periodic_records 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1685c4f8eea74df267aa354a27ccba8ba236530
-  data.tar.gz: 3ed7467ca7261f600cece03aa886fb0e59b57bf4
+  metadata.gz: ebc5b792de6c66cc8f858666775da5acbbbf67f2
+  data.tar.gz: 5f60cdab069337f62b3af5516035845f77aee527
 SHA512:
-  metadata.gz: 1d1aa12982eec539b6adb4dc1a6b7ddd9631c221a122d6995ad2827ecdc27aeaeb6f3ef06ffefc05e15747a303f42ca2323fe3d55bee99bce074e1e3e0d71d35
-  data.tar.gz: be8021adfcf1f8341335ee20f466d06f5630a5dae7e368088ad9ab12026d162f9d8aa0f87511d8d06dedb93103032b209a4e3719a50661a7e65f8f5140bcd206
+  metadata.gz: 94286105001f6fa005c6f40d162fb5d5d6058069eb1a65c9983d77ed307ad6246bf1c511e5dc7109508431c925cbd38b006776025ceae40928362b77295ce5a4
+  data.tar.gz: 9b8072aacca8ed7e270662715b23d5dbdd19d043232a79d52e30922aa4eae30d2d7ac260d7b885e43e1c350d07396a0e274dc58c584abdb183888de29828ef83

data/.travis.yml

@@ -1,3 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+env:
+  - "RAILS_VERSION=5.1.0"
+  - "RAILS_VERSION=5.2.0.beta2"

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2018-01-16
+
+- Support gapless records #2
+
 ## [0.2.1] - 2016-09-27
 
 - Relax dependencies for Rails 5 compatibility

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in periodic_records.gemspec
 gemspec
+
+if ENV['RAILS_VERSION']
+  gem 'activerecord',  "~> #{ENV['RAILS_VERSION']}"
+  gem 'activesupport', "~> #{ENV['RAILS_VERSION']}"
+end

data/README.md

@@ -15,25 +15,25 @@ employment history.
 
 Employees:
 
-id | name
----|------
-1  | John
+| id | name |
+|:---|:-----|
+| 1  | John |
 
 Employee assignments:
 
-id | employee_id | start_at   | end_at     | job_title
----|-------------|------------|------------|----------
-1  | 1           | 2014-01-01 | 9999-01-01 | Developer
+| id | employee_id | start_at   | end_at     | job_title |
+|:---|:------------|:-----------|:-----------|:----------|
+| 1  | 1           | 2014-01-01 | 9999-01-01 | Developer |
 
 Now John is promoted to "Senior Developer" and you create a new employee
 assignment record and this gem will take care of adjusting and splitting
 overlapping records. In this case it will adjust the `end_at` field for the
 previous assignment.
 
-id | employee_id | start_at   | end_at     | job_title
----|-------------|------------|------------|-----------------
-1  | 1           | 2014-01-01 | 2018-05-04 | Developer
-2  | 1           | 2018-05-05 | 9999-01-01 | Senior Developer
+| id | employee_id | start_at   | end_at     | job_title        |
+|:---|:------------|:-----------|:-----------|:-----------------|
+| 1  | 1           | 2014-01-01 | 2018-05-04 | Developer        |
+| 2  | 1           | 2018-05-05 | 9999-01-01 | Senior Developer |
 
 
 ## Installation
@@ -151,6 +151,60 @@ class AddEmployeeAssignmentsOverlappingDatesConstraint < ActiveRecord::Migration
 end
 ```
 
+## Gapless records
+
+If you want to avoid gaps between records, you can include also `PeriodicRecords::Gapless`.
+
+```ruby
+class EmployeeAssignment < ActiveRecord::Base
+  include PeriodicRecords::Model
+  include PeriodicRecords::Gapless
+
+  belongs_to :employee
+
+  def siblings
+    self.class.where(employee_id: employee_id).where.not(id: id)
+  end
+end
+```
+
+Example:
+
+| id | employee_id | start_at   | end_at     | job_title        |
+|:---|:------------|:-----------|:-----------|:-----------------|
+| 1  | 1           | 0001-01-01 | 2018-01-15 | Junior Developer |
+| 2  | 1           | 2018-01-16 | 2018-02-15 | Developer        |
+| 3  | 1           | 2018-02-16 | 9999-01-01 | Senior Developer |
+
+If you update #2 from `2018-01-16 - 2018-02-15` to `2018-01-20 - 2018-02-10`, it
+will also adjust end at for #1 and start at for #3 to avoid gaps between records.
+
+After (with `Gapless`):
+
+| id | employee_id | start_at   | end_at     | job_title        |
+|:---|:------------|:-----------|:-----------|:-----------------|
+| 1  | 1           | 0001-01-01 | 2018-01-19 | Junior Developer |
+| 2  | 1           | 2018-01-20 | 2018-02-10 | Developer        |
+| 3  | 1           | 2018-02-11 | 9999-01-01 | Senior Developer |
+
+After (without `Gapless`):
+
+| id | employee_id | start_at   | end_at     | job_title        |
+|:---|:------------|:-----------|:-----------|:-----------------|
+| 1  | 1           | 0001-01-01 | 2018-01-15 | Junior Developer |
+| 2  | 1           | 2018-01-20 | 2018-02-10 | Developer        |
+| 3  | 1           | 2018-02-16 | 9999-01-01 | Senior Developer |
+
+If you delete #2 then it will adjust end at for #1.
+
+You will not be able to delete entry that is at the beginning (#1) or at the end (#3).
+
+You will not be able to adjust start at for the beginning entry (#1).
+
+You will not be able to adjust end at for the ending entry (#3).
+
+For more examples see [gapless_spec.rb](spec/periodic_records/gapless_spec.rb]).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/periodic_records/gapless.rb

@@ -0,0 +1,76 @@
+module PeriodicRecords
+  module Gapless
+    extend ActiveSupport::Concern
+
+    included do
+      validate :validate_gapless_start_at, if: :gapless?
+      validate :validate_gapless_end_at, if: :gapless?
+      after_save :adjust_gaps, if: :gapless?
+      before_destroy :before_gapless_destroy, if: :gapless?
+      after_destroy :after_gapless_destroy, if: :gapless?
+    end
+
+    private
+
+    def gapless?
+      true
+    end
+
+    def validate_gapless_start_at
+      if start_at_changed? && start_at_was == self.class::MIN
+        errors.add :start_at, :invalid
+      end
+    end
+
+    def validate_gapless_end_at
+      if end_at_changed? && end_at_was == self.class::MAX
+        errors.add :end_at, :invalid
+      end
+    end
+
+    def adjust_gaps
+      adjust_previous_gap
+      adjust_next_gap
+    end
+
+    def adjust_previous_gap
+      if saved_change_to_start_at? && start_at && start_at_before_last_save && start_at > start_at_before_last_save
+        previous_record = siblings.where(end_at: start_at_before_last_save - 1.day).first
+        if previous_record
+          previous_record.end_at = start_at - 1.day
+          previous_record.save(validate: false)
+        end
+      end
+    end
+
+    def adjust_next_gap
+      if saved_change_to_end_at? && end_at && end_at_before_last_save && end_at_before_last_save > end_at
+        next_record = siblings.where(start_at: end_at_before_last_save + 1.day).first
+        if next_record
+          next_record.start_at = end_at + 1.day
+          next_record.save(validate: false)
+        end
+      end
+    end
+
+    def before_gapless_destroy
+      if start_at == self.class::MIN
+        errors.add :start_at, :invalid
+      end
+      if end_at == self.class::MAX
+        errors.add :end_at, :invalid
+      end
+      unless errors.empty?
+        throw :abort
+      end
+    end
+
+    def after_gapless_destroy
+      previous_record = siblings.where(end_at: start_at - 1.day).first
+      if previous_record
+        previous_record.end_at = end_at
+        previous_record.save(validate: false)
+      end
+    end
+  end
+end

data/lib/periodic_records/model.rb

@@ -49,7 +49,7 @@ module PeriodicRecords
     end
 
     def overlapping_records
-      @overlapping_records ||= siblings.within_interval(start_at, end_at)
+      siblings.within_interval(start_at, end_at)
     end
 
     def adjust_overlapping_records

data/lib/periodic_records/version.rb

@@ -1,3 +1,3 @@
 module PeriodicRecords
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/periodic_records.rb

@@ -1,5 +1,6 @@
 require "periodic_records/version"
 require "periodic_records/model"
+require "periodic_records/gapless"
 require "periodic_records/associations"
 
 module PeriodicRecords

data/periodic_records.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", ">= 4"
-  spec.add_runtime_dependency "activesupport", ">= 4"
+  spec.add_runtime_dependency "activerecord", ">= 5.1"
+  spec.add_runtime_dependency "activesupport", ">= 5.1"
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodic_records
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Edgars Beigarts
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,7 @@ files:
 - bin/setup
 - lib/periodic_records.rb
 - lib/periodic_records/associations.rb
+- lib/periodic_records/gapless.rb
 - lib/periodic_records/model.rb
 - lib/periodic_records/version.rb
 - periodic_records.gemspec
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Support functions for ActiveRecord models with periodic entries