paper_trail-sinatra 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d6d8c636449a424b7c0abdbc05cc80bdfe79d2a
-  data.tar.gz: a0a674060d20173bc2fdc012b91d479043ab5f38
+SHA256:
+  metadata.gz: c788651f7b1d67705204a69b0237a5e421260ef730c6b1c52be686b8c5edb5ab
+  data.tar.gz: 63095c80ffb4bd5c44f547585b25ea93c1ff88f052fd49aa71bcdaac51a66ad9
 SHA512:
-  metadata.gz: 7e4c53518748ed4db5417ca3c55c345e4e4e29df03e354e3c728800e3568695f674e8b10748b7613afc9d512b7b153337c9fca274fa3424a3ddf58bdb40f6cfa
-  data.tar.gz: 0b1a95a6976c92541cfd027e85b61f21aa682c19f9421cd59f0ce354ded240254d5173bd84c0e4f3683412186fe51f58f8a1f63fb2e3f14abb678a21fa4860b9
+  metadata.gz: '09a285afcd2272101ed389eaa5cd98eae372251d4fae622ebe0c759e985879fde9be5c0a9d78816875ac9376fc1d9021cc06acced80e8e644aad97a3dca61134'
+  data.tar.gz: 259bea423f113db5c6858a03c4794eda24c9276754df567e661eb7ee5b2748dd1785bf9e969e9b8c363ba717bf1fabaadfd4c4689c034fbda7822482a14863d1

data/.rubocop.yml

@@ -0,0 +1,106 @@
+inherit_from: .rubocop_todo.yml
+
+# Please:
+#
+# - Comment any deviations from the Ruby Style Guide
+# - Alphabetize cops
+# - Only include permanent config; temporary goes in .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    # This is where travis CI installs our bundle. If we don't exclude it,
+    # travis will try to lint all of our dependencies XD
+    - gemfiles/vendor/bundle/**/*
+
+  # Set to lowest supported version
+  TargetRubyVersion: 2.2
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Use exactly one space on each side of an operator. Do not align operators
+# because it makes the code harder to edit, and makes lines unnecessarily long.
+Layout/SpaceAroundOperators:
+  AllowForAlignment: false
+
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/BlockLength:
+  Enabled: false
+
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/ClassLength:
+  Enabled: false
+
+# The Ruby Style Guide recommends to "Limit lines to 80 characters."
+# (https://github.com/bbatsov/ruby-style-guide#80-character-limits)
+# Please aim for 80, but up to 100 is OK.
+Metrics/LineLength:
+  Max: 100
+
+# The number of lines in a method is not a useful metric compared to `AbcSize`.
+# It's common to have very long methods (> 50 lines) which are quite simple. For
+# example, a method that returns a long string with only a few interpolations.
+Metrics/MethodLength:
+  Enabled: false
+
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/ModuleLength:
+  Enabled: false
+
+# Heredocs are usually assigned to a variable or constant, which already has a
+# name, so naming the heredoc doesn't add much value. Feel free to name
+# heredocs that are used as anonymous values (not a variable, constant, or
+# named parameter).
+#
+# All heredocs containing SQL should be named SQL, to support editor syntax
+# highlighting.
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# Too subtle to lint.
+# Two-letter param names are OK. Consider `send_email(to:, cc:)`.
+# Even one-letter names are OK. Consider `draw_point(x, y)`.
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+# Please use semantic style, e.g. `do` when there's a side-effect, else `{}`.
+# The semantic style is too nuanced to lint, so the cop is disabled.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Use double negation wherever it would otherwise be impractical to convert
+# a value to an actual boolean.
+Style/DoubleNegation:
+  Enabled: false
+
+# Avoid annotated tokens except in desperately complicated format strings.
+# In 99% of format strings they actually make it less readable.
+Style/FormatStringToken:
+  Enabled: false
+
+# The decision of when to use a guard clause to improve readability is subtle,
+# and it's not clear that it can be linted. Certainly, the default
+# `MinBodyLength` of 1 can actually hurt readability.
+Style/GuardClause:
+  Enabled: false
+
+# Only use postfix (modifier) conditionals for utterly simple statements.
+# As a rule of thumb, the entire statement should not exceed 60 chars.
+# Rubocop used to support this level of configuration, but no longer does.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# The Ruby Style Guide does not prescribe a particular quote character, only
+# that a project should pick one and be consistent. The decision has no
+# performance implications. Double quotes are slightly easier to read.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,82 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-05-08 22:55:10 -0400 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 42
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/paper_trail/sinatra.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/paper_trail/sinatra/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'paper_trail-sinatra.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'paper_trail-sinatra.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/paper_trail/sinatra.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/paper_trail/sinatra/version.rb'
+
+# Offense count: 149
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'bin/console'
+    - 'lib/paper_trail/sinatra.rb'
+    - 'lib/paper_trail/sinatra/version.rb'
+    - 'paper_trail-sinatra.gemspec'
+    - 'spec/gem_version_spec.rb'
+    - 'spec/gemfiles/Gemfile_pt7_sinatra1.rb'
+    - 'spec/gemfiles/Gemfile_pt7_sinatra2.rb'
+    - 'spec/gemfiles/Gemfile_pt8_sinatra1.rb'
+    - 'spec/gemfiles/Gemfile_pt8_sinatra2.rb'
+    - 'spec/gemfiles/Gemfile_pt9_sinatra1.rb'
+    - 'spec/gemfiles/Gemfile_pt9_sinatra2.rb'
+    - 'spec/modular_sinatra_spec.rb'
+    - 'spec/sinatra_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 89

data/.travis.yml

@@ -5,18 +5,42 @@ before_script:
   - mkdir db
   - touch db/test.sqlite3
   - sqlite3 db/test.sqlite3 < spec/create_db.sql
+cache: bundler
 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
+  - gemfiles/pt7_sinatra1.rb
+  - gemfiles/pt7_sinatra2.rb
+  - gemfiles/pt8_sinatra1.rb
+  - gemfiles/pt8_sinatra2.rb
+  - gemfiles/pt9_sinatra1.rb
+  - gemfiles/pt9_sinatra2.rb
 language: ruby
+matrix:
+  exclude:
+    # PT 9 requires ruby >= 2.3
+    - rvm: 2.2.9
+      gemfile: gemfiles/pt9_sinatra1.rb
+    - rvm: 2.2.9
+      gemfile: gemfiles/pt9_sinatra2.rb
 
-# For ruby compatibility, we test the highest and lowest minor versions only.
+    # We only test ruby 2.3 against PT 9. Lower versions of PT are tested
+    # against ruby 2.2.
+    - rvm: 2.3.7
+      gemfile: gemfiles/pt7_sinatra1.rb
+    - rvm: 2.3.7
+      gemfile: gemfiles/pt7_sinatra2.rb
+    - rvm: 2.3.7
+      gemfile: gemfiles/pt8_sinatra1.rb
+    - rvm: 2.3.7
+      gemfile: gemfiles/pt8_sinatra2.rb
+
+# For ruby compatibility, we usually only test the highest and lowest supported
+# versions. However see above re: PT 9.
 rvm:
   - 2.5.0
+  - 2.3.7
   - 2.2.9
 
 script:
+  - bundle exec rubocop
   - bundle exec rspec
 sudo: false

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
 ## Unreleased
 
 Breaking Changes
@@ -14,6 +19,21 @@ Fixed
 
 - None
 
+## 0.5.0 (2018-05-08)
+
+Breaking Changes
+
+- None
+
+Added
+
+- Support for PaperTrail 9
+- PaperTrail::Sinatra.gem_version
+
+Fixed
+
+- None
+
 ## 0.4.0 (2018-02-22)
 
 Breaking Changes

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+## Contributing
+
+```
+git clone
+bundle
+mkdir db
+sqlite3 db/test.sqlite3
+.read spec/create_db.sql
+bundle exec rubocop
+
+# Test specific dependency versions
+BUNDLE_GEMFILE=gemfiles/pt9_sinatra2.rb bundle
+BUNDLE_GEMFILE=gemfiles/pt9_sinatra2.rb bundle exec rspec
+```

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -62,17 +62,6 @@ class BlehApp < Sinatra::Base
 end
 ```
 
-## Contributing
-
-```
-git clone
-bundle
-mkdir db
-sqlite3 db/test.sqlite3
-.read spec/create_db.sql
-bundle exec rspec
-```
-
 [1]: http://www.sinatrarb.com
 [2]: https://github.com/janko-m/sinatra-activerecord
 [3]: https://raw.github.com/airblade/paper_trail/master/lib/generators/paper_trail/templates/create_versions.rb

data/gemfiles/pt7_sinatra1.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "7.1.3"
+gem "sinatra", "1.4.8"

data/gemfiles/pt7_sinatra2.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "7.1.3"
+gem "sinatra", "2.0.1"

data/gemfiles/pt8_sinatra1.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "8.1.2"
+gem "sinatra", "1.4.8"

data/gemfiles/pt8_sinatra2.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "8.1.2"
+gem "sinatra", "2.0.1"

data/gemfiles/pt9_sinatra1.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "9.0.1"
+gem "sinatra", "1.4.8"

data/gemfiles/pt9_sinatra2.rb

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec(path: "..")
+gem "activesupport", "4.2.10"
+gem "paper_trail", "9.0.1"
+gem "sinatra", "2.0.1"

data/lib/paper_trail/sinatra.rb

@@ -66,19 +66,34 @@ module PaperTrail
 
     # Tells PaperTrail who is responsible for any changes that occur.
     def set_paper_trail_whodunnit
-      ::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled?
+      return unless ::PaperTrail.enabled?
+      if ::Gem::Version.new(::PaperTrail::VERSION) >= ::Gem::Version.new('9')
+        ::PaperTrail.request.whodunnit = user_for_paper_trail
+      else
+        ::PaperTrail.whodunnit = user_for_paper_trail
+      end
     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?
+      return unless ::PaperTrail.enabled?
+      if ::Gem::Version.new(::PaperTrail::VERSION) >= ::Gem::Version.new('9')
+        ::PaperTrail.request.controller_info = info_for_paper_trail
+      else
+        ::PaperTrail.controller_info = info_for_paper_trail
+      end
     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?
+      return unless ::PaperTrail.enabled?
+      if ::Gem::Version.new(::PaperTrail::VERSION) >= ::Gem::Version.new('9')
+        ::PaperTrail.request.enabled = paper_trail_enabled_for_request
+      else
+        ::PaperTrail.enabled_for_controller = paper_trail_enabled_for_request
+      end
     end
   end
 end

data/lib/paper_trail/sinatra/version.rb

@@ -1,5 +1,11 @@
 module PaperTrail
   module Sinatra
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
+
+    # Added in 0.5.0
+    # @api public
+    def self.gem_version
+      ::Gem::Version.new(VERSION)
+    end
   end
 end

data/paper_trail-sinatra.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paper_trail/sinatra/version'
@@ -28,10 +29,11 @@ Gem::Specification.new do |spec|
 
   # This gem should not be used with PT < 7 because both define
   # `::PaperTrail::Sinatra`.
-  spec.add_dependency "paper_trail", [">= 7", "< 9"]
+  spec.add_dependency "paper_trail", [">= 7", "< 10"]
 
   spec.add_dependency "sinatra", [">= 1.0.0", "< 3"]
   spec.add_development_dependency "rack-test", "~> 0.6"
-  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rubocop", "~> 0.55.0"
   spec.add_development_dependency "sqlite3", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
         version: '7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -104,14 +104,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -134,13 +148,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - bin/console
 - bin/setup
+- gemfiles/pt7_sinatra1.rb
+- gemfiles/pt7_sinatra2.rb
+- gemfiles/pt8_sinatra1.rb
+- gemfiles/pt8_sinatra2.rb
+- gemfiles/pt9_sinatra1.rb
+- gemfiles/pt9_sinatra2.rb
 - lib/paper_trail/sinatra.rb
 - lib/paper_trail/sinatra/version.rb
 - paper_trail-sinatra.gemspec
@@ -164,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sinatra support for paper_trail