paper_trail_scrapbook 0.1.13 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c453ce85bdc41cc81c5f1d9f16922ae23c3936d
-  data.tar.gz: dc47a13264e5bb62434b4e8cd169c78e607b7842
+  metadata.gz: edc42760ad65ddabf5e4b5cbe6078a2106e05fd3
+  data.tar.gz: f414b720536a35971713cd2ab6615665861be9f0
 SHA512:
-  metadata.gz: 1848ed2409a099393b9adf26975d2b35575f742fe18b4d9a8af22108739102ab58aa663b9c28f68f38b7f16a9f007d4c1c759071fcb7b49d9126817d47f23d79
-  data.tar.gz: 7d9e1dbbf17832aa1e95b82f97efbf4d70d2596f4652b9d88256a56a2fcdb573b5a000236e333522193262681931ee34b8333f060d9be5c1fa143f7e15f265b9
+  metadata.gz: db255b9d214220f0161e76d0cc748b5a315be057fded74adfbaa4b79aa58403791196283381074050d0a3cb3fcc49b667ee57662268f6835c47b5b651c8f75cc
+  data.tar.gz: f05cfe2ca064ace2658641863635d640bf425cee52d5c57b9a14f51f63d849e2572f06b056468f175be867056a51891b95fab38545dc38974d1543cf7e2e42f9

data/.circleci/config.yml

@@ -1,6 +1,8 @@
 defaults: &defaults
   docker:
       - image: circleci/ruby:2.5.0-node-browsers
+        environment:
+          PGUSER: circleci
       - image: circleci/postgres:9.5-alpine
         environment:
           POSTGRES_USER: circleci
@@ -21,10 +23,11 @@ jobs:
           command: |
             echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
             source $BASH_ENV
-            gem install bundler
+            gem install bundler -v $BUNDLER_VERSION
       - run:
           name: Bundle Install
-          command: bundle check || bundle install
+          command:
+            bundle check || bundle install
       - save_cache:
           key: paper_trail_scrapbook-{{ checksum "Gemfile.lock" }}
           paths:

data/Gemfile.lock

@@ -1,36 +1,36 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.13)
+    paper_trail_scrapbook (0.1.19)
       activerecord
       adamantium
       concord
-      paper_trail (>= 5.2, <= 9.2.0)
+      paper_trail (>= 5.2, <= 10.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     abstract_type (0.0.7)
-    actionpack (5.2.2.1)
-      actionview (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2.1)
-      activesupport (= 5.2.2.1)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.2.1)
-      activesupport (= 5.2.2.1)
-    activerecord (5.2.2.1)
-      activemodel (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    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.2.1)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -51,25 +51,25 @@ GEM
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    crass (1.0.5)
     database_cleaner (1.6.2)
     diff-lcs (1.3)
     docile (1.1.5)
     equalizer (0.0.11)
-    erubi (1.8.0)
+    erubi (1.9.0)
     ffaker (2.8.1)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.1.0)
-    loofah (2.2.3)
+    json (2.3.1)
+    loofah (2.3.1)
       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.11.3)
+    minitest (5.12.2)
     morpher (0.2.6)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
@@ -98,43 +98,42 @@ GEM
     mutant-rspec (0.8.14)
       mutant (~> 0.8.14)
       rspec-core (>= 3.4.0, < 3.7.0)
-    nokogiri (1.10.2)
+    nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
-    paper_trail (9.2.0)
-      activerecord (>= 4.2, < 5.3)
-      paper_trail-association_tracking (< 2)
+    paper_trail (10.2.1)
+      activerecord (>= 4.2, < 6.1)
       request_store (~> 1.1)
-    paper_trail-association_tracking (1.1.1)
     parallel (1.12.1)
     parser (2.4.0.2)
       ast (~> 2.3)
     pg (0.18.4)
     powerpack (0.1.1)
     procto (0.0.3)
-    rack (2.0.6)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.2.1)
-      actionpack (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
-    rake (10.4.2)
+    rake (13.0.1)
     regexp_parser (0.4.9)
-    request_store (1.4.1)
+    request_store (1.5.0)
       rack (>= 1.4)
     rspec-core (3.6.0)
       rspec-support (~> 3.6.0)
     rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
+    rspec-jumpstart (1.1.2)
     rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
@@ -181,19 +180,21 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   codeclimate-test-reporter (~> 1.0.7)
   database_cleaner (~> 1.2)
   ffaker (~> 2.5)
-  loofah (~> 2.2.3)
+  loofah (~> 2.3.1)
   mutant
   mutant-rspec
   paper_trail_scrapbook!
   pg (= 0.18.4)
   rack (>= 2.0.6)
-  railties (= 5.2.2.1)
-  rake (~> 10.4.2)
+  railties (= 5.2.3)
+  rake (~> 13.0.1)
+  rspec-jumpstart
   rspec-rails
   rspec_junit_formatter
   rubocop
@@ -202,4 +203,4 @@ DEPENDENCIES
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   2.0.1
+   2.2.2

data/README.md

@@ -1,6 +1,6 @@
 # Paper Trail Scrapbook
 
-[![CircleCI](https://circleci.com/gh/tjchambers/paper_trail_scrapbook/tree/master.svg?style=svg)](https://circleci.com/gh/tjchambers/paper_trail_scrapbook/tree/master)
+[![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.
@@ -16,9 +16,9 @@ Add PaperTrailScrapBook to your `Gemfile`.
 ### Configuration
 
 This gem is dependent on [PaperTrail](https://github.com/paper-trail-gem/paper_trail),
-and specifically, on the `object_changes` column in the `PaperTrail::Version` 
+and specifically, on the `object_changes` column in the `PaperTrail::Version`
 table. If your `PaperTrail` installation does not include this column, you can
-add it manually, or re-runthe `PaperTrail` generator:
+add it manually, or re-run the `PaperTrail` generator:
 
 ```
 bundle exec rake generate paper_trail:install --with_changes
@@ -60,6 +60,14 @@ end
 PaperTrailScrapbook.config.whodunnit_class = WhoDidIt
 ```
 
+You also have the option of seeing the most recent changes first (default is chronological)
+
+```ruby
+
+ config.recent_first = true
+
+```
+
 ### Life Story
 
 The `LifeStory` module provides a complete history of an object (limited by the
@@ -70,12 +78,12 @@ widget = Widget.find 42
 text = PaperTrailScrapbook::LifeHistory.new(widget).story
 # On Wednesday, 07 Jun 2017 at 2:37 PM, Rob Owens created the following Widget information:
 #   • email: Tim@example.com
-#   • name: Tim's Widget 
+#   • name: Tim's Widget
 #   • built: true
 #   • created_by: Rob Owens[1742]
 #   • provider: RedCharge[3113]
 #   • cost: 29612.0
-#   • discounted_price: 29612.0 
+#   • discounted_price: 29612.0
 ```
 
 If desired, you can implement a `trailed_related_content` method in your model
@@ -110,18 +118,64 @@ text = PaperTrailScrapbook::LifeHistory.new(widget).story
 #
 # On Wednesday, 07 Jun 2017 at 2:37 PM, Rob Owens created the following Widget information:
 #   • email: Tim@example.com
-#   • name: Tim's Widget 
+#   • name: Tim's Widget
 #   • manufacturer: WidgetsAreUs[411]
 #   •: 1234
-#   
+#
 # On Thursday, 23 Oct 2017 at 7:55 AM PDT, Rob Owens updated Manufacturer[411]:
 #  • name: WidgetsRUs
-# 
+#
 # On Friday, 24 Oct 2017 at 10:10 AM PDT, Rob Owens created the following Attachment[212] information:
 #  • name: Electromagnet
 #  • widget: Tim's Widget[1234]
 #  •: 212
-# 
+#
+```
+
+`PaperTrailScrapbook` also implements a `version_filter` hook to provide a flexible way to filter which versions appear in a object's history. For example, if we only wanted our `Widget` class to include history for its manufacturer after the widget was created, we might implement `Widget#version_filter` like this:
+
+```ruby
+class Widget < ApplicationRecord
+  has_paper_trail
+
+  def trailed_related_content
+    attachments | [manufacturer]
+  end
+
+  def version_filter(version)
+    case version.item_type
+      when 'Manufacturer'
+        if version.created_at < created_at
+          return nil
+        end
+    end
+    version
+  end
+
+  ...
+```
+
+Then, the above history would be:
+
+```ruby
+widget = Widget.find 42
+
+text = PaperTrailScrapbook::LifeHistory.new(widget).story
+
+# On Wednesday, 07 Jun 2017 at 2:37 PM, Rob Owens created the following Widget information:
+#   • email: Tim@example.com
+#   • name: Tim's Widget
+#   • manufacturer: WidgetsAreUs[411]
+#   •: 1234
+#
+# On Thursday, 23 Oct 2017 at 7:55 AM PDT, Rob Owens updated Manufacturer[411]:
+#  • name: WidgetsRUs
+#
+# On Friday, 24 Oct 2017 at 10:10 AM PDT, Rob Owens created the following Attachment[212] information:
+#  • name: Electromagnet
+#  • widget: Tim's Widget[1234]
+#  •: 212
+#
 ```
 
 ### User Journal
@@ -191,7 +245,7 @@ text = PaperTrailScrapbook::UserJournal.new(who, start: 1.month.ago, end: Time.n
 
 ## Problems
 
-Please use GitHub's [issue tracker](http://github.com/tjchambers/paper_trail_scrapbook/issues).
+Please use GitHub's [issue tracker](http://github.com/hintmedia/paper_trail_scrapbook/issues).
 
 
 ## Contributors
@@ -207,7 +261,7 @@ possible.
 
 ## Intellectual Property
 
-Copyright (c) 2017 Tim Chambers (tim@possibilogy.com).
+Copyright (c) 2017 Hint Media, Inc.
 Released under the MIT licence.
 
 

data/lib/paper_trail_scrapbook/changes.rb

@@ -3,11 +3,16 @@
 module PaperTrailScrapbook
   # Class Changes provides detailed attribute by attribute analysis
   #
-  # @author Timothy Chambers <tim@possibilogy.com>
+  # @author Timothy Chambers <tim@hint.io>
   #
   class Changes
     include Concord.new(:version)
     include Adamantium::Flat
+    include PaperTrailScrapbook::VersionHelpers
+
+    POLYMORPH_BT_INDICATOR = '*'
+
+    delegate :object_changes, to: :version
 
     def initialize(*)
       super
@@ -23,10 +28,11 @@ module PaperTrailScrapbook
     # @return [String] Summary analysis of changes
     #
     def change_log
-      text = changes
-             .map { |k, v| digest(k, v) }
-             .compact
-             .join("\n")
+      text =
+        changes
+          .map { |k, v| digest(k, v) }
+          .compact
+          .join("\n")
 
       text = text.gsub(' id:', ':') if PaperTrailScrapbook.config.drop_id_suffix
       text
@@ -34,9 +40,13 @@ module PaperTrailScrapbook
 
     private
 
+    def polymorphic?(x)
+      x.to_s.start_with?(POLYMORPH_BT_INDICATOR)
+    end
+
     def digest(key, values)
       old, new = values
-      return if old.nil? && (new.nil? || new.eql?('')) || (old == new)
+      return if old.nil? && (new.nil? || new.eql?('')) || (old == new && !creating?)
 
       "#{BULLET} #{key.tr('_', ' ')}: #{detailed_analysis(key, new, old)}"
     end
@@ -63,17 +73,40 @@ module PaperTrailScrapbook
       return '*empty*' unless value
 
       begin
-        build_associations[key].find(value).to_s.to_s + "[#{value}]"
+        assoc_target(key).find(value).to_s.to_s + "[#{value}]"
       rescue StandardError
         "*not found*[#{value}]"
       end
     end
 
+    def assoc_target(key)
+      x = build_associations[key]
+      return x unless polymorphic?(x)
+      ref = x[1..-1] + '_type'
+
+      # try object changes to see if the belongs_to class is specified
+      latest_class = changes[ref]&.last
+
+      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
+        # 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]
+      end
+
+      Object.const_get(latest_class.classify)
+    end
+
     def assoc_klass(name, options = {})
       direct_class = options[:class_name]
-      return direct_class if direct_class && !direct_class.is_a?(String)
+      poly         = options[:polymorphic]
+
+      return direct_class if !poly && direct_class && !direct_class.is_a?(String)
 
-      Object.const_get((direct_class || name.to_s).classify)
+      poly ? POLYMORPH_BT_INDICATOR + name.to_s : Object.const_get((direct_class || name.to_s).classify)
     rescue StandardError
       Object.const_set(name.to_s.classify, Class.new)
     end
@@ -86,16 +119,12 @@ 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
 
-    def object_changes
-      version.object_changes
-    end
-
     def changes
       @changes ||= if object_changes
                      YAML

data/lib/paper_trail_scrapbook/chapter.rb

@@ -5,7 +5,7 @@ require_relative 'version_helpers'
 module PaperTrailScrapbook
   # Class Chapter provides single version history analysis
   #
-  # @author Timothy Chambers <tim@possibilogy.com>
+  # @author Timothy Chambers <tim@hint.io>
   #
   class Chapter
     include Concord.new(:version)

data/lib/paper_trail_scrapbook/config.rb

@@ -22,7 +22,8 @@ module PaperTrailScrapbook
                   :drop_id_suffix,
                   :unknown_whodunnit,
                   :invalid_whodunnit,
-                  :filter_non_changes
+                  :filter_non_changes,
+                  :recent_first
 
     def initialize
       @whodunnit_class    = nil
@@ -33,6 +34,7 @@ module PaperTrailScrapbook
       @invalid_whodunnit  = proc { |w| "*missing (#{w})*" }
       @drop_id_suffix     = true
       @filter_non_changes = true
+      @recent_first       = false
     end
   end
 end

data/lib/paper_trail_scrapbook/journal_entry.rb

@@ -5,7 +5,7 @@ require_relative 'version_helpers'
 module PaperTrailScrapbook
   # Class JournalEntry provides single version history analysis
   #
-  # @author Jason Dinsmore <jason@dinjas.com>
+  # @author Jason Dinsmore <jason@hint.io>
   #
   class JournalEntry
     include Concord.new(:version)

data/lib/paper_trail_scrapbook/life_history.rb

@@ -3,19 +3,12 @@
 module PaperTrailScrapbook
   # Class LifeHistory provides Full multi version history
   #
-  # @author Timothy Chambers <tim@possibilogy.com>
+  # @author Timothy Chambers <tim@hint.io>
   #
   class LifeHistory
     def initialize(object)
       @object   = object
-      @versions = object.versions
-      if object.respond_to?(:trailed_related_content)
-        object.trailed_related_content.compact.each do |trc|
-          @versions |= trc.versions
-        end
-      end
-
-      @versions = @versions.sort_by(&:created_at)
+      @versions = Versions.new(object).versions
     end
 
     # Retries textual historical analysis of versions
@@ -23,13 +16,17 @@ module PaperTrailScrapbook
     # @return [String] analyzed versions
     #
     def story
-      versions.map do |v|
+      x = versions.map do |v|
         if primary?(v)
           Chapter
         else
           SecondaryChapter
         end.new(v).story
-      end.compact.join("\n\n")
+      end.compact
+
+      x.reverse! if PaperTrailScrapbook.config.recent_first
+
+      x.join("\n\n")
     end
 
     private

data/lib/paper_trail_scrapbook/user_journal.rb

@@ -4,7 +4,7 @@ module PaperTrailScrapbook
   # Class UserJournal provides history for a user, optionally scoped by
   # object class and/or date range
   #
-  # @author Jason Dinsmore <jason@dinjas.com>
+  # @author Jason Dinsmore <jason@hint.io>
   #
   class UserJournal
     include Adamantium::Flat
@@ -26,7 +26,11 @@ module PaperTrailScrapbook
     def story
       s = versions.map do |v|
         JournalEntry.new(v).story
-      end.compact.join("\n\n")
+      end.compact
+
+      s.reverse! if PaperTrailScrapbook.config.recent_first
+
+      s.join("\n\n")
 
       "#{preface}#{s.presence || 'No history'}"
     end

data/lib/paper_trail_scrapbook/version.rb

@@ -2,5 +2,5 @@
 
 module PaperTrailScrapbook
   # Current version
-  VERSION = '0.1.13'
+  VERSION = '0.1.19'
 end

data/lib/paper_trail_scrapbook/versions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PaperTrailScrapbook
+  class Versions
+    include Concord.new(:object)
+
+    def versions
+      filtered(object.versions | related_content).sort_by(&:created_at)
+    end
+
+    def related_content
+      unless object.respond_to?(:trailed_related_content)
+        return []
+      end
+
+      object.trailed_related_content.compact.flat_map(&:versions)
+    end
+
+    def filtered(object_versions)
+      unless object.respond_to?(:version_filter)
+        return object_versions
+      end
+
+      object_versions.select { |v| object.version_filter(v) }
+    end
+
+  end
+
+end

data/paper_trail_scrapbook.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |gem|
   gem.summary     = 'Paper Trail Scrapbook'
   gem.description = "Human Readable Change Log for Paper Trail'd data"
   gem.authors     = ['Timothy Chambers']
-  gem.email       = 'tim@possibilogy.com'
+  gem.email       = 'tim@hint.io'
   gem.files       = `git ls-files`.split("\n")
-  gem.homepage    = 'https://github.com/tjchambers/paper_trail_scrapbook'
+  gem.homepage    = 'https://github.com/hintmedia/paper_trail_scrapbook'
   gem.license     = 'MIT'
 
   gem.required_rubygems_version = '>= 1.3.6'
@@ -21,21 +21,22 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'activerecord'
   gem.add_dependency 'adamantium'
   gem.add_dependency 'concord'
-  gem.add_dependency 'paper_trail', ['>= 5.2', '<= 9.2.0']
+  gem.add_dependency 'paper_trail', ['>= 5.2', '<= 10.2.1']
 
   gem.add_development_dependency 'ffaker', '~> 2.5'
-  gem.add_development_dependency 'rake', '~> 10.4.2'
+  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.2.1'
+  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.2.3'
+  gem.add_development_dependency 'loofah', '~> 2.3.1'
   gem.add_development_dependency 'mutant'
   gem.add_development_dependency 'mutant-rspec'
   gem.add_development_dependency 'pg', '= 0.18.4'
   gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'rspec-jumpstart'
   gem.add_development_dependency 'rspec_junit_formatter'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-rspec'

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

@@ -5,7 +5,7 @@ require 'securerandom'
 class CustomPrimaryKeyRecord < ActiveRecord::Base
   self.primary_key = :uuid
 
-  has_paper_trail class_name: 'CustomPrimaryKeyRecordVersion'
+  has_paper_trail versions: { class_name: 'CustomPrimaryKeyRecordVersion' }
 
   # This default_scope is to test the case of the Version#item association
   # not returning the item due to unmatched default_scope on the model.

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

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

data/spec/dummy_app/app/models/kitchen/banana.rb

@@ -2,6 +2,6 @@
 
 module Kitchen
   class Banana < ActiveRecord::Base
-    has_paper_trail class_name: 'Kitchen::BananaVersion'
+    has_paper_trail versions: { class_name: 'Kitchen::BananaVersion' }
   end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Post < ActiveRecord::Base
-  has_paper_trail class_name: 'PostVersion'
+  has_paper_trail versions: { class_name: 'PostVersion' }
 end

data/spec/dummy_app/config/initializers/paper_trail.rb

@@ -1,3 +1 @@
 # frozen_string_literal: true
-
-PaperTrail.config.track_associations = false

data/spec/paper_trail_scrapbook/journal_entry_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/paper_trail_scrapbook/journal_entry'
+
+RSpec.describe PaperTrailScrapbook::JournalEntry do
+  let(:person) { Person.create!(name: 'The Tim Man') }
+  let(:book) { Book.create!(title: 'How the Grinch stole Xmas') }
+  let(:version) do
+    OpenStruct.new(event: 'create',
+                   item_type: 'Book',
+                   item_id: book.id,
+                   created_at: whenn,
+                   version_author: person.id)
+  end
+  let(:subject) { described_class.new(version) }
+  let(:whenn) { Time.parse('2019-12-16 12:01:29 -0800') }
+
+  describe '#story' do
+    it 'story' do
+      result = subject.story
+
+      expect(result).to eql('On Monday, 16 Dec 2019 at 12:01 PM, '\
+                            "created Book[#{book.id}]:\n")
+    end
+  end
+
+end

data/spec/paper_trail_scrapbook/life_history_spec.rb

@@ -61,7 +61,7 @@ module PaperTrailScrapbook
           .to match(/How the Grinch stole Xmas\[\d+\] was \*removed\*/)
       end
 
-      context 'it handles missing whodunnit record' do
+      context 'when it handles missing whodunnit record' do
         it 'provides a whole story with missing whodunnit record' do
           target
           pid = person.id
@@ -88,7 +88,7 @@ module PaperTrailScrapbook
         end
       end
 
-      context 'no papertrail' do
+      context 'without papertrail' do
         let(:target) { Elephant.create! }
 
         it 'has none' do
@@ -97,6 +97,15 @@ module PaperTrailScrapbook
         end
       end
 
+      context 'with polymorphic data' do
+        let(:target) { Whatchamajigger.create!(owner: author) }
+
+        it 'locates the proper model' do
+          expect(subject).to match(/Dr. Seuss\[/)
+          expect(subject).to match(/owner type: Person/)
+        end
+      end
+
       context 'with related data' do
         before do
           author
@@ -120,6 +129,42 @@ module PaperTrailScrapbook
           expect(subject).to match(/author: Dr\. Seuss\[\d+\]/)
         end
       end
+
+      context 'recent first' do
+        before do
+          author
+          book
+          target
+
+          config = PaperTrailScrapbook.config
+          config.recent_first = true
+          config.time_format = '%A, %d %b %Y at %l:%M:%S.%9N %p'
+
+          def target.trailed_related_content
+            [book, author]
+          end
+        end
+
+        after do
+          config = PaperTrailScrapbook.config
+          config.recent_first = false
+          config.time_format = '%A, %d %b %Y at %l:%M %p'
+        end
+
+        it 'includes related content history' do
+          expect(subject).to match(/created the following Person\[\d+\] info/)
+          expect(subject).to match(/name: Dr\. Seuss/)
+
+          expect(subject).to match(/created the following Book\[\d+\] info/)
+          expect(subject).to match(/title: How the Grinch stole Xmas/)
+
+          expect(subject.squish).to match(/created the following Book.*created the following Person/)
+
+          expect(subject).to match(/created the following Authorship info/)
+          expect(subject).to match(/book: How the Grinch stole Xmas\[\d+\]/)
+          expect(subject).to match(/author: Dr\. Seuss\[\d+\]/)
+        end
+      end
     end
   end
 end

data/spec/paper_trail_scrapbook/versions_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'paper_trail_scrapbook/versions'
+
+module PaperTrailScrapbook
+  ::RSpec.describe Versions do
+    before do
+      PaperTrailScrapbook.config.whodunnit_class = Person
+      PaperTrail.request.whodunnit = person.id
+    end
+
+    let(:book) do
+      Book.new(title: 'How the Grinch stole Xmas').tap(&:save!)
+    end
+    let(:person) { Person.create(name: 'The Tim Man') }
+    let!(:authorship) do
+      Authorship.new(book: book, author: person).tap(&:save!)
+    end
+
+    let(:object) { described_class.new(book) }
+
+    describe '#versions' do
+      it 'versions' do
+        book.update!(title: 'New Title')
+
+        result = object.versions
+
+        expect(result).to eql(book.versions.to_a)
+        expect(result.size).to equal(2)
+      end
+    end
+
+    describe '#related_content' do
+      it 'related_content returns nothing if no related content' do
+        result = object.related_content
+
+        expect(result).to eql([])
+      end
+
+      it 'returns related content' do
+        allow(book).to receive(:respond_to?)
+          .with(:trailed_related_content).and_return(true)
+        allow(book).to receive(:respond_to?)
+          .with(:trailed_related_content, true).and_return(true)
+        allow(book).to receive(:trailed_related_content) do
+          book.authorships
+        end
+
+        result = object.related_content
+
+        expect(result).to eql(authorship.versions.to_a)
+      end
+    end
+
+    describe '#filtered' do
+      it 'returns versions if no filter' do
+        result = object.filtered(book.versions.to_a)
+
+        expect(result).to eql(book.versions.to_a)
+      end
+
+      it 'returns filtered versions if filter' do
+        allow(book).to receive(:respond_to?)
+          .with(:version_filter, true).and_return(true)
+        allow(book).to receive(:respond_to?)
+          .with(:version_filter).and_return(true)
+        allow(book).to receive(:version_filter) do |_version|
+          nil
+        end
+
+        result = object.filtered(book.versions.to_a)
+
+        expect(result).to eql([])
+      end
+
+      it 'returns filtered versions if filter' do
+        book.update!(title: 'New Title')
+
+        allow(book).to receive(:respond_to?).with(:version_filter, true).and_return(true)
+        allow(book).to receive(:respond_to?).with(:version_filter).and_return(true)
+        allow(book).to receive(:version_filter) do |version|
+          if version.event.eql?('update')
+            version
+          end
+        end
+
+        result = object.filtered(book.versions)
+
+        expect(result).to eql([book.versions.last])
+        expect(result.size).not_to eql(book.versions.size)
+      end
+    end
+  end
+end

data/spec/paper_trail_scrapbook_spec.rb

@@ -2,5 +2,13 @@
 
 require 'spec_helper'
 
-module PaperTrailScrapbook
+RSpec.describe PaperTrailScrapbook do
+  describe '.config' do
+    it 'sets the @config ivar' do
+      described_class.config
+
+      expect(described_class.instance_variable_get(:@config))
+        .to equal(PaperTrailScrapbook::Config.instance)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_scrapbook
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.19
 platform: ruby
 authors:
 - Timothy Chambers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -61,7 +61,7 @@ dependencies:
         version: '5.2'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 9.2.0
+        version: 10.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '5.2'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 9.2.0
+        version: 10.2.1
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.2.1
+        version: 5.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.2.1
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: mutant
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +212,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-jumpstart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -297,7 +311,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.6
 description: Human Readable Change Log for Paper Trail'd data
-email: tim@possibilogy.com
+email: tim@hint.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -326,6 +340,7 @@ files:
 - lib/paper_trail_scrapbook/user_journal.rb
 - lib/paper_trail_scrapbook/version.rb
 - lib/paper_trail_scrapbook/version_helpers.rb
+- lib/paper_trail_scrapbook/versions.rb
 - log/mutant/pts.log
 - paper_trail_scrapbook.gemspec
 - pkg/paper_trail_scrapbook-0.0.2.gem
@@ -405,18 +420,20 @@ files:
 - spec/paper_trail_scrapbook/changes_spec.rb
 - spec/paper_trail_scrapbook/chapter_spec.rb
 - spec/paper_trail_scrapbook/config_spec.rb
+- spec/paper_trail_scrapbook/journal_entry_spec.rb
 - spec/paper_trail_scrapbook/life_history_spec.rb
 - spec/paper_trail_scrapbook/secondary_chapter_spec.rb
 - spec/paper_trail_scrapbook/user_journal_spec.rb
 - spec/paper_trail_scrapbook/version_helpers_spec.rb
 - spec/paper_trail_scrapbook/version_spec.rb
+- spec/paper_trail_scrapbook/versions_spec.rb
 - spec/paper_trail_scrapbook_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/tjchambers/paper_trail_scrapbook
+homepage: https://github.com/hintmedia/paper_trail_scrapbook
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -431,9 +448,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.5.2.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Paper Trail Scrapbook
 test_files: []