locomotive_plugins 1.0.0.beta3 → 1.0.0.beta4

data/lib/locomotive/plugin.rb

@@ -117,11 +117,14 @@ module Locomotive
 
     # Initialize by supplying the current config parameters. Note that this
     # method should not be overridden for custom initialization of plugin
-    # objects. Instead, override the initialize_plugin method
+    # objects. Instead, override the initialize_plugin method. If given a
+    # block, the block will be called with `self` as an argument before the
+    # `initialize_plugin` method is called. This is used by LocomotiveCMS to
+    # perform some custom initialization before the plugin's initialization is
+    # called.
     def initialize(config)
       self.config = config
-      self.load_or_create_db_model_container!
-      self.save_db_model_container
+      yield self if block_given?
       self.initialize_plugin
     end
 

data/lib/locomotive/plugin/db_model_container.rb

@@ -5,6 +5,14 @@ module Locomotive
     # container has the actual relationships to the database objects
     class DBModelContainer
       include Mongoid::Document
+
+      field :container_name
+
+      def self.for_name(container_name)
+        where(container_name: container_name).first || \
+          new(container_name: container_name)
+      end
+
     end
   end
 end

data/lib/locomotive/plugin/db_models.rb

@@ -33,18 +33,21 @@ module Locomotive
         protected
 
         def create_has_many_relationship(name, klass)
-          self.db_model_container_class.embeds_many(name,
-            class_name: klass.to_s, inverse_of: :db_model_container)
-          klass.embedded_in(:db_model_container,
+          self.db_model_container_class.has_many(name,
+            class_name: klass.to_s, inverse_of: :db_model_container,
+            autosave: true, dependent: :destroy)
+          klass.belongs_to(:db_model_container,
             class_name: db_model_container_class.to_s, inverse_of: name)
 
-          self.define_passthrough_methods_to_container(name, "#{name}=")
+          self.define_passthrough_methods_to_container(name, "#{name}=",
+            "#{name}_ids", "#{name}_ids=")
         end
 
         def create_has_one_relationship(name, klass)
-          self.db_model_container_class.embeds_one(name,
-            class_name: klass.to_s, inverse_of: :db_model_container)
-          klass.embedded_in(:db_model_container,
+          self.db_model_container_class.has_one(name,
+            class_name: klass.to_s, inverse_of: :db_model_container,
+            autosave: true, dependent: :destroy)
+          klass.belongs_to(:db_model_container,
             class_name: db_model_container_class.to_s, inverse_of: name)
 
           self.define_passthrough_methods_to_container(name, "#{name}=",
@@ -52,13 +55,13 @@ module Locomotive
         end
 
         def define_passthrough_methods_to_container(*methods)
-          class_eval <<-EOF
-            %w{#{methods.join(' ')}}.each do |meth|
+          class_eval do
+            methods.each do |meth|
               define_method(meth) do |*args|
-                @db_model_container.send(meth, *args)
+                db_model_container.send(meth, *args)
               end
             end
-          EOF
+          end
         end
 
       end
@@ -70,14 +73,36 @@ module Locomotive
 
       # Get the DB Model container
       def db_model_container
-        @db_model_container || load_or_create_db_model_container!
+        @db_model_containers ||= {}
+        name = self.current_db_model_container_name
+        @db_model_containers[name] ||= load_db_model_container(name)
+      end
+
+      # Set the current DB Model container
+      def use_db_model_container(name)
+        @current_db_model_container_name = name
+      end
+
+      # Reset to the default DB Model container
+      def reset_current_db_model_container
+        self.use_db_model_container(nil)
+      end
+
+      # Set the current DB Model container for the duration of the block
+      def with_db_model_container(name, &block)
+        old_name = self.current_db_model_container_name
+        self.use_db_model_container(name)
+        block.call
+        self.use_db_model_container(old_name)
       end
 
+      # The name of the current container being used
+      attr_reader :current_db_model_container_name
+
       protected
 
-      def load_or_create_db_model_container!
-        @db_model_container = self.class.db_model_container_class.first \
-          || self.class.db_model_container_class.new
+      def load_db_model_container(name)
+        self.class.db_model_container_class.for_name(name)
       end
 
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module LocomotivePlugins
-  VERSION = '1.0.0.beta3'
+  VERSION = '1.0.0.beta4'
 end

data/spec/lib/locomotive/plugin/db_models_spec.rb

@@ -31,7 +31,7 @@ module Locomotive
         @plugin_with_db_model.items.where(name: /Item/)[1].name.should == 'Second Item'
       end
 
-      it 'should embed DBModel items in a document for the plugin class' do
+      it 'should reference DBModel items in a document for the plugin class' do
         @plugin_with_db_model.visit_count.db_model_container.kind_of?(
           PluginWithDBModel::DBModelContainer).should be_true
         @plugin_with_db_model.items.first.db_model_container.kind_of?(
@@ -39,7 +39,10 @@ module Locomotive
 
         @plugin_with_db_model.visit_count.relations[
           'db_model_container'].relation.should \
-          == Mongoid::Relations::Embedded::In
+          == Mongoid::Relations::Referenced::In
+        @plugin_with_db_model.items.relations[
+          'db_model_container'].relation.should \
+          == Mongoid::Relations::Referenced::In
       end
 
       it 'should run all validations for DBModel items' do
@@ -51,6 +54,153 @@ module Locomotive
         }
       end
 
+      it 'should destroy the contained objects when the container is destroyed' do
+        vc = @plugin_with_db_model.visit_count
+        i0 = @plugin_with_db_model.items[0]
+        i1 = @plugin_with_db_model.items[1]
+
+        DBModel.all.for_ids(vc.id, i0.id, i1.id).count.should == 3
+
+        @plugin_with_db_model.db_model_container.destroy
+
+        DBModel.all.for_ids(vc.id, i0.id, i1.id).count.should == 0
+      end
+
+      it 'should allow relationships between DBModels' do
+        plugin = PluginWithDBModelRelationships.new({})
+
+        t1 = plugin.teachers.build(name: 'Mr. Adams')
+        t2 = plugin.teachers.build(name: 'Ms. Boudreau')
+
+        s1 = plugin.students.build(name: 'Alex', teacher: t1)
+        s2 = plugin.students.build(name: 'Billy', teacher: t1)
+        s3 = plugin.students.build(name: 'Caitlyn', teacher: t2)
+
+        plugin.save_db_model_container.should be_true
+
+        # Reload from database
+        plugin = PluginWithDBModelRelationships.new({})
+
+        # Check all the names and relationships to make sure they were
+        # persisted
+        teachers = plugin.teachers.to_a
+        students = plugin.students.to_a
+
+        teachers[0].name.should == 'Mr. Adams'
+        teachers[0].students.count.should == 2
+        teachers[0].students.should include(s1)
+        teachers[0].students.should include(s2)
+
+        teachers[1].name.should == 'Ms. Boudreau'
+        teachers[1].students.count.should == 1
+        teachers[1].students.should include(s3)
+
+        s1.name.should == 'Alex'
+        s1.teacher.should == t1
+        s2.name.should == 'Billy'
+        s2.teacher.should == t1
+        s3.name.should == 'Caitlyn'
+        s3.teacher.should == t2
+      end
+
+      context 'with multiple containers' do
+
+        it 'should save the data in the correct container' do
+          plugin = PluginWithDBModel.new({})
+
+          plugin.with_db_model_container('my_container') do
+            plugin.build_visit_count(count: 10)
+          end
+
+          plugin.use_db_model_container('my_other_container')
+          plugin.build_visit_count(count: 20)
+          plugin.save_db_model_container.should be_true
+          plugin.reset_current_db_model_container
+
+          plugin.use_db_model_container('my_container')
+          plugin.db_model_container.changed?.should be_true
+          plugin.save_db_model_container.should be_true
+          plugin.db_model_container.changed?.should be_false
+
+          # Reload from the database
+          @plugin_with_db_model = PluginWithDBModel.new({})
+
+          # Make sure everything is in the right container and make sure we can
+          # access the containers how we want
+          @plugin_with_db_model.with_db_model_container('my_other_container') do
+            @plugin_with_db_model.current_db_model_container_name.should ==
+              'my_other_container'
+            @plugin_with_db_model.visit_count.count.should == 20
+          end
+
+          @plugin_with_db_model.use_db_model_container('my_container')
+          @plugin_with_db_model.current_db_model_container_name.should ==
+            'my_container'
+          @plugin_with_db_model.visit_count.count.should == 10
+
+          @plugin_with_db_model.reset_current_db_model_container
+          @plugin_with_db_model.current_db_model_container_name.should be_nil
+          @plugin_with_db_model.visit_count.count.should == 5
+        end
+
+        it 'should revert the current container name after using with_db_model_container' do
+          @plugin_with_db_model.use_db_model_container('fake_container')
+          @plugin_with_db_model.current_db_model_container_name.should ==
+            'fake_container'
+
+          @plugin_with_db_model.with_db_model_container('my_container') do
+            @plugin_with_db_model.current_db_model_container_name.should ==
+              'my_container'
+          end
+
+          @plugin_with_db_model.current_db_model_container_name.should ==
+            'fake_container'
+        end
+
+        it 'should only load each container once' do
+          container_names = %w{my_container my_other_container}
+
+          # The default container has already been loaded
+          @plugin_with_db_model.expects(:load_db_model_container).with(nil).never
+
+          # The others should only be called once. Just return something
+          # non-nil
+          container_names.each do |name|
+            @plugin_with_db_model.expects(:load_db_model_container).with(
+              name).returns(1).once
+          end
+
+          3.times do
+            container_names.each do |name|
+              @plugin_with_db_model.with_db_model_container(name) do
+                # Access the container
+                @plugin_with_db_model.db_model_container
+              end
+            end
+          end
+        end
+
+        it 'should not share containers between plugin objects' do
+          p0 = PluginWithDBModel.new({})
+          p1 = PluginWithDBModelRelationships.new({})
+
+          # Default container
+          p0.save_db_model_container.should be_true
+          p1.save_db_model_container.should be_true
+          p0.db_model_container.should_not == p1.db_model_container
+
+          # Named container
+          p0.with_db_model_container('my_container') do
+            p1.with_db_model_container('my_container') do
+              p0.save_db_model_container.should be_true
+              p1.save_db_model_container.should be_true
+              p0.db_model_container.should_not == p1.db_model_container
+            end
+          end
+        end
+
+      end
+
     end
   end
 end

data/spec/lib/locomotive/plugin_spec.rb

@@ -14,6 +14,13 @@ module Locomotive
       @plugin.custom_attribute.should == 'Value'
     end
 
+    it 'should call the gven block before custom initialization methods' do
+      @plugin = MyPlugin.new(@config) do |obj|
+        obj.custom_attribute.should be_nil
+      end
+      @plugin.custom_attribute.should_not be_nil
+    end
+
     it 'should store a list of before_filters' do
       @plugin.before_filters.count.should == 2
       @plugin.before_filters[0].should == :my_method1

data/spec/support/plugins/plugin_with_db_model_relationships.rb

@@ -0,0 +1,22 @@
+
+module Locomotive
+  class PluginWithDBModelRelationships
+    include Locomotive::Plugin
+
+    class Teacher < Locomotive::Plugin::DBModel
+      field :name
+      has_many :students,
+        class_name: 'Locomotive::PluginWithDBModelRelationships::Student'
+    end
+
+    class Student < Locomotive::Plugin::DBModel
+      field :name
+      belongs_to :teacher,
+        class_name: 'Locomotive::PluginWithDBModelRelationships::Teacher'
+    end
+
+    has_many :teachers, Teacher
+    has_many :students, Student
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locomotive_plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: locomotive_liquid
@@ -133,6 +133,7 @@ files:
 - spec/support/plugins/plugin_with_filter.rb
 - spec/support/plugins/plugin_with_many_filter_modules.rb
 - spec/support/plugins/my_plugin.rb
+- spec/support/plugins/plugin_with_db_model_relationships.rb
 - spec/support/plugins/plugin_with_db_model.rb
 - spec/support/factories.rb
 - spec/fixtures/config_template.haml