paper_trail_viewer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06cbe395c995ac810d7164e0efcc15786a545fd5abe4277a6c2e800ed2cb0ef4
-  data.tar.gz: 991c4f1ed961a5d8a5c5967d3b14c78534cdb549d6d7a235e3e38de634797e14
+  metadata.gz: c575ab1f007c5581b6a24b67e2d3b2843719d2bbf8399bcf7d1823cd3194b7dd
+  data.tar.gz: bb92946d7a3a688a7a1e5d6175d7deba19516330e745aa6850d679d8a480c5d9
 SHA512:
-  metadata.gz: af134d7971dff9b4d2344c534aa47f61e4bcd52fa06bcba99e7336db544a50aa0e0ac262db3e03b44830a2df7cf517e9aa9c44e9ce2912c37c0342bf18eaf29b
-  data.tar.gz: 8508f49cf1d1267b793f20917ec7f52363ce186898f6d8c36827e50619387bff0eecb3ee2f5a9bfe9c9d47c5974cc03cef2edd32958e6a4d082da91b16467f11
+  metadata.gz: 1754241bae44d5e79f91d570fb4fe81d2b9cad78fc8289ad02353e88bdf7fa7b29c727530ec81230e7025d231b50af4fe2fbe1977ae56c535a3fd736f300f313
+  data.tar.gz: 1f473d3e9fedd0c69d3209557573d79d85bc7b64526f8d997f6400f3447ee9bfe355bdc933da1b2b4063d05b20ef2bde1abfdaa6550f57d5187586c0fb7365f3

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2022-03-27
+
+### Added
+
+- Basic support for custom version classes
+- Rollback functionality
+- Track item functionality
+
+### Fixed
+
+- `LoadError` with data source `ActiveRecord`
+- `bin/setup` being considered a gem executable
+
 ## [1.0.0] - 2022-03-26
 
 Initial release.

data/README.md

@@ -1,23 +1,33 @@
 [![Gem Version](https://badge.fury.io/rb/paper_trail_viewer.svg)](http://badge.fury.io/rb/paper_trail_viewer)
-[![Build Status](https://github.com/jaynetics/paper_trail_viewer/workflows/tests/badge.svg)](https://github.com/jaynetics/paper_trail_viewer/actions)
+[![Build Status](https://github.com/jaynetics/paper_trail_viewer/actions/workflows/tests.yml/badge.svg)](https://github.com/jaynetics/paper_trail_viewer/actions)
 
 # PaperTrailViewer
 
-Browse changes to records when using Ruby on Rails and the [`paper_trail` gem](https://github.com/paper-trail-gem/paper_trail).
+Browse changes to records when using Ruby on Rails and the [`paper_trail`](https://github.com/paper-trail-gem/paper_trail) gem.
+
+[
+  ![Screenshot thumbnail showing the webapp](
+    https://user-images.githubusercontent.com/10758879/160241794-9b9e9552-722f-48e2-9b1d-9ad463b99020.png
+  )
+](https://user-images.githubusercontent.com/10758879/160241664-fa1a6c08-54f1-4d32-9010-16b501b70f60.png)
 
 ## Installation
 
 Add `paper_trail_viewer` to your bundle and add the following line to your `config/routes.rb`:
 
-    mount PaperTrailViewer::Engine => '/changes'
+```ruby
+mount PaperTrailViewer::Engine => '/changes'
+```
 
 You can pick any path. Restart the server and go to the chosen path to view your versions.
 
-To limit access to this view, do something like:
+To limit access, do something like this:
 
-    authenticate :user, ->*{ |u| u.superadmin? } do
-      mount PaperTrailViewer::Engine => '/changes'
-    end
+```ruby
+authenticate :user, ->*{ |u| u.superadmin? } do
+  mount PaperTrailViewer::Engine => '/changes'
+end
+```
 
 ### Configuration
 
@@ -25,8 +35,15 @@ Put configuration in `config/initializers/paper_trail_viewer.rb`.
 
 E.g. for linking (or not) to the whodunnit user with a custom path helper:
 
-    PaperTrailViewer.user_path_method = :admin_path # default is :user_path
-    PaperTrailViewer.user_path_method = nil # don't link to the user
+```ruby
+PaperTrailViewer.user_path_method = :admin_path # default is :user_path
+PaperTrailViewer.user_path_method = nil # don't link to the user
+```
+
+Other options are:
+
+- `PaperTrailViewer.allow_rollback` (default is `true`)
+- `PaperTrailViewer.data_source` (default is `ActiveRecord`)
 
 ## Development
 
@@ -38,7 +55,8 @@ E.g. for linking (or not) to the whodunnit user with a custom path helper:
 
 ### Running tests
 
-* This repo uses the [Appraisal](https://github.com/thoughtbot/appraisal) gem
+This repo uses the [`appraisal`](https://github.com/thoughtbot/appraisal) gem.
+
 * Run `appraisal generate`
 * Run `appraisal install`
 * Run `appraisal rake generate_spec_app`

data/app/controllers/paper_trail_viewer/versions_controller.rb

@@ -1,119 +1,13 @@
 class PaperTrailViewer::VersionsController < ActionController::Base
   # Return the queried versions as JSON.
   def index
-    query = sanitized_params
-    versions = PaperTrailViewer.data_source.call(**query)
-    versions_as_json = versions.map { |v| version_as_json(v) }
-
-    render json: {
-      hasNextPage: !versions.last_page? && versions_as_json.any?,
-      query:       query,
-      versions:    versions_as_json,
-    }
+    result = PaperTrailViewer.data_source.call(params, main_app)
+    render json: result
   end
 
-  # Rollback a change
+  # Roll back a change.
   def update
-    unless version = PaperTrail::Version.find_by(id: params[:id])
-      flash[:error] = 'No such version.'
-      return redirect_to(root_url)
-    end
-
-    result =
-      if version.event == 'create'
-        version.item_type.constantize.find(version.item_id).destroy
-      else
-        version.reify.save
-      end
-
-    if result
-      if version.event == 'create'
-        flash[:notice] = 'Rolled back newly-created record by destroying it.'
-        redirect_to root_url
-      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 root_url
-    end
-  end
-
-  private
-
-  def sanitized_params
-    {
-      event:     params[:event].presence_in(%w[create update destroy]),
-      filter:    (params[:filter].presence if params[:filter] != '%%'),
-      item_id:   params[:item_id].presence,
-      item_type: params[:item_type].presence,
-      page:      (page = params[:page].to_i) > 0 ? page : 1,
-      per_page:  (per = params[:per_page].to_i).clamp(1, 1000),
-    }
-  end
-
-  def version_as_json(version)
-    {
-      **version.attributes.slice(*%w[id whodunnit event created_at]),
-      changeset: changeset_for(version),
-      object:    load_object(version),
-      item_id:   version.item_id.to_s,
-      item_type: version.item_type,
-      item_url:  change_item_url(version),
-      user_url:  user_url(version),
-    }
-  end
-
-  def changeset_for(version)
-    case version.event
-    when 'create', 'update'
-      version.changeset || {}
-    when 'destroy'
-      record = version.reify rescue nil
-      return {} unless record
-
-      record.attributes.each_with_object({}) do |changes, (k, v)|
-        changes[k] = [v, nil] unless v.nil?
-      end
-    else
-      raise ArgumentError, "Unknown event: #{version.event}"
-    end
-  end
-
-  # 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
-    main_app.try("#{version_type}_url", version.item_id)
-  end
-
-  def user_url(version)
-    (path_method = PaperTrailViewer.user_path_method).present? &&
-      (id = version.whodunnit).present? &&
-      !id.start_with?('#') &&
-      main_app.try(path_method, id) ||
-      nil
-  end
-
-  def load_object(version)
-    obj = version.object
-    if obj.is_a?(String)
-      PaperTrail.serializer.load(obj)
-    elsif obj.is_a?(Hash)
-      OpenStruct.new(obj)
-    else
-      obj
-    end
-  end
-end
-
-# backport deserialization fix for recent rubies
-# https://github.com/paper-trail-gem/paper_trail/pull/1338
-if PaperTrail::VERSION.to_s < '12.2.0'
-  module PaperTrail::Serializers::YAML
-    def load(string)
-      ::YAML.respond_to?(:unsafe_load) ? ::YAML.unsafe_load(string) : ::YAML.load(string)
-    end
+    result = PaperTrailViewer::Rollback.call(version_id: params[:id])
+    render json: result
   end
 end

data/app/views/paper_trail_viewer/viewer/index.html.erb

@@ -2,4 +2,4 @@
 
 <script src='<%= "#{js_url}?v=#{PaperTrailViewer::VERSION}" %>' type='text/javascript'></script>
 
-<div id='mount-paper-trail-viewer'/>
+<div id='mount-paper-trail-viewer' data-allow-rollback='<%= PaperTrailViewer.allow_rollback ? 1 : 0 %>' />