transcript 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b20d6d6f59ef113036dddfa9739d4fc16dc10b0
-  data.tar.gz: ea8aa8e46168e4dbddaa027f2820f6e83e7373ec
+  metadata.gz: 9e04f6c3c1dd6ca723c39b456a26e7b130e843fc
+  data.tar.gz: c7cd0d7476473cfe66ca443e5b40254fc53e366e
 SHA512:
-  metadata.gz: c58484693521b8da900784752ba56c334b7141d2af4163ce68b345b4010457fd43450eb2a9d307754dda9dc23ebafda1a7ec173d1a82999a360a4800778e66a0
-  data.tar.gz: 931079903ab30d12e4a52d9701120e22613d2dbe51a7be57764582d34b64df65b2b3f5f319e1af6c98976216ab8a8d6ff5f3620fc32a1c0faeb7c86c7d6fb2c8
+  metadata.gz: d63d943fb6cbaa5cd3f681788111f028407813b0aed8cbfac2e8510b6b998826967304f33c5119ee8858c2d50b5d1c7ff1736380fb880129e338e86a3b036f54
+  data.tar.gz: 58d11b15a2e01ffd08b7a55b240cb12b1e5a86cff8e45cc9990541c2b395001e4fc13809e9e9fba59c9dd36d59c232f84d2ccc4599373baa3c93ba40ddb644fc

data/Gemfile.lock

@@ -1,45 +1,45 @@
 PATH
   remote: .
   specs:
-    transcript (0.1.0)
-      rails (~> 5.0)
+    transcript (0.2.0)
+      rails (~> 5.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.0.1)
-      actionpack (= 5.0.0.1)
-      nio4r (~> 1.2)
+    actioncable (5.0.4)
+      actionpack (= 5.0.4)
+      nio4r (>= 1.2, < 3.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.0.1)
-      actionpack (= 5.0.0.1)
-      actionview (= 5.0.0.1)
-      activejob (= 5.0.0.1)
+    actionmailer (5.0.4)
+      actionpack (= 5.0.4)
+      actionview (= 5.0.4)
+      activejob (= 5.0.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.0.1)
-      actionview (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    actionpack (5.0.4)
+      actionview (= 5.0.4)
+      activesupport (= 5.0.4)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.0.1)
-      activesupport (= 5.0.0.1)
+    actionview (5.0.4)
+      activesupport (= 5.0.4)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.0.1)
-      activesupport (= 5.0.0.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.4)
+      activesupport (= 5.0.4)
       globalid (>= 0.3.6)
-    activemodel (5.0.0.1)
-      activesupport (= 5.0.0.1)
-    activerecord (5.0.0.1)
-      activemodel (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    activemodel (5.0.4)
+      activesupport (= 5.0.4)
+    activerecord (5.0.4)
+      activemodel (= 5.0.4)
+      activesupport (= 5.0.4)
       arel (~> 7.0)
-    activesupport (5.0.0.1)
+    activesupport (5.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -48,11 +48,11 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
-    arel (7.1.1)
-    builder (3.2.2)
+    arel (7.1.4)
+    builder (3.2.3)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.2.5)
     docile (1.1.5)
     erubis (2.7.0)
@@ -61,48 +61,46 @@ GEM
     factory_girl_rails (4.7.0)
       factory_girl (~> 4.7.0)
       railties (>= 3.0.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
     json (2.0.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
+    mail (2.6.6)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    nio4r (1.2.1)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
-    rack (2.0.1)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.0.1)
-      actioncable (= 5.0.0.1)
-      actionmailer (= 5.0.0.1)
-      actionpack (= 5.0.0.1)
-      actionview (= 5.0.0.1)
-      activejob (= 5.0.0.1)
-      activemodel (= 5.0.0.1)
-      activerecord (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    rails (5.0.4)
+      actioncable (= 5.0.4)
+      actionmailer (= 5.0.4)
+      actionpack (= 5.0.4)
+      actionview (= 5.0.4)
+      activejob (= 5.0.4)
+      activemodel (= 5.0.4)
+      activerecord (= 5.0.4)
+      activesupport (= 5.0.4)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.0.1)
+      railties (= 5.0.4)
       sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.1)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.0.1)
-      actionpack (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    railties (5.0.4)
+      actionpack (= 5.0.4)
+      activesupport (= 5.0.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -135,19 +133,19 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sprockets (3.7.0)
+    sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.1.1)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.11)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.4)
+    websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
 
@@ -167,4 +165,4 @@ DEPENDENCIES
   transcript!
 
 BUNDLED WITH
-   1.12.5
+   1.15.1

data/README.md

@@ -22,14 +22,14 @@ gem 'transcript'
 
 And then execute:
 
-```sh
-$ bundle
+```bash
+bundle
 ```
 
 Next, run the generator to install:
 
-```sh
-$ rails generate transcript:install NAME
+```bash
+rails generate transcript:install NAME
 ```
 
 This generates a Transcript model, which can be called anything, and an initializer, specifying some configuration.
@@ -65,7 +65,7 @@ This interface sets up relationships to the log. To get a list of all the entrie
 The receiver, similar to the actor, can be any individual model, and as many models as required. To add a new receiver, include the concern:
 
 ```ruby
-class Post < ActiveRecord::Post
+class Post < ActiveRecord::Base
   include Transcript::Receiver
 end
 ```
@@ -124,7 +124,8 @@ end
 
 Now, in any action, make a call to the helper. The method expects an object representing the actor and the object that is being acted upon. You can optionally pass a custom action name as a third argument as a string representing the verb (e.g. `create`, `delete`, or `export`). If no custom action is provided Transcript will infer from the controller action it's being called in.
 
-**Implied action:**
+#### Implied action
+
 ```ruby
 def create
   audit_action current_user, @comment
@@ -132,7 +133,8 @@ def create
 end
 ```
 
-**Custom action:**
+#### Custom action
+
 ```ruby
 def send_password_reset
   audit_action current_user, @user, "password_reset"
@@ -140,6 +142,16 @@ def send_password_reset
 end
 ```
 
+### Background Job
+
+Transcript includes an ActiveJob class to create audit entries in the background. However, it can also be run in synchronous mode where entries are created inline. This is handled with a configuration value, which by default is set to synchronous mode.
+
+```ruby
+Transcript.configure do |config|
+  config.create_mode = :asynchronous # use backgrounding or :synchronous for inline
+end
+```
+
 ## Known Issues
 
 ### UUIDs
@@ -163,7 +175,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/newaperio/transcript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/newaperio/transcript). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/generators/transcript/templates/transcript.rb.erb

@@ -1,3 +1,3 @@
 Transcript.configure do |config|
-  config.audit_model = <%= class_name %>
+  config.audit_model = '<%= class_name %>'
 end

data/lib/transcript/actor.rb

@@ -7,7 +7,7 @@ module Transcript
     included do
       has_many :audit_entries_by,
         as: :actor,
-        class_name: Transcript.configuration.audit_model
+        class_name: Transcript.configuration.audit_model.to_s
     end
   end
 end

data/lib/transcript/configuration.rb

@@ -1,5 +1,27 @@
 module Transcript
   class Configuration
+    CREATE_MODES = [:asynchronous, :synchronous]
+
+    class UnsupportedCreateMode < StandardError; end
+
     attr_accessor :audit_model
+    attr_reader :create_mode
+
+    def initialize
+      @create_mode = :synchronous
+    end
+
+    def create_mode=(mode)
+      mode = mode.to_sym
+
+      raise UnsupportedCreateMode unless CREATE_MODES.include?(mode)
+      @create_mode = mode
+    ensure
+      @create_mode = :synchronous if @create_mode.nil?
+    end
+
+    def job_method
+      create_mode.to_sym == :asynchronous ? :perform_later : :perform_now
+    end
   end
 end

data/lib/transcript/controller.rb

@@ -5,7 +5,10 @@ module Transcript
     extend ActiveSupport::Concern
 
     def audit_action(actor, receiver, action = action_name)
-      Transcript::Job.perform_later(actor, receiver, action)
+      Transcript::Job.send(
+        Transcript.configuration.job_method,
+        actor, receiver, action
+      )
     end
   end
 end

data/lib/transcript/version.rb

@@ -1,3 +1,3 @@
 module Transcript
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/dummy/config/initializers/transcript.rb

@@ -1,3 +1,4 @@
 Transcript.configure do |config|
   config.audit_model = AuditEntry
+  config.create_mode = :asynchronous
 end

data/spec/generators/install_generator_spec.rb

@@ -37,7 +37,7 @@ RSpec.describe Transcript::InstallGenerator, type: :generator do
 
     expect(initializer).to exist
     expect(initializer).to have_correct_syntax
-    expect(initializer).to contain("config.audit_model = AuditLog")
+    expect(initializer).to contain("config.audit_model = 'AuditLog'")
   end
 
   it "includes the controller concern in ApplicationController" do

data/spec/transcript/configuration_spec.rb

@@ -1,7 +1,32 @@
 RSpec.describe Transcript::Configuration do
   it "accepts a custom audit model" do
-    Transcript.configure { |config| config.audit_model = AuditEntry }
+    config = Transcript::Configuration.new
+    config.audit_model = AuditEntry
 
-    expect(Transcript.configuration.audit_model).to eq AuditEntry
+    expect(config.audit_model).to eq AuditEntry
+  end
+
+  it "has a default create mode" do
+    config = Transcript::Configuration.new
+
+    expect(config.create_mode).to eq :synchronous
+    expect(config.job_method).to eq :perform_now
+  end
+
+  it "accepts a create mode option" do
+    config = Transcript::Configuration.new
+    config.create_mode = :asynchronous
+
+    expect(config.create_mode).to eq :asynchronous
+    expect(config.job_method).to eq :perform_later
+  end
+
+  it "raises an error if unsupported create mode is given" do
+    config = Transcript::Configuration.new
+
+    expect { config.create_mode = :foo }.to raise_error(
+      Transcript::Configuration::UnsupportedCreateMode
+    )
+    expect(config.create_mode).to eq :synchronous
   end
 end

data/transcript.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "shoulda-matchers", "~> 3.1"
   spec.add_development_dependency "simplecov", "~> 0.12"
   spec.add_development_dependency "sqlite3", "~> 1.3"
-  spec.add_runtime_dependency "rails", "~> 5.0"
+  spec.add_runtime_dependency "rails", "~> 5.0.4"
   spec.authors = ["Logan Leger", "NewAperio"]
   spec.description = <<-DESC
 Transcript is a simple audit library. It provides a clean interface for

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transcript
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Logan Leger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.4
 description: |
   Transcript is a simple audit library. It provides a clean interface for
   recording changes to a given record, including metadata about the change itself.
@@ -291,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple ActiveRecord auditing.