paper_trail_scrapbook 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8a8392755eb1e658bea68423fffc6707e8aa465
-  data.tar.gz: 755f0f904aa0173175f279ec8832bc959833f0a6
+  metadata.gz: beb12cf083c8ab24992a92031c733746855ee546
+  data.tar.gz: d086bc0ab29a2c5b35aae138318edfaae355fa84
 SHA512:
-  metadata.gz: 9ee0eaa31e43a7f427b4f2f1f224a19207cdc24e6ecc67bb84bea064c95b92fc05644c3779ddc533d38291674f18a3f35b7e1c0d4825d0c8c30557be745e07a3
-  data.tar.gz: a9d56422cad7eb4da6437077761b032a874c3940288ff3d82f3ac0b81317b7d4dc108b93d627f990378a2fd09092b0c5550ca85b98b62278b8808ba7035e566e
+  metadata.gz: 3a3eefe97a1dcca4d1218708959f7eaffb24d0858d37a7b957a6e51e42f74567fb8b9bb487831245a3df3240451370d0edc9d14db33611d8c4c2dcea1ab2ca1a
+  data.tar.gz: 828fe0985c42cb90538dd2d9e48416b171996352948f1cc8f55310a2e49a87b8994e08f3abe89d4eb88161d25770b8cb751212b24b4f7217198310f480db323a

data/.rubocop.yml

@@ -18,3 +18,13 @@ Security/YAMLLoad:
 # Limit line length
 Metrics/LineLength:
   Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
+

data/Changelog.md

@@ -15,6 +15,21 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 ### Fixed
 
+## 0.1.7 (2018-01-19)  Functional Release
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- Added #invalid_whodunnit to support whodunnit that are declared but not found
+- Added UserJournal to capture all changes made by a user over time
+
+### Fixed
+
+- None
+
 ## 0.1.4 (2017-11-08) Minor Functional Release
 
 ### Breaking Changes

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec # DRY!  No need to repeat the gem deps here

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.6)
+    paper_trail_scrapbook (0.1.7)
       activerecord (>= 4.0, < 5.2)
       adamantium
       concord
       paper_trail (>= 5.2)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionpack (5.1.2)
       actionview (= 5.1.2)
@@ -60,16 +60,16 @@ GEM
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (0.8.2)
-    mini_portile2 (2.2.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.2)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
-    paper_trail (7.0.3)
-      activerecord (>= 4.0, < 5.2)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    paper_trail (8.1.2)
+      activerecord (>= 4.2, < 5.2)
       request_store (~> 1.1)
-    parallel (1.11.2)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     powerpack (0.1.1)
     rack (2.0.3)
     rack-test (0.6.3)
@@ -85,37 +85,37 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rainbow (2.2.2)
-      rake
-    rake (12.0.0)
-    request_store (1.3.2)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    request_store (1.4.0)
+      rack (>= 1.4)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-rails (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
       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)
-    rubocop (0.49.1)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (0.18.1)
-      rubocop (~> 0.18)
-    ruby-progressbar (1.8.1)
+    rubocop-rspec (1.22.1)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.9.0)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -139,7 +139,7 @@ DEPENDENCIES
   paper_trail_scrapbook!
   railties (>= 4.0, < 5.2)
   rake (~> 12.0)
-  rspec-rails (~> 3.6)
+  rspec-rails (~> 3.7)
   rubocop
   rubocop-rspec
   simplecov
@@ -147,4 +147,4 @@ DEPENDENCIES
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

data/lib/paper_trail_scrapbook.rb

@@ -6,8 +6,11 @@ require 'pathname'
 require 'paper_trail_scrapbook/config'
 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/user_journal'
 require 'paper_trail_scrapbook/version'
+require 'paper_trail_scrapbook/version_helpers'
 
 # Library namespace
 #

data/lib/paper_trail_scrapbook/changes.rb

@@ -36,7 +36,7 @@ module PaperTrailScrapbook
       old, new = v
       return if old.nil? && (new.nil? || new.eql?(''))
 
-      "#{BULLET} #{k.gsub('_',' ')}: #{detailed_analysis(k, new, old)}"
+      "#{BULLET} #{k.tr('_', ' ')}: #{detailed_analysis(k, new, old)}"
     end
 
     def detailed_analysis(k, new, old)
@@ -62,7 +62,7 @@ module PaperTrailScrapbook
 
       begin
         assoc[key].find(value).to_s.to_s + "[#{value}]"
-      rescue
+      rescue StandardError
         "*not found*[#{value}]"
       end
     end
@@ -72,7 +72,7 @@ module PaperTrailScrapbook
       return direct_class if direct_class && !direct_class.is_a?(String)
 
       Object.const_get((direct_class || name.to_s).classify)
-    rescue
+    rescue StandardError
       Object.const_set(name.to_s.classify, Class.new)
     end
 

data/lib/paper_trail_scrapbook/chapter.rb

@@ -1,3 +1,5 @@
+require_relative 'version_helpers'
+
 module PaperTrailScrapbook
   # Class Chapter provides single version history analysis
   #
@@ -6,8 +8,7 @@ module PaperTrailScrapbook
   class Chapter
     include Concord.new(:version)
     include Adamantium::Flat
-
-    delegate :event, to: :version
+    include PaperTrailScrapbook::VersionHelpers
 
     # Single version historical analysis
     #
@@ -25,51 +26,5 @@ module PaperTrailScrapbook
     def preface
       "On #{whenn}, #{who} #{kind} the following #{model} info:".squeeze(' ')
     end
-
-    def model
-      version.item_type
-    end
-
-    def create?
-      event.eql?('create')
-    end
-
-    def changes
-      Changes.new(version).change_log
-    end
-
-    def who
-      author = version.version_author
-      if author
-        if whodunnit_class
-          if whodunnit_class.method_defined?(:to_whodunnit)
-            whodunnit_class.find(author).to_whodunnit
-          else
-            whodunnit_class.find(author).to_s
-          end
-        else
-          author
-        end
-      else
-        config.unknown_whodunnit
-      end
-    end
-
-    def whodunnit_class
-      config.whodunnit_class
-    end
-
-    def config
-      PaperTrailScrapbook.config
-    end
-
-    def whenn
-      version.created_at.strftime(config.time_format)
-    end
-
-    def kind
-      config.events[event] ||
-        raise(ArgumentError, "incorrect event:#{event}")
-    end
   end
 end

data/lib/paper_trail_scrapbook/config.rb

@@ -19,6 +19,7 @@ module PaperTrailScrapbook
                   :scrub_columns,
                   :drop_id_suffix,
                   :unknown_whodunnit,
+                  :invalid_whodunnit,
                   :filter_non_changes
 
     def initialize
@@ -27,6 +28,7 @@ module PaperTrailScrapbook
       @events             = DEFAULT_EVENTS
       @scrub_columns      = SCRUB_COLUMNS
       @unknown_whodunnit  = UNKNOWN_WHODUNNIT
+      @invalid_whodunnit  = proc { |w| "*missing (#{w})*" }
       @drop_id_suffix     = true
       @filter_non_changes = true
     end

data/lib/paper_trail_scrapbook/journal_entry.rb

@@ -0,0 +1,32 @@
+require_relative 'version_helpers'
+
+module PaperTrailScrapbook
+  # Class JournalEntry provides single version history analysis
+  #
+  # @author Jason Dinsmore <jason@dinjas.com>
+  #
+  class JournalEntry
+    include Concord.new(:version)
+    include Adamantium::Flat
+    include PaperTrailScrapbook::VersionHelpers
+
+    delegate :event, to: :version
+
+    # Single version historical analysis
+    #
+    # @return [String] Human readable description of changes
+    #
+    def story
+      updates = changes
+      return unless create? || updates.present? || !config.filter_non_changes
+
+      "#{preface}\n#{updates}"
+    end
+
+    private
+
+    def preface
+      "On #{whenn}, #{kind} #{model}[#{model_id}]:".squeeze(' ')
+    end
+  end
+end

data/lib/paper_trail_scrapbook/user_journal.rb

@@ -0,0 +1,62 @@
+module PaperTrailScrapbook
+  # Class UserJournal provides history for a user, optionally scoped by
+  # object class and/or date range
+  #
+  # @author Jason Dinsmore <jason@dinjas.com>
+  #
+  class UserJournal
+    include Adamantium::Flat
+
+    def initialize(user, opts = {})
+      @user     = user
+      @user_id  = String(user.id)
+      @options  = opts
+      @starts   = options[:start] || Time.at(0).in_time_zone
+      @ends     = options[:end] || Time.current.in_time_zone
+
+      @versions = PaperTrail::Version.where(query_params)
+    end
+
+    # Retries textual historical analysis of versions
+    #
+    # @return [String] analyzed versions
+    #
+    def story
+      s = versions.map do |v|
+        JournalEntry.new(v).story
+      end.compact.join("\n\n")
+
+      "#{preface}#{s.presence || 'No history'}"
+    end
+
+    private
+
+    def preface
+      "Between #{when_range}, #{user} made the following #{what} changes:\n\n"
+        .squeeze(' ')
+    end
+
+    def query_params
+      params = { whodunnit: user_id }
+      return params if options.empty?
+
+      params.merge(item_type:  what,
+                   created_at: starts..ends)
+            .delete_if { |_, v| v.presence.nil? }
+    end
+
+    def time_format
+      PaperTrailScrapbook.config.time_format
+    end
+
+    def what
+      String(options.fetch(:klass, nil)).presence
+    end
+
+    def when_range
+      "#{starts.strftime(time_format)} and #{ends.strftime(time_format)}"
+    end
+
+    attr_reader :user, :user_id, :versions, :options, :starts, :ends
+  end
+end

data/lib/paper_trail_scrapbook/version.rb

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

data/lib/paper_trail_scrapbook/version_helpers.rb

@@ -0,0 +1,60 @@
+module PaperTrailScrapbook
+  # Module VersionHelpers provides methods for extracting common information
+  # from a version or PaperTrailScrapbook config
+  module VersionHelpers
+    delegate :event, to: :version
+
+    def model
+      version.item_type
+    end
+
+    def model_id
+      version.item_id
+    end
+
+    def create?
+      event.eql?('create')
+    end
+
+    def changes
+      Changes.new(version).change_log
+    end
+
+    def config
+      PaperTrailScrapbook.config
+    end
+
+    def whenn
+      version.created_at.strftime(config.time_format)
+    end
+
+    def kind
+      config.events[event] ||
+        raise(ArgumentError, "incorrect event:#{event}")
+    end
+
+    def who
+      author = version.version_author
+      return config.unknown_whodunnit unless author
+      return author unless whodunnit_class
+
+      whodunnit_instance(author)
+    end
+
+    def whodunnit_class
+      config.whodunnit_class
+    end
+
+    def whodunnit_instance(author)
+      instance = begin
+                   whodunnit_class.find(author)
+                 rescue StandardError
+                   config.invalid_whodunnit.call(author)
+                 end
+
+      return instance.to_whodunnit if instance.respond_to?(:to_whodunnit)
+
+      instance.to_s
+    end
+  end
+end

data/paper_trail_scrapbook.gemspec

@@ -21,18 +21,18 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'concord'
   gem.add_dependency 'paper_trail', '>= 5.2'
 
-  gem.add_development_dependency 'rake', '~> 12.0'
   gem.add_development_dependency 'ffaker', '~> 2.5'
+  gem.add_development_dependency 'rake', '~> 12.0'
 
   # Why `railties`? Possibly used by `spec/dummy_app` boot up?
   gem.add_development_dependency 'railties', ['>= 4.0', '< 5.2']
 
-  gem.add_development_dependency 'rspec-rails', '~> 3.6'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.7'
   gem.add_development_dependency 'database_cleaner', '~> 1.2'
+  gem.add_development_dependency 'rspec-rails', '~> 3.7'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-rspec'
-  gem.add_development_dependency 'timecop', '~> 0.8.0'
-  gem.add_development_dependency 'sqlite3', '~> 1.3.13'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.7'
+  gem.add_development_dependency 'sqlite3', '~> 1.3.13'
+  gem.add_development_dependency 'timecop', '~> 0.8.0'
 end

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

@@ -1,5 +1,3 @@
 class Fruit < ActiveRecord::Base
-  if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
-    has_paper_trail class_name: 'JsonVersion'
-  end
+  has_paper_trail class_name: 'JsonVersion' if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
 end

data/spec/dummy_app/config/application.rb

@@ -26,12 +26,8 @@ module Dummy
     # in rails 5. Oh, how fickle are the gods.
     if ActiveRecord.respond_to?(:gem_version)
       v = ActiveRecord.gem_version
-      if v >= Gem::Version.new('4.2') && v < Gem::Version.new('5.0.0.beta1')
-        config.active_record.raise_in_transactional_callbacks = true
-      end
-      if v >= Gem::Version.new('5.0.0.beta1')
-        config.active_record.time_zone_aware_types = [:datetime]
-      end
+      config.active_record.raise_in_transactional_callbacks = true if v >= Gem::Version.new('4.2') && v < Gem::Version.new('5.0.0.beta1')
+      config.active_record.time_zone_aware_types = [:datetime] if v >= Gem::Version.new('5.0.0.beta1')
     end
   end
 end

data/spec/paper_trail_scrapbook/life_history_spec.rb

@@ -4,13 +4,11 @@ module PaperTrailScrapbook
   ::RSpec.describe LifeHistory do
     before do
       PaperTrailScrapbook.config.whodunnit_class = Person
-
-      p = Person.new(name: 'The Tim Man')
-      p.save!
-
-      PaperTrail.whodunnit = p.id
+      PaperTrail.whodunnit = person.id
     end
 
+    let(:person) { Person.create(name: 'The Tim Man') }
+
     let(:book) do
       b = Book.new(title: 'How the Grinch stole Xmas')
       b.save!
@@ -57,7 +55,35 @@ module PaperTrailScrapbook
         target.book = nil
         target.save!
 
-        expect(subject).to match(/How the Grinch stole Xmas\[1\] was \*removed\*/)
+        expect(subject)
+          .to match(/How the Grinch stole Xmas\[1\] was \*removed\*/)
+      end
+
+      context 'it handles missing whodunnit record' do
+        it 'provides a whole story with missing whodunnit record' do
+          target
+          pid = person.id
+          person.destroy
+
+          expect(subject)
+            .to match(/\*missing \(#{pid}\)\* created the following/)
+        end
+      end
+
+      context 'with overridden invalid whodunnit handler' do
+        it 'allows for a custom invalid_whodunnit handler' do
+          config = PaperTrailScrapbook.config
+          handler = config.invalid_whodunnit
+          config.invalid_whodunnit = proc { |w| "*WHO (#{w})*" }
+
+          target
+          pid = person.id
+          person.destroy
+
+          expect(subject).to match(/\*WHO \(#{pid}\)\* created the following/)
+
+          config.invalid_whodunnit = handler
+        end
       end
     end
   end

data/spec/paper_trail_scrapbook/user_journal_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+module PaperTrailScrapbook
+  RSpec.describe UserJournal do
+    before do
+      PaperTrailScrapbook.config.whodunnit_class = Person
+      PaperTrail.whodunnit = person.id
+
+      a_ship
+    end
+
+    let(:name) { 'The Tim Man' }
+    let(:title) { 'How the Grinch stole Xmas' }
+    let(:a_name) { 'Dr. Seuss' }
+    let(:changes) { 'made the following changes:' }
+    let(:b_changes) { 'made the following Book changes:' }
+
+    let(:book) { Book.create!(title: title) }
+    let(:author) { Person.create!(name: a_name) }
+    let(:a_ship) { Authorship.create!(book: book, author: author) }
+    let(:person) do
+      who = PaperTrail.whodunnit
+      PaperTrail.whodunnit = nil
+      p = Person.new(name: name)
+      p.save!
+      PaperTrail.whodunnit = who
+      p
+    end
+    let(:format) { PaperTrailScrapbook.config.time_format }
+    let(:object) { described_class.new(person, {}) }
+    let(:subject) { object.story }
+    let(:f_starts) { starts.strftime(format).squeeze(' ') }
+    let(:f_ends) { ends.strftime(format).squeeze(' ') }
+
+    describe '#story' do
+      context 'with a provided user' do
+        it 'provides a whole story' do
+          expect(subject)
+            .to match(/Between .* and .*, #{name} #{changes}/)
+          expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title}/)
+          expect(subject).to match(/On .*, created Person\[#{author.id}\]:/)
+          expect(subject).to match(/ • name: #{a_name}/)
+          expect(subject).to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+          expect(subject).to match(/ • book: #{title}\[#{book.id}\]/)
+          expect(subject).to match(/ • author: Dr. Seuss\[#{author.id}\]/)
+        end
+
+        it 'provides a whole story missing to_s content' do
+          book.title = nil
+          book.save!
+
+          expect(subject).to match(/On .*, updated Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title} was \*removed\*/)
+        end
+      end
+
+      context 'with missing references' do
+        it 'provides a whole story missing reference' do
+          book.destroy
+
+          expect(subject).to match(/book: \*not found\*\[/)
+        end
+
+        it 'provides a whole story missing reference' do
+          a_ship.book = nil
+          a_ship.save!
+
+          expect(subject).to match(/#{title}\[1\] was \*removed\*/)
+        end
+      end
+
+      context 'with a provided class' do
+        let(:object) { described_class.new(person, klass: Book) }
+
+        it 'provides a story for provided class' do
+          expect(subject)
+            .to match(/Between .* and .*, #{name} #{b_changes}/)
+          expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title}/)
+          expect(subject).not_to match(/On .*, created Person\[#{author.id}\]:/)
+          expect(subject).not_to match(/ • name: #{a_name}/)
+          expect(subject)
+            .not_to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+        end
+      end
+
+      context 'with start time and class but no end time' do
+        let(:object) { described_class.new(person, klass: Book, start: starts) }
+        let(:starts) { Time.current.advance(minutes: -5) }
+
+        it 'provides a story with start time' do
+          expect(subject)
+            .to match(/Between #{f_starts} and .*, #{name} #{b_changes}/)
+          expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title}/)
+          expect(subject).not_to match(/On .*, created Person\[#{author.id}\]:/)
+          expect(subject).not_to match(/ • name: #{a_name}/)
+          expect(subject)
+            .not_to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+        end
+      end
+
+      context 'with end time but no start time and no class' do
+        let(:ends) { Time.current.advance(minutes: 5) }
+        let(:object) { described_class.new(person, end: ends) }
+
+        it 'provides a story with end time in the future' do
+          expect(subject)
+            .to match(/Between .* and #{f_ends}, #{name} #{changes}/)
+          expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title}/)
+          expect(subject).to match(/On .*, created Person\[#{author.id}\]:/)
+          expect(subject).to match(/ • name: #{a_name}/)
+          expect(subject).to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+        end
+
+        describe 'with end time in past' do
+          let(:ends) { Time.current.advance(minutes: -5) }
+
+          it 'provides a story with end time in the past' do
+            expect(subject).not_to match(/#{name} created the following Person/)
+            expect(subject).not_to match(/#{name} created the following Book/)
+            expect(subject).not_to match(/#{title}/)
+            expect(subject).not_to match(/#{name} created the following Author/)
+          end
+        end
+      end
+
+      context 'with start and end times but no class' do
+        let(:starts) { Time.current.advance(minutes: -4) }
+        let(:ends) { starts.advance(hours: 1) }
+        let(:object) { described_class.new(person, start: starts, end: ends) }
+
+        it 'provides a story with start and end times' do
+          expect(subject)
+            .to match(/Between .* and .*, #{name} #{changes}/)
+          expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+          expect(subject).to match(/ • title: #{title}/)
+          expect(subject).to match(/On .*, created Person\[#{author.id}\]:/)
+          expect(subject).to match(/ • name: #{a_name}/)
+          expect(subject).to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+          expect(subject).to match(/ • book: #{title}\[#{book.id}\]/)
+        end
+      end
+
+      context 'with start time, end time, and a class' do
+        let(:starts) { Time.current.advance(minutes: -4) }
+        let(:ends) { starts.advance(hours: 1) }
+        let(:object) do
+          described_class.new(person, klass: Book, start: starts, end: ends)
+        end
+
+        describe 'when time range covers current time' do
+          it 'provides a story for provided class with start and end times' do
+            expect(subject)
+              .to match(/Between #{f_starts} and #{f_ends}, #{name} #{b_changes}/)
+            expect(subject).to match(/On .*, created Book\[#{book.id}\]:/)
+            expect(subject).to match(/ • title: #{title}/)
+            expect(subject)
+              .not_to match(/On .*, created Person\[#{author.id}\]:/)
+            expect(subject).not_to match(/ • name: #{a_name}/)
+            expect(subject)
+              .not_to match(/On .*, created Authorship\[#{a_ship.id}\]:/)
+          end
+        end
+
+        describe 'when time range is completely in the future' do
+          let(:starts) { Time.current.advance(minutes: 4) }
+
+          it 'provides a story' do
+            expect(subject).to eql("Between #{f_starts} and #{f_ends}, #{name}"\
+                                     " #{b_changes}\n\nNo history".squeeze(' '))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/paper_trail_scrapbook/version_helpers_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'ostruct'
+
+module PaperTrailScrapbook
+  RSpec.describe VersionHelpers 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: Time.current,
+                     version_author: person.id)
+    end
+    let(:config) { PaperTrailScrapbook.config }
+    let(:subject) { JournalEntry.new(version) }
+
+    before do
+      PaperTrailScrapbook.config.whodunnit_class = Person
+      PaperTrail.whodunnit = person.id
+    end
+
+    describe '#model' do
+      it 'returns expected result' do
+        expect(subject.model).to eql('Book')
+      end
+    end
+
+    describe '#model_id' do
+      it 'returns expected result' do
+        expect(subject.model_id).to equal(book.id)
+      end
+    end
+
+    describe '#create?' do
+      it 'returns true if create event' do
+        expect(subject.create?).to be true
+      end
+
+      it 'returns false if not create event' do
+        version.event = 'update'
+
+        expect(subject.create?).to be false
+      end
+    end
+
+    describe '#changes' do
+      it 'returns changes' do
+        expect(subject.changes).to eql('')
+      end
+    end
+
+    describe '#config' do
+      it 'returns instance of Config' do
+        expect(subject.config).to be_an_instance_of(PaperTrailScrapbook::Config)
+      end
+    end
+
+    describe '#whenn' do
+      it 'returns version created_at' do
+        expect(subject.whenn)
+          .to eql(version.created_at.strftime(config.time_format))
+      end
+    end
+
+    describe '#kind' do
+      it 'returns expected value' do
+        expect(subject.kind).to eql('created')
+      end
+    end
+
+    describe '#who' do
+      it 'returns expected value' do
+        expect(subject.who).to eql(person.name)
+      end
+    end
+
+    describe '#whodunnit_class' do
+      it 'returns expected value' do
+        expect(subject.whodunnit_class).to eql(Person)
+      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.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Timothy Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -73,33 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: ffaker
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -121,19 +121,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 1.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -177,19 +191,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -205,33 +219,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.13
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  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: codeclimate-test-reporter
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 0.8.0
 description: Human Readable Change Log for Paper Trail'd data
 email: tim@possibilogy.com
 executables: []
@@ -255,10 +255,15 @@ files:
 - lib/paper_trail_scrapbook/changes.rb
 - lib/paper_trail_scrapbook/chapter.rb
 - lib/paper_trail_scrapbook/config.rb
+- lib/paper_trail_scrapbook/journal_entry.rb
 - lib/paper_trail_scrapbook/life_history.rb
+- lib/paper_trail_scrapbook/user_journal.rb
 - lib/paper_trail_scrapbook/version.rb
+- lib/paper_trail_scrapbook/version_helpers.rb
 - paper_trail_scrapbook.gemspec
 - pkg/paper_trail_scrapbook-0.0.2.gem
+- pkg/paper_trail_scrapbook-0.1.6.gem
+- pkg/paper_trail_scrapbook-0.1.7.gem
 - spec/dummy_app/Rakefile
 - spec/dummy_app/app/models/animal.rb
 - spec/dummy_app/app/models/article.rb
@@ -336,6 +341,8 @@ 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/user_journal_spec.rb
+- spec/paper_trail_scrapbook/version_helpers_spec.rb
 - spec/paper_trail_scrapbook/version_spec.rb
 - spec/paper_trail_scrapbook_spec.rb
 - spec/spec_helper.rb