activeadmin-audit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eea25e963a62183de6ecfa5dbbb1ccdf1fe5fd2
-  data.tar.gz: 26600c5639afb004e950447a9104c9a8600ae083
+  metadata.gz: 0e531041f918eba6555a4d60a8be881de0f5e21d
+  data.tar.gz: 47a35a6077e02a7cad49cccfd72ec7f2ced715c1
 SHA512:
-  metadata.gz: 50af6f9fb5257b18c7845fd982aea7a3a618f7b5e0648799f538edb7f4afbf7b213efef0f5f15ed9aff11d141ddeeb5b46f8eb103072a4d5956097e0de4bbe5d
-  data.tar.gz: b63c0beff362edc36238acb03e9b3a48a812982969bfd24605b3e65597ded857f2db5da579ef4247a3bedb24d07ba733d0fc0118439172973b24f404a4532bde
+  metadata.gz: 197e0bc999224d9017ccbef3e1e953ebd64068cdac8e0c0bafd104ecd72e7f80bf3a132bf8887d4b1db1f5d96287adf374b6ed5e72f90e3093b5297a303685e1
+  data.tar.gz: 6c22f3a836fa938c58d9ada37e00d1f8563c3d708a8e67bbdcf145ee96a31e31ddaeabed9d08f4c912861dd46bcab7fdb95c11daa7da4a28fe76884ab00c7fcc

data/README.md

@@ -23,6 +23,26 @@ Or install it yourself as:
 
     $ gem install activeadmin-audit
 
+## Setting up Active Admin Audit (for Rails)
+
+After installing the gem, you need to run the generator. Here are your options:
+
+- If you want to use an existing user class, provide it as an argument:
+  ```sh
+  rails g active_admin_audit:install User
+  ```
+
+- Otherwise, with no arguments we will create an `AdminUser` class to use with Devise:
+  ```sh
+  rails g active_admin_audit:install
+  ```
+
+The generator adds these core files, among others:
+
+```
+config/initializers/active_admin_audit.rb
+```
+
 ## Usage
 
 Copy and apply migrations
@@ -46,7 +66,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-From model that you want to auditing call `has_versions` method 
+From model that you want to auditing call `has_versions` method
 
 ```ruby
 class Movie < ActiveRecord::Base
@@ -58,7 +78,7 @@ class Movie < ActiveRecord::Base
     images: [:url, :width, :height, :kind],
   }
 ```
- 
+
 By default `has_versions` take care about all record attributes including belongs_to references. If you don't want to include some attribute you can pass it name to `skip` options. If you want to include has_many relation pass it's name with attributes to  `also_include` option.
 
 To display table with latest changes on the ActiveAdmin resource page use helper `latest_versions`:
@@ -88,4 +108,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/activeadmin-audit.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activeadmin', '>= 1.0.0.pre1'
-  spec.add_dependency 'paper_trail', '~> 4.0.0'
+  spec.add_dependency 'paper_trail', '~> 5.0'
   spec.add_dependency 'rails', '>= 4.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'

data/app/admin/content_versions.rb

@@ -5,7 +5,12 @@ ActiveAdmin.register ActiveAdmin::Audit::ContentVersion, as: 'ContentVersion' do
 
   filter :item_type, input_html: { class: 'chosen' }, as: :select
   filter :event, input_html: { class: 'chosen' }, as: :select
-  filter :whodunnit, input_html: { class: 'chosen' }, as: :select, collection: -> { AdminUser.all.map { |u| [u.email, u.id] } }
+  filter :whodunnit, input_html: { class: 'chosen' }, as: :select,
+                     collection: lambda {
+                       ActiveAdmin::Audit.configuration.user_class_name.to_s.classify.constantize.all.map do |user|
+                         [user.email, user.id]
+                       end
+                     }
   filter :created_at
 
   index do
@@ -53,4 +58,4 @@ ActiveAdmin.register ActiveAdmin::Audit::ContentVersion, as: 'ContentVersion' do
       additional_objects_snapshot: version.additional_objects_snapshot,
     }
   end
-end
+end

data/app/models/active_admin/audit/content_version.rb

@@ -29,7 +29,7 @@ module ActiveAdmin
       end
 
       def who
-        AdminUser.find_by(id: whodunnit)
+        Audit.configuration.user_class_name.to_s.classify.constantize.find_by(id: whodunnit)
       end
 
       def item_class
@@ -45,4 +45,4 @@ module ActiveAdmin
       end
     end
   end
-end
+end

data/lib/active_admin/audit.rb

@@ -1,4 +1,5 @@
 require 'active_admin'
+require 'active_admin/audit/configuration'
 require 'active_admin/audit/version'
 require 'active_admin/audit/engine'
 require 'active_admin/audit/controller_helper'
@@ -9,5 +10,17 @@ require 'active_admin/versions_helper'
 
 module ActiveAdmin
   module Audit
+    class << self
+      attr_accessor :configuration
+
+      def configuration
+        @configuration ||= ::ActiveAdmin::Audit::Configuration.new
+      end
+
+      # Gets called within the initializer
+      def setup
+        yield(configuration)
+      end
+    end
   end
 end

data/lib/active_admin/audit/configuration.rb

@@ -0,0 +1,14 @@
+module ActiveAdmin
+  module Audit
+    class Configuration
+      include ActiveAdmin::Settings
+
+      # == User class name
+      #
+      # Set the name of the class that is used as the AdminUser.
+      # Defaults to AdminUser
+      #
+      setting :user_class_name, :admin_user
+    end
+  end
+end

data/lib/active_admin/audit/controller_helper.rb

@@ -2,7 +2,7 @@ module ActiveAdmin
   module Audit
     module ControllerHelper
       def user_for_paper_trail
-        current_admin_user
+        send(ActiveAdmin.application.current_user_method)
       end
 
       def paper_trail_enabled_for_controller
@@ -10,4 +10,4 @@ module ActiveAdmin
       end
     end
   end
-end
+end

data/lib/active_admin/audit/engine.rb

@@ -14,6 +14,10 @@ module ActiveAdmin
         module ActiveAdmin::ViewHelpers
           include ActiveAdmin::VersionsHelper
         end
+
+        ActiveAdmin.setup do |config|
+          config.before_filter :set_paper_trail_whodunnit
+        end
       end
 
       initializer 'active_record.set_configs' do

data/lib/active_admin/audit/has_versions.rb

@@ -14,7 +14,7 @@ module ActiveAdmin
             options[:skip] += translated_attrs.map { |attr| "#{attr}_translations" }
           end
 
-          has_paper_trail options.merge(on: [:nothing], class_name: 'ActiveAdmin::Audit::ContentVersion', meta: {
+          has_paper_trail options.merge(on: [], class_name: 'ActiveAdmin::Audit::ContentVersion', meta: {
             additional_objects: ->(record) { record.additional_objects_snapshot.to_json },
             additional_objects_changes: ->(record) { record.additional_objects_snapshot_changes.to_json },
           })
@@ -39,7 +39,7 @@ module ActiveAdmin
 
             # Will save new version of the object
             after_commit do
-              if paper_trail_switched_on?
+              if paper_trail.enabled?
                 if @event_for_paper_trail
                   generate_version!
                 end
@@ -50,7 +50,7 @@ module ActiveAdmin
 
             if options_on.include?(:create)
               after_create do
-                if paper_trail_switched_on?
+                if paper_trail.enabled?
                   @event_for_paper_trail = 'create'
                 end
               end
@@ -59,7 +59,7 @@ module ActiveAdmin
             if options_on.include?(:update)
               # Cache object changes to access it from after_commit
               after_update do
-                if paper_trail_switched_on?
+                if paper_trail.enabled?
                   @event_for_paper_trail = 'update'
                   cache_version_object_changes
                 end
@@ -69,7 +69,7 @@ module ActiveAdmin
             if options_on.include?(:destroy)
               # Cache all details to access it from after_commit
               before_destroy do
-                if paper_trail_switched_on?
+                if paper_trail.enabled?
                   @event_for_paper_trail = 'destroy'
                   cache_version_object
                   cache_version_object_changes
@@ -97,15 +97,15 @@ module ActiveAdmin
       private
 
       def cache_version_object
-        @version_object_cache ||= object_attrs_for_paper_trail(self.attributes)
+        @version_object_cache ||= paper_trail.object_attrs_for_paper_trail
       end
 
       def cache_version_object_changes
-        @version_object_changes_cache ||= changes_for_paper_trail
+        @version_object_changes_cache ||= paper_trail.changes
       end
 
       def cache_version_additional_objects_and_changes
-        @version_additional_objects_and_changes_cache ||= merge_metadata({})
+        @version_additional_objects_and_changes_cache ||= paper_trail.merge_metadata({})
       end
 
       def clear_version_cache

data/lib/active_admin/audit/version.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
   module Audit
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/generators/active_admin_audit/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module ActiveAdminAudit
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      desc "Installs Active Admin Audit and generates the necessary configurations"
+      argument :name, type: :string, default: "AdminUser"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        @underscored_user_name = name.underscore.gsub('/', '_')
+        template 'active_admin.audit.rb.erb', 'config/initializers/active_admin_audit.rb'
+      end
+    end
+  end
+end

data/lib/generators/active_admin_audit/templates/active_admin.audit.rb.erb

@@ -0,0 +1,8 @@
+ActiveAdmin::Audit.setup do |config|
+  # == User class name
+  #
+  # Set the name of the class that is used as the AdminUser.
+  # Defaults to AdminUser
+  #
+  config.user_class_name = :<%= @underscored_user_name %>
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-audit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Emelyanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +218,7 @@ files:
 - bin/setup
 - db/migrate/20141219113159_create_versions.rb
 - lib/active_admin/audit.rb
+- lib/active_admin/audit/configuration.rb
 - lib/active_admin/audit/controller_helper.rb
 - lib/active_admin/audit/engine.rb
 - lib/active_admin/audit/has_versions.rb
@@ -226,6 +227,8 @@ files:
 - lib/active_admin/versions_helper.rb
 - lib/active_admin/views/latest_versions.rb
 - lib/activeadmin/audit.rb
+- lib/generators/active_admin_audit/install_generator.rb
+- lib/generators/active_admin_audit/templates/active_admin.audit.rb.erb
 homepage: https://github.com/holyketzer/activeadmin-audit
 licenses:
 - MIT
@@ -246,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: PaperTrail based audit for ActiveAdmin