paper_trail_viewer 1.0.0

data/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "paper_trail_viewer",
+  "version": "1.0.0",
+  "description": "Browse changes to records when using Ruby on Rails and the `paper_trail` gem.",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "compile": "npx webpack"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaynetics/paper_trail_viewer.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jaynetics/paper_trail_viewer/issues"
+  },
+  "homepage": "https://github.com/jaynetics/paper_trail_viewer#readme",
+  "dependencies": {
+    "@babel/cli": "^7.17.6",
+    "@babel/core": "^7.17.8",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-react": "^7.16.7",
+    "@babel/preset-typescript": "^7.16.7",
+    "@types/react": "^17.0.41",
+    "@types/react-dom": "^17.0.14",
+    "@types/react-modal": "^3.13.1",
+    "babel-loader": "^8.2.4",
+    "react": "^16.14.0",
+    "react-diff-viewer": "^3.1.1",
+    "react-dom": "^16.14.0",
+    "react-hook-form": "^7.28.1",
+    "react-modal": "^3.14.4",
+    "ts-loader": "^9.2.8",
+    "webpack": "^5.70.0",
+    "webpack-cli": "^4.9.2"
+  }
+}

data/paper_trail_viewer.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/paper_trail_viewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paper_trail_viewer'
+  spec.version       = PaperTrailViewer::VERSION
+  spec.authors       = ['Janosch Müller', 'Igal Koshevoy']
+  spec.summary       = 'A user interface for `paper_trail` versioning data in Ruby on Rails applications.'
+  spec.description   = 'Browse, view and revert changes to records when using Ruby on Rails and the `paper_trail` gem.'
+  spec.homepage      = 'https://github.com/jaynetics/paper_trail_viewer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0") + %w[javascript/compiled.js]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_dependency 'kaminari'
+  spec.add_dependency 'paper_trail', ['>= 11.1']
+  spec.add_dependency 'rails', ['>= 6.0', '< 8.0']
+
+  spec.add_development_dependency 'appraisal', '~> 1.0'
+  spec.add_development_dependency 'capybara', '~> 3.0'
+  spec.add_development_dependency 'factory_bot_rails', '~> 6.0'
+  spec.add_development_dependency 'puma', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0'
+  spec.add_development_dependency 'sqlite3', '>= 1.3.6'
+  spec.add_development_dependency 'webdrivers', '~> 5.0'
+end

data/spec/app_template.rb

@@ -0,0 +1,19 @@
+gem 'paper_trail_viewer', path: __FILE__ + '/../../../'
+
+generate 'paper_trail:install'
+generate 'resource', 'entity name:string status:string --no-test-framework'
+generate 'resource', 'platform name:string status:string --no-test-framework'
+
+model_body = <<-RUBY
+  has_paper_trail
+
+  validates_presence_of :name
+  validates_presence_of :status
+RUBY
+
+inject_into_class 'app/models/entity.rb', 'Entity', model_body
+inject_into_class 'app/models/platform.rb', 'Platform', model_body
+
+route 'mount PaperTrailViewer::Engine => "/changes"'
+
+rake 'db:migrate db:test:prepare'

data/spec/rails_helper.rb

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__)
+require 'rspec/rails'
+
+require 'selenium/webdriver'
+require 'webdrivers/chromedriver'
+
+Capybara.server = :puma, { Silent: true }
+
+Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.before(:each, type: :system) do
+    driven_by :selenium_chrome_headless
+  end
+end

data/spec/support/factories.rb

@@ -0,0 +1,13 @@
+require 'factory_bot_rails'
+
+FactoryBot.define do
+  factory :entity do
+    sequence(:name)   { |n| "name_#{n}" }
+    sequence(:status) { |n| "status_#{n}" }
+  end
+
+  factory :platform do
+    sequence(:name)   { |n| "name_#{n}" }
+    sequence(:status) { |n| "status_#{n}" }
+  end
+end

data/spec/system/paper_trail_viewer_spec.rb

@@ -0,0 +1,114 @@
+require 'rails_helper'
+
+describe PaperTrailViewer, versioning: true do
+  let(:engine_urls) { PaperTrailViewer::Engine.routes.url_helpers }
+
+  context 'without changes' do
+    context 'when fetching the index' do
+      it 'has no changes by default' do
+        visit engine_urls.root_path
+
+        expect(page).to have_content('No versions found')
+      end
+    end
+  end
+
+  context 'with changes' do
+    let(:reimu) { FactoryBot.create(:entity, name: 'Miko Hakurei Reimu', status: 'Highly Responsive to Prayers') }
+    let(:flanchan) { FactoryBot.create(:entity, name: 'Flandre Scarlet', status: 'The Embodiment of Scarlet Devil') }
+    let(:sakuya) { FactoryBot.create(:entity, name: 'Sakuya Izayoi', status: 'Flowering Night') }
+    let(:kyuu_hachi) { FactoryBot.create(:platform, name: 'PC-9801', status: 'SUGOI!!1!') }
+    let!(:uinodouzu) { FactoryBot.create(:platform, name: 'Mikorusofto Uinodouzu', status: 'o-O') }
+
+    let!(:flanchan_id) { flanchan.id }
+
+    before do
+      sakuya
+      reimu.update(name: 'Hakurei Reimu', status: 'Phantasmagoria of Dimensional Dream')
+      reimu.update(status: 'Perfect Cherry Blossom')
+      flanchan.destroy
+      kyuu_hachi.update(status: 'Kimochi warui.')
+      kyuu_hachi.destroy
+      uinodouzu
+    end
+
+    describe 'index' do
+      context 'when getting all changes' do
+        context 'with authorization' do
+          context 'when getting default index' do
+            before { visit engine_urls.root_path }
+
+            it 'has all changes' do
+              expect(page).to have_selector('[data-ci-type="version-row"]', count: 10)
+            end
+
+            it 'has changes for all changed item types' do
+              within('table') do
+                expect(page).to have_content('Entity')
+                expect(page).to have_content('Platform')
+              end
+            end
+
+            it 'orders changes with newest and highest id at the top' do
+              ids = PaperTrail::Version.pluck(:id)
+              expect(page).to have_content(/#{ids.sort.reverse.join('.+')}/m)
+            end
+          end
+        end
+      end
+
+      context 'when getting changes for a specific type' do
+        context 'when changes exist' do
+          before { visit engine_urls.root_path(item_type: 'Entity') }
+
+          it 'shows a subset of the changes' do
+            expect(page).to have_selector('[data-ci-type="version-row"]', count: 6)
+          end
+        end
+      end
+
+      context 'when getting changes for a specific record' do
+        context 'when changes exist' do
+          before { visit engine_urls.root_path(item_type: 'Entity', item_id: reimu.id) }
+
+          it 'shows a subset of the changes' do
+            expect(page).to have_selector('[data-ci-type="version-row"]', count: 3)
+          end
+        end
+      end
+    end
+
+    describe 'rolling back changes' do
+      context 'when changes exist' do
+        context 'when authorized' do
+          it 'rollbacks a newly-created record by deleting it' do
+            expect(Entity).to exist(reimu.id)
+
+            put engine_urls.version_path(reimu.versions.first)
+
+            expect(Entity).not_to exist(reimu.id)
+          end
+
+          it 'rollbacks an edit by reverting to the previous state' do
+            reimu.reload
+            expect(reimu.status).to eq 'Perfect Cherry Blossom'
+
+            put engine_urls.version_path(reimu.versions.last)
+
+            reimu.reload
+            expect(reimu.status).to eq 'Phantasmagoria of Dimensional Dream'
+          end
+
+          it 'rollbacks a delete by restoring the record' do
+            expect(Entity.exists?(flanchan_id)).to eq false
+
+            put engine_urls.version_path(PaperTrail::Version.where(item_id: flanchan_id, item_type: 'Entity').last)
+
+            found = Entity.find(flanchan_id)
+            expect(found.status).to eq 'The Embodiment of Scarlet Devil'
+          end
+        end
+      end
+    end
+  end
+end

data/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "downlevelIteration": true,
+    "outDir": "./javascript/",
+    "noImplicitAny": true,
+    "module": "es6",
+    "target": "es5",
+    "jsx": "react",
+    "allowJs": true,
+    "moduleResolution": "node"
+  }
+}

data/webpack.config.js

@@ -0,0 +1,26 @@
+const path = require('path')
+
+module.exports = {
+  entry: './javascript/src/index.ts',
+  mode: 'production',
+  module: {
+    rules: [
+      {
+        rules: [
+          {
+            test: /\.tsx?$/,
+            use: 'ts-loader',
+            exclude: /node_modules/,
+          },
+        ],
+      }
+    ]
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'compiled.js',
+    path: path.resolve(__dirname, 'javascript'),
+  },
+}

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail_viewer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Janosch Müller
+- Igal Koshevoy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Browse, view and revert changes to records when using Ruby on Rails and
+  the `paper_trail` gem.
+email:
+executables:
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/paper_trail_viewer/js_controller.rb
+- app/controllers/paper_trail_viewer/versions_controller.rb
+- app/controllers/paper_trail_viewer/viewer_controller.rb
+- app/views/paper_trail_viewer/viewer/index.html.erb
+- bin/setup
+- config/routes.rb
+- 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
+- javascript/compiled.js
+- javascript/src/app.tsx
+- javascript/src/components/change_diff.tsx
+- javascript/src/components/config_modal.tsx
+- javascript/src/components/controls.tsx
+- javascript/src/components/full_object_modal.tsx
+- javascript/src/components/index.ts
+- javascript/src/components/modal.tsx
+- javascript/src/components/pagination.tsx
+- javascript/src/components/versions_list.tsx
+- javascript/src/index.ts
+- javascript/src/types.ts
+- lib/paper_trail_viewer.rb
+- lib/paper_trail_viewer/data_source/active_record.rb
+- lib/paper_trail_viewer/data_source/bigquery.rb
+- lib/paper_trail_viewer/engine.rb
+- lib/paper_trail_viewer/version.rb
+- package.json
+- paper_trail_viewer.gemspec
+- spec/app_template.rb
+- spec/rails_helper.rb
+- spec/support/factories.rb
+- spec/system/paper_trail_viewer_spec.rb
+- tsconfig.json
+- webpack.config.js
+homepage: https://github.com/jaynetics/paper_trail_viewer
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A user interface for `paper_trail` versioning data in Ruby on Rails applications.
+test_files:
+- spec/app_template.rb
+- spec/rails_helper.rb
+- spec/support/factories.rb
+- spec/system/paper_trail_viewer_spec.rb