mongoid-included 0.0.1 → 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-rspec.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alexandre Angelim
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+Mongoid::Included
+====================
+
+Helper module to embed documents using the parent's namespace while preserving url helpers consistency. This is useful to organize your project if you heavily rely on embedded documents. This gem concerns the issue 1429 of rails repository: https://github.com/rails/rails/issues/1429
+Works with [Mongoid 2.0](https://github.com/mongoid/mongoid) and ActiveModel 3.1.0.beta1. 
+
+Installation
+------------
+
+Add the gem to your Bundler `Gemfile`:
+
+    gem 'mongoid-included'
+
+Or install with RubyGems:
+
+    $ gem install mongoid-included
+
+
+Usage
+-----
+
+In your embedded model:
+
+	# Include the helper module
+	include Mongoid::DocumentInclusion
+
+	# Define parent document in embedded class
+	included_in :invoice
+
+In your parent model:
+
+	# Define embedded relation in parent document
+	includes_many :items
+	includes_one :user
+    
+
+Example
+-------
+
+	class Invoice
+		include Mongoid::Document
+		include Mongoid::DocumentInclusion
+		
+		includes_many :items
+	end
+	
+	# This will generate a Mongoid Relation with the following signature:
+		embeds_many :items, :class_name => Invoice::Item
+
+	class Invoice::Item
+		include Mongoid::Document
+		include Mongoid::DocumentInclusion
+	
+		included_in :invoice
+	end
+	# This will generate the following code:
+		extend ActiveModel::Naming
+		# Overriding .model_name so rails recognizes the class as __Item__ and generate more convenient urls.
+		def model_name
+			if self.parent != Object
+				ActiveModel::Name.new(self, self.parent)
+			else
+				super
+			end
+		end
+		
+		embedded_in :invoice
+
+	# Define routes with the embedded document as a nested resource
+	resources :invoices do
+		resources :items
+	end
+	
+	# if you decide that the controller should also use namespaces, place the __items_controller__ inside an __invoices__ folder and use:
+	resources :invoices do
+		resources :items, :module => :invoices
+	end
+	
+	
+	
+Rake tasks
+----------
+
+Todo
+----------
+
+Known issues
+------------
+
+
+Credits
+-------
+
+Copyright (c) 2011 Alexandre Angelim, released under the MIT license.

data/Rakefile

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require "rspec"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new("spec:functional") do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/functional/**/*_spec.rb"
+end
+
+task :default => :spec
+task :test => :spec
+
+require 'rake/rdoctask'
+require "mongoid-included/version"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid-included #{Mongoid::Mirrored::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mongoid-included.rb

@@ -0,0 +1,2 @@
+require 'mongoid'
+require 'mongoid-included/document_inclusion'

data/lib/mongoid-included/document_inclusion.rb

@@ -0,0 +1,67 @@
+module Mongoid
+  module DocumentInclusion
+    extend ActiveSupport::Concern
+    
+    class NotMongoidDocument < StandardError; end;
+    class DocumentAlreadyIncluded < StandardError; end;
+      
+    included do
+      extend ActiveModel::Naming
+      cattr_accessor :inclusion_model
+    end
+    
+    module ClassMethods
+      def included_in(_model, args = {})
+        raise NotMongoidDocument,       "Document must be a Mongoid Document" unless mongoid_document? self
+        raise NotMongoidDocument,       "Parent document must be a Mongoid Document" unless mongoid_document? self.parent
+        raise DocumentAlreadyIncluded,  "Document can be included only in one class" if inclusion_model
+        embedded_in _model, args
+        self.inclusion_model = true
+      end
+      
+      def includes_many(_model, args = {})
+        verify_dependencies(_model)
+        embeds_many _model, args.merge(:class_name => included_klass(_model))
+        self.inclusion_model = true
+      end
+      
+      def includes_one(_model, args = {})
+        verify_dependencies(_model)
+        embeds_one _model, args.merge(:class_name => included_klass(_model))
+        self.inclusion_model = true
+      end
+      
+      def model_name
+        if self.parent != Object
+          ActiveModel::Name.new(self, self.parent)
+        else
+          super
+        end
+      end
+      
+      private
+      
+      def model_klass_name(_model)
+        _model.to_s.classify
+      end
+      
+      def model_klass(_model)
+        _model.to_s.classify.constantize
+      end
+      
+      def included_klass(_model)
+        "#{self}::#{model_klass_name(_model)}"
+      end
+        
+      def mongoid_document?(_model)
+        _model.ancestors.include?(Mongoid::Document)
+      end
+      
+      def verify_dependencies(_model)
+        raise NotMongoidDocument,       "Document must be a Mongoid Document" unless mongoid_document? self
+        raise NotMongoidDocument,       "Descendent document must be a Mongoid Document" unless mongoid_document? model_klass(included_klass(_model))
+      end
+      
+    end
+  end
+end

data/lib/mongoid-included/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Included
+    VERSION = "0.0.2"
+  end
+end

data/mongoid-included.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid-included/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid-included"
+  s.version     = Mongoid::Included::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors = ["Alexandre Angelim"]
+  s.email = %q{angelim@angelim.com.br}  
+  s.homepage = %q{http://github.com/angelim/mongoid-included}    
+  s.summary = %q{Included namespaces documents for Mongoid}  
+  s.description = %q{Helper to facilitate inclusion of namespaced documents in another Mongoid Document}
+    
+  s.rubyforge_project = "mongoid-included"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency("activemodel", ["~> 3.1.0.beta1"])
+  s.add_runtime_dependency(%q<mongoid>, ["~> 2.0"])
+  s.add_development_dependency("rspec", ["~> 2.6"])
+  s.add_development_dependency("bson_ext", ["~> 1.3"])
+  
+end

data/spec/functional/invoice.rb

@@ -0,0 +1,16 @@
+# test methods
+# test from_mirror
+require 'spec_helper'
+
+describe Invoice do
+  let(:invoice) { Invoice.create(:title => "InvoiceTest") }
+  
+  it "respond to items" do
+    invoice.should respond_to(:items)
+  end
+  
+  it "has proxy to items" do
+    invoice.items.create(:name => "ItemTest")
+    invoice.items.should have(1).item
+  end
+end

data/spec/functional/item.rb

@@ -0,0 +1,16 @@
+# test methods
+# test from_mirror
+require 'spec_helper'
+
+describe Invoice::Item do
+  let(:invoice) { Invoice.create(:title => "InvoiceTest") }
+  let(:item) { invoice.items.create(:name => "ItemTest") }
+  
+  it "respond to invoice" do
+    item.should respond_to(:invoice)
+  end
+  
+  it "has proxy to invoice" do
+    item.invoice.should == invoice
+  end
+end

data/spec/models/inclusion.rb

@@ -0,0 +1,12 @@
+class Invoice
+  includes_many :items
+  includes_one :user, :inverse_of => :invoice, :index => true
+end
+
+class Invoice::Item
+  included_in :invoice
+end
+
+class Invoice::User
+  included_in :invoice, :inverse_of => :user
+end

data/spec/models/invoice.rb

@@ -0,0 +1,6 @@
+class Invoice
+  include Mongoid::Document
+  include Mongoid::DocumentInclusion
+  field :title  
+  validates_presence_of :title
+end

data/spec/models/invoice/item.rb

@@ -0,0 +1,11 @@
+class Invoice::Item
+  include Mongoid::Document
+  include Mongoid::DocumentInclusion
+  
+  field :name  
+  field :test, :default => "ale"
+  field :test1, :default => "ale"
+  
+
+  validates_presence_of :name
+end

data/spec/models/invoice/user.rb

@@ -0,0 +1,6 @@
+class Invoice::User
+  include Mongoid::Document
+  include Mongoid::DocumentInclusion
+  
+  field :name
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require 'rspec'
+require 'mongoid'
+require 'mongoid-included'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+MODELS = [File.join(File.dirname(__FILE__), "models"), File.join(File.dirname(__FILE__), "models/invoice")]
+MODELS.each do |_model|
+  $LOAD_PATH.unshift(_model)  
+end
+require 'models/invoice'
+require 'models/invoice/item'
+require 'models/invoice/user'
+require 'models/inclusion'
+    
+Mongoid.configure do |config|
+  name = "mongoid-included-test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  config.autocreate_indexes = true
+end
+
+# MODELS.each do |_model|
+#   Dir[ File.join(_model, "*.rb") ].sort.each { |file| require File.basename(file) }
+# end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.after :each do
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+  end
+end

data/spec/unit/included_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe "Mongoid::Included" do
+
+  context "when parent class includes a child" do
+    it "delegates options to mongoid relation macro" do
+      Invoice.relations["user"].inverse_of.should == :invoice
+    end
+    
+    it "embeds many children with given association name" do
+      Invoice.relations.keys.include? "items"
+      Invoice.relations["items"].macro.should == :embeds_many
+    end
+    
+    it "embeds one child with given association name" do
+      Invoice.relations.keys.include? "item"
+      Invoice.relations["user"].macro.should == :embeds_one
+    end
+    
+    it "embeds child with given association class" do
+      Invoice.relations["items"].class_name.should == "Invoice::Item"
+    end
+    
+    it "issues an error if not mongoid document" do
+      Object.const_set "NonMongoidDocument", Class.new
+      NonMongoidDocument.send(:include, Mongoid::DocumentInclusion)
+      NonMongoidDocument.const_set "NonMongoidEmbed", Class.new
+      begin
+        NonMongoidDocument.includes_many :non_mongoid_embeds
+      rescue => e
+        e.class.should == Mongoid::DocumentInclusion::NotMongoidDocument
+        e.message.should =~ /Document must be a Mongoid Document/
+      end
+    end
+    
+    it "issues an error if child is not mongoid document" do
+      Object.const_set "NonMongoidDocument", Class.new
+      NonMongoidDocument.const_set "NonMongoidEmbed", Class.new
+      NonMongoidDocument.send(:include, Mongoid::Document)
+      NonMongoidDocument.send(:include, Mongoid::DocumentInclusion)
+      begin
+        NonMongoidDocument.includes_many :non_mongoid_embeds
+      rescue => e
+        e.class.should == Mongoid::DocumentInclusion::NotMongoidDocument
+        e.message.should =~ /Descendent document must be a Mongoid Document/
+      end
+    end
+  
+  end
+  
+  context "when child class is included in parent" do
+    
+    it "delegates options to mongoid relation macro" do
+      Invoice::User.relations["invoice"].inverse_of.should == :user
+    end
+    
+    it "is embedded in parent class" do
+      Invoice::Item.relations.keys.include? "invoice"
+      Invoice::Item.relations["invoice"].macro.should == :embedded_in
+    end
+    
+    it "strips namespace from param_key" do
+      Invoice::Item.model_name.param_key.should == "item"
+    end
+    
+    it "strips namespace from #route_key" do
+      Invoice::Item.model_name.route_key.should == "items"
+    end
+    
+    it "forbids inclusion in another parent" do
+      begin
+        Invoice::Item.included_in :invoice
+      rescue => e
+        e.class.should == Mongoid::DocumentInclusion::DocumentAlreadyIncluded
+      end
+    end
+  
+    
+    it "issues an error if parent is not mongoid document" do
+      Object.const_set "NonMongoidDocument", Class.new
+      NonMongoidDocument.const_set "NonMongoidParent", Class.new
+      NonMongoidDocument.send(:include, Mongoid::Document)
+      NonMongoidDocument.send(:include, Mongoid::DocumentInclusion)
+      begin
+        NonMongoidDocument.included_in :invoice
+      rescue => e
+        e.class.should == Mongoid::DocumentInclusion::NotMongoidDocument
+        e.message.should =~ /Parent document must be a Mongoid Document/
+      end
+    end    
+    
+    it "issues an error if parent is not mongoid document" do
+      Object.const_set "NonMongoidDocument", Class.new
+      NonMongoidDocument.const_set "NonMongoidParent", Class.new
+      NonMongoidDocument.send(:include, Mongoid::DocumentInclusion)
+      begin
+        NonMongoidDocument.included_in :invoice
+      rescue => e
+        e.class.should == Mongoid::DocumentInclusion::NotMongoidDocument
+        e.message.should =~ /Document must be a Mongoid Document/
+      end
+    end
+    
+  end
+  
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alexandre Angelim
@@ -83,8 +83,27 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid-included.rb
+- lib/mongoid-included/document_inclusion.rb
+- lib/mongoid-included/version.rb
+- log/development.log
+- mongoid-included.gemspec
+- spec/functional/invoice.rb
+- spec/functional/item.rb
+- spec/models/inclusion.rb
+- spec/models/invoice.rb
+- spec/models/invoice/item.rb
+- spec/models/invoice/user.rb
+- spec/spec_helper.rb
+- spec/unit/included_spec.rb
 has_rdoc: true
 homepage: http://github.com/angelim/mongoid-included
 licenses: []
@@ -117,5 +136,12 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Included namespaces documents for Mongoid
-test_files: []
-
+test_files: 
+- spec/functional/invoice.rb
+- spec/functional/item.rb
+- spec/models/inclusion.rb
+- spec/models/invoice.rb
+- spec/models/invoice/item.rb
+- spec/models/invoice/user.rb
+- spec/spec_helper.rb
+- spec/unit/included_spec.rb