shiftable 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bad3e2f27677202648655a227fa9f251a595910db9146c9fdb72952657053d3
-  data.tar.gz: 481fede6aa751831cec5c19fe8849b61b081f51cfd4e5aa0a7522ecbb31b38bf
+  metadata.gz: 03d919c64ab0be03ba40c5474cfa7971dda6158ab01df20940bb644c32482b19
+  data.tar.gz: 3246e28e7578ea7b56ae905c23c675e121a8c71556d127b8ee4a0fbeedcce15b
 SHA512:
-  metadata.gz: 050f4afb2b1ad1e81cd9209dfee0a0f1270745a02bfea84dcaff3914794349c4e6b53b01fb21873731ad05693ae0d02639ee3ade2a0f0d1b5b103fc30952e362
-  data.tar.gz: 5bfc201b247b3082a0a1836c164133f73f59f317de9664934f08bc28a6b3d00140e2c2a3fe0ed7da2a0450fcabb67c66eb28e28c3787403517eadd28fb8d8114
+  metadata.gz: b3721c0d437b1ab45deb99f71f7a199fe4c37aae31f86f8443eb2effd1bd07c9d930aa64c4a4b824c7371863c9cb219251e59dc673d9ef40a73551e75c7efc67
+  data.tar.gz: c0d40a890f89fda5137575d9052131605f33e6a861e6b9e55b6681d89cfeba4f9ac5547cb09c4ab68cb69bafa50a9c6ebc75412152cf8c3bf9e76f90ce80f823

data/CHANGELOG.md

@@ -12,6 +12,11 @@
 ### Removed
 
 
+## [0.6.0] - 2021-11-12
+### Added
+
+- Support for wrappers/hooks around each record shift, and around the entire set (see examples in specs or README)
+
 ## [0.5.1] - 2021-11-12
 ### Fixed
 

data/README.md

@@ -80,7 +80,7 @@ But how can you accomplish this? If you used the `shiftable` gem, won't take but
 class Spaceship < ActiveRecord::Base
   belongs_to :captain
   extend Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, precheck: true,
-                               before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
+                               before_shift: ->(shifting_rel) { shifting_rel.result.ownership_changes += 1 }
 end
 ```
 
@@ -111,11 +111,10 @@ federation!  And in a run-in with their arch-Nemesis the Plinth-inth,
 all federation spaceships are commandeered!  You are ruined!
 
 ```ruby
-
 class Spaceship < ActiveRecord::Base
   belongs_to :space_federation
   extend Shiftable::Collection.new belongs_to: :space_federation, has_many: :spaceships,
-                                   before_shift: lambda { |shifting_rel:, shift_to:, shift_from:|
+                                   before_shift: lambda { |shifting_rel|
                                      shifting_rel.each { |spaceship| spaceship.federation_changes += 1 }
                                    }
 end
@@ -155,7 +154,7 @@ class SpaceTreatySignature < ActiveRecord::Base
     belongs_to: :signatory, has_many: :space_treaty_signature,
     polymorphic: { type: "SpaceFederation", as: :signatory },
     method_prefix: "space_federation_",
-    before_shift: lambda { |shifting_rel:, shift_to:, shift_from:|
+    before_shift: lambda { |shifting_rel|
       # Each item in shifting_rel is an instance of the class where Shiftable::Collection is defined,
       #   in this case: SpaceTreatySignature
       # And each of them has a signatory which is of type "SpaceFederation",
@@ -191,6 +190,50 @@ class SpaceStation < ActiveRecord::Base
 end
 ```
 
+### Wrapping a shift
+
+For example, in a transaction.  Let's update the nemesis foundation example from above with a transaction shift_each_wrapper,
+which we'll pull from the [`activerecord-transactionable`](https://github.com/pboling/activerecord-transactionable) gem, which provides best practice framing around transactions.
+
+```ruby
+class Spaceship < ActiveRecord::Base
+  belongs_to :space_federation
+  extend Shiftable::Collection.new(
+    belongs_to: :space_federation,
+    has_many: :spaceships,
+    before_shift: lambda { |shifting_rel|
+                    shifting_rel.each { |spaceship| spaceship.federation_changes += 1 }
+                  },
+    wrapper: {
+      each: lambda { |record, &block|
+              tresult = record.transaction_wrapper(outside_rescued_errors: ActiveRecord::RecordNotUnique) do
+                puts "melon #{record.name} honey"
+                block.call # does the actual saving!
+              end
+              # NOTE: The value returned by the wrapper will also be returned by the call to `shift_cx`.
+              #       You could return the whole tresult object here, instead of just true/false!
+              tresult.success?
+            },
+      all: lambda { |rel, &block|
+             tresult = Spaceship.transaction_wrapper do
+               puts "can you eat #{rel.count} shoes"
+               block.call
+             end
+             tresult.success?
+           }
+    }
+  )
+end
+
+class SpaceFederation < ActiveRecord::Base
+  has_many :spaceships
+
+  def all_spaceships_commandeered_by(nemesis_federation)
+    Spaceship.shift_cx(shift_to: nemesis_federation, shift_from: self)
+  end
+end
+```
+
 ### Complete example
 
 Putting it all together...
@@ -207,13 +250,32 @@ end
 class Spaceship < ActiveRecord::Base
   belongs_to :captain
   extend Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, precheck: true,
-                               before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
+                               before_shift: ->(shifting_rel) { shifting_rel.result.ownership_changes += 1 }
 
   belongs_to :space_federation
-  extend Shiftable::Collection.new belongs_to: :space_federation, has_many: :spaceships,
-                                   before_shift: lambda { |shifting_rel:, shift_to:, shift_from:|
-                                     shifting_rel.each { |spaceship| spaceship.federation_changes += 1 }
-                                   }
+  extend Shiftable::Collection.new(
+    belongs_to: :space_federation,
+    has_many: :spaceships,
+    before_shift: lambda { |shifting_rel|
+      shifting_rel.each { |spaceship| spaceship.federation_changes += 1 }
+    },
+    wrapper: {
+      each: lambda { |record, &block|
+              tresult = record.transaction_wrapper(outside_rescued_errors: ActiveRecord::RecordNotUnique) do
+                puts "melon #{record.name} honey"
+                block.call # does the actual saving!
+              end
+              tresult.success?
+            },
+      all: lambda { |rel, &block|
+             tresult = Spaceship.transaction_wrapper do
+               puts "can you eat #{rel.count} shoes"
+               block.call
+             end
+             tresult.success?
+           }
+    }
+  )
 end
 
 class SpaceFederation < ActiveRecord::Base

data/lib/shiftable/collection.rb

@@ -16,7 +16,7 @@ module Shiftable
   class Collection < Module
     # associations: belongs_to, has_many
     # options: method_prefix, before_shift
-    def initialize(belongs_to:, has_many:, polymorphic: nil, method_prefix: nil, before_shift: nil)
+    def initialize(belongs_to:, has_many:, polymorphic: nil, method_prefix: nil, before_shift: nil, wrapper: nil)
       # Ruby's Module initializer doesn't take any arguments
       super()
 
@@ -39,7 +39,12 @@ module Shiftable
           method_prefix: method_prefix,
           # will prevent the save if it returns false
           # allows for any custom logic to be run, such as setting attributes, prior to the shift (save).
-          before_shift: before_shift
+          before_shift: before_shift,
+          # wrapper: {
+          #   all: ->() { klass.transaction_wrapper { yield } },
+          #   each: ->() { klass.transaction_wrapper { yield } },
+          # }
+          wrapper: wrapper
         },
         type: polymorphic ? :pcx : :cx
       )

data/lib/shiftable/mod_signature.rb

@@ -24,6 +24,10 @@ module Shiftable
       raise ArgumentError, "exactly two distinct associations must be provided" if invalid_number_of_associations?
     end
 
+    def wrapper
+      options[:wrapper] || {}
+    end
+
     def polymorphic_type
       options.dig(:polymorphic, :type)
     end
@@ -77,10 +81,11 @@ module Shiftable
           to: shift_to,
           from: shift_from,
           column: shift_column,
-          base: base
+          base: base,
+          wrapper: wrapper
         )
-        shifting_rel.shift do |result|
-          before_shift&.call(shifting_rel: result, shift_to: shift_to, shift_from: shift_from)
+        shifting_rel.shift do
+          before_shift&.call(shifting_rel)
         end
       end
     end
@@ -101,10 +106,11 @@ module Shiftable
             as: polymorphic_as,
             id_column: shift_pcx_column
           },
-          base: base
+          base: base,
+          wrapper: wrapper
         )
-        shifting_rel.shift do |result|
-          before_shift&.call(shifting_rel: result, shift_to: shift_to, shift_from: shift_from)
+        shifting_rel.shift do
+          before_shift&.call(shifting_rel)
         end
       end
     end
@@ -125,12 +131,13 @@ module Shiftable
           to: shift_to,
           from: shift_from,
           column: shift_column,
-          base: base
+          base: base,
+          wrapper: wrapper
         ) do
           !precheck || !shift_to.send(has_rel)
         end
-        shifting.shift do |result|
-          before_shift&.call(shifting: result, shift_to: shift_to, shift_from: shift_from)
+        shifting.shift do
+          before_shift&.call(shifting)
         end
       end
     end

data/lib/shiftable/shifting.rb

@@ -3,9 +3,9 @@
 module Shiftable
   # Gets data to be shifted
   class Shifting
-    attr_reader :to, :from, :column, :base, :result, :run_save
+    attr_reader :to, :from, :column, :base, :result, :run_save, :shift_all_wrapper, :shift_each_wrapper
 
-    def initialize(to:, from:, column:, base:)
+    def initialize(to:, from:, column:, base:, wrapper:)
       @to = to
       @from = from
       @column = column
@@ -14,6 +14,8 @@ module Shiftable
       do_query = block_given? ? yield : true
       @result = do_query ? query : nil
       @run_save = true
+      @shift_all_wrapper = wrapper[:all]
+      @shift_each_wrapper = wrapper[:each]
     end
 
     # def found?
@@ -31,6 +33,28 @@ module Shiftable
       raise ArgumentError, "shift_from must have an id (primary key) value, but is: #{from&.id}" unless from&.id
     end
 
+    def run_save!
+      if shift_all_wrapper
+        shift_all_wrapper.call(self) do
+          do_saves
+        end
+      else
+        do_saves
+      end
+    end
+
+    def do_saves
+      if shift_each_wrapper
+        each do |rec|
+          shift_each_wrapper.call(rec) do
+            rec.save
+          end
+        end
+      else
+        each(&:save)
+      end
+    end
+
     # def query
     #   raise "query must be defined in a subclass"
     # end

data/lib/shiftable/shifting_polymorphic_relation.rb

@@ -28,8 +28,10 @@ module Shiftable
       each do |record|
         record.send("#{polymorphic_id_column}=", to.id)
       end
-      @run_save = yield result if block_given?
-      each(&:save) if run_save
+      @run_save = yield if block_given?
+      return result unless run_save
+
+      run_save!
       result
     end
 

data/lib/shiftable/shifting_record.rb

@@ -12,12 +12,34 @@ module Shiftable
       return false unless found?
 
       result.send("#{column}=", to.id)
-      @run_save = yield result if block_given?
-      result.save if run_save
+      @run_save = yield if block_given?
+      return nil unless run_save
+
+      run_save!
     end
 
     private
 
+    def run_save!
+      if shift_all_wrapper
+        shift_all_wrapper.call(self) do
+          do_save
+        end
+      else
+        do_save
+      end
+    end
+
+    def do_save
+      if shift_each_wrapper
+        shift_each_wrapper.call(result) do
+          result.save
+        end
+      else
+        result.save
+      end
+    end
+
     def query
       base.find_by(column => from.id)
     end

data/lib/shiftable/shifting_relation.rb

@@ -20,8 +20,10 @@ module Shiftable
       each do |record|
         record.send("#{column}=", to.id)
       end
-      @run_save = yield result if block_given?
-      each(&:save) if run_save
+      @run_save = yield if block_given?
+      return result unless run_save
+
+      run_save!
       result
     end
 

data/lib/shiftable/single.rb

@@ -14,14 +14,14 @@
 #             belongs_to: :captain,
 #             has_one: :spaceship,
 #             precheck: true,
-#             before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
+#             before_shift: ->(shifting_rel) { shifting_rel.result..ownership_changes += 1 }
 #           )
 #   end
 #
 module Shiftable
   # Inheriting from Module is a powerful pattern. If you like it checkout the debug_logging gem!
   class Single < Module
-    def initialize(belongs_to:, has_one:, method_prefix: nil, precheck: true, before_shift: nil)
+    def initialize(belongs_to:, has_one:, method_prefix: nil, precheck: true, before_shift: nil, wrapper: nil)
       # Ruby's Module initializer doesn't take any arguments
       super()
 
@@ -44,7 +44,8 @@ module Shiftable
           method_prefix: method_prefix,
           # will prevent the save if it returns false
           # allows for any custom logic to be run, such as setting attributes, prior to the shift (save).
-          before_shift: before_shift
+          before_shift: before_shift,
+          wrapper: wrapper
         },
         type: :sg
       )

data/lib/shiftable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiftable
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shiftable
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Boling
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: activerecord-transactionable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: silent_stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement