paper_trail_scrapbook 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c453ce85bdc41cc81c5f1d9f16922ae23c3936d
-  data.tar.gz: dc47a13264e5bb62434b4e8cd169c78e607b7842
+  metadata.gz: 3cd11a4eeaf7c668fe41fe854748cf0f2e8fcaed
+  data.tar.gz: a1143aad24dcaa956b19fd47142e7e52b52bc8c4
 SHA512:
-  metadata.gz: 1848ed2409a099393b9adf26975d2b35575f742fe18b4d9a8af22108739102ab58aa663b9c28f68f38b7f16a9f007d4c1c759071fcb7b49d9126817d47f23d79
-  data.tar.gz: 7d9e1dbbf17832aa1e95b82f97efbf4d70d2596f4652b9d88256a56a2fcdb573b5a000236e333522193262681931ee34b8333f060d9be5c1fa143f7e15f265b9
+  metadata.gz: 7d8ef81dbaa77a0a90944adc34086ef4482fa6a97304490f4f929520465e7b56398868beb04f0ad433742b2d94fed78d019b63a36603ccd62d08ecba4b022c6a
+  data.tar.gz: ff4accb4de852aaacff14195e42b520ee4eac4f3a95370d8e43d24e1aa7492c3afd752af0e68524757438a14cb5383c1f8f256713bfb20c9d51ab8cc6a5962e4

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.13)
+    paper_trail_scrapbook (0.1.15)
       activerecord
       adamantium
       concord
-      paper_trail (>= 5.2, <= 9.2.0)
+      paper_trail (>= 5.2, <= 10.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -100,11 +100,9 @@ GEM
       rspec-core (>= 3.4.0, < 3.7.0)
     nokogiri (1.10.2)
       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)

data/README.md

@@ -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

data/lib/paper_trail_scrapbook/changes.rb

@@ -8,6 +8,11 @@ module PaperTrailScrapbook
   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/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/life_history.rb

@@ -23,13 +23,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

@@ -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.15'
 end

data/paper_trail_scrapbook.gemspec

@@ -21,7 +21,7 @@ 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'

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/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

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.15
 platform: ruby
 authors:
 - Timothy Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-04-01 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