caruby-core 1.4.7 → 1.4.9

data/lib/caruby/migration/uniquify.rb

@@ -1,4 +1,3 @@
-require 'caruby/migration/migratable'
 require 'caruby/domain/uniquify'
 
 module CaRuby

data/lib/caruby/resource.rb

@@ -17,7 +17,7 @@ module CaRuby
   # This module defines essential common domain methods that enable the jRuby-Java API bridge.
   # Classes which include Domain must implement the +metadata+ Domain::Metadata accessor method.
   module Resource
-    include Mergeable, Migratable, Persistable, Inversible, Validation
+    include Mergeable, Migratable, Persistable, Inversible
     
     # JRuby alert - Bug #5090 - JRuby 1.5 object_id no longer reserved, results in String value.
     # See http://jira.codehaus.org/browse/JRUBY-5090.
@@ -25,6 +25,7 @@ module CaRuby
     #
     # @return [Integer] the object id
     def proxy_object_id
+      # make a hash code on demand
       @_hc ||= (Object.new.object_id * 31) + 17
     end
     
@@ -54,8 +55,13 @@ module CaRuby
       end
       self
     end
+    
+    # Sets the default attribute values for this auto-generated domain object.
+    def add_defaults_autogenerated
+      add_defaults_recursive
+    end
 
-    # Validates this domain object and its #{ResourceAttributes.unproxied_cascaded_attributes}
+    # Validates this domain object and its #{ResourceAttributes.unproxied_save_template_attributes}
     # for completeness prior to a database create operation.
     # An object without an identifer is valid if it contains a non-nil value for each mandatory property.
     # Objects which have an identifier or have already been validated are skipped.
@@ -69,7 +75,7 @@ module CaRuby
         validate_local
         @validated = true
       end
-      self.class.unproxied_cascaded_attributes.each do |attr|
+      self.class.unproxied_save_template_attributes.each do |attr|
         send(attr).enumerate { |dep| dep.validate }
       end
       self
@@ -167,6 +173,12 @@ module CaRuby
     def owner
       self.class.owner_attributes.detect_value { |attr| send(attr) }
     end
+
+    # @return [Symbol, nil] the attribute for which there is an owner reference,
+    #  or nil if this domain object does not reference an owner
+    def effective_owner_attribute
+      self.class.owner_attributes.detect { |attr| send(attr) }
+    end
     
     # Sets this dependent's owner attribute to the given domain object.
     #
@@ -430,7 +442,7 @@ module CaRuby
     # @yieldparam [Resource] owner the domain object to print
     # @return [String] the domain object content
     def dump(&selector)
-      database.lazy_loader.disable { DetailPrinter.new(self, &selector).pp_s }
+      do_without_lazy_loader { DetailPrinter.new(self, &selector).pp_s }
     end
 
     # Prints this domain object in the format:
@@ -708,7 +720,18 @@ module CaRuby
       attr_md = self.class.attribute_metadata(attribute)
       attr_md.property_descriptor.property_type if JavaAttributeMetadata === attr_md
     end
-
+    
+    # Executes the given block with the database lazy loader disabled, if any.
+    #
+    # @yield the block to execute
+    def do_without_lazy_loader(&block)
+      if database then
+        database.lazy_loader.disable(&block)
+      else
+        yield
+      end
+    end
+    
     # Returns the source => target hash of matches for the given attr_md newval sources and
     # oldval targets. If the matcher block is given, then that block is called on the sources
     # and targets. Otherwise, {Resource.match_all} is called.

data/lib/caruby/util/attribute_path.rb

@@ -2,8 +2,6 @@ require 'caruby/util/validation'
 
 # An AttributePath encapsulates an array of attributes that can be evaluated on a source object.
 class AttributePath < Array
-  include Validation
-
   # Creates an AttributePath from the path Array, String or Symbol. A path string is a period-delimited sequence
   # of attributes, e.g. +person.name+.
   def initialize(path)

data/lib/caruby/util/class.rb

@@ -13,21 +13,21 @@ class Class
   alias :succ :superclass
 
   private
-
+  
   # Creates an alias for each accessor method of the given attribute.
   #
   # @example
   #   class Person
   #    attr_reader :social_security_number
   #    attr_accessor :postal_code
-  #    define_attribute_alias(:ssn, :social_security_number)
-  #    define_attribute_alias(:zip_code, :postal_code)
+  #    alias_attribute(:ssn, :social_security_number)
+  #    alias_attribute(:zip_code, :postal_code)
   #   end
   #   Person.method_defined?(:ssn) #=> true
   #   Person.method_defined?(:ssn=) #=> false
   #   Person.method_defined?(:zip_code) #=> true
   #   Person.method_defined?(:zip_code=) #=> true
-  def define_attribute_alias(aliaz, attribute)
+  def alias_attribute(aliaz, attribute)
     alias_method(aliaz, attribute) if method_defined?(attribute)
     writer = "#{attribute}=".to_sym
     alias_method("#{aliaz}=".to_sym, writer) if method_defined?(writer)
@@ -117,7 +117,10 @@ class Class
   # The block creates a proc which implements the new method body.
   #
   # @example
-  #   redefine_method(:ssn) { |old_method| lambda { send(old_method).delete('-').to_i } }
+  #   redefine_method(:ssn) { |omth| lambda { send(omth).delete('-').to_i } }
+  # @param [Symbol] method the method to redefine
+  # @yield [old_method] the redefinition Proc
+  # @yieldparam old_method [Symbol] the method being redefined
   # @return [Symbol] an alias to the old method implementation
   def redefine_method(method)
     # make a new alias id method__base for the existing method.

data/lib/caruby/util/collection.rb

@@ -1,7 +1,6 @@
 require 'set'
 require 'delegate'
 require 'enumerator'
-require 'generator'
 require 'caruby/util/class'
 require 'caruby/util/validation'
 require 'caruby/util/options'
@@ -229,10 +228,12 @@ module Enumerable
   # @yield [item] the transformer on the enumerated items
   # @yieldparam item an enumerated item
   # @return [Enumerable] an enumeration on the transformed values
-  def wrap(&mapper)
+  def transform(&mapper)
     Transformer.new(self, &mapper)
   end
   
+  alias :wrap :transform
+  
   def join(other)
     Joiner.new(self, other)
   end
@@ -276,7 +277,7 @@ module Enumerable
     # @param item the item to add
     # @return [Filter] self
     def <<(item)
-      @base << value
+      @base << item
       self
     end
 
@@ -794,6 +795,7 @@ module Hashable
     include Hashable
 
     def initialize(*hashes)
+      if hashes.include?(nil) then raise ArgumentError.new("MultiHash is missing a component hash.") end
       @hashes = hashes
     end
 

data/lib/caruby/util/domain_extent.rb

@@ -7,8 +7,6 @@ require 'caruby/util/validation'
 # @example
 #   DomainExtent.new { |klass, key| key.to_s + klass.name }.get(String, 'a') #=> aString
 class DomainExtent < LazyHash
-  include Validation
-
   # Creates a new DomainExtent. The block passed to the constructor
   # is a factory to create an object on demand, with arguments
   # the target class and the target key. The default block is empty.
@@ -24,7 +22,6 @@ class DomainExtent < LazyHash
   # The factory accepts a single argument, the instance key, e.g.
   #   set_factory(MyClass) { |key| MyClass.new(key) }
   def set_factory(klass, &factory)
-    validate_type(klass => Class)
     # the current instances, if any
     instances = fetch(klass) if has_key?(klass)
     # make the key => instance class extent map

data/lib/caruby/util/options.rb

@@ -30,15 +30,16 @@ class Options
   def self.get(option, options, default=nil, &block)
     return default(default, &block) if options.nil?
     case options
-    when Hash then
-      value = options[option]
-      value.nil? ? default(default, &block) : value
-    when Enumerable then
-      options.include?(option) ? true : default(default, &block)
-    when Symbol then
-      option == options ? true : default(default, &block)
-    else
-      raise ArgumentError.new("Options argument type is not supported; expected Hash or Symbol, found: #{options.class}")
+      when Hash then
+        value = options[option]
+        if String === value then value.strip! end
+        value.nil_or_empty? ? default(default, &block) : value
+      when Enumerable then
+        options.include?(option) ? true : default(default, &block)
+      when Symbol then
+        option == options ? true : default(default, &block)
+      else
+        raise ArgumentError.new("Options argument type is not supported; expected Hash or Symbol, found: #{options.class}")
     end
   end
 

data/lib/caruby/util/person.rb

@@ -4,12 +4,29 @@ require 'caruby/util/validation'
 module CaRuby
   module Person
     class Name
-      include Validation
-
-      attr_accessor :salutation, :qualifier, :credentials
-      attr_reader :first, :last, :middle
+      # @return [String] the salutation, e.g. 'Mr.'
+      attr_accessor :salutation
+      
+      # @return [String] the trailing name qualifier, e.g. 'III'
+      attr_accessor :qualifier
+      
+      # @return [String] the trailing name credentials, e.g. 'MD'
+      attr_accessor :credentials
+      
+      # @return [String] the first name
+      attr_reader :first
+      
+      # @return [String] the middle name
+      attr_reader :middle
+      
+      # @return [String] the ;ast name
+      attr_reader :last
 
       # Creates a new Name with the required last and optional first and middle components.
+      #
+      # @param [String] last the required last name
+      # @param [String, nil] first the optional first name
+      # @param [String, nil] middle the optional middle name
       def initialize(last, first=nil, middle=nil)
         # replace empty with nil
         @first = first unless first == ''
@@ -17,7 +34,8 @@ module CaRuby
         @middle = middle unless middle == ''
       end
 
-      # Returns this Name as an array consisting of the first, middle and last fields.
+      # @return [(String, String, String)] this Name as an array consisting of the first,
+      # middle and last fields
       #
       # @example
       #  Person.parse("Abe Lincoln").to_a #=> ["Abe", nil, "Lincoln"]
@@ -25,14 +43,14 @@ module CaRuby
         [@first, @middle, @last]
       end
 
-      # Returns this Name in the format [Salutation] First [Middle] Last[, Credentials].
+      # @return [String] this Name in the format [Salutation] First [Middle] Last[, Credentials]
       def to_s
         name_s = [salutation, first, middle, last, qualifier].reject { |part| part.nil? }.join(' ')
         name_s << ', ' << credentials if credentials
         name_s
       end
 
-      # Returns whether this Person's first, middle and last name components equal the other Person's.
+      # @return [Boolean] whether this Person's first, middle and last name components equal the other Person's
       def ==(other)
         self.class == other.class and first == other.first and middle == other.middle and last == other.last
       end
@@ -44,12 +62,15 @@ module CaRuby
       # * [salutation] [first [middle]] last [qualifier] [, credentials]
       # where _salutation_ ends in a period.
       #
-      # Examples:
+      # Example input:
       # * Longfellow, Henry Wadsworth
       # * Longfellow, Henry Gallifant Wadsworth
       # * Henry Longfellow
       # * Longfellow
       # * Mr. Henry Wadsworth Longfellow III, MD, Ph.D.
+      #
+      # @param [String] name_s the name to parse
+      # @return [Name] the parsed Name
       def self.parse(name_s)
         return if name_s.blank?
         # the name component variables
@@ -94,8 +115,8 @@ module CaRuby
         name
       end
 
-      # Raises ValidationError if there is neither a first nor a last name
-      # or if there is a middle name but no first name.
+      # @raise [ValidationError] if there is neither a first nor a last name
+      # or if there is a middle name but no first name
       def validate
         if last.nil? and first.nil? then
           raise ValidationError.new("Name is missing both the first and last fields")
@@ -105,12 +126,20 @@ module CaRuby
         end
       end
 
-      # Returns whether s ends in a period.
+      # @param [String] s a name fragment
+      # @return [Boolean] whether the fragment ends in a period
       def self.salutation?(s)
         s =~ /\.$/
       end
 
-      # Returns whether s is Jr., Sr., II, III, etc.
+      # Returns whether the given name fragment is a recognized qualifier. The following
+      # qualifiers are recognized:
+      # * +Jr+ with optional period
+      # * +Sr+ with optional period
+      # * +I+, +II+ or +III+
+      #
+      # @param [String] s a name fragment
+      # @return [Boolean] whether s is a recognized qualifier
       def self.qualifier?(s)
         s and (s =~ /[J|S]r[.]?/ or s =~ /\AI+\Z/)
       end

data/lib/caruby/util/pretty_print.rb

@@ -124,7 +124,7 @@ module Enumerable
   # Pretty-prints the content within brackets, as is done by the Array pretty printer.
   def pretty_print(q)
     q.group(1, '[', ']') {
-      q.seplist(self) {|v|
+      q.seplist(self) { |v|
         q.pp v
       }
     }

data/lib/caruby/util/validation.rb

@@ -18,31 +18,3 @@ class Object
     nil? or (respond_to?(:empty?) and empty?)
   end
 end
-
-module Validation
-  # A Validator is a procedure which responds to the +validate(value)+ method.
-  class Validator < Proc
-    alias :validate :call
-  end
-
-  # Validates that each key value in the value_type_assns value => type hash is an instance of the associated class.
-  #
-  # Raises ValidationError if the value is missing.
-  # Raises TypeError if the value is not the specified type.
-  def validate_type(value_type_assns)
-    TYPE_VALIDATOR.validate(value_type_assns)
-  end
-
-  private
-
-  def self.create_type_validator
-    Validator.new do |value_type_assns|
-      value_type_assns.each do |value, type|
-        raise ArgumentError.new("Missing #{type.name} argument") if value.nil?
-        raise TypeError.new("Unsupported argument type; expected: #{type.name} found: #{value.class.name}") unless type === value
-      end
-    end
-  end
-
-  TYPE_VALIDATOR = create_type_validator
-end

data/lib/caruby/version.rb

@@ -1,3 +1,3 @@
 module CaRuby
-  VERSION = "1.4.7"
+  VERSION = "1.4.9"
 end

data/test/lib/caruby/import/java_test.rb

@@ -6,18 +6,26 @@ require 'caruby'
 
 class JavaTest < Test::Unit::TestCase
   def test_ruby_to_java_date_conversion
-    ruby_date = DateTime.now
-    java_date = Java::JavaUtil::Date.from_ruby_date(ruby_date)
-    actual = java_date.to_ruby_date
-    assert(CaRuby::Resource.value_equal?(ruby_date, actual), 'Ruby->Java->Ruby date conversion not idempotent')
+    rdt = DateTime.now
+    jdt = Java::JavaUtil::Date.from_ruby_date(rdt)
+    assert(CaRuby::Resource.value_equal?(rdt, jdt.to_ruby_date), 'Ruby->Java->Ruby date conversion not idempotent')
   end
 
   def test_java_to_ruby_date_conversion
-    java_date = Java::JavaUtil::Calendar.instance.time
-    ruby_date = java_date.to_ruby_date
-    actual = Java::JavaUtil::Date.from_ruby_date(ruby_date)
-    assert_equal(java_date.to_s, actual.to_s, 'Java->Ruby->Java date conversion not idempotent')
-    assert_equal(java_date.to_ruby_date, ruby_date, 'Java->Ruby date reconversion not equal')
+    cal = Java::JavaUtil::Calendar.instance
+    verify_java_to_ruby_date_conversion(cal.time)
+    # roll back to a a different DST setting
+    if cal.timeZone.useDaylightTime then
+      verify_java_to_ruby_date_conversion(flip_DST(cal))
+    end
+  end
+  
+  def flip_DST(cal)
+    isdt = cal.timeZone.inDaylightTime(cal.time)
+    11.times do
+      cal.roll(Java::JavaUtil::Calendar::MONTH, false)
+      return cal.time if cal.timeZone.inDaylightTime(cal.time) != isdt
+    end
   end
 
   def test_to_ruby
@@ -55,4 +63,13 @@ class JavaTest < Test::Unit::TestCase
     assert(set.include?(2), "HashSet merge not updated")
     assert_same(set, set.clear, "HashSet clear result incorrect")
   end
+  
+  private 
+  
+  def verify_java_to_ruby_date_conversion(jdate)
+    rdt = jdate.to_ruby_date
+    actual = Java::JavaUtil::Date.from_ruby_date(rdt)
+    assert_equal(jdate.to_s, actual.to_s, 'Java->Ruby->Java date conversion not idempotent')
+    assert_equal(jdate.to_ruby_date, rdt, 'Java->Ruby date reconversion not equal')
+  end
 end

data/test/lib/caruby/migration/test_case.rb

@@ -0,0 +1,103 @@
+LOG_FILE = 'test/results/log/migration.log'
+
+require File.join(File.dirname(__FILE__), '..', 'test_case')
+require 'caruby/domain/uniquify'
+require 'caruby/migration/migrator'
+
+module CaRuby
+  module MigrationTestCase
+    include CaRuby::TestCase
+
+    #@param [String] fixtures the fixtures directory
+    def setup(fixtures, database=nil)
+      super(database)
+      @fixtures = fixtures
+      # Clear the uniquifier for this migration.
+      CaRuby::ResourceUniquifier.instance.clear
+    end
+
+    ## MIGRATION TEST UTILITY METHODS ##
+
+    private
+
+    # Runs a migrator on the given input fixture and options.
+    #
+    # @param (see #create_migrator)
+    # @option (see #create_migrator)
+    def migrate_to_database(fixture, opts={}, &verifier)
+      mgtr = create_migrator(fixture, opts)
+      logger.debug { "Migration test migrating #{fixture} fixture..." }
+      mgtr.migrate_to_database(&verifier)
+      logger.debug { "Migration test migrated #{fixture} fixture." }
+    end
+
+    # Creates a new Migrator for the given fixture with the given options.
+    # If a factory block is provided, then that factory is called to make a new
+    # Migrator instance. Otherwise, {CaTissue::Migrator#initialize} makes the instance.
+    #
+    # If there is no :input option, then the migration input is set to the
+    # _fixture_.+csv+ file in the {#initialize} fixtures directory.
+    #
+    # @param [Symbol] fixture the migration test fixture
+    # @param [{Symbol => Object}] opts (see CaTissue::Migrator#initialize)
+    # @option (see CaTissue::Migrator#initialize)
+    # @return [CaTissue::Migrator]
+    # @yield [opts] the optional Migrator factory
+    def create_migrator(fixture, opts={}, &factory)
+      opts[:quiet] = true
+      opts[:input] ||= File.join(@fixtures, fixture.to_s + '.csv')
+      block_given? ? yield(opts) : CaRuby::Migrator.new(opts)
+    end
+
+    # Verifies that the given test fixture is successfully migrated.
+    # Each migrated target object is validated using {CaTissue::TestCase#verify_saved}.
+    # In addition, if a verifier block is given to this method, then that block is
+    # called on the target migration object, or nil if no target was migrated.
+    # Supported options are described in {CaTissue::Migrator#migrate}.
+    #
+    # @param (see #verify_target)
+    # @option (see #verify_target)
+    # @yield (see #verify_target)
+    # @yieldparam (see #verify_target)
+    def verify_save(fixture, opts={})
+      logger.debug { "Migrating the #{fixture} test fixture..." }
+      opts[:unique] = true unless opts.has_key?(:unique)
+      migrate_to_database(fixture, opts) do |tgt|
+        verify_saved(tgt)
+        yield tgt if block_given?
+      end
+    end
+
+    # Verifies the given fixture migration.
+    # Each migrated target object is validated using {#validate_target}.
+    # The target is migrated but not stored.
+    #
+    # @param [Symbol] fixture the test fixture to verify
+    # @param [<Symbol>] opts the migration options
+    # @option (see CaTissue::Migrator#migrate)
+    # @yield [target] verifies the given target
+    # @yieldparam [Resource] target the domain object to verify
+    def verify_target(fixture, opts={}, &verifier)
+      opts[:unique] ||= false
+      create_migrator(fixture, opts).migrate { |tgt| validate_target(tgt, &verifier) }
+    end
+
+    # Validates that the given target was successfully migrated.
+    # If a target was migrated, then this method calls {CaTissue::TestCase#verify_defaults}
+    # to confirm that the target can be stored.
+    # In addition, if a block is given to this method then the block is called on the
+    # (possibly nil) migration target.
+    #
+    # @param [Resource] target the domain object to verify
+    # @yield (see #verify_target)
+    # @yieldparam (see #verify_target)
+    def validate_target(target)
+      assert_not_nil(target, "Missing target")
+      logger.debug { "Validating migration target #{target}..." }
+      verify_defaults(target) if target
+      yield target if block_given?
+      logger.debug { "Validated migration target #{target}." }
+      target
+    end
+  end
+end