periodic_records 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0429dc9d8d852306fb1ef7f6d97ea8111189fd0
+  data.tar.gz: 62588c2e384ae43407036906f73b4378ced4f7d3
+SHA512:
+  metadata.gz: 798fe949cd0c014f0961211a1f98641ccbcdaa414821810f317e3c0a2078e6ba3e734ac5649f0e63af89544dccd66703119ba4a16898abd87fb236f009a0aaa4
+  data.tar.gz: 52a122f179ab08dc6749f610bc438abe5eeb7caaf3f8134fe70719c05f39b40c7b18add41c9bea33a5681c629a88cfa136ce02a93dcf13b7de801a40dd7076b3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in periodic_records.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Toms Mikoss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# PeriodicRecords
+
+[![Build Status](https://travis-ci.org/mak-it/periodic_records.svg?branch=master)](https://travis-ci.org/mak-it/periodic_records)
+
+Support functions for ActiveRecord models with periodic entries.
+
+* Supports periods where the smallest unit is a whole day
+* Adjusts and splits overlapping records
+* Preloads currently active records to avoid N+1 queries
+* Easy querying within history - join returns 0..1 records (no grouping needed)
+  `LEFT JOIN ... ON ... AND <date> BETWEEN start_at AND end_at`
+
+For example you have employees table and assignments table that stores all the
+employment history.
+
+Employees:
+
+id | name
+---|------
+1  | John
+
+Employee assignments:
+
+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
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'periodic_records'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install periodic_records
+```
+
+## Preparation
+
+Ensure `start_at` and `end_at` date columns on the model that will have
+periodic versions.
+Include `PeriodicRecords::Model` and define `siblings` method:
+
+```ruby
+class EmployeeAssignment < ActiveRecord::Base
+  include PeriodicRecords::Model
+
+  belongs_to :employee
+
+  def siblings
+    self.class.where(employee_id: employee_id).where.not(id: id)
+  end
+end
+```
+
+Include `PeriodicRecords::Associations` in the model that has periodic
+associations, and call `has_periodic`:
+
+```ruby
+class Employee < ActiveRecord::Base
+  include PeriodicRecords::Associations
+
+  has_many :employee_assignments, inverse_of: :employee
+  has_periodic :employee_assignments, as: :assignments
+end
+```
+
+## Usage
+
+Look up the currently active record with `model.current_association`:
+
+```ruby
+employee.current_assignment
+```
+
+Look up records for specific date or period
+with `within_date` and `within_interval`:
+
+```ruby
+employee.employee_assignments.within_date(Date.tomorrow)
+```
+
+```ruby
+employee.employee_assignments.within_interval(Date.current.beginning_of_month...Date.current.end_of_month)
+```
+
+Look up records starting with specific date with `from_date`
+
+```ruby
+employee.employee_assignments.from_date(Date.tomorrow)
+```
+
+Preload currently active records, to avoid N+1 queries on `current_assignment`.
+
+```ruby
+employees = Employee.all
+Employee.preload_current_assignments(employees)
+employees.each do |employee|
+  puts employee.current_assignment.to_s
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release` to create a git tag for the version,
+push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/mak-it/periodic_records/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require 'active_record'
+require 'active_support/all'
+
+require "periodic_records"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/periodic_records.rb

@@ -0,0 +1,6 @@
+require "periodic_records/version"
+require "periodic_records/model"
+require "periodic_records/associations"
+
+module PeriodicRecords
+end

data/lib/periodic_records/associations.rb

@@ -0,0 +1,73 @@
+module PeriodicRecords
+  module Associations
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_periodic(association, as: nil)
+        as ||= association
+        define_periodic_preload_method(association, as)
+        define_periodic_default_method(association, as)
+        define_periodic_current_method(association, as)
+      end
+
+      private
+
+      def define_periodic_preload_method(association, as)
+        method_name = "preload_current_#{as}"
+        accessor_name = "current_#{as.to_s.singularize}"
+        define_singleton_method method_name do |records, *associations|
+          reflection = reflections[association]
+          records_hash = {}
+          records.each do |record|
+            record.send("#{accessor_name}=", nil)
+            records_hash[record.id] = record
+          end
+          states = reflection.klass.current.
+            where(reflection.foreign_key => records_hash.keys)
+          states.each do |state|
+            record = records_hash[state.send(reflection.foreign_key)]
+            record.send("#{accessor_name}=", state)
+            state.send("#{reflection.inverse_of.name}=", record)
+          end
+          unless associations.empty?
+            ActiveRecord::Associations::Preloader.new.
+              preload(states, associations)
+          end
+        end
+      end
+
+      # def default_assignment
+      #   @default_assignment ||= employee_assignments.new
+      # end
+      def define_periodic_default_method(association, as)
+        accessor_name = "default_#{as.to_s.singularize}"
+        define_method accessor_name do
+          instance_variable_get("@#{accessor_name}") ||
+          instance_variable_set("@#{accessor_name}", send(association).new)
+        end
+      end
+
+      # attr_writer :current_assignment
+      # def current_assignment
+      #   unless defined?(@current_assignment)
+      #     @current_assignment = \
+      #       employee_assignments.to_a.find(&:current?) ||
+      #       default_assignment
+      #   end
+      #   @current_assignment
+      # end
+      def define_periodic_current_method(association, as)
+        accessor_name = "current_#{as.to_s.singularize}"
+        attr_writer accessor_name
+        define_method accessor_name do
+          unless instance_variable_defined?("@#{accessor_name}")
+            current = send(association).to_a.find(&:current?)
+            value = current || send("default_#{as.to_s.singularize}")
+            instance_variable_set("@#{accessor_name}", value)
+          end
+          instance_variable_get("@#{accessor_name}")
+        end
+      end
+    end
+  end
+end

data/lib/periodic_records/model.rb

@@ -0,0 +1,114 @@
+module PeriodicRecords
+  module Model
+    extend ActiveSupport::Concern
+
+    MIN = Date.new(0001, 1, 1)
+    MAX = Date.new(9999, 1, 1)
+
+    included do
+      validates_presence_of :start_at, :end_at
+      validate :validate_dates
+
+      after_initialize :set_default_period, if: :set_default_period_after_initialize?
+      after_save :adjust_overlaping_records
+    end
+
+    module ClassMethods
+      def within_interval(start_date, end_date)
+        t = arel_table
+        where(t[:start_at].lteq(end_date)).
+        where(t[:end_at].gteq(start_date))
+      end
+
+      def within_date(date)
+        within_interval(date, date)
+      end
+
+      def current
+        date = Date.current
+        within_date(date)
+      end
+
+      def from_date(date)
+        t = arel_table
+        where(t[:end_at].gteq(date))
+      end
+    end
+
+    def current?
+      date = Date.current
+      within_interval?(date, date)
+    end
+
+    def within_interval?(start_date, end_date)
+      start_at && end_at && start_at <= end_date && end_at >= start_date
+    end
+
+    def siblings
+      raise NotImplementedError
+    end
+
+    def overlaping_records
+      @overlaping_records ||= siblings.within_interval(start_at, end_at)
+    end
+
+    def adjust_overlaping_records
+      overlaping_records.each do |overlaping_record|
+        if overlaping_record.start_at >= start_at &&
+             overlaping_record.end_at <= end_at
+          destroy_overlaping_record(overlaping_record)
+        elsif overlaping_record.start_at < start_at &&
+                overlaping_record.end_at > end_at
+          split_overlaping_record(overlaping_record)
+        elsif overlaping_record.start_at < start_at
+          adjust_overlaping_record_end_at(overlaping_record)
+        elsif overlaping_record.end_at > end_at
+          adjust_overlaping_record_start_at(overlaping_record)
+        end
+      end
+    end
+
+    def set_default_period_after_initialize?
+      new_record?
+    end
+
+    private
+
+    def set_default_period
+      self.start_at ||= Date.current
+      self.end_at   ||= MAX
+    end
+
+    def destroy_overlaping_record(overlaping_record)
+      overlaping_record.destroy
+    end
+
+    def split_overlaping_record(overlaping_record)
+      overlaping_record_end = overlaping_record.dup
+      overlaping_record_end.start_at = end_at + 1.day
+      overlaping_record_end.end_at   = overlaping_record.end_at
+
+      overlaping_record_start = overlaping_record
+      overlaping_record_start.end_at = start_at - 1.day
+
+      overlaping_record_start.save(validate: false)
+      overlaping_record_end.save(validate: false)
+    end
+
+    def adjust_overlaping_record_end_at(overlaping_record)
+      overlaping_record.end_at = start_at - 1.day
+      overlaping_record.save(validate: false)
+    end
+
+    def adjust_overlaping_record_start_at(overlaping_record)
+      overlaping_record.start_at = end_at + 1.day
+      overlaping_record.save(validate: false)
+    end
+
+    def validate_dates
+      if start_at && end_at && end_at < start_at
+        errors.add :end_at, :invalid
+      end
+    end
+  end
+end

data/lib/periodic_records/version.rb

@@ -0,0 +1,3 @@
+module PeriodicRecords
+  VERSION = "0.1.0"
+end

data/periodic_records.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'periodic_records/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "periodic_records"
+  spec.version       = PeriodicRecords::VERSION
+  spec.authors       = ["Edgars Beigarts", "Toms Mikoss"]
+  spec.email         = ["edgars.beigarts@makit.lv", "toms.mikoss@makit.lv"]
+
+  spec.summary       = %q{Support functions for ActiveRecord models with periodic entries}
+  spec.description   = %q{Support functions for ActiveRecord models with periodic entries}
+  spec.homepage      = "https://github.com/mak-it/periodic_records"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", [">= 4", "< 5"]
+  spec.add_runtime_dependency "activesupport", [">= 4", "< 5"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: periodic_records
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edgars Beigarts
+- Toms Mikoss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support functions for ActiveRecord models with periodic entries
+email:
+- edgars.beigarts@makit.lv
+- toms.mikoss@makit.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/periodic_records.rb
+- lib/periodic_records/associations.rb
+- lib/periodic_records/model.rb
+- lib/periodic_records/version.rb
+- periodic_records.gemspec
+homepage: https://github.com/mak-it/periodic_records
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Support functions for ActiveRecord models with periodic entries
+test_files: []