historiographer 1.0.0

data/spec/db/migrate/20171011194624_create_safe_posts.rb

@@ -0,0 +1,19 @@
+class CreateSafePosts < ActiveRecord::Migration[5.1]
+  def change
+    create_table :safe_posts do |t|
+      t.string :title, null: false
+      t.text :body, null: false
+      t.integer :author_id, null: false
+      t.boolean :enabled, default: false
+      t.datetime :live_at
+      t.datetime :deleted_at
+
+      t.timestamps
+    end
+
+    add_index :safe_posts, :author_id
+    add_index :safe_posts, :enabled
+    add_index :safe_posts, :live_at
+    add_index :safe_posts, :deleted_at
+  end
+end

data/spec/db/migrate/20171011194715_create_safe_post_histories.rb

@@ -0,0 +1,9 @@
+require "historiographer/postgres_migration"
+
+class CreateSafePostHistories < ActiveRecord::Migration[5.1]
+  def change
+    create_table :safe_post_histories do |t|
+      t.histories
+    end
+  end
+end

data/spec/db/schema.rb

@@ -0,0 +1,121 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2017_10_11_194715) do
+
+  create_table "author_histories", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+    t.integer "author_id", null: false
+    t.string "full_name", null: false
+    t.text "bio"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.datetime "history_started_at", null: false
+    t.datetime "history_ended_at"
+    t.integer "history_user_id"
+    t.index ["author_id"], name: "index_author_histories_on_author_id"
+    t.index ["deleted_at"], name: "index_author_histories_on_deleted_at"
+    t.index ["history_ended_at"], name: "index_author_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_author_histories_on_history_started_at"
+    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|
+    t.string "full_name", null: false
+    t.text "bio"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    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|
+    t.integer "post_id", null: false
+    t.string "title", null: false
+    t.text "body", null: false
+    t.integer "author_id", null: false
+    t.boolean "enabled", default: false
+    t.datetime "live_at"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.datetime "history_started_at", null: false
+    t.datetime "history_ended_at"
+    t.integer "history_user_id"
+    t.index ["author_id"], name: "index_post_histories_on_author_id"
+    t.index ["deleted_at"], name: "index_post_histories_on_deleted_at"
+    t.index ["enabled"], name: "index_post_histories_on_enabled"
+    t.index ["history_ended_at"], name: "index_post_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_post_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_post_histories_on_history_user_id"
+    t.index ["live_at"], name: "index_post_histories_on_live_at"
+    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|
+    t.string "title", null: false
+    t.text "body", null: false
+    t.integer "author_id", null: false
+    t.boolean "enabled", default: false
+    t.datetime "live_at"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["author_id"], name: "index_posts_on_author_id"
+    t.index ["deleted_at"], name: "index_posts_on_deleted_at"
+    t.index ["enabled"], name: "index_posts_on_enabled"
+    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|
+    t.integer "safe_post_id", null: false
+    t.string "title", null: false
+    t.text "body", null: false
+    t.integer "author_id", null: false
+    t.boolean "enabled", default: false
+    t.datetime "live_at"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.datetime "history_started_at", null: false
+    t.datetime "history_ended_at"
+    t.integer "history_user_id"
+    t.index ["author_id"], name: "index_safe_post_histories_on_author_id"
+    t.index ["deleted_at"], name: "index_safe_post_histories_on_deleted_at"
+    t.index ["enabled"], name: "index_safe_post_histories_on_enabled"
+    t.index ["history_ended_at"], name: "index_safe_post_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_safe_post_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_safe_post_histories_on_history_user_id"
+    t.index ["live_at"], name: "index_safe_post_histories_on_live_at"
+    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|
+    t.string "title", null: false
+    t.text "body", null: false
+    t.integer "author_id", null: false
+    t.boolean "enabled", default: false
+    t.datetime "live_at"
+    t.datetime "deleted_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["author_id"], name: "index_safe_posts_on_author_id"
+    t.index ["deleted_at"], name: "index_safe_posts_on_deleted_at"
+    t.index ["enabled"], name: "index_safe_posts_on_enabled"
+    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|
+    t.string "name"
+  end
+
+end

data/spec/examples.txt

@@ -0,0 +1,21 @@
+example_id                              | status | run_time        |
+--------------------------------------- | ------ | --------------- |
+./spec/historiographer_spec.rb[1:1:1]   | passed | 0.00794 seconds |
+./spec/historiographer_spec.rb[1:1:2]   | passed | 0.04572 seconds |
+./spec/historiographer_spec.rb[1:1:3]   | passed | 0.03308 seconds |
+./spec/historiographer_spec.rb[1:2:1]   | passed | 0.0742 seconds  |
+./spec/historiographer_spec.rb[1:2:2]   | passed | 0.00138 seconds |
+./spec/historiographer_spec.rb[1:2:3:1] | passed | 0.01369 seconds |
+./spec/historiographer_spec.rb[1:2:3:2] | passed | 0.059 seconds   |
+./spec/historiographer_spec.rb[1:2:3:3] | passed | 0.00794 seconds |
+./spec/historiographer_spec.rb[1:2:4]   | passed | 0.00348 seconds |
+./spec/historiographer_spec.rb[1:2:5]   | passed | 0.03144 seconds |
+./spec/historiographer_spec.rb[1:2:6]   | passed | 0.01239 seconds |
+./spec/historiographer_spec.rb[1:3:1]   | passed | 0.04853 seconds |
+./spec/historiographer_spec.rb[1:4:1]   | passed | 0.03917 seconds |
+./spec/historiographer_spec.rb[1:5:1]   | passed | 0.03402 seconds |
+./spec/historiographer_spec.rb[1:5:2]   | passed | 0.02494 seconds |
+./spec/historiographer_spec.rb[1:6:1]   | passed | 0.0287 seconds  |
+./spec/historiographer_spec.rb[1:7:1]   | passed | 0.07329 seconds |
+./spec/historiographer_spec.rb[1:7:2]   | passed | 0.01293 seconds |
+./spec/historiographer_spec.rb[1:8:1]   | passed | 0.08211 seconds |

data/spec/historiographer_spec.rb

@@ -0,0 +1,395 @@
+require "spec_helper"
+
+class Post < ActiveRecord::Base
+  include Historiographer
+end
+
+class PostHistory < ActiveRecord::Base
+end
+
+class SafePost < ActiveRecord::Base
+  include Historiographer::Safe
+end
+
+class SafePostHistory < ActiveRecord::Base
+end
+
+class Author < ActiveRecord::Base
+  include Historiographer
+end
+
+class AuthorHistory < ActiveRecord::Base
+end
+
+class User < ActiveRecord::Base
+end
+
+describe Historiographer do
+  before(:all) do
+    @now = Timecop.freeze
+  end
+
+  after(:all) do
+    Timecop.return
+  end
+
+  let(:username) { "Test User" }
+
+  let(:user) do
+    User.create(name: username)
+  end
+
+  let(:create_post) do
+    Post.create(
+      title: "Post 1",
+      body: "Great post",
+      author_id: 1,
+      history_user_id: user.id
+    )
+  end
+
+  let(:create_author) do
+    Author.create(
+      full_name: "Breezy",
+      history_user_id: user.id
+    )
+  end
+
+  describe "History counting" do
+    it "creates history on creation of primary model record" do
+      expect {
+        create_post
+      }.to change {
+        PostHistory.count
+      }.by 1
+    end
+
+    it "appends new history on update" do
+      post = create_post
+
+      expect {
+        post.update(title: "Better Title")
+      }.to change {
+        PostHistory.count
+      }.by 1
+    end
+
+    it "does not append new history if nothing has changed" do
+      post = create_post
+
+      expect { 
+        post.update(title: post.title)
+      }.to_not change {
+        PostHistory.count
+      }
+    end
+  end
+
+  describe "History recording" do
+    it "records all fields from the parent" do
+      post         = create_post
+      post_history = post.histories.first
+
+      expect(post_history.title).to eq     post.title
+      expect(post_history.body).to eq      post.body
+      expect(post_history.author_id).to eq post.author_id
+      expect(post_history.post_id).to eq   post.id
+      expect(post_history.history_started_at.to_s).to eq @now.in_time_zone(Historiographer::UTC).to_s
+      expect(post_history.history_ended_at).to be_nil
+      expect(post_history.history_user_id).to eq user.id
+
+      post.update(title: "Better title")
+      post_histories = post.histories.reload.order("id asc")
+      first_history  = post_histories.first
+      second_history = post_histories.second
+
+      expect(first_history.history_ended_at.to_s).to eq @now.in_time_zone(Historiographer::UTC).to_s
+      expect(second_history.history_ended_at).to be_nil
+    end
+
+    it "cannot create without history_user_id" do
+      post = Post.create(
+        title: "Post 1",
+        body: "Great post",
+        author_id: 1,
+      ) 
+      expect(post.errors.to_h).to eq({ :history_user_id => "must be an integer" })
+
+      expect {
+        post.send(:record_history)
+      }.to raise_error(
+        Historiographer::HistoryUserIdMissingError
+      )
+    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")
+
+        post = SafePost.create(
+          title: "Post 1",
+          body: "Great post",
+          author_id: 1,
+        ) 
+        expect(post.errors.to_h.keys).to be_empty
+        expect(post).to be_persisted
+        expect(post.histories.count).to eq 1
+        expect(post.histories.first.history_user_id).to be_nil
+      end
+
+      it "creates history with history_user_id" do
+        expect(Rollbar).to_not receive(:error)
+
+        post = SafePost.create(
+          title: "Post 1",
+          body: "Great post",
+          author_id: 1,
+          history_user_id: user.id
+        ) 
+        expect(post.errors.to_h.keys).to be_empty
+        expect(post).to be_persisted
+        expect(post.histories.count).to eq 1
+        expect(post.histories.first.history_user_id).to eq user.id
+      end
+
+       it "skips history creation if desired" do
+        post = SafePost.new(
+          title: "Post 1",
+          body: "Great post",
+          author_id: 1
+        ) 
+
+        post.save_without_history
+        expect(post).to be_persisted
+        expect(post.histories.count).to eq 0
+       end
+    end
+
+    it "can override without history_user_id" do
+      expect { 
+        post = Post.new(
+          title: "Post 1",
+          body: "Great post",
+          author_id: 1,
+        ) 
+
+        post.save_without_history
+      }.to_not raise_error
+    end
+
+    it "can override without history_user_id" do
+      expect { 
+        post = Post.new(
+          title: "Post 1",
+          body: "Great post",
+          author_id: 1,
+        ) 
+
+        post.save_without_history!
+      }.to_not raise_error
+    end
+
+    it "does not record histories when main model fails to save" do
+      class Post
+        after_save :raise_error, prepend: true
+
+        def raise_error
+          raise "Oh no, db issue!"
+        end
+      end
+
+      expect { create_post }.to raise_error
+      expect(Post.count).to be 0
+      expect(PostHistory.count).to be 0
+
+      Post.skip_callback(:save, :after, :raise_error)
+    end
+  end
+
+  describe "Scopes" do
+    it "finds current histories" do
+      post1 = create_post
+      post1.update(title: "Better title")
+
+      post2 = create_post
+      post2.update(title: "Better title")
+
+      expect(PostHistory.current.pluck(:title)).to all eq "Better title"
+      expect(post1.current_history.title).to eq "Better title"
+    end
+  end
+
+  describe "Associations" do
+    it "names associated records" do
+      post1 = create_post
+      expect(post1.histories.first).to be_a(PostHistory)
+
+      expect(post1.histories.first.post).to be(post1)
+
+      author1 = create_author
+      expect(author1.histories.first).to be_a(AuthorHistory)
+
+      expect(author1.histories.first.author).to be(author1)
+    end
+  end
+
+  describe "Histories" do
+    it "does not allow direct updates of histories" do
+      post1 = create_post
+      hist1 = post1.histories.first
+
+      expect(hist1.update(title: "A different title")).to be false
+      expect(hist1.reload.title).to eq post1.title
+
+      expect(hist1.update!(title: "A different title")).to be false
+      expect(hist1.reload.title).to eq post1.title
+
+      hist1.title = "A different title"
+      expect(hist1.save).to be false
+      expect(hist1.reload.title).to eq post1.title
+
+      hist1.title = "A different title"
+      expect(hist1.save!).to be false
+      expect(hist1.reload.title).to eq post1.title
+    end
+
+    it "does not allow destroys of histories" do
+      post1                  = create_post
+      hist1                  = post1.histories.first
+      original_history_count = post1.histories.count
+
+      expect(hist1.destroy).to be false
+      expect(hist1.destroy!).to be false
+
+      expect(post1.histories.count).to be original_history_count
+    end
+  end
+  
+  describe "Deletion" do
+    it "records deleted_at on primary and history if you use acts_as_paranoid" do
+      class Post
+        acts_as_paranoid
+      end
+
+      post = create_post
+
+      expect {
+        post.destroy
+      }.to change {
+        PostHistory.count
+      }.by 1
+
+      expect(Post.unscoped.where.not(deleted_at: nil).count).to eq 1
+      expect(Post.unscoped.where(deleted_at: nil).count).to eq 0
+      expect(PostHistory.where.not(deleted_at: nil).count).to eq 1
+      expect(PostHistory.where(deleted_at: nil).count).to eq 1
+    end
+  end
+
+  describe "Scopes" do
+    it "finds current" do
+      post = create_post
+      post.update(title: "New Title")
+      post.update(title: "New Title 2")
+
+      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,
+          history_started_at,
+          history_ended_at
+        ) VALUES (
+          'Post 1',
+          'Text',
+          1,
+          1,
+          now() - INTERVAL '1 day',
+          NULL
+        ), (
+          'Post 1',
+          'Different text',
+          1,
+          1,
+          now() - INTERVAL '12 hours',
+          NULL
+        ), (
+          'Post 1',
+          'Even more different text',
+          1,
+          1,
+          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
+    it "links to user" do
+      post = create_post
+      author = create_author
+
+      expect(post.current_history.user.name).to eq username
+      expect(author.current_history.user.name).to eq username
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+ENV["HISTORIOGRAPHY_ENV"] = "test"
+
+require_relative "../init.rb"
+require "ostruct"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end