acts_as_nested_by 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+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:
+
+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.rdoc

@@ -0,0 +1,52 @@
+= acts_as_nested_by
+
+"acts_as_nested_by" is/will be a simple counterpart for rails' "accepts_attribute_for".
+
+== 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
+    has_many :bars
+    validates_associated :bars
+    accepts_nested_attributes_for :bars
+  end
+
+  class Bar < ActiveRecord
+    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.
+
+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.
+
+To handle this acts_as_nested_by comes in handy.
+  class Bar < ActiveRecord
+    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. ;)
+
+== Nota bene
+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.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Thomas Limp. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_nested_by"
+    gem.summary = %Q{Add a acts_as_nested_by :nesting_model class method to ActiveRecord::Base models}
+    gem.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
+      }
+    gem.email = "thomas.limp@valiton.com"
+    gem.homepage = "http://github.com/tehael/acts_as_nested_by"
+    gem.authors = ["Thomas Limp"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "sqlite3-ruby", ">= 0"
+    gem.add_dependency "activerecord"
+  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 = "acts_as_nested_by #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/acts_as_nested_by.gemspec

@@ -0,0 +1,65 @@
+# 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{acts_as_nested_by}
+  s.version = "0.1.1"
+
+  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.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.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_nested_by.gemspec",
+     "lib/acts_as_nested_by.rb",
+     "test/helper.rb",
+     "test/test_acts_as_nested_by.rb"
+  ]
+  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.summary = %q{Add a acts_as_nested_by :nesting_model class method to ActiveRecord::Base models}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_acts_as_nested_by.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= 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"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/lib/acts_as_nested_by.rb

@@ -0,0 +1,38 @@
+module ActsAsNestedBy#:nodoc
+  def self.included(base)
+    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
+    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
+            
+              def nested_by_#{association_name}
+                @nested_by_#{association_name} = @nested_by_#{association_name}.nil? ? false : true
+              end
+            
+              def nested_by_#{association_name}?
+                nested_by_#{association_name}
+              end
+            }
+          else
+            raise ArgumentError, "Association `#{association_name}' must be :belongs_to but it's `#{reflection.macro}'."
+          end
+        else
+          raise ArgumentError, "No association found for name `#{association_name}'. Has it been defined yet?"
+        end 
+      end
+    end
+  end
+end
+require "active_record"
+ActiveRecord::Base.send :include, ActsAsNestedBy

data/test/helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'acts_as_nested_by'
+
+class Foo < ActiveRecord::Base; end
+
+class Bar < ActiveRecord::Base; end
+
+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 :bars do |t| t.references :foo end
+  end
+  
+  def self.db_teardown
+    File.delete(@dbfile)
+  end
+end

data/test/test_acts_as_nested_by.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+class TestActsAsNestedBy < Test::Unit::TestCase
+  db_setup
+  
+  context "ActiveRecord::Base decendant class" do
+    should "respond to :acts_as_nested_by" do
+      assert Foo.respond_to? :acts_as_nested_by
+    end
+    
+    should "raise ArgumentError when trying to set :acts_as_nested_by for an undefined association" do
+      assert_raise ArgumentError do
+        class Bar < ActiveRecord::Base
+          acts_as_nested_by :foo
+        end
+      end
+    end
+    
+    should "raise ArgumentError when trying to set :acts_as_nested_by for association :has_many" do
+      assert_raise ArgumentError do
+        class Foo < ActiveRecord::Base
+          has_many :bars
+          acts_as_nested_by :bars
+        end
+      end
+    end
+    
+    should "raise ArgumentError when trying to set :acts_as_nested_by for association :has_one" do
+      assert_raise ArgumentError do
+        class Foo < ActiveRecord::Base
+          has_one :bar
+          acts_as_nested_by :bar
+        end
+      end
+    end
+  end  
+  
+  context "Instance of Bar (which acts_as_nested_by)" do
+    setup do
+      class Bar < ActiveRecord::Base
+        belongs_to :foo
+        acts_as_nested_by :foo
+      end
+      @bar = Bar.new
+    end
+    should "respond to :nested_by_foo=" do 
+      assert @bar.respond_to? :nested_by_foo=
+    end
+  
+    should "respond to :nested_by_foo" do
+      assert @bar.respond_to? :nested_by_foo
+    end
+  
+    should "respond to :nested_by_foo?" do
+      assert @bar.respond_to? :nested_by_foo?
+    end
+    
+    should "return false when called #nested_by_foo if nested_by_foo was not set" do
+      assert !@bar.nested_by_foo
+    end
+    
+    should "return false when called #nested_by_foo? if nested_by_foo was not set" do
+      assert !@bar.nested_by_foo?
+    end
+    
+    should "return true when called #nested_by_foo if nested_by_foo was set" do
+      @bar = Bar.new(:nested_by_foo => 1)
+      assert @bar.nested_by_foo
+    end
+    
+    should "return true when called #nested_by_foo? if nested_by_foo was set" do
+      @bar = Bar.new(:nested_by_foo => 1)
+      assert @bar.nested_by_foo?
+    end
+  end
+  
+  db_teardown
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_nested_by
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Thomas Limp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-05 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 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_nested_by.gemspec
+- lib/acts_as_nested_by.rb
+- test/helper.rb
+- test/test_acts_as_nested_by.rb
+has_rdoc: true
+homepage: http://github.com/tehael/acts_as_nested_by
+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.6.1
+signing_key: 
+specification_version: 3
+summary: Add a acts_as_nested_by :nesting_model class method to ActiveRecord::Base models
+test_files: 
+- test/helper.rb
+- test/test_acts_as_nested_by.rb