jinx-migrate 2.1.1 → 2.1.2

data/Gemfile

@@ -3,6 +3,6 @@ gemspec
 
 group :development do
   # Uncomment to use the local development project.
-  gem 'jinx', :path => File.dirname(__FILE__) + '/../core'
+  #gem 'jinx', :path => File.dirname(__FILE__) + '/../core'
   gem 'jinx-migrate', :path => File.dirname(__FILE__)
 end

data/History.md

@@ -1,6 +1,10 @@
 This history lists major release themes. See the GitHub commits (https://github.com/jinx/migrate)
 for change details.
 
+2.1.2 / 2012-06-12
+------------------
+* Support caSmall web service.
+
 2.1.1 / 2012-04-13
 ------------------
 * Initial public release spun off from caruby/core.

data/lib/jinx/csv/csvio.rb

@@ -110,7 +110,7 @@ module Jinx
       when Enumerable then
         ''.parse_csv(:headers => hdr_opt, :header_converters => :symbol, :return_headers => true)
       else
-        Jinx.fail(ArgumentError, "CSV headers option value not supported: #{hdr_opt}")
+        raise ArgumentError.new("CSV headers option value not supported: #{hdr_opt}")
       end
       # The field value accessors consist of the header row headers converted to a symbol.
       @accessors = hdr_row.headers

data/lib/jinx/migration/filter.rb

@@ -139,7 +139,7 @@ module Jinx
           reopt = if opt then
             case opt
               when 'i' then Regexp::IGNORECASE
-              else Jinx.fail(MigrationError, "Migration value filter regular expression #{k} qualifier not supported: expected 'i', found '#{opt}'")
+              else raise MigrationError.new("Migration value filter regular expression #{k} qualifier not supported: expected 'i', found '#{opt}'")
             end
           end
           # the Regexp object

data/lib/jinx/migration/migrator.rb

@@ -7,7 +7,6 @@ require 'jinx/helpers/lazy_hash'
 require 'jinx/helpers/log'
 require 'jinx/helpers/inflector'
 require 'jinx/helpers/pretty_print'
-require 'jinx/helpers/stopwatch'
 require 'jinx/helpers/transitive_closure'
 require 'jinx/migration/migratable'
 require 'jinx/migration/reader'
@@ -20,15 +19,13 @@ module Jinx
   class Migrator
     include Enumerable
 
-    # Creates a new Migrator. The input can be either a file name or a source factory. The factory
-    # implements the +open+ method, which returns a {Migration::Reader}
+    # Creates a new Migrator from the given options.
     #
     # @param [{Symbol => Object}] opts the migration options
-    # @option opts [String] :target the required target domain class
+    # @option opts [Class] :target the required target domain class
     # @option opts [<String>, String] :mapping the required input field => caTissue attribute mapping file(s)
     # @option opts [String, Migration::Reader] :input the required input file name or an adapter which
     #   implements the {Migration::Reader} methods
-    # @option opts [Jinx::Database] :database the optional destination +Jinx::Database+
     # @option opts [<String>, String] :defaults the optional caTissue attribute => value default mapping file(s)
     # @option opts [<String>, String] :filters the optional caTissue attribute input value => caTissue value filter file(s)
     # @option opts [<String>, String] :shims the optional shim file(s) to load
@@ -48,30 +45,13 @@ module Jinx
       parse_options(opts)
       build
     end
-    
-    # Imports this migrator's file into the database with the given connect options.
-    # This method creates or updates the domain objects mapped from the import source.
-    # If a block is given to this method, then the block is called on each stored
-    # migration target object.
-    #
-    # If the +:create+ option is set, then an input record for a target object which already
-    # exists in the database is noted in a debug log message and ignored rather than updated.
-    #
-    # @yield (see #migrate)
-    # @yieldparam (see #migrate)
-    # @return (see #migrate)
-    def migrate_to_database(&block)
-      # migrate with save
-      tm = Stopwatch.measure { execute_save(&block) }.elapsed
-      logger.debug { format_migration_time_log_message(tm) }
-    end
 
     # Imports this migrator's CSV file and calls the given block on each migrated target
     # domain object. If no block is given, then this method returns an array of the
     # migrated target objects.
     #
-    # @yield [target, row] operation performed on the migration target
-    # @yieldparam [Jinx::Resource] target the migrated target domain object
+    # @yield [target, row] operates on the migration target
+    # @yieldparam [Resource] target the migrated target domain object
     # @yieldparam [{Symbol => Object}] row the migration source record
     def migrate(&block)
       unless block_given? then
@@ -150,46 +130,10 @@ module Jinx
       end
     end
 
-    # {#migrate} with a {#save} block on the migration target. Each migrated object
-    # is created, if necessary, after the target save.
-    def execute_save
-      if @database.nil? then
-        Jinx.fail(MigrationError, "Migrator cannot save records since the database option was not specified.")
-      end
-      @database.open do |db|
-        migrate do |tgt, rec|
-          save(tgt, db)
-          # Ensure that each migrated object is created if necessary.
-          @migrated.each do |obj|
-            next if obj.identifier
-            logger.debug { "The migrator is saving the migrated #{obj}..." }
-            save(obj, db)
-            logger.debug { "The migrator saved the migrated #{obj}." }
-          end
-          yield(tgt, rec) if block_given?
-          db.clear
-        end
-      end
-    end
-
-    # @return a log message String for the given migration time in seconds
-    def format_migration_time_log_message(time)
-      # the database execution time
-      dt = @database.execution_time
-      if time > 120 then
-        time /= 60
-        dt /= 60
-        unit = "minutes"
-      else
-        unit = "seconds"
-      end
-      "Migration took #{'%.2f' % time} #{unit}, of which #{'%.2f' % dt} were database operations."
-    end
-
     def parse_options(opts)
       @fld_map_files = opts[:mapping]
       if @fld_map_files.nil? then
-        Jinx.fail(MigrationError, "Migrator missing required field mapping file parameter")
+        raise MigrationError.new("Migrator missing required field mapping file parameter")
       end
       @def_files = opts[:defaults]
       @flt_files = opts[:filters]
@@ -200,12 +144,11 @@ module Jinx
       @from = opts[:from] ||= 1
       @input = opts[:input]
       if @input.nil? then
-        Jinx.fail(MigrationError, "Migrator missing required source file parameter")
+        raise MigrationError.new("Migrator missing required source file parameter")
       end
-      @database = opts[:database]
       @target_class = opts[:target]
       if @target_class.nil? then
-        Jinx.fail(MigrationError, "Migrator missing required target class parameter")
+        raise MigrationError.new("Migrator missing required target class parameter")
       end
       @bad_file = opts[:bad]
       @extract = opts[:extract]
@@ -225,7 +168,7 @@ module Jinx
 
     def build
       # the current source class => instance map
-      Jinx.fail(MigrationError, "No file to migrate") if @input.nil?
+      raise MigrationError.new("No file to migrate") if @input.nil?
 
       # If the input is a file name, then make a CSV loader which only converts input fields
       # corresponding to non-String attributes.
@@ -258,7 +201,7 @@ module Jinx
       # An abstract class cannot be instantiated.
       @creatable_classes.each do |klass|
         if klass.abstract? then
-          Jinx.fail(MigrationError, "Migrator cannot create the abstract class #{klass}; specify a subclass instead in the mapping file.")
+          raise MigrationError.new("Migrator cannot create the abstract class #{klass}; specify a subclass instead in the mapping file.")
         end
       end
       
@@ -544,7 +487,7 @@ module Jinx
           @rejects.flush
           logger.debug("Invalid record #{rec_no} was written to the rejects file #{@bad_file}.")
         else
-          Jinx.fail(MigrationError, "Migration not performed on record #{rec_no}")
+          raise MigrationError.new("Migration not performed on record #{rec_no}")
         end
         # Bump the record count.
         @rec_cnt += 1
@@ -593,7 +536,7 @@ module Jinx
       # create an instance for each creatable class
       created = Set.new
       # the migrated objects
-      migrated = @creatable_classes.map { |klass| create(klass, row, created) }
+      migrated = @creatable_classes.map { |klass| create_instance(klass, row, created) }
       # migrate each object from the input row
       migrated.each do |obj|
         # First uniquify the object if necessary.
@@ -691,7 +634,7 @@ module Jinx
     # @param [{Symbol => Object}] row the input row
     # @param [<Resource>] created the migrated instances for this row
     # @return [Resource] the new instance
-    def create(klass, row, created)
+    def create_instance(klass, row, created)
       # the new object
       logger.debug { "The migrator is building #{klass.qp}..." }
       created << obj = klass.new
@@ -758,7 +701,7 @@ module Jinx
     # @return the new object
     def create_reference(obj, property, row, created)
       if property.type.abstract? then
-        Jinx.fail(MigrationError, "Cannot create #{obj.qp} #{property} with abstract type #{property.type}")
+        raise MigrationError.new("Cannot create #{obj.qp} #{property} with abstract type #{property.type}")
       end
       ref = property.type.new
       ref.migrate(row, Array::EMPTY_ARRAY)
@@ -785,8 +728,8 @@ module Jinx
       # set the attribute
       begin
         obj.send(property.writer, value)
-      rescue Exception => e
-        Jinx.fail(MigrationError, "Could not set #{obj.qp} #{property} to #{value.qp}", e)
+      rescue Exception
+        raise MigrationError.new("Could not set #{obj.qp} #{property} to #{value.qp} - " + $!)
       end
       logger.debug { "Migrated #{obj.qp} #{property} to #{value}." }
     end
@@ -810,20 +753,6 @@ module Jinx
       flts = @attr_flt_hash[obj.class] || return
       flts[attribute]
     end
-
-    # @param [Resource] obj the domain object to save in the database
-    # @return [Resource, nil] obj if the save is successful, nil otherwise
-    def save(obj, database)
-      if @create then
-        logger.debug { "Migrator creating #{obj}..." }
-        database.create(obj)
-        logger.debug { "Migrator created #{obj}." }
-      else
-        logger.debug { "Migrator saving #{obj}..." }
-        database.save(obj)
-        logger.debug { "Migrator saved #{obj}." }
-      end
-    end
     
     def current_record
       @rec_cnt + 1
@@ -878,7 +807,7 @@ module Jinx
       begin
         config = YAML.load_file(file)
       rescue
-        Jinx.fail(MigrationError, "Could not read field map file #{file}: " + $!)
+        raise MigrationError.new("Could not read field map file #{file}: " + $!)
       end
       populate_field_map(config, hash)
     end
@@ -892,7 +821,7 @@ module Jinx
         # the header accessor method for the field
         header = @reader.accessor(field)
         if header.nil? then
-          Jinx.fail(MigrationError, "Field defined in migration configuration not found in input file #{@input} headers: #{field}")
+          raise MigrationError.new("Field defined in migration configuration not found in input file #{@input} headers: #{field}")
         end
         # associate each attribute path in the property value with the header
         attr_list.split(/,\s*/).each do |path_s|
@@ -921,7 +850,7 @@ module Jinx
       begin
         config = YAML::load_file(file)
       rescue
-        Jinx.fail(MigrationError, "Could not read defaults file #{file}: " + $!)
+        raise MigrationError.new("Could not read defaults file #{file}: " + $!)
       end
       # collect the class => path => value entries
       config.each do |path_s, value|
@@ -952,13 +881,15 @@ module Jinx
       begin
         config = YAML::load_file(file)
       rescue
-        Jinx.fail(MigrationError, "Could not read filter file #{file}: " + $!)
+        raise MigrationError.new("Could not read filter file #{file}: " + $!)
       end
       config.each do |path_s, flt|
         next if flt.nil_or_empty?
         klass, path = create_attribute_path(path_s)
-        unless path.size == 1 then
-          Jinx.fail(MigrationError, "Migration filter configuration path not supported: #{path_s}")
+        if path.empty? then
+          raise MigrationError.new("Migration filter configuration path does not include a property: #{path_s}")
+        elsif path.size > 1 then
+          raise MigrationError.new("Migration filter configuration path with more than one property is not supported: #{path_s}")
         end
         pa = klass.standard_attribute(path.first.to_sym)
         flt_hash = hash[klass] ||= {}
@@ -973,10 +904,10 @@ module Jinx
       names = path_s.split('.')
       # If the path starts with a capitalized class name, then resolve the class.
       # Otherwise, the target class is the start of the path.
-      klass = names.first =~ /^[A-Z]/ ? context_module.module_for_name(names.shift) : @target_class
+      klass = names.first =~ /^[A-Z]/ ? class_for_name(names.shift) : @target_class
       # There must be at least one attribute.
       if names.empty? then
-        Jinx.fail(MigrationError, "Property entry in migration configuration is not in <class>.<attribute> format: #{path_s}")
+        raise MigrationError.new("Property entry in migration configuration is not in <class>.<attribute> format: #{path_s}")
       end
       
       # Build the attribute path.
@@ -985,11 +916,11 @@ module Jinx
         pa = name.to_sym
         prop = begin
           parent.property(pa)
-        rescue NameError => e
-          Jinx.fail(MigrationError, "Migration field mapping attribute #{parent.qp}.#{pa} not found", e)
+        rescue NameError
+          raise MigrationError.new("Migration field mapping attribute #{parent}.#{pa} not found - " + $!)
         end
         if prop.collection? then
-          Jinx.fail(MigrationError, "Migration field mapping attribute #{parent.qp}.#{prop} is a collection, which is not supported")
+          raise MigrationError.new("Migration field mapping attribute #{parent}.#{prop} is a collection, which is not supported")
         end
         path << prop
         prop.type
@@ -1008,6 +939,13 @@ module Jinx
     def context_module
       @target_class.domain_module
     end
+    
+    # @param [String] the class name to resolve in the context of this migrator
+    # @return [Class] the corresponding class
+    # @raise [NameError] if the name cannot be resolved
+    def class_for_name(name)
+      context_module.module_for_name(name)
+    end
 
     # @return a new class => [paths] hash from the migration fields configuration map
     def create_class_paths_hash(fld_map, def_map)

data/lib/jinx/migration/version.rb

@@ -1,5 +1,5 @@
 module Jinx
   module Migrate
-    VERSION = "2.1.1"
+    VERSION = '2.1.2'
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: jinx-migrate
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors: 
   - OHSU
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-13 00:00:00 -07:00
-default_executable: 
+date: 2012-06-12 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: rack
@@ -81,7 +80,6 @@ files:
   - .rspec
   - .yardopts
   - Gemfile
-  - Gemfile.lock
   - History.md
   - LEGAL
   - LICENSE
@@ -141,7 +139,6 @@ files:
   - test/fixtures/csv/data/empty.csv
   - test/fixtures/csv/data/variety.csv
   - test/lib/csv/csvio_test.rb
-has_rdoc: yard
 homepage: http://github.com/jinx/migrate
 licenses: 
   - MIT
@@ -165,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: jinx
-rubygems_version: 1.5.1
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Jinx JSON plug-in.
@@ -204,3 +201,4 @@ test_files:
   - spec/unique/parents.csv
   - spec/unique/shims.rb
   - spec/unique/unique_spec.rb
+has_rdoc: yard

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jinx-migrate (2.1.1)
-      bundler
-      fastercsv
-      rack
-
-PATH
-  remote: /Users/loneyf/workspace/jinx/core
-  specs:
-    jinx (2.1.1)
-      bundler
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    fastercsv (1.5.4)
-    rack (1.4.1)
-    rake (0.9.2.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-
-PLATFORMS
-  java
-
-DEPENDENCIES
-  jinx!
-  jinx-migrate!
-  rake
-  rspec (>= 2.6)