Support Mongoid's has_and_belongs_to_many custom primary_key

Closes #3097

Author: mshibuya

lib/rails_admin/adapters/active_record/association.rb

@@ -30,7 +30,13 @@ def klass
         end
 
         def primary_key
-          (options[:primary_key] || association.klass.primary_key).try(:to_sym) unless polymorphic?
+          return nil if polymorphic?
+          case type
+          when :has_one
+            association.klass.primary_key
+          else
+            association.association_primary_key
+          end.try(:to_sym)
         end
 
         def foreign_key
@@ -50,6 +56,17 @@ def foreign_inverse_of
           nil
         end
 
+        def key_accessor
+          case type
+          when :has_many, :has_and_belongs_to_many
+            "#{name.to_s.singularize}_ids".to_sym
+          when :has_one
+            "#{name}_id".to_sym
+          else
+            foreign_key
+          end
+        end
+
         def as
           options[:as].try :to_sym
         end

lib/rails_admin/adapters/mongoid/association.rb

@@ -41,7 +41,12 @@ def klass
         end
 
         def primary_key
-          association.primary_key.to_sym rescue :_id
+          case type
+          when :belongs_to, :has_and_belongs_to_many
+            association.primary_key.to_sym
+          else
+            :_id
+          end
         end
 
         def foreign_key
@@ -64,6 +69,19 @@ def foreign_inverse_of
           inverse_of_field.try(:to_sym)
         end
 
+        def key_accessor
+          case macro.to_sym
+          when :has_many
+            "#{name.to_s.singularize}_ids".to_sym
+          when :has_one
+            "#{name}_id".to_sym
+          when :embedded_in, :embeds_one, :embeds_many
+            nil
+          else
+            foreign_key
+          end
+        end
+
         def as
           association.as.try :to_sym
         end

lib/rails_admin/config/fields/association.rb

@@ -10,6 +10,10 @@ def association
           @properties
         end
 
+        def method_name
+          association.key_accessor
+        end
+
         register_instance_option :pretty_value do
           v = bindings[:view]
           [value].flatten.select(&:present?).collect do |associated|
@@ -82,12 +86,7 @@ def associated_object_label_method
 
         # Reader for associated primary key
         def associated_primary_key
-          @associated_primary_key ||= associated_model_config.abstract_model.primary_key
-        end
-
-        # Reader for the association's key
-        def foreign_key
-          association.foreign_key
+          association.primary_key
         end
 
         # Reader whether this is a polymorphic association

lib/rails_admin/config/fields/types/belongs_to_association.rb

@@ -28,15 +28,15 @@ class BelongsToAssociation < RailsAdmin::Config::Fields::Association
           end
 
           def associated_primary_key
-            @associated_primary_key ||= association.primary_key
+            association.primary_key
           end
 
           def selected_id
-            bindings[:object].send(foreign_key)
+            bindings[:object].send(association.key_accessor)
           end
 
           def method_name
-            nested_form ? "#{name}_attributes".to_sym : association.foreign_key
+            nested_form ? "#{name}_attributes".to_sym : super
           end
 
           def multiple?

lib/rails_admin/config/fields/types/has_many_association.rb

@@ -18,7 +18,7 @@ class HasManyAssociation < RailsAdmin::Config::Fields::Association
           end
 
           def method_name
-            nested_form ? "#{super}_attributes".to_sym : "#{super.to_s.singularize}_ids".to_sym # name_ids
+            nested_form ? "#{name}_attributes".to_sym : super
           end
 
           # Reader for validation errors of the bound object

lib/rails_admin/config/fields/types/has_one_association.rb

@@ -26,7 +26,7 @@ def selected_id
           end
 
           def method_name
-            nested_form ? "#{name}_attributes".to_sym : "#{name}_id".to_sym
+            nested_form ? "#{name}_attributes".to_sym : super
           end
 
           def multiple?

spec/dummy_app/app/mongoid/managing_user.rb

@@ -1,6 +1,8 @@
 class ManagingUser < User
   has_one :team, class_name: 'ManagedTeam', foreign_key: :manager, primary_key: :email, inverse_of: :user
   has_many :teams, class_name: 'ManagedTeam', foreign_key: :manager, primary_key: :email, inverse_of: :user
+  has_and_belongs_to_many :players, foreign_key: :player_names, primary_key: :name, inverse_of: :nil
+  has_and_belongs_to_many :balls, primary_key: :color, inverse_of: :nil
 
   def team_id=(id)
     self.team = ManagedTeam.where(_id: id).first

spec/integration/fields/has_and_belongs_to_many_association_spec.rb

@@ -52,4 +52,27 @@
       is_expected.not_to have_css("a[href='/admin/comment/#{@comment3.id}']")
     end
   end
+
+  context "with Mongoid's custom primary_key option", mongoid: true do
+    let(:user) { FactoryBot.create :managing_user, players: [players[0]], balls: [balls[0]] }
+    let!(:players) { FactoryBot.create_list(:player, 2) }
+    let!(:balls) { %w(red blue).map { |color| FactoryBot.create(:ball, color: color) } }
+    before do
+      RailsAdmin.config ManagingUser do
+        field :players
+        field :balls
+      end
+    end
+
+    it "allows update" do
+      visit edit_path(model_name: 'managing_user', id: user.id)
+      expect(find("select#managing_user_player_names option[value=\"#{players[0].name}\"]")).to be_selected
+      expect(find("select#managing_user_ball_ids option[value=\"#{balls[0].color}\"]")).to be_selected
+      select(players[1].name, from: 'Players')
+      select(balls[1].rails_admin_default_object_label_method, from: 'Balls')
+      click_button 'Save'
+      expect(ManagingUser.first.players).to match_array players
+      expect(ManagingUser.first.balls).to match_array balls
+    end
+  end
 end

spec/rails_admin/adapters/active_record/association_spec.rb

@@ -67,6 +67,7 @@ class ARComment < Tableless
       expect(subject.primary_key).to eq :id
       expect(subject.foreign_key).to eq :a_r_blog_id
       expect(subject.foreign_type).to be_nil
+      expect(subject.key_accessor).to eq :a_r_blog_id
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -85,6 +86,7 @@ class ARComment < Tableless
       expect(subject.primary_key).to eq :id
       expect(subject.foreign_key).to eq :ar_blog_id
       expect(subject.foreign_type).to be_nil
+      expect(subject.key_accessor).to eq :a_r_post_ids
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -162,6 +164,7 @@ class FieldTestWithSymbolForeignKey < FieldTest
       expect(subject.primary_key).to eq :id
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_key_nullable?).to be_truthy
+      expect(subject.key_accessor).to eq :a_r_category_ids
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -181,6 +184,7 @@ class FieldTestWithSymbolForeignKey < FieldTest
       expect(subject.primary_key).to be_nil
       expect(subject.foreign_key).to eq :commentable_id
       expect(subject.foreign_type).to eq :commentable_type
+      expect(subject.key_accessor).to eq :commentable_id
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_truthy
       expect(subject.inverse_of).to be_nil
@@ -204,6 +208,7 @@ class FieldTestWithSymbolForeignKey < FieldTest
       expect(subject.primary_key).to eq :id
       expect(subject.foreign_key).to eq :commentable_id
       expect(subject.foreign_type).to be_nil
+      expect(subject.key_accessor).to eq :a_r_comment_ids
       expect(subject.as).to eq :commentable
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil

spec/rails_admin/adapters/mongoid/association_spec.rb

@@ -90,6 +90,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_truthy
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to eq :mongo_blog_id
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -115,6 +116,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_truthy
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to eq :mongo_post_ids
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -135,6 +137,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_truthy
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to eq :mongo_category_ids
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -156,6 +159,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_truthy
       expect(subject.foreign_type).to eq :commentable_type
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to eq :commentable_id
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_truthy
       expect(subject.inverse_of).to be_nil
@@ -177,6 +181,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_truthy
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to eq :mongo_comment_ids
       expect(subject.as).to eq :commentable
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -202,6 +207,7 @@ class MongoNote
       expect(subject.foreign_key_nullable?).to be_falsey
       expect(subject.foreign_type).to be_nil
       expect(subject.foreign_inverse_of).to be_nil
+      expect(subject.key_accessor).to be_nil
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil
@@ -221,6 +227,7 @@ class MongoNote
       expect(subject.foreign_key).to be_nil
       expect(subject.foreign_key_nullable?).to be_falsey
       expect(subject.foreign_type).to be_nil
+      expect(subject.key_accessor).to be_nil
       expect(subject.as).to be_nil
       expect(subject.polymorphic?).to be_falsey
       expect(subject.inverse_of).to be_nil