paper_trail_viewer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06cbe395c995ac810d7164e0efcc15786a545fd5abe4277a6c2e800ed2cb0ef4
+  data.tar.gz: 991c4f1ed961a5d8a5c5967d3b14c78534cdb549d6d7a235e3e38de634797e14
+SHA512:
+  metadata.gz: af134d7971dff9b4d2344c534aa47f61e4bcd52fa06bcba99e7336db544a50aa0e0ac262db3e03b44830a2df7cf517e9aa9c44e9ce2912c37c0342bf18eaf29b
+  data.tar.gz: 8508f49cf1d1267b793f20917ec7f52363ce186898f6d8c36827e50619387bff0eecb3ee2f5a9bfe9c9d47c5974cc03cef2edd32958e6a4d082da91b16467f11

data/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.7
+          - 3.0
+        gemfile:
+          - gemfiles/rails_6.0_paper_trail_11.1.gemfile
+          - gemfiles/rails_6.0_paper_trail_12.2.gemfile
+          - gemfiles/rails_7.0_paper_trail_12.2.gemfile
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby}}-gems-${{ hashFiles('**/paper_trail_viewer.gemspec') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      # - uses: nanasess/setup-chromedriver@v1.0.1
+      - name: Install dependencies
+        run: |
+          bundle install --jobs 4 --retry 3
+          npm install
+      - name: Build
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,41 @@
+*.a
+*.bundle
+*.gem
+*.gemfile.lock
+*.iml
+*.o
+*.so
+*.stTheme.cache
+*.sublime-project
+*.sublime-workspace
+*.swp
+*.tmPreferences.cache
+*.tmlanguage.cache
+*~
+.DS_Store
+.byebug_history
+.idea/
+.rspec_status
+.ruby-gemset
+.ruby-version
+.tags
+.tags1
+.tool-versions
+.vscode
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/javascript/compiled*
+/node_modules
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+bbin/
+binstubs/*
+bundler_stubs/*/.yardoc
+mkmf.log
+package-lock.json
+spec/dummy

data/Appraisals

@@ -0,0 +1,13 @@
+{
+  '6.0' => %w[11.1 12.2],
+  '7.0' => %w[12.2],
+}.each do |rails_version, paper_trail_versions|
+  paper_trail_versions.each do |paper_trail_version|
+    appraise "rails-#{rails_version}-paper_trail-#{paper_trail_version}" do
+      gem 'rails', "~> #{rails_version}"
+      gem 'sqlite3', '~> 1.4'
+      gem 'paper_trail', "~> #{paper_trail_version}"
+      gem 'kaminari'
+    end
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+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.0.0] - 2022-03-26
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paper_trail_viewer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright for portions of paper_trail_viewer are held by Igal Koshevoy, 2011,
+as part of project paper_trail_manager.
+
+All other copyright for paper_trail_viewer is held by Janosch Müller, 2022.
+
+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/README.md

@@ -0,0 +1,53 @@
+[![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)
+
+# PaperTrailViewer
+
+Browse changes to records when using Ruby on Rails and the [`paper_trail` gem](https://github.com/paper-trail-gem/paper_trail).
+
+## Installation
+
+Add `paper_trail_viewer` to your bundle and add the following line to your `config/routes.rb`:
+
+    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:
+
+    authenticate :user, ->*{ |u| u.superadmin? } do
+      mount PaperTrailViewer::Engine => '/changes'
+    end
+
+### Configuration
+
+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
+
+## Development
+
+### Setup
+
+* Clone the repository
+* Go into the directory
+* Run `bin/setup` to install Ruby and JS dependencies
+
+### Running tests
+
+* This repo uses the [Appraisal](https://github.com/thoughtbot/appraisal) gem
+* Run `appraisal generate`
+* Run `appraisal install`
+* Run `appraisal rake generate_spec_app`
+* Run `appraisal rake`
+
+## License
+
+This program is provided under an MIT open source license, read the [LICENSE.txt](https://github.com/jaynetics/paper_trail_viewer/blob/master/LICENSE.txt) file for details.
+
+## To Note:
+
+This project started as a fork of [PaperTrailManager](https://github.com/fusion94/paper_trail_manager), which was originally developed by [Igal Koshevoy](https://github.com/igal), [Reid Beels](https://github.com/reidab), and [Micah Geisel](https://github.com/botandrose).

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new
+task default: [:compile_js, :generate_spec_app, :spec]
+
+task :compile_js do
+  `npm run compile`
+end
+
+task :generate_spec_app do
+  sh 'rm -rf spec/dummy'
+  sh *%w[
+    rails new spec/dummy
+    --template=spec/app_template.rb
+    --skip-action-cable
+    --skip-action-mailbox
+    --skip-action-mailer
+    --skip-action-text
+    --skip-active-job
+    --skip-active-storage
+    --skip-asset-pipeline
+    --skip-bootsnap
+    --skip-bundle
+    --skip-git
+    --skip-hotwire
+    --skip-javascript
+    --skip-jbuilder
+    --skip-keeps
+    --skip-listen
+    --skip-spring
+    --skip-sprockets
+    --skip-system-test
+    --skip-test
+    --skip-turbolinks
+    --skip-webpack
+  ]
+end
+
+# ensure fresh js is compiled when packaging the gem
+task build: [:compile_js]

data/app/controllers/paper_trail_viewer/js_controller.rb

@@ -0,0 +1,14 @@
+# This returns the pre-compiled JS for the viewer component.
+# Yes, that is a hacky way to make the gem work without
+# forcing users to install and integrate an npm package.
+class PaperTrailViewer::JsController < ActionController::Base
+  protect_from_forgery unless: -> { request.format.js? }
+
+  def show
+    send_file js_file, type: 'text/javascript', disposition: 'inline'
+  end
+
+  def js_file
+    File.join(__dir__, '..', '..', '..', 'javascript', 'compiled.js')
+  end
+end

data/app/controllers/paper_trail_viewer/versions_controller.rb

@@ -0,0 +1,119 @@
+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,
+    }
+  end
+
+  # Rollback 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
+  end
+end

data/app/controllers/paper_trail_viewer/viewer_controller.rb

@@ -0,0 +1,4 @@
+class PaperTrailViewer::ViewerController < ActionController::Base
+  def index
+  end
+end

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

@@ -0,0 +1,5 @@
+<link href='https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css' rel='stylesheet'>
+
+<script src='<%= "#{js_url}?v=#{PaperTrailViewer::VERSION}" %>' type='text/javascript'></script>
+
+<div id='mount-paper-trail-viewer'/>

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+npm install
+npm run compile

data/config/routes.rb

@@ -0,0 +1,5 @@
+PaperTrailViewer::Engine.routes.draw do
+  root to: 'viewer#index'
+  resource :js, only: :show, defaults: { format: :js }
+  resources :versions, only: %i[index update]
+end

data/gemfiles/rails_6.0_paper_trail_11.1.gemfile

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

data/gemfiles/rails_6.0_paper_trail_12.2.gemfile

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

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

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