acts_as_nested_by 0.1.1 → 0.1.2

data/LICENSE

@@ -1,20 +1,21 @@
+The MIT License
+
 Copyright (c) 2009 Thomas Limp
 
-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:
+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 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.
+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.rdoc

@@ -1,41 +1,55 @@
-= acts_as_nested_by
+= ActsAsNestedBy
 
-"acts_as_nested_by" is/will be a simple counterpart for rails' "accepts_attribute_for".
+'acts_as_nested_by' is/will be a simple counterpart for ActiveRecord::NestedAttributes 'accepts_attribute_for'.
+
+== Installation
+
+* as gem
+    $ sudo gem install acts_as_nested_by
+* or as plugin in your rails app
+    $ ./script/plugin/install git://github.com/tehael/acts_as_nested_by.git # rails 2.3.x
+    $ rails plugin install git://github.com/tehael/acts_as_nested_by.git # rails 3.0.x
 
 == Use case example
-Since the rails-way of handling referential integrity is to code the logic into you your model, without using database dependent foreign key constraints, you might come across situations like this.
 
-  class Foo < ActiveRecord
+Since the rails-way of handling referential integrity is to code the logic into you model without using database level foreign key constraints, you might produce code like this.
+
+  class Foo < ActiveRecord::Base
     has_many :bars
     validates_associated :bars
     accepts_nested_attributes_for :bars
   end
 
-  class Bar < ActiveRecord
+  class Bar < ActiveRecord::Base
     belongs_to :foo
     validates_presence_of :foo
   end
 
-Using validates_presence_of :foo instead of :foo_id ensures that not only a :foo_id was given but a Foo object existst in the :foos table.
+Using 'validates_presence_of :foo' instead of 'validates_presence_of :foo_id' ensures that not only a ':foo_id' was given but a Foo object existst in the :foos table.
 
-But on creation of a Foo with nested Bars in on step produces a kind of dead look, since the :foo_id for the Bars is not available until the Foo ist saved, and the validates_presence_of :bars produces an error in the Bars, no :foo_id, no Foo in the :foos table. And because the Foo :validates_associated :bars it cannot be saved.
-Using an :unless => :new_record? conditions with the validations might help, but it can but those valdation would also be skipped, if the Bars were not to be created in a nested form.
+But on creation of a Foo with nested Bars in one step produces a dead look, since the ':foo_id' for the Bars is not available until the Foo is saved, and the 'validates_presence_of :foo' therefore produces an error in the Bars invalidating them, no ':foo_id' no 'Foo' in the ':foos' table. And because the 'Foo' ':validates_associated :bars' it cannot be saved.
+Using an ':unless => :new_record?' condition with the ':validates_presence_of :foo' might help, but the validation is also skipped, if a 'Bar' is not created in a nested way.
 
-To handle this acts_as_nested_by comes in handy.
-  class Bar < ActiveRecord
+To handle this 'acts_as_nested_by' comes in handy.
+
+  class Bar < ActiveRecord::Base
     belongs_to :foo
     acts_as_nested_by :foo
     validates_presence_of :foo, :unless => :nested_by_foo?
   end
 
-Now just pass a parameter (with a hidden form parameter, or in the controller) :nested_by_foo => true when creating Bars nested in a Foo. If the Foo ist valid? it can be saved and the nested Bars will be auto saved and consistency is assured. ;)
+For now just pass a parameter (with a hidden form parameter) ':nested_by_foo => true' when creating 'Bars' nested in a 'Foo'. If the 'Foo' itsef is 'valid?' it can be saved, the nested 'Bars' will be auto saved and consistency is assured. ;)
 
 == Nota bene
-When using :attr_accessible, :attr_proteced and a hidden form parameter you should add :nested_by_foo to the mass-assignable attributes.
+
+* The association must be established before 'calling acts_as_nested_by :foo', so it must be called after 'belongs_to :foo'. An ArgumentError will be raised if the association is not yet established.
+* By now the association must be defined by 'belongs_to' macro, otherwise an ArgumentError will be raised.
+* When using ':attr_accessible', ':attr_proteced' and a hidden form parameter you should add ':nested_by_foo' to the mass-assignable attributes.
 
 == Next steps/known issues
 
-Since the setting of :nested_by_foo via mass assignement could be exploited to create inconsitent entries, the build/create methods provide by the association macros should set the :nested_by_foo internaly and the generated ActiveRecord::Base#nested_by_foo should be defined protected.
+* Setting of ':nested_by_other' via mass assignement or by calling 'nested_by_other = true' could be exploited to create inconsistent entries.
+* Therefore the mass assignment setter method provided by 'ActiveRecord#accepts_nested_attributes_for' should set the ':nested_by_other' flag internaly and 'ActiveRecord::Base#nested_by_other' should be defined protected.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -12,7 +12,7 @@ begin
       nested_by_nesting_model returns true if nested_by nesting_model
       nested_by_nesting_model? alias for nested_by_nesting_model
       }
-    gem.email = "thomas.limp@valiton.com"
+    gem.email = "thomas.limp@gmx.com"
     gem.homepage = "http://github.com/tehael/acts_as_nested_by"
     gem.authors = ["Thomas Limp"]
     gem.add_development_dependency "shoulda", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/acts_as_nested_by.gemspec

@@ -5,18 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_nested_by}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Limp"]
-  s.date = %q{2010-05-05}
+  s.date = %q{2010-05-06}
   s.description = %q{
       The acts_as_nested_by class method add 3 instance methods to the model.
       nested_by_nesting_model=(flag) sets the nesting_model 
       nested_by_nesting_model returns true if nested_by nesting_model
       nested_by_nesting_model? alias for nested_by_nesting_model
       }
-  s.email = %q{thomas.limp@valiton.com}
+  s.email = %q{thomas.limp@gmx.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "acts_as_nested_by.gemspec",
+     "init.rb",
      "lib/acts_as_nested_by.rb",
      "test/helper.rb",
      "test/test_acts_as_nested_by.rb"
@@ -36,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/tehael/acts_as_nested_by}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6.1}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Add a acts_as_nested_by :nesting_model class method to ActiveRecord::Base models}
   s.test_files = [
     "test/helper.rb",
@@ -47,7 +48,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 0"])

data/init.rb

@@ -0,0 +1 @@
+require "acts_as_nested_by"

data/lib/acts_as_nested_by.rb

@@ -1,17 +1,28 @@
-module ActsAsNestedBy#:nodoc
-  def self.included(base)
+module ActsAsNestedBy #:nodoc:
+  def self.included(base) #:nodoc:
     base.send :extend, ClassMethods
   end
   
-  module ClassMethods #:nodoc
-    # Generates instance methods for setting and reading a nested_by_other flag
-    # raises ArgumentError if association to other does not exist or is not created by the :belongs_to macro
+  module ClassMethods
+    # Generates instance methods for setting and getting a 'nested_by_other' flag for each ':other' in association_names
+    # * Example:
+    #     Bar < ActiveRecord::Base
+    #       belongs_to :other
+    #       acts_as_nested_by :other
+    #     end
+    #
+    #   generates methods 
+    #     Bar#nested_by_other=
+    #     Bar#nested_by_other
+    #     Bar#nested_by_other?
+    # * Exceptions raised
+    #   * ArgumentError if one of the associations does not exist
+    #   * ArgumentError if one of the associations is not created by the :belongs_to macro
     def acts_as_nested_by(*association_names)
       association_names.each do |association_name|
         if reflection = reflect_on_association(association_name)
           if :belongs_to == reflection.macro
             class_eval %{
-            
               def nested_by_#{association_name}=(nested_by_#{association_name})
                 @nested_by_#{association_name} = nested_by_#{association_name}
               end

data/test/helper.rb

@@ -14,7 +14,7 @@ class Test::Unit::TestCase
   def self.db_setup    
     @dbfile = File.join(File.dirname(__FILE__),"test.sqlite3")
     ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database  => @dbfile)
-    ActiveRecord::Migration.create_table :foos
+    ActiveRecord::Migration.create_table :foos do end
     ActiveRecord::Migration.create_table :bars do |t| t.references :foo end
   end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Thomas Limp
@@ -14,14 +14,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 +02:00
+date: 2010-05-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -34,7 +33,6 @@ dependencies:
   name: sqlite3-ruby
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -47,7 +45,6 @@ dependencies:
   name: activerecord
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -57,7 +54,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 description: "\n      The acts_as_nested_by class method add 3 instance methods to the model.\n      nested_by_nesting_model=(flag) sets the nesting_model \n      nested_by_nesting_model returns true if nested_by nesting_model\n      nested_by_nesting_model? alias for nested_by_nesting_model\n      "
-email: thomas.limp@valiton.com
+email: thomas.limp@gmx.com
 executables: []
 
 extensions: []
@@ -73,6 +70,7 @@ files:
 - Rakefile
 - VERSION
 - acts_as_nested_by.gemspec
+- init.rb
 - lib/acts_as_nested_by.rb
 - test/helper.rb
 - test/test_acts_as_nested_by.rb
@@ -86,7 +84,6 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -94,7 +91,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -104,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6.1
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Add a acts_as_nested_by :nesting_model class method to ActiveRecord::Base models