paper_trail_scrapbook 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2227bf7cf82738d74887b11e4017a52950b5f774
+  data.tar.gz: 20465a690da01b2f9073059870e9e37e8ed3b0ee
+SHA512:
+  metadata.gz: a50ecc1b54b77918bf1aed69156f6f0c7fe93ebba4bf3fe6c589a25f57ff6141af992679eb2128e5199e0013514a12b36bd235740c6f44c8c71233d82f23e1a8
+  data.tar.gz: 1b9d471bc89bd8f6f906aba1538d41c9727274add361110fb744d40b11c4072973b14f7beee2a815c6f62986f2217bf38597c54fd43ba262bd6226deb4d30cd9

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths: []

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--require spec_helper
+--format progress
+--warnings
+--order random

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  DisabledByDefault: false
+  TargetRubyVersion: 2.2
+  TargetRailsVersion: 4.0
+  DisplayCopNames: true
+
+Security/YAMLLoad:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+paper_trail_scrapbook

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec # DRY!  No need to repeat the gem deps here

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    paper_trail_scrapbook (0.0.2)
+      activerecord (>= 4.0, < 5.2)
+      adamantium
+      concord
+      paper_trail
+      request_store (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (5.1.2)
+      actionview (= 5.1.2)
+      activesupport (= 5.1.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.2)
+      activesupport (= 5.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.1.2)
+      activesupport (= 5.1.2)
+    activerecord (5.1.2)
+      activemodel (= 5.1.2)
+      activesupport (= 5.1.2)
+      arel (~> 8.0)
+    activesupport (5.1.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    arel (8.0.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.6.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    erubi (1.6.1)
+    ffaker (2.6.0)
+    i18n (0.8.4)
+    ice_nine (0.11.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    paper_trail (7.0.3)
+      activerecord (>= 4.0, < 5.2)
+      request_store (~> 1.1)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.2)
+      actionpack (= 5.1.2)
+      activesupport (= 5.1.2)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.0)
+      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)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.15.1)
+      rubocop (>= 0.42.0)
+    ruby-progressbar (1.8.1)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    timecop (0.8.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 1.2)
+  ffaker (~> 2.5)
+  paper_trail_scrapbook!
+  railties (>= 4.0, < 5.2)
+  rake (~> 12.0)
+  rspec-core (~> 3.6)
+  rspec-rails (~> 3.6)
+  rubocop
+  rubocop-rspec
+  sqlite3
+  timecop (~> 0.8.0)
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Tim Chambers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Paper Trail Scrapbook
+
+[![CircleCI](https://circleci.com/gh/tjchambers/paper_trail_scrapbook/tree/master.svg?style=svg)](https://circleci.com/gh/tjchambers/paper_trail_scrapbook/tree/master)
+
+Human Readable audit reporting for users of [PaperTrail](https://github.com/airblade/paper_trail) gem.
+
+## Installation
+
+Add PaperTrailScrapBook to your `Gemfile`.
+
+    `gem 'paper_trail_scrapbook'`
+
+## Basic Usage
+
+### Configuration
+
+If you are using a ID of some sort to a class (i.e. _User_) for whodunnit in PaperTrail
+then you should configure this into the scrapbook so it can locate and provide a human readable value for the whodunnit.
+
+Create an initializer i.e. _config/initializers/paper_trail_scrapbook.rb
+```ruby
+ PaperTrailScrapbook.config.whodunnit_class = User
+
+```
+
+This gem will call `find` on that class, and translate the result to a 
+String via `to_s`, so it can be a simple Rails model, or a custom Ruby class that has `find` class method and 
+expects the `whodunnit` value. For example
+
+```ruby
+class WhoDidIt
+  def self.find(email)
+    Person.find_by(email: email)
+  end
+end
+
+
+PaperTrailScrapbook.config.whodunnit_class = WhoDidIt
+
+```
+
+### Life Story
+```ruby
+widget = Widget.find 42
+
+text = PaperTrailScrapbook::LifeStory.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 
+#   • built: true
+#   • created_by: Rob Owens[1742]
+#   • provider: RedCharge[3113]
+#   • cost: 29612.0
+#   • discounted_price: 29612.0 
+```
+
+## Problems
+
+Please use GitHub's [issue tracker](http://github.com/tjchambers/paper_trail_scrapbook/issues).
+
+## Contributors
+
+Created by Tim Chambers in 2017.
+
+https://github.com/tjchambers/paper_trail_scrapbook/graphs/contributors
+
+Acknowledgement and kudos to Andy Stewart, Ben Atkins, Jared Beck, and all the other contributors to the PaperTrail gem. 
+Without them this would not be possible.
+
+
+## Intellectual Property
+
+Copyright (c) 2017 Tim Chambers (tim@possibilogy.com).
+Released under the MIT licence.
+
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Set a relevant database.yml for testing'
+task :prepare do
+  ENV['DB'] ||= 'sqlite'
+  FileUtils.cp(
+    "spec/dummy_app/config/database.#{ENV['DB']}.yml",
+    'spec/dummy_app/config/database.yml'
+  )
+end
+
+require 'rspec/core/rake_task'
+desc 'Run tests on PaperTrailScrapbook with RSpec'
+task(:spec).clear
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false # hide list of specs bit.ly/1nVq3Jn
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+desc 'Default: run all available test suites'
+task default: %i[rubocop prepare spec]

data/circle.yml

@@ -0,0 +1,10 @@
+---
+machine:
+  ruby:
+    version: '2.2.7'
+dependencies:
+  pre:
+    - gem install bundler
+test:
+  override:
+    - bundle exec rake spec

data/lib/paper_trail_scrapbook/changes.rb

@@ -0,0 +1,89 @@
+module PaperTrailScrapbook
+  class Changes
+    include Concord.new(:version)
+
+    def initialize(*)
+      super
+
+      build_associations
+    end
+
+    BULLET = ' •'.freeze
+
+    def change_log
+      changes.map { |k, v| digest(k, v) }.compact.join("\n").gsub('_id:', ':')
+    end
+
+    private
+
+    def digest(k, v)
+      old, new = v
+      return if old.nil? && (new.nil? || new.eql?(''))
+
+      "#{BULLET} #{k}: " + if creating?
+                             find_value(k, new).to_s
+                           elsif old.nil?
+                             "#{find_value(k, new)} added"
+                           elsif new.nil?
+                             "#{find_value(k, old)} was *removed*"
+                           else
+                             "#{find_value(k, old)} -> #{find_value(k, new)}"
+                           end
+    end
+
+    def creating?
+      version.event.eql?('create')
+    end
+
+    def find_value(key, value)
+      return value.to_s unless assoc.key?(key)
+
+      return '*empty*' unless value
+
+      begin
+        assoc[key].find(value).to_s + "[#{value}]"
+      rescue
+        "*not found*[#{value}]"
+      end
+    end
+
+    def assoc_klass(name, options = {})
+      direct_class = options[:class_name]
+      return direct_class if direct_class && !direct_class.is_a?(String)
+
+      Object.const_get((direct_class || name.to_s).classify)
+    rescue
+      Object.const_set(name.to_s.classify, Class.new)
+    end
+
+    def klass
+      assoc_klass(version.item_type)
+    end
+
+    def build_associations
+      @assoc ||=
+        Hash[
+          klass
+        .reflect_on_all_associations
+        .select { |a| a.macro.equal?(:belongs_to) }
+        .map { |x| [x.foreign_key.to_s, assoc_klass(x.name, x.options)] }
+        ]
+    end
+
+    def object_changes
+      version.object_changes
+    end
+
+    def changes
+      @chs ||= if object_changes
+                 YAML
+                   .load(object_changes)
+                   .except('updated_at', 'created_at ', 'id')
+               else
+                 {}
+               end
+    end
+
+    attr_reader :assoc, :chs
+  end
+end

data/lib/paper_trail_scrapbook/chapter.rb

@@ -0,0 +1,49 @@
+module PaperTrailScrapbook
+  class Chapter
+    include Concord.new(:version)
+
+    UNKNOWN = '*the app*'.freeze
+
+    def story
+      "On #{whenn}, #{who} #{kind} the following #{model} information:".split.join(' ') + "\n#{changes}"
+    end
+
+    private
+
+    def model
+      version.item_type
+    end
+
+    def changes
+      PaperTrailScrapbook::Changes.new(version).change_log
+    end
+
+    def who
+      author = version.version_author
+      if author
+        if PaperTrailScrapbook.whodunnit_class
+          PaperTrailScrapbook.whodunnit_class.find(author.to_i).to_s
+        else
+          author
+        end
+      else
+        UNKNOWN
+      end
+    end
+
+    def whenn
+      version.created_at.strftime('%A, %d %b %Y at %l:%M %p')
+    end
+
+    def kind
+      case version.event
+      when 'create'
+        'created'
+      when 'update'
+        'updated'
+      when 'destroy'
+        'destroyed'
+      end
+    end
+  end
+end

data/lib/paper_trail_scrapbook/config.rb

@@ -0,0 +1,13 @@
+require 'singleton'
+
+module PaperTrailScrapbook
+  # Global configuration affecting all threads.
+  class Config
+    include Singleton
+
+    def initialize
+      # Variables which affect all threads, whose access is synchronized.
+      @mutex = Mutex.new
+    end
+  end
+end

data/lib/paper_trail_scrapbook/life_history.rb

@@ -0,0 +1,17 @@
+module PaperTrailScrapbook
+  class LifeHistory
+    def initialize(object)
+      @versions = object.versions
+    end
+
+    def story
+      versions.map do |v|
+        Chapter.new(v).story
+      end.join("\n\n")
+    end
+
+    private
+
+    attr_reader :versions
+  end
+end

data/lib/paper_trail_scrapbook/version.rb

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

data/lib/paper_trail_scrapbook.rb

@@ -0,0 +1,51 @@
+require 'adamantium'
+require 'concord'
+require 'digest/sha1'
+require 'equalizer'
+require 'ice_nine'
+require 'pathname'
+require 'paper_trail_scrapbook/config'
+require 'paper_trail_scrapbook/chapter'
+require 'paper_trail_scrapbook/changes'
+require 'paper_trail_scrapbook/life_history'
+require 'paper_trail_scrapbook/version'
+
+# Library namespace
+#
+# @api private
+module PaperTrailScrapbook
+  class << self
+    # Sets class associated with PaperTrail.whodunnit
+    # @api public
+    def whodunnit_class=(value)
+      paper_trail_scrapbook_store[:whodunnit_class] = value
+    end
+
+    # class responsible for any changes that occur.
+    #
+    # @api public
+    def whodunnit_class
+      paper_trail_scrapbook_store[:whodunnit_class]
+    end
+
+    # Thread-safe hash to hold PaperTrailScrapbook's data. Initializing with needed
+    # default values.
+    # @api private
+    def paper_trail_scrapbook_store
+      RequestStore.store[:paper_trail_scrapbook] ||= {}
+    end
+
+    # Returns PaperTrailScrapbook's configuration object.
+    # @api private
+    def config
+      @config ||= PaperTrailScrapbook::Config.instance
+      yield @config if block_given?
+      @config
+    end
+    alias configure config
+
+    def version
+      VERSION::STRING
+    end
+  end
+end

data/paper_trail_scrapbook.gemspec

@@ -0,0 +1,38 @@
+require File.expand_path('../lib/paper_trail_scrapbook/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'paper_trail_scrapbook'
+  gem.version     = PaperTrailScrapbook::VERSION.dup
+  gem.date        = Time.now.utc.strftime('%Y-%m-%d')
+  gem.summary     = 'Paper Trail Scrapbook'
+  gem.description = "Human Readable Change Log for Paper Trail'd data"
+  gem.authors     = ['Timothy Chambers']
+  gem.email       = 'tim@possibilogy.com'
+  gem.files       = `git ls-files`.split("\n")
+  gem.homepage    = 'https://github.com/tjchambers/paper_trail_scrapbook'
+  gem.license     = 'MIT'
+
+  gem.required_rubygems_version = '>= 1.3.6'
+  gem.required_ruby_version = '>= 2.2.0'
+
+  # Rails does not follow semver, makes breaking changes in minor versions.
+  gem.add_dependency 'activerecord', ['>= 4.0', '< 5.2']
+  gem.add_dependency 'request_store', '~> 1.1'
+  gem.add_dependency 'adamantium'
+  gem.add_dependency 'concord'
+  gem.add_dependency 'paper_trail'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'ffaker', '~> 2.5'
+
+  # 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 'rspec-core', '~> 3.6'
+  gem.add_development_dependency 'database_cleaner', '~> 1.2'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-rspec'
+  gem.add_development_dependency 'timecop', '~> 0.8.0'
+  gem.add_development_dependency 'sqlite3'
+end

data/spec/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,4 @@
+class Animal < ActiveRecord::Base
+  has_paper_trail
+  self.inheritance_column = 'species'
+end

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

@@ -0,0 +1,24 @@
+class Article < ActiveRecord::Base
+  has_paper_trail(
+    ignore: [
+      :title, {
+        abstract: proc { |obj|
+          ['ignore abstract', 'Other abstract'].include? obj.abstract
+        }
+      }
+    ],
+    only: [:content, { abstract: proc { |obj| obj.abstract.present? } }],
+    skip: [:file_upload],
+    meta: {
+      answer: 42,
+      action: :action_data_provider_method,
+      question: proc { "31 + 11 = #{31 + 11}" },
+      article_id: proc { |article| article.id },
+      title: :title
+    }
+  )
+
+  def action_data_provider_method
+    object_id.to_s
+  end
+end

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

@@ -0,0 +1,5 @@
+class Authorship < ActiveRecord::Base
+  belongs_to :book
+  belongs_to :author, class_name: 'Person'
+  has_paper_trail
+end

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

@@ -0,0 +1,4 @@
+class BarHabtm < ActiveRecord::Base
+  has_and_belongs_to_many :foo_habtms
+  has_paper_trail
+end

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

@@ -0,0 +1,9 @@
+class Book < ActiveRecord::Base
+  has_many :authorships, dependent: :destroy
+  has_many :authors, through: :authorships
+
+  has_many :editorships, dependent: :destroy
+  has_many :editors, through: :editorships
+
+  has_paper_trail
+end

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

@@ -0,0 +1,4 @@
+class Boolit < ActiveRecord::Base
+  default_scope { where(scoped: true) }
+  has_paper_trail
+end