paper_trail_manager 0.6.0 → 0.8.0

data/app/controllers/paper_trail_manager/changes_controller.rb

@@ -1,128 +1,146 @@
+# frozen_string_literal: true
+
 # Allow the parent class of ChangesController to be configured in the host app
 PaperTrailManager::ChangesController = Class.new(PaperTrailManager.base_controller.constantize)
 
-class PaperTrailManager::ChangesController
-  # Default number of changes to list on a pagenated index page.
-  PER_PAGE = 50
+class PaperTrailManager
+  class ChangesController
+    # Default number of changes to list on a pagenated index page.
+    PER_PAGE = 50
 
-  helper PaperTrailManager.route_helpers if PaperTrailManager.route_helpers
-  helper PaperTrailManager::ChangesHelper
-  layout PaperTrailManager.layout if PaperTrailManager.layout
+    helper PaperTrailManager.route_helpers if PaperTrailManager.route_helpers
+    helper PaperTrailManager::ChangesHelper
+    layout PaperTrailManager.layout if PaperTrailManager.layout
 
-  # List changes
-  def index
-    unless change_index_allowed?
-      flash[:error] = "You do not have permission to list changes."
-      return(redirect_to root_url)
-    end
+    # List changes
+    def index
+      unless change_index_allowed?
+        flash[:error] = 'You do not have permission to list changes.'
+        return(redirect_to root_url)
+      end
 
-    @versions = PaperTrail::Version.order('created_at DESC, id DESC')
-    if params[:type]
-      @versions = @versions.where(:item_type => params[:type])
-    end
-    if params[:id]
-      @versions = @versions.where(:item_id => params[:id])
+      @versions = PaperTrail::Version.order('created_at DESC, id DESC')
+      @versions = @versions.where(item_type: params[:type]) if params[:type]
+      @versions = @versions.where(item_id: params[:id]) if params[:id]
+
+      # Date range filtering
+      @from = parse_date(params[:from])
+      @to = parse_date(params[:to])
+      @versions = @versions.where('created_at >= ?', @from.beginning_of_day) if @from
+      @versions = @versions.where('created_at <= ?', @to.end_of_day) if @to
+
+      # Ensure pagination parameters have sensible values
+      @page = params[:page].to_i
+      @page = nil if @page.zero?
+
+      @per_page = params[:per_page].to_i
+      @per_page = PER_PAGE if @per_page.zero?
+
+      @versions = if defined?(WillPaginate)
+                    @versions.paginate(page: @page, per_page: @per_page)
+                  else
+                    @versions.page(@page).per(@per_page)
+                  end
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.atom # index.atom.builder
+        format.json { render json: @versions }
+      end
     end
 
-    # Ensure pagination parameters have sensible values
-    @page = (v = params[:page].to_i; v == 0 ? nil : v)
-    @per_page = (v = params[:per_page].to_i; v == 0 ? PER_PAGE : v)
+    # Show a change
+    def show
+      begin
+        @version = PaperTrail::Version.find(params[:id])
+      rescue ActiveRecord::RecordNotFound
+        flash[:error] = 'No such version.'
+        return(redirect_to action: :index)
+      end
 
-    if defined?(WillPaginate)
-      @versions = @versions.paginate(:page => @page, :per_page => @per_page)
-    else
-      @versions = @versions.page(@page).per(@per_page)
-    end
+      unless change_show_allowed?(@version)
+        flash[:error] = 'You do not have permission to show that change.'
+        return(redirect_to action: :index)
+      end
 
-    respond_to do |format|
-      format.html # index.html.erb
-      format.atom # index.atom.builder
-      format.json { render :json => @versions }
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @version }
+      end
     end
-  end
 
-  # Show a change
-  def show
-    begin
-      @version = PaperTrail::Version.find(params[:id])
-    rescue ActiveRecord::RecordNotFound
-      flash[:error] = "No such version."
-      return(redirect_to :action => :index)
-    end
+    # Rollback a change
+    def update
+      begin
+        @version = PaperTrail::Version.find(params[:id])
+      rescue ActiveRecord::RecordNotFound
+        flash[:error] = 'No such version.'
+        return(redirect_to(changes_path))
+      end
 
-    unless change_show_allowed?(@version)
-      flash[:error] = "You do not have permission to show that change."
-      return(redirect_to :action => :index)
-    end
+      unless change_revert_allowed?(@version)
+        flash[:error] = 'You do not have permission to revert this change.'
+        return(redirect_to changes_path)
+      end
 
-    respond_to do |format|
-      format.html # show.html.erb
-      format.json { render :json => @version }
-    end
-  end
+      if @version.event == 'create'
+        @record = @version.item_type.constantize.find(@version.item_id)
+        @result = @record.destroy
+      else
+        @record = @version.reify
+        @result = @record.save
+      end
 
-  # Rollback a change
-  def update
-    begin
-      @version = PaperTrail::Version.find(params[:id])
-    rescue ActiveRecord::RecordNotFound
-      flash[:error] = "No such version."
-      return(redirect_to(changes_path))
+      if @result
+        if @version.event == 'create'
+          flash[:notice] = 'Rolled back newly-created record by destroying it.'
+          redirect_to changes_path
+        else
+          flash[:notice] = 'Rolled back changes to this record.'
+          redirect_to change_item_url(@version)
+        end
+      else
+        flash[:error] = "Couldn't rollback. Sorry."
+        redirect_to changes_path
+      end
     end
 
-    unless change_revert_allowed?(@version)
-      flash[:error] = "You do not have permission to revert this change."
-      return(redirect_to changes_path)
-    end
+    protected
 
-    if @version.event == "create"
-      @record = @version.item_type.constantize.find(@version.item_id)
-      @result = @record.destroy
-    else
-      @record = @version.reify
-      @result = @record.save
+    # Return the URL for the item represented by the +version+, e.g. a Company record instance referenced by a version.
+    def change_item_url(version)
+      version_type = version.item_type.underscore.split('/').last
+      send("#{version_type}_url", version.item_id)
+    rescue NoMethodError
+      nil
     end
+    helper_method :change_item_url
 
-    if @result
-      if @version.event == "create"
-        flash[:notice] = "Rolled back newly-created record by destroying it."
-        redirect_to changes_path
-      else
-        flash[:notice] = "Rolled back changes to this record."
-        redirect_to change_item_url(@version)
-      end
-    else
-      flash[:error] = "Couldn't rollback. Sorry."
-      redirect_to changes_path
+    # Allow index?
+    def change_index_allowed?
+      PaperTrailManager.allow_index?(self)
     end
-  end
-
-protected
+    helper_method :change_index_allowed?
 
-  # Return the URL for the item represented by the +version+, e.g. a Company record instance referenced by a version.
-  def change_item_url(version)
-    version_type = version.item_type.underscore.split('/').last
-    return send("#{version_type}_url", version.item_id)
-  rescue NoMethodError
-    return nil
-  end
-  helper_method :change_item_url
+    # Allow show?
+    def change_show_allowed?(version)
+      PaperTrailManager.allow_show?(self, version)
+    end
+    helper_method :change_show_allowed?
 
-  # Allow index?
-  def change_index_allowed?
-    return PaperTrailManager.allow_index?(self)
-  end
-  helper_method :change_index_allowed?
+    # Allow revert?
+    def change_revert_allowed?(version)
+      PaperTrailManager.allow_revert?(self, version)
+    end
+    helper_method :change_revert_allowed?
 
-  # Allow show?
-  def change_show_allowed?(version)
-    return PaperTrailManager.allow_show?(self, version)
-  end
-  helper_method :change_show_allowed?
+    # Parse a date string, returning nil for invalid/missing values
+    def parse_date(value)
+      return nil if value.blank?
 
-  # Allow revert?
-  def change_revert_allowed?(version)
-    return PaperTrailManager.allow_revert?(self, version)
+      Date.parse(value)
+    rescue Date::Error, ArgumentError
+      nil
+    end
   end
-  helper_method :change_revert_allowed?
 end

data/app/helpers/paper_trail_manager/changes_helper.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 class PaperTrailManager
   module ChangesHelper
     # Return HTML representing the +object+, which is either its text or a stylized "nil".
     def text_or_nil(object)
       if object.nil?
-        return content_tag("em", "nil")
+        content_tag('em', 'nil')
       else
-        return h(object)
+        h(object)
       end
     end
 
@@ -26,16 +28,18 @@ class PaperTrailManager
     #   }
     def changes_for(version)
       case version.event
-      when "create", "update"
+      when 'create', 'update'
         return {} unless version.changeset
+
         version.changeset.inject({}) do |changes, (attr, (prev, curr))|
-          changes.store(attr, {previous: prev, current: curr}) && changes
+          changes.store(attr, { previous: prev, current: curr }) && changes
         end
-      when "destroy"
+      when 'destroy'
         record = version_reify(version)
         return {} unless record
-        record.attributes.reject{|k,v| v.nil?}.inject({}) do |changes, (attr, value)|
-          changes.store(attr, {previous: value, current: nil}) && changes
+
+        record.attributes.reject { |_k, v| v.nil? }.inject({}) do |changes, (attr, value)|
+          changes.store(attr, { previous: value, current: nil }) && changes
         end
       else
         raise ArgumentError, "Unknown event: #{version.event}"
@@ -51,21 +55,21 @@ class PaperTrailManager
         name = "#{version.item_type} #{version.item_id}"
       end
 
-      return h(name)
+      h(name)
     end
 
     def change_item_types
-      ActiveRecord::Base.subclasses.select do |klass|
+      ActiveRecord::Base.descendants.select do |klass|
         klass.include?(PaperTrail::Model::InstanceMethods)
-      end.map(&:to_s)
+      end.map(&:to_s).sort
     end
 
     # Returns HTML link for the item stored in the version, e.g. a link to a Company record stored in the version.
     def change_item_link(version)
-      if url = change_item_url(version)
-        return link_to(change_title_for(version), url, :class => 'change_item')
+      if (url = change_item_url(version))
+        link_to(change_title_for(version), url, class: 'change_item')
       else
-        return content_tag(:span, change_title_for(version), :class => 'change_item')
+        content_tag(:span, change_title_for(version), class: 'change_item')
       end
     end
 

data/app/views/paper_trail_manager/changes/_version.html.erb

@@ -20,7 +20,7 @@
         <% end %>
       <% end %>
       <% if change_revert_allowed?(version) %>
-        <%= link_to 'Roll back', change_path(version), :method => 'put', :class => 'rollback', :data => { :confirm => 'Are you sure?' } %>
+        <%= button_to 'Roll back', change_path(version), method: :put, class: 'rollback', form: { data: { turbo_confirm: 'Are you sure?' } } %>
       <% end %>
     </p>
     <% if version.event == 'update' or version.event == 'create' %>

data/app/views/paper_trail_manager/changes/index.atom.builder

@@ -1,44 +1,48 @@
+# frozen_string_literal: true
+
 atom_feed do |feed|
-  feed.title("Changes")
-  date = @versions.first.try(:created_at) || Time.at(0)
+  feed.title('Changes')
+  date = @versions.first.try(:created_at) || Time.zone.at(0)
   feed.updated(date)
 
   @versions.each do |version|
     next unless change_show_allowed?(version)
 
-    feed.entry(version, :url => change_url(version)) do |entry|
+    feed.entry(version, url: change_url(version)) do |entry|
       changes = changes_for(version)
 
-      if PaperTrailManager.whodunnit_class && version.whodunnit
-        user = PaperTrailManager.whodunnit_class.find(version.whodunnit) rescue nil
-      else
-        user = nil
-      end
+      user = if PaperTrailManager.whodunnit_class && version.whodunnit
+               begin
+          PaperTrailManager.whodunnit_class.find(version.whodunnit)
+               rescue StandardError
+                 nil
+        end
+             end
 
-      entry.title "#{version.event.upcase} #{version.item_type} «#{change_title_for(version)}» #{user ? 'by '+user.send(PaperTrailManager.whodunnit_name_method) : ''}"
+      entry.title "#{version.event.upcase} #{version.item_type} «#{change_title_for(version)}» #{user ? 'by ' + user.send(PaperTrailManager.whodunnit_name_method) : ''}"
       entry.updated version.created_at.utc.xmlschema
 
       xm = ::Builder::XmlMarkup.new
-      xm.div {
-        xm.p {
+      xm.div do
+        xm.p do
           xm.span << 'Go to: '
           xm.span << link_to('Change', change_url(version))
           xm.span << ' | '
           xm.span << link_to('Record', change_item_url(version))
-        }
-        xm.table {
+        end
+        xm.table do
           changes.keys.sort.each do |key|
-            xm.tr {
+            xm.tr do
               xm.td { xm.b key }
               xm.td changes[key][:previous].inspect
-              xm.td { xm.span << "&rarr;" }
+              xm.td { xm.span << '&rarr;' }
               xm.td changes[key][:current].inspect
-            }
+            end
           end
-        }
-      }
+        end
+      end
 
-      entry.content(xm.to_s, :type => 'html')
+      entry.content(xm.to_s, type: 'html')
     end
   end
 end

data/app/views/paper_trail_manager/changes/index.html.erb

@@ -1,35 +1,48 @@
 <h1>Changes</h1>
 
-<p class='changes_feed'><%= link_to 'Changes feed', changes_path(:format => 'atom') %></p>
-
 <p>
   Show:
-  <%= ([link_to('All', changes_path)] + change_item_types.map { |type| link_to(type.pluralize, changes_path(:type => type)) }).join(' | ').html_safe %>
+  <%= ([link_to('All', changes_path)] + change_item_types.map { |type| link_to(type.pluralize, changes_path(type: type)) }).join(' | ').html_safe %>
 </p>
 
-<table class='changes_table'>
-  <tfoot>
-    <tr>
-      <td colspan='2'>
-        <%= paginate @versions %>
-      </td>
-    </tr>
-  </tfoot>
-  <thead>
-    <tr class='changes_header'>
-      <th class='change_time'>Time</th>
-      <th class='change_details'>Attribute with previous and current values</th>
-    </tr>
-  </thead>
-  <tbody>
-    <% if @versions.any? %>
-      <% @versions.each do |version| %>
-        <% next unless change_show_allowed?(version) %>
-        <%= render :partial => 'version', :object => version %>
+<%= form_tag changes_path, method: :get, class: 'changes_date_filter' do %>
+  <%= hidden_field_tag :type, params[:type] if params[:type] %>
+  <%= hidden_field_tag :id, params[:id] if params[:id] %>
+  <label for="from">From:</label>
+  <%= date_field_tag :from, params[:from], id: 'from' %>
+  <label for="to">To:</label>
+  <%= date_field_tag :to, params[:to], id: 'to' %>
+  <%= submit_tag 'Filter', name: nil %>
+  <% if params[:from].present? || params[:to].present? %>
+    <%= link_to 'Clear', changes_path(type: params[:type], id: params[:id]), class: 'clear_filter' %>
+  <% end %>
+<% end %>
+<div class="table-responsive">
+  <table class='changes_table table table-bordered'>
+    <tfoot>
+      <tr>
+        <td colspan='2'>
+          <%= paginate @versions %>
+        </td>
+      </tr>
+    </tfoot>
+    <thead>
+      <tr class='changes_header'>
+        <th class='change_time'>Time</th>
+        <th class='change_details'>Attribute with previous and current values</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% if @versions.any? %>
+        <% @versions.each do |version| %>
+          <% next unless change_show_allowed?(version) %>
+          <%= render partial: 'version', object: version %>
+        <% end %>
+      <% else %>
+        <tr>
+          <td colspan='2'> &mdash; No changes found &mdash; </td>
+        </tr>
       <% end %>
-    <% else %>
-      <td rowspan='2'> &mdash; No changes found &mdash; </td>
-    <% end %>
-  </tbody>
-</table>
-
+    </tbody>
+  </table>
+</div>

data/app/views/paper_trail_manager/changes/show.html.erb

@@ -1,10 +1,13 @@
 <h1>Change <%= @version.id %></h1>
 
 <table class='changes_table'>
-  <tr class='changes_header'>
-    <th class='change_time'>Time</th>
-    <th class='change_details'>Attribute with previous and current values</th>
-    <%= render :partial => 'version', :object => @version %>
-  </tr>
+  <thead>
+    <tr class='changes_header'>
+      <th class='change_time'>Time</th>
+      <th class='change_details'>Attribute with previous and current values</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render partial: 'version', object: @version %>
+  </tbody>
 </table>
-

data/gemfiles/rails_6.1_paper_trail_12.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 12.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.1_paper_trail_12.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 12.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_12.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 12.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_12.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 12.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_15.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_15.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1_paper_trail_15.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1_paper_trail_15.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/lib/paper_trail_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'paper_trail'
 
@@ -7,32 +9,32 @@ rescue LoadError
   begin
     require 'kaminari'
   rescue LoadError
-    raise LoadError.new('will_paginate or kaminari must be in Gemfile or load_path')
+    raise LoadError, 'will_paginate or kaminari must be in Gemfile or load_path'
   end
 end
 
 class PaperTrailManager < Rails::Engine
-  initializer "paper_trail_manager.pagination" do
+  initializer 'paper_trail_manager.pagination' do
     if defined?(WillPaginate)
-      ::ActionView::Base.send(:alias_method, :paginate, :will_paginate)
+      ::ActionView::Base.define_method(:paginate) { |*args, **kwargs, &block| will_paginate(*args, **kwargs, &block) }
     end
   end
 
   @@whodunnit_name_method = :name
   cattr_accessor :whodunnit_class, :whodunnit_name_method, :route_helpers,
-    :layout, :base_controller, :user_path_method, :item_name_method
+                 :layout, :base_controller, :user_path_method, :item_name_method
 
-  self.base_controller = "ApplicationController"
+  self.base_controller = 'ApplicationController'
   self.user_path_method = :user_path
 
   (Pathname(__FILE__).dirname + '..').tap do |base|
-    paths["app/controller"] = base + 'app/controllers'
-    paths["app/view"] = base + 'app/views'
+    paths['app/controller'] = base + 'app/controllers'
+    paths['app/view'] = base + 'app/views'
   end
 
   cattr_accessor :allow_index_block, :allow_show_block, :allow_revert_block
 
-  block = Proc.new { true }
+  block = proc { true }
   self.allow_index_block = block
   self.allow_show_block = block
   self.allow_revert_block = block
@@ -50,7 +52,7 @@ class PaperTrailManager < Rails::Engine
   end
 
   def self.allow_show?(controller, version)
-    allow_index_block.call controller, version
+    allow_show_block.call controller, version
   end
 
   # Describe when to allow reverts. Call this with a block that accepts