shiftable 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d27c7c2706faf797241101fa5229f4bf707b06f4d1b7c839cc66fd7ab2ecf8
-  data.tar.gz: 0fa0fbe15096d109c2d63568101ad0589b4c684775b69b95e831289b8bfdac3d
+  metadata.gz: 62926c718edd257728210a0870ea5eca44aeb35b33a929d87d2efb8a5f902910
+  data.tar.gz: b4c35fcc2a3eff45d992b5260e6d4f2f13d870782f40d06285172eb2f1207f9d
 SHA512:
-  metadata.gz: fa80c525bb2a0cfa99a82350da151412972f86a6699e1091e520d9cec40466f07789e5d1e593f8e3b720cc9e447d742acf28f2c09f5b02c61745cf8ca79084cf
-  data.tar.gz: 4abc0b5c410ba1748646122914ac768829984934e1f57b4d0483db18d0d5985b1976d69deeceabb3bf04fc5b4e3b6307056e3eeae2cffbd89e8099059cb32c07
+  metadata.gz: 8c21a1f0c51b4a3cb715730fe07bb29d562a84d8dd79b558a3ca06c6a7bf20032928225b41aa1e749b4a7a85afe4fdb33cbf9d068b7539ef622665272f1f8115
+  data.tar.gz: d9bc2d54fe6fb3f15f781b33ddf83c6abfa91f7b66e426274bc9ef07595e61a9c6b4f42a2ffe27e6b8cce5453dbcc0221ac07261bddb762a3a9eba3e79d7cef1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2021-10-27
+
+### Changed
+
+- option :preflight_checks renamed to :precheck
+
+### Added
+
+- Even more 100% spec coverage
+
 ## [0.3.0] - 2021-10-26
 
 ### Changed
@@ -42,4 +52,11 @@
 - 100% test coverage
 
 [0.1.0]: https://github.com/pboling/shiftable/releases/tag/v0.1.0
-[0.1.1]: https://github.com/pboling/shiftable/releases/tag/v0.1.1
+
+[0.1.1]: https://github.com/pboling/shiftable/releases/tag/v0.1.1
+
+[0.2.0]: https://github.com/pboling/shiftable/releases/tag/v0.2.0
+
+[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

data/README.md

@@ -87,7 +87,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, preflight_checks: true,
+  extend Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, precheck: true,
                                before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
 end
 ```
@@ -100,8 +100,10 @@ class Spaceship < ActiveRecord::Base
   belongs_to :captain
 
   class << self
-    include Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, preflight_checks: true,
-                                  before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
+    include Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, precheck: true,
+                                  before_shift: lambda { |shifting:, shift_to:, shift_from:|
+                                    shifting.ownership_changes += 1
+                                  }
   end
 end
 ```
@@ -150,7 +152,7 @@ end
 
 class Spaceship < ActiveRecord::Base
   belongs_to :captain
-  extend Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, preflight_checks: true,
+  extend Shiftable::Single.new belongs_to: :captain, has_one: :spaceship, precheck: true,
                                before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
 
   belongs_to :space_federation

data/lib/shiftable/collection.rb

@@ -61,11 +61,12 @@ module Shiftable
     # Creates anonymous Ruby Modules, containing dynamically built methods
     module ShiftCollectionModulizer
       def to_mod(signature)
+        prefix = signature.method_prefix
         Module.new do
-          define_method(:"#{signature.mepr}shift_cx_column") do
+          define_method(:"#{prefix}shift_cx_column") do
             signature.shift_column
           end
-          define_method(:"#{signature.mepr}shift_cx") do |shift_to:, shift_from:|
+          define_method(:"#{prefix}shift_cx") do |shift_to:, shift_from:|
             signature.shift_data!(shift_to: shift_to, shift_from: shift_from)
           end
         end

data/lib/shiftable/mod_signature.rb

@@ -7,8 +7,8 @@ module Shiftable
       sg: %i[belongs_to has_one],
       cx: %i[belongs_to has_many]
     }.freeze
-    attr_accessor :associations, :options, :type
-    attr_reader :base
+    DEFAULT_BEFORE_SHIFT = ->(*_) { true }
+    attr_reader :associations, :options, :type, :base
 
     # Imagine you are a Spaceship Captain, the Spaceship belongs_to you, and it has only one Captain.
     # But you have to sell it to your nemesis!
@@ -22,12 +22,21 @@ module Shiftable
     end
 
     def validate
-      raise ArgumentError, "type must be one of: #{VALID_TYPES}, provided: #{type}" unless VALID_TYPES.include?(type)
-      raise ArgumentError, "associations must be symbols" if associations.keys.detect { |a| !a.is_a?(Symbol) }
-      raise ArgumentError, "exactly two distinct associations must be provided" unless associations.keys.uniq.length == 2
+      raise ArgumentError, "type must be one of: #{VALID_TYPES}, provided: #{type}" if invalid_type?
+      raise ArgumentError, "associations must be symbols" if invalid_association_key_type?
+      raise ArgumentError, "exactly two distinct associations must be provided" if invalid_number_of_associations?
+    end
+
+    def invalid_type?
+      !VALID_TYPES.include?(type)
+    end
 
-      invalid_tokens = associations.keys - VALID_ASSOCIATIONS[type]
-      raise ArgumentError, "valid associations: #{VALID_ASSOCIATIONS[type]}, invalid: #{invalid_tokens}" if invalid_tokens.any?
+    def invalid_association_key_type?
+      associations.keys.detect { |key| !key.is_a?(Symbol) }
+    end
+
+    def invalid_number_of_associations?
+      associations.keys.uniq.length != 2
     end
 
     # @note Chainable
@@ -45,8 +54,9 @@ module Shiftable
       bt = base.reflect_on_association(belongs_to)
       raise ArgumentError, "Unable to find belongs_to: :#{belongs_to} in #{base}" unless bt
 
-      hr = bt.klass.reflect_on_association(has_rel)
-      raise ArgumentError, "Unable to find #{has_rel_name}: :#{has_rel} in #{bt.klass}" unless hr
+      klass = bt.klass
+      hr = klass.reflect_on_association(has_rel)
+      raise ArgumentError, "Unable to find #{has_rel_name}: :#{has_rel} in #{klass}" unless hr
     end
 
     module CxMethods
@@ -56,30 +66,17 @@ module Shiftable
 
       alias has_rel has_many
 
-      # returns nil or ActiveRecord::Relation object
-      def data_for_shift(id)
-        base.where(send("shift_column") => id) if super
-      end
-
-      # returns false, nil or ActiveRecord::Relation object
-      def data_for_shift_safe(shift_to:, shift_from:)
-        return false unless super
-
-        data_for_shift(shift_from.id)
-      end
-
       def shift_data!(shift_to:, shift_from:)
         validate_relationships
-
-        shifting_rel = data_for_shift_safe(shift_to: shift_to, shift_from: shift_from)
-        return false unless shifting_rel && shifting_rel.any?
-
-        shifting_rel.each do |shifting|
-          shifting.send("#{send(:shift_column)}=", shift_to.id)
+        shifting_rel = ShiftingRelation.new(
+          to: shift_to,
+          from: shift_from,
+          column: shift_column,
+          base: base
+        )
+        shifting_rel.shift do |result|
+          before_shift&.call(shifting_rel: result, shift_to: shift_to, shift_from: shift_from)
         end
-        before_shift&.call(shifting_rel: shifting_rel, shift_to: shift_to, shift_from: shift_from)
-        shifting_rel.each(&:save)
-        shifting_rel
       end
     end
 
@@ -91,35 +88,23 @@ module Shiftable
       alias has_rel has_one
 
       # Do not move record if a record already exists (we are shifting a "has_one" association, after all)
-      def preflight_checks
-        options[:preflight_checks]
-      end
-
-      # returns nil or ActiveRecord object
-      def data_for_shift(id)
-        base.find_by(send("shift_column") => id) if super
-      end
-
-      # returns false, nil or ActiveRecord object
-      def data_for_shift_safe(shift_to:, shift_from:)
-        return false unless super
-
-        if preflight_checks
-          already_exists = shift_to.send(has_one)
-          return false if already_exists
-        end
-        data_for_shift(shift_from.id)
+      def precheck
+        options[:precheck]
       end
 
       def shift_data!(shift_to:, shift_from:)
         validate_relationships
-
-        shifting = data_for_shift_safe(shift_to: shift_to, shift_from: shift_from)
-        return false unless shifting
-
-        shifting.send("#{send(:shift_column)}=", shift_to.id)
-        shifting.save if before_shift.nil? || before_shift.call(shifting: shifting, shift_to: shift_to,
-                                                                shift_from: shift_from)
+        shifting = ShiftingRecord.new(
+          to: shift_to,
+          from: shift_from,
+          column: shift_column,
+          base: base
+        ) do
+          !precheck || !shift_to.send(has_one)
+        end
+        shifting.shift do |result|
+          before_shift&.call(shifting: result, shift_to: shift_to, shift_from: shift_from)
+        end
       end
     end
 
@@ -134,31 +119,15 @@ module Shiftable
       options[:method_prefix]
     end
 
-    alias mepr method_prefix
-
     # will prevent the save if it returns false
     # allows for any custom logic to be run, such as setting shift_from attributes, prior to the shift is saved.
     def before_shift
-      options[:before_shift]
+      options[:before_shift] || DEFAULT_BEFORE_SHIFT
     end
 
     def shift_column
       reflection = base.reflect_on_association(belongs_to).klass.reflect_on_association(has_rel)
       reflection.foreign_key
     end
-
-    # Effect is to short-circuit data_for_shift method prior to executing the ActiveRecord query
-    #   if there is no ID, to avoid a full table scan when no id provided,
-    #   e.g. where(id: nil).
-    def data_for_shift(id)
-      true if id
-    end
-
-    # Effect is to short-circuit data_for_shift_safe method prior to executing the ActiveRecord query
-    #   if there is no ID, to avoid a full table scan when no id provided,
-    #   e.g. where(id: nil).
-    def data_for_shift_safe(shift_to:, shift_from:)
-      true if shift_from&.id && shift_to&.id
-    end
   end
 end

data/lib/shiftable/shifting.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Shiftable
+  # Gets data to be shifted
+  class Shifting
+    attr_reader :to, :from, :column, :base, :result, :run_save
+
+    def initialize(to:, from:, column:, base:)
+      @to = to
+      @from = from
+      @column = column
+      @base = base
+      validate
+      do_query = block_given? ? yield : true
+      @result = do_query ? query : nil
+      @run_save = true
+    end
+
+    # def found?
+    #   raise "found? must be defined in a subclass"
+    # end
+
+    # def shift
+    #   raise "shift must be defined in a subclass"
+    # end
+
+    private
+
+    def validate
+      raise ArgumentError, "shift_to must have an id (primary key) value, but is: #{to&.id}" unless to&.id
+      raise ArgumentError, "shift_from must have an id (primary key) value, but is: #{from&.id}" unless from&.id
+    end
+
+    # def query
+    #   raise "query must be defined in a subclass"
+    # end
+  end
+end

data/lib/shiftable/shifting_record.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Shiftable
+  # Gets data to be shifted
+  class ShiftingRecord < Shifting
+    def found?
+      !!result
+    end
+
+    # @return true, false
+    def shift
+      return false unless found?
+
+      result.send("#{column}=", to.id)
+      @run_save = yield result if block_given?
+      result.save if run_save
+    end
+
+    private
+
+    def query
+      base.find_by(column => from.id)
+    end
+  end
+end

data/lib/shiftable/shifting_relation.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Shiftable
+  # Gets data to be shifted
+  class ShiftingRelation < Shifting
+    include Enumerable
+
+    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("#{column}=", to.id)
+      end
+      @run_save = yield result if block_given?
+      each(&:save) if run_save
+      result
+    end
+
+    private
+
+    def query
+      base.where(column => from.id)
+    end
+  end
+end

data/lib/shiftable/single.rb

@@ -13,7 +13,7 @@
 #     extend Shiftable::Single.new(
 #             belongs_to: :captain,
 #             has_one: :spaceship,
-#             preflight_checks: true,
+#             precheck: true,
 #             before_shift: ->(shifting:, shift_to:, shift_from:) { shifting.ownership_changes += 1 }
 #           )
 #   end
@@ -21,7 +21,7 @@
 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, preflight_checks: true, before_shift: nil)
+    def initialize(belongs_to:, has_one:, method_prefix: nil, precheck: true, before_shift: nil)
       # Ruby's Module initializer doesn't take any arguments
       super()
 
@@ -40,7 +40,7 @@ module Shiftable
         },
         options: {
           # Do not move record if a record already exists (we are shifting a "has_one" association, after all)
-          preflight_checks: preflight_checks,
+          precheck: precheck,
           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).
@@ -67,11 +67,12 @@ module Shiftable
     # Creates anonymous Ruby Modules, containing dynamically built methods
     module ShiftSingleModulizer
       def to_mod(signature)
+        prefix = signature.method_prefix
         Module.new do
-          define_method(:"#{signature.mepr}shift_column") do
+          define_method(:"#{prefix}shift_column") do
             signature.shift_column
           end
-          define_method(:"#{signature.mepr}shift_single") do |shift_to:, shift_from:|
+          define_method(:"#{prefix}shift_single") do |shift_to:, shift_from:|
             signature.shift_data!(shift_to: shift_to, shift_from: shift_from)
           end
         end

data/lib/shiftable/version.rb

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

data/lib/shiftable.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "shiftable/version"
+require_relative "shiftable/shifting"
+require_relative "shiftable/shifting_record"
+require_relative "shiftable/shifting_relation"
 require_relative "shiftable/mod_signature"
 require_relative "shiftable/collection"
 require_relative "shiftable/single"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiftable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -276,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -319,6 +333,9 @@ files:
 - lib/shiftable.rb
 - lib/shiftable/collection.rb
 - lib/shiftable/mod_signature.rb
+- lib/shiftable/shifting.rb
+- lib/shiftable/shifting_record.rb
+- lib/shiftable/shifting_relation.rb
 - lib/shiftable/single.rb
 - lib/shiftable/version.rb
 homepage: https://railsbling.com/tags/shiftable