paper_trail-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c2a7d0c232080ed191377bd3b70aebdbbf5df8561d29846b79c6bfaf245c840
+  data.tar.gz: d85a090ed4de3c94eef116bfe09a9b8a6ef33a61bcf02b0c13e8f9811e66a6c3
+SHA512:
+  metadata.gz: ea9485746cd967d7e878bb81891a848148c943dd0ec45eb1a1e975fa42e8de149661bc5b33a44b001d3d2014a224ff98e95b32c408c2165e92864860b5443fb8
+  data.tar.gz: ae08cbb579ad278720936d0e9b4057a4c63c9271dc311f17d85777ce544751a4955cf7c563c90eefb2899caf60c6913ee81be1dc339b332c6546e818583359e2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in paper_trail-rails.gemspec
+gemspec

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2018 Tyler Rick
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,35 @@
+# PaperTrail::Rails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paper_trail/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paper_trail-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paper_trail-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/paper_trail-rails.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paper_trail/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/paper_trail/rails/configuration.rb

@@ -0,0 +1,32 @@
+module PaperTrail
+  module Rails
+    class Configuration
+      def initialize
+        self.user_filter_for_console = :itself
+        self.paper_trail_user_for_test_console = ->(users) {
+          users.admins.last
+        }
+
+        self.ask_reason = true
+        self.require_reason = false
+      end
+
+      # Filter users with this proc. For example:
+      #   ->(users) { users.admins) }
+      attr_accessor :user_filter_for_console
+
+      # A proc that returns a user if you ever run `rails console` in test
+      # environment (where you probably won't have any real data)
+      attr_accessor :paper_trail_user_for_test_console
+
+      attr_accessor :ask_reason
+      attr_accessor :require_reason
+
+      class << self
+        def configure
+          yield self
+        end
+      end
+    end
+  end
+end

data/lib/paper_trail/rails/general.rb

@@ -0,0 +1,30 @@
+# General helpers that aren't really specific to this project
+
+module PaperTrail
+  module Rails
+    class << self
+      def select_user(filter: :itself, other_allowed_values: [], other_values_prompt: '')
+        User.logger.silence do
+          puts 'id. user'
+          filter.to_proc.(User.all).default_order.each do |user|
+            puts "%4s. %s" % [user.id, user.inspect]
+          end
+        end
+        other_values_prompt = " (#{other_values_prompt})" if other_values_prompt.present?
+
+        user = nil
+        until user.present? do
+          print "Please enter the id of one of the users above (or any valid User id)#{other_values_prompt}: "
+          input = gets.chomp
+          case input
+          when *other_allowed_values
+            user = input
+          else
+            user = User.find(input) rescue nil
+          end
+        end
+        user
+      end
+    end
+  end
+end

data/lib/paper_trail/rails/migration_extensions.rb

@@ -0,0 +1,16 @@
+module PaperTrail
+  module Rails
+    module RecordMigrationNameInVersion
+      def exec_migration(conn, direction)
+        PaperTrail.update_metadata(
+          command: "rails db:migrate: #{self.name} (#{direction})"
+        )
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::Migration.class_eval do
+  prepend PaperTrail::Rails::RecordMigrationNameInVersion
+end

data/lib/paper_trail/rails/paper_trail_extensions.rb

@@ -0,0 +1,24 @@
+PaperTrail.class_eval do
+
+  unless methods.include?(:with_metadata)
+    # Adds additional metadata to versions created within the given block.  This will be merged with
+    # (and may override) any metadata already set by your controller's info_for_paper_trail.
+    #
+    # Example:
+    #   PaperTrail.with_metadata(reason: 'Update for ...')
+    #
+    def self.with_metadata(metadata)
+      merged_metadata = (::PaperTrail.request.controller_info || {}).merge(metadata)
+      PaperTrail.request(controller_info: merged_metadata) do
+        yield
+      end
+    end
+  end
+
+  unless methods.include?(:update_metadata)
+    def self.update_metadata(metadata)
+      merged_metadata = (::PaperTrail.request.controller_info || {}).merge(metadata)
+      PaperTrail.request.controller_info = merged_metadata
+    end
+  end
+end

data/lib/paper_trail/rails/railtie.rb

@@ -0,0 +1,45 @@
+# paper_trail gem also provides a Railtie (Engine) in this require. It seems to
+# work to just add initializers to that existing Railtie. If needed, though, we
+# could define a different one, like "Railtie".
+require 'rails'
+require 'paper_trail/frameworks/rails/engine'
+
+module PaperTrail
+  module Rails
+    class Engine
+      initializer "paper_trail-rails.set_default_paper_trail_metadata" do |app|
+        # There's no way to set up deferred evaluation of PaperTrail.request.controller_info from
+        # here like we can with whodunnit, so abuse that property of PaperTrail.request.whodunnit to
+        # set other metadata. Reserve the whodunnit field for storing the actual name or id of the
+        # human who made the change.
+        PaperTrail.request.whodunnit = ->() {
+          PaperTrail::Rails.set_default_paper_trail_metadata
+          nil
+        }
+      end
+
+      console do
+        config = PaperTrail::Rails.config
+        PaperTrail.update_metadata command: "rails console"
+        PaperTrail.request.whodunnit = ->() {
+          PaperTrail::Rails.set_default_paper_trail_metadata
+          @paper_trail_whodunnit ||= (
+            if ::Rails.env.test?
+              user = config.paper_trail_user_for_test_console.(User.all)
+            else
+              puts "Before you make any changes... We need to know who is making the changes, to store in the PaperTrail version history."
+              user = PaperTrail::Rails.select_paper_trail_user_or_system
+              puts "Thank you, #{user}! Have a wonderful time!"
+            end
+            user.respond.id
+          )
+          if config.ask_reason
+            @paper_trail_reason ||= PaperTrail::Rails.get_paper_trail_reason(required: config.require_reason)
+          end
+          PaperTrail.update_metadata reason: @paper_trail_reason
+          @paper_trail_whodunnit
+        }
+      end
+    end
+  end
+end

data/lib/paper_trail/rails/version.rb

@@ -0,0 +1,7 @@
+module PaperTrail
+  module Rails
+    def self.version
+      "0.1.0"
+    end
+  end
+end

data/lib/paper_trail/rails.rb

@@ -0,0 +1,53 @@
+require 'paper_trail'
+
+require_relative 'rails/version'
+require_relative 'rails/general'
+require_relative 'rails/paper_trail_extensions'
+require_relative 'rails/configuration'
+require_relative 'rails/migration_extensions'
+
+module PaperTrail
+  module Rails
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+      alias_method :config, :configuration
+
+      def configure
+        yield config
+      end
+
+      # Store some metadata about where the change came from, even for rake tasks, etc.
+      def set_default_paper_trail_metadata
+        PaperTrail.update_metadata(
+          command: "#{File.basename($PROGRAM_NAME)} #{ARGV.join ' '}",
+          source_location: caller.find { |line|
+            line.starts_with? ::Rails.root.to_s and
+           !line.starts_with? __FILE__
+          }
+        )
+      end
+
+      def select_paper_trail_user_or_system
+        select_user(
+          filter: config.user_filter_for_console,
+          other_allowed_values: ['system'],
+          other_values_prompt: "or 'system'"
+        )
+      end
+
+      def get_paper_trail_reason(required: false)
+        reason = nil
+        until reason.present? do
+          print "What is the reason for this change? "
+          reason = gets.chomp
+          break unless required
+        end
+        reason
+      end
+    end
+  end
+end
+
+require_relative 'rails/railtie'

data/paper_trail-rails.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "paper_trail/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "paper_trail-rails"
+  spec.version       = PaperTrail::Rails.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+
+  spec.summary       = %q{Integrate with rails console and migrations. In rails console, ask who is making change and why. Records the command.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/TylerRick/paper_trail-rails"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "paper_trail"
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Integrate with rails console and migrations. In rails console, ask who
+  is making change and why. Records the command.
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- lib/paper_trail/rails.rb
+- lib/paper_trail/rails/configuration.rb
+- lib/paper_trail/rails/general.rb
+- lib/paper_trail/rails/migration_extensions.rb
+- lib/paper_trail/rails/paper_trail_extensions.rb
+- lib/paper_trail/rails/railtie.rb
+- lib/paper_trail/rails/version.rb
+- paper_trail-rails.gemspec
+homepage: https://github.com/TylerRick/paper_trail-rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/TylerRick/paper_trail-rails
+  source_code_uri: https://github.com/TylerRick/paper_trail-rails
+  changelog_uri: https://github.com/TylerRick/paper_trail-rails/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Integrate with rails console and migrations. In rails console, ask who is
+  making change and why. Records the command.
+test_files: []