paper_trail-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2a7d0c232080ed191377bd3b70aebdbbf5df8561d29846b79c6bfaf245c840
-  data.tar.gz: d85a090ed4de3c94eef116bfe09a9b8a6ef33a61bcf02b0c13e8f9811e66a6c3
+  metadata.gz: 70c683fd54f3d91ce5136dc79ccf3cae67564beebaed69d6fc94590588b2f9b2
+  data.tar.gz: 6b75131fbe1e81b1cb40943ec9148a52357310ed7e6d505b0bde16f2bb126d14
 SHA512:
-  metadata.gz: ea9485746cd967d7e878bb81891a848148c943dd0ec45eb1a1e975fa42e8de149661bc5b33a44b001d3d2014a224ff98e95b32c408c2165e92864860b5443fb8
-  data.tar.gz: ae08cbb579ad278720936d0e9b4057a4c63c9271dc311f17d85777ce544751a4955cf7c563c90eefb2899caf60c6913ee81be1dc339b332c6546e818583359e2
+  metadata.gz: ffa6a5dbfa8c843e651a27394f51d7515498a0c486dc890e136f2c57cfcb832f932d931bdbe260efb4b758d02cf1d812ea8e3de7298443aaee69872fa55f3fbf
+  data.tar.gz: faeb455308c26c59e0de58849563ac8fafe70b22b57f49fc7f2f844c9d32312646ca6d6f7ac1acb59e3552af4465dbadbe889c55db02c7a750134c7c1f7a33d1

data/Changelog.md

@@ -0,0 +1,15 @@
+## 0.2.0 (2019-05-23)
+
+### Breaking changes
+- Moved config specific to rails console under `config.console`
+- Rename `PaperTrail::Rails.set_default_paper_trail_metadata` to `PaperTrail::Rails.set_default_metadata`
+- Rename `PaperTrail::Rails.select_paper_trail_user_or_system` to `PaperTrail::Rails.select_user`
+- and others
+
+### Added
+- Automatically reset reason so it doesn't keep assuming and using the same reason for all changes you make in this console session.(Can be disabled with `config.console.auto_reset_reason = false`)
+- Add `config.console.ask_for_user`, `config.console.require_user`, and `config.console.auto_reset_user`
+
+## 0.1.0 (2019-05-22)
+
+Initial release

data/Readme.md

@@ -1,8 +1,22 @@
 # 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
+[![Gem Version][1]][2]
+
+An extension to [PaperTrail](https://github.com/paper-trail-gem/paper_trail)
+that adds some useful automatic integrations with Rails:
+
+- Automatically record which migration made the change in the version record (in
+  the `command` attribute) when migrations make changes to data.
+- Automatically record `rails console` as the command in the version record (in
+  the `command` attribute).
+- Automatically record the source location that initiated the change so you can
+  figure out what caused caused the change later when inspecting a version
+  record
+- (Optional) Never forget to set the actor (whodunnit) when making changes in the `rails
+  console`. It will prompt you to choose an actor user as soon as you try to
+  make a change that would record a PaperTrail Version. (Enter `system` if you
+  don't want any particular user recorded as the actor.)
+- (Optional) Automatically ask for a reason whenever you make a change
 
 ## Installation
 
@@ -16,13 +30,40 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Add and run this migration:
+```
+class VersionsAddSourceLocationCommandReason < ActiveRecord::Migration[5.2]
+  def change
+    change_table :versions do |t|
+      t.text    :source_location
+      t.text    :command
+      t.text    :reason
+    end
+    change_table :versions do |t|
+      t.index   :command
+      t.index   :reason
+    end
+  end
+end
+```
+
+## Configuration
 
-    $ gem install paper_trail-rails
+Add to `config/initializers/paper_trail.rb` and change as needed:
 
-## Usage
+```ruby
+PaperTrail::Rails.configure do |config|
+  config.console.ask_for_user      = true
+  config.console.require_user      = false
+  config.console.auto_reset_user   = false
+
+  config.console.ask_for_reason    = true
+  config.console.require_reason    = false
+  config.console.auto_reset_reason = true
 
-TODO: Write usage instructions here
+  config.user_filter = ->(users) { users.admins }
+end
+```
 
 ## Development
 
@@ -33,3 +74,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/paper_trail-rails.
+
+[1]: https://badge.fury.io/rb/paper_trail-rails.svg
+[2]: https://rubygems.org/gems/paper_trail-rails

data/lib/paper_trail/rails/configuration.rb

@@ -2,31 +2,27 @@ module PaperTrail
   module Rails
     class Configuration
       def initialize
-        self.user_filter_for_console = :itself
-        self.paper_trail_user_for_test_console = ->(users) {
+        config = self
+
+        config.select_user_filter = :itself
+        config.select_user_other_allowed_values = ['system', 'admin']
+        config.user_for_test = ->(users) {
           users.admins.last
         }
-
-        self.ask_reason = true
-        self.require_reason = false
       end
 
-      # Filter users with this proc. For example:
+      # Filter proc to use to show a list of users in select_user helper. For example:
       #   ->(users) { users.admins) }
-      attr_accessor :user_filter_for_console
+      # or
+      #   ->(users) { users.none) }
+      # Can be also be a symbol or anything that responds to to_proc.
+      attr_accessor :select_user_filter
+
+      attr_accessor :select_user_other_allowed_values
 
       # 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
+      attr_accessor :user_for_test
     end
   end
 end

data/lib/paper_trail/rails/console.rb

@@ -0,0 +1,102 @@
+require_relative 'configuration'
+require_relative 'railtie'
+
+module PaperTrail
+  module Rails
+    module Console
+      class << self
+      end
+
+      class Configuration
+        def initialize
+          config = self
+
+          config.ask_for_user      = true
+          config.require_user      = false
+          config.auto_reset_user   = false
+
+          config.ask_for_reason    = true
+          config.require_reason    = false
+          config.auto_reset_reason = true
+        end
+
+        attr_accessor :ask_for_user
+        attr_accessor :require_user
+        attr_accessor :auto_reset_user
+
+        attr_accessor :ask_for_reason
+        attr_accessor :require_reason
+        attr_accessor :auto_reset_reason
+
+        class << self
+          def configure
+            yield self
+          end
+        end
+      end
+    end
+
+    class Configuration
+      def console
+        @console ||= Console::Configuration.new
+      end
+    end
+
+    class Engine
+      initializer "paper_trail-rails.set_default_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_metadata
+          nil
+        }
+      end
+
+      console do
+        config = PaperTrail::Rails.config
+        PaperTrail.update_metadata command: "rails console"
+        PaperTrail.request.whodunnit = ->() {
+          PaperTrail::Rails.set_default_metadata
+          @paper_trail_whodunnit ||= (
+            if config.console.ask_for_user
+              if ::Rails.env.test?
+                user = config.console.user_for_test.(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_user(required: config.console.require_reason)
+                puts "Thank you, #{user}! Have a wonderful time!" if user
+              end
+              user.respond.id
+            end
+          )
+
+          if config.console.ask_for_reason
+            @paper_trail_reason ||= PaperTrail::Rails.get_reason(required: config.console.require_reason)
+          end
+          PaperTrail.update_metadata reason: @paper_trail_reason
+
+          @paper_trail_whodunnit
+        }
+
+
+        if config.console.auto_reset_user || config.console.auto_reset_reason
+          if defined?(Pry)
+            Pry.hooks.add_hook(:after_eval, "paper_trail-rails-auto_reset") do |output, binding, pry|
+              if config.console.auto_reset_user
+                @paper_trail_whodunnit = nil
+              end
+              if config.console.auto_reset_reason
+                @paper_trail_reason = nil
+                PaperTrail.update_metadata reason: @paper_trail_reason
+              end
+            end
+          else
+            raise "Pry is required in order to use `auto_reset`. Please add pry-rails to your Gemfile or disable this in the config."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paper_trail/rails/general.rb

@@ -2,28 +2,30 @@
 
 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]
+    module General
+      class << self
+        def select_user(filter: :itself, other_allowed_values: [], prompt: 'Please enter a User id', required: true)
+          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
-        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
+          user = nil
+          until user.present? do
+            print "#{prompt}: "
+            input = gets.chomp
+            case input
+            when *other_allowed_values
+              user = input
+            else
+              user = User.find(input) rescue nil
+            end
+            break unless required
           end
+          user
         end
-        user
       end
     end
   end

data/lib/paper_trail/rails/paper_trail_extensions.rb

@@ -15,6 +15,12 @@ PaperTrail.class_eval do
     end
   end
 
+  unless methods.include?(:reset_metadata)
+    def self.reset_metadata
+      PaperTrail.request.controller_info = nil
+    end
+  end
+
   unless methods.include?(:update_metadata)
     def self.update_metadata(metadata)
       merged_metadata = (::PaperTrail.request.controller_info || {}).merge(metadata)

data/lib/paper_trail/rails/railtie.rb

@@ -7,39 +7,6 @@ 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

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

data/lib/paper_trail/rails.rb

@@ -1,12 +1,18 @@
 require 'paper_trail'
 
 require_relative 'rails/version'
-require_relative 'rails/general'
-require_relative 'rails/paper_trail_extensions'
+
+# (In alphabetical order)
 require_relative 'rails/configuration'
+require_relative 'rails/console'
+require_relative 'rails/general'
 require_relative 'rails/migration_extensions'
+require_relative 'rails/paper_trail_extensions'
 
 module PaperTrail
+  # This is the main module for this gem. Can't make it a class because
+  # paper_trail gem already defines this module; otherwise I would have made
+  # this a class.
   module Rails
     class << self
       def configuration
@@ -18,8 +24,8 @@ module PaperTrail
         yield config
       end
 
-      # Store some metadata about where the change came from, even for rake tasks, etc.
-      def set_default_paper_trail_metadata
+      # Store some metadata about where the change came from
+      def set_default_metadata
         PaperTrail.update_metadata(
           command: "#{File.basename($PROGRAM_NAME)} #{ARGV.join ' '}",
           source_location: caller.find { |line|
@@ -29,15 +35,18 @@ module PaperTrail
         )
       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'"
+      def select_user(required: false)
+        other_allowed_values = config.select_user_other_allowed_values
+        other_values_prompt = " (or #{other_allowed_values.join(' or ')})" if other_allowed_values.present?
+        General.select_user(
+          filter:               config.select_user_filter,
+          other_allowed_values: other_allowed_values,
+          prompt: "Please enter a User id#{other_values_prompt}",
+          required: required
         )
       end
 
-      def get_paper_trail_reason(required: false)
+      def get_reason(required: false)
         reason = nil
         until reason.present? do
           print "What is the reason for this change? "
@@ -49,5 +58,3 @@ module PaperTrail
     end
   end
 end
-
-require_relative 'rails/railtie'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paper_trail
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - lib/paper_trail/rails.rb
 - lib/paper_trail/rails/configuration.rb
+- lib/paper_trail/rails/console.rb
 - lib/paper_trail/rails/general.rb
 - lib/paper_trail/rails/migration_extensions.rb
 - lib/paper_trail/rails/paper_trail_extensions.rb