temporal_tables 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4f6546810d969fb905818b357aff6f3130a85e80cc1bc3037f5fb885660856e
-  data.tar.gz: e3e2167bdb2104ef7f2a56f9381e16b7648dc800b25785094a5ca3825277d980
+  metadata.gz: d3769a9624f0d50658cde81f3275a273cc026ae4a5c19b37fdc86031727df2b1
+  data.tar.gz: 64c02f0431cc68a44149f64088dec31b2fee7c0e78ddfdb51e36ecb85f546f5b
 SHA512:
-  metadata.gz: fa67585d54cbfa598729a139b36b788f0f0cf7ca5e7bccdd6ac82a660f000467b56f8ac97c07fa967028a4f501397fa0901af9de309eb03f184afd029c0dbed7
-  data.tar.gz: 719e681acf4ae6f07a3de41fc7c7cbb3b7296e18d821a88bef7b82f62b618e0e4e64059672e20a2b60a60c834db69f45afec9df239b97d4068c7ded887a685bc
+  metadata.gz: 2c64cc0fa0c02b4f7c622e1e1fa3b94c1701525720586a56e864fc7b4ada9744cc278defd276dea5dcdb6f1a98b673e7af1816661584eec82ebe1f5832818393
+  data.tar.gz: 59e1cd19d8ea5c12c5afd890093dab74c98c7fc1a34203e84a3021d07fa325fb5ec913de0daf96beb9a87d442f1c28fdf2f01a87c7d4bd3f96c87925e3061482

data/README.md

@@ -2,7 +2,7 @@
 
 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
+Currently tested on Ruby 2.4, Rails 5.2, Postgres 10.3, MySQL 8.0.11
 
 ## Installation
 
@@ -27,7 +27,7 @@ $ gem install temporal_tables
 
 In your rails migration, specify that you want a table to have its history tracked:
 ``` ruby
-create_table :people, :temporal => true do |t|
+create_table :people, temporal: true do |t|
   ...
 end
 ```
@@ -51,25 +51,32 @@ add_temporal_table :people
 For the below queries, we'll assume the following schema:
 ``` ruby
 class Person < ActiveRecord::Base
-  attr_accessible :name
-  belongs_to :coven
+  belongs_to :coven, optional: true
   has_many :warts
 
-  def label
-    "#{name} from #{coven.name}"
+  def to_s
+    parts = [name]
+    parts << "from #{coven.name}" if coven
+    parts.join ' '
   end
 end
 
 class Coven < ActiveRecord::Base
-  attr_accessible :name
   has_many :members, class_name: "Person"
+
+  def to_s
+    name
+  end
 end
 
 class Wart < ActiveRecord::Base
-  attr_accessible :location
   belongs_to :person
 
   scope :very_hairy, -> { where(arel_table[:num_hairs].gteq(3)) }
+
+  def to_s
+    "wart on #{location} with #{pluralize num_hairs, 'hair'}"
+  end
 end
 ```
 
@@ -81,10 +88,10 @@ Person.history #=> PersonHistory(history_id: :integer, id: :integer, name: :stri
 
 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}")
+Person.history.where(id: 1).map { |p| "#{p.eff_from}: #{p.to_s}")
 # => [
 #  "1974-01-14: Emily",
-#  "2003-11-03: Grunthilda"
+#  "2003-11-03: Grunthilda from Delta Gamma Gamma"
 # ]
 ```
 
@@ -113,26 +120,27 @@ grunthilda.warts.very_hairy.count #=> 7
 
 Instance methods are inherited.
 ``` ruby
-grunthilda.label                  #=> "Grunthilda from Delta Gamma Gamma"
+grunthilda.to_s                   #=> "Grunthilda from Delta Gamma Gamma"
 grunthilda.class.name             #=> "PersonHistory"
 grunthilda.class.superclass.name  #=> "Person"
 ```
 
 ## Config
+You can configure temporal_tables in an initializer.
 
-Create temporal tables for all tables by default
+Create temporal tables for all tables by default (default = false)
 ``` ruby
 TemporalTables.create_by_default = true
 ```
 
-Don't create temporal tables for these tables.  Defaults to schema_migrations and sessions tables.
+Don't create temporal tables for these tables.  (default = %w{schema_migrations sessions ar_internal_metadata})
 ``` 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.
+Add an `updated_by` column to all temporal tables to track who made any changes, which is quite useful for auditing.  Defaults to a :string field.  The block is called when records are saved to determine the value to place within the `updated_by` field.  `updated_by` fields are only auto-created if this is configured.
 ``` ruby
-TemporalTables.add_updated_by_field(:integer) { User.current_user.try(:id) }
+TemporalTables.add_updated_by_field(:integer) { User.current_user&.id }
 ```
 
 ## Copyright

data/lib/temporal_tables/version.rb

@@ -1,3 +1,3 @@
 module TemporalTables
-	VERSION = "0.6.2"
+	VERSION = "0.6.3"
 end

data/lib/temporal_tables.rb

@@ -34,7 +34,7 @@ module TemporalTables
 		@@create_by_default = default
 	end
 
-	@@skipped_temporal_tables = [:schema_migrations, :sessions]
+	@@skipped_temporal_tables = [:schema_migrations, :sessions, :ar_internal_metadata]
 	def self.skip_temporal_table_for(*tables)
 		@@skipped_temporal_tables += tables
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporal_tables
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Brent Kroeker