paper_trail_scrapbook 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97a2bf7b57ccb17e58774b1577cc82a3d1abca21
-  data.tar.gz: d889470556b4800a03da9f22100f21c05436f8e9
+SHA256:
+  metadata.gz: 67563a25cc478a45dfcc0a63311ecec0b38db5c5e8ce3d50977e5eaf3f30ac36
+  data.tar.gz: 78c1e866535132c11e9e98a606ef739e973f5ed4db0a878db6ae5bf150e67c68
 SHA512:
-  metadata.gz: 6ef3a6c2be07485324519923b9696035e72a81f5bfc37721eb1763e28f443ffc8e4da968acc2fcef1ee2be5b30d00bf1426c6cc2eeb01ab03687b2585946a6bd
-  data.tar.gz: cd1d28c3ceac1e739735659dc907310ce4b90328ced4396eb4999b05efbef6b32ae9dc52f6b3a70358cbbe8b019de7dd7dd35b046b0a4c7a7d2acbb3db47e067
+  metadata.gz: fe2c6468ec05d4f1f4996a248667ac8ec7c7b3d15921df851dc9266c3ff45566e15569f9f64ebc868bef95a798fb049c33e7363a090ef05158409cc0eafa7cc1
+  data.tar.gz: 2eb5f79927a5e60ccaad7accd97c6eaca0afc0fa51fe4075c63a5b42d4f424a645ba531c6ebabdc558faeef126b5799269e1ef76a30d50265c67a0fbc9b64c87

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.8)
+    paper_trail_scrapbook (0.1.9)
       activerecord (>= 4.0, < 5.2)
       adamantium
       concord
@@ -98,11 +98,13 @@ GEM
     mutant-rspec (0.8.14)
       mutant (~> 0.8.14)
       rspec-core (>= 3.4.0, < 3.7.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
-    paper_trail (9.0.0)
+    paper_trail (9.2.0)
       activerecord (>= 4.2, < 5.3)
+      paper_trail-association_tracking (< 2)
       request_store (~> 1.1)
+    paper_trail-association_tracking (1.0.0)
     parallel (1.12.1)
     parser (2.4.0.2)
       ast (~> 2.3)
@@ -115,8 +117,8 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
     railties (5.1.4)
       actionpack (= 5.1.4)
       activesupport (= 5.1.4)

data/README.md

@@ -69,6 +69,52 @@ text = PaperTrailScrapbook::LifeHistory.new(widget).story
 #   • discounted_price: 29612.0 
 ```
 
+If desired, you can implement a `trailed_related_content` method in your model
+that returns a collection of related objects to include in the history.
+
+The following would, for example, cause version information for the `attachments` and `manufacturer` to be included when viewing the life story of a `Widget`:
+
+```ruby
+class Widget < ApplicationRecord
+  has_paper_trail
+
+  def trailed_related_content
+    attachments | [manufacturer]
+  end
+
+  has_many :attachments
+  has_one  :manufacturer
+end
+```
+
+A history leveraging this feature might look like this:
+
+```ruby
+widget = Widget.find 42
+
+text = PaperTrailScrapbook::LifeHistory.new(widget).story
+
+# On Monday, 05 Jun 2017 at 12:37 PM, Rob Owens created the following Manufacturer[411] information:
+#   • email: widgetsrus@example.com
+#   • name: WidgetsAreUs
+#   •: 411
+#
+# 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
 
 The `UserJournal` module provides a list of changes made by a particular
@@ -79,7 +125,7 @@ who = WhoDidIt.find 42
 text = PaperTrailScrapbook::UserJournal.new(who).story
 # Between Wednesday, 31 Dec 1969 at 4:00 PM PST and Friday, 26 Jan 2018 at 10:35 AM PST, Rob Owens made the following changes:
 #
-# On Wednesday, 07 Jan 2018 at 2:37 PM, Rob Owens created the following Widget information:
+# On Wednesday, 07 Jan 2018 at 2:37 PM, created the following Widget information:
 #   • email: Tim@example.com
 #   • name: Tim's Widget
 #   • built: true
@@ -107,7 +153,7 @@ You can also scope the change list to a specific class:
 text = PaperTrailScrapbook::UserJournal.new(who, klass: Widget).story
 # Between Wednesday, 31 Dec 1969 at 4:00 PM PST and Friday, 26 Jan 2018 at 10:35 AM PST, Rob Owens made the following Widget changes:
 #
-# On Wednesday, 07 Jan 2018 at 2:37 PM, Rob Owens created Widget[123]:
+# On Wednesday, 07 Jan 2018 at 2:37 PM, created Widget[123]:
 #   • email: Tim@example.com
 #   • name: Tim's Widget
 #   • built: true
@@ -123,7 +169,7 @@ Or view changes in a time range:
 text = PaperTrailScrapbook::UserJournal.new(who, start: 1.month.ago, end: Time.now).story
 # Between Tuesday, 26 Dec 2017 at 4:00 PM PST and Friday, 26 Jan 2018 at 4:00 PM PST, Rob Owens made the following changes:
 #
-# On Wednesday, 07 Jan 2018 at 2:37 PM, Rob Owens created the following Widget information:
+# On Wednesday, 07 Jan 2018 at 2:37 PM, created the following Widget information:
 #   • email: Tim@example.com
 #   • name: Tim's Widget
 #   • built: true

data/circle.yml

@@ -1,7 +1,7 @@
 ---
 machine:
   ruby:
-    version: '2.2.7'
+    version: '2.3.0'
   environment:
     CC_TEST_REPORTER_ID: e0db6fd6beb8208980b2908947735982fb5a4e8a9a3cb742dc194e00df79f388
 

data/lib/paper_trail_scrapbook/chapter.rb

@@ -16,15 +16,29 @@ module PaperTrailScrapbook
     #
     def story
       updates = changes
-      return unless create? || updates.present? || !config.filter_non_changes
+      return unless tell_story?(updates)
 
-      "#{preface}\n#{updates}"
+      [preface, (updates unless destroy?)].compact.join("\n")
     end
 
     private
 
     def preface
-      "On #{whenn}, #{who} #{kind} the following #{model} info:".squeeze(' ')
+      "On #{whenn}, #{who} #{kind} #{what}".squeeze(' ')
+    end
+
+    def what
+      if destroy?
+        "#{model}#{item_id}"
+      else
+        "the following #{model}#{item_id} info:"
+      end
+    end
+
+    def item_id; end
+
+    def tell_story?(updates)
+      create? || destroy? || updates.present? || !config.filter_non_changes
     end
   end
 end

data/lib/paper_trail_scrapbook/life_history.rb

@@ -5,7 +5,15 @@ module PaperTrailScrapbook
   #
   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)
     end
 
     # Retries textual historical analysis of versions
@@ -14,12 +22,21 @@ module PaperTrailScrapbook
     #
     def story
       versions.map do |v|
-        Chapter.new(v).story
+        if primary?(v)
+          Chapter
+        else
+          SecondaryChapter
+        end.new(v).story
       end.compact.join("\n\n")
     end
 
     private
 
-    attr_reader :versions
+    def primary?(version)
+      version.item_type.eql?(object.class.name) &&
+        version.item_id.equal?(object.id)
+    end
+
+    attr_reader :object, :versions
   end
 end

data/lib/paper_trail_scrapbook/secondary_chapter.rb

@@ -0,0 +1,12 @@
+module PaperTrailScrapbook
+  # Class SecondaryChapter provides single version history analysis for data
+  # related to the main subject
+  #
+  class SecondaryChapter < Chapter
+    private
+
+    def item_id
+      "[#{model_id}]"
+    end
+  end
+end

data/lib/paper_trail_scrapbook/version.rb

@@ -1,4 +1,4 @@
 module PaperTrailScrapbook
   # Current version
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

data/lib/paper_trail_scrapbook/version_helpers.rb

@@ -16,6 +16,10 @@ module PaperTrailScrapbook
       event.eql?('create')
     end
 
+    def destroy?
+      event.eql?('destroy')
+    end
+
     def changes
       Changes.new(version).change_log
     end

data/lib/paper_trail_scrapbook.rb

@@ -8,6 +8,7 @@ require 'paper_trail_scrapbook/chapter'
 require 'paper_trail_scrapbook/changes'
 require 'paper_trail_scrapbook/journal_entry'
 require 'paper_trail_scrapbook/life_history'
+require 'paper_trail_scrapbook/secondary_chapter'
 require 'paper_trail_scrapbook/user_journal'
 require 'paper_trail_scrapbook/version'
 require 'paper_trail_scrapbook/version_helpers'

data/spec/paper_trail_scrapbook/chapter_spec.rb

@@ -50,7 +50,14 @@ module PaperTrailScrapbook
 
     describe '#story' do
       it 'provides a whole story' do
+        expect(subject).to match(/updated the following Widget info/)
+        expect(subject).to match(/email: tim@redbox.com added/)
+        expect(subject).to match(/name: Tim Chambers added/)
+        expect(subject).to match(/sent: false -> true/)
+        expect(subject).to match(/created by: \d+ added/)
+        expect(subject).to match(/amount: 29612.0 added/)
         expect(subject).to match(/discounted amount: 29612.0 added/)
+        expect(subject).to match(/status: active -> issued/)
       end
     end
   end

data/spec/paper_trail_scrapbook/life_history_spec.rb

@@ -87,12 +87,37 @@ module PaperTrailScrapbook
       end
 
       context 'no papertrail' do
-        let(:target) {Elephant.create!}
+        let(:target) { Elephant.create! }
+
         it 'has none' do
           target
           expect(subject).to eql ''
         end
       end
+
+      context 'with related data' do
+        before do
+          author
+          book
+          target
+
+          def target.trailed_related_content
+            [book, author]
+          end
+        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).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/secondary_chapter_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module PaperTrailScrapbook
+  ::RSpec.describe SecondaryChapter do
+    let(:version) do
+      OpenStruct.new(id:             2_674_798,
+                     item_type:      'Widget',
+                     item_id:        4804,
+                     event:          'update',
+                     whodunnit:      '1742',
+                     object:         ['---',
+                                      'id: ',
+                                      'discounted_amount: '].join("\n"),
+                     created_at:     Time.current,
+                     object_changes: ['---',
+                                      'email:',
+                                      '- ',
+                                      '- tim@redbox.com',
+                                      'name:',
+                                      '- ',
+                                      '- Tim Chambers',
+                                      'sent:',
+                                      '- false',
+                                      '- true',
+                                      'created_by:',
+                                      '- ',
+                                      '- 1742',
+                                      'amount:',
+                                      '- ',
+                                      '- 29612.0',
+                                      'discounted_amount:',
+                                      '- ',
+                                      '- !ruby/object:BigDecimal 36:0.29612E5',
+                                      'created_at:',
+                                      '- ',
+                                      '- &1 2017-06-07 21:37:02.188657104 Z',
+                                      'updated_at:',
+                                      '- ',
+                                      '- *1',
+                                      'id:',
+                                      '- ',
+                                      '- 4806',
+                                      'status:',
+                                      '- active',
+                                      '- issued'].join("\n"))
+    end
+
+    let(:object) { described_class.new(version) }
+    let(:subject) { object.story }
+
+    describe '#story' do
+      it 'provides a whole story' do
+        expect(subject).to match(/updated the following Widget\[\d+\] info/)
+        expect(subject).to match(/email: tim@redbox.com added/)
+        expect(subject).to match(/name: Tim Chambers added/)
+        expect(subject).to match(/sent: false -> true/)
+        expect(subject).to match(/created by: \d+ added/)
+        expect(subject).to match(/amount: 29612.0 added/)
+        expect(subject).to match(/discounted amount: 29612.0 added/)
+        expect(subject).to match(/status: active -> issued/)
+      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.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Timothy Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -299,6 +299,7 @@ files:
 - lib/paper_trail_scrapbook/config.rb
 - lib/paper_trail_scrapbook/journal_entry.rb
 - lib/paper_trail_scrapbook/life_history.rb
+- lib/paper_trail_scrapbook/secondary_chapter.rb
 - lib/paper_trail_scrapbook/user_journal.rb
 - lib/paper_trail_scrapbook/version.rb
 - lib/paper_trail_scrapbook/version_helpers.rb
@@ -382,6 +383,7 @@ files:
 - spec/paper_trail_scrapbook/chapter_spec.rb
 - spec/paper_trail_scrapbook/config_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
@@ -407,7 +409,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Paper Trail Scrapbook