johnsbrn-classy-inheritance 0.6.3

data/History.txt

@@ -0,0 +1,34 @@
+== 0.6.3 2009-01-13
+  * Fixed validations for prefix and postfix - johnsbrn
+== 0.6.2 2008-09-25
+  * Added back validates_associated override.
+== 0.6.1 2008-07-21
+  * Removed validates_associated override, was causing issues.
+== 0.6.0 2008-07-18
+  * Add: new option:  postfix
+  * Add: Expanded prefix,postfix functionality to either accept true or values to prefix/postix attribute with.
+  * Add: Tests to support new options
+== 0.5.0 2008-07-08
+  * Add: new options:  validates_presence_if, validates_associated_if to allow for greater control over validation use.
+  * Add: Basic test cases of classy-inheritance depends_on functionality.
+== 0.4.4 2008-06-24
+  * Fix: :class_name attribute was not being recognized
+== 0.4.3 2008-06-24
+  * Fix: :prefix option was not being removed before passing option to has_one/belongs_to
+== 0.4.2 2008-06-24
+  * Fix: has_one only saves for a create, not update.  added in save for update.
+== 0.4.1 2008-06-23
+  * Fix: removed extra save call for polymorphic associations.  rails handles the save on a has_one relationship
+== 0.4.0 2008-06-23
+  * Add: support for other options such as :dependent and :class_name
+== 0.3.0 2008-06-12
+  * Add: :prefix parameter to depends_on call.  So if you have User.depends_on(:profile, :attrs => [:first_name], :prefix => true), your user model will have @user.profile_first_name.  This is to avoid name collisions with requisite classes.
+== 0.2.1 2008-06-09
+  * Add: exposed :can_be method.  Can now define what the polymorphic class can be with these methods.  This will add the "is_a_<model>?" and "as_a_<model>" methods.
+  * Add: respond_to? :can_be test before adding to requisite class
+== 0.2.0 2008-06-02
+  * Add:  When defining a depends_on that is polymorhic the requisite class has two methods added: "is_a_<model>?" and "as_a_<model>".
+== 0.1.1 2008-05-30
+  * Fix:  Merge when other conditionals are passed to the find_with method was incorrectly called without bang!
+== 0.1.0 2008-05-29
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/classy-inheritance.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
+test/test_classy-inheritance.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,48 @@
+= classy-inheritance
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'classy-inheritance/version'
+
+AUTHOR = 'Andrew Stone'  # can also be an array of Authors
+EMAIL = "andy@stonean.com"
+DESCRIPTION = "Adds a depends_on class method to your ActiveRecord model so that you can define requisite objects."
+GEM_NAME = 'classy-inheritance' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'classyinherit' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "astone"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = ClassyInheritance::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'classy-inheritance documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+#PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+PATH    = RUBYFORGE_PROJECT
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+#$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.rsync_args = '-av --delete'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/classy-inheritance.rb

@@ -0,0 +1,198 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+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)
+        end
+      end
+    end
+  end
+end
+                                  
+
+module Stonean
+  module ClassyInheritance
+    def self.included(base)
+      base.extend Stonean::ClassyInheritance::ClassMethods
+    end
+
+    module ClassMethods
+      def depends_on(model_sym, options = {}) 
+        define_relationship(model_sym,options)
+
+        # Optional presence of handling
+        if options.has_key?(:validates_presence_if) && options[:validates_presence_if] != true
+          if [Symbol, String, Proc].include?(options[:validates_presence_if].class)
+            validates_presence_of model_sym, :if => options[:validates_presence_if]
+          end
+        else
+          validates_presence_of model_sym
+        end
+
+        if options.has_key?(:validates_associated_if) && options[:validates_associated_if] != true
+          if [Symbol, String, Proc].include?(options[:validates_associated_if].class)
+            validates_associated_dependent model_sym, options, :if => options[:validates_associated_if]
+          end
+        else
+          validates_associated_dependent model_sym, options
+        end
+
+        # Before save functionality to create/update the requisite object
+        define_save_method(model_sym, options[:as])
+
+        # Adds a find_with_<model_sym> class method
+        define_find_with_method(model_sym)
+
+        if options[:as]
+          define_can_be_method_on_requisite_class(options[:class_name] || model_sym, options[:as])
+        end
+
+        options[:attrs].each{|attr| define_accessors(model_sym, attr, options)}
+      end
+
+
+      def can_be(model_sym, options = {})
+        unless options[:as]
+          raise ArgumentError, ":as attribute required when calling can_be"
+        end
+
+        klass = model_sym.to_s.classify
+
+        define_method "is_a_#{model_sym}?" do
+          eval("self.#{options[:as]}_type == '#{klass}'")
+        end
+
+        find_with_method = "find_with_#{self.name.underscore}"
+
+        define_method "as_a_#{model_sym}" do
+          eval("#{klass}.send(:#{find_with_method},self.#{options[:as]}_id)")
+        end
+      end
+
+      private
+
+      def classy_options
+        [:as, :attrs, :prefix, :postfix, :validates_presence_if, :validates_associated_if]
+      end
+
+      def delete_classy_options(options, *keepers)
+        options.delete_if do |key,value|
+          classy_options.include?(key) && !keepers.include?(key)
+        end
+        options
+      end
+
+      def define_relationship(model_sym, options)
+        opts = delete_classy_options(options.dup, :as)
+        if opts[:as]
+          as_opt = opts.delete(:as)
+          opts = polymorphic_constraints(as_opt).merge(opts)
+          has_one model_sym, opts
+        else
+          belongs_to model_sym, opts
+        end
+      end
+
+      def define_save_method(model_sym, polymorphic_name = nil)
+        define_method "save_requisite_#{model_sym}" do
+          # Return unless the association exists
+          eval("return unless self.#{model_sym}")
+
+          # Set the polymorphic type and id before saving
+          if polymorphic_name
+            eval("self.#{model_sym}.#{polymorphic_name}_type = self.class.name")
+            eval("self.#{model_sym}.#{polymorphic_name}_id = self.id")
+          end
+
+          if polymorphic_name
+            # Save only if it's an update, has_one creates automatically
+            eval <<-SAVEIT
+              unless self.#{model_sym}.new_record?
+                self.#{model_sym}.save
+              end
+            SAVEIT
+          else
+            eval("self.#{model_sym}.save")
+          end
+        end
+
+        before_save "save_requisite_#{model_sym}".to_sym
+      end
+
+      def define_find_with_method(model_sym)
+        self.class.send :define_method, "find_with_#{model_sym}" do |*args|
+          eval <<-CODE
+            if args[1] && args[1].is_a?(Hash)
+              if args[1].has_key?(:include)
+                inc_val = args[1][:include]
+                new_val = inc_val.is_a?(Array) ? inc_val.push(:#{:model_sym}) : [inc_val, :#{model_sym}] 
+                args[1][:include] = new_val
+              else
+                args[1].merge!({:include => :#{model_sym}})
+              end
+            else
+              args << {:include => :#{model_sym}}
+            end
+            find(*args)
+          CODE
+        end
+      end
+
+      def define_accessors(model_sym, attr, options)
+        accessor_method_name = attr
+
+        if options[:prefix]
+          accessor_method_name = (options[:prefix] == true) ? "#{model_sym}_#{accessor_method_name}" : "#{options[:prefix]}_#{accessor_method_name}"
+        end
+
+        if options[:postfix]
+          accessor_method_name = (options[:postfix] == true) ? "#{accessor_method_name}_#{model_sym}" : "#{accessor_method_name}_#{options[:postfix]}"
+        end
+
+        define_method accessor_method_name do
+          eval("self.#{model_sym} ? self.#{model_sym}.#{attr} : nil")
+        end
+
+        define_method "#{accessor_method_name}=" do |val|
+          model_defined = eval("self.#{model_sym}")
+
+          unless model_defined
+            klass = options[:class_name] || model_sym.to_s.classify
+            eval("self.#{model_sym} = #{klass}.new")
+          end
+
+          eval("self.#{model_sym}.#{attr}= val")
+        end
+      end
+
+      def define_can_be_method_on_requisite_class(model_sym, polymorphic_name)
+        klass = model_sym.to_s.classify
+        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 
+        end
+      end
+
+      def polymorphic_constraints(polymorphic_name)
+        { :foreign_key => "#{polymorphic_name}_id",
+          :conditions => "#{polymorphic_name}_type = '#{self.name}'"}
+      end
+    end # ClassMethods
+  end # ClassyInheritance module
+end # Stonean module
+ActiveRecord::Base.send :include, Stonean::ClassyInheritance

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/classy-inheritance.rb'}"
+puts "Loading classy-inheritance gem"
+exec "#{irb} #{libs} --simple-prompt"