mongo_mapper 0.15.5 → 0.16.0

data/spec/functional/callbacks_spec.rb

@@ -10,10 +10,14 @@ module CallbacksSupport
       :before_save,       :after_save,
       :before_destroy,    :after_destroy
     ].each do |callback|
-      base.send(callback) do
+      base.send(callback, if: :always_true) do
         history << callback.to_sym
       end
     end
+
+    base.send(:define_method, :always_true) do
+      true
+    end
   end
 
   def history

data/spec/functional/embedded_document_spec.rb

@@ -51,6 +51,39 @@ describe "EmbeddedDocument" do
       doc.foo._parent_document.should be(doc)
       doc.foo._root_document.should be(doc)
     end
+
+    context "given subclass of embedded document" do
+      before do
+        @sub_address_class = Subclass(@address_class, 'SubAddress')
+      end
+
+      it "should embed embedded document" do
+        address = @sub_address_class.new(:city => 'South Bend', :state => 'IN')
+        doc = @klass.create(:foo => address)
+        doc.foo.city.should == 'South Bend'
+        doc.foo.state.should == 'IN'
+
+        doc = doc.reload
+        doc.foo.city.should == 'South Bend'
+        doc.foo.state.should == 'IN'
+      end
+
+      it "should assign _parent_document and _root_document" do
+        address = @sub_address_class.new(:city => 'South Bend', :state => 'IN')
+        address._parent_document.should be_nil
+        doc = @klass.create(:foo => address)
+        address._parent_document.should be(doc)
+        address._root_document.should be(doc)
+      end
+
+      it "should assign _parent_document and _root_document when loading" do
+        address = @sub_address_class.new(:city => 'South Bend', :state => 'IN')
+        doc = @klass.create(:foo => address)
+        doc.reload
+        doc.foo._parent_document.should be(doc)
+        doc.foo._root_document.should be(doc)
+      end
+    end
   end
 
   it "should correctly instantiate single collection inherited embedded documents" do

data/spec/functional/keys_spec.rb

@@ -367,4 +367,80 @@ describe "Keys" do
       instance.a_num.should == 10
     end
   end
+
+  describe 'default value is child of embedded class' do
+    class EmbeddedParent
+      include MongoMapper::EmbeddedDocument
+    end
+    class EmbeddedChild < EmbeddedParent
+    end
+
+    context 'with type' do
+      class DocumentWithEmbeddedAndDefaultValue
+        include MongoMapper::Document
+        key :my_embedded, EmbeddedParent, default: -> { EmbeddedChild.new }
+      end
+
+      it "should work" do
+        instance = DocumentWithEmbeddedAndDefaultValue.new
+        instance.my_embedded.should be_instance_of(EmbeddedChild)
+      end
+    end
+
+    context 'without type' do
+      class DocumentWithEmbeddedAndDefaultValueWithoutType
+        include MongoMapper::Document
+        key :my_embedded, EmbeddedParent, default: -> { EmbeddedChild.new }
+      end
+
+      it "should work" do
+        instance = DocumentWithEmbeddedAndDefaultValueWithoutType.new
+        instance.my_embedded.should be_instance_of(EmbeddedChild)
+      end
+    end
+  end
+
+  describe 'default value is a custom class' do
+    class TimeOfDay
+      attr_reader :seconds
+
+      def initialize(seconds)
+        @seconds = seconds
+      end
+
+      def self.from_mongo(value)
+        return nil if value.blank?
+
+        new(value.to_i)
+      end
+
+      def self.to_mongo(value)
+        return nil if value.blank?
+
+        value.seconds
+      end
+    end
+
+    context 'with type' do
+      class DocumentWithCustomClass
+        include MongoMapper::Document
+        key :my_embedded, TimeOfDay, default: -> { TimeOfDay.new(900) }
+      end
+      it "should work" do
+        instance = DocumentWithCustomClass.new
+        instance.my_embedded.should be_instance_of(TimeOfDay)
+      end
+    end
+
+    context 'without type' do
+      class DocumentWithCustomClassWithoutType
+        include MongoMapper::Document
+        key :my_embedded, default: -> { TimeOfDay.new(900) }
+      end
+      it "should work" do
+        instance = DocumentWithCustomClass.new
+        instance.my_embedded.should be_instance_of(TimeOfDay)
+      end
+    end
+  end
 end

data/spec/functional/shardable_spec.rb

@@ -1,65 +1,57 @@
 require 'spec_helper'
 
 describe 'Shardable' do
-  let(:sharded_model) {
-    Doc do
-      key :first_name, String
-      key :last_name, String
-      shard_key :first_name, :last_name
-    end
-  }
-
   describe 'shard_key_fields' do
     it 'returns declared field names' do
-      sharded_model.shard_key_fields.should == ['first_name', 'last_name']
+      ShardedModel.shard_key_fields.should == ['first_name']
     end
   end
 
   describe 'shard_key_filter' do
     context 'new record' do
-      let(:document) { sharded_model.new(first_name: 'John', last_name: 'Smith') }
+      let(:document) { ShardedModel.new(first_name: 'John', last_name: 'Smith') }
 
       it 'returns current values' do
-        document.shard_key_filter.should == { 'first_name' => 'John', 'last_name' => 'Smith' }
+        document.shard_key_filter.should == { 'first_name' => 'John' }
       end
     end
 
     context 'persisted record' do
-      let(:document) { sharded_model.create!(first_name: 'John', last_name: 'Smith') }
+      let(:document) { ShardedModel.create!(first_name: 'John', last_name: 'Smith') }
 
       before do
         document.first_name = 'William'
       end
 
       it 'returns persisted values' do
-        document.shard_key_filter.should == { 'first_name' => 'John', 'last_name' => 'Smith' }
+        document.shard_key_filter.should == { 'first_name' => 'John' }
       end
     end
   end
 
   context 'creating new document' do
-    let(:document) { sharded_model.new(first_name: 'John', last_name: 'Smith') }
+    let(:document) { ShardedModel.new(first_name: 'John', last_name: 'Smith') }
 
     it 'inserts new document' do
-      lambda { document.save! }.should change { sharded_model.count }.by(1)
+      lambda { document.save! }.should change { ShardedModel.count }.by(1)
 
-      persisted = sharded_model.find(document.id)
+      persisted = ShardedModel.find(document.id)
       persisted.first_name.should == 'John'
       persisted.last_name.should == 'Smith'
     end
   end
 
   context 'updating persisted document' do
-    let(:document) { sharded_model.create!(first_name: 'John', last_name: 'Smith') }
+    let(:document) { ShardedModel.create!(first_name: 'John', last_name: 'Smith') }
 
     before do
       document.first_name = 'William'
     end
 
     it 'updates persisted document' do
-      lambda { document.save! }.should_not change { sharded_model.count }
+      lambda { document.save! }.should_not change { ShardedModel.count }
 
-      persisted = sharded_model.find(document.id)
+      persisted = ShardedModel.find(document.id)
       persisted.first_name.should == 'William'
       persisted.last_name.should == 'Smith'
     end

data/spec/spec_helper.rb

@@ -69,6 +69,18 @@ def EDoc(name='Class', &block)
   klass
 end
 
+def Subclass(super_class, name='Subclass', &block)
+  klass = Class.new(super_class) do
+    if name
+      class_eval "def self.name; '#{name}' end"
+      class_eval "def self.to_s; '#{name}' end"
+    end
+  end
+
+  klass.class_eval(&block) if block_given?
+  klass
+end
+
 def drop_indexes(klass)
   klass.collection.indexes.drop_all if klass.database.collection_names.include?(klass.collection.name)
 end

data/spec/support/sharded_model.rb

@@ -0,0 +1,24 @@
+class ShardedModel
+  include MongoMapper::Document
+
+  key :first_name, String
+  key :last_name, String
+  shard_key :first_name
+end
+
+if ENV.fetch("ENABLE_SHARDING", "0") == "1"
+  client = MongoMapper.connection
+  database = MongoMapper.database
+
+  # https://www.mongodb.com/docs/manual/reference/command/enableSharding/#mongodb-dbcommand-dbcmd.enableSharding
+  client.use(:admin).command(enableSharding: database.name)
+
+  # https://www.mongodb.com/docs/manual/reference/command/shardCollection/#mongodb-dbcommand-dbcmd.shardCollection
+  # Note: this command automatically creates the index for the empty collection
+  client.use(:admin).command(
+    shardCollection: [database.name, ShardedModel.collection.name].join("."),
+    key: {
+      first_name: "hashed",
+    },
+  )
+end

data/spec/unit/document_spec.rb

@@ -88,7 +88,7 @@ describe "Document" do
     end
 
     it "should be recorded" do
-      Message.descendants.should == [Enter, Exit, Chat]
+      Message.descendants.should contain_exactly(Enter, Exit, Chat)
     end
   end
 

data/spec/unit/embedded_document_spec.rb

@@ -220,10 +220,10 @@ describe "EmbeddedDocument" do
         end
 
         it "should be recorded" do
-          Grandparent.direct_descendants.should == [Parent]
-          Grandparent.descendants.to_set.should == [Parent, Child, OtherChild].to_set
+          Grandparent.direct_descendants.should contain_exactly(Parent)
+          Grandparent.descendants.to_set.should contain_exactly(Parent, Child, OtherChild)
 
-          Parent.descendants.should      == [Child, OtherChild]
+          Parent.descendants.should contain_exactly(Child, OtherChild)
         end
       end
     end

data/spec/unit/inspect_spec.rb

@@ -44,4 +44,54 @@ describe "Inspect" do
       doc.inspect.should =~ /_id:.*, pet: .*_id.*, name: "Kitten".*/
     end
   end
+
+  context "#inspect with filter_attributes" do
+    before do
+      MongoMapper::Utils.remove_instance_variable(:@filter) if MongoMapper::Utils.instance_variable_defined?(:@filter)
+      MongoMapper.filter_attributes = [:email, :card_number, :phone_number]
+    end
+
+    after do
+      MongoMapper.filter_attributes =[]
+      MongoMapper::Utils.remove_instance_variable(:@filter) if MongoMapper::Utils.instance_variable_defined?(:@filter)
+    end
+
+    it "should filter the fields given by filter_attributes" do
+      document = Doc('User') do
+        key :name,  String
+        key :age,   Integer
+        key :email, String
+        key :card_number, String
+      end
+      doc = document.new(
+        :name => 'John',
+        :age => 29,
+        :email => 'mongomapper@example.com',
+        :card_number => '123'
+      )
+
+      if ActiveSupport.version >= Gem::Version.new("6.0")
+        doc.inspect.should =~ /_id:.*, age: 29, card_number: \[FILTERED\], email: \[FILTERED\], name: "John"/
+      else
+        doc.inspect.should =~ /_id:.*, age: 29, card_number: "123", email: "mongomapper@example.com", name: "John"/
+      end
+    end
+
+    it "should filter the fields given by filter_attributes for embedded document" do
+      document = EDoc('Profile') do
+        key :job,  String
+        key :phone_number,  String
+      end
+      doc = document.new(
+        :job => 'Software Engineer',
+        :phone_number => '09011110000'
+      )
+
+      if ActiveSupport.version >= Gem::Version.new("6.0")
+        doc.inspect.should =~ /job: "Software Engineer", phone_number: \[FILTERED\]/
+      else
+        doc.inspect.should =~ /job: "Software Engineer", phone_number: "09011110000"/
+      end
+    end
+  end
 end

data/spec/unit/key_spec.rb

@@ -276,6 +276,17 @@ describe "Key" do
       it "should work with procs" do
          Key.new(:foo, String, :default => lambda { return 'hello world' }).default_value.should == "hello world"
       end
+
+      it "should work with embedded document" do
+        embedded = EDoc()
+        Key.new(:foo, embedded, :default => lambda { embedded.new }).default_value.should be_instance_of(embedded)
+      end
+
+      it "should work with subclass of embedded document" do
+        embedded = EDoc()
+        subclass = Subclass(embedded)
+        Key.new(:foo, embedded, :default => lambda { subclass.new }).default_value.should be_instance_of(subclass)
+      end
     end
   end
 end # KeyTest

data/spec/unit/mongo_mapper_spec.rb

@@ -71,7 +71,7 @@ describe "MongoMapper" do
         'development' => {'hosts' => ['127.0.0.1:27017'], 'database' => 'test', 'read' => 'primary'}
       }
       logger = double('logger')
-      Mongo::Client.should_receive(:new).with(['127.0.0.1:27017'], :logger => logger, :read => :primary, :database => 'test')
+      Mongo::Client.should_receive(:new).with(['127.0.0.1:27017'], { :logger => logger, :read => :primary, :database => 'test' })
       MongoMapper.connect('development', :logger => logger)
     end
 
@@ -80,7 +80,7 @@ describe "MongoMapper" do
         'development' => {'hosts' => ['192.168.1.1:2222'], 'database' => 'test', 'safe' => true}
       }
       logger = double('logger')
-      Mongo::Client.should_receive(:new).with(['192.168.1.1:2222'], :logger => logger, :safe => true, :database => 'test')
+      Mongo::Client.should_receive(:new).with(['192.168.1.1:2222'], { :logger => logger, :safe => true, :database => 'test' })
       MongoMapper.connect('development', :logger => logger)
     end
 
@@ -89,7 +89,7 @@ describe "MongoMapper" do
         'development' => {'uri' => 'mongodb://127.0.0.1:27017/test', 'options'=> {:foo => 1}}
       }
       logger = double('logger')
-      Mongo::Client.should_receive(:new).with('mongodb://127.0.0.1:27017/test', :logger => logger, :foo => 1)
+      Mongo::Client.should_receive(:new).with('mongodb://127.0.0.1:27017/test', { :logger => logger, :foo => 1 })
       MongoMapper.connect('development', :logger => logger)
     end
 
@@ -97,7 +97,7 @@ describe "MongoMapper" do
       MongoMapper.config = {
         'development' => {'hosts' => ['127.0.0.1:27017'], 'database' => 'test', 'user' => 'john', 'password' => 'secret'}
       }
-      Mongo::Client.should_receive(:new).with(['127.0.0.1:27017'], :database => 'test', :user => 'john', :password => 'secret')
+      Mongo::Client.should_receive(:new).with(['127.0.0.1:27017'], { :database => 'test', :user => 'john', :password => 'secret' })
       MongoMapper.connect('development')
     end
 
@@ -129,9 +129,23 @@ describe "MongoMapper" do
     it "should work as shortcut for setting config, environment and options" do
       config, logger = double('config'), double('logger')
       MongoMapper.should_receive(:config=).with(config)
-      MongoMapper.should_receive(:connect).with('development', :logger => logger)
+      MongoMapper.should_receive(:connect).with('development',  { :logger => logger })
       MongoMapper.should_receive(:handle_passenger_forking).once
       MongoMapper.setup(config, 'development', :logger => logger)
     end
+
+    it "should use the right reconnect method" do
+      Mongo::Client.instance_methods.should_not include(:connect) # v1
+      Mongo::Client.instance_methods.should include(:reconnect) # v1
+    end
+  end
+
+  context "options" do
+    it "should sets/returns filtered_attributes correctly" do
+      MongoMapper.filter_attributes.should == []
+      filtered_attributes = [:password, :credit_number]
+      MongoMapper.filter_attributes = filtered_attributes
+      MongoMapper.filter_attributes.should == filtered_attributes
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_mapper
 version: !ruby/object:Gem::Version
-  version: 0.15.5
+  version: 0.16.0
 platform: ruby
 authors:
 - John Nunemaker
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -125,6 +125,7 @@ files:
 - examples/validating/embedded_docs.rb
 - lib/mongo_mapper.rb
 - lib/mongo_mapper/connection.rb
+- lib/mongo_mapper/deprecator.rb
 - lib/mongo_mapper/document.rb
 - lib/mongo_mapper/embedded_document.rb
 - lib/mongo_mapper/exceptions.rb
@@ -145,6 +146,7 @@ files:
 - lib/mongo_mapper/extensions/time.rb
 - lib/mongo_mapper/locale/en.yml
 - lib/mongo_mapper/middleware/identity_map.rb
+- lib/mongo_mapper/options.rb
 - lib/mongo_mapper/plugins.rb
 - lib/mongo_mapper/plugins/accessible.rb
 - lib/mongo_mapper/plugins/active_model.rb
@@ -271,6 +273,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/matchers.rb
 - spec/support/models.rb
+- spec/support/sharded_model.rb
 - spec/unit/associations/base_spec.rb
 - spec/unit/associations/belongs_to_association_spec.rb
 - spec/unit/associations/many_association_spec.rb
@@ -320,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby Object Mapper for Mongo