dm-accepts_nested_attributes 0.12.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Martin Gamsjäger
+
+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.textile

@@ -0,0 +1,94 @@
+h2. dm-accepts_nested_attributes
+
+A DataMapper plugin that allows nested model attribute assignment like activerecord does.
+
+Current documentation can always be found at "rdoc.info":http://rdoc.info/projects/snusnu/dm-accepts_nested_attributes
+
+h3. Examples
+
+The following example illustrates the use of this plugin.
+
+<pre>
+<code>
+require "rubygems"
+
+require "dm-core"
+require "dm-validations"
+require "dm-accepts_nested_attributes"
+
+DataMapper::Logger.new(STDOUT, :debug)  
+DataMapper.setup(:default, 'sqlite3::memory:')
+  
+class Person
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  has 1, :profile
+  has n, :project_memberships
+  has n, :projects, :through => :project_memberships
+
+  accepts_nested_attributes_for :profile
+  accepts_nested_attributes_for :projects
+
+  # adds the following instance methods
+  # #profile_attributes=
+  # #profile_attributes
+  # #projects_attributes=
+  # #projects_attributes
+end
+
+class Profile
+  include DataMapper::Resource
+  property :id,      Serial
+  property :person_id, Integer
+  belongs_to :person
+
+  accepts_nested_attributes_for :person
+
+  # adds the following instance methods
+  # #person_attributes=
+  # #person_attributes
+end
+
+class Project
+  include DataMapper::Resource
+  property :id, Serial
+  has n, :tasks
+  has n, :project_memberships
+  has n, :people, :through => :project_memberships
+
+  accepts_nested_attributes_for :tasks
+  accepts_nested_attributes_for :people
+  
+  # adds the following instance methods
+  # #tasks_attributes=
+  # #tasks_attributes
+  # #people_attributes=
+  # #people_attributes
+end
+
+class ProjectMembership
+  include DataMapper::Resource
+  property :id,         Serial
+  property :person_id,  Integer
+  property :project_id, Integer
+  belongs_to :person
+  belongs_to :project
+end
+
+class Task
+  include DataMapper::Resource
+  property :id,         Serial
+  property :project_id, Integer
+  belongs_to :project
+end
+
+DataMapper.auto_migrate!
+</code>
+</pre>
+
+h2. TODO
+
+* collect validation errors from related resources
+* update README to include more complete usecases
+* think about replacing :reject_if with :if and :unless

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+require File.expand_path('../lib/dm-accepts_nested_attributes/version', __FILE__)
+
+FileList['tasks/**/*.rake'].each { |task| load task }
+
+begin
+
+  gem 'jeweler', '~> 1.4'
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+
+    gem.version     = DataMapper::NestedAttributes::VERSION
+
+    gem.name        = 'dm-accepts_nested_attributes'
+    gem.summary     = 'Nested model assignment for datamapper'
+    gem.description = 'A datamapper plugin that allows nested model assignment like activerecord.'
+    gem.email       = 'gamsnjaga [a] gmail [d] com'
+    gem.homepage    = 'http://github.com/snusnu/dm-accepts_nested_attributes'
+    gem.authors     = [ 'Martin Gamsjaeger' ]
+
+    gem.add_dependency 'dm-core', '~> 0.10.2'
+
+    gem.add_development_dependency 'rspec', '~> 1.2.9'
+    gem.add_development_dependency 'yard',  '~> 0.4.0'
+
+  end
+
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end

data/TODO

@@ -0,0 +1,6 @@
+TODO
+====
+
+* collect validation errors from related resources
+* update README to include more complete usecases
+* think about replacing :reject_if with :if and :unless

data/dm-accepts_nested_attributes.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-accepts_nested_attributes}
+  s.version = "0.12.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Gamsjaeger"]
+  s.date = %q{2010-01-23}
+  s.description = %q{A datamapper plugin that allows nested model assignment like activerecord.}
+  s.email = %q{gamsnjaga [a] gmail [d] com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "TODO",
+     "dm-accepts_nested_attributes.gemspec",
+     "lib/dm-accepts_nested_attributes.rb",
+     "lib/dm-accepts_nested_attributes/error_collecting.rb",
+     "lib/dm-accepts_nested_attributes/model.rb",
+     "lib/dm-accepts_nested_attributes/resource.rb",
+     "lib/dm-accepts_nested_attributes/transactional_save.rb",
+     "lib/dm-accepts_nested_attributes/version.rb",
+     "spec/accepts_nested_attributes_for_spec.rb",
+     "spec/many_to_many_spec.rb",
+     "spec/many_to_one_spec.rb",
+     "spec/one_to_many_spec.rb",
+     "spec/one_to_one_spec.rb",
+     "spec/rcov.opts",
+     "spec/shared/many_to_many_spec.rb",
+     "spec/shared/many_to_one_spec.rb",
+     "spec/shared/one_to_many_spec.rb",
+     "spec/shared/one_to_one_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/changelog.rake",
+     "tasks/ci.rake",
+     "tasks/metrics.rake",
+     "tasks/spec.rake",
+     "tasks/yard.rake",
+     "tasks/yardstick.rake"
+  ]
+  s.homepage = %q{http://github.com/snusnu/dm-accepts_nested_attributes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Nested model assignment for datamapper}
+  s.test_files = [
+    "spec/accepts_nested_attributes_for_spec.rb",
+     "spec/many_to_many_spec.rb",
+     "spec/many_to_one_spec.rb",
+     "spec/one_to_many_spec.rb",
+     "spec/one_to_one_spec.rb",
+     "spec/shared/many_to_many_spec.rb",
+     "spec/shared/many_to_one_spec.rb",
+     "spec/shared/one_to_many_spec.rb",
+     "spec/shared/one_to_one_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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<dm-core>, ["~> 0.10.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.2.9"])
+      s.add_development_dependency(%q<yard>, ["~> 0.4.0"])
+    else
+      s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
+      s.add_dependency(%q<rspec>, ["~> 1.2.9"])
+      s.add_dependency(%q<yard>, ["~> 0.4.0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
+    s.add_dependency(%q<rspec>, ["~> 1.2.9"])
+    s.add_dependency(%q<yard>, ["~> 0.4.0"])
+  end
+end
+

data/lib/dm-accepts_nested_attributes.rb

@@ -0,0 +1,7 @@
+require 'dm-core'
+
+require 'dm-accepts_nested_attributes/model'
+require 'dm-accepts_nested_attributes/resource'
+
+# Activate the plugin
+DataMapper::Model.append_extensions(DataMapper::NestedAttributes::Model)

data/lib/dm-accepts_nested_attributes/error_collecting.rb

@@ -0,0 +1,35 @@
+module DataMapper
+  module NestedAttributes
+
+    module ValidationErrorCollecting
+
+      # collect errors on parent associations
+      def before_save_parent_association(association, context)
+        if association.respond_to?(:each)
+          association.each do |r|
+            unless r.valid?(context)
+              r.errors.each { |e| self.errors.add(:general, e) }
+            end
+          end
+        else
+          unless association.valid?(context)
+            association.errors.each { |e| self.errors.add(:general, e) }
+          end
+        end
+      end
+
+      # collect errors on child associations
+      def before_save_child_association(association, context)
+        if association.respond_to?(:valid?)
+          unless association.valid?(context)
+            association.errors.each { |e| self.errors.add(:general, e) }
+          end
+        else
+          self.errors.add(:general, "child association is missing")
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dm-accepts_nested_attributes/model.rb

@@ -0,0 +1,155 @@
+module DataMapper
+  module NestedAttributes
+
+    ##
+    # Named plugin exception that gets raised by
+    # @see accepts_nested_attributes_for
+    # if the passed options don't make sense
+    class InvalidOptions < ArgumentError; end
+
+    module Model
+
+      ##
+      # Allows any association to accept nested attributes.
+      #
+      # @param [Symbol, String] association_name
+      #   The name of the association that should accept nested attributes
+      #
+      # @param [Hash, nil] options
+      #   List of resources to initialize the Collection with
+      #
+      # @option [Symbol, String, #call] :reject_if
+      #   An instance method name or an object that respond_to?(:call), which
+      #   stops a new record from being created, if it evaluates to true.
+      #
+      # @option [true, false] :allow_destroy
+      #   If true, allow destroying the association via the generated writer
+      #   If false, prevent destroying the association via the generated writer
+      #   defaults to false
+      #
+      # @raise [DataMapper::NestedAttributes::InvalidOptions]
+      #   A named exception class indicating invalid options
+      #
+      # @return nil
+      #
+      def accepts_nested_attributes_for(association_name, options = {})
+
+        # ----------------------------------------------------------------------------------
+        #                      try to fail as early as possible
+        # ----------------------------------------------------------------------------------
+
+        unless relationship = relationships(repository_name)[association_name]
+          raise(ArgumentError, "No relationship #{association_name.inspect} for '#{name}' in :#{repository_name} repository")
+        end
+
+        # raise InvalidOptions if the given options don't make sense
+        assert_valid_options_for_nested_attributes(options)
+
+        # by default, nested attributes can't be destroyed
+        options = { :allow_destroy => false }.update(options)
+
+        # ----------------------------------------------------------------------------------
+        #                       should be safe to go from here
+        # ----------------------------------------------------------------------------------
+
+        options_for_nested_attributes[relationship] = options
+
+        include ::DataMapper::NestedAttributes::Resource
+
+        # TODO i wonder if this is the best place here?
+        # the transactional save behavior is definitely not needed for all resources,
+        # but it's necessary for resources that accept nested attributes
+        # FIXME this leads to weird "no such table" errors when specs are run
+        add_transactional_save_behavior # TODO if repository.adapter.supports_transactions?
+
+        # TODO make this do something
+        # it's only here now to remind me that this is probably the best place to put it
+        add_error_collection_behavior if DataMapper.const_defined?('Validate')
+
+        type = relationship.max > 1 ? :collection : :resource
+
+        define_method "#{association_name}_attributes" do
+          instance_variable_get("@#{association_name}_attributes")
+        end
+
+        define_method "#{association_name}_attributes=" do |attributes|
+          attributes = sanitize_nested_attributes(attributes)
+          instance_variable_set("@#{association_name}_attributes", attributes)
+          send("assign_nested_attributes_for_related_#{type}", relationship, attributes)
+        end
+
+      end
+
+      def options_for_nested_attributes
+        @options_for_nested_attributes ||= {}
+      end
+
+
+      private
+
+      ##
+      # Provides a hook to include or disable customized transactional save behavior.
+      # Override this method to customize the implementation or disable it altogether.
+      # The current implementation in @see DataMapper::NestedAttributes::TransactionalSave
+      # simply wraps the saving of the complete object tree inside a transaction
+      # and rolls back in case any exceptions are raised, or any of the calls to
+      # @see DataMapper::Resource#save returned false
+      #
+      # @return Not specified
+      #
+      def add_transactional_save_behavior
+        require 'dm-accepts_nested_attributes/transactional_save'
+        include ::DataMapper::NestedAttributes::TransactionalSave
+      end
+
+      ##
+      # Provides a hook to include or disable customized error collecting behavior.
+      # Overwrite this method to customize the implementation or disable it altogether.
+      # The current implementation in @see DataMapper::NestedAttributes::ValidationErrorCollecting
+      # simply attaches all errors of related resources to the object that was initially saved.
+      #
+      # @return Not specified
+      #
+      def add_error_collection_behavior
+        require 'dm-accepts_nested_attributes/error_collecting'
+        include ::DataMapper::NestedAttributes::ValidationErrorCollecting
+      end
+
+      ##
+      # Checks options passed to @see accepts_nested_attributes_for
+      # If any of the given options is invalid, this method will raise
+      # @see DataMapper::NestedAttributes::InvalidOptions
+      #
+      # @param [Hash, nil] options
+      #   The options passed to @see accepts_nested_attributes_for
+      #
+      # @raise [DataMapper::NestedAttributes::InvalidOptions]
+      #   A named exception class indicating invalid options
+      #
+      # @return [nil]
+      #
+      def assert_valid_options_for_nested_attributes(options)
+
+        assert_kind_of 'options', options, Hash
+
+        valid_options = [ :allow_destroy, :reject_if ]
+
+        unless options.all? { |k,v| valid_options.include?(k) }
+          raise InvalidOptions, 'options must be one of :allow_destroy or :reject_if'
+        end
+
+        guard = options[:reject_if]
+        if guard.is_a?(Symbol) || guard.is_a?(String)
+          msg = ":reject_if => #{guard.inspect}, but there is no instance method #{guard.inspect} in #{self.name}"
+          raise InvalidOptions, msg unless instance_methods.include?(options[:reject_if].to_s)
+        else
+          msg = ":reject_if must be a Symbol|String or respond_to?(:call) "
+          raise InvalidOptions, msg unless guard.nil? || guard.respond_to?(:call)
+        end
+
+      end
+
+    end
+
+  end
+end