hoodoo 1.3.1 → 1.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmVkNzQ3ZmU3YWQ3ZjY5YzFhOTQzOWQ3ODgwYWYwNGI5NDRhOGM2YQ==
+    OGQ2ZGRmYWM3NTIwOWEwOGIyNjFiOTkyN2I4ZDdhNzY1YWUzZWIyNw==
   data.tar.gz: !binary |-
-    ZTM4ZDc5NWM5OTVjZjI4ZWQ3M2E5M2Y5YzVmNGYyMzcwYmVhMjczNg==
+    OWUxNzBkMjc2NzM5N2ViZDM5ZWY2ZjNjMDFhZjJiNDVmNzA5NDYxMA==
 SHA512:
   metadata.gz: !binary |-
-    ODEwNjVhMDM1ODM0ZGUyMWVmMjUxMDQzZWU2NDY1YTFlNzg4YjI2MDYxNWFk
-    NmI1YzU4ZmVjYzFkODNmMjhjNjYxNTRhNzc4ZDAwZDNhMmUzYzAyOTE4Yjlm
-    MDNkYjI3MzJjMWUzYzU5MDQ5NzhiYWVkZDJkN2I2YTExOWVmNDA=
+    MjE2MTQ5YTU0OWFkZWEyN2Y0YTU5ZDJhOWU5MjkwODI3MmViYWFmODg4ZDll
+    MWI5MjUyNjIzNGFjMWZiYmViYzhhYTcyZGQyZmRhMjk5M2ZjMjQzOWJiNWFl
+    Mzg4NWZlMDFhZjQ3MjA4ZmQxZWM1YzM5YTY4YTJiNTE4MjFjOGQ=
   data.tar.gz: !binary |-
-    NjNhNmY1YTk4MjYxNTk2MTUxNDFiMjIyMTEyODM0MzEzMDU4ZDBkMGU3ODFj
-    ZWU0NzYwOTUyNDVmNDZlNjAyZjc4N2IwMDk4ZmE5ZWU2NjBmY2RhNWY4YjI2
-    MGQ1OWExN2Q1OWRkYTY5ZDQxYzY4ODIxNjJkMzM2ZDQzNjA1NzQ=
+    NWFlNzg2Y2E4ODg4ODY3MjYwMTRmMzQzZmYzMWQ0OGJkYzljZDdhZjY0ZmYw
+    YjUwNjljZjkwMWM5Y2ZjOTgwNmJiNTZkNzg4MGE3OTk4M2ZlOWQxZDEzMWQy
+    ZDJiYzBjNTAzMDkwOGIzYzI3MjU1OGQxMjk0MDg2OTcwMTdjMWY=

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

@@ -88,6 +88,27 @@ module Hoodoo
       #
       module ClassMethods
 
+        # Returns an ActiveRecord::Relation instance representing a primitive
+        # base scope that includes various context-related aspects according
+        # to the prevailing mixins included by "this" class, if any - e.g.
+        # security, dating and/or translation.
+        #
+        # See Hoodoo::ActiveRecord::Support#full_scope_for to see the list
+        # of things that get included. If there are no "interesting" mixins,
+        # the returned scope will just return the same thing that the +all+
+        # method in ActiveRecord would have returned. Consequently, a default
+        # scope _will_ be honoured if one has been declared, though default
+        # scopes are generally considered an anti-pattern to be avoided.
+        #
+        # +context+:: Hoodoo::Services::Context instance describing a call
+        #             context. This is typically a value passed to one of
+        #             the Hoodoo::Services::Implementation instance methods
+        #             that a resource subclass implements.
+        #
+        def scoped_in( context )
+          Hoodoo::ActiveRecord::Support.full_scope_for( self, context )
+        end
+
         # "Polymorphic" find - support for finding a model by fields other
         # than just +:id+, based on a single unique identifier. Use #acquire
         # just like you'd use +find_by_id+ and only bother with it if you
@@ -159,10 +180,11 @@ module Hoodoo
         end
 
         # Implicily secure, translated, dated etc. etc. version of #acquire,
-        # according to which modules are mixed into your model class. See
-        # Hoodoo::ActiveRecord::Support#full_scope_for to see the list of
-        # things that get included in the scope according to the mixins
-        # that are in use.
+        # according to which modules are mixed into your model class. Uses
+        # #scoped_in to obtain a base scope in which to operate, so it is
+        # "mixin aware" and incorporates other Hoodoo extensions within the
+        # wider scope chain. See that method's documentation for more
+        # information.
         #
         # For example, if you are using or at some point intend to mix in and
         # use the mechanism described by the likes of
@@ -213,8 +235,7 @@ module Hoodoo
         #     SomeModel.acquire_in( context )
         #
         # The same applies to forgetting dated scopes, translated scopes, or
-        # anything else that Hoodoo::ActiveRecord::Support#full_scope_for
-        # might include for you.
+        # anything else that #scoped_in might include for you.
         #
         # Parameters:
         #
@@ -226,8 +247,7 @@ module Hoodoo
         # Returns a found model instance or +nil+ for no match.
         #
         def acquire_in( context )
-          scope = Hoodoo::ActiveRecord::Support.full_scope_for( self, context )
-          return scope.acquire( context.request.ident )
+          return scoped_in( context ).acquire( context.request.ident )
         end
 
         # Describe the list of model fields _in_ _addition_ _to_ +id+ which
@@ -294,11 +314,13 @@ module Hoodoo
         #
         # Normally such a scope could only ever return a single record based
         # on an assuption of uniqueness constraints around columns which one
-        # might use in an equivalent of a +find+ call. In some instances
-        # however - e.g. a table that contains historic representations of a
-        # model as well as its 'current' representation - there may be more
-        # than one result and the returned value from this method may need to
-        # be chained in with other scopes to form a useful query.
+        # might use in an equivalent of a +find+ call. This scope is often
+        # chained on top of a wider listing scope provided by #scoped_in to
+        # create a fully context-aware, secure, dated, translated etc. query.
+        # It is possible however that the chosen +ident+ value might not
+        # resolve to a single unique record depending on how your data works
+        # and you may need to manually apply additional constraints to the
+        # returned ActiveRecord::Relation instance.
         #
         def acquisition_scope( ident )
           extra_fields = self.acquired_with()
@@ -432,9 +454,8 @@ module Hoodoo
 
         # Implicily secure, translated, dated etc. etc. version of #list,
         # according to which modules are mixed into your model class. See
-        # Hoodoo::ActiveRecord::Support#full_scope_for to see the list of
-        # things that get included in the scope according to the mixins
-        # that are in use.
+        # #scoped_in to see the list of things that get included in the
+        # scope according to the mixins that are in use.
         #
         # For example, if you have included Hoodoo::ActiveRecord::Secure,
         # this method provides you with an implicitly secure query. Read the
@@ -450,8 +471,7 @@ module Hoodoo
         #     SomeModel.list_in( context )
         #
         # The same applies to forgetting dated scopes, translated scopes, or
-        # anything else that Hoodoo::ActiveRecord::Support#full_scope_for
-        # might include for you.
+        # anything else that #scoped_in might include for you.
         #
         # +context+:: Hoodoo::Services::Context instance describing a call
         #             context. This is typically a value passed to one of
@@ -462,8 +482,7 @@ module Hoodoo
         # query methods like +where+ or fetching from the database with +all+.
         #
         def list_in( context )
-          scope = Hoodoo::ActiveRecord::Support.full_scope_for( self, context )
-          return scope.list( context.request.list )
+          return scoped_in( context ).list( context.request.list )
         end
 
         # Given some scope - typically that obtained from a prior call to

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.3.1'
+  VERSION = '1.4.0'
 
 end

data/spec/active/active_record/finder_spec.rb

@@ -129,7 +129,90 @@ describe Hoodoo::ActiveRecord::Finder do
 
   # ==========================================================================
 
-  context 'acquire' do
+  context '#scoped_in' do
+    before :each do
+
+      # Get a good-enough-for-test interaction which has a context
+      # that contains a Session we can modify.
+
+      @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
+      @session = @interaction.context.session
+    end
+
+    # If security scoping works _and_ we know that it called #full_scope_for
+    # in the "internal"-ish support API, then we consider that good enough
+    # to prove that it's calling the scope engine and that engine has its
+    # own comprehensive test coverage in suport_spec.rb.
+    #
+    it 'generates appropriate scope' do
+      @session.scoping = { :authorised_uuids => [ 'uuid 1', 'uuid 2' ], :authorised_code => 'code 1' }
+
+      expect( Hoodoo::ActiveRecord::Support ).to(
+        receive( :full_scope_for ).once().with(
+          RSpecModelFinderTest, @context
+        ).and_call_original()
+      )
+
+      sql = RSpecModelFinderTest.scoped_in( @context ).to_sql
+
+      expect( sql ).to eq( "SELECT \"r_spec_model_finder_tests\".* "<<
+                           "FROM \"r_spec_model_finder_tests\" " <<
+                           "WHERE " <<
+                             "\"r_spec_model_finder_tests\".\"uuid\" IN ('uuid 1', 'uuid 2') AND " <<
+                             "\"r_spec_model_finder_tests\".\"code\" = 'code 1'" )
+    end
+  end
+
+  # ==========================================================================
+
+  context 'acquisition scope and overrides' do
+    def expect_sql( sql, id_attr_name )
+      expect( sql ).to eq( "SELECT \"r_spec_model_finder_tests\".* "<<
+                           "FROM \"r_spec_model_finder_tests\" " <<
+                           "WHERE (" <<
+                             "(" <<
+                               "\"r_spec_model_finder_tests\".\"#{ id_attr_name }\" = '#{ @id }' OR " <<
+                               "\"r_spec_model_finder_tests\".\"uuid\" = '#{ @id }'" <<
+                             ") OR " <<
+                             "\"r_spec_model_finder_tests\".\"code\" = '#{ @id }'" <<
+                           ")" )
+    end
+
+    context '#acquisition_scope' do
+      it 'SQL generation is as expected' do
+        sql = RSpecModelFinderTest.acquisition_scope( @id ).to_sql()
+        expect_sql( sql, 'id' )
+      end
+    end
+
+    context '#acquire_with_id_substitute' do
+      before :each do
+        @alt_attr_name = 'foo'
+        RSpecModelFinderTest.acquire_with_id_substitute( @alt_attr_name )
+      end
+
+      after :each do
+        RSpecModelFinderTest.acquire_with_id_substitute( 'id' )
+      end
+
+      it 'SQL generation is as expected' do
+        sql = RSpecModelFinderTest.acquisition_scope( @id ).to_sql()
+        expect_sql( sql, @alt_attr_name )
+      end
+    end
+  end
+
+  # ==========================================================================
+
+  context '#acquire' do
     it 'finds from the class' do
       found = RSpecModelFinderTest.acquire( @id )
       expect( found ).to eq(@a)
@@ -203,7 +286,7 @@ describe Hoodoo::ActiveRecord::Finder do
 
   # ==========================================================================
 
-  context 'acquire_in' do
+  context '#acquire_in' do
     before :each do
       @scoped_1 = RSpecModelFinderTest.new
       @scoped_1.id        = 'id 1'
@@ -350,46 +433,7 @@ describe Hoodoo::ActiveRecord::Finder do
 
   # ==========================================================================
 
-  context 'acquisition scope and overrides' do
-    def expect_sql( sql, id_attr_name )
-      expect( sql ).to eq( "SELECT \"r_spec_model_finder_tests\".* "<<
-                           "FROM \"r_spec_model_finder_tests\" " <<
-                           "WHERE (" <<
-                             "(" <<
-                               "\"r_spec_model_finder_tests\".\"#{ id_attr_name }\" = '#{ @id }' OR " <<
-                               "\"r_spec_model_finder_tests\".\"uuid\" = '#{ @id }'" <<
-                             ") OR " <<
-                             "\"r_spec_model_finder_tests\".\"code\" = '#{ @id }'" <<
-                           ")" )
-    end
-
-    context 'acquisition_scope' do
-      it 'SQL generation is as expected' do
-        sql = RSpecModelFinderTest.acquisition_scope( @id ).to_sql()
-        expect_sql( sql, 'id' )
-      end
-    end
-
-    context 'acquire_with_id_substitute' do
-      before :each do
-        @alt_attr_name = 'foo'
-        RSpecModelFinderTest.acquire_with_id_substitute( @alt_attr_name )
-      end
-
-      after :each do
-        RSpecModelFinderTest.acquire_with_id_substitute( 'id' )
-      end
-
-      it 'SQL generation is as expected' do
-        sql = RSpecModelFinderTest.acquisition_scope( @id ).to_sql()
-        expect_sql( sql, @alt_attr_name )
-      end
-    end
-  end
-
-  # ==========================================================================
-
-  context 'lists' do
+  context '#list' do
     it 'lists with pages, offsets and counts' do
       @list_params.offset = 1 # 0 is first record
       @list_params.limit  = 1
@@ -695,7 +739,7 @@ describe Hoodoo::ActiveRecord::Finder do
 
   # ==========================================================================
 
-  context 'list_in' do
+  context '#list_in' do
     before :each do
       @scoped_1 = RSpecModelFinderTest.new
       @scoped_1.id   = 'id 1'

data/spec/active/active_record/support_spec.rb

@@ -74,6 +74,14 @@ describe Hoodoo::ActiveRecord::Support do
           t.string :bar
           t.timestamps :null => true
         end
+
+        ActiveRecord::Migration.create_table( :r_spec_full_scope_for_manually_dateds ) do | t |
+          t.string :baz
+          t.string :uuid, :length => 32
+          t.datetime :effective_start
+          t.datetime :effective_end
+          t.timestamps :null => true
+        end
       end
 
       # Note inheritance from plain ActiveRecord::Base, important for
@@ -107,6 +115,16 @@ describe Hoodoo::ActiveRecord::Support do
       class RSpecFullScopeForTestBaseSubclassWithoutOverrides < RSpecFullScopeForTestBaseWithDirectives
         # No overrides at all
       end
+
+      # Manual and automatic effective dating can live in the same mixin
+      # collection but can't both be enabled at the same time, so do this
+      # in a special test class with a database table that meets the
+      # related requirements.
+      #
+      class RSpecFullScopeForManuallyDated < Hoodoo::ActiveRecord::Base
+        secure_with( :baz => :baz )
+        manual_dating_enabled()
+      end
     end
 
     before :each do
@@ -221,5 +239,37 @@ describe Hoodoo::ActiveRecord::Support do
         expect( auto_scope ).to eq( manual_scope )
       end
     end
+
+    context '(with manual dating enabled)' do
+      before :each do
+        @session.scoping.baz = [ @test_scoping_value ]
+      end
+
+      context 'gets customised scope:' do
+        it 'manually dated' do
+          manual_scope = RSpecFullScopeForManuallyDated.manually_dated( @context ).to_sql()
+
+          expect( manual_scope ).to include( 'FROM "r_spec_full_scope_for_manually_dateds"' )
+          expect( manual_scope ).to include( "\"effective_end\" > #{ RSpecFullScopeForTestSubclass.sanitize( @test_time_value.to_time.round( Hoodoo::ActiveRecord::ManuallyDated::SECONDS_DECIMAL_PLACES ) ) }" )
+        end
+
+        it 'secure' do
+          manual_scope = RSpecFullScopeForManuallyDated.secure( @context ).to_sql()
+
+          expect( manual_scope ).to include( "\"r_spec_full_scope_for_manually_dateds\".\"baz\" = '#{ @test_scoping_value }'" )
+        end
+
+        pending 'translated' do
+          raise "Scope verification for '\#translated'"
+        end
+
+        it 'everything' do
+          auto_scope   = described_class.full_scope_for( RSpecFullScopeForManuallyDated, @context ).to_sql()
+          manual_scope = RSpecFullScopeForManuallyDated.manually_dated( @context ).secure( @context ).translated( @context ).to_sql()
+
+          expect( auto_scope ).to eq( manual_scope )
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio