hoodoo 2.0.0 → 2.1.1

data/spec/active/active_record/finder_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 require 'active_record'
 
+# Automatic and manual dating tests have their own test files and Finder
+# module features specific to dating are covered there, to keep things more
+# simple here.
+#
 # The "counting" tests must run first and in-order internally, else e.g. an
 # ANALYZE might happen before the pre-ANALYZE test, breaking the results.
 # Other tests that create objects in the table can cause the estimated count
@@ -11,8 +15,7 @@ require 'active_record'
 describe Hoodoo::ActiveRecord::Finder, :order => :defined do
   before :all do
     spec_helper_silence_stdout() do
-      ActiveRecord::Migration.create_table( :r_spec_model_finder_tests, :id => false ) do | t |
-        t.text :id
+      ActiveRecord::Migration.create_table( :r_spec_model_finder_tests, :id => :string ) do | t |
         t.text :uuid
         t.text :code
         t.text :field_one
@@ -22,6 +25,8 @@ describe Hoodoo::ActiveRecord::Finder, :order => :defined do
         t.timestamps :null => true
         t.text :created_by
       end
+
+      ActiveRecord::Migration.change_column( :r_spec_model_finder_tests, :id, :string, :limit => 32 )
     end
 
     class RSpecModelFinderTest < ActiveRecord::Base
@@ -65,14 +70,6 @@ describe Hoodoo::ActiveRecord::Finder, :order => :defined do
       )
     end
 
-    class RSpecModelFinderTestWithDating < ActiveRecord::Base
-      self.primary_key = :id
-      self.table_name = :r_spec_model_finder_tests
-
-      include Hoodoo::ActiveRecord::Finder
-      include Hoodoo::ActiveRecord::Dated
-    end
-
     class RSpecModelFinderTestWithHelpers < ActiveRecord::Base
       include Hoodoo::ActiveRecord::Finder
 
@@ -284,9 +281,9 @@ describe Hoodoo::ActiveRecord::Finder, :order => :defined do
             # The outer 'before' code ensures an accurate initial count of 3,
             # but we're going add in a few more unestimated items.
             #
-            @uncounted1 = RSpecModelFinderTest.new.save!
-            @uncounted2 = RSpecModelFinderTest.new.save!
-            @uncounted3 = RSpecModelFinderTest.new.save!
+            @uncounted1 = RSpecModelFinderTest.new( :id => 'unc_id1' ).save!
+            @uncounted2 = RSpecModelFinderTest.new( :id => 'unc_id2' ).save!
+            @uncounted3 = RSpecModelFinderTest.new( :id => 'unc_id3' ).save!
 
             @subsequent_accurate_count = RSpecModelFinderTest.count
           end
@@ -624,6 +621,42 @@ describe Hoodoo::ActiveRecord::Finder, :order => :defined do
         found = RSpecModelFinderTest.where( :field_one => @scoped_3.field_one + '!' ).acquire_in( @context )
         expect( found ).to be_nil
       end
+
+      context 'enhanced by #acquire_in!' do
+        before :each do
+          @session.scoping = { :authorised_uuids => [ 'uuid 1' ], :authorised_code => 'code 1' }
+        end
+
+        # This test proves that the higher level interface uses the lower
+        # level interface and, as such, we judge that only the extra added
+        # features need test coverage, rather than repeating all of the
+        # coverage already done for #acquire_in.
+        #
+        it 'acquires via #acquire_in' do
+          expect( RSpecModelFinderTest ).to receive( :acquire_in ).with( @context ).and_call_original()
+
+          @context.request.uri_path_components = [ @scoped_1.id ]
+          found = RSpecModelFinderTest.acquire_in!( @context )
+
+          expect( found ).to eq( @scoped_1 )
+        end
+
+        it 'does not add errors when an instance is found' do
+          @context.request.uri_path_components = [ @scoped_1.id ]
+          RSpecModelFinderTest.acquire_in!( @context )
+
+          expect( @context.response.halt_processing? ).to eq( false )
+        end
+
+        it 'adds "not_found" if an instance is absent' do
+          @context.request.uri_path_components = [ Hoodoo::UUID.generate() ]
+          RSpecModelFinderTest.acquire_in!( @context )
+
+          expect( @context.response.halt_processing? ).to eq( true )
+          expect( @context.response.errors.errors.count ).to eq( 1 )
+          expect( @context.response.errors.errors[ 0 ][ 'code' ] ).to eq( 'generic.not_found' )
+        end
+      end
     end
 
     # ========================================================================

data/spec/active/active_record/manually_dated_spec.rb

@@ -11,9 +11,8 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
 
   before :all do
     spec_helper_silence_stdout() do
-      ActiveRecord::Migration.create_table( :r_spec_model_manual_date_tests, :id => false ) do | t |
+      ActiveRecord::Migration.create_table( :r_spec_model_manual_date_tests, :id => :string ) do | t |
         t.string :uuid, :null => false, :length => 32
-        t.string :id,   :null => false, :length => 32
 
         t.text :data
         t.text :unique
@@ -23,6 +22,8 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
         t.datetime :effective_end,   :null => false
       end
 
+      ActiveRecord::Migration.change_column( :r_spec_model_manual_date_tests, :id, :string, :limit => 32 )
+
       # Documentation recommends these constraints in migrations, so ensure
       # everything works when they're present.
 
@@ -49,6 +50,7 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
 
     class RSpecModelManualDateTest < ActiveRecord::Base
       include Hoodoo::ActiveRecord::ManuallyDated
+
       manual_dating_enabled()
 
       validates_each :data do | record, attribute, value |
@@ -57,6 +59,13 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
         end
       end
     end
+
+    class RSpecModelManualDateTestOverride < ActiveRecord::Base
+      include Hoodoo::ActiveRecord::ManuallyDated
+
+      self.table_name = :r_spec_model_manual_date_tests
+      manual_dating_enabled()
+    end
   end
 
   # Create some example data for finding. The data has two different UUIDs
@@ -279,6 +288,158 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
     end
   end
 
+  # ==========================================================================
+  # Hoodoo::ActiveRecord::Finder interaction
+  # ==========================================================================
+
+  context 'with Hoodoo::ActiveRecord::Finder support' do
+    before :each do
+      interaction = Hoodoo::Services::Middleware::Interaction.new( {}, nil )
+      interaction.context = Hoodoo::Services::Context.new(
+        Hoodoo::Services::Session.new,
+        interaction.context.request,
+        interaction.context.response,
+        interaction
+      )
+
+      @context = interaction.context
+    end
+
+    context '#scoped_in' do
+      it 'generates appropriate scope' do
+        expect( Hoodoo::ActiveRecord::Support ).to(
+          receive( :full_scope_for ).once().with(
+            RSpecModelManualDateTestOverride, @context
+          ).and_call_original()
+        )
+
+        sql = RSpecModelManualDateTestOverride.scoped_in( @context ).to_sql
+
+        expect( sql ).to_not include( "UNION ALL" ) # This is only present in auto-dating, not manual dating
+        expect( sql ).to     include( " AND \"r_spec_model_manual_date_tests\".\"effective_end\" > '" )
+      end
+
+      it 'generates appropriate undated scope' do
+        expect( Hoodoo::ActiveRecord::Support ).to(
+          receive( :add_undated_scope_to ).once().with(
+            kind_of( ActiveRecord::Relation ), RSpecModelManualDateTestOverride, @context
+          ).and_call_original()
+        )
+
+        sql = RSpecModelManualDateTestOverride.scoped_undated_in( @context ).to_sql
+
+        expect( sql ).to eq( "SELECT \"r_spec_model_manual_date_tests\".* FROM \"r_spec_model_manual_date_tests\"" )
+      end
+    end
+
+    context '#acquire_in' do
+      context 'with contemporary' do
+        it 'finds the contemporary record' do
+          @context.request.dated_at            = nil
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTestOverride.acquire_in!( @context )
+
+          expect( @context.response.halt_processing? ).to eq( false )
+          expect( result.data                        ).to eq( 'six' )
+        end
+
+        it 'finds a historic record' do
+          @context.request.dated_at            = @now - 4.hours
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTestOverride.acquire_in!( @context )
+
+          expect( @context.response.halt_processing? ).to eq( false )
+          expect( result.data                        ).to eq( 'one' )
+        end
+
+        it 'indicates correctly that a contemporary exists during a far-backdated lookup' do
+          @context.request.dated_at            = @now - 1.year
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTestOverride.acquire_in!( @context )
+
+          expect( @context.response.halt_processing?    ).to eq( true )
+          expect( @context.response.errors.errors.count ).to eq( 2    )
+
+          expect( @context.response.errors.errors[ 0 ][ 'code'      ] ).to eq( 'generic.not_found' )
+          expect( @context.response.errors.errors[ 1 ][ 'code'      ] ).to eq( 'generic.contemporary_exists' )
+          expect( @context.response.errors.errors[ 0 ][ 'reference' ] ).to eq( @uuid_a )
+          expect( @context.response.errors.errors[ 1 ][ 'reference' ] ).to eq( @uuid_a )
+        end
+      end
+
+      context 'with a UUID that matches no existing record' do
+        it 'indicates correctly that no record exists and does not say a contemporary is present' do
+          alt_uuid                             = Hoodoo::UUID.generate
+          @context.request.dated_at            = @now - 5.seconds
+          @context.request.uri_path_components = [ alt_uuid ]
+
+          result = RSpecModelManualDateTestOverride.acquire_in!( @context )
+
+          expect( @context.response.halt_processing?    ).to eq( true )
+          expect( @context.response.errors.errors.count ).to eq( 1    )
+
+          expect( @context.response.errors.errors[ 0 ][ 'code'      ] ).to eq( 'generic.not_found' )
+          expect( @context.response.errors.errors[ 0 ][ 'reference' ] ).to eq( alt_uuid )
+        end
+      end
+
+      context 'without contemporary' do
+        before( :each ) do
+          @context.request.dated_at = nil
+
+          RSpecModelManualDateTest.manually_dated_destruction_in(
+            @context,
+            ident: @uuid_a
+          )
+
+          sleep( ( 0.1 ** Hoodoo::ActiveRecord::ManuallyDated::SECONDS_DECIMAL_PLACES ) * 2 )
+        end
+
+        it 'finds no contemporary record' do
+          @context.request.dated_at            = nil
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTest.acquire_in!( @context )
+          expect( result ).to be_nil
+
+          expect( @context.response.halt_processing?    ).to eq( true )
+          expect( @context.response.errors.errors.count ).to eq( 1    )
+
+          expect( @context.response.errors.errors[ 0 ][ 'code'      ] ).to eq( 'generic.not_found' )
+          expect( @context.response.errors.errors[ 0 ][ 'reference' ] ).to eq( @uuid_a )
+        end
+
+        it 'finds a historic record' do
+          @context.request.dated_at            = @now - 4.hours
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTest.acquire_in!( @context )
+          expect( result ).to_not be_nil
+
+          expect( @context.response.halt_processing? ).to eq( false )
+          expect( result.data                        ).to eq( 'one' )
+        end
+
+        it 'indicates correctly that no contemporary exists during a far-backdated lookup' do
+          @context.request.dated_at            = @now - 1.year
+          @context.request.uri_path_components = [ @uuid_a ]
+
+          result = RSpecModelManualDateTest.acquire_in!( @context )
+          expect( result ).to be_nil
+
+          expect( @context.response.halt_processing?    ).to eq( true )
+          expect( @context.response.errors.errors.count ).to eq( 1    )
+
+          expect( @context.response.errors.errors[ 0 ][ 'code'      ] ).to eq( 'generic.not_found' )
+          expect( @context.response.errors.errors[ 0 ][ 'reference' ] ).to eq( @uuid_a )
+        end
+      end
+    end
+  end
+
   # ==========================================================================
   # Writing tests
   # ==========================================================================

data/spec/active/active_record/support_spec.rb

@@ -59,7 +59,7 @@ describe Hoodoo::ActiveRecord::Support do
     end
   end
 
-  context '#full_scope_for' do
+  context '#full_scope_for and #add_undated_scope_to' do
 
     # Here we not only test the full scope generator with all mixins included,
     # and test them all in a *deactivated* state, we also check that inheritance
@@ -214,9 +214,9 @@ describe Hoodoo::ActiveRecord::Support do
 
         pending 'translated' # Scope verification for '#translated'
 
-        # In this last one, we actually check full_scope_for; activations are in
-        # the subclass so we drive the non-context versions directly to verify
-        # that the context chain worked.
+        # Finally, we actually check full_scope_for / add_undated_scope_to;
+        # activations are in the subclass so we drive the non-context versions
+        # directly to verify that the context chain worked.
 
         it 'everything' do
           auto_scope   = described_class.full_scope_for( RSpecFullScopeForTestSubclass, @context ).to_sql()
@@ -224,6 +224,18 @@ describe Hoodoo::ActiveRecord::Support do
 
           expect( auto_scope ).to eq( manual_scope )
         end
+
+        it 'undated' do
+          auto_scope = described_class.add_undated_scope_to(
+            RSpecFullScopeForTestSubclass.all(),
+            RSpecFullScopeForTestSubclass,
+            @context
+          ).to_sql()
+
+          manual_scope = RSpecFullScopeForTestSubclass.secure( @context ).translated( @context ).to_sql()
+
+          expect( auto_scope ).to eq( manual_scope )
+        end
       end
     end
 
@@ -285,6 +297,18 @@ describe Hoodoo::ActiveRecord::Support do
 
           expect( auto_scope ).to eq( manual_scope )
         end
+
+        it 'undated' do
+          auto_scope = described_class.add_undated_scope_to(
+            RSpecFullScopeForManuallyDated.all(),
+            RSpecFullScopeForManuallyDated,
+            @context
+          ).to_sql()
+
+          manual_scope = RSpecFullScopeForManuallyDated.secure( @context ).translated( @context ).to_sql()
+
+          expect( auto_scope ).to eq( manual_scope )
+        end
       end
     end
   end

data/spec/active/active_record/uuid_spec.rb

@@ -6,11 +6,10 @@ describe Hoodoo::ActiveRecord::UUID do
     spec_helper_silence_stdout() do
       tblname = :r_spec_model_uuid_tests
 
-      ActiveRecord::Migration.create_table( tblname, :id => false ) do | t |
-        t.string( :id, :limit => 32, :null => false )
+      ActiveRecord::Migration.create_table( tblname, :id => :string ) do | t |
       end
 
-      ActiveRecord::Migration.add_index( tblname, :id, :unique => true )
+      ActiveRecord::Migration.change_column( tblname, :id, :string, :limit => 32 )
 
       class RSpecModelUUIDTest < ActiveRecord::Base
         include Hoodoo::ActiveRecord::UUID

data/spec/active/active_record/writer_spec.rb

@@ -29,8 +29,7 @@ describe Hoodoo::ActiveRecord::Writer do
 
     before( :all ) do
       spec_helper_silence_stdout() do
-        ActiveRecord::Migration.create_table(:r_spec_model_writer_tests, :id => false) do | t |
-          t.text :id
+        ActiveRecord::Migration.create_table(:r_spec_model_writer_tests, :id => :string) do | t |
           t.text :uuid
           t.text :code
           t.text :random_field
@@ -38,6 +37,7 @@ describe Hoodoo::ActiveRecord::Writer do
           t.timestamps :null => false
         end
 
+        ActiveRecord::Migration.change_column( :r_spec_model_writer_tests, :id, :string, :limit => 32 )
         ActiveRecord::Migration.add_index(:r_spec_model_writer_tests, :code, unique: true)
       end
     end

data/spec/services/services/response_spec.rb

@@ -274,14 +274,30 @@ describe Hoodoo::Services::Response do
   end
 
   context '#not_found' do
-
     let(:ident) { 'an_ident' }
     before { @r.not_found(ident) }
 
     it 'sets the generic.not_found code' do
+      expect(@r.errors.errors.count).to eq(1)
       expect(@r.errors.errors.first['code']).to eq('generic.not_found')
     end
-    it 'sets the the reference to be the ident passed in' do
+    it 'sets the reference to be the ident passed in' do
+      expect(@r.errors.errors.first['reference']).to eq(ident)
+    end
+    it 'sets halt processing to true' do
+      expect(@r.halt_processing?).to eq(true)
+    end
+  end
+
+  context '#contemporary_exists' do
+    let(:ident) { 'an_ident' }
+    before { @r.contemporary_exists(ident) }
+
+    it 'sets the generic.contemporary_exists code' do
+      expect(@r.errors.errors.count).to eq(1)
+      expect(@r.errors.errors.first['code']).to eq('generic.contemporary_exists')
+    end
+    it 'sets the reference to be the ident passed in' do
       expect(@r.errors.errors.first['reference']).to eq(ident)
     end
     it 'sets halt processing to true' do

data/spec/spec_helper.rb

@@ -167,7 +167,10 @@ end
 [ Hoodoo::Monkey::Patch, Hoodoo::Monkey::Chaos ].each do | monkey |
   monkey.constants.each do | extension_module_name |
     extension_module = monkey.const_get( extension_module_name )
-    Hoodoo::Monkey.disable( extension_module: extension_module )
+
+     # Ignore "not registered" exceptions for not-yet-registered patches.
+     #
+    Hoodoo::Monkey.disable( extension_module: extension_module ) rescue nil
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,8 @@ files:
 - lib/hoodoo/middleware.rb
 - lib/hoodoo/monkey.rb
 - lib/hoodoo/monkey/monkey.rb
+- lib/hoodoo/monkey/patch/active_record_dated_finder_additions.rb
+- lib/hoodoo/monkey/patch/active_record_manually_dated_finder_additions.rb
 - lib/hoodoo/monkey/patch/datadog_traced_amqp.rb
 - lib/hoodoo/monkey/patch/newrelic_middleware_analytics.rb
 - lib/hoodoo/monkey/patch/newrelic_traced_amqp.rb
@@ -524,7 +526,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.0
 signing_key: 
 specification_version: 4
 summary: Opinionated APIs