activerecord_chronological_records 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby
+  - ree

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "activerecord",  ">= 3.0.0"
+
+group :development do
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler"
+  gem "sqlite3", :platforms => :ruby
+  gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 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,65 @@
+# activerecord_chronological_records [![Build Status](https://secure.travis-ci.org/tmikoss/activerecord_chronological_records.png)](http://travis-ci.org/tmikoss/activerecord_chronological_records)
+
+Provides a set of helper methods for dealing with chronological records that have common primary key and date columns denoting when the record is active (example: Oracle EBS tables).
+
+## Usage
+
+### Invocation
+
+To add the helper methods, invoke `has_chronological_records` method on your ActiveRecord model:
+
+    class Employee < ActiveRecord::Base
+      has_chronological_records
+    end
+
+This will assume you have `start_date` and `end_date` columns on the model. To change the column names, pass them as arguments:
+
+    class Employee < ActiveRecord::Base
+      has_chronological_records :start_date, :end_date
+    end
+
+### Class methods
+
+Following scopes are defined at class level that return all records matching specific condition:
+
+* `Class.current` - records valid at current date
+* `Class.at(date)` - records valid at given date
+
+### Instance methods
+
+Following instance methods are defined for navigation between versions or record. Can return nil if no version matches the condition.
+
+* `instance.current` - version of instance valid at current date
+* `instance.at(date)` - version of instance valid at given date
+* `instance.earliest` - first version of record
+* `instance.latest` - last version of record
+* `instance.previous` - version before the one method is being called on
+* `instance.next` - version after the one method is being called on
+
+Additonally, following helper methods are available:
+
+* `instance.current?` - checks whether instance is valid at current date
+
+## Installation
+
+Add the following line to your `Gemfile`
+
+    gem 'activerecord_chronological_records'
+
+and run the `bundle install` command.
+
+## Contributing to activerecord_chronological_records
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Toms Mikoss. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activerecord_chronological_records"
+  gem.homepage = "http://github.com/tmikoss/activerecord_chronological_records"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides a set of helper methods for dealing with chronological records.}
+  gem.description = %Q{Provides a set of helper methods for dealing with chronological records that have common primary key and date columns denoting when the record is active (example: Oracle EBS tables).}
+  gem.email = "toms.mikoss@gmail.com"
+  gem.authors = ["Toms Mikoss"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord_chronological_records #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/activerecord_chronological_records.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord_chronological_records"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toms Mikoss"]
+  s.date = "2012-11-12"
+  s.description = "Provides a set of helper methods for dealing with chronological records that have common primary key and date columns denoting when the record is active (example: Oracle EBS tables)."
+  s.email = "toms.mikoss@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "activerecord_chronological_records.gemspec",
+    "lib/activerecord_chronological_records.rb",
+    "spec/activerecord_chronological_records_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/tmikoss/activerecord_chronological_records"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Provides a set of helper methods for dealing with chronological records."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
+  end
+end
+

data/lib/activerecord_chronological_records.rb

@@ -0,0 +1,51 @@
+module ActiverecordChronologicalRecords
+  def has_chronological_records(*options)
+    if options.empty?
+      start_column, end_column = :start_date, :end_date
+    else
+      start_column, end_column = options[0], options[1]
+    end
+
+    self.instance_eval <<-EOS
+      def at(date)
+        where("#{start_column} <= :date AND (#{end_column} >= :date OR #{end_column} IS NULL)", :date => date)
+      end
+
+      def current
+        at(Time.now)
+      end
+EOS
+
+    self.class_eval <<-EOS
+      def at(date)
+        #{self}.at(date).where(:#{primary_key} => self.#{primary_key}).first
+      end
+
+      def current
+        at(Time.now)
+      end
+
+      def current?
+        #{start_column}.to_time <= Time.now && #{end_column}.to_time >= Time.now
+      end
+
+      def earliest
+        #{self}.where(:#{primary_key} => self.#{primary_key}).order("#{start_column} ASC").first
+      end
+
+      def latest
+        #{self}.where(:#{primary_key} => self.#{primary_key}).order("#{start_column} DESC").first
+      end
+
+      def previous
+        at(#{start_column} - 1.day)
+      end
+
+      def next
+        at(#{end_column} + 1.day)
+      end
+EOS
+  end
+end
+
+ActiveRecord::Base.extend ActiverecordChronologicalRecords

data/spec/activerecord_chronological_records_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActiverecordChronologicalRecords" do
+  def make_employee(attributes)
+    Employee.new(attributes).tap{ |e| e.id = 1; e.save! }
+  end
+
+  before(:all) do
+    Employee.rebuild_table do |t|
+      t.date :start_date
+      t.date :end_date
+    end
+
+    Employee.has_chronological_records
+  end
+
+  shared_examples "scopes" do
+    specify { Employee.current.all.should eq [@current_record] }
+    specify { Employee.at(Date.today).all.should eq [@current_record] }
+    specify { Employee.at(Date.today - 2.months).all.should eq [@first_record] }
+    specify { Employee.at(Date.today + 2.months).all.should eq [@last_record] }
+  end
+
+  shared_examples "navigation methods" do
+    specify { @first_record.current.should eq @current_record }
+    specify { @first_record.at(Date.today).should eq @current_record }
+    specify { @current_record.earliest.should eq @first_record }
+    specify { @current_record.latest.should eq @last_record }
+    specify { @current_record.previous.should eq @first_record }
+    specify { @current_record.next.should eq @last_record }
+  end
+
+  shared_examples "helper methods" do
+    specify { @current_record.should be_current }
+    specify { @first_record.should_not be_current }
+  end
+
+  context "When start and end dates are present" do
+    before(:all) do
+      Employee.destroy_all
+      @first_record   = make_employee(:start_date => Date.today - 1.year, :end_date => Date.today - 1.month - 1.day)
+      @current_record = make_employee(:start_date => Date.today - 1.month, :end_date => Date.today + 1.month)
+      @last_record    = make_employee(:start_date => Date.today + 1.month + 1.day, :end_date => Date.today + 1.year)
+    end
+
+    include_examples "scopes"
+    include_examples "navigation methods"
+    include_examples "helper methods"
+  end
+
+  context "When last record does not have end date" do
+    before(:all) do
+      Employee.destroy_all
+      @first_record   = make_employee(:start_date => Date.today - 1.year, :end_date => Date.today - 1.month - 1.day)
+      @current_record = make_employee(:start_date => Date.today - 1.month, :end_date => Date.today + 1.month)
+      @last_record    = make_employee(:start_date => Date.today + 1.month + 1.day, :end_date => nil)
+    end
+
+    include_examples "scopes"
+    include_examples "navigation methods"
+    include_examples "helper methods"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'activerecord_chronological_records'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(JRUBY_VERSION) ? "jdbcsqlite3": "sqlite3",
+  :database => "#{File.dirname(__FILE__)}/activerecord_chronological_records.db"
+)
+
+class Employee < ActiveRecord::Base
+  self.primary_key = :id
+
+  def self.rebuild_table
+    ActiveRecord::Schema.define do
+      self.verbose = false
+
+      create_table :employees, :force => true, :id => false do |t|
+        t.integer :id
+        yield t
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_chronological_records
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Toms Mikoss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-jdbcsqlite3-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Provides a set of helper methods for dealing with chronological records
+  that have common primary key and date columns denoting when the record is active
+  (example: Oracle EBS tables).'
+email: toms.mikoss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- activerecord_chronological_records.gemspec
+- lib/activerecord_chronological_records.rb
+- spec/activerecord_chronological_records_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tmikoss/activerecord_chronological_records
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -609177617
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a set of helper methods for dealing with chronological records.
+test_files: []