acts_as_span 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec6db2024d649082face6a15ed22acffb3828ca67de3c54c509f940ade832eb
-  data.tar.gz: 67c0277e44d09fb7b5b73e4eb73327c4e8ff796109975f77f5afe42dc2120db3
+  metadata.gz: 59d6ed6e5f0b02d6d3683a99d62ac5f3b11ccdb5cf510f5bf1a3197e095102ff
+  data.tar.gz: 856975edeadab3d35def0a65e51bb6d65987fc2042cdec822d72b7c76741a9cb
 SHA512:
-  metadata.gz: 9fbe5d893be0359e262ed8cfb5d1fc58551317d103fc07098c1d5b6f5955fc95a520129c6d0d2493fda975681a9508484bc5550e17a187af9827fc867564ccc6
-  data.tar.gz: 9fc6775556dca3cd990b2988de635beb11311c683e4a104951faf33245b1f5b36ecdd3d66d501c57092a517e6bbba15ec181def50cbea01c6de5b50271bc377a
+  metadata.gz: cb1ae3e3c092a528e83d7dcb2fd9ca7d601b985eaa974b6eac1c1eb2634dc4630473dc5bfcafd548d3748a602569185cd803c2f7f6551c486dddcee1905e8205
+  data.tar.gz: 605657a4fb0114f18018b4aab29d9c2f9c63bf87321fe7c04ceaccb7974ad064dc4112ce3b7e5b44c8b541b65680e768e60ef54e8d43e1502ec59f27f46c797d

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.3
+ruby 2.6.5

data/.travis.yml

@@ -2,7 +2,11 @@ language: ruby
 rvm:
   - 2.4.5
   - 2.5.3
-  - 2.6.1
-before_install: gem install bundler
+  - 2.6.5
+
+# match the bundler version in the gemspec
+before_install:
+  - gem install -v 2.1.4 bundler --no-document
+  - bundle _2.1.4_ install
 notifications:
   email: false

data/acts_as_span.gemspec

@@ -1,39 +1,40 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "acts_as_span/version"
+# frozen_string_Literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'acts_as_span/version'
 
 Gem::Specification.new do |s|
-  s.name        = "acts_as_span"
+  s.name        = 'acts_as_span'
   s.version     = ActsAsSpan::VERSION::STRING
-  s.authors     = ["Eric Sullivan"]
-  s.email       = ["eric.sullivan@annkissam.com"]
-  s.homepage    = "https://github.com/annkissam/acts_as_span"
+  s.authors     = ['Eric Sullivan']
+  s.email       = ['eric.sullivan@annkissam.com']
+  s.homepage    = 'https://github.com/annkissam/acts_as_span'
   s.summary     = ActsAsSpan::VERSION::SUMMARY
-  s.description = %q{ActiveRecord model w/ a start_date and an end_date == ActsAsSpan}
-  s.license       = "MIT"
+  s.description = 'ActiveRecord model w/ a start_date and an end_date == ActsAsSpan'
+  s.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if s.respond_to?(:metadata)
-    s.metadata["allowed_push_host"] = "https://rubygems.org"
+    s.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-          "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
   end
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w[lib]
 
-  s.add_development_dependency "bundler", "~> 2.0.1"
-  s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "sqlite3", "~> 1.4"
-  s.add_development_dependency "has_siblings", "~> 0.2.7"
-  s.add_development_dependency "temping"
-  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency 'bundler', '~> 2.1.4'
+  s.add_development_dependency 'has_siblings', '~> 0.2.7'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake', '>= 12.3.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'sqlite3', '~> 1.4'
+  s.add_development_dependency 'temping'
 
-  s.add_runtime_dependency('activerecord', '>= 4.2.0')
-  s.add_runtime_dependency('activesupport', '>= 4.2.0')
+  s.add_runtime_dependency('activerecord', '>= 5.0.0')
+  s.add_runtime_dependency('activesupport', '>= 5.0.0')
 end

data/lib/acts_as_span/end_date_propagator.rb

@@ -70,12 +70,14 @@ module ActsAsSpan
   class EndDatePropagator
     attr_reader :object,
                 :errors_cache,
-                :skipped_classes
+                :skipped_classes,
+                :include_errors
 
-    def initialize(object, errors_cache: [], skipped_classes: [])
+    def initialize(object, errors_cache: [], skipped_classes: [], include_errors: true)
       @object = object
       @errors_cache = errors_cache
       @skipped_classes = skipped_classes
+      @include_errors = include_errors
     end
 
     # class-level call: enable the usage of ActsAsSpan::EndDatePropagator.call
@@ -88,7 +90,7 @@ module ActsAsSpan
       # only add new errors to the object
       result.errors.each do |error, message|
         unless object.errors[error].include? message
-          object.errors[error] << message
+          object.errors.add(error, message: message)
         end
       end
       object
@@ -108,8 +110,13 @@ module ActsAsSpan
         save_with_errors(object, child, propagated_child)
       end
 
-      # add just the strings, prevent ugly nested arrays in the view
-      object.errors[:base].push(*errors_cache.flatten)
+      if errors_cache.present?
+        errors_cache.each do |message|
+          skip if object.errors.added?(:base, message)
+
+          object.errors.add(:base, message: message)
+        end
+      end
 
       # return the object, with any newly-added errors
       object
@@ -119,13 +126,15 @@ module ActsAsSpan
     def assign_end_date(child, new_end_date)
       child.assign_attributes({ child.span.end_field => new_end_date })
       ActsAsSpan::EndDatePropagator.call(
-        child, errors_cache: errors_cache, skipped_classes: skipped_classes
+        child,
+        errors_cache: errors_cache,
+        skipped_classes: skipped_classes,
       )
     end
 
     # save the child record, add errors.
     def save_with_errors(object, child, propagated_child)
-      if object_has_errors?(propagated_child)
+      if object_has_errors?(propagated_child) && include_errors
         errors_cache << propagation_error_message(object, child)
       end
       child.save
@@ -136,11 +145,11 @@ module ActsAsSpan
         'propagation_failure',
         scope: %i[activerecord errors messages end_date_propagator],
         end_date_field_name: child.class.human_attribute_name(
-          child.span.end_field
+          child.span.end_field,
         ),
         parent: object.model_name.human,
         child: child.model_name.human,
-        reason: child.errors.full_messages.join('; ')
+        reason: child.errors.full_messages.join('; '),
       )
     end
 
@@ -163,8 +172,7 @@ module ActsAsSpan
 
     # Use acts_as_span to determine whether a record has an end date
     def should_propagate_to?(klass)
-      klass.respond_to?(:span) &&
-        @skipped_classes.exclude?(klass)
+      klass.respond_to?(:span) && @skipped_classes.exclude?(klass)
     end
 
     def child_associations(object)

data/lib/acts_as_span/no_overlap_validator.rb

@@ -42,9 +42,10 @@ module ActsAsSpan
 
       return unless overlapping_records.any? && instance_scope
 
+      error_message = options[:message] || :no_overlap
       record.errors.add(
         :base,
-        :no_overlap,
+        error_message,
         model_name: record.class.model_name.human,
         model_name_plural: record.class.model_name.plural.humanize,
         start_date: record.span.start_date,

data/lib/acts_as_span/span_instance.rb

@@ -33,5 +33,13 @@ module ActsAsSpan
     def end_date
       span_model[end_field]
     end
+
+    def start_date_changed?
+      span_model.will_save_change_to_attribute?(start_field)
+    end
+
+    def end_date_changed?
+      span_model.will_save_change_to_attribute?(end_field)
+    end
   end
 end

data/lib/acts_as_span/span_klass/status.rb

@@ -8,10 +8,7 @@ module ActsAsSpan
       included do
         def current(query_date = Date.current)
           klass.where(
-            (arel_table[start_field].lteq(query_date).or(arel_table[start_field].eq(nil))).
-            and(
-              arel_table[end_field].eq(nil).or(arel_table[end_field].gteq(query_date))
-            )
+            current_condition(query_date: query_date, table: arel_table)
           )
         end
 
@@ -44,6 +41,19 @@ module ActsAsSpan
         end
 
         alias_method :current_or_future, :current_or_future_on
+
+        private
+
+        # returns an Arel node usable within an ActiveRecord `where` clause
+        def current_condition(query_date:, table:)
+          start_col = arel_table[start_field]
+          end_col = arel_table[end_field]
+
+          start_condition = start_col.lteq(query_date).or(start_col.eq(nil))
+          end_condition = end_col.eq(nil).or(end_col.gteq(query_date))
+
+          start_condition.and(end_condition)
+        end
       end
     end
   end

data/lib/acts_as_span/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_Literal: true
+
 module ActsAsSpan
   module VERSION
     MAJOR = 1
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/acts_as_span/within_parent_date_span_validator.rb

@@ -3,8 +3,10 @@ module ActsAsSpan
     def validate(record)
       parents = options[:parent] || options[:parents]
 
+      error_message = options[:message] || :not_within_parent_date_span
+
       Array(parents).each do |parent|
-        record.errors.add(:base, :not_within_parent_date_span, parent: record.class.human_attribute_name(parent)) if outside_of_parent_date_span?(record, parent)
+        record.errors.add(:base, error_message, parent: record.class.human_attribute_name(parent)) if outside_of_parent_date_span?(record, parent)
       end
     end
 

data/spec/lib/end_date_propagator_spec.rb

@@ -3,13 +3,16 @@ require 'spec_helper'
 RSpec.describe ActsAsSpan::EndDatePropagator do
   let(:end_date_propagator) do
     ActsAsSpan::EndDatePropagator.new(
-      base_instance, skipped_classes: skipped_classes
+      base_instance, skipped_classes: skipped_classes,
+      include_errors: include_errors
     )
   end
 
   let(:base_instance) do
     Base.create(end_date: initial_end_date)
   end
+
+  let(:include_errors) { true }
   let(:initial_end_date) { nil }
 
   let(:other_base_instance) do
@@ -102,28 +105,38 @@ RSpec.describe ActsAsSpan::EndDatePropagator do
     end
 
     context 'when multiple child records are not valid' do
-      before do
-        child_instance.date_of_birth = base_instance.span.start_date - 1
-        child_instance.save(validate: false)
-        bird_instance.start_date = child_instance.span.start_date - 1
-        bird_instance.save(validate: false)
-      end
-      it "the parent gains all children's errors" do
-        expect(
-          end_date_propagator.call.errors.values.join
-        ).to include(
-          I18n.t(
-            'not_within_parent_date_span',
-            parent: 'Child',
-            scope: %i[activerecord errors messages]
-          )
-        ).and include(
-          I18n.t(
-            'not_within_parent_date_span',
-            parent: 'Base',
-            scope: %i[activerecord errors messages]
+      context 'when include_errors = true (default)' do
+        before do
+          child_instance.date_of_birth = base_instance.span.start_date - 1
+          child_instance.save(validate: false)
+          bird_instance.start_date = child_instance.span.start_date - 1
+          bird_instance.save(validate: false)
+        end
+        it "the parent gains all children's errors" do
+          expect(
+            end_date_propagator.call.errors.values.join
+          ).to include(
+            I18n.t(
+              'not_within_parent_date_span',
+              parent: 'Child',
+              scope: %i[activerecord errors messages]
+            )
+          ).and include(
+            I18n.t(
+              'not_within_parent_date_span',
+              parent: 'Base',
+              scope: %i[activerecord errors messages]
+            )
           )
-        )
+        end
+      end
+
+      context 'when include_errors = false' do
+        let(:include_errors) { false }
+
+        it 'does not push any child errors' do
+          expect(end_date_propagator.call.errors.values).to be_empty
+        end
       end
     end
   end

data/spec/lib/no_overlap_validator_spec.rb

@@ -116,4 +116,14 @@ RSpec.describe ActsAsSpan::NoOverlapValidator do
       end
     end
   end
+
+  describe 'error messages' do
+    let(:child_class) { OneParentChildCustom }
+    let(:new_child_start_date) { sister_start_date }
+    let(:new_child_end_date) { sister_end_date }
+    it 'allows using custom error messages' do
+      expect(new_child).not_to be_valid
+      expect(new_child.errors.messages[:base]).to include('Custom error message')
+    end
+  end
 end

data/spec/lib/span_instance_spec.rb

@@ -12,5 +12,17 @@ RSpec.describe "Span" do
     it "should return the end_date" do
       expect(span.end_date).to eq(span_model.end_date)
     end
+
+    context "changed?" do
+      it 'returns true when start_date has changed' do
+        span_model.start_date = span_model.start_date + 5
+        expect(span.start_date_changed?).to eq(true)
+      end
+
+      it 'returns true when end_date has changed' do
+        span_model.end_date = span_model.end_date + 5
+        expect(span.end_date_changed?).to eq(true)
+      end
+    end
   end
 end

data/spec/lib/span_klass/status_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActsAsSpan::SpanKlass::Status do
+  let(:span_klass) { ::SpanModel }
+
+  let!(:today) { Date.current }
+
+  describe '.current' do
+    let!(:record) do
+      span_klass.create(
+        start_date: today - 1.week,
+        end_date: today + 1.week,
+      )
+    end
+
+    subject { span_klass.current(query_date) }
+
+    context "when query_date is within the record's span" do
+      let(:query_date) { record.start_date + 3.days }
+
+      it { is_expected.not_to be_empty }
+    end
+
+    context "when query_date is before the record's span" do
+      let(:query_date) { record.start_date - 1.week }
+
+      it { is_expected.to be_empty }
+    end
+
+    context "when query_date is after the record's span" do
+      let(:query_date) { record.end_date + 1.week }
+
+      it { is_expected.to be_empty }
+    end
+  end
+end

data/spec/lib/within_parent_date_span_validator_spec.rb

@@ -112,4 +112,15 @@ RSpec.describe ActsAsSpan::WithinParentDateSpanValidator do
       end
     end
   end
+
+  describe 'error messages' do
+    let(:child_class) { OneParentChildCustom }
+    let(:new_child_start_date) { mama_start_date - 3.days }
+    let(:new_child_end_date) { mama_end_date + 5.days }
+
+    it 'allows using custom error messages' do
+      expect(new_child).not_to be_valid
+      expect(new_child.errors.messages[:base]).to include('Custom error message')
+    end
+  end
 end

data/spec/spec_models.rb

@@ -47,6 +47,32 @@ Temping.create :one_parent_child do
   validates_with ActsAsSpan::WithinParentDateSpanValidator, parents: [:mama]
 end
 
+Temping.create :one_parent_child_custom do
+  with_columns do |t|
+    t.belongs_to :mama
+
+    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 }, instance_scope: proc { favorite? }, message: 'Custom error message'
+  validates_with ActsAsSpan::WithinParentDateSpanValidator, parents: [:mama], message: 'Custom error message'
+end
+
+
 Temping.create :two_parent_child do
   with_columns do |t|
     t.belongs_to :mama
@@ -76,6 +102,7 @@ Temping.create :mama do
 
   has_many :one_parent_children
   has_many :two_parent_children
+  has_many :one_parent_child_customs
 end
 
 Temping.create :papa do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_span
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Sullivan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,86 +16,86 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: has_siblings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.2.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: has_siblings
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: temping
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: temping
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
 description: ActiveRecord model w/ a start_date and an end_date == ActsAsSpan
 email:
 - eric.sullivan@annkissam.com
@@ -173,6 +173,7 @@ files:
 - spec/lib/span_instance/status_spec.rb
 - spec/lib/span_instance/validations_spec.rb
 - spec/lib/span_instance_spec.rb
+- spec/lib/span_klass/status_spec.rb
 - spec/lib/within_parent_date_span_validator_spec.rb
 - spec/spec_helper.rb
 - spec/spec_models.rb
@@ -181,7 +182,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,10 +197,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: acts_as_span 1.1.1
+summary: acts_as_span 1.2.0
 test_files:
 - spec/lib/acts_as_span_spec.rb
 - spec/lib/delegation_spec.rb
@@ -211,6 +212,7 @@ test_files:
 - spec/lib/span_instance/status_spec.rb
 - spec/lib/span_instance/validations_spec.rb
 - spec/lib/span_instance_spec.rb
+- spec/lib/span_klass/status_spec.rb
 - spec/lib/within_parent_date_span_validator_spec.rb
 - spec/spec_helper.rb
 - spec/spec_models.rb