paper_trail_scrapbook 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04ce3afcfa96b52d1e8463ff220070e356c1cd68
-  data.tar.gz: 37b9d95a96920753ed9f903896c2efe64c23e03c
+  metadata.gz: a8a8392755eb1e658bea68423fffc6707e8aa465
+  data.tar.gz: 755f0f904aa0173175f279ec8832bc959833f0a6
 SHA512:
-  metadata.gz: d03384bd9a008a9ecf496e854da517041b44fc80007f2847973de231d1fa5a66815ceda7b45d02e78d7d22c8d4e94ff636e4c3d85d3bcea4e0058a055c521be3
-  data.tar.gz: 12803d8f125410f002c46f8eeb8f23af17f004724c69f44523cfbf22c7a49445cbbd92326b9f571d454c4325c594a3dfbec46de8ce6ca8d8d255d00c0fdcbc53
+  metadata.gz: 9ee0eaa31e43a7f427b4f2f1f224a19207cdc24e6ecc67bb84bea064c95b92fc05644c3779ddc533d38291674f18a3f35b7e1c0d4825d0c8c30557be745e07a3
+  data.tar.gz: a9d56422cad7eb4da6437077761b032a874c3940288ff3d82f3ac0b81317b7d4dc108b93d627f990378a2fd09092b0c5550ca85b98b62278b8808ba7035e566e

data/.gitignore

@@ -0,0 +1 @@
+test.log

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at tim@possibilogy.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Changelog.md

@@ -15,6 +15,20 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 ### Fixed
 
+## 0.1.4 (2017-11-08) Minor Functional Release
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- Added #to_whodunnit as a customizeable fetch of the whodunnit info
+
+### Fixed
+
+- None
+
 ## 0.1.3 (2017-07-05) Bugfix Release
 
 ### Breaking Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paper_trail_scrapbook (0.1.2)
+    paper_trail_scrapbook (0.1.6)
       activerecord (>= 4.0, < 5.2)
       adamantium
       concord
@@ -147,4 +147,4 @@ DEPENDENCIES
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   1.15.1
+   1.15.4

data/README.md

@@ -46,7 +46,7 @@ PaperTrailScrapbook.config.whodunnit_class = WhoDidIt
 ```ruby
 widget = Widget.find 42
 
-text = PaperTrailScrapbook::LifeStory.new(widget).story
+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 

data/Rakefile

@@ -21,4 +21,4 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 desc 'Default: run all available test suites'
-task default: %i(rubocop prepare spec)
+task default: %i[rubocop prepare spec]

data/lib/paper_trail_scrapbook/changes.rb

@@ -26,7 +26,7 @@ module PaperTrailScrapbook
              .compact
              .join("\n")
 
-      text = text.gsub('_id:', ':') if PaperTrailScrapbook.config.drop_id_suffix
+      text = text.gsub(' id:', ':') if PaperTrailScrapbook.config.drop_id_suffix
       text
     end
 
@@ -36,7 +36,7 @@ module PaperTrailScrapbook
       old, new = v
       return if old.nil? && (new.nil? || new.eql?(''))
 
-      "#{BULLET} #{k}: #{detailed_analysis(k, new, old)}"
+      "#{BULLET} #{k.gsub('_',' ')}: #{detailed_analysis(k, new, old)}"
     end
 
     def detailed_analysis(k, new, old)

data/lib/paper_trail_scrapbook/chapter.rb

@@ -7,12 +7,17 @@ module PaperTrailScrapbook
     include Concord.new(:version)
     include Adamantium::Flat
 
+    delegate :event, to: :version
+
     # Single version historical analysis
     #
     # @return [String] Human readable description of changes
     #
     def story
-      "#{preface}\n#{changes}"
+      updates = changes
+      return unless create? || updates.present? || !config.filter_non_changes
+
+      "#{preface}\n#{updates}"
     end
 
     private
@@ -25,6 +30,10 @@ module PaperTrailScrapbook
       version.item_type
     end
 
+    def create?
+      event.eql?('create')
+    end
+
     def changes
       Changes.new(version).change_log
     end
@@ -33,7 +42,11 @@ module PaperTrailScrapbook
       author = version.version_author
       if author
         if whodunnit_class
-          whodunnit_class.find(author).to_s
+          if whodunnit_class.method_defined?(:to_whodunnit)
+            whodunnit_class.find(author).to_whodunnit
+          else
+            whodunnit_class.find(author).to_s
+          end
         else
           author
         end
@@ -55,8 +68,8 @@ module PaperTrailScrapbook
     end
 
     def kind
-      config.events[version.event] ||
-        raise(ArgumentError, "incorrect event:#{version.event}")
+      config.events[event] ||
+        raise(ArgumentError, "incorrect event:#{event}")
     end
   end
 end

data/lib/paper_trail_scrapbook/config.rb

@@ -10,7 +10,7 @@ module PaperTrailScrapbook
                             'update'  => 'updated',
                             'destroy' => 'destroyed' }.freeze
 
-    SCRUB_COLUMNS     = %w(updated_at created_at id).freeze
+    SCRUB_COLUMNS     = %w[updated_at created_at id].freeze
     UNKNOWN_WHODUNNIT = '*the app*'.freeze
 
     attr_accessor :whodunnit_class,
@@ -18,15 +18,17 @@ module PaperTrailScrapbook
                   :events,
                   :scrub_columns,
                   :drop_id_suffix,
-                  :unknown_whodunnit
+                  :unknown_whodunnit,
+                  :filter_non_changes
 
     def initialize
-      @whodunnit_class   = nil
-      @time_format       = DEFAULT_TIME_FORMAT
-      @events            = DEFAULT_EVENTS
-      @scrub_columns     = SCRUB_COLUMNS
-      @unknown_whodunnit = UNKNOWN_WHODUNNIT
-      @drop_id_suffix    = true
+      @whodunnit_class    = nil
+      @time_format        = DEFAULT_TIME_FORMAT
+      @events             = DEFAULT_EVENTS
+      @scrub_columns      = SCRUB_COLUMNS
+      @unknown_whodunnit  = UNKNOWN_WHODUNNIT
+      @drop_id_suffix     = true
+      @filter_non_changes = true
     end
   end
 end

data/lib/paper_trail_scrapbook/life_history.rb

@@ -15,7 +15,7 @@ module PaperTrailScrapbook
     def story
       versions.map do |v|
         Chapter.new(v).story
-      end.join("\n\n")
+      end.compact.join("\n\n")
     end
 
     private

data/lib/paper_trail_scrapbook/version.rb

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

data/spec/paper_trail_scrapbook/changes_spec.rb

@@ -89,7 +89,7 @@ module PaperTrailScrapbook
 
     describe '#change_log' do
       it 'provides a set of update changes' do
-        expect(subject).to match(/discounted_amount: 29612.0 added/)
+        expect(subject).to match(/discounted amount: 29612.0 added/)
       end
 
       it 'filters the proper columns' do
@@ -101,7 +101,7 @@ module PaperTrailScrapbook
       it 'provides a set of create changes' do
         version.event = 'create'
 
-        expect(subject).to match(/discounted_amount: 29612.0$/)
+        expect(subject).to match(/discounted amount: 29612.0$/)
       end
     end
   end

data/spec/paper_trail_scrapbook/chapter_spec.rb

@@ -50,7 +50,7 @@ module PaperTrailScrapbook
 
     describe '#story' do
       it 'provides a whole story' do
-        expect(subject).to match(/discounted_amount: 29612.0 added/)
+        expect(subject).to match(/discounted amount: 29612.0 added/)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_scrapbook
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Timothy Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -239,9 +239,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
+- CODE_OF_CONDUCT.md
 - Changelog.md
 - Gemfile
 - Gemfile.lock