administrate-field-paper_trail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69f939123a47a422bb338a97dcaaf061514c19a25ffcda1922c6b4e5b991736b
+  data.tar.gz: 1efc7453358914b6b6220b7dd2c990c8850aa4cb4e5be0b0d74d4e999e5c72bc
+SHA512:
+  metadata.gz: 66c858c8b27f43c4a5c126924ae2da54e8f18836ec79d0b8c2244287fe3fc2cbe37b7379b55ae2fd0ee439dfa876455f27e7eaf2165eed0bf50ddf1d45bf84d1
+  data.tar.gz: c70a7df3406500cd94f1cd324a9fe541aefc78e9e013d3fb34ba3da1d71f7c2bc3c9f264f391a2c9a40d9d1d1df130ff1b7ee80c5bd508d459b21ed1abc0f536

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+---
+name: CI
+on: [push,pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Irvan Fauziansyah
+
+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,69 @@
+# AdministrateFieldPaperTrail
+
+![Gem](https://img.shields.io/gem/v/administrate-field-paper_trail.svg)
+![CI](https://github.com/IrvanFza/administrate-field-paper_trail/workflows/CI/badge.svg)
+
+An [Administrate](https://github.com/thoughtbot/administrate/) plugin to show record change histories from [PaperTrail](https://github.com/paper-trail-gem/paper_trail).
+
+## Requirements
+
+- Ruby on Rails version >= 5.0
+- Administrate version >= 0.2.2
+- PaperTrail version >= 2.7.2
+
+## Installation
+
+Make sure you already setup [PaperTrail](https://github.com/paper-trail-gem/paper_trail#1b-installation) properly in your project.
+Add `administrate-field-paper_trail` to your Gemfile:
+
+```ruby
+gem 'administrate-field-paper_trail'
+```
+
+And then execute:
+```
+$ bundle install
+```
+
+## Usage
+
+Add to your `UserDashboard`:
+
+```ruby
+ATTRIBUTE_TYPES = {
+  changeset: Field::PaperTrail.with_options(excluded_attributes: %w[created_at updated_at]),
+}
+```
+
+The `excluded_attributes` option takes an array of string of the attributes you want to exclude from the result.
+
+Then show the data either in your show page like so:
+
+```ruby
+SHOW_PAGE_ATTRIBUTES = %i[
+  changeset
+]
+```
+
+Currently, only support to show changes in the show page. Contribution will be appreciated.
+
+## To Do
+
+- [x] Show record changes information in the show page
+- [ ] Show count of changes of each records in the index page
+- [ ] Add i18n support for the result message
+- [ ] Add i18n support for date/time value
+
+## Contributing
+
+1. Contribution are welcome (codes, suggestions, and bugs)
+2. Please test your code: `bundle exec rspec`
+3. Please document your code
+4. Bug reports and pull requests are welcome on GitHub at https://github.com/IrvanFza/administrate-field-paper_trail
+
+## License
+
+[MIT License](https://github.com/IrvanFza/administrate-field-paper_trail/blob/master/LICENSE.md)
+
+---
+Based on the [Administrate::Field::Image](https://github.com/thoughtbot/administrate-field-image) template

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+
+##
+# Configure the test suite.
+##
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+##
+# By default, just run the tests.
+##
+task default: :spec

data/administrate-field-paper_trail.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "administrate-field-paper_trail"
+  gem.version = "0.1.0"
+  gem.authors = ["Irvan Fauziansyah"]
+  gem.email = ["ervhan@gmail.com"]
+  gem.homepage = "https://github.com/IrvanFza/administrate-field-paper_trail"
+  gem.summary = "Administrate field for PaperTrail"
+  gem.description = "Administrate's plugin to show PaperTrail versions via new field type"
+  gem.license = "MIT"
+
+  gem.require_paths = ["lib"]
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_dependency "administrate", ">= 0.2.2"
+  gem.add_dependency "paper_trail", ">= 2.7.2"
+  gem.add_dependency "rails", ">= 5.0"
+
+  gem.add_development_dependency "rspec", "~> 3.4"
+end

data/app/views/fields/paper_trail/_show.html.erb

@@ -0,0 +1,42 @@
+<%#
+# PaperTrail Show Partial
+
+This partial renders a paper_trail attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as a table tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Image][1].
+  A wrapper around the image url pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Image
+%>
+
+<% versions = field.resource.versions %>
+<% if versions.present? %>
+  <table aria-describedby="Record Changes">
+    <thead>
+    <tr>
+      <th width="10%">Action</th>
+      <th width="10%">Updated By</th>
+      <th width="10%">Updated At</th>
+      <th>Changes</th>
+    </tr>
+    </thead>
+    <tbody>
+    <% versions.each do |version| %>
+      <tr>
+        <td width="10%"><%= version.event %></td>
+        <td width="10%"><%= version.whodunnit %></td>
+        <td width="10%"><%= version.created_at %></td>
+        <td><%= field.humanize_changeset(version.changeset) %></td>
+      </tr>
+    <% end %>
+    <tbody>
+  </table>
+<% else %>
+  -
+<% end %>

data/lib/administrate/field/paper_trail.rb

@@ -0,0 +1,27 @@
+require "administrate/field/base"
+require "rails"
+
+module Administrate
+  module Field
+    class PaperTrail < Administrate::Field::Base
+      class Engine < ::Rails::Engine
+      end
+
+      def excluded_attributes
+        options.fetch(:excluded_attributes, %w[id created_at updated_at])
+      end
+
+      def humanize_changeset(changeset)
+        result = ''
+        changeset.each do |attribute, values|
+          next if excluded_attributes.include?(attribute)
+
+          old_value, new_value = values
+          result += "#{attribute.gsub('_', ' ').capitalize} changed from '#{old_value}' to '#{new_value}'. "
+        end
+
+        result
+      end
+    end
+  end
+end

data/spec/lib/administrate/field/paper_trail_spec.rb

@@ -0,0 +1,14 @@
+require "administrate/field/paper_trail"
+
+describe Administrate::Field::PaperTrail do
+  describe "#to_partial_path" do
+    it "returns a partial based on the page being rendered" do
+      page = :show
+      field = Administrate::Field::PaperTrail.new(:image, "/a.jpg", page)
+
+      path = field.to_partial_path
+
+      expect(path).to eq("/fields/paper_trail/#{page}")
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-paper_trail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Irvan Fauziansyah
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Administrate's plugin to show PaperTrail versions via new field type
+email:
+- ervhan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-paper_trail.gemspec
+- app/views/fields/paper_trail/_show.html.erb
+- lib/administrate/field/paper_trail.rb
+- spec/lib/administrate/field/paper_trail_spec.rb
+homepage: https://github.com/IrvanFza/administrate-field-paper_trail
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.3
+signing_key:
+specification_version: 4
+summary: Administrate field for PaperTrail
+test_files:
+- spec/lib/administrate/field/paper_trail_spec.rb