hoodoo 1.2.2 → 1.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDIzZWU2OWE2MmEyY2RiZjRjMDk1OTlmZGFhM2YyNzA3ZTE0NDQ5MA==
+    MDRkMTlhM2I2NjQyNWE2OTQxZDA3MjdiMjQ2MjgzMzVkYjhkMWEwOQ==
   data.tar.gz: !binary |-
-    MDc4NDgwNjM1MDcwZmE3OWE0NTAzYjExN2Y0MzMxYmJhYzQyZmI0OQ==
+    NjMxZTIwOTI0OGFiMzgxMDEyYjRmY2JjM2MwODI3MDJmOTNjMjgyNQ==
 SHA512:
   metadata.gz: !binary |-
-    M2IyM2U5ZGI3NjBiMzRhYjUyOTBhZDk5ODE4YmY2N2RlOGUyNTA0ODgxODdk
-    N2Y2OGYxNTE0NjYwOWRiMmZkOGJkMTUyMzQ2Yzk1YmE0ZGY0ZTE2ODkyN2Nj
-    MDg3NjQwZjI0NTUxODRhODIzNTFhOTg3Yzg1MzFiYzk0OWYwNTE=
+    YzdiYTY3MTIyY2VkMWZjZjI5N2RmYjBkY2M1NTYyZWVjZjFiOWM0NDU4YjVk
+    MGM4MGI1MWFlYzNhNjg0MzNlYmU0YzYwMzZhMDViNDgwYmVjN2ExZWY3MjJi
+    NGQ0NDRmOThhZjE4MWQwNmEyODk5NmYxNmE0NTkzMmY2YTliMjE=
   data.tar.gz: !binary |-
-    MGU2ZDA2Yzg3NmRmNGE3MTRiMzczOWU0N2JmZDc0ZmFmNmJlNTc5NGE3ZWJl
-    YmY2Mjk1YWZkNzY2NjEwNjIwYTFiYzhkM2Y0MTExZmVjMmRmOWIxNDRkOGY5
-    OWE3MjZkODUwYjEzZjM4MzU3MWQ1MDNjYTk5ZmNiMTA4YjE2MzI=
+    NGM2NmNlMmQ2ZGYwZmVhMmEwZWMyYjU1NjJmZTBhYTU1M2UzNzMyMjRlZjRj
+    ZTAzNzM5MDI0MmRlMmU4OWU4MzBlZWUxNTRiMGU4MzE4YWI4YTE3M2M1MGMy
+    ZjI1MWY1YWM5NmQwNWYyYWZhNTk0MTA1OGU4NWVkN2Y4YTUzNDE=

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

@@ -30,7 +30,7 @@ module Hoodoo
     #
     # ...to create model instances and participate "for free" in whatever
     # plug-in ActiveRecord modules are mixed into the model classes, such as
-    # Hoodoo::ActiveRecord::Dated.
+    # Hoodoo::ActiveRecord::Dated and Hoodoo::ActiveRecord::ManuallyDated.
     #
     # See also:
     #
@@ -117,12 +117,13 @@ module Hoodoo
 
           # TODO: Refactor this to use the scope chain plugin approach in due
           #       course, but for now, pragmatic implementation does the only
-          #       thing we currently need to do - set "created_at".
+          #       things we currently require - set "created_at"/"updated_at".
           #
-          if self.include?( Hoodoo::ActiveRecord::Dated )
-            unless context.request.dated_from.nil?
-              instance.created_at = instance.updated_at = context.request.dated_from
-            end
+          unless context.request.dated_from.nil?
+            instance.created_at = instance.updated_at = context.request.dated_from if (
+              ( self.include?( Hoodoo::ActiveRecord::Dated         ) && self.dating_enabled?()        ) ||
+              ( self.include?( Hoodoo::ActiveRecord::ManuallyDated ) && self.manual_dating_enabled?() )
+            )
           end
 
           return instance

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

@@ -97,14 +97,14 @@ module Hoodoo
     #
     # == Model instance creation
     #
-    # It is _VERY_ _IMPORTANT_ that you use
-    # Hoodoo::ActiveRecord::Creator::ClassMethods::new_in to create new
-    # resource instances when using Dating. You _could_ just manually read the
+    # It is _VERY_ _IMPORTANT_ that you use method
+    # Hoodoo::ActiveRecord::Creator::ClassMethods.new_in to create new
+    # resource instances when using dating. You _could_ just manually read the
     # `context.request.dated_from` value to ensure that an appropriate creation
     # time is set; presently, `created_at` and `updated_at` are set from the
     # `dated_from` value. However, using `new_in` for this isolates your code
     # from any possible under-the-hood implementation changes therein and
-    # future-proof your code.
+    # future-proofs your code.
     #
     module Dated
 
@@ -183,7 +183,7 @@ module Hoodoo
         # returns +true+, else +false+.
         #
         def dating_enabled?
-          return self.dated_with() != nil?
+          return self.dated_with().present?
         end
 
         # Return an ActiveRecord::Relation containing the model instances which

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

@@ -109,6 +109,8 @@ module Hoodoo
     # you *MUST* include the ActiveRecord::Relation instances (scopes) inside
     # any query chain used to read or write data.
     #
+    # === Show and List
+    #
     # You might use Hoodoo::ActiveRecord::Finder#list_in or
     # Hoodoo::ActiveRecord::Finder#acquire_in for +list+ or +show+ actions;
     # such code changes from e.g.:
@@ -119,7 +121,20 @@ module Hoodoo
     #
     #     SomeModel.manually_dated( context ).list_in( context )
     #
-    # You MUST NOT update or delete records using conventional ActiveRecord
+    # === Create
+    #
+    # As with automatic dating - see Hoodoo::ActiveRecord::Dated - you should
+    # use method Hoodoo::ActiveRecord::Creator::ClassMethods.new_in to create
+    # new resource instances, to help ensure correct initial date setup and to
+    # help isolate your code from future functionality extensions/changes. An
+    # ActiveRecord +before_create+ filter deals with some of the "behind the
+    # scenes" maintenance but the initial acquisition of dating information
+    # from the prevailing request context only happens for you if you use
+    # Hoodoo::ActiveRecord::Creator::ClassMethods::new_in.
+    #
+    # === Update and Delete
+    #
+    # You *MUST* *NOT* update or delete records using conventional ActiveRecord
     # methods if you want to use manual dating to record state changes.
     # Instead, use
     # Hoodoo::ActiveRecord::ManuallyDated::ClassMethods#manually_dated_update_in
@@ -143,6 +158,8 @@ module Hoodoo
     # information on overriding the identifier used to find the target record
     # and the attribute data used for updates.
     #
+    # == Rendering
+    #
     # When rendering, you *MUST* remember to set the resource's +id+ field
     # from the model's +uuid+ field:
     #
@@ -155,8 +172,20 @@ module Hoodoo
     #       }
     #     )
     #
-    # Likewise, remember to set foreign keys for any relational declarations
-    # via the +uuid+ column - e.g. go from this:
+    # == Associations
+    #
+    # Generally, use of ActiveRecord associations is minimal in most services
+    # because there is an implied database-level coupling of resources and a
+    # temptation to use cross-table ActiveRecord mechanisms for things like
+    # relational UUID integrity checks, rather than inter-resource calls.
+    # Doing so couples resources together at the database rather than keeping
+    # them isolated purely by API, which is often a really bad idea. It is,
+    # however, sometimes necessary for best possible performance, or sometimes
+    # one complex resource may be represented by several models with
+    # relationships between them.
+    #
+    # In such cases, remember to set foreign keys for relational declarations
+    # to a manually dated table via the +uuid+ column - e.g. go from this:
     #
     #     member.account_id = account.id
     #
@@ -408,10 +437,6 @@ module Hoodoo
         def manual_dating_enabled
           self.nz_co_loyalty_hoodoo_manually_dated = true
 
-          rounder = Proc.new do | timelike |
-            timelike.to_time.round( SECONDS_DECIMAL_PLACES )
-          end
-
           # This is the 'tightest'/innermost callback available for creation.
           # Intentionally have nothing for updates/deletes as the high level
           # API here must be used; we don't want to introduce any more magic.

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.2.2'
+  VERSION = '1.2.3'
 
 end

data/spec/active/active_record/creator_spec.rb

@@ -15,6 +15,7 @@ describe Hoodoo::ActiveRecord::Creator do
     class RSpecModelCreatorTest < ActiveRecord::Base
       include Hoodoo::ActiveRecord::Creator
       include Hoodoo::ActiveRecord::Dated
+      include Hoodoo::ActiveRecord::ManuallyDated
     end
   end
 
@@ -45,14 +46,57 @@ describe Hoodoo::ActiveRecord::Creator do
       expect( instance.updated_at ).to be_nil
     end
 
-    it 'creates with specified dated-from value' do
-      time = Time.now.iso8601
-      @context.request.dated_from = time
+    context 'with "dated_from" given' do
+      before :each do
+        @time                       = Time.now
+        @context.request.dated_from = @time
+      end
 
-      instance = RSpecModelCreatorTest.new_in( @context )
+      shared_examples 'a dated model' do
+        it 'using the specified dated-from value' do
+          instance = RSpecModelCreatorTest.new_in( @context )
+
+          expect( instance.created_at ).to eq( @time )
+          expect( instance.updated_at ).to eq( @time )
+        end
+      end
+
+      shared_examples 'a normal model' do
+        it 'creating with no default timestamps' do
+          instance = RSpecModelCreatorTest.new_in( @context )
+
+          expect( instance.created_at ).to eq( nil )
+          expect( instance.updated_at ).to eq( nil )
+        end
+      end
 
-      expect( instance.created_at.iso8601 ).to eq( time )
-      expect( instance.updated_at.iso8601 ).to eq( time )
+      context 'automatic dating present' do
+        context 'and enabled it' do
+          before :each do
+            expect( RSpecModelCreatorTest ).to receive( :dating_enabled? ).once.and_return( true )
+          end
+
+          it_behaves_like 'a dated model'
+        end
+
+        context 'and not enabled it' do
+          it_behaves_like 'a normal model'
+        end
+      end
+
+      context 'manual dating present' do
+        context 'and enabled it' do
+          before :each do
+            expect( RSpecModelCreatorTest ).to receive( :manual_dating_enabled? ).once.and_return( true )
+          end
+
+          it_behaves_like 'a dated model'
+        end
+
+        context 'and not enabled it' do
+          it_behaves_like 'a normal model'
+        end
+      end
     end
 
     it 'creates with provided attributes' do

data/spec/active/active_record/dated_spec.rb

@@ -124,9 +124,15 @@ describe Hoodoo::ActiveRecord::Dated do
     end
 
     context '#dating_enabled?' do
+      class RSpecNotDated < Hoodoo::ActiveRecord::Base; end
+
       it 'says it is automatically dated' do
         expect( model_klass.dating_enabled? ).to eq( true )
       end
+
+      it 'knows when something is not automatically dated' do
+        expect( RSpecNotDated.dating_enabled? ).to eq( false )
+      end
     end
 
     context '#dated_at' do

data/spec/active/active_record/manually_dated_spec.rb

@@ -139,9 +139,15 @@ describe Hoodoo::ActiveRecord::ManuallyDated do
     end
 
     context '#manual_dating_enabled?' do
+      class RSpecNotManuallyDated < Hoodoo::ActiveRecord::Base; end
+
       it 'says it is manually dated' do
         expect( RSpecModelManualDateTest.manual_dating_enabled? ).to eq( true )
       end
+
+      it 'knows when something is not automatically dated' do
+        expect( RSpecNotManuallyDated.manual_dating_enabled? ).to eq( false )
+      end
     end
 
     context '#manually_dated_at' do

metadata

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