activeadmin-history 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/CHANGELOG.md +0 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +56 -0
- data/Rakefile +6 -0
- data/activeadmin-history.gemspec +28 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/activeadmin/history.rb +60 -0
- data/lib/activeadmin/history/version.rb +5 -0
- data/lib/activeadmin/models/admin_action.rb +7 -0
- data/lib/generators/active_admin/history/install_generator.rb +22 -0
- data/lib/generators/active_admin/history/templates/admin_action_migration.rb.tt +14 -0
- data/lib/generators/active_admin/history/templates/admin_action_model.rb.tt +3 -0
- data/lib/generators/active_admin/history/templates/admin_action_register.rb.tt +28 -0
- metadata +66 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: bc71f6be1915a90e4c1103e6ea884915e94307f4bd8e1b17580e6ddd5e2f300d
|
4
|
+
data.tar.gz: cb912c1c5d8513b0692be6e59fc9bcabdfa3f802822be267b9dda72c35a29183
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 737c207d91240094c77e888b3a2800b1b5da5441016943a32557f52eea558af73162ffe5eb2644c60724dd84a19922c5426f8836be2bcf3c67bcc7c3294edf6f
|
7
|
+
data.tar.gz: 7a5097a1362aa3467344c6302d03c7b00c5954fc817220d10f83486a6b31ffffb731eef86d04a694e0091d98a2096aa39389d23946ba2bbb383f57609eee170d
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
File without changes
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at danielsellergren@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 Daniel Sellergren
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
# Activeadmin::History
|
2
|
+
|
3
|
+
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.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'activeadmin-history'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install activeadmin-history
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
Run the installer from the Rails project to create the needed files, then migrate.
|
26
|
+
|
27
|
+
rails generate active_admin:history:install
|
28
|
+
rails db:migrate
|
29
|
+
|
30
|
+
Include in any ActiveAdmin register file that you want to monitor.
|
31
|
+
|
32
|
+
ActiveAdmin.register Task do
|
33
|
+
include ActiveAdmin::History
|
34
|
+
|
35
|
+
permit_params :name, :completed
|
36
|
+
end
|
37
|
+
|
38
|
+
|
39
|
+
## Development
|
40
|
+
|
41
|
+
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.
|
42
|
+
|
43
|
+
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).
|
44
|
+
|
45
|
+
## Contributing
|
46
|
+
|
47
|
+
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).
|
48
|
+
|
49
|
+
|
50
|
+
## License
|
51
|
+
|
52
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
53
|
+
|
54
|
+
## Code of Conduct
|
55
|
+
|
56
|
+
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
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require_relative 'lib/activeadmin/history/version'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = "activeadmin-history"
|
5
|
+
spec.version = Activeadmin::History::VERSION
|
6
|
+
spec.authors = ["Daniel Sellergren"]
|
7
|
+
spec.email = ["danielsellergren@gmail.com"]
|
8
|
+
|
9
|
+
spec.summary = "A History of AdminUser actions for the ActiveAdmin framework."
|
10
|
+
spec.homepage = "https://github.com/danielsellergren/activeadmin-history"
|
11
|
+
spec.license = "MIT"
|
12
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
13
|
+
|
14
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
15
|
+
|
16
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
17
|
+
spec.metadata["source_code_uri"] = "https://github.com/danielsellergren/activeadmin-history"
|
18
|
+
spec.metadata["changelog_uri"] = "https://github.com/danielsellergren/activeadmin-history/CHANGELOG.md"
|
19
|
+
|
20
|
+
# Specify which files should be added to the gem when it is released.
|
21
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
22
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
23
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
24
|
+
end
|
25
|
+
spec.bindir = "exe"
|
26
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
27
|
+
spec.require_paths = ["lib"]
|
28
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "activeadmin/history"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
require "activeadmin/history/version"
|
2
|
+
|
3
|
+
module ActiveAdmin
|
4
|
+
module History
|
5
|
+
extend ActiveSupport::Concern
|
6
|
+
|
7
|
+
class Error < StandardError; end
|
8
|
+
|
9
|
+
def self.included(dsl)
|
10
|
+
dsl.controller do
|
11
|
+
before_action :before_admin_action, only: [:create, :update, :destroy]
|
12
|
+
after_action :after_admin_action, only: [:create, :update, :destroy]
|
13
|
+
|
14
|
+
def before_admin_action
|
15
|
+
@admin_user_id = current_admin_user.id
|
16
|
+
@action = params[:action]
|
17
|
+
@param_attributes = params.dig(controller_name.singularize.to_sym)
|
18
|
+
@object_diff = nil
|
19
|
+
|
20
|
+
if @action == 'update'
|
21
|
+
@object_diff = diff(resource, resource.class.new(@param_attributes.to_unsafe_hash))
|
22
|
+
end
|
23
|
+
|
24
|
+
@admin_action = ::AdminAction.create(
|
25
|
+
admin_user_id: @admin_user_id,
|
26
|
+
action: @action,
|
27
|
+
object_params: ActiveSupport::JSON.encode(@param_attributes),
|
28
|
+
object_diff: ActiveSupport::JSON.encode(@object_diff),
|
29
|
+
)
|
30
|
+
end
|
31
|
+
|
32
|
+
def after_admin_action
|
33
|
+
@admin_action.update(
|
34
|
+
object_id: resource.id,
|
35
|
+
object_type: resource.class.to_s,
|
36
|
+
)
|
37
|
+
end
|
38
|
+
|
39
|
+
private
|
40
|
+
|
41
|
+
def diff(resource_a, resource_b)
|
42
|
+
h = {}
|
43
|
+
resource_a.attributes.each_pair do |key, value|
|
44
|
+
if resource_a.respond_to?(key) && resource_b.respond_to?(key)
|
45
|
+
unless %w[id created_at updated_at].include?(key)
|
46
|
+
value_a = resource_a.send(key)
|
47
|
+
value_b = resource_b.send(key)
|
48
|
+
|
49
|
+
if value_a != value_b
|
50
|
+
h[key] = [value_a, value_b]
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
h
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
require "rails/generators/active_record"
|
2
|
+
|
3
|
+
module ActiveAdmin
|
4
|
+
module History
|
5
|
+
module Generators
|
6
|
+
class InstallGenerator < Rails::Generators::Base
|
7
|
+
include ActiveRecord::Generators::Migration
|
8
|
+
source_root File.join(__dir__, "templates")
|
9
|
+
|
10
|
+
def copy_migration
|
11
|
+
template "admin_action_model.rb", "app/models/admin_action.rb"
|
12
|
+
template "admin_action_register.rb", "app/admin/admin_actions.rb"
|
13
|
+
migration_template "admin_action_migration.rb", "db/migrate/create_admin_actions.rb", migration_version: migration_version
|
14
|
+
end
|
15
|
+
|
16
|
+
def migration_version
|
17
|
+
"[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
|
2
|
+
def change
|
3
|
+
create_table :admin_actions do |t|
|
4
|
+
t.string :admin_user_id, default: false, null: false
|
5
|
+
t.bigint :object_id
|
6
|
+
t.string :object_type
|
7
|
+
t.string :action, null: false
|
8
|
+
t.string :object_params
|
9
|
+
t.string :object_diff
|
10
|
+
|
11
|
+
t.timestamps
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
ActiveAdmin.register AdminAction do
|
2
|
+
index do
|
3
|
+
column 'ID', :id
|
4
|
+
column 'Admin', :admin_user_id do |a|
|
5
|
+
link_to a.admin_user.email, admin_admin_user_path(a.admin_user)
|
6
|
+
end
|
7
|
+
column 'Action', :action do |a|
|
8
|
+
a.action.humanize
|
9
|
+
end
|
10
|
+
column 'Object', :object_id do |o|
|
11
|
+
if o.object_type
|
12
|
+
link_to o.object_type, send("admin_#{o.object_type.constantize.table_name.singularize}_path", o)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
column 'Params', :object_params
|
16
|
+
column 'Diff', :object_diff do |o|
|
17
|
+
decoded = ActiveSupport::JSON.decode(o.object_diff)
|
18
|
+
formatted = ''
|
19
|
+
|
20
|
+
decoded&.each do |k, v|
|
21
|
+
formatted << "#{k}: #{v[0]} => #{v[1]}<br/>"
|
22
|
+
end
|
23
|
+
formatted.html_safe
|
24
|
+
end
|
25
|
+
column 'Performed', :created_at
|
26
|
+
actions
|
27
|
+
end
|
28
|
+
end
|
metadata
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: activeadmin-history
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Daniel Sellergren
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-06-05 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description:
|
14
|
+
email:
|
15
|
+
- danielsellergren@gmail.com
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- ".gitignore"
|
21
|
+
- ".rspec"
|
22
|
+
- ".travis.yml"
|
23
|
+
- CHANGELOG.md
|
24
|
+
- CODE_OF_CONDUCT.md
|
25
|
+
- Gemfile
|
26
|
+
- LICENSE.txt
|
27
|
+
- README.md
|
28
|
+
- Rakefile
|
29
|
+
- activeadmin-history.gemspec
|
30
|
+
- bin/console
|
31
|
+
- bin/setup
|
32
|
+
- lib/activeadmin/history.rb
|
33
|
+
- lib/activeadmin/history/version.rb
|
34
|
+
- lib/activeadmin/models/admin_action.rb
|
35
|
+
- lib/generators/active_admin/history/install_generator.rb
|
36
|
+
- lib/generators/active_admin/history/templates/admin_action_migration.rb.tt
|
37
|
+
- lib/generators/active_admin/history/templates/admin_action_model.rb.tt
|
38
|
+
- lib/generators/active_admin/history/templates/admin_action_register.rb.tt
|
39
|
+
homepage: https://github.com/danielsellergren/activeadmin-history
|
40
|
+
licenses:
|
41
|
+
- MIT
|
42
|
+
metadata:
|
43
|
+
allowed_push_host: https://rubygems.org
|
44
|
+
homepage_uri: https://github.com/danielsellergren/activeadmin-history
|
45
|
+
source_code_uri: https://github.com/danielsellergren/activeadmin-history
|
46
|
+
changelog_uri: https://github.com/danielsellergren/activeadmin-history/CHANGELOG.md
|
47
|
+
post_install_message:
|
48
|
+
rdoc_options: []
|
49
|
+
require_paths:
|
50
|
+
- lib
|
51
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ">="
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: 2.3.0
|
56
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '0'
|
61
|
+
requirements: []
|
62
|
+
rubygems_version: 3.1.2
|
63
|
+
signing_key:
|
64
|
+
specification_version: 4
|
65
|
+
summary: A History of AdminUser actions for the ActiveAdmin framework.
|
66
|
+
test_files: []
|