paper_trail_scrapbook 0.1.21 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ea6a987eb4b121ef35faa696cbab0e1280f82c9c5c50994cedbcfa3fd2a161
-  data.tar.gz: 750cd326b91c05264c536476836cc64f612ef8e82e043be3f4cdd9fe5139a493
+  metadata.gz: 1ab2da369e6db07c4fdf12e63335ffd33e269beee77b903d6d12db40d8c0755f
+  data.tar.gz: fc86adc663d1695905ef6500554962f2cdf7e5127b644f43e82afd00e529e05a
 SHA512:
-  metadata.gz: 34b3c0af6ab002f7e4c076d6f490a6e9546e8c4b91b5c27e9679b6e669a072a00159a8cfebaf47b56601c714a26959f9692bd0baa75a92a039ff46a2584d9345
-  data.tar.gz: 84652d9b2f8fbf4c5a2d234fb6db4cea7dd4b50f8321aacd049caed5db0a2f968107b5dc328ed3bac855235f9902a81b83becd9357af3cf973da399d6990a606
+  metadata.gz: '08828b154f081625bce0fe40bac7dcc6f60df04098671e04798fc271bd68eed7f7f1e613c090ce7589e78089de16c4defa841d5c534e18fced196fe55c720d35'
+  data.tar.gz: fd9d86505bc9375e67576e8bc8aae247d824e8bf1ab3cd029aca34f5d15f92f42435ad20e48be32bed56dbd4df500b3c5758f20cb56082be0b6a222adc662aa9

data/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+# This workflow uses actions that are not certified by GitHub.  They are
+# provided by a third-party and are governed by separate terms of service,
+# privacy policy, and support documentation.
+#
+# This workflow will install a prebuilt Ruby version, install dependencies, and
+# run tests and linters.
+name: "CI"
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        ports:
+          - "5432:5432"
+        env:
+          POSTGRES_DB: pts_db
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+
+        # needed because the postgres container does not provide a healthcheck
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      RAILS_ENV: test
+      DATABASE_NAME: pts_db
+      DATABASE_USER: postgres
+      DATABASE_PASSWORD: postgres
+      DATABASE_HOST: "127.0.0.1"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Set up database
+        run: bundle exec rake prepare
+      # Add or replace test runners here
+      - name: Run tests
+        run: bundle exec rspec
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Lint Ruby files
+        run: bundle exec rubocop

data/.gitignore

@@ -1 +1,4 @@
 test.log
+.tool*
+
+coverage*

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   DisabledByDefault: false
-  TargetRubyVersion: 2.3
-  TargetRailsVersion: 4.0
+  TargetRubyVersion: 2.6
+  TargetRailsVersion: 6.1
   DisplayCopNames: true
   Exclude:
     - 'db/**/*'

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.7

data/Gemfile.lock

@@ -1,198 +1,165 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.21)
+    paper_trail_scrapbook (0.2.0)
       activerecord
       adamantium
       concord
-      paper_trail (>= 5.2, <= 11.1.0)
+      paper_trail (>= 11, < 13)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    abstract_type (0.0.7)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    actionpack (6.1.6.1)
+      actionview (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activesupport (6.1.6.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     adamantium (0.2.0)
       ice_nine (~> 0.11.0)
       memoizable (~> 0.4.0)
-    anima (0.3.0)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2)
-      equalizer (~> 0.0.11)
-    arel (9.0.0)
-    ast (2.3.0)
-    builder (3.2.3)
-    codeclimate-test-reporter (1.0.8)
+    ast (2.4.2)
+    builder (3.2.4)
+    codeclimate-test-reporter (1.0.9)
       simplecov (<= 0.13)
-    concord (0.1.5)
+    concord (0.1.6)
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
-    concurrent-ruby (1.1.5)
-    crass (1.0.5)
-    database_cleaner (1.6.2)
-    diff-lcs (1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.5.0)
     docile (1.1.5)
     equalizer (0.0.11)
-    erubi (1.9.0)
-    ffaker (2.8.1)
-    i18n (1.7.0)
+    erubi (1.11.0)
+    ffaker (2.21.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.3.1)
-    loofah (2.3.1)
+    json (2.6.2)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.12.2)
-    morpher (0.2.6)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.3.0)
-      ast (~> 2.2)
-      concord (~> 0.1.5)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.0)
-      procto (~> 0.0.2)
-    mutant (0.8.14)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.3.0)
-      ast (~> 2.2)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.1)
-      memoizable (~> 0.4.2)
-      morpher (~> 0.2.6)
-      parallel (~> 1.3)
-      parser (>= 2.3.1.4, < 2.5)
-      procto (~> 0.0.2)
-      regexp_parser (~> 0.4.3)
-      unparser (~> 0.2.5)
-    mutant-rspec (0.8.14)
-      mutant (~> 0.8.14)
-      rspec-core (>= 3.4.0, < 3.7.0)
-    nokogiri (1.10.8)
-      mini_portile2 (~> 2.4.0)
-    paper_trail (10.3.1)
-      activerecord (>= 4.2)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    paper_trail (12.3.0)
+      activerecord (>= 5.2)
       request_store (~> 1.1)
-    parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    pg (1.2.3)
-    powerpack (0.1.1)
-    procto (0.0.3)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pg (1.4.3)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (0.4.9)
-    request_store (1.5.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    request_store (1.5.1)
       rack (>= 1.4)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rexml (3.2.5)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-jumpstart (1.1.2)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.11.0)
+    rspec-jumpstart (1.1.5)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-rails (3.6.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.52.1)
+    rubocop (1.35.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
-      powerpack (~> 0.1)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.22.1)
-      rubocop (>= 0.52.1)
-    ruby-progressbar (1.9.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
     simplecov (0.13.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    thor (0.20.3)
+    thor (1.2.1)
     thread_safe (0.3.6)
     timecop (0.8.1)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
-    unparser (0.2.6)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      parser (>= 2.3.1.2, < 2.5)
-      procto (~> 0.0.2)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
-  x86_64-darwin-20
 
 DEPENDENCIES
   codeclimate-test-reporter (~> 1.0.7)
-  database_cleaner (~> 1.2)
+  database_cleaner
   ffaker (~> 2.5)
-  loofah (~> 2.3.1)
-  mutant
-  mutant-rspec
+  loofah
   paper_trail_scrapbook!
-  pg (= 1.2.3)
+  pg
   rack (>= 2.0.6)
-  railties (= 5.2.3)
+  railties (>= 5.2.3)
   rake (~> 13.0.1)
   rspec-jumpstart
   rspec-rails
@@ -203,4 +170,4 @@ DEPENDENCIES
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   2.2.2
+   2.2.26

data/README.md

@@ -1,6 +1,6 @@
 # Paper Trail Scrapbook
 
-[![CircleCI](https://circleci.com/gh/hintmedia/paper_trail_scrapbook/tree/master.svg?style=svg)](https://circleci.com/gh/tjchambers/paper_trail_scrapbook/tree/master)
+
 [![Gem Version](https://badge.fury.io/rb/paper_trail_scrapbook.svg)](https://badge.fury.io/rb/paper_trail_scrapbook)
 
 Human Readable audit reporting for users of [PaperTrail](https://github.com/paper-trail-gem/paper_trail) gem.

data/lib/paper_trail_scrapbook/changes.rb

@@ -30,9 +30,9 @@ module PaperTrailScrapbook
     def change_log
       text =
         changes
-          .map { |k, v| digest(k, v) }
-          .compact
-          .join("\n")
+        .map { |k, v| digest(k, v) }
+        .compact
+        .join("\n")
 
       text = text.gsub(' id:', ':') if PaperTrailScrapbook.config.drop_id_suffix
       text
@@ -40,8 +40,8 @@ module PaperTrailScrapbook
 
     private
 
-    def polymorphic?(x)
-      x.to_s.start_with?(POLYMORPH_BT_INDICATOR)
+    def polymorphic?(key)
+      key.to_s.start_with?(POLYMORPH_BT_INDICATOR)
     end
 
     def digest(key, values)
@@ -82,7 +82,8 @@ module PaperTrailScrapbook
     def assoc_target(key)
       x = build_associations[key]
       return x unless polymorphic?(x)
-      ref = x[1..-1] + '_type'
+
+      ref = "#{x[1..]}_type"
 
       # try object changes to see if the belongs_to class is specified
       latest_class = changes[ref]&.last
@@ -90,16 +91,19 @@ module PaperTrailScrapbook
       if latest_class.nil? && create?
         # try the db default class
         # for creates where the object changes do not specify this it
-        # is most likely because the default ==  type selected so
+        # is most likely because the default == type selected so
         # the default was not changed and therefore is not in
         # object changes
-        orig_instance = Object.const_get(version.item_type.classify).new
-        latest_class  = orig_instance[ref.to_sym]
+        latest_class = orig_instance[ref.to_sym]
       end
 
       Object.const_get(latest_class.classify)
     end
 
+    def orig_instance
+      Object.const_get(version.item_type.classify).new
+    end
+
     def assoc_klass(name, options = {})
       direct_class = options[:class_name]
       poly         = options[:polymorphic]
@@ -119,9 +123,9 @@ module PaperTrailScrapbook
       @build_associations ||=
         Hash[
           klass
-            .reflect_on_all_associations
-            .select { |a| a.macro.equal?(:belongs_to) }
-            .map { |x| [x.foreign_key.to_s, assoc_klass(x.name, x.options)] }
+        .reflect_on_all_associations
+        .select { |a| a.macro.equal?(:belongs_to) }
+        .map { |x| [x.foreign_key.to_s, assoc_klass(x.name, x.options)] }
         ]
     end
 

data/lib/paper_trail_scrapbook/config.rb

@@ -8,8 +8,8 @@ module PaperTrailScrapbook
     include Singleton
 
     DEFAULT_TIME_FORMAT = '%A, %d %b %Y at %l:%M %p'
-    DEFAULT_EVENTS      = { 'create'  => 'created',
-                            'update'  => 'updated',
+    DEFAULT_EVENTS      = { 'create' => 'created',
+                            'update' => 'updated',
                             'destroy' => 'destroyed' }.freeze
 
     SCRUB_COLUMNS     = %w[updated_at created_at id].freeze

data/lib/paper_trail_scrapbook/user_journal.rb

@@ -46,7 +46,7 @@ module PaperTrailScrapbook
       params = { whodunnit: user_id }
       return params if options.empty?
 
-      params.merge(item_type:  what,
+      params.merge(item_type: what,
                    created_at: starts..ends)
             .delete_if { |_, v| v.presence.nil? }
     end

data/lib/paper_trail_scrapbook/version.rb

@@ -2,5 +2,5 @@
 
 module PaperTrailScrapbook
   # Current version
-  VERSION = '0.1.21'
+  VERSION = '0.2.0'
 end

data/lib/paper_trail_scrapbook/version_helpers.rb

@@ -53,10 +53,10 @@ module PaperTrailScrapbook
 
     def whodunnit_instance(author)
       instance = begin
-                   whodunnit_class.find(author)
-                 rescue StandardError
-                   config.invalid_whodunnit.call(author)
-                 end
+        whodunnit_class.find(author)
+      rescue StandardError
+        config.invalid_whodunnit.call(author)
+      end
 
       return instance.to_whodunnit if instance.respond_to?(:to_whodunnit)
 

data/lib/paper_trail_scrapbook/versions.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module PaperTrailScrapbook
+  # Fetches available versions and related version info
+  # Provides filtering
   class Versions
     include Concord.new(:object)
 
@@ -9,21 +11,15 @@ module PaperTrailScrapbook
     end
 
     def related_content
-      unless object.respond_to?(:trailed_related_content)
-        return []
-      end
+      return [] unless object.respond_to?(:trailed_related_content)
 
       object.trailed_related_content.compact.flat_map(&:versions)
     end
 
     def filtered(object_versions)
-      unless object.respond_to?(:version_filter)
-        return object_versions
-      end
+      return object_versions unless object.respond_to?(:version_filter)
 
       object_versions.select { |v| object.version_filter(v) }
     end
-
   end
-
 end

data/paper_trail_scrapbook.gemspec

@@ -15,32 +15,30 @@ Gem::Specification.new do |gem|
   gem.license     = 'MIT'
 
   gem.required_rubygems_version = '>= 1.3.6'
-  gem.required_ruby_version = '>= 2.3.0'
+  gem.required_ruby_version = '>= 2.6'
 
   # Rails does not follow semver, makes breaking changes in minor versions.
   gem.add_dependency 'activerecord'
   gem.add_dependency 'adamantium'
   gem.add_dependency 'concord'
-  gem.add_dependency 'paper_trail', ['>= 5.2', '<= 11.1.0']
+  gem.add_dependency 'paper_trail', ['>= 11', '< 13']
 
   gem.add_development_dependency 'ffaker', '~> 2.5'
   gem.add_development_dependency 'rake', '~> 13.0.1'
 
   # Why `railties`? Possibly used by `spec/dummy_app` boot up?
-  gem.add_development_dependency 'railties', '= 5.2.3'
+  gem.add_development_dependency 'railties', '>= 5.2.3'
 
   gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.7'
-  gem.add_development_dependency 'database_cleaner', '~> 1.2'
-  gem.add_development_dependency 'loofah', '~> 2.3.1'
-  gem.add_development_dependency 'mutant'
-  gem.add_development_dependency 'mutant-rspec'
-  gem.add_development_dependency 'pg', '= 1.2.3'
-  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'loofah'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'rack', '>= 2.0.6'
   gem.add_development_dependency 'rspec-jumpstart'
   gem.add_development_dependency 'rspec_junit_formatter'
+  gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-rspec'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'timecop', '~> 0.8.0'
-  gem.add_development_dependency 'rack', '>= 2.0.6'
 end

data/spec/dummy_app/app/models/document.rb

@@ -2,7 +2,7 @@
 
 class Document < ActiveRecord::Base
   has_paper_trail(
-    versions: {name: :paper_trail_versions},
+    versions: { name: :paper_trail_versions },
     on: %i[create update]
   )
 end

data/spec/dummy_app/app/models/fruit.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Fruit < ActiveRecord::Base
-  has_paper_trail class_name: 'JsonVersion' if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
+  has_paper_trail versions: { class_name: 'JsonVersion' } if ENV['DATABASE_HOST'] == 'postgres' || JsonVersion.table_exists?
 end

data/spec/dummy_app/app/models/song.rb

@@ -34,6 +34,7 @@ class Song < ActiveRecord::Base
     attribute :name, :string
   else
     attr_accessor :name
+
     prepend OverrideSongAttributesTheRails4Way
   end
 end

data/spec/dummy_app/config/database.yml

@@ -2,8 +2,10 @@
 test: &test
   adapter: postgresql
   encoding: unicode
-  host: localhost
+  host: <%= ENV['DATABASE_HOST'] || 'localhost' %>
   database: pts_db
+  username: postgres
+  password: postgres
   port: <%= ENV['DB_PORT'] || 5432 %>
   pool: 5
 

data/spec/dummy_app/config.ru

@@ -2,5 +2,5 @@
 
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment', __FILE__)
+require ::File.expand_path('config/environment', __dir__)
 run Dummy::Application