mongoid_silo 0.3.5 → 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 761fdd5682b8ade43547264a6f4e81c5ea9007d2
+  data.tar.gz: 7c5f6992a91ab8d4fd883634f86dbaced2adf9e8
+SHA512:
+  metadata.gz: 988c3bb22112c2672738154a6ebc2d8146297de6cc95dd0b8f8d8de323e891074b430775247549b6cc8ed1d1d4b209c3985b7bc591970e7f1734b37475ae1ed2
+  data.tar.gz: 91bb0e8b95038a8cb700912da9fd3a6ecb7beb63b3036e22a85e156581f799b17547badd990b6acd198d4f480c0ef43b30b0cdde22dfbfb630cb6969af042ae6

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - "1.9.3"
+  - "2.0.0"
 services: mongodb
-script: bundle exec rspec spec
+script: bundle exec rspec spec

data/app/models/silo.rb

@@ -8,6 +8,7 @@ class Silo
   field :item_id, type: String
   field :silo_type, type: String
   field :bag, type: Hash
+  field :version, type: Integer, default: 1
 
   index item_class: 1
   index item_id: 1
@@ -18,12 +19,26 @@ class Silo
   end
 
   class << self
-    def for_id_and_class_with_name item_id, class_name, silo_name
-      where(item_class: class_name, item_id: item_id, silo_type: silo_name).first
+    def for_id_and_class_with_name(item_id, class_name, silo_name, version: 1)
+      harvest(item_id, silo_name, class_name: class_name, version: version)
     end
 
-    def for_id_and_name_with_no_class item_id, silo_name
-      where(item_id: item_id, silo_type: silo_name).first
+    def for_id_and_name_with_no_class(item_id, silo_name, version: 1)
+      harvest(item_id, silo_name, version: version)
+    end
+
+    def harvest(item_id, silo_name, class_name: nil, version: 1)
+      query = {
+        item_class: class_name,
+        item_id: item_id,
+        silo_type: silo_name,
+        version: version
+      }
+
+      query = query.delete_if { |field, param| param.nil? }
+
+      where(query).first
     end
   end
-end
+end
+

data/app/workers/mongoid_silo/update_silo_worker.rb

@@ -1,60 +1,77 @@
 require 'sidekiq'
 
 module MongoidSilo
+  refine String do
+    def constantize
+      Object.module_eval("::#{foo}", __FILE__, __LINE__)
+    end
+  end
 
   class UpdateSiloWorker
     include Sidekiq::Worker
 
-    def perform(item_id, item_class, name, mode="save", generator=nil, callback=nil)
-      @item_id, @item_class, @generator, @callback = item_id, item_class, generator, callback
-      mode.to_s == "save" ? update_silo(name, generator) : destroy_silo(name)
-    end
+    attr_reader :generator, :klass, :id, :name, :callback
 
+    def perform(id, klass, name, mode = :save, generator = nil, callback = nil)
+      @id        = id.kind_of?(String) ? id : id["$oid"]
+      @klass     = klass.constantize
+      @generator = generator ? generator.constantize : nil
+      @callback  = callback
+      @name      = name
+
+      __send__(mode.to_sym)
+    end
 
     private
-    def update_silo name, generator
-      @item = item_class.send(:find, @item_id)
-      @silo = Silo.where(item_class: @item_class, item_id: @item_id, silo_type: name).first
-      @content = generator_class.send(:new, @item).generate
-      if @silo
-        @silo.set(:bag, @content)
+
+    def save
+      if generator.versioned_generators.empty?
+        save_unversioned_silo
       else
-        @silo = Silo.create(item_class: @item_class, item_id: @item_id, bag: @content, silo_type: name)
-      end
-      unless @callback.nil? || @callback == ""
-        @item.__send__(@callback, :updated)
+        save_versioned_silo
       end
+
+      call_callback(:updated)
     end
 
-    def destroy_silo name
-      @silo = Silo.where(item_class: @item_class, item_id: @item_id, silo_type: name).first
-      if @silo
-        @silo.destroy
-      end
-      unless @callback.nil? || @callback == ""
-        @item.__send__(@callback, :destroyed)
+    def save_unversioned_silo
+      content = generator.send(:new, item).generate
+
+      save_silo_content(content, version: 1)
+    end
+
+    def save_versioned_silo
+      generator.versioned_generators.each do |version, p|
+        content = generator.send(:new, item).instance_eval(&p)
+        save_silo_content(content, version: version)
       end
     end
 
-    def item_class
-      cl = nil
-      @item_class.split("::").inject(nil) do |parent, identifier|
-        parent ||= Kernel
-        cl = parent.const_get(identifier)
+    def save_silo_content(content, version: 1)
+      if silo = Silo.where(item_class: klass, item_id: id, silo_type: name, version: version).first
+        silo.set(:bag, content)
+      else
+        silo = Silo.create(item_class: klass, item_id: id, bag: content, silo_type: name, version: version)
       end
-      cl
     end
 
+    def destroy
+      if silo = Silo.where(item_class: klass, item_id: id, silo_type: name).all
+        silo.map(&:destroy)
+      end
 
-    def generator_class
-      cl = nil
-      @generator.split("::").inject(nil) do |parent, identifier|
-        parent ||= Kernel
-        cl = parent.const_get(identifier)
+      call_callback(:destroyed)
+    end
+
+    def call_callback(event)
+      if !callback.to_s.empty?
+        item.__send__(callback, :destroyed)
       end
-      cl
     end
 
+    def item
+      @item ||= klass.send(:find, id)
+    end
   end
-    
-end
+end
+

data/lib/mongoid/silo.rb

@@ -25,9 +25,8 @@ module Mongoid
         end
       end
 
-
-
       protected
+
       def setup_own_silo name, opts
         define_method "#{name}_silo" do
           from_silo name
@@ -54,9 +53,8 @@ module Mongoid
           arr << out
         end
 
-
         registry.each do |key|
-          key[:class_name].classify.constantize.class_eval <<-EOS, __FILE__, __LINE__+1
+          key[:class_name].classify.constantize.class_eval <<-RUBY, __FILE__, __LINE__+1
             set_callback :save, :after do
               ident = key[:foreign_key].to_sym
               MongoidSilo::UpdateSiloWorker.perform_async(self.__send__(ident), "#{key[:parent_class]}", "#{key[:silo_name]}", :save, "#{key[:generator]}", "#{key[:callback]}")
@@ -64,9 +62,9 @@ module Mongoid
 
             set_callback :destroy, :after do
               ident = key[:foreign_key].to_sym
-              MongoidSilo::UpdateSiloWorker.perform_async(self.__send__(ident), "#{key[:parent_class]}", "#{key[:silo_name]}", :destroy, "#{key[:callback]}")
+              MongoidSilo::UpdateSiloWorker.perform_async(self.__send__(ident), "#{key[:parent_class]}", "#{key[:silo_name]}", :save, "#{key[:generator]}", "#{key[:callback]}")
             end
-          EOS
+          RUBY
         end
       end
     end
@@ -97,4 +95,4 @@ module Mongoid
       MultiJson.encode from_silo
     end
   end
-end
+end

data/lib/mongoid_silo/grain_belt.rb

@@ -1,8 +1,28 @@
 module MongoidSilo
   class GrainBelt
-
     attr_accessor :object
-    
+
+    class << self
+      attr_accessor :versioned_generators_store
+
+      def versioned_generators
+        @versioned_generators_store ||= {}
+
+        if self == GrainBelt
+          @versioned_generators_store
+        else
+          superclass.versioned_generators.merge(@versioned_generators_store)
+        end
+      end
+
+      def version(*args, &block)
+        @versioned_generators_store ||= {}
+        args.each do |version|
+          @versioned_generators_store[version] = block
+        end
+      end
+    end
+
     def initialize(object)
       @object = object
     end
@@ -16,6 +36,6 @@ module MongoidSilo
         out[attribute] = object.send(attribute) unless ["_type", "_id"].include?(attribute)
       end
     end
-    
   end
-end
+end
+

data/lib/mongoid_silo/version.rb

@@ -1,3 +1,3 @@
 module MongoidSilo
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/spec/lib/grain_belt_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 describe MongoidSilo::GrainBelt do
   context "Instantiated with a simple model" do
-
     before do
       @model = create(:project)
       @silovator = MongoidSilo::GrainBelt.new(@model)
@@ -19,6 +18,48 @@ describe MongoidSilo::GrainBelt do
     it "generates a hash for storing in the silo" do
       @silovator.generate.should be_a(Hash)
     end
+  end
+
+  context "versioning" do
+    let(:klass) do
+      Class.new(described_class)
+    end
+
+    before do
+      klass.versioned_generators_store = {}
+    end
+
+    it "adds a block to the version hash" do
+      klass.version(1) do
+        "foo"
+      end
+
+      klass.versioned_generators[1].call == "foo"
+    end
 
+    it "allows multiple versions to be defined at once" do
+      klass.version(1, 2, 3) do
+        "foo"
+      end
+
+      received = []
+
+      klass.versioned_generators.each do |version, proc|
+        received << "foo"
+      end
+
+      received.should == ["foo", "foo", "foo"]
+    end
+
+    it "supports subclassing" do
+      klass.version(1, 2, 3) do
+        "foo"
+      end
+
+      subclass = Class.new(klass)
+
+      subclass.versioned_generators[1].call.should == "foo"
+    end
   end
-end
+end
+

data/spec/models/silo_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Silo do
-
   context 'simple silos' do
     before do
       @project = create(:project)
@@ -12,6 +11,10 @@ describe Silo do
       Silo.count.should eq(1)
     end
 
+    it "assigns a default version of 1" do
+      Silo.first.version.should eq(1)
+    end
+
     it "should contain the name of the project" do
       @project.default_silo.should eq({"name" => @project.name})
     end
@@ -26,7 +29,54 @@ describe Silo do
       @project.destroy
       Silo.count.should eq(0)
     end
+  end
+
+  context 'versioned silo' do
+    before do
+      @project = VersionedProject.create
+    end
+
+    it "should persist a Silo" do
+      @project.should be_persisted
+      Silo.count.should eq(2)
+    end
+
+    it "assigns the correct version to the generated silos" do
+      Silo.all.map(&:version).should == [1, 2]
+    end
+
+    it "assigns the correct attributes to the first silo" do
+      Silo.where(version: 1).first.bag.should == { "foo" => "bar" }
+    end
+
+    it "assigns the correct attributes to the second silo" do
+      Silo.where(version: 2).first.bag.should == { "foo" => "baz" }
+    end
+
+    it "should delete the silos if the project is deleted" do
+      @project.destroy
+      Silo.count.should eq(0)
+    end
+
+    describe "#for_id_and_class_with_name" do
+      it "supports querying specific versions" do
+        args = [@project.id.to_s, @project.class.name, "foobar", version: 2]
+
+        Silo.for_id_and_class_with_name(*args).bag.should == {
+          "foo" => "baz"
+        }
+      end
+    end
+
+    describe "#for_id_and_name_with_no_class" do
+      it "supports querying specific versions" do
+        args = [@project.id.to_s, "foobar", version: 2]
 
+        Silo.for_id_and_name_with_no_class(*args).bag.should == {
+          "foo" => "baz"
+        }
+      end
+    end
   end
 
   context 'Direct finders and methods:' do
@@ -74,17 +124,18 @@ describe Silo do
     it "updates a silo on save" do
       @complex_project.name = Faker::Name.name
       @complex_project.save
+
       @complex_project.complex_silo["name"].should eq(@complex_project.name)
     end
 
     it "removes the custom silo on destroying the project" do
       @complex_project.destroy
+
       Silo.count.should eq(0)
     end
   end
 
   context "Block based constructors:" do
-
     subject(:block_project) { create(:block_project) }
 
     it "defines an accessor based on the declared silo name" do
@@ -97,6 +148,7 @@ describe Silo do
 
     it "updates the parent when a child is saved" do
       project_item = create(:block_project_item, block_project_id: block_project.id)
+
       block_project.block_silo["items"][0]["name"].should eq(project_item.name)
     end
 
@@ -104,6 +156,7 @@ describe Silo do
       project_item = create(:block_project_item, block_project_id: block_project.id)
       project_item.name = Faker::Name.name
       project_item.save
+
       block_project.block_silo["items"][0]["name"].should eq(project_item.name)
     end
 
@@ -113,17 +166,15 @@ describe Silo do
       project_item3 = create(:block_project_item, block_project_id: block_project.id)
       block_project.block_silo["items"].length.should eq(3)
 
-      
       project_item2.name = Faker::Name.name
       project_item2.save
-      
+
       bp = BlockProject.find block_project.id
 
       bp.block_silo["items"].map{|i| i["name"]}.sort.should eq(
         [project_item1.name, project_item2.name, project_item3.name].sort
-      ) 
+      )
     end
-
   end
 
   context "Multiple silo constructors:" do
@@ -139,6 +190,7 @@ describe Silo do
       _expectation = {
         "name" => @multi_silo_project.name
       }
+
       @multi_silo_project.name_silo.should eq(_expectation)
     end
 
@@ -147,21 +199,25 @@ describe Silo do
         "city" => @multi_silo_project.city,
         "county" => @multi_silo_project.county
       }
+
       @multi_silo_project.location_silo.should eq(_expectation)
     end
 
     it "Correctly updates both silos" do
-      @multi_silo_project.city    = Faker::Address.city
-      @multi_silo_project.county  = Faker::AddressUK.county
-      @multi_silo_project.name    = Faker::Name.name
+      @multi_silo_project.city   = Faker::Address.city
+      @multi_silo_project.county = Faker::AddressUK.county
+      @multi_silo_project.name   = Faker::Name.name
       @multi_silo_project.save
+
       _name_silo_expectation = {
         "name" => @multi_silo_project.name
       }
+
       _location_silo_expectation = {
         "city" => @multi_silo_project.city,
         "county" => @multi_silo_project.county
       }
+
       @multi_silo_project.name_silo.should eq(_name_silo_expectation)
       @multi_silo_project.location_silo.should eq(_location_silo_expectation)
     end
@@ -171,16 +227,13 @@ describe Silo do
       Silo.count.should eq(0)
     end
   end
-  
+
   context "Callbacks" do
     subject(:project) { build(:callback_project) }
-    
+
     it "should trigger a named callback" do
       CallbackProject.should_receive(:triggered)
-      project.save 
+      project.save
     end
-    
-    
   end
-
-end
+end

data/spec/support/models/versioned_project.rb

@@ -0,0 +1,9 @@
+class VersionedProject
+  include Mongoid::Document
+  include Mongoid::Silo
+
+  silo :foobar do |conf|
+    conf.generator = "MakeVersionedProjectGrainBelt"
+  end
+end
+

data/spec/support/silovators/make_versioned_grain_belt.rb

@@ -0,0 +1,9 @@
+class MakeVersionedProjectGrainBelt < MongoidSilo::GrainBelt
+  version 1 do
+    { foo: "bar" }
+  end
+
+  version 2 do
+    { foo: "baz" }
+  end
+end

metadata

@@ -1,64 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_silo
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - John Maxwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.9
-    none: false
-  name: activesupport
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.9
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
-    none: false
-  name: mongoid
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
-    none: false
-  name: sidekiq
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
-    none: false
 description: MongoidSilo gives a simple way to create static representations of models
 email:
 - john@musicglue.com
@@ -98,33 +91,34 @@ files:
 - spec/support/models/complex_project.rb
 - spec/support/models/multi_silo_project.rb
 - spec/support/models/project.rb
+- spec/support/models/versioned_project.rb
 - spec/support/silovators/make_block_project_grain_belt.rb
 - spec/support/silovators/make_complex_grain_belt.rb
 - spec/support/silovators/make_location_grain_belt.rb
 - spec/support/silovators/make_name_grain_belt.rb
+- spec/support/silovators/make_versioned_grain_belt.rb
 homepage: https://github.com/musicglue/mongoid_silo
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: MongoidSilo is a bit like a Grain Elevator, but without the grain.
 test_files:
 - spec/factories/block_project_factory.rb
@@ -143,8 +137,9 @@ test_files:
 - spec/support/models/complex_project.rb
 - spec/support/models/multi_silo_project.rb
 - spec/support/models/project.rb
+- spec/support/models/versioned_project.rb
 - spec/support/silovators/make_block_project_grain_belt.rb
 - spec/support/silovators/make_complex_grain_belt.rb
 - spec/support/silovators/make_location_grain_belt.rb
 - spec/support/silovators/make_name_grain_belt.rb
-has_rdoc: 
+- spec/support/silovators/make_versioned_grain_belt.rb