classy-inheritance 0.4.4 → 0.5.0

data/History.txt

@@ -1,3 +1,6 @@
+== 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

data/lib/classy-inheritance.rb

@@ -26,8 +26,22 @@ module Stonean
       def depends_on(model_sym, options = {}) 
         define_relationship(model_sym,options)
 
-        validates_presence_of model_sym
-        validates_associated model_sym
+        # 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_assoicated_if].class)
+            validates_associated model_sym, :if => options[:validates_associated_if]
+          end
+        else
+          validates_associated model_sym
+        end
 
         # Before save functionality to create/update the requisite object
         define_save_method(model_sym, options[:as])
@@ -63,9 +77,19 @@ module Stonean
 
       private
 
+      def classy_options
+        [:as, :attrs, :prefix, :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 = options.dup
-        [:attrs, :prefix].each{|key| opts.delete(key)}
+        opts = delete_classy_options(options.dup, :as)
         if opts[:as]
           as_opt = opts.delete(:as)
           opts = polymorphic_constraints(as_opt).merge(opts)
@@ -77,12 +101,17 @@ module Stonean
 
       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

data/lib/classy-inheritance/version.rb

@@ -1,8 +1,8 @@
 module ClassyInheritance #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 4
-    TINY  = 4
+    MINOR = 5
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_classy-inheritance.rb

@@ -1,11 +1,61 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
+User.depends_on :profile, :attrs => [:first_name, :last_name, :email]
+
 class TestClassyInheritance < Test::Unit::TestCase
 
   def setup
+    @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
+  
+  def test_user_should_respond_to_find_with_profile
+    assert User.respond_to?(:find_with_profile)
+  end
+
+  def test_user_should_respond_to_first_name
+    assert @user.respond_to?(:first_name)
+  end
+  
+  def test_user_should_respond_to_first_name=
+    assert @user.respond_to?(:first_name=)
   end
   
-  def test_truth
-    assert true
+  def test_user_should_respond_to_last_name
+    assert @user.respond_to?(:last_name)
   end
+  
+  def test_user_should_respond_to_last_name=
+    assert @user.respond_to?(:last_name=)
+  end
+  
+  def test_user_should_respond_to_email
+    assert @user.respond_to?(:email)
+  end
+  
+  def test_user_should_respond_to_email=
+    assert @user.respond_to?(:email=)
+  end
+  
+  def test_user_should_be_invalid_without_profile_attributes
+    @user.login = 'joe'
+    assert !@user.valid?
+  end
+  
+  def test_user_should_valid_with_profile_attributes
+    @user.login = 'joe'
+    @user.first_name = 'joe'
+    @user.last_name = 'bloggs'
+    @user.email = 'joe@bloggs.co.uk'
+    
+    assert @user.valid?
+  end
+  
 end

data/test/test_helper.rb

@@ -1,2 +1,136 @@
+require 'rubygems'
+require 'activerecord'
+
 require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/classy-inheritance'
+
+ActiveRecord::Base.establish_connection({
+      :adapter => "sqlite3",
+      :dbfile => "test/database.sqlite3"
+})
+
+class SetupTestTables < ActiveRecord::Migration
+  def self.up
+    create_table :profiles, :force => true do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :email
+
+      t.timestamps
+    end
+    
+    create_table :users, :force => true do |t|
+      t.string :login
+      t.integer :profile_id
+
+      t.timestamps
+    end
+    
+    create_table :authors, :force => true do |t|
+      t.string :login
+      t.integer :profile_id
+
+      t.timestamps
+    end
+
+    create_table :artists, :force => true do |t|
+      t.string :login
+      t.integer :profile_id
+
+      t.timestamps
+    end
+
+    create_table :addresses, :force => true do |t|
+      t.string :line_one
+      t.string :line_two
+      t.string :city
+      t.string :state_code
+      t.string :postal_code
+
+      t.timestamps
+    end
+
+    create_table :offices, :force => true do |t|
+      t.string :name
+      t.integer :billing_address_id
+      t.integer :shipping_address_id
+
+      t.timestamps
+    end
+
+    create_table :contents, :force => true do |t|
+      t.string :name
+      t.string :presentable_type 
+      t.integer :presentable_id
+
+      t.timestamps
+    end
+
+    create_table :pages, :force => true do |t|
+      t.text :body
+
+      t.timestamps
+    end
+
+    create_table :documents, :force => true do |t|
+      t.string :version_file_name
+      t.string :version_content_type
+      t.integer :version_file_size
+
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :authors
+    drop_table :artists
+    drop_table :users
+    drop_table :profiles
+    drop_table :offices
+    drop_table :addresses
+    drop_table :pages
+    drop_table :documents
+    drop_table :contents
+  end
+end
+
+SetupTestTables.migrate(:up)
+
+class Profile < ActiveRecord::Base
+  validates_presence_of :first_name, :last_name, :email
+end
+
+class User < ActiveRecord::Base
+  validates_presence_of :login
+end
+
+class Author < ActiveRecord::Base
+  validates_presence_of :login
+end
+
+# to test optional dependency
+class Artist < ActiveRecord::Base
+  validates_presence_of :login
+end
+
+# to test using standard relationship options (class_name, etc..)
+class Address < ActiveRecord::Base
+  validates_presence_of :line_one, :city, :postal_code
+end
+
+class Office < ActiveRecord::Base
+  validates_presence_of :name
+end
+
+# Polymorphic classes
+class Content < ActiveRecord::Base
+  validates_presence_of :name
+end
+
+class Page < ActiveRecord::Base
+  validates_presence_of :body
+end
+
+# Would typically use PaperClip for this...
+class Document < ActiveRecord::Base
+end

data/test/test_polymorphic_associations.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+Content.can_be :document, :as => :presentable
+
+Page.depends_on :content, :attrs => [:name], :as => :presentable
+
+class TestPolymorphicAssociations < Test::Unit::TestCase
+
+  def setup
+    @page = Page.new
+
+    @test_page = Page.create(:name => 'My Page', :body => 'Something interesting')
+    @test_content = @test_page.content
+  end
+
+  # from Content.can_be declaration
+  def test_document_should_respond_to_find_with_content
+    assert Document.respond_to?(:find_with_content)
+  end
+
+  def test_page_should_respond_to_name
+    assert @page.respond_to?(:name)
+  end
+
+  def test_page_should_fail_validation_without_content_name
+    @page.body = 'Some really informative stuff that would be a lot longer'
+    assert !@page.valid?
+  end
+
+  def test_page_should_pass_validation_with_content_name
+    @page.name = 'First Page'
+    @page.body = 'Some really informative stuff that would be a lot longer'
+    assert @page.valid?
+  end
+
+  def test_page_should_create_content
+    @page.name = 'First Page'
+    @page.body = 'Some really informative stuff that would be a lot longer'
+    @page.save
+
+    assert @page.content.id != nil
+  end
+
+  def test_content_should_respond_to_is_a_document
+    assert @test_content.respond_to?(:is_a_document?)
+  end
+
+  def test_content_should_respond_to_as_a_document
+    assert @test_content.respond_to?(:as_a_document)
+  end
+
+  def test_content_should_respond_to_is_a_page
+    assert @test_content.respond_to?(:is_a_page?)
+  end
+
+  def test_content_should_respond_to_as_a_page
+    assert @test_content.respond_to?(:as_a_page)
+  end
+
+  def test_content_should_return_page_object
+    assert @test_content.as_a_page.is_a?(Page)
+  end
+  
+end

data/test/test_with_optional_dependency.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestWithOptionalDependency < Test::Unit::TestCase
+  # Turn off the validates_presence_of call
+  Author.depends_on :profile, :validates_presence_if => false, 
+    :attrs => [:first_name, :last_name, :email]
+  
+  # Turn off the validates_presence_of and the validates_associated calls
+  Artist.depends_on :profile, :validates_presence_if => false, 
+    :validates_associated_if => false,
+    :attrs => [:first_name, :last_name, :email]
+
+  def setup
+    @author = Author.new
+    @artist = Artist.new
+  end
+  
+  def test_author_should_be_valid_without_profile
+    @author.login = 'joe'
+    
+    @author.valid?
+    puts @author.errors.full_messages.to_sentence
+    
+    assert @author.valid?
+  end
+  
+  def test_author_should_be_invalid_with_invalid_profile
+    @author.login = 'joe'
+    @author.first_name = 'joe'
+    
+    assert !@author.valid?
+  end
+  
+  def test_author_should_be_valid_with_profile_attributes
+    @author.login = 'joe'
+    @author.first_name = 'joe'
+    @author.last_name = 'bloggs'
+    @author.email = 'joe@bloggs.co.uk'
+    
+    assert @author.valid?
+  end
+
+  def test_artist_should_not_save_with_invalid_profile
+    @artist.login = 'joe'
+    @artist.first_name = 'joe'
+    
+    assert !@artist.save
+  end
+
+  def test_artist_should_save_with_valid_profile
+    @artist.login = 'joe'
+    @artist.first_name = 'joe'
+    @artist.last_name = 'bloggs'
+    @artist.email = 'joe@bloggs.co.uk'
+    
+    assert @artist.save
+  end
+  
+end

data/test/test_with_standard_attributes.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+Office.depends_on :billing_address, 
+                  :attrs => [:line_one, :line_two, :city, :state_code, :postal_code],
+                  :class_name => "Address", 
+                  :foreign_key => "billing_address_id", 
+                  :prefix => true
+
+Office.depends_on :shipping_address, 
+                  :attrs => [:line_one, :line_two, :city, :state_code, :postal_code],
+                  :class_name => "Address", 
+                  :foreign_key => "shipping_address_id", 
+                  :prefix => true
+
+class TestWithStandardAttributes < Test::Unit::TestCase
+  def setup
+    @office = Office.new
+  end
+  
+  def test_office_should_respond_to_billing_address_line_one
+    assert_respond_to(@office, :billing_address_line_one)
+  end
+
+  def test_office_should_respond_to_billing_address_line_two
+    assert_respond_to(@office, :billing_address_line_two)
+  end
+
+  def test_office_should_respond_to_billing_address_city
+    assert_respond_to(@office, :billing_address_city)
+  end
+
+  def test_office_should_respond_to_billing_address_state_code
+    assert_respond_to(@office, :billing_address_state_code)
+  end
+
+  def test_office_should_respond_to_billing_address_postal_code
+    assert_respond_to(@office, :billing_address_postal_code)
+  end
+
+  def test_office_should_respond_to_shipping_address_line_one
+    assert_respond_to(@office, :shipping_address_line_one)
+  end
+
+  def test_office_should_respond_to_shipping_address_line_two
+    assert_respond_to(@office, :shipping_address_line_two)
+  end
+
+  def test_office_should_respond_to_shipping_address_city
+    assert_respond_to(@office, :shipping_address_city)
+  end
+
+  def test_office_should_respond_to_shipping_address_state_code
+    assert_respond_to(@office, :shipping_address_state_code)
+  end
+
+  def test_office_should_respond_to_shipping_address_postal_code
+    assert_respond_to(@office, :shipping_address_postal_code)
+  end
+
+  def test_office_should_create_billing_and_shipping_address_records
+    @office.name = 'Initest'
+
+    @office.billing_address_line_one = '123 Somewhere'
+    @office.billing_address_city = 'Somecity'
+    @office.billing_address_postal_code = '12345'
+
+    @office.shipping_address_line_one = '999 MyHouse'
+    @office.shipping_address_city = 'Mycity'
+    @office.shipping_address_postal_code = '98765'
+
+    @office.save
+
+    @billing_address = Address.find(@office.billing_address_id)
+    @shipping_address = Address.find(@office.shipping_address_id)
+
+    assert_equal @billing_address, @office.billing_address
+
+    assert_equal @shipping_address, @office.shipping_address
+  end
+
+
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Classy Inheritance</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/classyinherit"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/classyinherit" class="numbers">0.4.4</a>
+      <a href="http://rubyforge.org/projects/classyinherit" class="numbers">0.5.0</a>
     </div>
     <p><i>&#8220;You stay classy, inheritance&#8221; &#8211; Gibson</i></p>
 
@@ -56,7 +56,7 @@
 	<p>Thanks for your interest in Classy Inheritance,<br/>
 -andy</p>
     <p class="coda">
-      <a href="http://blog.stonean.com">Andrew Stone</a>, 24th June 2008<br>
+      <a href="http://blog.stonean.com">Andrew Stone</a>, 8th July 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: classy-inheritance
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors: 
 - Andrew Stone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-24 00:00:00 -04:00
+date: 2008-07-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -84,3 +84,6 @@ summary: Adds a depends_on class method to your ActiveRecord model so that you c
 test_files: 
 - test/test_classy-inheritance.rb
 - test/test_helper.rb
+- test/test_polymorphic_associations.rb
+- test/test_with_optional_dependency.rb
+- test/test_with_standard_attributes.rb