mm-nested-attributes 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -0,0 +1,2 @@
+== 0.1.0 / 2010-07-10
+  * Nested attributes functionality for collections.

data/README.txt

@@ -0,0 +1,62 @@
+mm-nested-attributes
+    by Toni Tuominen
+    http://github.com/tjtuom/mm-nested-attributes
+
+== DESCRIPTION:
+
+A port of ActiveRecord's nested attributes functionality for MongoMapper.
+
+== FEATURES/PROBLEMS:
+
+At the moment only collection functionality is supported.
+
+== SYNOPSIS:
+
+class Parent
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Associations::NestedAttributes
+
+  many :children
+  accepts_nested_attributes_for :children
+end
+
+class Child
+  include MongoMapper::Document
+
+  key :foo, String
+end
+
+== REQUIREMENTS:
+
+* MongoMapper
+
+== INSTALL:
+
+Add
+gem 'mm-nested-attributes'
+to your Gemfile.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010
+
+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/Rakefile

@@ -0,0 +1,23 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'spec:run'
+task 'gem:release' => 'spec:run'
+
+Bones {
+  name  'mm-nested-attributes'
+  authors  'Toni Tuominen'
+  email    'toni@piranhadigital.fi'
+  url      'http://github.com/tjtuom/mm-nested-attributes'
+
+  ignore_file '.gitignore'
+
+  depend_on 'mongo_mapper', '0.8.2'
+
+  depend_on 'rspec', :development => true
+}
+

data/lib/mm-nested-attributes.rb

@@ -0,0 +1,36 @@
+require 'mongo_mapper/plugins/associations/nested_attributes'
+
+module MongoMapper
+  module Plugins
+    module Document
+      module InstanceMethods
+        def mark_for_destruction
+          @marked_for_destruction = true
+        end
+
+        def marked_for_destruction?
+          @marked_for_destruction
+        end
+      end
+    end
+  end
+end
+
+module MongoMapper
+  module Plugins
+    module Associations
+      class ManyDocumentsProxy
+        def save_to_collection_with_delete(options={})
+          if @target
+            to_delete = @target.delete_if { |doc| doc.marked_for_destruction? }
+            to_delete.each { |doc| doc.destroy }
+          end
+          save_to_collection_without_delete(options)
+        end
+
+        alias :save_to_collection_without_delete :save_to_collection
+        alias :save_to_collection :save_to_collection_with_delete
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/associations/nested_attributes.rb

@@ -0,0 +1,124 @@
+module MongoMapper
+
+  class TooManyRecords < MongoMapper::Error
+  end
+
+  module Plugins
+    module Associations
+      module NestedAttributes
+
+        REJECT_ALL_BLANK_PROC = proc { |attributes| attributes.all? { |_, value| value.blank? } }
+
+        def self.configure(model)
+          model.class_eval do
+            class_inheritable_accessor :nested_attributes_options, :instance_writer => false
+            self.nested_attributes_options = {}
+          end
+        end
+
+        module ClassMethods
+          def accepts_nested_attributes_for(*attr_names)
+            options = { :allow_destroy => false, :update_only => false }
+            options.update(attr_names.extract_options!)
+            options.assert_valid_keys(:allow_destroy, :reject_if, :limit, :update_only)
+            options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
+
+            attr_names.each do |association_name|
+              if association = associations[association_name]
+                type = (association.many? ? :collection : :one_to_one)
+                nested_attributes_options[association_name.to_sym] = options
+
+                class_eval %{
+                  if method_defined?(:#{association_name}_attributes=)
+                    remove_method(:#{association_name}_attributes=)
+                  end
+                  def #{association_name}_attributes=(attributes)
+                    assign_nested_attributes_for_#{type}_association(:#{association_name}, attributes)
+                  end
+                }, __FILE__, __LINE__
+              else
+                raise ArgumentError, "No association found for name '#{association_name}'. Has it been defined yet?"
+              end
+            end
+          end
+        end
+
+        module InstanceMethods
+
+          private
+
+          # Attribute hash keys that should not be assigned as normal attributes.
+          # These hash keys are nested attributes implementation details.
+          UNASSIGNABLE_KEYS = %w( id _destroy )
+
+          def assign_nested_attributes_for_collection_association(association_name, attributes_collection)
+            options = nested_attributes_options[association_name]
+
+            unless attributes_collection.is_a?(Hash) || attributes_collection.is_a?(Array)
+              raise ArgumentError, "Hash or Array expected, got #{attributes_collection.class.name} (#{attributes_collection.inspect})"
+            end
+
+            if options[:limit] && attributes_collection.size > options[:limit]
+              raise TooManyRecords, "Maximum #{options[:limit]} records are allowed. Got #{attributes_collection.size} records instead."
+            end
+
+            if attributes_collection.is_a? Hash
+              attributes_collection = attributes_collection.sort_by { |index, _| index.to_i }.map { |_, attributes| attributes }
+            end
+
+            attributes_collection.each do |attributes|
+              attributes = attributes.with_indifferent_access
+
+              if attributes['id'].blank?
+                unless reject_new_record?(association_name, attributes)
+                  send(association_name).build(attributes.except(*UNASSIGNABLE_KEYS))
+                end
+              elsif existing_record = send(association_name).detect { |record| record.id.to_s == attributes['id'].to_s }
+                assign_to_or_mark_for_destruction(existing_record, attributes, options[:allow_destroy])
+              else
+                raise_nested_attributes_record_not_found(association_name, attributes['id'])
+              end
+            end
+          end
+
+          # Updates a record with the +attributes+ or marks it for destruction if
+          # +allow_destroy+ is +true+ and has_destroy_flag? returns +true+.
+          def assign_to_or_mark_for_destruction(record, attributes, allow_destroy)
+            if has_destroy_flag?(attributes) && allow_destroy
+              record.mark_for_destruction
+            else
+              record.attributes = attributes.except(*UNASSIGNABLE_KEYS)
+            end
+          end
+
+          # Determines if a hash contains a truthy _destroy key.
+          TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE'].to_set
+          def has_destroy_flag?(hash)
+            hash['_destroy'].present? && TRUE_VALUES.include?(hash['_destroy'])
+          end
+
+          # Determines if a new record should be build by checking for
+          # has_destroy_flag? or if a <tt>:reject_if</tt> proc exists for this
+          # association and evaluates to +true+.
+          def reject_new_record?(association_name, attributes)
+            has_destroy_flag?(attributes) || call_reject_if(association_name, attributes)
+          end
+
+          def call_reject_if(association_name, attributes)
+            case callback = nested_attributes_options[association_name][:reject_if]
+            when Symbol
+              method(callback).arity == 0 ? send(callback) : send(callback, attributes)
+            when Proc
+              callback.call(attributes)
+            end
+          end
+
+          def raise_nested_attributes_record_not_found(association_name, record_id)
+            assoc = self.class.associations[association_name]
+            raise DocumentNotFound, "Couldn't find #{assoc.klass.name} with ID=#{record_id} for #{self.class.name} with ID=#{id}"
+          end
+        end
+      end
+    end
+  end
+end

data/mm-nested-attributes.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mm-nested-attributes}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toni Tuominen"]
+  s.date = %q{2010-07-10}
+  s.description = %q{A port of ActiveRecord's nested attributes functionality for MongoMapper.}
+  s.email = %q{toni@piranhadigital.fi}
+  s.extra_rdoc_files = ["History.txt", "README.txt", "version.txt"]
+  s.files = [".gitignore", "History.txt", "README.txt", "Rakefile", "lib/mm-nested-attributes.rb", "lib/mongo_mapper/plugins/associations/nested_attributes.rb", "mm-nested-attributes.gemspec", "spec/mm-nested-attributes_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "version.txt"]
+  s.homepage = %q{http://github.com/tjtuom/mm-nested-attributes}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mm-nested-attributes}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A port of ActiveRecord's nested attributes functionality for MongoMapper}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.3"])
+    else
+      s.add_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<bones>, [">= 3.4.3"])
+    end
+  else
+    s.add_dependency(%q<mongo_mapper>, [">= 0.8.2"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<bones>, [">= 3.4.3"])
+  end
+end

data/spec/mm-nested-attributes_spec.rb

@@ -0,0 +1,174 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe "Nested attributes plugin" do
+  before do
+    @klass = Doc('Parent') do
+      plugin MongoMapper::Plugins::Associations::NestedAttributes
+      key :body, String
+    end
+
+    @child_klass = Doc('Child') do
+      key :value, String
+    end
+
+    @klass.many :children, :class => @child_klass
+    @klass.accepts_nested_attributes_for :children
+
+    @parent = @klass.new
+  end
+
+  it "responds to #<association>_attributes=" do
+    @parent.should respond_to(:children_attributes=)
+  end
+
+  it "raises an error for undefined associations" do
+    doing { @klass.accepts_nested_attributes_for :foo }.should(
+      raise_error(ArgumentError, "No association found for name 'foo'. Has it been defined yet?"))
+  end
+
+  it 'rejects the document if _destroy flag is present' do
+    @parent = @klass.new(:children_attributes => [ { :value => 'ok' }, { :value => 'not ok', :_destroy => '1' } ])
+    @parent.children.size.should == 1
+    @parent.children[0].value.should == 'ok'
+  end
+end
+
+describe "Nested attributes plugin for collections" do
+  before do
+    @klass = Doc('Parent') do
+      plugin MongoMapper::Plugins::Associations::NestedAttributes
+      key :body, String
+    end
+
+    @child_klass = Doc('Child') do
+      key :value, String
+    end
+
+    @klass.many :children, :class => @child_klass
+    @klass.accepts_nested_attributes_for :children
+
+    @parent = @klass.new
+  end
+
+  describe "assigning attributes" do
+    it "creates the child model when given an array" do
+      @parent.children_attributes = [ { :value => "foo" } ]
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == "foo"
+    end
+
+    it "creates the child model when given a hash" do
+      @parent.children_attributes = { 0 => { :value => "foo" } }
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == "foo"
+    end
+  end
+
+  describe "initializing a new model" do
+    it "creates the child model when given an array" do
+      @parent = @klass.new(:children_attributes => [ { :value => "foo"} ])
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == "foo"
+    end
+
+    it "creates the child model when given a hash" do
+      @parent = @klass.new(:children_attributes => { 0 => { :value => "foo" } })
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == "foo"
+    end
+  end
+
+  describe "editing an existing document" do
+    it "raises an error if the document isn't found" do
+      @parent = @klass.new
+      @child = @parent.children.create!(:value => 'foo')
+
+      id = BSON::ObjectID.new
+      doing do
+        @parent.children_attributes = [ { :id => id, :value => 'bar' } ]
+      end.should raise_error(MongoMapper::DocumentNotFound, "Couldn't find Child with ID=#{id} for Parent with ID=#{@parent.id}")
+    end
+
+    it 'updates the document' do
+      @parent = @klass.new
+      @child = @parent.children.create!(:value => 'foo')
+
+      @parent.children_attributes = [ { :id => @child.id, :value => 'bar' } ]
+      @parent.children[0].value.should == 'bar'
+
+      # has not been saved so the db should have the old value
+      @klass.first.children[0].value.should == 'foo'
+
+      @parent.save!
+
+      # after save the db should have the new value
+      @klass.first.children[0].value.should == 'bar'
+    end
+  end
+
+  describe "deleting an existing document" do
+    it 'does nothing unless :allow_destroy is true' do
+      @klass.accepts_nested_attributes_for :children
+
+      @parent = @klass.new
+      @child = @parent.children.create!(:value => 'foo')
+
+      @parent.children_attributes = [ { :id => @child.id, :_destroy => '1' } ]
+      doing do
+        @parent.save!
+      end.should_not change(@parent.children, :size)
+    end
+
+    it 'deletes the document when _destroy is present' do
+      @klass.accepts_nested_attributes_for :children, :allow_destroy => true
+
+      @parent = @klass.new
+      @child = @parent.children.create!(:value => 'foo')
+
+      @parent.children_attributes = [ { :id => @child.id, :_destroy => '1' } ]
+
+      doing do
+        @parent.save!
+      end.should change(@parent.children, :size).by(-1)
+    end
+
+    it "does not delete the document until save is called" do
+      @klass.accepts_nested_attributes_for :children, :allow_destroy => true
+
+      @parent = @klass.new
+      @child = @parent.children.create!(:value => 'foo')
+
+      doing do
+        @parent.children_attributes = [ { :id => @child.id, :_destroy => '1' } ]
+      end.should_not change(@parent.children, :size)
+    end
+  end
+
+  describe "limit option" do
+    it "raises an error if more docs are given than are allowed" do
+      @klass.accepts_nested_attributes_for :children, :limit => 1
+
+      doing do
+        @parent = @klass.new(:children_attributes => [ { :value => 'foo' }, { :bar => 'bar'} ])
+      end.should raise_error(MongoMapper::TooManyRecords, "Maximum 1 records are allowed. Got 2 records instead.")
+    end
+  end
+
+  describe "reject_if option" do
+    it 'rejects docs that the block returns true for' do
+      @klass.accepts_nested_attributes_for :children, :reject_if => proc { |attrs| attrs['value'] == 'reject' }
+
+      @parent = @klass.new(:children_attributes => [ { :value => 'ok' }, { :value => 'reject' } ])
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == 'ok'
+    end
+
+    it 'rejects fully empty objects if the reject_if option is set to :all_blank' do
+      @klass.accepts_nested_attributes_for :children, :reject_if => :all_blank
+
+      @parent = @klass.new(:children_attributes => [ { :value => '' }, { :value => 'ok' } ])
+      @parent.children.size.should == 1
+      @parent.children[0].value.should == 'ok'
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'mongo_mapper'
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib mm-nested-attributes]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  def Doc(name=nil, &block)
+    klass = Class.new do
+      include MongoMapper::Document
+      set_collection_name :test
+
+      if name
+        class_eval "def self.name; '#{name}' end"
+        class_eval "def self.to_s; '#{name}' end"
+      end
+    end
+
+    klass.class_eval(&block) if block_given?
+    klass.collection.remove
+    klass
+  end
+
+  def doing(&block)
+    block
+  end
+
+  MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+  MongoMapper.database = "mm-nested-attributes-test-#{RUBY_VERSION.gsub('.', '-')}"
+  MongoMapper.database.collections.each { |c| c.drop_indexes }
+
+end
+

data/version.txt

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: mm-nested-attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Toni Tuominen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-10 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 4
+        - 3
+        version: 3.4.3
+  type: :development
+  version_requirements: *id003
+description: A port of ActiveRecord's nested attributes functionality for MongoMapper.
+email: toni@piranhadigital.fi
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+- version.txt
+files: 
+- .gitignore
+- History.txt
+- README.txt
+- Rakefile
+- lib/mm-nested-attributes.rb
+- lib/mongo_mapper/plugins/associations/nested_attributes.rb
+- mm-nested-attributes.gemspec
+- spec/mm-nested-attributes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- version.txt
+has_rdoc: true
+homepage: http://github.com/tjtuom/mm-nested-attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mm-nested-attributes
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A port of ActiveRecord's nested attributes functionality for MongoMapper
+test_files: []
+