@@ -1,32 +1,37 @@ -= classy-inheritance - -* FIX (url) +classy-inheritance + by Andrew Stone + http://stonean.com == DESCRIPTION: -FIX (describe your package) - -== FEATURES/PROBLEMS: +Classy Inheritance adds a depends_on class method to your ActiveRecord model so that you can define requisite objects. -* FIX (list of features or problems) +This functionality is provided using the existing ActiveRecord methods without monkey patching any core code. Essentially, it provides an easy interface to generate code that anyone could add to their model to receive the same result. Depending on the parameters to your depends_on call, it may add some of the following methods: validates_presence_of, validates_associated, has_one or belongs_to. == SYNOPSIS: - FIX (code sample of usage) +class User < ActiveRecord::Base + depends_on :profile, :attrs => [:first_name, :last_name, :email] +end -== REQUIREMENTS: +# Pass-through methods to profile attributes. Now you don't have to manage +# two different objects. +@user.first_name = 'Andrew' +@user.last_name = 'Stone' +@user.email = 'andy@stonean.com' -* FIX (list of requirements) +# Manages profile relationship for you +@user.save == INSTALL: -* FIX (sudo gem install, anything else) +sudo gem install classy-inheritance == LICENSE: (The MIT License) -Copyright (c) 2008 FIX +Copyright (c) 2009 Andrew Stone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -45,4 +50,4 @@ 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. \ No newline at end of file +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. README.txt @@ -1,4 +1,30 @@ -require 'config/requirements' -require 'config/hoe' # setup Hoe + all gem configuration - -Dir['tasks/**/*.rake'].each { |rake| load rake } \ No newline at end of file +# Look in the tasks/setup.rb file for the various options that can be +# configured in this Rakefile. The .rake files in the tasks directory +# are where the options are used. + +begin + require 'bones' + Bones.setup +rescue LoadError + begin + load 'tasks/setup.rb' + rescue LoadError + raise RuntimeError, '### please install the "bones" gem ###' + end +end + +ensure_in_path 'lib' +require 'classy-inheritance' + +task :default => 'spec:run' + +PROJ.name = 'classy-inheritance' +PROJ.authors = 'Andrew Stone' +PROJ.email = 'andy@stonean.com' +PROJ.url = 'http://stonean.com/wiki/classy-inheritance' +PROJ.version = Stonean::ClassyInheritance::VERSION +PROJ.rubyforge.name = 'classyinherit' + +PROJ.spec.opts << '--color' + +# EOF Rakefile @@ -1,28 +1,10 @@ -$:.unshift(File.dirname(__FILE__)) unless - $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__))) - - -module ActiveRecord::Validations::ClassMethods - def validates_associated(*attr_names) - configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save } - configuration.update(attr_names.extract_options!) - - validates_each(attr_names, configuration) do |record, attr_name, value| - associate = record.send(attr_name) - if associate && !associate.valid? - associate.errors.each do |key, value| - record.errors.add(key, value) unless record.errors[key] - end - end - end - end -end - module Stonean module ClassyInheritance - def self.included(base) - base.extend Stonean::ClassyInheritance::ClassMethods + VERSION = '0.6.3' + + def self.version + VERSION end module ClassMethods @@ -40,10 +22,10 @@ module Stonean if options.has_key?(:validates_associated_if) && options[:validates_associated_if] != true if [Symbol, String, Proc].include?(options[:validates_associated_if].class) - validates_associated model_sym, :if => options[:validates_associated_if] + validates_associated_dependent model_sym, options, :if => options[:validates_associated_if] end else - validates_associated model_sym + validates_associated_dependent model_sym, options end # Before save functionality to create/update the requisite object @@ -179,7 +161,7 @@ module Stonean requisite_klass = eval(klass) unless requisite_klass.respond_to?(self.name.underscore.to_sym) requisite_klass.send :can_be, self.name.underscore, - :as => polymorphic_name + :as => polymorphic_name end end @@ -190,4 +172,32 @@ module Stonean end # ClassMethods end # ClassyInheritance module end # Stonean module -ActiveRecord::Base.send :include, Stonean::ClassyInheritance + +if Object.const_defined?("ActiveRecord") && ActiveRecord.const_defined?("Base") + module ActiveRecord::Validations::ClassMethods + + def validates_associated_dependent(model_sym, options, configuration = {}) + configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save }.update(configuration) + + validates_each(model_sym, configuration) do |record, attr_name, value| + associate = record.send(attr_name) + if associate && !associate.valid? + associate.errors.each do |key, value| + if options[:prefix] + key = (options[:prefix] == true) ? "#{model_sym}_#{key}" : "#{options[:prefix]}_#{key}" + end + if options[:postfix] + key = (options[:postfix] == true) ? "#{key}_#{model_sym}" : "#{key}_#{options[:postfix]}" + end + record.errors.add(key, value) unless record.errors[key] + end + end + end + end + end + + + ActiveRecord::Base.class_eval do + extend Stonean::ClassyInheritance::ClassMethods + end +end lib/classy-inheritance.rb @@ -8,10 +8,6 @@ class TestClassyInheritance < Test::Unit::TestCase @user = User.new end - def test_active_record_should_have_classy_inheritance_included - assert ActiveRecord::Base.included_modules.include?(Stonean::ClassyInheritance) - end - def test_active_record_should_respond_to_depends_on assert ActiveRecord::Base.respond_to?(:depends_on) end test/test_classy-inheritance.rb PostInstall.txt README config/hoe.rb config/requirements.rb lib/classy-inheritance/version.rb script/console script/destroy script/generate script/txt2html setup.rb tasks/deployment.rake tasks/environment.rake tasks/website.rake website/index.html website/index.txt website/javascripts/rounded_corners_lite.inc.js website/stylesheets/screen.css website/template.html.erb 0dd340ebb2da4adc83d602287f7e0eabe39ea560 Andrew Stone andy@stonean.com http://github.com/stonean/classy-inheritance/commit/6b31e09e32f91b68195a704f21adf9764ffa5276 6b31e09e32f91b68195a704f21adf9764ffa5276 2009-01-14T18:21:42-08:00 2009-01-14T18:21:42-08:00 fix from johnsbrn for prefix and postfix validations 0d2d962c949375be1cb88552f175394118dc108a Andrew Stone andy@stonean.com