mongoid_silo 0.0.7 → 0.1.0

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--require rspec/instafail
+--format RSpec::Instafail
+--fail-fast
+--drb

data/.travis.yml

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

data/Gemfile

@@ -2,3 +2,23 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mongoid-silo.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'factory_girl'
+  gem 'database_cleaner'
+  gem 'fuubar'
+  gem 'faker'
+  gem 'spork'
+end
+
+group :development do
+  gem 'guard'
+  gem 'terminal-notifier-guard'
+  gem 'guard-rspec'
+  gem 'guard-spork'
+  gem 'guard-bundler'
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch("Gemfile")
+end
+
+guard :rspec do
+  watch(%r{^app/models/(.+)\.rb$}) { |m| "spec/models/#{m[1]}_spec.rb" }
+  watch(%r{^app/workers/(.+)\.rb$}) { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/musicglue/mongoid_silo)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/musicglue/mongoid_silo) [![Build Status](https://travis-ci.org/musicglue/mongoid_silo.png?branch=master)](https://travis-ci.org/musicglue/mongoid_silo)
 # MongoidSilo
 
 MongoidSilo creates and transparently manages static representations of a model - e.g. for creating Feeds or other diverse datastructures.
@@ -27,12 +27,28 @@ Include ```Mongoid::Silo``` in your model, and then declare your silos.
 
 ```ruby
 # The default usage creates a "default" silo, accessable through instance#default_silo that will call
-# an instance#to_silo method to populate itself on save.
+# down to the default 'GrainBelt' generator. This will simply store all the attributes on your model,
+# so you almost certainly don't want this. See below for more details.
 silo
 
-# Or you can specify the silo name and the method that will be called to populate it, like so...
-silo :feed, :make_my_feed
+# Or you can specify the silo name and the class that will be called to populate it, like so...
+silo :feed, generator: "MyGeneratorClass"
+
+# To create a custom generator class, simply inherit from MongoidSilo::GrainBelt and override the
+# generate method.
+class MyGeneratorClass < MongoidSilo::GrainBelt
+  def generate
+    {
+      name: name,
+      age: age,
+      dingbats: true
+    }
+  end
+end
 ```
+The generator class gets passed the instance of your model when the Silo is generated, and it exposes
+your methods and attributes on that instance. Otherwise, you have access to the instance through the ```object``` accessor.
+
 
 ## Contributing
 

data/app/workers/mongoid_silo/update_silo_worker.rb

@@ -5,33 +5,51 @@ module MongoidSilo
   class UpdateSiloWorker
     include Sidekiq::Worker
 
-    def perform(item_id, item_class, name, mode="save", method=nil)
-      @item_id, @item_class = item_id, item_class
+    def perform(item_id, item_class, name, mode="save", generator=nil)
+      @item_id, @item_class, @generator = item_id, item_class, generator
 
-      mode.to_s == "save" ? update_silo(name, method) : destroy_silo(name)
+      mode.to_s == "save" ? update_silo(name, generator) : destroy_silo(name)
     end
 
 
     private
-    def update_silo name, method
-      puts "[SILO] Creating or Updating Silo for #{@item_class}::::#{@item_id}"
-      @item = @item_class.classify.constantize.send(:find, @item_id)
+    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, @item.send(method))
+        @silo.set(:bag, @content)
       else
-        @silo = Silo.create(item_class: @item_class, item_id: @item_id, bag: @item.send(method), silo_type: name)
+        @silo = Silo.create(item_class: @item_class, item_id: @item_id, bag: @content, silo_type: name)
       end
     end
 
     def destroy_silo name
-      puts "[SILO] Destroying Silo for #{@item_class}::::#{@item_id}"
       @silo = Silo.where(item_class: @item_class, item_id: @item_id, silo_type: name).first
       if @silo
         @silo.destroy
       end
     end
 
+    def item_class
+      cl = nil
+      @item_class.split("::").inject(nil) do |parent, identifier|
+        parent ||= Kernel
+        cl = parent.const_get(identifier)
+      end
+      cl
+    end
+
+
+    def generator_class
+      cl = nil
+      @generator.split("::").inject(nil) do |parent, identifier|
+        parent ||= Kernel
+        cl = parent.const_get(identifier)
+      end
+      cl
+    end
+
   end
     
 end

data/lib/mongoid/silo.rb

@@ -5,13 +5,14 @@ module Mongoid
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def silo name=:default, method=:to_silo
+      def silo name=:default, opts={}
+        opts[:generator] ||= "MongoidSilo::GrainBelt"
         define_method "#{name}_silo" do
           from_silo name
         end
 
         set_callback :save, :after do
-          update_silo name, method
+          update_silo name, opts[:generator]
         end
 
         set_callback :destroy, :after do
@@ -20,36 +21,30 @@ module Mongoid
       end
     end
 
-    module InstanceMethods
-      def update_silo name, method
-        MongoidSilo::UpdateSiloWorker.perform_async(self.id.to_s, self.class.to_s, name, :save, method)
-      end
-
-      def destroy_silo name
-        MongoidSilo::UpdateSiloWorker.perform_async(self.id.to_s, self.class.to_s, name, :destroy)
-      end
+    def update_silo name, generator
+      MongoidSilo::UpdateSiloWorker.perform_async(self.id.to_s, self.class.to_s, name, :save, generator)
+    end
 
-      def to_silo #OVERWRITE THIS IN YOUR MODELS, BITCHES
-        {}
-      end
+    def destroy_silo name
+      MongoidSilo::UpdateSiloWorker.perform_async(self.id.to_s, self.class.to_s, name, :destroy)
+    end
 
-      def from_silo name="default"
-        if @bag && @bag[name]
-          @bag[name]
-        else
-          @bag = {}
-          @bag[name] ||= begin
-            silo = ::Silo.where(item_class: self.class.to_s, item_id: self.id.to_s, silo_type: name).first
-            silo.bag
-          rescue Mongoid::Errors::DocumentNotFound
-            {}
-          end
+    def from_silo name="default"
+      if @bag && @bag[name]
+        @bag[name]
+      else
+        @bag = {}
+        @bag[name] ||= begin
+          silo = ::Silo.where(item_class: self.class.to_s, item_id: self.id.to_s, silo_type: name).first
+          silo.bag
+        rescue Mongoid::Errors::DocumentNotFound
+          {}
         end
       end
+    end
 
-      def json_from_silo
-        MultiJson.encode from_silo
-      end
+    def json_from_silo
+      MultiJson.encode from_silo
     end
   end
 end

data/lib/mongoid_silo/grain_belt.rb

@@ -0,0 +1,22 @@
+module MongoidSilo
+  class GrainBelt
+
+    attr_accessor :object
+    
+    def initialize(object)
+      @object = object
+    end
+
+    def method_missing(meth, *args)
+      object.send(meth)
+    end
+
+    def generate
+      out = {}
+      object.attribute_names.each do |attribute|
+        out[attribute] = object.send(attribute) unless ["_type", "_id"].include?(attribute)
+      end
+      out
+    end
+  end
+end

data/lib/mongoid_silo/version.rb

@@ -1,3 +1,3 @@
 module MongoidSilo
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/mongoid_silo.rb

@@ -1,8 +1,9 @@
 require "mongoid_silo/version"
 require 'mongoid_silo/railtie' if defined?(Rails)
+require 'mongoid_silo/grain_belt'
 require 'mongoid/silo'
-require_relative '../app/models/silo'
-require_relative '../app/workers/mongoid_silo/update_silo_worker'
+
+Dir['./app/**/*.rb'].each{ |file| require file }
 
 module MongoidSilo
 end

data/spec/factories/complex_project_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :complex_project do
+    name { Faker::Name.name }
+    due_date { DateTime.now }
+  end
+end

data/spec/factories/multi_silo_project_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :multi_silo_project do
+    name { Faker::Name.name }
+    city { Faker::Address.city }
+    country { Faker::Address.country }
+  end
+end

data/spec/factories/project_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :project do
+    name { Faker::Name.name }
+  end
+end

data/spec/lib/grain_belt_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MongoidSilo::GrainBelt do
+  context "Instantiated with a simple model" do
+
+    before do
+      @model = create(:project)
+      @silovator = MongoidSilo::GrainBelt.new(@model)
+    end
+
+    it "exposes the model's properties without prefixing" do
+      @silovator.name.should eq(@model.name)
+    end
+
+    it "exposes the model through the object accessor" do
+      @silovator.object.should eq(@model)
+    end
+
+    it "generates a hash for storing in the silo" do
+      @silovator.generate.should be_a(Hash)
+    end
+
+  end
+end

data/spec/models/silo_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Silo do
+
+  context 'simple silos' do
+    before do
+      @project = create(:project)
+    end
+
+    it "should persist a Silo" do
+      @project.should be_persisted
+      Silo.count.should eq(1)
+    end
+
+    it "should contain the name of the project" do
+      @project.default_silo.should eq({"name" => @project.name})
+    end
+
+    it "should update the name if the name changes" do
+      @project.name = Faker::Name.name
+      @project.save
+      @project.default_silo["name"].should eq(@project.name)
+    end
+
+    it "should delete the silo if the project is deleted" do
+      @project.destroy
+      Silo.count.should eq(0)
+    end
+
+  end
+
+  context 'Direct finders and methods:' do
+    before do
+      @project1 = create(:project)
+      @project2 = create(:project)
+      @project3 = create(:complex_project)
+    end
+
+    it "should find by id and silo type" do
+      found = Silo.for_id_and_name_with_no_class(@project1.id.to_s, "default")
+      found.should_not be_nil
+    end
+
+    it "should find by id and class and silo type" do
+      found = Silo.for_id_and_class_with_name(@project1.id.to_s, @project1.class.to_s, "default")
+      found.should_not be_nil
+    end
+
+    it "should find complex documents" do
+      found = Silo.for_id_and_class_with_name(@project3.id.to_s, @project3.class.to_s, "complex")
+      found.should_not be_nil
+    end
+
+    it "should not find where no match exists" do
+      found = Silo.for_id_and_class_with_name("wombats", "aren't", "real")
+      found.should be_nil
+    end
+
+    it "should serialize to JSON correctly" do
+      found = Silo.for_id_and_class_with_name(@project1.id.to_s, @project1.class.to_s, "default")
+      MultiJson.decode("#{found.to_json}").should be_a(Hash)
+    end
+  end
+
+  context "Custom Silo constructors:" do
+    before do
+      @complex_project = create(:complex_project)
+    end
+
+    it "defines an accessor based on the declared silo name" do
+      @complex_project.should respond_to(:complex_silo)
+    end
+
+    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 "Multiple silo constructors:" do
+    before do
+      @multi_silo_project = create(:multi_silo_project)
+    end
+
+    it "Creates two silos" do
+      Silo.count.should eq(2)
+    end
+
+    it "Correctly populates the Name silo" do
+      _expectation = {
+        "name" => @multi_silo_project.name
+      }
+      @multi_silo_project.name_silo.should eq(_expectation)
+    end
+
+    it "Correctly populates the Location silo" do
+      _expectation = {
+        "city" => @multi_silo_project.city,
+        "country" => @multi_silo_project.country
+      }
+      @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.country = Faker::Address.country
+      @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,
+        "country" => @multi_silo_project.country
+      }
+      @multi_silo_project.name_silo.should eq(_name_silo_expectation)
+      @multi_silo_project.location_silo.should eq(_location_silo_expectation)
+    end
+
+    it "Destroys both silos when project is deleted" do
+      @multi_silo_project.destroy
+      Silo.count.should eq(0)
+    end
+  end
+
+end

data/spec/mongoid.yml

@@ -0,0 +1,9 @@
+test:
+  sessions:
+    default:
+      hosts:
+        - localhost:27017
+      database: mongoid_silo-test
+      options:
+        identity_map_enabled: false
+        safe: false

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'spork'
+require 'guard/rspec'
+require 'rspec'
+
+Spork.prefork do
+  require 'mongoid_silo'
+  require 'factory_girl'
+  require 'database_cleaner'
+  require 'faker'
+  require 'sidekiq/testing/inline'
+  # Loading more in this block will cause your tests to run faster. However,
+  # if you change any configuration or code from libraries loaded here, you'll
+  # need to restart spork for it take effect.
+  FactoryGirl.find_definitions
+
+  Mongoid.load!(File.expand_path("../mongoid.yml", __FILE__), :test)
+
+
+
+  RSpec.configure do |config|
+    config.include FactoryGirl::Syntax::Methods
+
+    config.before(:suite) do
+      DatabaseCleaner.strategy = :truncation
+      DatabaseCleaner.clean
+    end
+
+    config.after(:each) do
+      DatabaseCleaner.clean
+    end
+  end
+
+  Dir['./spec/support/**/*.rb'].each{ |file| require file }
+end
+
+Spork.each_run do
+  Dir['./app/**/*.rb'].each { |file| require file }
+end
+
+
+
+
+
+
+
+
+
+

data/spec/support/models/complex_project.rb

@@ -0,0 +1,11 @@
+class ComplexProject
+  include Mongoid::Document
+  include Mongoid::Silo
+
+  field :name, type: String
+  field :due_date, type: DateTime
+
+
+  silo :complex, generator: "MakeComplexGrainBelt"
+
+end

data/spec/support/models/multi_silo_project.rb

@@ -0,0 +1,12 @@
+class MultiSiloProject
+  include Mongoid::Document
+  include Mongoid::Silo
+
+  field :name, type: String
+  field :city, type: String
+  field :country, type: String
+
+  silo :name, generator: "MakeNameGrainBelt"
+  silo :location, generator: "MakeLocationGrainBelt"
+
+end

data/spec/support/models/project.rb

@@ -0,0 +1,9 @@
+class Project
+  include Mongoid::Document
+  include Mongoid::Silo
+
+  field :name, type: String
+
+  silo
+  
+end

data/spec/support/silovators/make_complex_grain_belt.rb

@@ -0,0 +1,8 @@
+class MakeComplexGrainBelt < MongoidSilo::GrainBelt
+  def generate
+    {
+      name: name,
+      due_date: due_date
+    }
+  end
+end

data/spec/support/silovators/make_location_grain_belt.rb

@@ -0,0 +1,8 @@
+class MakeLocationGrainBelt < MongoidSilo::GrainBelt
+  def generate
+    {
+      city: city,
+      country: country
+    }
+  end
+end

data/spec/support/silovators/make_name_grain_belt.rb

@@ -0,0 +1,7 @@
+class MakeNameGrainBelt < MongoidSilo::GrainBelt
+  def generate
+    {
+      name: name
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_silo
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,7 +67,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -75,9 +78,23 @@ files:
 - app/workers/mongoid_silo/update_silo_worker.rb
 - lib/mongoid/silo.rb
 - lib/mongoid_silo.rb
+- lib/mongoid_silo/grain_belt.rb
 - lib/mongoid_silo/railtie.rb
 - lib/mongoid_silo/version.rb
 - mongoid_silo.gemspec
+- spec/factories/complex_project_factory.rb
+- spec/factories/multi_silo_project_factory.rb
+- spec/factories/project_factory.rb
+- spec/lib/grain_belt_spec.rb
+- spec/models/silo_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/support/models/complex_project.rb
+- spec/support/models/multi_silo_project.rb
+- spec/support/models/project.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
 homepage: https://github.com/musicglue/mongoid_silo
 licenses: []
 post_install_message: 
@@ -102,5 +119,18 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: MongoidSilo is a bit like a Grain Elevator, but without the grain.
-test_files: []
+test_files:
+- spec/factories/complex_project_factory.rb
+- spec/factories/multi_silo_project_factory.rb
+- spec/factories/project_factory.rb
+- spec/lib/grain_belt_spec.rb
+- spec/models/silo_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/support/models/complex_project.rb
+- spec/support/models/multi_silo_project.rb
+- spec/support/models/project.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: