paper_trail-sinatra 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 02b7ddf0982ce846ee50323035eda996cd94dc3252f1093b520b525a41fc2f22
-  data.tar.gz: 1248c0a0fd5d0c509396c33308a896fbdc4c559e39a2da63311df2831cea2eaf
+SHA1:
+  metadata.gz: 6d6d8c636449a424b7c0abdbc05cc80bdfe79d2a
+  data.tar.gz: a0a674060d20173bc2fdc012b91d479043ab5f38
 SHA512:
-  metadata.gz: 854c929dd6a47cd3284e5ed1207ebfd5917c1e38348890ff9e7580cfac014fefa42d4fa7b3b7dc3864595a59c33e71300f8a7892eca95ad122a3fefabce25dfe
-  data.tar.gz: 7137fb6dc2db905aabd5e60bbaf512eae371c32942999b4e3959a52329c4d3f44055392c8650e0f0607d3b28db539a3b81f92ba7f47d5b561e46085fb91aedbc
+  metadata.gz: 7e4c53518748ed4db5417ca3c55c345e4e4e29df03e354e3c728800e3568695f674e8b10748b7613afc9d512b7b153337c9fca274fa3424a3ddf58bdb40f6cfa
+  data.tar.gz: 0b1a95a6976c92541cfd027e85b61f21aa682c19f9421cd59f0ce354ded240254d5173bd84c0e4f3683412186fe51f58f8a1f63fb2e3f14abb678a21fa4860b9

data/.gitignore

@@ -6,6 +6,7 @@
 /coverage/
 /doc/
 /pkg/
+/spec/gemfiles/*.lock
 /spec/reports/
 /spec/examples.txt
 /tmp/

data/.travis.yml

@@ -0,0 +1,22 @@
+before_install:
+  - gem update --system
+  - gem update bundler
+before_script:
+  - mkdir db
+  - touch db/test.sqlite3
+  - sqlite3 db/test.sqlite3 < spec/create_db.sql
+gemfile:
+  - spec/gemfiles/Gemfile_pt7_sinatra1.rb
+  - spec/gemfiles/Gemfile_pt7_sinatra2.rb
+  - spec/gemfiles/Gemfile_pt8_sinatra1.rb
+  - spec/gemfiles/Gemfile_pt8_sinatra2.rb
+language: ruby
+
+# For ruby compatibility, we test the highest and lowest minor versions only.
+rvm:
+  - 2.5.0
+  - 2.2.9
+
+script:
+  - bundle exec rspec
+sudo: false

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Change Log
 
+## Unreleased
+
+Breaking Changes
+
+- None
+
+Added
+
+- None
+
+Fixed
+
+- None
+
+## 0.4.0 (2018-02-22)
+
+Breaking Changes
+
+- Drop support for activesupport < 4.2 (EoL)
+- Drop support for ruby < 2.2 (EoL, and required by sinatra 2)
+
+Added
+
+- [#5](https://github.com/jaredbeck/paper_trail-sinatra/pull/5) -
+  Two methods familiar to rails users
+  - info_for_paper_trail
+  - paper_trail_enabled_for_request
+
+Fixed
+
+- None
+
 ## 0.3.0 (2017-12-10)
 
 Breaking Changes

data/README.md

@@ -32,12 +32,23 @@ into the `create_versions` migration that was generated into your `db/migrate` d
 
 5. Add `has_paper_trail` to the models you want to track.
 
-PaperTrail provides a helper extension that acts similar to the controller mixin
+PaperTrail provides some helper extensions that acts similar to the controller mixin
 it provides for `Rails` applications.
 
-It will set `PaperTrail.whodunnit` to whatever is returned by a method named
-`user_for_paper_trail` which you can define inside your Sinatra Application. (by
-default it attempts to invoke a method named `current_user`)
+In your helpers you can override these methods:
+
+```ruby
+# Returns the user who is responsible for any changes that occur.
+# Defaults to current_user.
+user_for_paper_trail
+
+# Returns any information about the controller or request that you want
+# PaperTrail to store alongside any changes that occur.
+info_for_paper_trail
+
+# Returns `true` (default) or `false` to turn PaperTrail on/off for per request.
+paper_trail_enabled_for_request
+```
 
 If you're using the modular [`Sinatra::Base`][4] style of application, you will
 need to register the extension:

data/lib/paper_trail/sinatra/version.rb

@@ -1,5 +1,5 @@
 module PaperTrail
   module Sinatra
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/paper_trail/sinatra.rb

@@ -10,7 +10,11 @@ module PaperTrail
     def self.registered(app)
       app.use RequestStore::Middleware
       app.helpers self
-      app.before { set_paper_trail_whodunnit }
+      app.before {
+        set_paper_trail_whodunnit
+        set_paper_trail_request_info
+        set_paper_trail_enabled_for_request
+      }
     end
 
     protected
@@ -27,13 +31,55 @@ module PaperTrail
       current_user
     end
 
+    # Returns any information about the controller or request that you
+    # want PaperTrail to store alongside any changes that occur.  By
+    # default this returns an empty hash.
+    #
+    # Override this method in your controller to return a hash of any
+    # information you need.  The hash's keys must correspond to columns
+    # in your `versions` table, so don't forget to add any new columns
+    # you need.
+    #
+    # For example:
+    #
+    #     {:ip => request.remote_ip, :user_agent => request.user_agent}
+    #
+    # The columns `ip` and `user_agent` must exist in your `versions` # table.
+    #
+    # Use the `:meta` option to
+    # `PaperTrail::Model::ClassMethods.has_paper_trail` to store any extra
+    # model-level data you need.
+    def info_for_paper_trail
+      {}
+    end
+
+    # Returns `true` (default) or `false` depending on whether PaperTrail
+    # should be active for the current request.
+    #
+    # Override this method in your controller to specify when PaperTrail
+    # should be off.
+    def paper_trail_enabled_for_request
+      ::PaperTrail.enabled?
+    end
+
     private
 
     # Tells PaperTrail who is responsible for any changes that occur.
     def set_paper_trail_whodunnit
-      @set_paper_trail_whodunnit_called = true
       ::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled?
     end
+
+    # Tells PaperTrail any information from the controller you want to store
+    # alongside any changes that occur.
+    def set_paper_trail_request_info
+      ::PaperTrail.controller_info = info_for_paper_trail if ::PaperTrail.enabled?
+    end
+
+    # Tells PaperTrail whether versions should be saved in the current
+    # request.
+    def set_paper_trail_enabled_for_request
+      ::PaperTrail.enabled_for_controller = paper_trail_enabled_for_request if ::PaperTrail.enabled?
+    end
   end
 end
 

data/paper_trail-sinatra.gemspec

@@ -4,27 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paper_trail/sinatra/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "paper_trail-sinatra"
-  spec.version       = ::PaperTrail::Sinatra::VERSION
-  spec.authors       = ["Jared Beck"]
-  spec.email         = ["jared@jaredbeck.com"]
+  spec.name = "paper_trail-sinatra"
+  spec.version = ::PaperTrail::Sinatra::VERSION
+  spec.authors = ["Jared Beck"]
+  spec.email = ["jared@jaredbeck.com"]
   spec.licenses = ["GPL-3.0"]
-  spec.summary       = 'Sinatra support for paper_trail'
-  spec.homepage      = 'https://github.com/jaredbeck/paper_trail-sinatra'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.summary = 'Sinatra support for paper_trail'
+  spec.homepage = 'https://github.com/jaredbeck/paper_trail-sinatra'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables = []
   spec.require_paths = ["lib"]
 
   # PT 7 requires ruby >= 2.1.0. We don't technically need the same constraint
   # in this project, but it's helpful for local development.
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_dependency "activesupport", [">= 4.0", "< 6"]
+  spec.add_dependency "activesupport", [">= 4.2", "< 6"]
 
+  # Why constrain bundler? Is there a better way?
   spec.add_dependency "bundler", "~> 1.13"
 
   # This gem should not be used with PT < 7 because both define

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -134,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -155,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Sinatra support for paper_trail