activeadmin-history 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc71f6be1915a90e4c1103e6ea884915e94307f4bd8e1b17580e6ddd5e2f300d
+  data.tar.gz: cb912c1c5d8513b0692be6e59fc9bcabdfa3f802822be267b9dda72c35a29183
+SHA512:
+  metadata.gz: 737c207d91240094c77e888b3a2800b1b5da5441016943a32557f52eea558af73162ffe5eb2644c60724dd84a19922c5426f8836be2bcf3c67bcc7c3294edf6f
+  data.tar.gz: 7a5097a1362aa3467344c6302d03c7b00c5954fc817220d10f83486a6b31ffffb731eef86d04a694e0091d98a2096aa39389d23946ba2bbb383f57609eee170d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# macOS Finder
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danielsellergren@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activeadmin-history.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Sellergren
+
+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,56 @@
+# Activeadmin::History
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activeadmin/history`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activeadmin-history'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activeadmin-history
+
+## Usage
+
+Run the installer from the Rails project to create the needed files, then migrate.
+
+    rails generate active_admin:history:install
+    rails db:migrate
+
+Include in any ActiveAdmin register file that you want to monitor.
+
+    ActiveAdmin.register Task do
+      include ActiveAdmin::History
+  
+      permit_params :name, :completed
+    end
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielsellergren/activeadmin-history. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/danielsellergren/activeadmin-history/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveAdmin::History project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/danielsellergren/activeadmin-history/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activeadmin-history.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/activeadmin/history/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activeadmin-history"
+  spec.version       = Activeadmin::History::VERSION
+  spec.authors       = ["Daniel Sellergren"]
+  spec.email         = ["danielsellergren@gmail.com"]
+
+  spec.summary       = "A History of AdminUser actions for the ActiveAdmin framework."
+  spec.homepage      = "https://github.com/danielsellergren/activeadmin-history"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/danielsellergren/activeadmin-history"
+  spec.metadata["changelog_uri"] = "https://github.com/danielsellergren/activeadmin-history/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activeadmin/history"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activeadmin/history.rb

@@ -0,0 +1,60 @@
+require "activeadmin/history/version"
+
+module ActiveAdmin
+  module History
+    extend ActiveSupport::Concern
+
+    class Error < StandardError; end
+
+    def self.included(dsl)
+      dsl.controller do
+        before_action :before_admin_action, only: [:create, :update, :destroy]
+        after_action :after_admin_action, only: [:create, :update, :destroy]
+
+        def before_admin_action
+          @admin_user_id = current_admin_user.id
+          @action = params[:action]
+          @param_attributes = params.dig(controller_name.singularize.to_sym)
+          @object_diff = nil
+
+          if @action == 'update'
+            @object_diff = diff(resource, resource.class.new(@param_attributes.to_unsafe_hash))
+          end
+
+          @admin_action = ::AdminAction.create(
+            admin_user_id: @admin_user_id,
+            action: @action,
+            object_params: ActiveSupport::JSON.encode(@param_attributes),
+            object_diff: ActiveSupport::JSON.encode(@object_diff),
+          )
+        end
+
+        def after_admin_action
+          @admin_action.update(
+            object_id: resource.id,
+            object_type: resource.class.to_s,
+          )
+        end
+
+        private
+
+        def diff(resource_a, resource_b)
+          h = {}
+          resource_a.attributes.each_pair do |key, value|
+            if resource_a.respond_to?(key) && resource_b.respond_to?(key)
+              unless %w[id created_at updated_at].include?(key)
+                value_a = resource_a.send(key)
+                value_b = resource_b.send(key)
+                
+                if value_a != value_b
+                  h[key] = [value_a, value_b]
+                end
+              end
+            end  
+          end    
+          h
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/history/version.rb

@@ -0,0 +1,5 @@
+module Activeadmin
+  module History
+    VERSION = "0.1.0"
+  end
+end

data/lib/activeadmin/models/admin_action.rb

@@ -0,0 +1,7 @@
+module ActiveAdmin
+  module History
+    class AdminAction < ApplicationRecord
+
+    end
+  end
+end

data/lib/generators/active_admin/history/install_generator.rb

@@ -0,0 +1,22 @@
+require "rails/generators/active_record"
+
+module ActiveAdmin
+  module History
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+        source_root File.join(__dir__, "templates")
+
+        def copy_migration
+          template "admin_action_model.rb", "app/models/admin_action.rb"
+          template "admin_action_register.rb", "app/admin/admin_actions.rb"
+          migration_template "admin_action_migration.rb", "db/migrate/create_admin_actions.rb", migration_version: migration_version
+        end
+
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_admin/history/templates/admin_action_migration.rb.tt

@@ -0,0 +1,14 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :admin_actions do |t|
+      t.string :admin_user_id, default: false, null: false
+      t.bigint :object_id
+      t.string :object_type
+      t.string :action, null: false
+      t.string :object_params
+      t.string :object_diff
+      
+      t.timestamps
+    end
+  end
+end

data/lib/generators/active_admin/history/templates/admin_action_model.rb.tt

@@ -0,0 +1,3 @@
+class AdminAction < ApplicationRecord
+  belongs_to :admin_user
+end

data/lib/generators/active_admin/history/templates/admin_action_register.rb.tt

@@ -0,0 +1,28 @@
+ActiveAdmin.register AdminAction do
+  index do
+    column 'ID', :id
+    column 'Admin', :admin_user_id do |a|
+      link_to a.admin_user.email, admin_admin_user_path(a.admin_user)
+    end
+    column 'Action', :action do |a|
+      a.action.humanize
+    end
+    column 'Object', :object_id do |o|
+      if o.object_type
+        link_to o.object_type, send("admin_#{o.object_type.constantize.table_name.singularize}_path", o)
+      end
+    end
+    column 'Params', :object_params
+    column 'Diff', :object_diff do |o|
+      decoded = ActiveSupport::JSON.decode(o.object_diff)
+      formatted = ''
+      
+      decoded&.each do |k, v|
+        formatted << "#{k}: #{v[0]} => #{v[1]}<br/>"
+      end
+      formatted.html_safe
+    end
+    column 'Performed', :created_at
+    actions
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-history
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Sellergren
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- danielsellergren@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeadmin-history.gemspec
+- bin/console
+- bin/setup
+- lib/activeadmin/history.rb
+- lib/activeadmin/history/version.rb
+- lib/activeadmin/models/admin_action.rb
+- lib/generators/active_admin/history/install_generator.rb
+- lib/generators/active_admin/history/templates/admin_action_migration.rb.tt
+- lib/generators/active_admin/history/templates/admin_action_model.rb.tt
+- lib/generators/active_admin/history/templates/admin_action_register.rb.tt
+homepage: https://github.com/danielsellergren/activeadmin-history
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/danielsellergren/activeadmin-history
+  source_code_uri: https://github.com/danielsellergren/activeadmin-history
+  changelog_uri: https://github.com/danielsellergren/activeadmin-history/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A History of AdminUser actions for the ActiveAdmin framework.
+test_files: []