hoodoo 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTFiNjAzNDk4MDdmOTFmNWRkZTg1MmY3ODExMmY3ZGU4MTU3YjkzNg==
+    MDliMjQ5YTcwM2ExNTU4YzgxY2U4NTNmZTM1ODFkMTI0NzY0MmMzZQ==
   data.tar.gz: !binary |-
-    MjMwNDRjODEzZDU5YmRmM2E0YmRlNTlmYTVkYzA3NmIxMDA3ZjE1Yg==
+    ZWY4NTg4ODEzOTliMGQyMTBjMmFkZGNmMmYzZmFjZjc0NDlmMWJlZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZjEzZDYxZDJjZGI3MWU0NDFmYTYwNzQ2ZmYwZGY4MmQ2Zjc0NWJhZmRiMjli
-    ZjQ0MTA1MzkzYTFkN2RhZTA1YWFkNjc1MDI4MDgwNzYyZDk5YmFhZTdmZDE1
-    ZTJlYjRjZDc5N2IzYmNiNTc0M2Q0NzMzNDhlODk3OTEzZjc0YTU=
+    NjlkZTI4NjZhNDczZTdmZTM5ODlmNjVhNTY0MjQ1MGI3MDg4YmMxNDE3MDQw
+    NjMzOWY1MTE0MmM0N2E1MGYwNTEwODlmMzQ0M2I5YjEwZGY0ZWY4MTA5MGYw
+    NmRlZWViMWJiOGVlNDdkMTFmNjYzYjYxZTFhM2M4MzgyY2ZkYTE=
   data.tar.gz: !binary |-
-    MzMwNGY1MGZlOTFiZjE3YmI0MDgxYjcwYTUxYTliNTQxNDFjODMwNThkMGUx
-    ZDk5NzE0ZDcwMWY1YzZhMTIxMzgyY2ZiMWJiMTFiZjk4ZmNlMTE0N2JmZThj
-    ZDIxZWM4MzQ0ODc0ODdmNWU5OWEzYmU3ODlkMTE4OTI1ZTNiYWM=
+    MzUzNmJlYTM4ZTc3ZDgyZTExMzU5ZjhhNzE2OTQxMWY1OWFlMWQwY2Q2NTgy
+    N2FiNmU3YmJkYjJhZDBlMjQ5NzNkZmJmYmIxY2JmMTZjYmQ0MDgzNmNmMGRj
+    YmRmNjJiMTY3NGU2OTRkNTc1ZGNkZDNkZjZmNjY5NTM1YmNiODI=

data/lib/hoodoo/active/active_record/dated.rb

@@ -144,13 +144,25 @@ module Hoodoo
         model.extend( ClassMethods )
       end
 
-      # Forms a String containing the specified +model_klass+'s attribute names
-      # escaped and joined with commas.
+      # Returns a String containing the specified +model_klass+'s attribute
+      # names considered as column names, escaped by the in-use database
+      # adaptor and joined into with commas.
       #
-      # +model_klass+ Class which responds to .attribute_names
+      # +model_klass+:: Class which responds to <tt>#attribute_names</tt>.
       #
       def self.sanitised_column_string( model_klass )
-        model_klass.attribute_names.map{ | c | ActiveRecord::Base.connection.quote_column_name( c ) }.join( ',' )
+        self.sanitised_column_string_for( model_klass.attribute_names )
+      end
+
+      # As ::sanitised_column_string but takes the array of attribute or
+      # column names directly.
+      #
+      # +attribute_array+:: Array of column names, as Strings or Symbols.
+      #
+      def self.sanitised_column_string_for( attribute_array )
+        attribute_array.map do | c |
+          ActiveRecord::Base.connection.quote_column_name( c )
+        end.join( ',' )
       end
 
       # Collection of class methods that get defined on an including class via
@@ -200,9 +212,20 @@ module Hoodoo
         #             the Hoodoo::Services::Implementation instance methods
         #             that a resource subclass implements.
         #
-        def dated( context )
+        # Additional _named_ parameters are:
+        #
+        # +unquoted_column_names+:: (Optional) An Array of Strings giving one
+        #                           or more column names to use for the query.
+        #                           If omitted, all model attribtues are used
+        #                           as columns. If the "id" column is not
+        #                           included in the Array, it will be added
+        #                           anyway as this column is mandatory. The
+        #                           effect is equivalent to an Array given in
+        #                           the ActiveRecord +select+ method.
+        #
+        def dated( context, unquoted_column_names: nil )
           date_time = context.request.dated_at || Time.now
-          return self.dated_at( date_time )
+          return self.dated_at( date_time, unquoted_column_names: unquoted_column_names )
         end
 
         # Return an ActiveRecord::Relation scoping a query to include only model
@@ -215,39 +238,52 @@ module Hoodoo
         #               can be converted to a DateTime instance, for which the
         #               "effective dated" scope is to be constructed.
         #
-        def dated_at( date_time = Time.now )
+        # Additional _named_ parameters are:
+        #
+        # +unquoted_column_names+:: (Optional) An Array of Strings giving one
+        #                           or more column names to use for the query.
+        #                           If omitted, all model attribtues are used
+        #                           as columns. If the "id" column is not
+        #                           included in the Array, it will be added
+        #                           anyway as this column is mandatory. The
+        #                           effect is equivalent to an Array given in
+        #                           the ActiveRecord +select+ method.
+        #
+        def dated_at( date_time = Time.now, unquoted_column_names: nil )
 
           dating_table_name = dated_with_table_name()
           return all() if dating_table_name.nil? # "Model.all" -> returns anonymous scope
 
           # Rationalise and convert the date time to UTC.
 
-          date_time = Hoodoo::Utilities.rationalise_datetime( date_time ).utc
-
-          # Create a string that specifies this model's attributes escaped and
-          # joined by commas for use in a SQL query.
+          date_time      = Hoodoo::Utilities.rationalise_datetime( date_time ).utc
+          safe_date_time = self.sanitize( date_time ) # ActiveRecord provides #sanitize
 
-          formatted_model_attributes = Hoodoo::ActiveRecord::Dated.sanitised_column_string( self )
+          # Create strings that specify the required attributes escaped and
+          # joined by commas for use in a SQL query, for both main and history
+          # tables.
 
-          # Convert date_time to a String suitable for an SQL query.
+          safe_name_string = self.quoted_column_name_string(
+            unquoted_column_names: unquoted_column_names
+          )
 
-          string_date_time = sanitize( date_time )
+          safe_history_name_string = self.quoted_column_name_string_for_history(
+            unquoted_column_names: unquoted_column_names
+          )
 
           # A query that combines historical and current records which are
           # effective at the specified date time.
 
           nested_query = %{
             (
-              SELECT #{ formatted_model_attributes } FROM (
-                SELECT #{ formatted_model_attributes }, updated_at as effective_start, null AS effective_end
+              SELECT #{ safe_name_string } FROM (
+                SELECT #{ safe_name_string },"updated_at" AS "effective_start",NULL AS "effective_end"
                 FROM #{ self.table_name }
-
                 UNION ALL
-
-                SELECT #{ self.dated_with_history_column_mapping }, effective_start, effective_end
+                SELECT #{ safe_history_name_string },"effective_start","effective_end"
                 FROM #{ dating_table_name }
               ) AS u
-              WHERE effective_start <= #{ string_date_time } AND (effective_end > #{ string_date_time } OR effective_end IS NULL)
+              WHERE "effective_start" <= #{ safe_date_time } AND ("effective_end" > #{ safe_date_time } OR "effective_end" IS NULL)
             ) AS #{ self.table_name }
           }
 
@@ -263,26 +299,42 @@ module Hoodoo
         # If historic dating hasn't been enabled via a call to #dating_enabled,
         # then the default 'all' scope is returned instead.
         #
-        def dated_historical_and_current
+        # _Named_ parameters are:
+        #
+        # +unquoted_column_names+:: (Optional) An Array of Strings giving one
+        #                           or more column names to use for the query.
+        #                           If omitted, all model attribtues are used
+        #                           as columns. If the "id" column is not
+        #                           included in the Array, it will be added
+        #                           anyway as this column is mandatory. The
+        #                           effect is equivalent to an Array given in
+        #                           the ActiveRecord +select+ method.
+        #
+        def dated_historical_and_current( unquoted_column_names: nil )
 
           dating_table_name = dated_with_table_name()
           return all() if dating_table_name.nil? # "Model.all" -> returns anonymous scope
 
-          # Create a string that specifies this model's attributes escaped and
-          # joined by commas for use in a SQL query.
+          # Create strings that specify the required attributes escaped and
+          # joined by commas for use in a SQL query, for both main and history
+          # tables.
+
+          safe_name_string = self.quoted_column_name_string(
+            unquoted_column_names: unquoted_column_names
+          )
 
-          formatted_model_attributes = Hoodoo::ActiveRecord::Dated.sanitised_column_string( self )
+          safe_history_name_string = self.quoted_column_name_string_for_history(
+            unquoted_column_names: unquoted_column_names
+          )
 
           # A query that combines historical and current records.
 
           nested_query = %{
             (
-              SELECT #{ formatted_model_attributes }
+              SELECT #{ safe_name_string }
               FROM #{ self.table_name }
-
               UNION ALL
-
-              SELECT #{ self.dated_with_history_column_mapping }
+              SELECT #{ safe_history_name_string }
               FROM #{ dating_table_name }
             ) AS #{ self.table_name }
           }
@@ -314,27 +366,64 @@ module Hoodoo
           instance.nil? ? nil : instance.table_name
         end
 
-        protected
+      protected
 
-        # Forms and returns string which maps history table column names to the
-        # primary table column names for use in SQL queries.
+        # Takes an Array of unquoted column names and returns a new Array of
+        # names quoted by the current database adapter.
         #
-        def dated_with_history_column_mapping
-          desired_attributes = self.attribute_names.dup
+        # +unquoted_column_names+:: Optional Array of unquoted column names
+        #                           to use. Must contain only Strings.
+        #
+        def quoted_column_names( unquoted_column_names )
+          return unquoted_column_names.map do | c |
+            ActiveRecord::Base.connection.quote_column_name( c )
+          end
+        end
 
-          # Locate the primary key field, which must be called "id".
+        # Returns a String of comma-separated sanitised (quoted) column names
+        # based on this model's attribute names, or the given array of unquoted
+        # column names.
+        #
+        # _Named_ parameters are:
+        #
+        # +unquoted_column_names+:: Optional Array of unquoted column names
+        #                           to use. Must contain only Strings. If column
+        #                           "id" is missing, it will be added for you.
+        #
+        def quoted_column_name_string( unquoted_column_names: nil )
+          unquoted_column_names ||= self.attribute_names()
+          unquoted_column_names << 'id' unless unquoted_column_names.include?( 'id' )
 
-          primary_key_index = desired_attributes.index( 'id' )
+          return self.quoted_column_names( unquoted_column_names ).join( ',' )
+        end
 
-          # Sanitise the attribute names.
+        # As ::quoted_column_name_string, but returns a String appropriate for
+        # the history table. Notably, this requires a source column of "uuid" to
+        # be mapped in as column name "id" and works on the assumption that the
+        # primary key is "id".
+        #
+        # _Named_ parameters are:
+        #
+        # +unquoted_column_names+:: Optional Array of unquoted column names
+        #                           to use. Must contain only Strings. If column
+        #                           "id" is missing, it will be added for you.
+        #
+        def quoted_column_name_string_for_history( unquoted_column_names: nil )
+          unquoted_column_names ||= self.attribute_names
+          primary_key_index       = unquoted_column_names.index( 'id' )
 
-          desired_attributes.map!{ | c | ActiveRecord::Base.connection.quote_column_name( c ) }
+          if primary_key_index.nil?
+            unquoted_column_names << 'id'
+            primary_key_index = unquoted_column_names.count - 1
+          end
 
-          # Map the primary key.
+          quoted_column_names     = self.quoted_column_names( unquoted_column_names )
+          quoted_primary_key_name = quoted_column_names[ primary_key_index ]
+          history_primary_key     = '"uuid" AS ' << quoted_primary_key_name
 
-          desired_attributes[ primary_key_index ] = 'uuid as ' << desired_attributes[ primary_key_index ]
+          quoted_column_names[ primary_key_index ] = history_primary_key
 
-          return desired_attributes.join( ',' )
+          return quoted_column_names.join( ',' )
         end
 
       end

data/lib/hoodoo/services/middleware/endpoints/inter_resource_remote.rb

@@ -148,7 +148,7 @@ module Hoodoo
               # around somewhere.
 
               @wrapping_session = session
-              @wrapped_endpoint.session_id = session.session_id
+              @wrapped_endpoint.session_id = session.session_id unless session.nil?
               return nil
             end
           end

data/lib/hoodoo/version.rb

@@ -12,6 +12,6 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, ensure that the date in
   # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
   #
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
 end

data/spec/active/active_record/dated_spec.rb

@@ -77,7 +77,7 @@ describe Hoodoo::ActiveRecord::Dated do
       @uuid_a = Hoodoo::UUID.generate
       @uuid_b = Hoodoo::UUID.generate
 
-      @now  = Time.now.utc
+      @now = Time.now.utc
 
       # uuid, data, created_at, effective_end, effective_start
       [
@@ -208,7 +208,6 @@ describe Hoodoo::ActiveRecord::Dated do
     end
 
     context '.dated_historical_and_current' do
-
       it 'returns counts correctly' do
         expect( model_klass.dated_historical_and_current.count ).to be 6
       end
@@ -217,14 +216,41 @@ describe Hoodoo::ActiveRecord::Dated do
         expect( model_klass.dated_historical_and_current.pluck( :data ) ).to match_array( [ 'one', 'two', 'three', 'four', 'five', 'six' ] )
       end
 
+      context 'SQL' do
+        it 'has expected default columns' do
+          sql = model_klass.dated_historical_and_current.to_sql.downcase
+
+          expect( sql ).to include( 'select "id","data","created_at","updated_at"' )
+          expect( sql ).to include( 'select "uuid" as "id","data","created_at","updated_at"' )
+        end
+
+        it 'handles custom column selections' do
+          sql = model_klass.dated_historical_and_current(
+            unquoted_column_names: [ 'id', 'created_at' ]
+          ).to_sql.downcase
+
+          expect( sql ).to include( 'select "id","created_at"' )
+          expect( sql ).to include( 'select "uuid" as "id","created_at"' )
+        end
+
+        it 'handles custom column selections that omit "id"' do
+          sql = model_klass.dated_historical_and_current(
+            unquoted_column_names: [ 'created_at' ]
+          ).to_sql.downcase
+
+          expect( sql ).to include( 'select "created_at","id"' )
+          expect( sql ).to include( 'select "created_at","uuid" as "id"' )
+        end
+      end
     end
 
   end
 
   context "using default effective dating config" do
 
-    # Must be defined as a method rather than using a let statement as let
-    # statement values cannot be used in before blocks.
+    # Must be defined as a method rather than using a 'let' statement as
+    # 'let' statement values cannot be used in 'before' blocks.
+    #
     def model_klass
       RSpecModelEffectiveDateTest
     end
@@ -235,8 +261,9 @@ describe Hoodoo::ActiveRecord::Dated do
 
   context "overriding history table name" do
 
-    # Must be defined as a method rather than using a let statement as let
-    # statement values cannot be used in before blocks.
+    # Must be defined as a method rather than using a 'let' statement as
+    # 'let' statement values cannot be used in 'before' blocks.
+    #
     def model_klass
       RSpecModelEffectiveDateTestOverride
     end
@@ -245,4 +272,74 @@ describe Hoodoo::ActiveRecord::Dated do
 
   end
 
+  context "SQL and column selections" do
+    before :each do
+      @now      = Time.now.utc
+      @safe_now = RSpecModelEffectiveDateTestOverride.sanitize( @now )
+
+      request   = Hoodoo::Services::Request.new
+      @context  = Hoodoo::Services::Context.new( nil, request, nil, nil )
+
+      @context.request.dated_at = @now
+    end
+
+    def run_other_expectations( sql )
+      expect( sql ).to include( "from r_spec_model_effective_date_history_entries" )
+      expect( sql ).to include( "\"effective_start\" <= #{ @safe_now }" )
+      expect( sql ).to include( "\"effective_end\" > #{ @safe_now }" )
+      expect( sql ).to include( "\"effective_end\" is null" )
+    end
+
+    it 'generates expected basic SQL' do
+      sql = RSpecModelEffectiveDateTestOverride.dated( @context ).to_sql.downcase
+
+      expect( sql ).to include( 'select "id","data","created_at","updated_at"' )
+      expect( sql ).to include( 'select "uuid" as "id","data","created_at","updated_at"' )
+      run_other_expectations( sql )
+    end
+
+    it 'generates expected column-selected SQL via #dated' do
+      sql = RSpecModelEffectiveDateTestOverride.dated(
+        @context,
+        unquoted_column_names: [ 'id', 'created_at' ]
+      ).to_sql.downcase
+
+      expect( sql ).to include( 'select "id","created_at"' )
+      expect( sql ).to include( 'select "uuid" as "id","created_at"' )
+      run_other_expectations( sql )
+    end
+
+    it 'includes "id" if omitted, via #dated' do
+      sql = RSpecModelEffectiveDateTestOverride.dated(
+        @context,
+        unquoted_column_names: [ 'created_at' ]
+      ).to_sql.downcase
+
+      expect( sql ).to include( 'select "created_at","id"' )
+      expect( sql ).to include( 'select "created_at","uuid" as "id"' )
+      run_other_expectations( sql )
+    end
+
+    it 'generates expected column-selected SQL via #dated_at' do
+      sql = RSpecModelEffectiveDateTestOverride.dated_at(
+        @now,
+        unquoted_column_names: [ 'id', 'created_at' ]
+      ).to_sql.downcase
+
+      expect( sql ).to include( 'select "id","created_at"' )
+      expect( sql ).to include( 'select "uuid" as "id","created_at"' )
+      run_other_expectations( sql )
+    end
+
+    it 'includes "id" if omitted, via #dated_at' do
+      sql = RSpecModelEffectiveDateTestOverride.dated_at(
+        @now,
+        unquoted_column_names: [ 'created_at' ]
+      ).to_sql.downcase
+
+      expect( sql ).to include( 'select "created_at","id"' )
+      expect( sql ).to include( 'select "created_at","uuid" as "id"' )
+      run_other_expectations( sql )
+    end
+  end
 end

data/spec/active/active_record/support_spec.rb

@@ -163,7 +163,7 @@ describe Hoodoo::ActiveRecord::Support do
           manual_scope = RSpecFullScopeForTestSubclass.dated( @context ).to_sql()
 
           expect( manual_scope ).to include( "FROM #{ @thtname1 }" )
-          expect( manual_scope ).to include( "effective_end > #{ RSpecFullScopeForTestSubclass.sanitize( @test_time_value ) }" )
+          expect( manual_scope ).to include( "\"effective_end\" > #{ RSpecFullScopeForTestSubclass.sanitize( @test_time_value ) }" )
         end
 
         it 'secure' do
@@ -201,7 +201,7 @@ describe Hoodoo::ActiveRecord::Support do
         manual_scope = RSpecFullScopeForTestBaseSubclassWithoutOverrides.dated( @context ).to_sql()
 
         expect( manual_scope ).to include( "FROM #{ @thtname2 }" )
-        expect( manual_scope ).to include( "effective_end > #{ RSpecFullScopeForTestBaseSubclassWithoutOverrides.sanitize( @test_time_value ) }" )
+        expect( manual_scope ).to include( "\"effective_end\" > #{ RSpecFullScopeForTestBaseSubclassWithoutOverrides.sanitize( @test_time_value ) }" )
       end
 
       it 'secure' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools