dm-accepts_nested_attributes_for 1.2.0

data/Gemfile

@@ -0,0 +1,84 @@
+source 'http://rubygems.org'
+
+SOURCE         = ENV.fetch('SOURCE', :git).to_sym
+REPO_POSTFIX   = SOURCE == :path ? ''                                : '.git'
+DATAMAPPER     = SOURCE == :path ? Pathname(__FILE__).dirname.parent : 'http://github.com/datamapper'
+DM_VERSION     = '~> 1.2.0.rc2'
+DO_VERSION     = '~> 0.10.6'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+CURRENT_BRANCH = ENV.fetch('GIT_BRANCH', 'master')
+
+gem 'dm-core', DM_VERSION,
+  SOURCE  => "#{DATAMAPPER}/dm-core#{REPO_POSTFIX}",
+  :branch => CURRENT_BRANCH
+
+group :development do
+
+  gem 'dm-validations', DM_VERSION,
+    SOURCE  => "#{DATAMAPPER}/dm-validations#{REPO_POSTFIX}",
+    :branch => CURRENT_BRANCH
+
+  gem 'dm-constraints', DM_VERSION,
+    SOURCE  => "#{DATAMAPPER}/dm-constraints#{REPO_POSTFIX}",
+    :branch => CURRENT_BRANCH
+
+  gem 'rake',      '~> 0.9.2'
+  gem 'rspec',     '~> 1.3.2'
+  gem 'yard',      '~> 0.7.2'
+  gem 'jeweler',   '~> 1.6.4'
+
+end
+
+platforms :mri_18 do
+  group :quality do
+
+    gem 'rcov',      '~> 0.9.10'
+    gem 'yard',      '~> 0.7.2'
+    gem 'yardstick', '~> 0.4'
+
+  end
+end
+
+group :datamapper do
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+
+    do_options = {}
+    do_options[:git] = "#{DATAMAPPER}/do#{REPO_POSTFIX}" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects', DO_VERSION, do_options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, do_options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION,
+      SOURCE => "#{DATAMAPPER}/dm-do-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+
+  end
+
+  adapters.each do |adapter|
+
+    gem "dm-#{adapter}-adapter", DM_VERSION,
+      SOURCE => "#{DATAMAPPER}/dm-#{adapter}-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+
+    gem plugin, DM_VERSION,
+      SOURCE => "#{DATAMAPPER}/#{plugin}#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+
+  end
+
+end

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,25 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    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 (snusnu)' ]
+    gem.has_rdoc    = 'yard'
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  FileList['tasks/**/*.rake'].each { |task| import task }
+
+rescue LoadError => e
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+  puts '-----------------------------------------------------------------------------'
+  puts e.backtrace # Let's help by actually showing *which* dependency is missing
+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/VERSION

@@ -0,0 +1 @@
+1.1.0

data/dm-accepts_nested_attributes.gemspec

@@ -0,0 +1,114 @@
+2# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-accepts_nested_attributes_for}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Martin Gamsjaeger (snusnu)}]
+  s.date = %q{2011-09-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 = [
+    "CHANGELOG",
+    "Gemfile",
+    "LICENSE",
+    "README.textile",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "dm-accepts_nested_attributes.gemspec",
+    "lib/dm-accepts_nested_attributes.rb",
+    "lib/dm-accepts_nested_attributes/model.rb",
+    "lib/dm-accepts_nested_attributes/relationship.rb",
+    "lib/dm-accepts_nested_attributes/resource.rb",
+    "lib/dm-accepts_nested_attributes/version.rb",
+    "spec/accepts_nested_attributes_for_spec.rb",
+    "spec/assign_nested_attributes_for_spec.rb",
+    "spec/comb/1-1_disjoint_spec.rb",
+    "spec/comb/1-1_overlapping_spec.rb",
+    "spec/comb/1-1_subset_spec.rb",
+    "spec/comb/1-1_superset_spec.rb",
+    "spec/comb/1-m_disjoint_spec.rb",
+    "spec/comb/1-m_overlapping_spec.rb",
+    "spec/comb/1-m_subset_spec.rb",
+    "spec/comb/1-m_superset_spec.rb",
+    "spec/comb/m-1_disjoint_spec.rb",
+    "spec/comb/m-1_overlapping_spec.rb",
+    "spec/comb/m-1_subset_spec.rb",
+    "spec/comb/m-1_superset_spec.rb",
+    "spec/comb/n-m_composite_spec.rb",
+    "spec/comb/n-m_surrogate_spec.rb",
+    "spec/many_to_many_composite_spec.rb",
+    "spec/many_to_many_spec.rb",
+    "spec/many_to_one_composite_spec.rb",
+    "spec/many_to_one_spec.rb",
+    "spec/one_to_many_composite_spec.rb",
+    "spec/one_to_many_spec.rb",
+    "spec/one_to_one_composite_spec.rb",
+    "spec/one_to_one_spec.rb",
+    "spec/rcov.opts",
+    "spec/resource_spec.rb",
+    "spec/shared/many_to_many_composite_spec.rb",
+    "spec/shared/many_to_many_spec.rb",
+    "spec/shared/many_to_one_composite_spec.rb",
+    "spec/shared/many_to_one_spec.rb",
+    "spec/shared/one_to_many_composite_spec.rb",
+    "spec/shared/one_to_many_spec.rb",
+    "spec/shared/one_to_one_composite_spec.rb",
+    "spec/shared/one_to_one_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/update_dirty_spec.rb",
+    "spec/update_multiple_spec.rb",
+    "tasks/changelog.rake",
+    "tasks/ci.rake",
+    "tasks/local_gemfile.rake",
+    "tasks/spec.rake",
+    "tasks/yard.rake",
+    "tasks/yardstick.rake"
+  ]
+  s.homepage = %q{http://github.com/snusnu/dm-accepts_nested_attributes}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Nested model assignment for datamapper}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<dm-validations>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<dm-constraints>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<dm-core>, ["~> 1.2.0"])
+      s.add_dependency(%q<dm-validations>, ["~> 1.2.0"])
+      s.add_dependency(%q<dm-constraints>, ["~> 1.2.0"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.2"])
+      s.add_dependency(%q<yard>, ["~> 0.7.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["~> 1.2.0"])
+    s.add_dependency(%q<dm-validations>, ["~> 1.2.0"])
+    s.add_dependency(%q<dm-constraints>, ["~> 1.2.0"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.2"])
+    s.add_dependency(%q<yard>, ["~> 0.7.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/lib/dm-accepts_nested_attributes.rb

@@ -0,0 +1,13 @@
+require 'dm-core'
+
+require 'dm-accepts_nested_attributes/model'
+require 'dm-accepts_nested_attributes/resource'
+require 'dm-accepts_nested_attributes/relationship'
+
+# Activate the plugin
+DataMapper::Model.append_extensions(DataMapper::NestedAttributes::Model)
+DataMapper::Associations::Relationship.send(:include, DataMapper::NestedAttributes::Relationship)
+DataMapper::Associations::ManyToMany::Relationship.send(:include, DataMapper::NestedAttributes::ManyToMany)
+DataMapper::Associations::OneToMany::Relationship.send(:include, DataMapper::NestedAttributes::OneToMany)
+DataMapper::Associations::ManyToOne::Relationship.send(:include, DataMapper::NestedAttributes::ManyToOne)
+DataMapper::Associations::OneToOne::Relationship.send(:include, DataMapper::NestedAttributes::OneToOne)

data/lib/dm-accepts_nested_attributes/model.rb

@@ -0,0 +1,144 @@
+module DataMapper
+  module NestedAttributes
+    class BackwardsCompatibilityHash < Hash
+      def initialize(model)
+        @model = model
+      end
+
+      def [](key)
+        if key.is_a?(DataMapper::Associations::Relationship)
+          warn "#{@model}#options_for_nested_attributes: Using a relationship " +
+               "as key is deprecated. Use the relationship name (i.e. " +
+               "#{key.name.inspect}) as key."
+          key = key.name
+        end
+        super(key)
+      end
+
+      def []=(key, value)
+        if key.is_a?(DataMapper::Associations::Relationship)
+          warn "#{@model}#options_for_nested_attributes: Using a relationship " +
+               "as key is deprecated. Use the relationship name (i.e. " +
+               "#{key.name.inspect}) as key."
+          key = key.name
+        end
+        super(key, value)
+      end
+    end
+
+    ##
+    # Named plugin exception that is raised by {Model#accepts_nested_attributes_for}
+    # if the passed options are invalid.
+    class InvalidOptions < ArgumentError; end
+
+    module Model
+
+      ##
+      # Allows an association to accept nested attributes.
+      #
+      # @param [Symbol, String] association_name
+      #   The name of the association that should accept nested attributes.
+      #
+      # @param [Hash?] options
+      #   List of resources to initialize the collection with.
+      #
+      # @option options [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 options [Boolean] :allow_destroy (false)
+      #   If true, allows destroying the association via the generated writer.
+      #   If false, prevents destroying the association via the generated writer.
+      #
+      # @raise [DataMapper::NestedAttributes::InvalidOptions]
+      #   A named exception class indicating invalid options.
+      #
+      # @return [void]
+      #
+      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.name] = options
+
+        include ::DataMapper::NestedAttributes::Resource
+
+        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
+
+      # Returns a hash with the options for all associations (using the
+      # corresponding relationship as key) that accept nested attributes.
+      #
+      # @return [Hash{DataMapper::Associations::Relationship => Hash}]
+      def options_for_nested_attributes
+        @options_for_nested_attributes ||= DataMapper::NestedAttributes::BackwardsCompatibilityHash.new(self)
+      end
+
+
+      private
+
+      ##
+      # Checks options passed to {#accepts_nested_attributes_for}.
+      # If any of the given options is invalid, this method will raise
+      # {DataMapper::NestedAttributes::InvalidOptions}.
+      #
+      # @param [Hash?] options
+      #   The options passed to {#accepts_nested_attributes_for}.
+      #
+      # @raise [DataMapper::NestedAttributes::InvalidOptions]
+      #   A named exception class indicating invalid options.
+      #
+      # @return [void]
+      #
+      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