historiographer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433e733811c7f23a3044282b54c87832abc944e3f46817d16036c87778f938ff
-  data.tar.gz: 54e27e8e68ab4512bb5edf146d1c210f9072ad99346d8a1ced37e6766d014d3b
+  metadata.gz: e7cb91195d9d049faf9de52f631cd6c64c46c24e3e0d44fba5ea446197986d98
+  data.tar.gz: 0236e459a57ec0a4105f9dd9a8e933745f98e9942d2919298e97e6cf7a32c3d3
 SHA512:
-  metadata.gz: 1abd0b29fc36c284fb6e8c5da6c884640678ce0dd9b58c089b15056897514f7cd47b8d4117e54b3549d306be6ce0a08c36f772724bc741fd09cf782a174c0415
-  data.tar.gz: c63eecd58ea1b7ad604d3cf049735b2fed3bdd403aa2c508190a3907b6dfcaf7ecb6094b9ac14bf2fb0d5574e8277a0c2b05ef06d25a8291bfbc3306c419decb
+  metadata.gz: 6ddac0ce23e3b5ded4dc95a6c8d2e5b0870bc95e40e89d5d3fbf2e867511cc6320d23f4ac1562191c025d011161afca0f1c107fcb0c9a64d59799183bb31ef5a
+  data.tar.gz: ac97602293b1488db300d33178bf1c697f69613e3929c62aa5199c2a11a3d6ae07e4d8a1afb1198a8a41761c6ff09726c4fee5570ef17f35721ff5e8ce8756f5

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/historiographer.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: historiographer 1.1.0 ruby lib
+# stub: historiographer 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "historiographer".freeze
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["brettshollenberger".freeze]
-  s.date = "2019-10-11"
+  s.date = "2019-10-24"
   s.description = "Creates separate tables for each history table".freeze
   s.email = "brett.shollenberger@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -47,6 +47,8 @@ Gem::Specification.new do |s|
     "spec/db/migrate/20161121212232_create_users.rb",
     "spec/db/migrate/20171011194624_create_safe_posts.rb",
     "spec/db/migrate/20171011194715_create_safe_post_histories.rb",
+    "spec/db/migrate/20191024142304_create_thing_with_compound_index.rb",
+    "spec/db/migrate/20191024142352_create_thing_with_compound_index_history.rb",
     "spec/db/schema.rb",
     "spec/examples.txt",
     "spec/historiographer_spec.rb",

data/lib/historiographer/history_migration.rb

@@ -16,7 +16,8 @@ module Historiographer
     # Will automatically add user_id, history_started_at,
     # and history_ended_at columns
     #
-    def histories(except: [], only: [], no_business_columns: false)
+    def histories(except: [], only: [], no_business_columns: false, index_names: {})
+      index_names.symbolize_keys!
       original_table_name = self.name.gsub(/_histories$/) {}.pluralize
       foreign_key         = original_table_name.singularize.foreign_key
 
@@ -32,7 +33,6 @@ module Historiographer
       original_columns.each do |column|
         opts = {}
         opts.merge!(column.as_json.clone)
-        # opts.merge!(column.type.as_json.clone)
 
         send(column.type, column.name, opts.symbolize_keys!)
       end
@@ -41,38 +41,49 @@ module Historiographer
       datetime :history_ended_at
       integer :history_user_id
 
-      index :history_started_at
-      index :history_ended_at
-      index :history_user_id
-      index foreign_key
-
-      indices_sql = <<-SQL
-        SELECT
-            a.attname AS column_name
-        FROM
-            pg_class t,
-            pg_class i,
-            pg_index ix,
-            pg_attribute a
-        WHERE
-            t.oid = ix.indrelid
-            AND i.oid = ix.indexrelid
-            AND a.attrelid = t.oid
-            AND a.attnum = ANY(ix.indkey)
-            AND t.relkind = 'r'
-            AND t.relname = ?
-        ORDER BY
-            t.relname,
-            i.relname;
-      SQL
+      indices_sql = %q(
+        SELECT 
+          DISTINCT(
+            ARRAY_TO_STRING(ARRAY(
+             SELECT pg_get_indexdef(idx.indexrelid, k + 1, true)
+             FROM generate_subscripts(idx.indkey, 1) as k
+             ORDER BY k
+           ), ',')
+         ) as indkey_names
+        FROM pg_class t,
+        pg_class i,
+        pg_index idx,
+        pg_attribute a,
+        pg_am am
+        WHERE t.oid = idx.indrelid
+        AND i.oid = idx.indexrelid
+        AND a.attrelid = t.oid
+        AND a.attnum = ANY(idx.indkey)
+        AND t.relkind = 'r'
+        AND t.relname = ?;
+      )
 
       indices_query_array = [indices_sql, original_table_name]
       indices_sanitized_query = klass.send(:sanitize_sql_array, indices_query_array)
 
-      klass.connection.execute(indices_sanitized_query).to_a.map(&:values).flatten.reject { |i| i == "id" }.each do |index_name|
-        index index_name.to_sym
+      indexes = klass.connection.execute(indices_sanitized_query).to_a.map(&:values).flatten.reject { |i| i == "id" }.map { |i| i.split(",") }.concat([
+        foreign_key,
+        :history_started_at,
+        :history_ended_at,
+        :history_user_id
+      ])
+
+      indexes.each do |index_definition|
+        index_definition = [index_definition].flatten.map(&:to_sym)
+        index_name = index_definition.count == 1 ?  index_definition.first : index_definition
+
+        if index_names.key?(index_name)
+          index index_name, name: index_names[index_name]
+        else
+          index index_name
+        end
       end
 
     end
   end
-end
+end

data/spec/db/database.yml

@@ -1,27 +1,26 @@
-# default: &default
-#   adapter: postgresql
-#   prepared_statements: false
-#   url: "postgres://localhost/historiographer_development"
-
-# development:
-#   <<: *default
-
-# test:
-#   adapter: postgresql
-#   database: historiographer_test
-
-mysql_default: &mysql_default
-  adapter: mysql2
-  encoding: utf8
-  username: root
-  password:
-  host: 127.0.0.1
-  port: 3306
+default: &default
+  adapter: postgresql
+  prepared_statements: false
+  url: "postgres://localhost/historiographer_development"
 
 development:
-  <<: *mysql_default
-  database: historiographer_development
+  <<: *default
 
 test:
-  <<: *mysql_default
+  adapter: postgresql
   database: historiographer_test
+# mysql_default: &mysql_default
+#   adapter: mysql2
+#   encoding: utf8
+#   username: root
+#   password:
+#   host: 127.0.0.1
+#   port: 3306
+
+# development:
+#   <<: *mysql_default
+#   database: historiographer_development
+
+# test:
+#   <<: *mysql_default
+#   database: historiographer_test

data/spec/db/migrate/20191024142304_create_thing_with_compound_index.rb

@@ -0,0 +1,10 @@
+class CreateThingWithCompoundIndex < ActiveRecord::Migration[5.2]
+  def change
+    create_table :thing_with_compound_indices do |t|
+      t.string :key
+      t.string :value
+
+      t.index [:key, :value], name: "idx_key_value"
+    end
+  end
+end

data/spec/db/migrate/20191024142352_create_thing_with_compound_index_history.rb

@@ -0,0 +1,11 @@
+require "historiographer/postgres_migration"
+class CreateThingWithCompoundIndexHistory < ActiveRecord::Migration[5.2]
+  def change
+    create_table :thing_with_compound_index_histories do |t|
+      t.histories index_names: {
+        [:key, :value] => "idx_history_k_v",
+        :thing_with_compound_index_id => "idx_k_v_histories"
+      }
+    end
+  end
+end

data/spec/db/schema.rb

@@ -10,9 +10,12 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2017_10_11_194715) do
+ActiveRecord::Schema.define(version: 2019_10_24_142352) do
 
-  create_table "author_histories", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "author_histories", force: :cascade do |t|
     t.integer "author_id", null: false
     t.string "full_name", null: false
     t.text "bio"
@@ -29,7 +32,7 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["history_user_id"], name: "index_author_histories_on_history_user_id"
   end
 
-  create_table "authors", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "authors", force: :cascade do |t|
     t.string "full_name", null: false
     t.text "bio"
     t.datetime "deleted_at"
@@ -38,7 +41,7 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["deleted_at"], name: "index_authors_on_deleted_at"
   end
 
-  create_table "post_histories", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "post_histories", force: :cascade do |t|
     t.integer "post_id", null: false
     t.string "title", null: false
     t.text "body", null: false
@@ -61,7 +64,7 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["post_id"], name: "index_post_histories_on_post_id"
   end
 
-  create_table "posts", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "posts", force: :cascade do |t|
     t.string "title", null: false
     t.text "body", null: false
     t.integer "author_id", null: false
@@ -76,7 +79,7 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["live_at"], name: "index_posts_on_live_at"
   end
 
-  create_table "safe_post_histories", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "safe_post_histories", force: :cascade do |t|
     t.integer "safe_post_id", null: false
     t.string "title", null: false
     t.text "body", null: false
@@ -99,7 +102,7 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["safe_post_id"], name: "index_safe_post_histories_on_safe_post_id"
   end
 
-  create_table "safe_posts", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "safe_posts", force: :cascade do |t|
     t.string "title", null: false
     t.text "body", null: false
     t.integer "author_id", null: false
@@ -114,7 +117,27 @@ ActiveRecord::Schema.define(version: 2017_10_11_194715) do
     t.index ["live_at"], name: "index_safe_posts_on_live_at"
   end
 
-  create_table "users", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+  create_table "thing_with_compound_index_histories", force: :cascade do |t|
+    t.integer "thing_with_compound_index_id", null: false
+    t.string "key"
+    t.string "value"
+    t.datetime "history_started_at", null: false
+    t.datetime "history_ended_at"
+    t.integer "history_user_id"
+    t.index ["history_ended_at"], name: "index_thing_with_compound_index_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_thing_with_compound_index_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_thing_with_compound_index_histories_on_history_user_id"
+    t.index ["key", "value"], name: "idx_history_k_v"
+    t.index ["thing_with_compound_index_id"], name: "idx_k_v_histories"
+  end
+
+  create_table "thing_with_compound_indices", force: :cascade do |t|
+    t.string "key"
+    t.string "value"
+    t.index ["key", "value"], name: "idx_key_value"
+  end
+
+  create_table "users", force: :cascade do |t|
     t.string "name"
   end
 

data/spec/historiographer_spec.rb

@@ -24,6 +24,13 @@ end
 class User < ActiveRecord::Base
 end
 
+class ThingWithCompoundIndex < ActiveRecord::Base
+  include Historiographer
+end
+
+class ThingWithCompoundIndexHistory < ActiveRecord::Base
+end
+
 describe Historiographer do
   before(:all) do
     @now = Timecop.freeze
@@ -317,6 +324,8 @@ describe Historiographer do
           body,
           post_id,
           author_id,
+          created_at,
+          updated_at,
           history_started_at,
           history_ended_at
         ) VALUES (
@@ -324,6 +333,8 @@ describe Historiographer do
           'Text',
           1,
           1,
+          now(),
+          now(),
           now() - INTERVAL '1 day',
           NULL
         ), (
@@ -331,6 +342,8 @@ describe Historiographer do
           'Different text',
           1,
           1,
+          now(),
+          now(),
           now() - INTERVAL '12 hours',
           NULL
         ), (
@@ -338,6 +351,8 @@ describe Historiographer do
           'Even more different text',
           1,
           1,
+          now(),
+          now(),
           now() - INTERVAL '12 hours',
           NULL
         )
@@ -407,4 +422,42 @@ describe Historiographer do
       expect(author.current_history.user.name).to eq username
     end
   end
+
+  describe "Migrations with compound indexes" do
+    it "supports renaming compound indexes and migrating them to history tables" do
+      indices_sql = %q(
+        SELECT 
+          DISTINCT(
+            ARRAY_TO_STRING(ARRAY(
+             SELECT pg_get_indexdef(idx.indexrelid, k + 1, true)
+             FROM generate_subscripts(idx.indkey, 1) as k
+             ORDER BY k
+           ), ',')
+         ) as indkey_names
+        FROM pg_class t,
+        pg_class i,
+        pg_index idx,
+        pg_attribute a,
+        pg_am am
+        WHERE t.oid = idx.indrelid
+        AND i.oid = idx.indexrelid
+        AND a.attrelid = t.oid
+        AND a.attnum = ANY(idx.indkey)
+        AND t.relkind = 'r'
+        AND t.relname = ?;
+      )
+
+      indices_query_array = [indices_sql, :thing_with_compound_index_histories]
+      indices_sanitized_query = ThingWithCompoundIndexHistory.send(:sanitize_sql_array, indices_query_array)
+
+      indexes = ThingWithCompoundIndexHistory.connection.execute(indices_sanitized_query).to_a.map(&:values).flatten.map { |i| i.split(",") }
+
+      expect(indexes).to include(["history_started_at"])
+      expect(indexes).to include(["history_ended_at"])
+      expect(indexes).to include(["history_user_id"])
+      expect(indexes).to include(["id"])
+      expect(indexes).to include(["key", "value"])
+      expect(indexes).to include(["thing_with_compound_index_id"])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: historiographer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - brettshollenberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -228,6 +228,8 @@ files:
 - spec/db/migrate/20161121212232_create_users.rb
 - spec/db/migrate/20171011194624_create_safe_posts.rb
 - spec/db/migrate/20171011194715_create_safe_post_histories.rb
+- spec/db/migrate/20191024142304_create_thing_with_compound_index.rb
+- spec/db/migrate/20191024142352_create_thing_with_compound_index_history.rb
 - spec/db/schema.rb
 - spec/examples.txt
 - spec/historiographer_spec.rb