RubyGems - journaled - Versions diffs - 2.0.0.alpha1 → 2.0.0.rc1 - Mend

journaled 2.0.0.alpha1 → 2.0.0.rc1

Files changed (59) hide show

checksums.yaml +4 -4
data/README.md +95 -25
data/app/models/concerns/journaled/changes.rb +41 -0
data/app/models/journaled/actor_uri_provider.rb +22 -0
data/app/models/journaled/change_definition.rb +17 -1
data/app/models/journaled/change_writer.rb +3 -22
data/app/models/journaled/event.rb +0 -4
data/config/initializers/change_protection.rb +3 -0
data/lib/journaled.rb +9 -1
data/lib/journaled/relation_change_protection.rb +27 -0
data/lib/journaled/rspec.rb +18 -0
data/lib/journaled/version.rb +1 -1
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +26 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +21 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +78 -0
data/spec/dummy/config/environments/test.rb +39 -0
data/spec/dummy/config/initializers/assets.rb +8 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/db/migrate/20180606205114_create_delayed_jobs.rb +18 -0
data/spec/dummy/db/schema.rb +31 -0
data/spec/dummy/log/development.log +34 -0
data/spec/dummy/log/test.log +34540 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/lib/journaled_spec.rb +51 -0
data/spec/models/concerns/journaled/actor_spec.rb +46 -0
data/spec/models/concerns/journaled/changes_spec.rb +94 -0
data/spec/models/database_change_protection_spec.rb +106 -0
data/spec/models/journaled/actor_uri_provider_spec.rb +41 -0
data/spec/models/journaled/change_writer_spec.rb +276 -0
data/spec/models/journaled/delivery_spec.rb +156 -0
data/spec/models/journaled/event_spec.rb +145 -0
data/spec/models/journaled/json_schema_model/validator_spec.rb +133 -0
data/spec/models/journaled/writer_spec.rb +129 -0
data/spec/rails_helper.rb +20 -0
data/spec/spec_helper.rb +22 -0
data/spec/support/delayed_job_spec_helper.rb +11 -0
data/spec/support/environment_spec_helper.rb +16 -0
metadata +113 -4

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/lib/journaled_spec.rb ADDED

@@ -0,0 +1,51 @@
+require 'rails_helper'
+RSpec.describe Journaled do
+  it "is enabled in production" do
+    allow(Rails).to receive(:env).and_return("production")
+    expect(Journaled).to be_enabled
+  end
+  it "is disabled in development" do
+    allow(Rails).to receive(:env).and_return("development")
+    expect(Journaled).not_to be_enabled
+  end
+  it "is disabled in test" do
+    allow(Rails).to receive(:env).and_return("test")
+    expect(Journaled).not_to be_enabled
+  end
+  it "is enabled in whatevs" do
+    allow(Rails).to receive(:env).and_return("whatevs")
+    expect(Journaled).to be_enabled
+  end
+  it "is enabled when explicitly enabled in development" do
+    with_env(JOURNALED_ENABLED: true) do
+      allow(Rails).to receive(:env).and_return("development")
+      expect(Journaled).to be_enabled
+    end
+  end
+  it "is disabled when explicitly disabled in production" do
+    with_env(JOURNALED_ENABLED: false) do
+      allow(Rails).to receive(:env).and_return("production")
+      expect(Journaled).not_to be_enabled
+    end
+  end
+  it "is disabled when explicitly disabled with empty string" do
+    with_env(JOURNALED_ENABLED: '') do
+      allow(Rails).to receive(:env).and_return("production")
+      expect(Journaled).not_to be_enabled
+    end
+  end
+  describe "#actor_uri" do
+    it "delegates to ActorUriProvider" do
+      allow(Journaled::ActorUriProvider).to receive(:instance).and_return(double(actor_uri: "my actor uri"))
+      expect(Journaled.actor_uri).to eq "my actor uri"
+    end
+  end
+end

data/spec/models/concerns/journaled/actor_spec.rb ADDED

@@ -0,0 +1,46 @@
+require 'rails_helper'
+# This is a controller mixin, but testing as a model spec!
+RSpec.describe Journaled::Actor do
+  let(:user) { double("User") }
+  let(:klass) do
+    Class.new do
+      cattr_accessor :before_actions
+      self.before_actions = []
+      def self.before_action(&hook)
+        before_actions << hook
+      end
+      include Journaled::Actor
+      self.journaled_actor = :current_user
+      def current_user
+        nil
+      end
+      def trigger_before_actions
+        before_actions.each { |proc| instance_eval(&proc) }
+      end
+    end
+  end
+  subject { klass.new }
+  it "Stores a thunk returning nil if current_user returns nil" do
+    subject.trigger_before_actions
+    allow(subject).to receive(:current_user).and_return(nil)
+    expect(RequestStore.store[:journaled_actor_proc].call).to eq nil
+  end
+  it "Stores a thunk returning current_user if it is set when called" do
+    subject.trigger_before_actions
+    allow(subject).to receive(:current_user).and_return(user)
+    expect(RequestStore.store[:journaled_actor_proc].call).to eq user
+  end
+end

data/spec/models/concerns/journaled/changes_spec.rb ADDED

@@ -0,0 +1,94 @@
+require 'rails_helper'
+RSpec.describe Journaled::Changes do
+  let(:klass) do
+    Class.new do
+      cattr_accessor :after_create_hooks
+      self.after_create_hooks = []
+      cattr_accessor :after_save_hooks
+      self.after_save_hooks = []
+      cattr_accessor :after_destroy_hooks
+      self.after_destroy_hooks = []
+      def self.after_create(&hook)
+        after_create_hooks << hook
+      end
+      def self.after_save(opts, &hook)
+        # This is a back-door assertion to prevent regressions in the module's hook definition behavior
+        raise "expected `unless: :saved_change_to_id?`" unless opts[:unless] == :saved_change_to_id?
+        after_save_hooks << hook
+      end
+      def self.after_destroy(&hook)
+        after_destroy_hooks << hook
+      end
+      include Journaled::Changes
+      journal_changes_to :my_heart, as: :change_of_heart
+      def trigger_after_create_hooks
+        after_create_hooks.each { |proc| instance_eval(&proc) }
+      end
+      def trigger_after_save_hooks
+        after_save_hooks.each { |proc| instance_eval(&proc) }
+      end
+      def trigger_after_destroy_hooks
+        after_destroy_hooks.each { |proc| instance_eval(&proc) }
+      end
+    end
+  end
+  subject { klass.new }
+  let(:change_writer) { double(Journaled::ChangeWriter, create: true, update: true, delete: true) }
+  before do
+    allow(Journaled::ChangeWriter).to receive(:new) do |opts|
+      expect(opts[:model]).to eq(subject)
+      expect(opts[:change_definition].logical_operation).to eq(:change_of_heart)
+      change_writer
+    end
+  end
+  it "can be asserted on with our matcher" do
+    expect(klass).to journal_changes_to(:my_heart, as: :change_of_heart)
+    expect(klass).not_to journal_changes_to(:your_heart, as: :something_else)
+    expect {
+      expect(klass).to journal_changes_to(:foobaloo, as: :an_event_to_remember)
+    }.to raise_error(/> to journal changes to :foobaloo as :an_event_to_remember/)
+    expect {
+      expect(klass).not_to journal_changes_to(:my_heart, as: :change_of_heart)
+    }.to raise_error(/> not to journal changes to :my_heart as :change_of_heart/)
+  end
+  it "has a single change definition" do
+    expect(klass._journaled_change_definitions.length).to eq 1
+  end
+  it "journals create events on create" do
+    subject.trigger_after_create_hooks
+    expect(change_writer).to have_received(:create)
+    expect(Journaled::ChangeWriter).to have_received(:new)
+  end
+  it "journals update events on save" do
+    subject.trigger_after_save_hooks
+    expect(change_writer).to have_received(:update)
+    expect(Journaled::ChangeWriter).to have_received(:new)
+  end
+  it "journals delete events on destroy" do
+    subject.trigger_after_destroy_hooks
+    expect(change_writer).to have_received(:delete)
+    expect(Journaled::ChangeWriter).to have_received(:new)
+  end
+end

data/spec/models/database_change_protection_spec.rb ADDED

@@ -0,0 +1,106 @@
+require 'rails_helper'
+# rubocop:disable Rails/SkipsModelValidations
+RSpec.describe "Raw database change protection" do
+  let(:journaled_class) do
+    Class.new(Delayed::Job) do
+      include Journaled::Changes
+      journal_changes_to :locked_at, as: :attempt
+    end
+  end
+  let(:journaled_class_with_no_journaled_columns) do
+    Class.new(Delayed::Job) do
+      include Journaled::Changes
+    end
+  end
+  describe "the relation" do
+    describe "#update_all" do
+      it "refuses on journaled columns" do
+        expect { journaled_class.update_all(locked_at: nil) }.to raise_error(/aborted by Journaled/)
+      end
+      it "succeeds on unjournaled columns" do
+        expect { journaled_class.update_all(handler: "") }.not_to raise_error
+      end
+      it "succeeds when forced on journaled columns" do
+        expect { journaled_class.update_all({ locked_at: nil }, force: true) }.not_to raise_error
+      end
+    end
+    describe "#delete" do
+      it "refuses if journaled columns exist" do
+        expect { journaled_class.delete(1) }.to raise_error(/aborted by Journaled/)
+      end
+      it "succeeds if no journaled columns exist" do
+        expect { journaled_class_with_no_journaled_columns.delete(1) }.not_to raise_error
+      end
+      it "succeeds if journaled columns exist when forced" do
+        expect { journaled_class.delete(1, force: true) }.not_to raise_error
+      end
+    end
+    describe "#delete_all" do
+      it "refuses if journaled columns exist" do
+        expect { journaled_class.delete_all }.to raise_error(/aborted by Journaled/)
+      end
+      it "succeeds if no journaled columns exist" do
+        expect { journaled_class_with_no_journaled_columns.delete_all }.not_to raise_error
+      end
+      it "succeeds if journaled columns exist when forced" do
+        expect { journaled_class.delete_all(force: true) }.not_to raise_error
+      end
+    end
+  end
+  describe "an instance" do
+    let(:job) do
+      module TestJob
+        def perform
+          "foo"
+        end
+        module_function :perform
+      end
+    end
+    subject { journaled_class.enqueue(job) }
+    describe "#update_columns" do
+      it "refuses on journaled columns" do
+        expect { subject.update_columns(locked_at: nil) }.to raise_error(/aborted by Journaled/)
+      end
+      it "succeeds on unjournaled columns" do
+        expect { subject.update_columns(handler: "") }.not_to raise_error
+      end
+      it "succeeds when forced on journaled columns" do
+        expect { subject.update_columns({ locked_at: nil }, force: true) }.not_to raise_error
+      end
+    end
+    describe "#delete" do
+      it "refuses if journaled columns exist" do
+        expect { subject.delete }.to raise_error(/aborted by Journaled/)
+      end
+      it "succeeds if no journaled columns exist" do
+        instance = journaled_class_with_no_journaled_columns.enqueue(job)
+        expect { instance.delete }.not_to raise_error
+      end
+      it "succeeds if journaled columns exist when forced" do
+        expect { subject.delete(force: true) }.not_to raise_error
+      end
+    end
+  end
+end
+# rubocop:enable Rails/SkipsModelValidations