temporal_tables 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d62499062a9e064ab78f44d40ad96dcd82936731662b8fc6c1920f5dfb5bb1f5
+  data.tar.gz: 14ce63e0d1dfa16260132c0204671b2694823455623958177a46ce9d33e2ddc3
+SHA512:
+  metadata.gz: 217fa0285c8a7ad77f438e4236d50ccd35647cf1d3cd3dec127479b27e6a03f9597560943f11f8cbc28911e05a31c7788eeddfadfb7a766788fcb094ef2677f3
+  data.tar.gz: 4dc597b2b6ee301b7bbba1852cc466b4c4ea67760e975dff38fefbf99804d2ac1fa960157357bff7d0ea2493acfedeb226e3b79f5d31086cb02b126064c0f7af

data/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+indent_size = 2

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/internal/config/database.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.4.3
+
+gemfile:
+  - gemfiles/Gemfile.5.2.pg
+  - gemfiles/Gemfile.5.2.mysql

data/CHANGELOG.md

@@ -0,0 +1,73 @@
+# CHANGELOG
+
+## 0.4.0 (2016-12-13)
+
+ * added multi-environment spec framework
+ * bug fix: mysql2 gem should now be functional
+
+## 0.3.1 (2015-10-08)
+
+ * bug fix: accepts reserved keywords for postgres column names, like "default"
+ * bug fix: correctly handles models nested within modules
+
+## 0.3.0 (2014-07-04)
+
+ * Updated for Rails 4
+
+## 0.2.7 (2013-07-10)
+
+ * bug fix: fix problems with STI instantiation
+
+## 0.2.6 (2013-05-23)
+
+ * bug fix: explicitly set sti_name on history classes of STI subclasses
+
+## 0.2.5 (2013-04-24)
+
+ * bug fix: rename_column wasn't linked in correctly
+
+## 0.2.4 (2013-03-07)
+
+ * bug fix: another fix for removing indexes
+
+# 0.2.3 (2013-02-25)
+
+ * bug fix: history classes did not have the correct primary key set, which could provide unexpected results in certain use cases
+ * added a history method to ActiveRecord::Base objects to return a sorted list of all historical versions of that object.
+ * added prev and next methods to history objects to aid in traversing the historical versions of an object.
+ * added orig_obj method to history objects to return their non-historical objects
+
+## 0.2.2 (2013-02-25)
+
+ * bug fix: add_index with specified name caused an index collision
+
+## 0.2.1 (2013-02-21)
+
+ * bug fix: removing indexes didn't work
+
+## 0.2.0 (2013-02-21)
+
+ * added support for indexes
+
+## 0.1.0 (2013-01-10)
+
+ * added history querying
+
+## 0.0.6 (2012-11-29)
+
+ * optimized the history table index
+
+## 0.0.5 (2012-11-29)
+
+ * added indexes to history tables
+
+## 0.0.4 (2012-10-19)
+
+ * added updated_by support
+ * added some configuration options
+
+## 0.0.2 (2012-10-12)
+
+ * added support for rename_table
+ * added add_temporal_table(table_name) method
+ * added remove_temporal_table(table_name) method

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brent Kroeker
+
+MIT License
+
+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,139 @@
+# TemporalTables
+
+Easily recall what your data looked like at any point in the past!  TemporalTables sets up and maintains history tables to track all temporal changes to to your data.
+
+Currently tested on Ruby 2.4, Rails 5.2, Postgres, MySQL
+
+## Installation
+
+Add this line to your application's Gemfile:
+``` ruby
+gem 'temporal_tables'
+```
+
+And then execute:
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+``` bash
+$ gem install temporal_tables
+```
+
+## Usage
+
+### Schema
+
+In your rails migration, specify that you want a table to have its history tracked:
+``` ruby
+create_table :people, :temporal => true do |t|
+  ...
+end
+```
+
+This will create a history table called "people_h" which will maintain a history of all changes to any records in people with the use of triggers on any create/update/delete operation.
+
+Any subsequent schema changes to people will be reflected automatically in people_h.
+
+``` ruby
+# Nothing extra required -- people_h will automatically get an "name" column too!
+add_column :people, :name, :string
+```
+
+To track the history of a pre-existing table, just call `add_temporal_table`:
+``` ruby
+add_temporal_table :people
+```
+
+### Querying
+
+For the below queries, we'll assume the following schema:
+``` ruby
+class Person < ActiveRecord::Base
+  attr_accessible :name
+  belongs_to :coven
+  has_many :warts
+
+  def label
+    "#{name} from #{coven.name}"
+  end
+end
+
+class Coven < ActiveRecord::Base
+  attr_accessible :name
+  has_many :members, class_name: "Person"
+end
+
+class Wart < ActiveRecord::Base
+  attr_accessible :location
+  belongs_to :person
+
+  scope :very_hairy, -> { where(arel_table[:num_hairs].gteq(3)) }
+end
+```
+
+You can query the history tables by calling `history` on the class.
+``` ruby
+Person         #=> Person(id: :integer, name: :string)
+Person.history #=> PersonHistory(history_id: :integer, id: :integer, name: :string, eff_from: :datetime, eff_to: :datetime)
+```
+
+You can easily get a history of all changes to a records.
+``` ruby
+Person.history.where(id: 1).map { |p| "#{p.eff_from}: #{p.name}")
+# => [
+#  "1974-01-14: Emily",
+#  "2003-11-03: Grunthilda"
+# ]
+```
+
+You can query for records as they were at any point in the past by calling `at`.
+``` ruby
+ Person.history.at(2.years.ago).where(id: 1).first.name #=> "Grunthilda"
+```
+
+Associations work too.
+``` ruby
+grunthilda = Person.history.at(20.years.ago).find_by_name("Grunthilda")
+grunthilda.warts.count            #=> 2
+
+grunthilda = Person.history.at(1.year.ago).find_by_name("Grunthilda")
+grunthilda.warts.count            #=> 13
+
+grunthilda.warts.first.class.name #=> "WartHistory"
+```
+
+And scopes also!
+``` ruby
+grunthilda = Person.history.at(1.year.ago).find_by_name("Grunthilda")
+grunthilda.warts.count            #=> 13
+grunthilda.warts.very_hairy.count #=> 7
+```
+
+Instance methods are inherited.
+``` ruby
+grunthilda.label                  #=> "Grunthilda from Delta Gamma Gamma"
+grunthilda.class.name             #=> "PersonHistory"
+grunthilda.class.superclass.name  #=> "Person"
+```
+
+## Config
+
+Create temporal tables for all tables by default
+``` ruby
+TemporalTables.create_by_default = true
+```
+
+Don't create temporal tables for these tables.  Defaults to schema_migrations and sessions tables.
+``` ruby
+TemporalTables.skip_temporal_table_for :table_one, :table_two
+```
+
+Add an updated_by field to all temporal tables to track who made any changes.  Defaults to a :string field.  The block is called when records are saved to determine the value to place within the updated_by field.
+``` ruby
+TemporalTables.add_updated_by_field(:integer) { User.current_user.try(:id) }
+```
+
+## Copyright
+See [LICENSE](https://github.com/bkroeker/temporal_tables/blob/master/LICENSE.txt) for more details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end
+
+task :default => 'matrix:spec'

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/gemfiles/Gemfile.5.2.mysql

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'rails', '~> 5.2.0'
+gem 'mysql2', '~> 0.4.4'
+
+# Development dependencies
+gem 'rspec', '~> 3.4'
+gem 'rake'
+gem 'byebug'
+gem 'database_cleaner'
+gem 'combustion'
+gem 'gemika'
+
+# Gem under test
+gem 'temporal_tables', :path => '..'

data/gemfiles/Gemfile.5.2.mysql.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: ..
+  specs:
+    temporal_tables (0.6.0)
+      rails (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    combustion (0.9.1)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    gemika (0.3.2)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    mysql2 (0.4.10)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  combustion
+  database_cleaner
+  gemika
+  mysql2 (~> 0.4.4)
+  rails (~> 5.2.0)
+  rake
+  rspec (~> 3.4)
+  temporal_tables!
+
+BUNDLED WITH
+   1.16.1