shiftable 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678fdd1fc65199227c201ecd4346e4c0019c78747d949ac9b4dcba8b38158c24
-  data.tar.gz: 3f527ed0b2e70a2e677b006320b3e667d0512ccfcacc5bb76232129b9f37c6d0
+  metadata.gz: 5307ad9f6d83499df06dcd5b57745dfeed1522f5701708018c61e5b3a3b6bfba
+  data.tar.gz: 5452233e37e38c732340e1f7f825da3c020799b2600b5b692087af44969c2c73
 SHA512:
-  metadata.gz: c281d086eabfbce50dcd9f3098374656a8c7536b0ce1d5e21d5262c6e205172f90930aa7120a747904d6599313c235adba0bc5487011fa7b5df0e8c90af9157b
-  data.tar.gz: 217eb1fb303dbc45ccb962bddbff8c4dc246b20351b1f1f2312b9e4ea8c4db7a90360c089b040f0276e544a38193d01feb1728bd6f3949dfe849509a12d38a64
+  metadata.gz: d7ed429d81143625afb5717143a877b8de5da2729be8519ed87246353051aa26a8f94f9d33765a9b158b7fc6fa21ed35c2017cadf84e26b669c399d61992f627
+  data.tar.gz: ba888b498d8da4a6070f29346426b0ea05a23f959ff208400b5c1067394d5d7301850f99dce3cf0a90b712fd57b6dc397d5b871f7d81723901fd0b60d270329f

data/CHANGELOG.md

@@ -12,6 +12,26 @@
 ### Removed
 
 
+## [0.7.0] - 2021-11-15
+### Changed
+
+- Make the `Shifting` Relation available to the `each` wrapper, as a block parameter
+
+## [0.6.1] - 2021-11-14
+### Added
+
+- Support for using save with bang (`save!`) to raise error when ActiveRecord save fails.
+
+## [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
+
+- Documentation typos in README
+
 ## [0.5.0] - 2021-11-12
 ### Added
 
@@ -76,4 +96,16 @@
 
 [0.3.0]: https://github.com/pboling/shiftable/releases/tag/v0.3.0
 
-[0.4.0]: https://github.com/pboling/shiftable/releases/tag/v0.4.0
+[0.4.0]: https://github.com/pboling/shiftable/releases/tag/v0.4.0
+
+[0.4.1]: https://github.com/pboling/shiftable/releases/tag/v0.4.1
+
+[0.5.0]: https://github.com/pboling/shiftable/releases/tag/v0.5.0
+
+[0.5.1]: https://github.com/pboling/shiftable/releases/tag/v0.5.1
+
+[0.6.0]: https://github.com/pboling/shiftable/releases/tag/v0.6.0
+
+[0.6.1]: https://github.com/pboling/shiftable/releases/tag/v0.6.1
+
+[0.7.0]: https://github.com/pboling/shiftable/releases/tag/v0.7.0

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
@@ -153,9 +152,9 @@ class SpaceTreatySignature < ActiveRecord::Base
   #   )
   extend Shiftable::Collection.new(
     belongs_to: :signatory, has_many: :space_treaty_signature,
-    polymorphic_type: "SpaceFederation",
+    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",
@@ -171,7 +170,7 @@ class SpaceFederation < ActiveRecord::Base
   has_many :treaty_planets, class_name: "Planet", through: :space_treaty_signatures, as: :signatory
   has_many :treaty_stations, class_name: "SpaceStation", through: :space_treaty_signatures, as: :signatory
   def assimilate_from(other_federation)
-    SpaceTreatySignature.space_federation_shift_cx(shift_to: self, shift_from: other_federation)
+    SpaceTreatySignature.space_federation_shift_pcx(shift_to: self, shift_from: other_federation)
   end
 end
 
@@ -189,7 +188,51 @@ class SpaceStation < ActiveRecord::Base
   has_many :treaty_federations, class_name: "SpaceFederation", through: :space_treaty_signatures, as: :signatory
   has_many :treaty_planets, class_name: "Planet", through: :space_treaty_signatures, as: :signatory
 end
-```#<--rubocop/md-->#<--rubocop/md-->`
+```
+
+### 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 { |rel, record, &block|
+              tresult = record.transaction_wrapper(outside_rescued_errors: ActiveRecord::RecordNotUnique) do
+                puts "melon #{record.name} honey #{rel.count}"
+                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
 
@@ -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 { |rel, record, &block|
+              tresult = record.transaction_wrapper(outside_rescued_errors: ActiveRecord::RecordNotUnique) do
+                puts "melon #{record.name} honey #{rel.count}"
+                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
@@ -241,7 +303,7 @@ class SpaceTreatySignature < ActiveRecord::Base
   belongs_to :signatory, polymorphic: true
   extend Shiftable::Collection.new(
     belongs_to: :signatory, has_many: :space_treaty_signatures,
-    polymorphic_type: "SpaceFederation",
+    polymorphic: { type: "SpaceFederation", as: :signatory },
     method_prefix: "space_federation_"
   )
 end
@@ -311,7 +373,7 @@ the [Pessimistic Version Constraint][pvc] with two digits of precision.
 For example:
 
 ```ruby
-spec.add_dependency "shiftable", "~> 0.4"
+spec.add_dependency "shiftable", "~> 0.7"
 ```
 
 ## Contact

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
       )
@@ -68,8 +73,8 @@ module Shiftable
           define_method(:"#{prefix}shift_#{type}_column") do
             signature.send("shift_#{type}_column")
           end
-          define_method(:"#{prefix}shift_#{type}") do |shift_to:, shift_from:|
-            signature.shift_data!(shift_to: shift_to, shift_from: shift_from)
+          define_method(:"#{prefix}shift_#{type}") do |shift_to:, shift_from:, bang: false|
+            signature.shift_data!(shift_to: shift_to, shift_from: shift_from, bang: bang)
           end
         end
       end

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
@@ -71,16 +75,18 @@ module Shiftable
         associations[:has_many]
       end
 
-      def shift_data!(shift_to:, shift_from:)
+      def shift_data!(shift_to:, shift_from:, bang: false)
         validate_relationships
         shifting_rel = ShiftingRelation.new(
           to: shift_to,
           from: shift_from,
           column: shift_column,
-          base: base
+          base: base,
+          wrapper: wrapper,
+          bang: bang
         )
-        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
@@ -91,7 +97,7 @@ module Shiftable
       #   associations[:has_many]
       # end
 
-      def shift_data!(shift_to:, shift_from:)
+      def shift_data!(shift_to:, shift_from:, bang: false)
         validate_relationships
         shifting_rel = ShiftingPolymorphicRelation.new(
           to: shift_to,
@@ -101,10 +107,12 @@ module Shiftable
             as: polymorphic_as,
             id_column: shift_pcx_column
           },
-          base: base
+          base: base,
+          wrapper: wrapper,
+          bang: bang
         )
-        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
@@ -119,18 +127,20 @@ module Shiftable
         options[:precheck]
       end
 
-      def shift_data!(shift_to:, shift_from:)
+      def shift_data!(shift_to:, shift_from:, bang: false)
         validate_relationships
         shifting = ShiftingRecord.new(
           to: shift_to,
           from: shift_from,
           column: shift_column,
-          base: base
+          base: base,
+          wrapper: wrapper,
+          bang: bang
         ) 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,13 @@
 module Shiftable
   # Gets data to be shifted
   class Shifting
-    attr_reader :to, :from, :column, :base, :result, :run_save
+    # Public API
+    attr_accessor :result, :bang, :shift_all_wrapper, :shift_each_wrapper
+    attr_reader :to, :from
+    # Internal API
+    attr_reader :column, :base, :run_save
 
-    def initialize(to:, from:, column:, base:)
+    def initialize(to:, from:, column:, base:, wrapper:, bang:)
       @to = to
       @from = from
       @column = column
@@ -14,6 +18,9 @@ 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]
+      @bang = bang
     end
 
     # def found?
@@ -31,6 +38,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(self, rec) do
+            bang ? rec.save! : rec.save
+          end
+        end
+      else
+        bang ? each(&:save!) : 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(self, result) do
+          bang ? result.save! : result.save
+        end
+      else
+        bang ? result.save! : 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
       )
@@ -72,8 +73,8 @@ module Shiftable
           define_method(:"#{prefix}shift_column") do
             signature.send("shift_#{signature.type}_column")
           end
-          define_method(:"#{prefix}shift_single") do |shift_to:, shift_from:|
-            signature.shift_data!(shift_to: shift_to, shift_from: shift_from)
+          define_method(:"#{prefix}shift_single") do |shift_to:, shift_from:, bang: false|
+            signature.shift_data!(shift_to: shift_to, shift_from: shift_from, bang: bang)
           end
         end
       end

data/lib/shiftable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiftable
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -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