historiographer 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7cb91195d9d049faf9de52f631cd6c64c46c24e3e0d44fba5ea446197986d98
-  data.tar.gz: 0236e459a57ec0a4105f9dd9a8e933745f98e9942d2919298e97e6cf7a32c3d3
+  metadata.gz: cceab0e39bc86b8e410a55d5c5b23556ad8ecf543fae2720d0761cbfc9070b1d
+  data.tar.gz: 70fd87e0ecf2fbf6829a50ac315746bced3e2533e0a3664ce005c237557265bd
 SHA512:
-  metadata.gz: 6ddac0ce23e3b5ded4dc95a6c8d2e5b0870bc95e40e89d5d3fbf2e867511cc6320d23f4ac1562191c025d011161afca0f1c107fcb0c9a64d59799183bb31ef5a
-  data.tar.gz: ac97602293b1488db300d33178bf1c697f69613e3929c62aa5199c2a11a3d6ae07e4d8a1afb1198a8a41761c6ff09726c4fee5570ef17f35721ff5e8ce8756f5
+  metadata.gz: e77e1c8d9dc96c8d6db182b568529fc1d16e1947dc6e16a1234109a90ad3f02229ec9532ba560ea56246fa79d9ccc928801a885a9a6b5a14d2d132202d3cb220
+  data.tar.gz: 9e94ed498ca13062259f8031bfbd529ae516261e7a08e46a32e73bec86a066df4d9d83e1ea70754a7260c0f5fa38a933bcc4ce1431cffbd0a2944fbd3f21c686

data/Gemfile

@@ -4,6 +4,7 @@ ruby "2.6.3"
 gem "activerecord", "~> 5.1"
 gem "activesupport"
 gem "rollbar"
+gem "activerecord-import"
 
 group :development, :test do
   gem "pg"
@@ -26,4 +27,5 @@ group :test do
   gem "guard"
   gem "guard-rspec"
   gem "database_cleaner"
+  gem "factory_bot_rails"
 end

data/Gemfile.lock

@@ -37,6 +37,8 @@ GEM
       activemodel (= 5.2.3)
       activesupport (= 5.2.3)
       arel (>= 9.0)
+    activerecord-import (1.0.2)
+      activerecord (>= 3.2)
     activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
@@ -54,6 +56,11 @@ GEM
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.8.0)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    factory_bot_rails (5.1.1)
+      factory_bot (~> 5.1.0)
+      railties (>= 4.2.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
@@ -178,9 +185,11 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (~> 5.1)
+  activerecord-import
   activesupport
   bundler (~> 1.0)
   database_cleaner
+  factory_bot_rails
   guard
   guard-rspec
   jeweler!

data/README.md

@@ -80,6 +80,24 @@ Additionally it will add indices on:
 - The same columns that had indices on the original model (e.g. `enabled`)
 - `history_started_at`, `history_ended_at`, and `history_user_id`
 
+### what to do when generated index names are too long
+
+Sometimes the generated index names are too long. Just like with standard Rails migrations, you can override the name of the index to fix this problem. To do so, use the `index_names` argument to override individual index names:
+
+```ruby
+require "historiographer/postgres_migration"
+class CreatePostHistories < ActiveRecord::Migration
+  def change
+    create_table :post_histories do |t|
+      t.histories, index_names: {
+        title: "my_index_name",
+        [:compound, :index] => "my_compound_index_name"
+      }
+    end
+  end
+end
+```
+
 ## models
 
 The primary model should include `Historiographer`:

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.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.2.0 ruby lib
+# stub: historiographer 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "historiographer".freeze
-  s.version = "1.2.0"
+  s.version = "1.3.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-24"
+  s.date = "2019-11-08"
   s.description = "Creates separate tables for each history table".freeze
   s.email = "brett.shollenberger@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/historiographer/history_migration_mysql.rb",
     "lib/historiographer/mysql_migration.rb",
     "lib/historiographer/postgres_migration.rb",
+    "lib/historiographer/relation.rb",
     "lib/historiographer/safe.rb",
     "spec/db/database.yml",
     "spec/db/migrate/20161121212228_create_posts.rb",
@@ -49,8 +50,10 @@ Gem::Specification.new do |s|
     "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/migrate/20191024203106_create_thing_without_history.rb",
     "spec/db/schema.rb",
     "spec/examples.txt",
+    "spec/factories/post.rb",
     "spec/historiographer_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -66,6 +69,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activerecord>.freeze, ["~> 5.1"])
       s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<rollbar>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord-import>.freeze, [">= 0"])
       s.add_development_dependency(%q<pg>.freeze, [">= 0"])
       s.add_development_dependency(%q<pry>.freeze, [">= 0"])
       s.add_development_dependency(%q<mysql2>.freeze, ["= 0.4.10"])
@@ -80,6 +84,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activerecord>.freeze, ["~> 5.1"])
       s.add_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_dependency(%q<rollbar>.freeze, [">= 0"])
+      s.add_dependency(%q<activerecord-import>.freeze, [">= 0"])
       s.add_dependency(%q<pg>.freeze, [">= 0"])
       s.add_dependency(%q<pry>.freeze, [">= 0"])
       s.add_dependency(%q<mysql2>.freeze, ["= 0.4.10"])
@@ -95,6 +100,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activerecord>.freeze, ["~> 5.1"])
     s.add_dependency(%q<activesupport>.freeze, [">= 0"])
     s.add_dependency(%q<rollbar>.freeze, [">= 0"])
+    s.add_dependency(%q<activerecord-import>.freeze, [">= 0"])
     s.add_dependency(%q<pg>.freeze, [">= 0"])
     s.add_dependency(%q<pry>.freeze, [">= 0"])
     s.add_dependency(%q<mysql2>.freeze, ["= 0.4.10"])

data/lib/historiographer.rb

@@ -249,5 +249,9 @@ module Historiographer
     def history_class
       "#{name}History".constantize
     end
+
+    def relation
+      super.tap { |r| r.extend Historiographer::Relation }
+    end
   end
 end

data/lib/historiographer/history.rb

@@ -66,11 +66,7 @@ module Historiographer
       # access to a current scope, returning
       # the most recent history.
       #
-      # Although we never want there to be more than 1 current history,
-      # in the off chance this invariant is broken, this method is
-      # guaranteed to only return an array containing the most recent history.
-      #
-      scope :current, -> { where(history_ended_at: nil).order(id: :desc).limit(1) }
+      scope :current, -> { where(history_ended_at: nil).order(id: :desc) }
 
       #
       # A History class will be linked to the user

data/lib/historiographer/relation.rb

@@ -0,0 +1,94 @@
+module Historiographer
+  module Relation
+    extend ActiveSupport::Concern
+
+    def has_histories?
+      self.klass.respond_to?(:history_class)
+    end
+
+    def update_all_without_history(updates)
+      update_all(updates, false)
+    end
+
+    def update_all(updates, histories=true)
+      unless histories
+        super(updates)
+      else
+        updates.symbolize_keys!
+
+        ActiveRecord::Base.transaction do
+          super(updates.except(:history_user_id))
+          now = UTC.now
+          records = self.reload
+          history_class = records.klass.history_class
+
+          records.new.send(:history_user_absent_action) if updates[:history_user_id].nil?
+          history_user_id = updates[:history_user_id]
+
+          new_histories = records.map do |record|
+            attrs         = record.attributes.clone
+            foreign_key   = history_class.history_foreign_key
+      
+            now = UTC.now
+            attrs.merge!(foreign_key => attrs["id"], history_started_at: now, history_user_id: history_user_id)
+      
+            attrs = attrs.except("id")
+
+            record.histories.build(attrs)
+          end
+
+          current_histories = history_class.current.where("#{history_class.history_foreign_key} IN (?)", records.map(&:id))
+
+          current_histories.update_all(history_ended_at: now)
+
+          history_class.import new_histories
+        end
+      end
+    end
+
+    def delete_all_without_history
+      delete_all(nil, false)
+    end
+
+    def delete_all(options={}, histories=true)
+      unless histories
+        super()
+      else
+        ActiveRecord::Base.transaction do
+          records = self
+          history_class = records.first.class.history_class
+          history_user_id = options[:history_user_id]
+          records.first.send(:history_user_absent_action) if history_user_id.nil?
+          now = UTC.now
+
+          history_class.current.where("#{history_class.history_foreign_key} IN (?)", records.map(&:id)).update_all(history_ended_at: now)
+
+          if records.first.respond_to?(:paranoia_destroy)
+            new_histories = records.map do |record|
+              attrs         = record.attributes.clone
+              foreign_key   = history_class.history_foreign_key
+        
+              now = UTC.now
+              attrs.merge!(foreign_key => attrs["id"], history_started_at: now, history_user_id: history_user_id, deleted_at: now)
+        
+              attrs = attrs.except("id")
+
+              record.histories.build(attrs)
+            end
+            history_class.import new_histories
+          end
+
+          super()
+        end
+      end
+    end
+
+    def destroy_all_without_history
+      records.each(&:destroy_without_history).tap { reset }
+    end
+
+    def destroy_all(history_user_id: nil)
+      records.each { |r| r.destroy(history_user_id: history_user_id) }.tap { reset }
+    end
+  end
+end

data/spec/db/migrate/20191024203106_create_thing_without_history.rb

@@ -0,0 +1,7 @@
+class CreateThingWithoutHistory < ActiveRecord::Migration[5.2]
+  def change
+    create_table :thing_without_histories do |t|
+      t.string :name
+    end
+  end
+end

data/spec/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_10_24_142352) do
+ActiveRecord::Schema.define(version: 2019_10_24_203106) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -137,6 +137,10 @@ ActiveRecord::Schema.define(version: 2019_10_24_142352) do
     t.index ["key", "value"], name: "idx_key_value"
   end
 
+  create_table "thing_without_histories", force: :cascade do |t|
+    t.string "name"
+  end
+
   create_table "users", force: :cascade do |t|
     t.string "name"
   end

data/spec/factories/post.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :post do
+    sequence(:title) { |n| "Post #{n}"}
+    body { "The body of the post" }
+    author_id { 1 }
+  end
+end

data/spec/historiographer_spec.rb

@@ -2,6 +2,7 @@ require "spec_helper"
 
 class Post < ActiveRecord::Base
   include Historiographer
+  acts_as_paranoid
 end
 
 class PostHistory < ActiveRecord::Base
@@ -31,6 +32,9 @@ end
 class ThingWithCompoundIndexHistory < ActiveRecord::Base
 end
 
+class ThingWithoutHistory < ActiveRecord::Base
+end
+
 describe Historiographer do
   before(:all) do
     @now = Timecop.freeze
@@ -129,6 +133,150 @@ describe Historiographer do
       )
     end
 
+    context "When directly hitting the database via SQL" do
+      context "#update_all" do
+        it "still updates histories" do
+          FactoryBot.create_list(:post, 3, history_user_id: 1)
+
+          posts = Post.all
+          expect(posts.count).to eq 3
+          expect(PostHistory.count).to eq 3
+          expect(posts.map(&:histories).map(&:count)).to all (eq 1)
+
+          posts.update_all(title: "My New Post Title", history_user_id: 1)
+
+          expect(PostHistory.count).to eq 6
+          expect(PostHistory.current.count).to eq 3
+          expect(posts.map(&:histories).map(&:count)).to all(eq 2)
+          expect(posts.map(&:current_history).map(&:title)).to all (eq "My New Post Title")
+          expect(Post.all).to respond_to :has_histories?
+
+          # It can update by sub-query
+          Post.where(id: [posts.first.id, posts.last.id]).update_all(title: "Brett's Post", history_user_id: 1)
+          posts = Post.all.reload.order(:id)
+          expect(posts.first.histories.count).to eq 3
+          expect(posts.second.histories.count).to eq 2
+          expect(posts.third.histories.count).to eq 3
+          expect(posts.first.title).to eq "Brett's Post"
+          expect(posts.second.title).to eq "My New Post Title"
+          expect(posts.third.title).to eq "Brett's Post"
+          expect(posts.first.current_history.title).to eq "Brett's Post"
+          expect(posts.second.current_history.title).to eq "My New Post Title"
+          expect(posts.third.current_history.title).to eq "Brett's Post"
+
+          posts.update_all_without_history(title: "Untracked")
+          expect(posts.first.histories.count).to eq 3
+          expect(posts.second.histories.count).to eq 2
+          expect(posts.third.histories.count).to eq 3
+
+          thing1 = ThingWithoutHistory.create(name: "Thing 1")
+          thing2 = ThingWithoutHistory.create(name: "Thing 2")
+
+          ThingWithoutHistory.all.update_all(name: "Thing 3")
+
+          expect(ThingWithoutHistory.all.map(&:name)).to all(eq "Thing 3")
+          expect(ThingWithoutHistory.all).to_not respond_to :has_histories?
+          expect(ThingWithoutHistory.all).to_not respond_to :update_all_without_history
+          expect(ThingWithoutHistory.all).to_not respond_to :delete_all_without_history
+        end
+        
+        it "respects safety" do
+          FactoryBot.create_list(:post, 3, history_user_id: 1)
+
+          posts = Post.all
+          expect(posts.count).to eq 3
+          expect(PostHistory.count).to eq 3
+          expect(posts.map(&:histories).map(&:count)).to all (eq 1)
+
+          expect {
+            posts.update_all(title: "My New Post Title")
+          }.to raise_error
+
+          posts.reload.map(&:title).each do |title|
+            expect(title).to_not eq "My New Post Title"
+          end
+
+          SafePost.create(
+            title: "Post 1",
+            body: "Great post",
+            author_id: 1,
+          )
+
+          safe_posts = SafePost.all
+
+          expect {
+            safe_posts.update_all(title: "New One")
+          }.to_not raise_error
+
+          expect(safe_posts.map(&:title)).to all(eq "New One")
+        end
+      end
+
+      context "#delete_all" do
+        it "includes histories when not paranoid" do
+          Timecop.freeze
+          authors = 3.times.map do
+            Author.create(full_name: "Brett", history_user_id: 1)
+          end
+          Author.delete_all(history_user_id: 1)
+          expect(AuthorHistory.count).to eq 3
+          expect(AuthorHistory.current.count).to eq 0
+          expect(AuthorHistory.where.not(history_ended_at: nil).count).to eq 3
+          expect(Author.count).to eq 0
+          Timecop.return
+        end
+
+        it "includes histories when paranoid" do
+          Timecop.freeze
+          posts = FactoryBot.create_list(:post, 3, history_user_id: 1)
+          Post.delete_all(history_user_id: 1)
+          expect(PostHistory.count).to eq 6
+          expect(PostHistory.current.count).to eq 3
+          expect(PostHistory.current.map(&:deleted_at)).to all(eq Time.now)
+          expect(PostHistory.current.map(&:history_user_id)).to all(eq 1)
+          expect(PostHistory.where(deleted_at: nil).where.not(history_ended_at: nil).count).to eq 3
+          expect(PostHistory.where(history_ended_at: nil).count).to eq 3
+          expect(Post.count).to eq 0
+          Timecop.return
+        end
+
+        it "allows delete_all_without_history" do
+          authors = 3.times.map do
+            Author.create(full_name: "Brett", history_user_id: 1)
+          end
+          Author.all.delete_all_without_history
+          expect(AuthorHistory.current.count).to eq 3
+          expect(Author.count).to eq 0
+        end
+      end
+
+      context "#destroy_all" do
+        it "includes histories" do
+          Timecop.freeze
+          posts = FactoryBot.create_list(:post, 3, history_user_id: 1)
+          Post.destroy_all(history_user_id: 1)
+          expect(PostHistory.count).to eq 6
+          expect(PostHistory.current.count).to eq 3
+          expect(PostHistory.current.map(&:deleted_at)).to all(eq Time.now)
+          expect(PostHistory.current.map(&:history_user_id)).to all(eq 1)
+          expect(PostHistory.where(deleted_at: nil).where.not(history_ended_at: nil).count).to eq 3
+          expect(PostHistory.where(history_ended_at: nil).count).to eq 3
+          expect(Post.count).to eq 0
+          Timecop.return
+        end
+
+        it "destroys without histories" do
+          Timecop.freeze
+          posts = FactoryBot.create_list(:post, 3, history_user_id: 1)
+          Post.all.destroy_all_without_history
+          expect(PostHistory.count).to eq 3
+          expect(PostHistory.current.count).to eq 3
+          expect(Post.count).to eq 0
+          Timecop.return
+        end
+      end
+    end
+
     context "When Safe mode" do
       it "creates history without history_user_id" do
         expect(Rollbar).to receive(:error).with("history_user_id must be passed in order to save record with histories! If you are in a context with no history_user_id, explicitly call #save_without_history")
@@ -274,20 +422,6 @@ describe Historiographer do
   
   describe "Deletion" do
     it "records deleted_at and history_user_id on primary and history if you use acts_as_paranoid" do
-      post = create_post
-
-      expect {
-        post.destroy(history_user_id: 2)
-      }.to_not change {
-        PostHistory.count
-      }
-
-      expect(PostHistory.last.history_ended_at).to_not be_nil
-      expect(PostHistory.last.deleted_at).to be_nil
-      class Post
-        acts_as_paranoid
-      end
-
       post = Post.create(
         title: "Post 1",
         body: "Great post",
@@ -316,101 +450,6 @@ describe Historiographer do
 
       expect(PostHistory.current.count).to be 1
     end
-
-    it "finds current even when the db is updated in an invalid way" do
-      postgresql = <<-SQL
-        INSERT INTO post_histories (
-          title,
-          body,
-          post_id,
-          author_id,
-          created_at,
-          updated_at,
-          history_started_at,
-          history_ended_at
-        ) VALUES (
-          'Post 1',
-          'Text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL '1 day',
-          NULL
-        ), (
-          'Post 1',
-          'Different text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL '12 hours',
-          NULL
-        ), (
-          'Post 1',
-          'Even more different text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL '12 hours',
-          NULL
-        )
-      SQL
-
-      mysql = <<-SQL
-        INSERT INTO post_histories (
-          title,
-          body,
-          post_id,
-          author_id,
-          created_at,
-          updated_at,
-          history_started_at,
-          history_ended_at
-        ) VALUES (
-          'Post 1',
-          'Text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL 1 day,
-          NULL
-        ), (
-          'Post 1',
-          'Different text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL 12 hour,
-          NULL
-        ), (
-          'Post 1',
-          'Even more different text',
-          1,
-          1,
-          now(),
-          now(),
-          now() - INTERVAL 12 hour,
-          NULL
-        )
-      SQL
-
-      sql = nil
-      case PostHistory.connection.instance_variable_get(:@config)[:adapter]
-      when "mysql2"
-        sql = mysql
-      when "postgresql"
-        sql = postgresql
-      end
-
-      PostHistory.connection.execute(sql)
-
-      expect(PostHistory.current.count).to be 1
-      expect(PostHistory.current.first.body).to eq "Even more different text"
-    end
   end
 
   describe "User associations" do

data/spec/spec_helper.rb

@@ -2,6 +2,10 @@ ENV["HISTORIOGRAPHY_ENV"] = "test"
 
 require_relative "../init.rb"
 require "ostruct"
+require "factory_bot"
+
+FactoryBot.definition_file_paths = %w{./factories ./spec/factories}
+FactoryBot.find_definitions
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -37,4 +41,12 @@ RSpec.configure do |config|
       example.run
     end
   end
+
+  config.before(:each, :logsql) do
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+
+  config.after(:each, :logsql) do
+    ActiveRecord::Base.logger = nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: historiographer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - brettshollenberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +233,7 @@ files:
 - lib/historiographer/history_migration_mysql.rb
 - lib/historiographer/mysql_migration.rb
 - lib/historiographer/postgres_migration.rb
+- lib/historiographer/relation.rb
 - lib/historiographer/safe.rb
 - spec/db/database.yml
 - spec/db/migrate/20161121212228_create_posts.rb
@@ -230,8 +245,10 @@ files:
 - 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/migrate/20191024203106_create_thing_without_history.rb
 - spec/db/schema.rb
 - spec/examples.txt
+- spec/factories/post.rb
 - spec/historiographer_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/brettshollenberger/historiographer