acts_as_span 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57404b0d110113b5f9c52537aa90970a560d69f4a5b7d5d318caacc229157679
-  data.tar.gz: 5702fafe912d1bc56b633aec32dd2ae76da9f886608c182eed29c0ca7d2ed509
+  metadata.gz: fec6db2024d649082face6a15ed22acffb3828ca67de3c54c509f940ade832eb
+  data.tar.gz: 67c0277e44d09fb7b5b73e4eb73327c4e8ff796109975f77f5afe42dc2120db3
 SHA512:
-  metadata.gz: b1e7265d3cfc7433b331f407fe991eb5549091e10c5dcef0298468099f1769dfaca71a7355363af8f6f88c381362d518fa494366d3f1dead8de8072458d95b2c
-  data.tar.gz: 6304cb8600c553e60bc7e470ed4f87e6cc145a4239243f5109556278f76d88b24d1624bbc904e499d7ce95d7196967d4d8822c962571c9184c875dbd20d6d57f
+  metadata.gz: 9fbe5d893be0359e262ed8cfb5d1fc58551317d103fc07098c1d5b6f5955fc95a520129c6d0d2493fda975681a9508484bc5550e17a187af9827fc867564ccc6
+  data.tar.gz: 9fc6775556dca3cd990b2988de635beb11311c683e4a104951faf33245b1f5b36ecdd3d66d501c57092a517e6bbba15ec181def50cbea01c6de5b50271bc377a

data/lib/acts_as_span/no_overlap_validator.rb

@@ -1,51 +1,83 @@
+# frozen_string_literal: true
+
 require 'active_model'
 
 module ActsAsSpan
+  # Validator that checks whether a record is overlapping with others
+  #
+  # Takes options `:instance_scope` (optional) and `:scope` (required):
+  # * `instance_scope` is a proc which, when evaluated by the record, returns
+  #   a boolean value. When false, the validatior will not check for overlap.
+  #   When true, the validator checks normally.
+  # * `scope` is also a proc. This is must return an ActiveRecord Relation that
+  #   determines which records' spans to compare.
+  #
+  # Usage:
+  # Given a record with `siblings` defined, the most basic use case is:
+  # ```
+  # validates_with ActsAsSpan::NoOverlapValidator,
+  #   scope: proc { siblings }
+  # ```
+  # When this record is validated, every record in the ActiveRecord relation
+  #   `record.siblings` is checked for mutual overlap with `record`.
+  #
+  # Use `instance_scope` if there is some condition where a record oughtn't be
+  #   validated for whatever reason:
+  # ```
+  # validates_with ActsAsSpan::NoOverlapValidator,
+  #   scope: proc { siblings }, instance_scope: proc { favorite? }
+  # ```
+  # Now, when this record is validated, if `record.favorite?` is `true`,
+  #   `record` must pass the overlap check with its siblings.
+  #   If `record.favorite?` is `false`, it is under less scrutiny.
+  #
   class NoOverlapValidator < ActiveModel::Validator
     def validate(record)
       overlapping_records = temporally_overlapping_for(record)
       instance_scope = if options[:instance_scope].is_a? Proc
-                         record.instance_eval&options[:instance_scope]
+                         record.instance_eval(&options[:instance_scope])
                        else
                          true
                        end
 
-      if overlapping_records.any? && instance_scope
-
-        record.errors.add(
-          :base,
-          :no_overlap,
-          model_name: record.class.model_name.human,
-          model_name_plural: record.class.model_name.plural.humanize,
-          start_date: record.span.start_date,
-          end_date: record.span.end_date,
-          count: overlapping_records.size,
-          overlapping_records_s: overlapping_records.join(",")
-        )
-      end
+      return unless overlapping_records.any? && instance_scope
+
+      record.errors.add(
+        :base,
+        :no_overlap,
+        model_name: record.class.model_name.human,
+        model_name_plural: record.class.model_name.plural.humanize,
+        start_date: record.span.start_date,
+        end_date: record.span.end_date,
+        count: overlapping_records.size,
+        overlapping_records_s: overlapping_records.join(', ')
+      )
     end
 
-    #TODO add back condition for start_date nil
-    #TODO add support for multiple spans (currently only checks :default)
+    # TODO: add back condition for start_date nil
+    # TODO: add support for multiple spans (currently only checks :default)
     def temporally_overlapping_for(record)
       scope = record.instance_eval(&options[:scope])
 
       start_date = record.span.start_date || Date.current
+
       end_date = record.span.end_date
+      end_field = record.span.end_field
+
       arel_table = record.class.arel_table
 
       if end_date
         scope.where(
           arel_table[record.span.start_field].lteq(end_date)
           .and(
-            arel_table[record.span.end_field].gteq(start_date)
-          .or(arel_table[record.span.end_field].eq(nil))
+            arel_table[end_field].gteq(start_date)
+          .or(arel_table[end_field].eq(nil))
           )
         )
       else
         scope.where(
-          arel_table[record.span.end_field].gteq(start_date)
-          .or(arel_table[record.span.end_field].eq(nil))
+          arel_table[end_field].gteq(start_date)
+          .or(arel_table[end_field].eq(nil))
         )
       end
     end

data/lib/acts_as_span/version.rb

@@ -2,7 +2,7 @@ module ActsAsSpan
   module VERSION
     MAJOR = 1
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/spec/lib/no_overlap_validator_spec.rb

@@ -42,6 +42,29 @@ RSpec.describe ActsAsSpan::NoOverlapValidator do
 
   let(:all_siblings) { [brother, sister, brother_from_another_mother] }
 
+  describe 'instance_scope' do
+    let(:child_class) { OneParentChild }
+
+    let(:new_child_start_date) { Date.current - 2 }
+    let(:new_child_end_date) { Date.current + 3 }
+
+    before { new_child.favorite = favorite }
+
+    context 'when instance_scope evaluates to false' do
+      let(:favorite) { false }
+      it 'skips validation on the record for which instance_scope is false' do
+        expect(new_child).to be_valid
+      end
+    end
+
+    context 'when instance_scope evaluates to true' do
+      let(:favorite) { true }
+      it 'validates normally' do
+        expect(new_child).not_to be_valid
+      end
+    end
+  end
+
   describe 'an object with a single parent' do
     let(:child_class) { OneParentChild }
 

data/spec/spec_models.rb

@@ -28,14 +28,22 @@ Temping.create :one_parent_child do
 
     t.date :start_date
     t.date :end_date
+
+    # every one-parent child is a favorite! ...by default
+    t.boolean :favorite, default: true
   end
 
   acts_as_span
 
+  def favorite?
+    favorite
+  end
+
   belongs_to :mama
   has_siblings through: [:mama]
 
-  validates_with ActsAsSpan::NoOverlapValidator, scope: proc { siblings }
+  validates_with ActsAsSpan::NoOverlapValidator,
+    scope: proc { siblings }, instance_scope: proc { favorite? }
   validates_with ActsAsSpan::WithinParentDateSpanValidator, parents: [:mama]
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_span
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Eric Sullivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,7 +199,7 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: acts_as_span 1.1.0
+summary: acts_as_span 1.1.1
 test_files:
 - spec/lib/acts_as_span_spec.rb
 - spec/lib/delegation_spec.rb