kriss-associated_records_on_steroids 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+== 0.1.0
+* Auto builder for associated records
+* Add merge option to ActiveRecord errors
+* Overwriten validates_associated method in ActiveRecord
+* Few tests of basic functionality

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss Kowalik
+
+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,65 @@
+Plugin allowing to auto build and validate associated records and merge validation errors
+
+== Examples
+
+If you want automatically build specified associated recrods when new record is
+initialized you can use auto_build:
+ 
+  class Bar < ActiveRecord::Base
+    belongs_to :foo
+  end
+
+  class Foo < ActiveRecord::Base
+    has_one :bar
+    set_associated_records_to_auto_build :bar
+  end
+
+  foo = Foo.new
+  foo.bar # => #<Bar:0x...>
+  
+You can also validate associated record in easy way:
+
+  class Person < ActiveRecord::Base
+    has_one :address
+    validates_presence_of :name
+    validates_associated_record :address
+    delegate :street, :street=, :city, :city=, :state, :state=,
+     :zip, :zip=, :to => :address
+  end
+
+  class Address < ActiveRecord::Base
+    validates_presence_of :street, :city, :state, :zip
+  end
+
+  joe = Person.new
+  joe.valid? # => false
+
+  joe.errors.on(:name) # => "can't be blank"
+  joe.errors.on(:street) # => "can't be blank"
+  joe.errors.on(:city) # => "can't be blank"
+  joe.errors.on(:state) # => "can't be blank"
+  joe.errors.on(:zip) # => "can't be blank"
+  
+And of course merging errors in not associated records:
+
+  class Person < ActiveRecord::Base
+    validates_presence_of :name
+  end
+  
+  class Address < ActiveRecord::Base
+    validates_presence_of :street, :city, :state, :zip
+  end
+
+  joe = Person.new
+  joe.valid? # => false
+  address = Address.new
+  address.valid? # => false
+
+  joe.errors.merge address.errors
+  joe.errors.on(:name) # => "can't be blank"
+  joe.errors.on(:street) # => "can't be blank"
+  joe.errors.on(:city) # => "can't be blank"
+  joe.errors.on(:state) # => "can't be blank"
+  joe.errors.on(:zip) # => "can't be blank"
+  
+Enjoy!

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dffddf'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.rdoc

@@ -0,0 +1,3 @@
+== 0.2
+* All tests
+* More exhaustive readme file

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+minor: 1
+patch: 0
+major: 0

data/init.rb

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

data/lib/active_record/build_associated_records.rb

@@ -0,0 +1,91 @@
+module ActiveRecord
+  class Base
+    class << self
+      # Set list of associated recodrs, which you want to build after
+      # initialize current model
+      #
+      # == Usage
+      # 
+      #   class Bar < ActiveRecord::Base
+      #     belongs_to :foo
+      #   end
+      # 
+      #   class Foo < ActiveRecord::Base
+      #     has_one :bar
+      #     set_associated_records_to_auto_build :bar
+      #   end
+      #
+      #   foo = Foo.new
+      #   foo.bar # => #<Bar:0x...>
+      def set_associated_records_to_auto_build(*names)
+        if names.is_a? Array
+          self.associated_records_to_auto_build = names
+        else
+          raise ArgumentError.new("List of associated records to auto build have to be given in array")
+        end
+      end
+  
+      # Add associated records which you want to automatically build at the end
+      # of autobuild queue
+      def append_associated_records_to_auto_build(*names)
+        self.associated_records_to_auto_build.concat(names)
+      end
+      
+      # Add associated records which you want to automatically build at the begin
+      # of autobuild queue
+      def prepend_associated_records_to_auto_build(*names)
+        self.associated_records_to_auto_build.unshift(*names)
+      end
+    end
+
+    # Queue of records to auto build
+    @@associated_records_to_auto_build = {}
+    cattr_accessor :associated_records_to_auto_build
+
+    # All records from autobuild queue should be created after initialization 
+    def after_initialize
+      build_associated_records
+    end
+
+    # List of automatically created objects for current model
+    def self.associated_records_to_auto_build
+      @@associated_records_to_auto_build[self.to_s] ||= []
+    end
+
+    # TODO: should i remove it?
+    def self.associated_records_to_auto_build=(val)
+      @@associated_records_to_auto_build[self.to_s] = val
+    end
+
+    # Build all associated records from autobuild queue
+    #
+    # == Options
+    #
+    # * +only+ - build only specified associations
+    # * +except+ - build all associations except specified in this parameter
+    def build_associated_records(*opts)
+      defaults = { :except => [], :only => [] }
+      opts = defaults.merge(opts.extract_options!)
+      # Find all associations for recrods specified in queue
+      all_associations = {}
+      self.class.reflect_on_all_associations.each {|a| all_associations[a.name] = a.macro }
+      # Build records
+      self.class.associated_records_to_auto_build.each do |name|
+        name = name.to_sym
+        next if !opts[:except].empty? && opts[:except].include?(name)
+        next if !opts[:only].empty? && !opts[:only].include?(name)
+        if all_associations.include?(name)
+          if all_associations[name] == :has_many
+            if records = self.send(name)
+              records.build if records.empty?
+            end
+          elsif [:has_one, :belongs_to].include?(all_associations[name])
+            self.send("build_#{name.to_s}".to_sym) unless self.send(name.to_sym)
+          end
+        else
+          raise ArgumentError.new("There is no association for '#{name}' in #{self.class.to_s}")
+        end
+      end
+    end
+  end
+end

data/lib/active_record/errors.rb

@@ -0,0 +1,55 @@
+# This code snippet I found somewhere on snippets.dzone.com
+# and modify little bit. Thanks to author whoever hi is :)
+
+module ActiveRecord
+  class Errors
+    # Merges the errors from the passed in errors object onto this errors object.
+    # 
+    # == Examples
+    #
+    #   class Person < ActiveRecord::Base
+    #     validates_presence_of :name
+    #   end
+    #
+    #   class Address < ActiveRecord::Base
+    #     validates_presence_of :street, :city, :state, :zip
+    #   end
+    #
+    #   joe = Person.new
+    #   joe.valid? # => false
+    #
+    #   address = Address.new
+    #   address.valid? # => false
+    #
+    #   joe.errors.merge address.errors
+    #   joe.errors.on(:name) # => "can't be blank"
+    #   joe.errors.on(:street) # => "can't be blank"
+    #   joe.errors.on(:city) # => "can't be blank"
+    #   joe.errors.on(:state) # => "can't be blank"
+    #   joe.errors.on(:zip) # => "can't be blank"
+    #
+    # == Options
+    # 
+    #  * +only+ - can take a single field or an array of fields, it merges errors from the specified fields
+    #  * +except+ - can take a single field or an array of fields, it merges all errors except the on the fields specified
+    def merge(errors, options={})
+      fields_to_merge = if only=options[:only]
+        only
+      elsif except=options[:except]
+        except = [except] unless except.is_a?(Array)
+        except.map!(&:to_sym)
+        errors.entries.map(&:first).select do |field|
+          !except.include?(field.to_sym)
+        end
+      else
+        errors.entries.map(&:first)
+      end
+      fields_to_merge = [fields_to_merge] unless fields_to_merge.is_a?(Array)
+      fields_to_merge.map!(&:to_sym)
+
+      errors.entries.each do |field, msg|
+        add field, msg if fields_to_merge.include?(field.to_sym)
+      end
+    end
+  end
+end

data/lib/active_record/validates_associated_record.rb

@@ -0,0 +1,44 @@
+module ActiveRecord
+  module Validations
+    module ClassMethods
+      # This overwritten method will merge errors from associated record 
+      # when it's invalid
+      #
+      # === Examples
+      #
+      #    class Person < ActiveRecord::Base
+      #      has_one :address
+      #      validates_presence_of :name
+      #      validates_associated_record :address
+      #      delegate :street, :street=, :city, :city=, :state, :state=,
+      #       :zip, :zip=, :to => :address
+      #    end
+      #
+      #    class Address < ActiveRecord::Base
+      #      validates_presence_of :street, :city, :state, :zip
+      #    end
+      #
+      #    joe = Person.new
+      #    joe.valid? # => false
+      #
+      #    joe.errors.on(:name) # => "can't be blank"
+      #    joe.errors.on(:street) # => "can't be blank"
+      #    joe.errors.on(:city) # => "can't be blank"
+      #    joe.errors.on(:state) # => "can't be blank"
+      #    joe.errors.on(:zip) # => "can't be blank"
+      def validates_associated(*attr_names)
+        configuration = { :on => :save }
+        configuration.update(attr_names.extract_options!)
+        send(validation_method(configuration[:on]), configuration) do |record|
+          attr_names.each do |attr_name|
+            if associated_record = record.send(attr_name.to_sym)
+              unless associated_record.valid?
+                record.errors.merge(associated_record.errors)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/associated_records_on_steroids.rb

@@ -0,0 +1,3 @@
+require "active_record/errors"
+require "active_record/validates_associated_record"
+require "active_record/build_associated_records"

data/test/associated_records_on_steroids_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class AssociatedRecordsTest < Test::Unit::TestCase
+  context "Using merge errors feature" do
+    should "merge Addres and Person errors" do
+      maria = Person.new
+      marias_place = Address.new
+      assert !maria.save
+      assert !marias_place.save
+      maria.errors.merge(marias_place.errors)
+      assert_equal "can't be blank", maria.errors.on(:name)
+      assert_equal "can't be blank", maria.errors.on(:street)
+    end
+  end
+  
+  context "Creating new record" do
+    should "merge Addres and Resident errors when are invalid" do
+      joe = Resident.new
+      # address is created automatically but we would like to check 
+      # this way of validation too
+      joe.address = Address.new 
+      assert !joe.save
+      assert_equal "can't be blank", joe.errors.on(:name)
+      assert_equal "can't be blank", joe.errors.on(:street)
+    end
+
+    should "build associated Address after Person initialize" do
+      joe = Resident.new
+      assert !joe.address.nil?
+    end
+  end
+end

data/test/models/address.rb

@@ -0,0 +1,6 @@
+class Address < ActiveRecord::Base
+  def self.columns; []; end
+  attr_accessor :street, :city, :state, :zip, :person_id
+  validates_presence_of :street, :city, :state, :zip
+  belongs_to :person
+end

data/test/models/person.rb

@@ -0,0 +1,6 @@
+class Person < ActiveRecord::Base
+  def self.columns; []; end
+  attr_accessor :name
+  has_one :address
+  validates_presence_of :name
+end

data/test/models/resident.rb

@@ -0,0 +1,7 @@
+class Resident < Person
+  def self.columns; []; end
+  validates_associated :address
+  delegate :street, :street=, :city, :city=, :state, :state=,
+    :zip, :zip=, :to => :address
+  set_associated_records_to_auto_build :address
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), '../../../../')
+
+require 'rubygems'
+require 'shoulda'
+require 'test/unit'
+
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+require File.dirname(__FILE__) + '/models/address'
+require File.dirname(__FILE__) + '/models/person'
+require File.dirname(__FILE__) + '/models/resident'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: kriss-associated_records_on_steroids
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kriss Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Plugin allowing to auto build and validate associated records and merge validation errors
+email: kriss.kowalik@gmail.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG.rdoc
+files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- TODO.rdoc
+- VERSION.yml
+- init.rb
+- lib/active_record/build_associated_records.rb
+- lib/active_record/errors.rb
+- lib/active_record/validates_associated_record.rb
+- lib/associated_records_on_steroids.rb
+- test/associated_records_on_steroids_test.rb
+- test/models/address.rb
+- test/models/person.rb
+- test/models/resident.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://krisskowalik.pl
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Plugin allowing to auto build and validate associated records and merge validation errors
+test_files: 
+- test/associated_records_on_steroids_test.rb
+- test/models/address.rb
+- test/models/person.rb
+- test/models/resident.rb
+- test/test_helper.rb