ncs_mdes_warehouse 0.8.0 → 0.9.0

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 NCS Navigator MDES Warehouse History
 ====================================
 
+0.9.0
+-----
+
+- Support symbolic references to models in `produce_one_for_one` in the database
+  transformer DSL. This results in a minor *BREAKING CHANGE*:
+  `Database::DSL::OneToOneProducer#model` has been renamed `model_or_name` and
+  may give you either the model or a symbolic reference to it. There is a new
+  method `#model(configuration)` which takes a configuration instance and always
+  gives you a model. Similarly, `Database::DSL::OneToOneProducer#column_map` now
+  requires a configuration instance as a second parameter. (#2552)
+
+- Fix probably-never-functional `Configuration#mdes_version` reader. (#2553)
+
 0.8.0
 -----
 

data/lib/ncs_navigator/warehouse/configuration.rb

@@ -157,9 +157,24 @@ module NcsNavigator::Warehouse
 
       @models_module = NcsNavigator::Warehouse::Models.const_get module_name
     end
-    attr_reader :mdes_version
 
     ##
+    # Returns the configured MDES version string.
+    #
+    # N.b.: this method triggers loading the default MDES module and
+    # specification if {#mdes_version=} has not been called yet.
+    #
+    # @return [String] the configured MDES version.
+    def mdes_version
+      mdes.version
+    end
+
+    ##
+    # Returns the specification for the active MDES version.
+    #
+    # N.b.: this method triggers loading the default MDES module and
+    # specification if {#mdes_version=} has not been called yet.
+    #
     # @return [NcsNavigator::Mdes::Specification] the specification
     #   (provided by `ncs_mdes`) for the active MDES version.
     def mdes
@@ -169,6 +184,11 @@ module NcsNavigator::Warehouse
     attr_writer :mdes
 
     ##
+    # Returns the module namespacing the models for the active MDES version.
+    #
+    # N.b.: this method triggers loading the default MDES module and
+    # specification if {#mdes_version=} has not been called yet.
+    #
     # @return [Module] the module namespacing the models for the
     #   active MDES version.
     def models_module

data/lib/ncs_navigator/warehouse/transformers/database.rb

@@ -274,8 +274,10 @@ module NcsNavigator::Warehouse::Transformers
       # @param [Symbol] name the name of this producer; if you don't
       #   specify a `:query`, the default is to return every row from
       #   the application table with this name.
-      # @param [Class] model the warehouse model to which results of
-      #   the query will be mapped.
+      # @param [Class,Symbol] model_or_reference the warehouse model to which
+      #   the results of the query will be mapped. It can be expressed either
+      #   as the model class itself or the unqualified name of the model. (See
+      #   {Configuration#model}.)
       # @param [Hash] options
       # @option options :query [String] the query to execute for this
       #   producer. If not specified, the query is `"SELECT * FROM #{name}"`.
@@ -292,13 +294,13 @@ module NcsNavigator::Warehouse::Transformers
       #   column map don't match them to anything.
       #
       # @return [void]
-      def produce_one_for_one(name, model, options={})
+      def produce_one_for_one(name, model_or_reference, options={})
         options[:column_map] =
           (options[:column_map] || {}).inject({}) { |h, (k, v)| h[k.to_s] = v.to_s; h }
         options[:ignored_columns] = (options[:ignored_columns] || []).collect(&:to_s)
 
         record_producers <<
-          OneForOneProducer.new(name, options.delete(:query), model, self, options)
+          OneForOneProducer.new(name, options.delete(:query), model_or_reference, self, options)
       end
     end
 
@@ -313,11 +315,11 @@ module NcsNavigator::Warehouse::Transformers
     ##
     # The class encapsulating one call to {DSL#produce_one_for_one}
     class OneForOneProducer < RecordProducer
-      attr_reader :model, :options, :dsl_host
+      attr_reader :model_or_reference, :options, :dsl_host
 
-      def initialize(name, query, model, dsl_host, options)
+      def initialize(name, query, model_or_reference, dsl_host, options)
         super(name, query, self)
-        @model = model
+        @model_or_reference = model_or_reference
         @dsl_host = dsl_host
         @options = options
       end
@@ -325,14 +327,14 @@ module NcsNavigator::Warehouse::Transformers
       ##
       # Produces a single instance of {#model} using the values in the
       # row as mapped by {#column_map}.
-      def convert_row(row)
-        col_map = column_map(row.members)
+      def convert_row(row, meta)
+        col_map = column_map(row.members, meta[:configuration])
         unused = row.members.collect(&:to_s) - col_map.keys - ignored_columns
 
         if on_unused == :fail && !unused.empty?
           raise UnusedColumnsForModelError.new(unused)
         end
-        model.new(
+        model(meta[:configuration]).new(
           col_map.inject({}) { |pv, (col_name, var_name)|
             pv[var_name] = clean_value(row[col_name]);
             pv
@@ -343,7 +345,23 @@ module NcsNavigator::Warehouse::Transformers
 
       ##
       # Implemented so that this class behaves like a lambda.
-      def arity; 1; end
+      def arity; 2; end
+
+      ##
+      # @param configuration [Configuration]
+      #
+      # @return [Class] the model for this producer. If {#model_or_reference}
+      #   is a symbolic reference, this method resolves it using the given
+      #   configuration.
+      def model(configuration)
+        case model_or_reference
+        when Class
+          model_or_reference
+        else
+          configuration.model(model_or_reference) or
+            fail("There is no table or model named #{model_or_reference.inspect} in MDES #{configuration.mdes_version}.")
+        end
+      end
 
       def clean_value(v)
         if v.respond_to?(:strip)
@@ -356,12 +374,15 @@ module NcsNavigator::Warehouse::Transformers
 
       ##
       # @param [Array<String>] column_names
+      # @param [Configuration] configuration the configuration to use to resolve
+      #   model references, if necessary.
+      #
       # @return [Hash<String, String>] a mapping from the given
       #   column names to MDES variable names for the configured
       #   model. This mapping reflects both the configured explicit
       #   mapping and the heuristic.
-      def column_map(column_names)
-        available_props = model.properties.collect { |p| p.name.to_s }
+      def column_map(column_names, configuration)
+        available_props = model(configuration).properties.collect { |p| p.name.to_s }
         available_props -= options[:column_map].values
 
         column_names.inject(options[:column_map].dup) do |map, column|

data/lib/ncs_navigator/warehouse/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   module Warehouse
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/spec/ncs_navigator/warehouse/configuration_spec.rb

@@ -124,6 +124,12 @@ module NcsNavigator::Warehouse
       end
     end
 
+    describe '#mdes_version', :slow, :use_mdes, :modifies_warehouse_state do
+      it 'is a shortcut for extracting the version from #mdes' do
+        spec_config.mdes_version.should == spec_mdes_version
+      end
+    end
+
     describe '#mdes', :slow, :modifies_warehouse_state do
       it 'Uses the default MDES version if called before mdes_version=' do
         config.mdes.version.should == NcsNavigator::Warehouse::DEFAULT_MDES_VERSION

data/spec/ncs_navigator/warehouse/transformers/database_spec.rb

@@ -273,6 +273,7 @@ module NcsNavigator::Warehouse::Transformers
         let(:options) { {} }
         let(:cls) { sample_class }
         let(:producer) { cls.record_producers.first }
+        let(:row_meta) { {} }
 
         def make_row(contents)
           Struct.new(*contents.keys).new.tap do |r|
@@ -284,7 +285,7 @@ module NcsNavigator::Warehouse::Transformers
 
         def model_row(row)
           cls.produce_one_for_one(:addresses, address_model, options)
-          producer.row_processor.call(make_row(row))
+          producer.row_processor.call(make_row(row), row_meta)
         end
 
         it 'maps a column to the property with the same name' do
@@ -314,6 +315,36 @@ module NcsNavigator::Warehouse::Transformers
           # expect no errors
         end
 
+        describe 'and a symbolic model' do
+          let(:address_model) { :Address }
+          let(:mock_config) { mock('Configuration') }
+
+          before do
+            row_meta[:configuration] = mock_config
+            mock_config.stub!(:model).and_return(Database::DSL::TestModels::Address)
+          end
+
+          it 'resolves the model using the configuration' do
+            mock_config.should_receive(:model).with(address_model).and_return(Database::DSL::TestModels::Address)
+
+            model_row(:street => '42 Foo').street.should == '42 Foo'
+          end
+
+          it 'throws an exception if the model does not exist' do
+            mock_config.should_receive(:model).with(address_model).and_return(nil)
+            mock_config.stub!(:mdes_version).and_return('3.4')
+
+            expect { model_row(:street => '42 Baz') }.
+              to raise_error('There is no table or model named :Address in MDES 3.4.')
+          end
+
+          it 'can retrieve the column map' do
+            options[:column_map] = { :street_loc => :street }
+            cls.produce_one_for_one(:addresses, address_model, options)
+            producer.column_map(%w(street street_loc), mock_config).keys.should == %w(street_loc)
+          end
+        end
+
         describe 'and unused columns' do
           it 'fails with unused columns if requested' do
             options[:on_unused] = :fail
@@ -349,7 +380,7 @@ module NcsNavigator::Warehouse::Transformers
 
             it 'fails appropriately' do
               begin
-                producer.call(make_row :address_type => '-5', :address_length => '6')
+                producer.call(make_row(:address_type => '-5', :address_length => '6'), row_meta)
                 fail "Exception not thrown"
               rescue Database::UnusedColumnsForModelError => e
                 e.unused.should == %w(address_length)
@@ -358,13 +389,13 @@ module NcsNavigator::Warehouse::Transformers
 
             it 'does not fail if the global setting is overridden' do
               options[:on_unused] = :ignore
-              lambda { producer.call(make_row :address_type => '-5', :address_length => '6') }.
+              lambda { producer.call(make_row(:address_type => '-5', :address_length => '6'), row_meta) }.
                 should_not raise_error
             end
 
             it 'can be ignored by modifying the global setting' do
               cls.on_unused_columns :ignore
-              lambda { producer.call(make_row :address_type => '-5', :address_length => '6') }.
+              lambda { producer.call(make_row(:address_type => '-5', :address_length => '6'), row_meta) }.
                 should_not raise_error
             end
           end
@@ -405,19 +436,19 @@ module NcsNavigator::Warehouse::Transformers
 
           it 'does not include the default mapping in the total map' do
             cls.produce_one_for_one(:addresses, address_model, options)
-            producer.column_map(%w(street street_loc)).keys.should == %w(street_loc)
+            producer.column_map(%w(street street_loc), configuration).keys.should == %w(street_loc)
           end
 
           it 'always includes explicit mapping values in the total map' do
             cls.produce_one_for_one(:addresses, address_model, options)
-            producer.column_map(%w(street)).keys.should == %w(street_loc)
+            producer.column_map(%w(street), configuration).keys.should == %w(street_loc)
           end
         end
 
         describe 'the processor' do
           it 'responds to :arity' do
             cls.produce_one_for_one(:addresses, address_model, options)
-            producer.row_processor.arity.should == 1
+            producer.row_processor.arity.should == 2
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncs_mdes_warehouse
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncs_mdes
@@ -2379,12 +2379,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1614550889051803335
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1614550889051803335
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24