shiftable 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62926c718edd257728210a0870ea5eca44aeb35b33a929d87d2efb8a5f902910
-  data.tar.gz: b4c35fcc2a3eff45d992b5260e6d4f2f13d870782f40d06285172eb2f1207f9d
+  metadata.gz: 03d919c64ab0be03ba40c5474cfa7971dda6158ab01df20940bb644c32482b19
+  data.tar.gz: 3246e28e7578ea7b56ae905c23c675e121a8c71556d127b8ee4a0fbeedcce15b
 SHA512:
-  metadata.gz: 8c21a1f0c51b4a3cb715730fe07bb29d562a84d8dd79b558a3ca06c6a7bf20032928225b41aa1e749b4a7a85afe4fdb33cbf9d068b7539ef622665272f1f8115
-  data.tar.gz: d9bc2d54fe6fb3f15f781b33ddf83c6abfa91f7b66e426274bc9ef07595e61a9c6b4f42a2ffe27e6b8cce5453dbcc0221ac07261bddb762a3a9eba3e79d7cef1
+  metadata.gz: b3721c0d437b1ab45deb99f71f7a199fe4c37aae31f86f8443eb2effd1bd07c9d930aa64c4a4b824c7371863c9cb219251e59dc673d9ef40a73551e75c7efc67
+  data.tar.gz: c0d40a890f89fda5137575d9052131605f33e6a861e6b9e55b6681d89cfeba4f9ac5547cb09c4ab68cb69bafa50a9c6ebc75412152cf8c3bf9e76f90ce80f823

data/CHANGELOG.md

@@ -1,7 +1,38 @@
 ## [Unreleased]
 
-## [0.4.0] - 2021-10-27
+### Added
+
+
+### Changed
+
+
+### Fixed
+
+
+### 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
+
+- Documentation typos in README
+
+## [0.5.0] - 2021-11-12
+### Added
+
+- Support for Polymorphic associations (see examples in specs or README)
+
+## [0.4.1] - 2021-11-10
+### Fixed
+
+- Documentation typos in README
+
+## [0.4.0] - 2021-10-27
 ### Changed
 
 - option :preflight_checks renamed to :precheck
@@ -11,7 +42,6 @@
 - Even more 100% spec coverage
 
 ## [0.3.0] - 2021-10-26
-
 ### Changed
 
 - Internal rewrite to improve maintainability
@@ -22,7 +52,6 @@
 - Even more 100% spec coverage
 
 ## [0.2.0] - 2021-10-24
-
 ### Changed
 
 - option `before_save` is now `before_shift` as originally documented
@@ -34,7 +63,6 @@
 - Documentation
 
 ## [0.1.1] - 2021-10-23
-
 ### Fixed
 
 - Github Actions build
@@ -44,7 +72,6 @@
 - Linting
 
 ## [0.1.0] - 2021-10-23
-
 ### Added
 
 - Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/pboling/activerecord-transactionable][source]
+. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct][conduct].
+
+To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request!
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=pboling/activerecord-transactionable)][contributors]
+
+Made with [contributors-img][contrib-rocks].
+
+[comment]: <> (Following links are used by README, CONTRIBUTING)
+
+[conduct]: https://github.com/pboling/activerecord-transactionable/blob/master/CODE_OF_CONDUCT.md
+
+[contrib-rocks]: https://contrib.rocks
+
+[contributors]: https://github.com/pboling/activerecord-transactionable/graphs/contributors
+
+[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
+
+[source]: https://github.com/pboling/activerecord-transactionable/

data/README.md

@@ -5,31 +5,23 @@ Do your Spaceships belong to Captains, but sometimes a Captain will retire, and
 We've all been there. This gem provides structure around the process of "shifting" your records from one associated
 record to a new record.
 
-| Project                 |  Shiftable |
-|------------------------ | ----------------------- |
-| gem name                |  [shiftable](https://rubygems.org/gems/shiftable) |
-| license                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) |
-| download rank           |  [![Downloads Today](https://img.shields.io/gem/rd/shiftable.svg)](https://github.com/pboling/shiftable) |
-| version                 |  [![Version](https://img.shields.io/gem/v/shiftable.svg)](https://rubygems.org/gems/shiftable) |
-| dependencies            |  [![Depfu](https://badges.depfu.com/badges/0412727b7e3b740b950a683eebc708e2/count.svg)](https://depfu.com/github/pboling/shiftable?project_id=32594) |
-| unit tests              |  [![unit tests](https://github.com/pboling/shiftable/actions/workflows/test.yml/badge.svg)](https://github.com/pboling/shiftable/actions) |
-| lint status             |  [![lint status](https://github.com/pboling/shiftable/actions/workflows/style.yml/badge.svg)](https://github.com/pboling/shiftable/actions) |
-| unsupported status      |  [![unsupported status](https://github.com/pboling/shiftable/actions/workflows/unsupported.yml/badge.svg)](https://github.com/pboling/shiftable/actions) |
-| test coverage           |  [![Test Coverage](https://api.codeclimate.com/v1/badges/a53aa8b7c413b950d519/test_coverage)](https://codeclimate.com/github/pboling/shiftable/test_coverage) |
-| maintainability         |  [![Maintainability](https://api.codeclimate.com/v1/badges/a53aa8b7c413b950d519/maintainability)](https://codeclimate.com/github/pboling/shiftable/maintainability) |
-| code triage             |  [![Open Source Helpers](https://www.codetriage.com/pboling/shiftable/badges/users.svg)](https://www.codetriage.com/pboling/shiftable) |
-| homepage                |  [on Github.com][homepage], [on Railsbling.com][blogpage] |
-| documentation           |  [on RDoc.info][documentation] |
-| Spread ~♡ⓛⓞⓥⓔ♡~      |  [🌏][aboutme], [👼][angelme], [💻][coderme], [![Tweet @ Peter][followme-img]][tweetme], [🌹][politicme] |
+| Project                    |  Shiftable |
+|--------------------------- | ----------------------- |
+| name, license, docs        |  [![RubyGems.org](https://img.shields.io/badge/name-shiftable-brightgreen.svg?style=flat)][rubygems] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref] [![RubyDoc.info](https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat)][documentation] |
+| version & downloads        |  [![Version](https://img.shields.io/gem/v/shiftable.svg)][rubygems] [![Total Downloads](https://img.shields.io/gem/dt/shiftable.svg)][rubygems] [![Downloads Today](https://img.shields.io/gem/rd/shiftable.svg)][rubygems] [![Homepage](https://img.shields.io/badge/source-github-brightgreen.svg?style=flat)][source] |
+| dependencies & linting     |  [![Depfu](https://badges.depfu.com/badges/0412727b7e3b740b950a683eebc708e2/count.svg)][depfu] [![lint status](https://github.com/pboling/shiftable/actions/workflows/style.yml/badge.svg)][actions] |
+| unit tests                 |  [![supported rubies](https://github.com/pboling/shiftable/actions/workflows/supported.yml/badge.svg)][actions] [![unsupported status](https://github.com/pboling/shiftable/actions/workflows/unsupported.yml/badge.svg)][actions] |
+| coverage & maintainability |  [![Test Coverage](https://api.codeclimate.com/v1/badges/a53aa8b7c413b950d519/test_coverage)][climate_coverage] [![codecov](https://codecov.io/gh/pboling/shiftable/branch/main/graph/badge.svg?token=J1542PYN2Z)][codecov_coverage] [![Maintainability](https://api.codeclimate.com/v1/badges/a53aa8b7c413b950d519/maintainability)][climate_maintainability] [![Security Policy](https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat)][security] |
+| resources                  |  [![Discussion](https://img.shields.io/badge/discussions-github-brightgreen.svg?style=flat)][gh_discussions] [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) [![Join the chat at https://gitter.im/pboling/shiftable](https://badges.gitter.im/Join%20Chat.svg)][chat] [![Blog](https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat)][blogpage] |
+| Spread ~♡ⓛⓞⓥⓔ♡~         |  [![Open Source Helpers](https://www.codetriage.com/pboling/shiftable/badges/users.svg)][code_triage] [![Liberapay Patrons](https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay)][liberapay_donate] [![Sponsor Me](https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github)][gh_sponsors] [🌏][aboutme] [👼][angelme] [💻][coderme] [🌹][politicme] [![Tweet @ Peter][followme-img]][tweetme] |
 
 ## Compatibility
 
 Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.6, 2.7, and 3.0, but may work on older Rubies back
 to 2.0, though it is limited to 2.5 in the gemspec. Feel free to fork if you need something older! Targeted ActiveRecord
 (Rails not required) compatibility follows the same scheme
-as [Rails Security Issue maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html#security-issues),
-currently 6.1, 6.0, 5.2, but it is highly likely that this code will work in any version of ActiveRecord/Rails that runs
-on Ruby 2+.
+as [Rails Security Issue maintenance policy][maintenancee_policy], currently 6.1, 6.0, 5.2, but it is highly likely that
+this code will work in any version of ActiveRecord/Rails that runs on Ruby 2+.
 
 ## Installation
 
@@ -88,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
 ```
 
@@ -112,22 +104,127 @@ end
 
 This works as you would expect with STI (single table inheritance) classes, i.e. when defined on a subclass, only the records of that class get shifted.
 
-### Multiple association on a single class
+### Multiple associations on a single class
 
 What if the captain and the spaceship have a boss... the space
 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_one: :spaceship,
-                                   before_shift: lambda do |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 }
+                                   }
+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
+```
+
+### Polymorphism and has_many through
+
+```ruby
+class SpaceTreaty < ActiveRecord::Base
+  has_many :space_treaty_signature
+end
+
+class SpaceTreatySignature < ActiveRecord::Base
+  belongs_to :space_treaty
+  belongs_to :signatory, polymorphic: true
+  # When two space federations assimilate (i.e. merge) to form a single larger federation,
+  #   they become party to (i.e. signatories of) all the treaties that had been signed by either.
+  # In practical terms, this means:
+  #
+  #   surviving_federation = SpaceFederation.find(1)
+  #   assimilated_federation = SpaceFederation.find(2)
+  #   SpaceTreatySignature.where(
+  #     signatory_id: assimilated_federation_id,
+  #     signatory_type: "SpaceFederation"
+  #   ).update_all(
+  #     signatory_id: surviving_federation.id
+  #   )
+  extend Shiftable::Collection.new(
+    belongs_to: :signatory, has_many: :space_treaty_signature,
+    polymorphic: { type: "SpaceFederation", as: :signatory },
+    method_prefix: "space_federation_",
+    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",
+      #   because a polymorphic collection only targets one type.
+      # shifting_rel.each { |signature| signature.signatory == "SpaceFederation" }
+    }
+  )
+end
+
+class SpaceFederation < ActiveRecord::Base
+  has_many :space_treaty_signature, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures, as: :signatory
+  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_pcx(shift_to: self, shift_from: other_federation)
   end
 end
 
+# Including Planet and SpaceStation, for completeness of the example as the other "types" of polymorphic signatories
+class Planet < ActiveRecord::Base
+  has_many :space_treaty_signature, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures
+  has_many :treaty_federations, class_name: "SpaceFederation", through: :space_treaty_signatures, as: :signatory
+  has_many :treaty_stations, class_name: "SpaceStation", through: :space_treaty_signatures, as: :signatory
+end
+
+class SpaceStation < ActiveRecord::Base
+  has_many :space_treaty_signature, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures
+  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
+```
+
+### 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
 
@@ -153,27 +250,97 @@ 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_one: :spaceship,
-                                   before_shift: lambda do |shifting_rel:, shift_to:, shift_from:|
-    shifting_rel.each { |spaceship| spaceship.federation_changes += 1 }
-  end
+  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
   has_many :captains
   has_many :spaceships
+  has_many :space_treaty_signature, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures, as: :signatory
+  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)
+  end
 
   def all_spaceships_commandeered_by(nemesis_federation)
     Spaceship.shift_cx(shift_to: nemesis_federation, shift_from: self)
   end
 end
+class SpaceTreaty < ActiveRecord::Base
+  has_many :space_treaty_signatures
+end
+
+class SpaceTreatySignature < ActiveRecord::Base
+  belongs_to :space_treaty
+  belongs_to :signatory, polymorphic: true
+  extend Shiftable::Collection.new(
+    belongs_to: :signatory, has_many: :space_treaty_signatures,
+    polymorphic: { type: "SpaceFederation", as: :signatory },
+    method_prefix: "space_federation_"
+  )
+end
+
+# Including Planet and SpaceStation, for completeness of the example as the other "types" of polymorphic signatories
+class Planet < ActiveRecord::Base
+  has_many :space_treaty_signatures, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures
+  has_many :treaty_federations, class_name: "SpaceFederation", through: :space_treaty_signatures, as: :signatory
+  has_many :treaty_stations, class_name: "SpaceStation", through: :space_treaty_signatures, as: :signatory
+end
+
+class SpaceStation < ActiveRecord::Base
+  has_many :space_treaty_signature, as: :signatory
+  has_many :space_treaties, through: :space_treaty_signatures
+  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
 ```
 
 ... stay tuned!
 
+## More Information
+
+* RubyDoc
+  Documentation: [![RubyDoc.info](https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat)][documentation]
+* GitHub
+  Discussions: [![Discussion](https://img.shields.io/badge/discussions-github-brightgreen.svg?style=flat)][gh_discussions]
+* Live Chat on
+  Gitter: [![Join the chat at https://gitter.im/pboling/activerecord-transactionable](https://badges.gitter.im/Join%20Chat.svg)][chat]
+* Maintainer's Blog: [![Blog](https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat)][blogpage]
+
+## Code of Conduct
+
+Everyone interacting in the Shiftable project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct][conduct].
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
@@ -185,14 +352,13 @@ push git commits and the created tag, and push the `.gem` file to [rubygems.org]
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/shiftable. This project is intended to
-be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [code of conduct](https://github.com/pboling/shiftable/blob/master/CODE_OF_CONDUCT.md).
+See [CONTRIBUTING.md][contributing]
 
-## Code of Conduct
+## Contributors
 
-Everyone interacting in the Shiftable project's codebases, issue trackers, chat rooms and mailing lists is expected to
-follow the [code of conduct](https://github.com/pboling/shiftable/blob/master/CODE_OF_CONDUCT.md).
+[![Contributors](https://contrib.rocks/image?repo=pboling/shiftable)]("https://github.com/pboling/shiftable/graphs/contributors")
+
+Made with [contributors-img](https://contrib.rocks).
 
 ## Versioning
 
@@ -207,18 +373,36 @@ the [Pessimistic Version Constraint][pvc] with two digits of precision.
 For example:
 
 ```ruby
-spec.add_dependency "shiftable", "~> 0.2"
+spec.add_dependency "shiftable", "~> 0.4"
 ```
 
+## Contact
+
+Author and maintainer is Peter Boling ([@pboling][gh_sponsors]).
+
+Comments are welcome in the [GitHub Discussions][gh_discussions] board.
+
+For security-related issues see [SECURITY][security].
+
 ## License
 
 The gem is available as open source under the terms of
-the [MIT License](https://opensource.org/licenses/MIT) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
-.
+the [MIT License][license] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref].
+See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer].
 
 * Copyright (c) 2021 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
 
-[license]: LICENSE
+[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
+
+[gh_discussions]: https://github.com/pboling/shiftable/discussions
+
+[conduct]: https://github.com/pboling/shiftable/blob/master/CODE_OF_CONDUCT.md
+
+[security]: https://github.com/pboling/shiftable/blob/master/SECURITY.md
+
+[license]: https://github.com/pboling/shiftable/blob/master/LICENSE.txt
+
+[license-ref]: https://opensource.org/licenses/MIT
 
 [semver]: http://semver.org/
 
@@ -240,8 +424,32 @@ the [MIT License](https://opensource.org/licenses/MIT) [![License: MIT](https://
 
 [politicme]: https://nationalprogressiveparty.org
 
-[documentation]: http://rdoc.info/github/pboling/shiftable/frames
+[documentation]: https://rubydoc.info/github/pboling/shiftable/main
+
+[source]: https://github.com/pboling/shiftable/
+
+[actions]: https://github.com/pboling/shiftable/actions
+
+[issues]: https://github.com/pboling/shiftable/issues
+
+[climate_maintainability]: https://codeclimate.com/github/pboling/shiftable/maintainability
 
-[homepage]: https://github.com/pboling/shiftable/
+[climate_coverage]: https://codeclimate.com/github/pboling/shiftable/test_coverage
+
+[codecov_coverage]: https://codecov.io/gh/pboling/shiftable
+
+[code_triage]: https://www.codetriage.com/pboling/shiftable
+
+[depfu]: https://depfu.com/github/pboling/shiftable?project_id=32594
 
 [blogpage]: http://www.railsbling.com/tags/shiftable/
+
+[rubygems]: https://rubygems.org/gems/shiftable
+
+[chat]: https://gitter.im/pboling/shiftable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+[maintenancee_policy]: https://guides.rubyonrails.org/maintenance_policy.html#security-issues
+
+[liberapay_donate]: https://liberapay.com/pboling/donate
+
+[gh_sponsors]: https://github.com/sponsors/pboling

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:, 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()
 
@@ -35,12 +35,18 @@ module Shiftable
           has_many: has_many.to_s.to_sym
         },
         options: {
+          polymorphic: polymorphic,
           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: :cx
+        type: polymorphic ? :pcx : :cx
       )
     end
 
@@ -62,11 +68,12 @@ module Shiftable
     module ShiftCollectionModulizer
       def to_mod(signature)
         prefix = signature.method_prefix
+        type = signature.type
         Module.new do
-          define_method(:"#{prefix}shift_cx_column") do
-            signature.shift_column
+          define_method(:"#{prefix}shift_#{type}_column") do
+            signature.send("shift_#{type}_column")
           end
-          define_method(:"#{prefix}shift_cx") do |shift_to:, shift_from:|
+          define_method(:"#{prefix}shift_#{type}") do |shift_to:, shift_from:|
             signature.shift_data!(shift_to: shift_to, shift_from: shift_from)
           end
         end

data/lib/shiftable/mod_signature.rb

@@ -2,11 +2,8 @@
 
 module Shiftable
   class ModSignature
-    VALID_TYPES = %i[sg cx].freeze
-    VALID_ASSOCIATIONS = {
-      sg: %i[belongs_to has_one],
-      cx: %i[belongs_to has_many]
-    }.freeze
+    VALID_ASSOCIATIONS = { sg: %i[belongs_to has_one], cx: %i[belongs_to has_many], pcx: %i[belongs_to has_many] }.freeze
+    VALID_TYPES = VALID_ASSOCIATIONS.keys.dup.freeze
     DEFAULT_BEFORE_SHIFT = ->(*_) { true }
     attr_reader :associations, :options, :type, :base
 
@@ -27,6 +24,18 @@ 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
+
+    def polymorphic_as
+      options.dig(:polymorphic, :as)
+    end
+
     def invalid_type?
       !VALID_TYPES.include?(type)
     end
@@ -51,42 +60,66 @@ module Shiftable
     end
 
     def validate_relationships
-      bt = base.reflect_on_association(belongs_to)
-      raise ArgumentError, "Unable to find belongs_to: :#{belongs_to} in #{base}" unless bt
-
-      klass = bt.klass
-      hr = klass.reflect_on_association(has_rel)
-      raise ArgumentError, "Unable to find #{has_rel_name}: :#{has_rel} in #{klass}" unless hr
+      bt_reflection = base.reflect_on_association(belongs_to)
+      raise ArgumentError, "Unable to find belongs_to: :#{belongs_to} in #{base}" unless bt_reflection
+      # We can't validate any further if the reflection is polymorphic
+      return true if bt_reflection.polymorphic?
+
+      klass = bt_reflection.klass
+      has_reflection = klass.reflect_on_association(has_rel)
+      raise ArgumentError, "Unable to find #{has_rel_name}: :#{has_rel} in #{klass}" unless has_reflection
     end
 
     module CxMethods
-      def has_many
+      def has_rel
         associations[:has_many]
       end
 
-      alias has_rel has_many
-
       def shift_data!(shift_to:, shift_from:)
         validate_relationships
         shifting_rel = ShiftingRelation.new(
           to: shift_to,
           from: shift_from,
           column: shift_column,
-          base: base
+          base: base,
+          wrapper: wrapper
+        )
+        shifting_rel.shift do
+          before_shift&.call(shifting_rel)
+        end
+      end
+    end
+
+    module PcxMethods
+      # This method could be defined for parity, but it is never used.
+      # def has_rel
+      #   associations[:has_many]
+      # end
+
+      def shift_data!(shift_to:, shift_from:)
+        validate_relationships
+        shifting_rel = ShiftingPolymorphicRelation.new(
+          to: shift_to,
+          from: shift_from,
+          column: {
+            type: polymorphic_type,
+            as: polymorphic_as,
+            id_column: shift_pcx_column
+          },
+          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
 
     module SgMethods
-      def has_one
+      def has_rel
         associations[:has_one]
       end
 
-      alias has_rel has_one
-
       # Do not move record if a record already exists (we are shifting a "has_one" association, after all)
       def precheck
         options[:precheck]
@@ -98,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_one)
+          !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
@@ -125,9 +159,16 @@ module Shiftable
       options[:before_shift] || DEFAULT_BEFORE_SHIFT
     end
 
+    def shift_pcx_column
+      "#{polymorphic_as}_id"
+    end
+
     def shift_column
       reflection = base.reflect_on_association(belongs_to).klass.reflect_on_association(has_rel)
       reflection.foreign_key
     end
+
+    alias shift_sg_column shift_column
+    alias shift_cx_column shift_column
   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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Shiftable
+  # Gets data to be shifted
+  class ShiftingPolymorphicRelation < Shifting
+    include Enumerable
+
+    def polymorphic_id_column
+      column[:id_column]
+    end
+
+    def polymorphic_type_column
+      "#{column[:as]}_type"
+    end
+
+    def found?
+      result.any?
+    end
+
+    def each(&block)
+      result.each(&block)
+    end
+
+    # @return result (once it is shifted)
+    def shift
+      return false unless found?
+
+      each do |record|
+        record.send("#{polymorphic_id_column}=", to.id)
+      end
+      @run_save = yield if block_given?
+      return result unless run_save
+
+      run_save!
+      result
+    end
+
+    private
+
+    def query
+      base.where(
+        polymorphic_type_column => column[:type],
+        polymorphic_id_column => from.id
+      )
+    end
+  end
+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
       )
@@ -70,7 +71,7 @@ module Shiftable
         prefix = signature.method_prefix
         Module.new do
           define_method(:"#{prefix}shift_column") do
-            signature.shift_column
+            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)

data/lib/shiftable/version.rb

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

data/lib/shiftable.rb

@@ -3,6 +3,7 @@
 require_relative "shiftable/version"
 require_relative "shiftable/shifting"
 require_relative "shiftable/shifting_record"
+require_relative "shiftable/shifting_polymorphic_relation"
 require_relative "shiftable/shifting_relation"
 require_relative "shiftable/mod_signature"
 require_relative "shiftable/collection"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiftable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        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
@@ -109,105 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec-block_is_expected
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop-faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rspec-benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -221,21 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec-focused
+  name: rspec-block_is_expected
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -249,47 +151,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-thread_safety
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
+  name: silent_stream
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -328,12 +202,14 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - lib/shiftable.rb
 - lib/shiftable/collection.rb
 - lib/shiftable/mod_signature.rb
 - lib/shiftable/shifting.rb
+- lib/shiftable/shifting_polymorphic_relation.rb
 - lib/shiftable/shifting_record.rb
 - lib/shiftable/shifting_relation.rb
 - lib/shiftable/single.rb
@@ -353,14 +229,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Easily shift record associations