mongoid_embedded_helper 0.1.0

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_STORE
+
+# yard generated
+doc
+.yardoc
+
+# jeweler generated
+pkg
+vendor
+.bundle
+
+
+

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+gem 'mongoid' 
+gem 'bson_ext', '>=1.0.1'
+
+group :test do
+  gem 'rspec', '>= 2.0.0.beta.15'
+  gem 'mocha'
+end

data/MITLICENSE

@@ -0,0 +1,22 @@
+Copyright (c) <#{Time.new.year}> <#{ENV['USERNAME'] || ENV['USER']}>
+
+ 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.markdown

@@ -0,0 +1,36 @@
+# Mongoid embedded helper #
+
+The Mongoid EmbeddedHelper helps overcome the limitation that you can't perform direct queries on an embedded collection without accessing it from the root.
+It simply introduces a generic function that performs the "local" query by accessing it from the nearest root ;)
+
+## Installation ##  
+
+<code>gem install mongoid_embedded_helper</code>
+
+## Usage ##
+
+Mongoid doesn't allow you to perform direct queries on an embedded collection. You have to access the embedded collection from the root in order to do this.
+To overcome this limitation, use the EmbeddedHelper module to add a method <code>query_class</code> which will find the closest non-embedded node in the hierarchy and
+then traverse down the path back to the object, so that you can perform the query on the embedded collection.
+
+<code>
+require 'mongoid_embedded_helper'
+
+class Item
+  include Mongoid::Document      
+  include Mongoid::EmbeddedHelper
+  field :pos, :type => Integer  
+  field :number, :type => Integer  
+  
+  field :assoc, :type => Symbol
+  embedded_in :list, :inverse_of => :items   
+end
+
+item = @person.lists[0].items[0]
+item.query_class.where(:number.gt => 1).to_a  
+  
+</code>
+
+## Copyright ##
+
+Copyright (c) <2010> <Kristian Mandrup>

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongoid_embedded_helper"
+    gem.summary = %Q{Facilitates performing queries on collections in embedded Mongoid documents}
+    gem.description = %Q{Facilitates performing queries on collections in embedded Mongoid documents by performing query from the root node}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/mongoid_embedded_helper"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_dependency("mongoid", "<= 2.0.0")
+    gem.add_dependency("bson", ">= 1.0.3")
+
+    gem.add_development_dependency "rspec", ">=2.0.0.beta.12"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+# 
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+# end
+# 
+# begin
+#   require 'rcov/rcovtask'
+#   Rcov::RcovTask.new do |test|
+#     test.libs << 'test'
+#     test.pattern = 'test/**/test_*.rb'
+#     test.verbose = true
+#   end
+# rescue LoadError
+#   task :rcov do
+#     abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+#   end
+# end
+# 
+# task :test => :check_dependencies
+# 
+# task :default => :test
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "mongoid_acts_as_tree #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+# 

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/mongoid/embedded_helper.rb

@@ -0,0 +1,36 @@
+require 'mongoid'
+
+module Mongoid
+  module EmbeddedHelper                  
+    def in_collection stack = []
+      stack.extend(ArrayExt) if stack.empty?
+      if embedded?        
+        stack.add_collection_name self
+        _parent.in_collection(stack)
+      else  
+        return self.class if stack.empty?      
+        iterate_collection_stack stack
+      end
+    end
+    
+    private 
+         
+    def iterate_collection_stack stack
+      collection = self
+      stack = stack.reverse
+      stack.each do |entry|
+        sub_collection = collection.send entry[:collection_name]    
+        index = sub_collection.to_a.index(entry[:object]) if entry != stack.last        
+        collection = sub_collection[index] if index
+        collection = sub_collection  if !index
+      end
+      collection
+    end
+    
+    module ArrayExt
+      def add_collection_name obj
+        self << {:collection_name => obj.collection_name, :object => obj}
+      end      
+    end    
+  end
+end

data/lib/mongoid_embedded_helper.rb

@@ -0,0 +1 @@
+require 'mongoid/embedded_helper'

data/spec/mongoid/embedded_helper_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+Mongoid.configure.master = Mongo::Connection.new.db('acts_as_list-test')
+
+class Person
+  include Mongoid::Document
+  include Mongoid::EmbeddedHelper
+  field :name, :type => String
+  embeds_many :lists   
+end  
+
+
+class List
+  include Mongoid::Document
+  include Mongoid::EmbeddedHelper
+  field :pos, :type => Integer  
+  field :name, :type => String
+  embedded_in :person, :inverse_of => :lists
+  
+  embeds_many :items     
+end
+
+
+class Item
+  include Mongoid::Document      
+  include Mongoid::EmbeddedHelper
+  field :pos, :type => Integer  
+  field :number, :type => Integer  
+  
+  field :assoc, :type => Symbol
+  embedded_in :list, :inverse_of => :items   
+end    
+
+describe 'Mongoid Embedded Helper' do
+
+  before :each do
+    @person = Person.create! :name => 'Kristian'
+    # person.lists = []               
+    list = List.new :pos => 1, :name => 'My list'
+    (1..3).each do |counter|  
+      item = Item.new :pos => counter, :number => counter
+      list.items << item  
+    end
+    @person.lists << list
+    @person.save!
+  end
+  
+  after :each do
+    Mongoid.database.collections.each do |coll|
+      coll.remove
+    end
+  end  
+     
+  describe '#top level query' do
+  
+    it "should handle query from top level node" do
+      result = @person.in_collection.where(:name => 'Kristian').to_a.first  
+      result.name.should == 'Kristian'
+    end
+  
+    it "should handle query from mid level node" do
+      result = @person.lists[0].in_collection.where(:name => 'My list').to_a.first  
+      result.name.should == 'My list'
+    end
+  
+    it "should handle query from mid level node" do
+      result = @person.lists[0].items[0].in_collection.where(:number.gt => 1).to_a  
+      result.size.should == 2
+    end
+  end  
+end
+

data/spec/rspec.options

@@ -0,0 +1 @@
+--format nested --color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+require 'rspec'
+require 'rspec/autorun'
+require 'mongoid_embedded_helper'
+
+RSpec.configure do |config|
+  # config.mock_with :mocha
+end
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_embedded_helper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <=
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 12
+        version: 2.0.0.beta.12
+  type: :development
+  version_requirements: *id003
+description: Facilitates performing queries on collections in embedded Mongoid documents by performing query from the root node
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- Gemfile
+- MITLICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- lib/mongoid/embedded_helper.rb
+- lib/mongoid_embedded_helper.rb
+- spec/mongoid/embedded_helper_spec.rb
+- spec/rspec.options
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/mongoid_embedded_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Facilitates performing queries on collections in embedded Mongoid documents
+test_files: 
+- spec/mongoid/embedded_helper_spec.rb
+- spec/spec_helper.rb