paper_trail-rails 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c131d41ac82f9058ed9bfbf6bbb0ec4c41d81bb0831213354a8a489d13ab02fa
-  data.tar.gz: ad5bc11f3012ff9155c6891a4cdd5b55a424c505aaa6872f38a4a9bae2a0e776
+  metadata.gz: df6b12e02d1b44eabbb7c41961258e502db07a2b7f1078d48f72b56def92f948
+  data.tar.gz: d5eba93e47293263d99c743e280ca385d2773c5752eaff08090f5fbe0d023466
 SHA512:
-  metadata.gz: ecf6879903c63aeca60556f75877f4bf709022a7953975610c732bb13819e4f0939e19f3c220b8aad562c1d6516c900b90b12b71666a4284d7b4dfc32c9c5309
-  data.tar.gz: d8956bd5abfe35a712cfec8f24df52319e1d3cbbb9a06162eab2582c4dcba0f05f2f422a9d7b7d4c8ddf62e09103c08111a046ff83f11f0ddf3a249ef0ab7336
+  metadata.gz: 33952094c64fd705018a4b33108c7e398ab5dc624449402e1a95cd4dc70a65544372e41906cb697b326b66fb7dc688c6ca2bfe35d82aecb7d8197a585358b064
+  data.tar.gz: b26c1c50f90b35dddf67291024beeacab8b4d37578f7450cb169f9c83d4794c455d66fadf6dd8d75ed9f9ad51dce589cb29b969818eaf5d6a5a1e71f410d8a97

data/Changelog.md

@@ -1,3 +1,10 @@
+## 0.4.0 (2020-04-23)
+- Allow user to be selected by index in addition to id
+- Add config.select_user_inspect
+- Fix: Remove .default_order which may not be defined. Included as config example instead.
+- Fix: Replace respond.id with respond_to?(:id)
+- Fix: Should use require_user rather than require_reason
+
 ## 0.3.0 (2019-09-16)
 - Fix: When running db:migrate:redo, command got recorded as "rails db:migrate:redo VERSION=2019…"
   instead of as "rails db:migrate: MigrationName (up)" as intended.

data/Readme.md

@@ -1,6 +1,7 @@
 # PaperTrail::Rails
 
 [![Gem Version][1]][2]
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rdoc.info/github/TylerRick/paper_trail-rails/master)
 
 An extension to [PaperTrail](https://github.com/paper-trail-gem/paper_trail)
 that adds some useful automatic integrations with Rails:

data/lib/paper_trail/rails/configuration.rb

@@ -4,18 +4,22 @@ module PaperTrail
       def initialize
         config = self
 
+        #config.user_model = User
         config.select_user_filter = :itself
+        config.select_user_inspect = :inspect
         config.select_user_other_allowed_values = ['system', 'admin']
         config.source_location_filter = ->(line) { !line.match /paper_trail/ }
       end
 
       # Filter proc to use to show a list of users in select_user helper. For example:
-      #   ->(users) { users.admins) }
+      #   ->(users) { users.admins.default_order }
       # or
-      #   ->(users) { users.none) }
+      #   ->(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_inspect
+
       attr_accessor :select_user_other_allowed_values
 
       attr_accessor :source_location_filter

data/lib/paper_trail/rails/console.rb

@@ -50,7 +50,7 @@ module PaperTrail
       end
     end
 
-    class Engine
+    class Railtie
       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
@@ -73,14 +73,14 @@ module PaperTrail
                 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)
+                user = PaperTrail::Rails.select_user(required: config.console.require_user)
                 puts "Thank you, #{user}! Have a wonderful time!" if user
               end
-              user.respond.id
+              user.respond_to?(:id) ? user.id : user
             end
           )
 
-          if config.console.ask_for_reason
+          if config.console.ask_for_reason && PaperTrail.request.controller_info[:reason].nil?
             @paper_trail_reason ||= PaperTrail::Rails.get_reason(required: config.console.require_reason)
           end
           PaperTrail.update_metadata reason: @paper_trail_reason

data/lib/paper_trail/rails/general.rb

@@ -4,11 +4,15 @@ module PaperTrail
   module Rails
     module General
       class << self
-        def select_user(filter: :itself, other_allowed_values: [], prompt: 'Please enter a User id', required: true)
+        def select_user(filter: :itself, other_allowed_values: [], prompt: '"Please enter the index of one of the users above, or a valid User id', required: true)
+          config = PaperTrail::Rails.config
+
+          user_options = nil
           User.logger.silence do
-            puts 'id. user'
-            filter.to_proc.(User.all).default_order.each do |user|
-              puts "%4s. %s" % [user.id, user.inspect]
+            puts 'index. user'
+            user_options = filter.to_proc.(User.all)
+            user_options.each.with_index do |user, i|
+              puts "%2s. %s" % [i + 1, user.inspect]
             end
           end
 
@@ -20,7 +24,11 @@ module PaperTrail
             when *other_allowed_values
               user = input
             else
-              user = User.find(input) rescue nil
+              if (i = Integer(input) rescue nil)
+                user = user_options[i - 1] || (User.find(input) rescue nil)
+              else  # allow for non-numeric ids like uuids
+                user =                         User.find(input) rescue nil
+              end
             end
             break unless required
           end

data/lib/paper_trail/rails/railtie.rb

@@ -1,12 +1,14 @@
-# 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'
+require 'paper_trail/frameworks/rails'
 
 module PaperTrail
   module Rails
-    class Engine
+    # lib/paper_trail/rails/console.rb adds an initializer to this Railtie.
+    #
+    # paper_trail gem also provides a Railtie, PaperTrail::Railtie
+    # (paper_trail/frameworks/rails/railtie.rb), but that is different from this one.
+    #
+    class Railtie < ::Rails::Railtie
     end
   end
 end

data/lib/paper_trail/rails/version.rb

@@ -1,7 +1,7 @@
 module PaperTrail
   module Rails
     def self.version
-      "0.3.0"
+      "0.5.1"
     end
   end
 end

data/paper_trail-rails.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paper_trail
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Integrate with rails console and migrations. In rails console, ask who is