paper_trail_scrapbook 0.1.7 → 0.1.8

data/paper_trail_scrapbook.gemspec

@@ -22,17 +22,20 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'paper_trail', '>= 5.2'
 
   gem.add_development_dependency 'ffaker', '~> 2.5'
-  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rake', '~> 10.4.2'
 
   # Why `railties`? Possibly used by `spec/dummy_app` boot up?
   gem.add_development_dependency 'railties', ['>= 4.0', '< 5.2']
 
   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 'loofah', '~> 2.2.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', '~> 3.6'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-rspec'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'sqlite3', '~> 1.3.13'
   gem.add_development_dependency 'timecop', '~> 0.8.0'
 end

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

@@ -1,3 +1,3 @@
 class Elephant < Animal
-  paper_trail.disable
+  PaperTrail.request.disable_model(Elephant)
 end

data/spec/dummy_app/config/database.yml

@@ -1,15 +1,16 @@
-# SQLite version 3.x
-#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+
 test: &test
-  adapter: sqlite3
+  adapter: postgresql
+  encoding: unicode
+  host: localhost
+  database: pts_db
+  port: <%= ENV['DB_PORT'] || 5432 %>
   pool: 5
-  timeout: 5000
-  database: db/test.sqlite3
 
 foo:
   <<: *test
-  database: db/test-foo.sqlite3
+  database: pts_foo_db
 
 bar:
   <<: *test
-  database: db/test-bar.sqlite3
+  database: pts_bar_db

data/spec/paper_trail_scrapbook/changes_spec.rb

@@ -43,24 +43,12 @@ module PaperTrailScrapbook
                                       'order_number:',
                                       '- ',
                                       "- ''",
-                                      'notes:',
-                                      '- ',
-                                      "- ''",
-                                      'internal_notes:',
-                                      '- ',
-                                      "- ' '",
-                                      'other_terms:',
-                                      '- ',
-                                      "- ' '",
-                                      'payment_terms_cd:',
-                                      '- ',
-                                      '- 1',
-                                      'other_payment_terms:',
-                                      '- ',
-                                      "- ' '",
-                                      'sent:',
-                                      '- false',
-                                      '- true',
+                                      'notes:', '- ', "- ''",
+                                      'internal_notes:', '- ', "- ' '",
+                                      'other_terms:', "- ' '", '-',
+                                      'payment_terms_cd:', '- ', '- 1',
+                                      'other_payment_terms:', '- ', "- ' '",
+                                      'sent:', '- false', '- true',
                                       'created_by:',
                                       '- ',
                                       '- 1742',
@@ -89,13 +77,19 @@ module PaperTrailScrapbook
 
     describe '#change_log' do
       it 'provides a set of update changes' do
-        expect(subject).to match(/discounted amount: 29612.0 added/)
+        result = subject
+
+        expect(result).to match(/discounted amount: 29612.0 added/)
+        expect(result).to match(/• status: active -> issued/)
+        expect(result).to match(/other terms:   was \*removed\*/)
       end
 
       it 'filters the proper columns' do
-        expect(subject).not_to match(/created_at:/)
-        expect(subject).not_to match(/updated_at:/)
-        expect(subject).not_to match(/id:/)
+        result = subject
+
+        expect(result).not_to match(/created_at:/)
+        expect(result).not_to match(/updated_at:/)
+        expect(result).not_to match(/id:/)
       end
 
       it 'provides a set of create changes' do

data/spec/paper_trail_scrapbook/config_spec.rb

@@ -5,6 +5,20 @@ module PaperTrailScrapbook
     describe '.instance' do
       it 'returns the singleton instance' do
         expect { described_class.instance }.not_to raise_error
+        expect(described_class.instance.whodunnit_class).to equal(Person).or be_nil
+        expect(described_class.instance.time_format)
+          .to eql(described_class::DEFAULT_TIME_FORMAT)
+        expect(described_class.instance.events)
+          .to eql(described_class::DEFAULT_EVENTS)
+        expect(described_class.instance.scrub_columns)
+          .to eql(described_class::SCRUB_COLUMNS)
+        expect(described_class.instance.unknown_whodunnit)
+          .to eql(described_class::UNKNOWN_WHODUNNIT)
+
+        expect(described_class.instance.drop_id_suffix)
+          .to be true
+        expect(described_class.instance.filter_non_changes)
+          .to be true
       end
     end
 

data/spec/paper_trail_scrapbook/life_history_spec.rb

@@ -4,10 +4,10 @@ module PaperTrailScrapbook
   ::RSpec.describe LifeHistory do
     before do
       PaperTrailScrapbook.config.whodunnit_class = Person
-      PaperTrail.whodunnit = person.id
+      PaperTrail.request.whodunnit = person.id
     end
 
-    let(:person) { Person.create(name: 'The Tim Man') }
+    let(:person) {Person.create(name: 'The Tim Man')}
 
     let(:book) do
       b = Book.new(title: 'How the Grinch stole Xmas')
@@ -27,8 +27,8 @@ module PaperTrailScrapbook
       a
     end
 
-    let(:object) { described_class.new(target) }
-    let(:subject) { object.story }
+    let(:object) {described_class.new(target)}
+    let(:subject) {object.story}
 
     describe '#story' do
       it 'provides a whole story' do
@@ -56,7 +56,7 @@ module PaperTrailScrapbook
         target.save!
 
         expect(subject)
-          .to match(/How the Grinch stole Xmas\[1\] was \*removed\*/)
+            .to match(/How the Grinch stole Xmas\[\d+\] was \*removed\*/)
       end
 
       context 'it handles missing whodunnit record' do
@@ -66,7 +66,7 @@ module PaperTrailScrapbook
           person.destroy
 
           expect(subject)
-            .to match(/\*missing \(#{pid}\)\* created the following/)
+              .to match(/\*missing \(#{pid}\)\* created the following/)
         end
       end
 
@@ -74,7 +74,7 @@ module PaperTrailScrapbook
         it 'allows for a custom invalid_whodunnit handler' do
           config = PaperTrailScrapbook.config
           handler = config.invalid_whodunnit
-          config.invalid_whodunnit = proc { |w| "*WHO (#{w})*" }
+          config.invalid_whodunnit = proc {|w| "*WHO (#{w})*"}
 
           target
           pid = person.id
@@ -85,6 +85,14 @@ module PaperTrailScrapbook
           config.invalid_whodunnit = handler
         end
       end
+
+      context 'no papertrail' do
+        let(:target) {Elephant.create!}
+        it 'has none' do
+          target
+          expect(subject).to eql ''
+        end
+      end
     end
   end
 end

data/spec/paper_trail_scrapbook/user_journal_spec.rb

@@ -4,39 +4,42 @@ module PaperTrailScrapbook
   RSpec.describe UserJournal do
     before do
       PaperTrailScrapbook.config.whodunnit_class = Person
-      PaperTrail.whodunnit = person.id
+      PaperTrail.request.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(: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(: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
+      who = PaperTrail.request.whodunnit
+      PaperTrail.request.whodunnit = nil
       p = Person.new(name: name)
       p.save!
-      PaperTrail.whodunnit = who
+      PaperTrail.request.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(' ') }
+    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(object.starts).to eql 'Thursday, 01 Jan 1970 at 12:00 AM'
+          #expect(object.ends).to eql Time.current.in_time_zone
+
           expect(subject)
-            .to match(/Between .* and .*, #{name} #{changes}/)
+              .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}\]:/)
@@ -66,48 +69,48 @@ module PaperTrailScrapbook
           a_ship.book = nil
           a_ship.save!
 
-          expect(subject).to match(/#{title}\[1\] was \*removed\*/)
+          expect(subject).to match(/#{title}\[\d+\] was \*removed\*/)
         end
       end
 
       context 'with a provided class' do
-        let(:object) { described_class.new(person, klass: Book) }
+        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}/)
+              .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}\]:/)
+              .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) }
+        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}/)
+              .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}\]:/)
+              .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) }
+        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}/)
+              .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}\]:/)
@@ -116,7 +119,7 @@ module PaperTrailScrapbook
         end
 
         describe 'with end time in past' do
-          let(:ends) { Time.current.advance(minutes: -5) }
+          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/)
@@ -128,13 +131,13 @@ module PaperTrailScrapbook
       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) }
+        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}/)
+              .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}\]:/)
@@ -145,8 +148,8 @@ module PaperTrailScrapbook
       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(: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
@@ -154,25 +157,34 @@ module PaperTrailScrapbook
         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}/)
+                .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}\]:/)
+                .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}\]:/)
+                .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) }
+          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
+
+        describe 'when no time range' do
+          let(:starts) {nil}
+          let(:ends) {nil}
+          it 'provides a story' do
+            expect(subject).to match("Between Thursday, 01 Jan 1970 at 12:00 AM and #{Time.current.in_time_zone.strftime(format).squeeze(' ')}, #{name}"\
+                                     " #{b_changes}\n\n".squeeze(' '))
+          end
+        end
       end
     end
   end

data/spec/paper_trail_scrapbook/version_helpers_spec.rb

@@ -3,8 +3,8 @@ 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(: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',
@@ -12,12 +12,12 @@ module PaperTrailScrapbook
                      created_at: Time.current,
                      version_author: person.id)
     end
-    let(:config) { PaperTrailScrapbook.config }
-    let(:subject) { JournalEntry.new(version) }
+    let(:config) {PaperTrailScrapbook.config}
+    let(:subject) {JournalEntry.new(version)}
 
     before do
       PaperTrailScrapbook.config.whodunnit_class = Person
-      PaperTrail.whodunnit = person.id
+      PaperTrail.request.whodunnit = person.id
     end
 
     describe '#model' do
@@ -59,7 +59,7 @@ module PaperTrailScrapbook
     describe '#whenn' do
       it 'returns version created_at' do
         expect(subject.whenn)
-          .to eql(version.created_at.strftime(config.time_format))
+            .to eql(version.created_at.strftime(config.time_format))
       end
     end
 
@@ -67,6 +67,18 @@ module PaperTrailScrapbook
       it 'returns expected value' do
         expect(subject.kind).to eql('created')
       end
+
+      context 'garbage' do
+        let(:subject) {JournalEntry.new(version)}
+        it 'returns expected value' do
+          x = PaperTrailScrapbook.config.events
+          PaperTrailScrapbook.config.events = {}
+
+          expect {subject.kind}.to raise_error(ArgumentError, 'incorrect event:create')
+
+          PaperTrailScrapbook.config.events = x
+        end
+      end
     end
 
     describe '#who' do