paper_trail_scrapbook 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: aa47cf69ac7a2144dc53b73398b15ca2de056a755288b8d046dff1b5a81f72ac
-  data.tar.gz: d3287790361e5a2ebca3faec7898f242593658386fcff8edb682e5b61680681c
+SHA1:
+  metadata.gz: edc42760ad65ddabf5e4b5cbe6078a2106e05fd3
+  data.tar.gz: f414b720536a35971713cd2ab6615665861be9f0
 SHA512:
-  metadata.gz: 5f160146eca7e32aa5f1bad9251db38b9a25f58f404c0b02f70526a450a86e294983e1bd5a9be3903cceb76d1d5e6746d0dfef941fa59bd6931c1059581114d7
-  data.tar.gz: c1af014f91175252110e50459bc33f594ff4a5d1edfd738ea7502f83ed8d9e7c79d70081fb7ac0cd003ea4779bece333628e714712232834149949897ec7967e
+  metadata.gz: db255b9d214220f0161e76d0cc748b5a315be057fded74adfbaa4b79aa58403791196283381074050d0a3cb3fcc49b667ee57662268f6835c47b5b651c8f75cc
+  data.tar.gz: f05cfe2ca064ace2658641863635d640bf425cee52d5c57b9a14f51f63d849e2572f06b056468f175be867056a51891b95fab38545dc38974d1543cf7e2e42f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.18)
+    paper_trail_scrapbook (0.1.19)
       activerecord
       adamantium
       concord
@@ -61,7 +61,7 @@ GEM
     i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.1.0)
+    json (2.3.1)
     loofah (2.3.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -109,7 +109,7 @@ GEM
     pg (0.18.4)
     powerpack (0.1.1)
     procto (0.0.3)
-    rack (2.0.8)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -180,6 +180,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   codeclimate-test-reporter (~> 1.0.7)
@@ -202,4 +203,4 @@ DEPENDENCIES
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.2

data/README.md

@@ -16,7 +16,7 @@ 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-run the `PaperTrail` generator:
 
@@ -78,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
@@ -118,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

data/lib/paper_trail_scrapbook/life_history.rb

@@ -8,14 +8,7 @@ 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)
+      @versions = Versions.new(object).versions
     end
 
     # Retries textual historical analysis of versions

data/lib/paper_trail_scrapbook/version.rb

@@ -2,5 +2,5 @@
 
 module PaperTrailScrapbook
   # Current version
-  VERSION = '0.1.18'
+  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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_scrapbook
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Timothy Chambers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -340,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
@@ -425,13 +426,14 @@ files:
 - 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/hintmedia/paper_trail_scrapbook
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -446,8 +448,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
 specification_version: 4
 summary: Paper Trail Scrapbook
 test_files: []