effective_logging 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9e1486d4c3bf0fc430ed4f50b803e30afba2fe
-  data.tar.gz: 40e598aba305e9829ebf96629c1b18b2cf1cebcb
+  metadata.gz: a450d9893a3bdc765a9d509a3108afb28f367b8e
+  data.tar.gz: 3c283840520c3676974d2f874d1b727fff8dd117
 SHA512:
-  metadata.gz: 3c17e821361ed6f77c7cb934c5a39fdb532371128542e567703bd67d8eb3d1257ae4bee524ccbd1bfad4d909f04c421a19a23282f2b1433eb2d48eeac8092b51
-  data.tar.gz: 86e384b5ebff16315ddf1d7cbf7a325f409eacb63926309b69744b85f50a26951bc09e83aa09466ac55be67b513f5be2d3d4be9ea9e3c32975c3476e3765909c
+  metadata.gz: 0efb78ee44a94a1f32f44d687707904aa5dfc41770e98777b1acf5156ce25aa18c3358b1f37312370c394e5d6560d940f1aad639fc9e09d18ef314aa06953699
+  data.tar.gz: f50fcc75ca0eb4e8138ddae57f740773e0414789883196a01b75721b4f490091da7a7f45aecf705f5d762fdb0bdfd7e913e1ebf82ef352fd085f300f7168dec5

data/README.md

@@ -16,8 +16,6 @@ Automatically logs any email sent by the application, any successful user login
 
 Has an effective_datatables driven admin interface to display and search/sort/filter all logs.
 
-Audits changes and performs Trash restore functionality for Active Record objects.
-
 ## Getting Started
 
 Add to your Gemfile:
@@ -247,36 +245,6 @@ def log_changes_formatted_value(attribute, value)
 end
 ```
 
-### Trash & Restore
-
-This gem provides a fully functional Trash implementation that can be
-used to delete and restore active record objects in any rails application.
-
-Add to your model:
-
-```ruby
-class Post < ActiveRecord::Base
-  acts_as_trashable
-end
-```
-
-The `acts_as_trashable` mixin sets up `before_destroy` hook and copies the now-deleted attributes to an `Effective::Log` object.
-
-Visit `/trash`, or `/admin/trash` to restore them.
-
-The above routes require the following, user specific, permissions:
-
-```ruby
-can :restore, Effective::Log, user_id: user.id
-```
-
-and for admin:
-
-```ruby
-can :restore, Effective::Log
-can :admin, :effective_logging
-```
-
 ### Logging From JavaScript
 
 First, require the javascript in your application.js:

data/app/helpers/effective_logging_helper.rb

@@ -8,7 +8,6 @@ module EffectiveLoggingHelper
       when 'info'     ; 'info'
       when 'warning'  ; 'warning'
       when 'error'    ; 'danger'
-      when 'trashed'  ; 'default'
       else 'primary'
     end
   end
@@ -16,7 +15,6 @@ module EffectiveLoggingHelper
   def render_log(log)
     render(partial: 'effective/logs/log', locals: {:log => log})
   end
-  alias_method :render_trash, :render_log
 
   def parents_of_log(log)
     parents = [log.parent]

data/app/models/effective/log.rb

@@ -27,21 +27,15 @@ module Effective
     # end
 
     validates :message, presence: true
-    validates :status, presence: true, inclusion: { in: (EffectiveLogging.statuses + [EffectiveLogging.log_changes_status, EffectiveLogging.trashable_status]) }
+    validates :status, presence: true, inclusion: { in: (EffectiveLogging.statuses + [EffectiveLogging.log_changes_status]) }
 
     default_scope -> { order(updated_at: :desc) }
 
     scope :logged_changes, -> { where(status: EffectiveLogging.log_changes_status)}
     scope :changes, -> { where(status: EffectiveLogging.log_changes_status)}
-    scope :trash, -> { where(status: EffectiveLogging.trashable_status)}
 
     def to_s
-      case status
-      when EffectiveLogging.trashable_status
-        [associated_type, associated_id].join(' ').presence || 'New Trash item'
-      else
-        "Log #{id}"
-      end
+      "Log #{id}"
     end
 
     def log(message, status = EffectiveLogging.statuses.first, options = {})
@@ -52,13 +46,6 @@ module Effective
       self[:details] || {}
     end
 
-    # So this is a Trash item
-    # When we delete ourselves, we restore this trash item first
-    def restore_trashable!
-      raise 'no attributes to restore from' unless details.kind_of?(Hash) && details[:attributes].present?
-      associated_type.constantize.new(details[:attributes]).save!
-    end
-
     # def next_log
     #   @next_log ||= Log.unscoped.order(:id).where(:parent_id => self.parent_id).where('id > ?', self.id).first
     # end

data/config/effective_logging.rb

@@ -31,9 +31,7 @@ EffectiveLogging.setup do |config|
 
   # config.layout = {
   #   logs: 'application',
-  #   trash: 'application',
   #   admin_logs: 'admin',
-  #   admin_trash: 'admin'
   # }
 
   # All statuses defined here, as well as 'info', 'success', and 'error' (hardcoded) will be created as
@@ -50,7 +48,4 @@ EffectiveLogging.setup do |config|
   # Log all successful user login attempts
   config.user_logins_enabled = true
   config.user_logouts_enabled = false
-
-  # Enable the /trash, /admin/trash and /trash/:id/restore routes. Doesn't affect acts_as_trashable itself.
-  config.trash_enabled = true
 end

data/config/routes.rb

@@ -5,21 +5,11 @@ EffectiveLogging::Engine.routes.draw do
     resources :logs, only: [:create, :index, :show] do
       member { get :html_part }
     end
-
-    if EffectiveLogging.trash_enabled
-      resources :trash, only: [:index, :show] do
-        member { get :restore }
-      end
-    end
   end
 
   if defined?(EffectiveDatatables)
     namespace :admin do
-      resources :logs, :only => [:index, :show]
-
-      if EffectiveLogging.trash_enabled
-        resources :trash, only: [:index, :show]
-      end
+      resources :logs, only: [:index, :show]
     end
   end
 

data/lib/effective_logging.rb

@@ -15,7 +15,6 @@ module EffectiveLogging
   mattr_accessor :emails_enabled
   mattr_accessor :user_logins_enabled
   mattr_accessor :user_logouts_enabled
-  mattr_accessor :trash_enabled
 
   def self.setup
     yield self
@@ -44,10 +43,6 @@ module EffectiveLogging
     'logged change'.freeze
   end
 
-  def self.trashable_status
-    'trashed'.freeze
-  end
-
   # This is set by the "set_effective_logging_current_user" before_filter.
   def self.current_user=(user)
     @effective_logging_current_user = user

data/lib/effective_logging/active_record_logger.rb

@@ -12,9 +12,7 @@ module EffectiveLogging
       @depth = options.delete(:depth) || 0
       @options = options
 
-      unless @logger.respond_to?(:logged_changes) || @logger.respond_to?(:trash)
-        raise ArgumentError.new('logger must respond to logged_changes or trash')
-      end
+      raise ArgumentError.new('logger must respond to logged_changes') unless @logger.respond_to?(:logged_changes)
     end
 
     # execute! is called when we recurse, otherwise the following methods are best called individually
@@ -28,11 +26,6 @@ module EffectiveLogging
       end
     end
 
-    # before_destroy
-    def trashed!
-      log_trash((resource.to_s rescue ''), details: applicable(attributes))
-    end
-
     # before_destroy
     def destroyed!
       log('Deleted', details: applicable(attributes))
@@ -87,8 +80,7 @@ module EffectiveLogging
 
       # Collect to_s representations for all has_one associations
       (resource.class.try(:reflect_on_all_associations, :has_one) || []).each do |association|
-        next if association.name == :trash && resource.respond_to?(:acts_as_trashable_options) # We skip our own association
-        attributes[association.name] = resource.send(association.name).to_s.presence || 'nil'
+        attributes[association.name] = resource.send(association.name).to_s.presence
       end
 
       # Collects attributes for all accepts_as_nested_parameters has_many associations
@@ -127,15 +119,6 @@ module EffectiveLogging
       ).tap { |log| log.save }
     end
 
-    def log_trash(message, details: {})
-      logger.build_trash(
-        user: EffectiveLogging.current_user,
-        status: EffectiveLogging.trashable_status,
-        message: "#{"\t" * depth}#{options[:prefix]}#{message}",
-        details: details
-      ).tap { |log| log.save }
-    end
-
     # TODO: Make this work better with nested objects
     def applicable(attributes)
       atts = if options[:only].present?

data/lib/effective_logging/engine.rb

@@ -29,14 +29,13 @@ module EffectiveLogging
     initializer 'effective_logging.active_record' do |app|
       ActiveSupport.on_load :active_record do
         ActiveRecord::Base.extend(ActsAsLoggable::ActiveRecord)
-        ActiveRecord::Base.extend(ActsAsTrashable::ActiveRecord)
       end
     end
 
     # Register the log_page_views concern so that it can be called in ActionController or elsewhere
     initializer 'effective_logging.log_changes_action_controller' do |app|
       ActiveSupport.on_load :action_controller do
-        ActionController::Base.include(EffectiveLogging::LogChangesUser)
+        ActionController::Base.include(EffectiveLogging::SetCurrentUser)
         ActionController::Base.send(:before_action, :set_effective_logging_current_user)
       end
     end

data/lib/effective_logging/{log_changes_user.rb → set_current_user.rb}

@@ -1,5 +1,5 @@
 module EffectiveLogging
-  module LogChangesUser
+  module SetCurrentUser
 
     # Add me to your ApplicationController
     # before_action :set_effective_logging_current_user

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Code and Effect
@@ -93,15 +93,11 @@ files:
 - app/assets/javascripts/effective_logging.js
 - app/assets/javascripts/effective_logging/effective_logger.js.coffee.erb
 - app/controllers/admin/logs_controller.rb
-- app/controllers/admin/trash_controller.rb
 - app/controllers/effective/logs_controller.rb
-- app/controllers/effective/trash_controller.rb
 - app/helpers/effective_logging_helper.rb
 - app/models/concerns/acts_as_loggable.rb
-- app/models/concerns/acts_as_trashable.rb
 - app/models/effective/access_denied.rb
 - app/models/effective/datatables/logs.rb
-- app/models/effective/datatables/trash.rb
 - app/models/effective/log.rb
 - app/models/effective_logger.rb
 - app/views/active_admin/effective_logging/logs/index.html.haml
@@ -109,14 +105,9 @@ files:
 - app/views/admin/logs/_actions.html.haml
 - app/views/admin/logs/index.html.haml
 - app/views/admin/logs/show.html.haml
-- app/views/admin/trash/_actions.html.haml
-- app/views/admin/trash/index.html.haml
-- app/views/admin/trash/show.html.haml
 - app/views/effective/logs/_log.html.haml
 - app/views/effective/logs/index.html.haml
 - app/views/effective/logs/show.html.haml
-- app/views/effective/trash/index.html.haml
-- app/views/effective/trash/show.html.haml
 - config/effective_logging.rb
 - config/routes.rb
 - db/migrate/01_create_effective_logging.rb.erb
@@ -124,8 +115,8 @@ files:
 - lib/effective_logging/active_record_logger.rb
 - lib/effective_logging/email_logger.rb
 - lib/effective_logging/engine.rb
-- lib/effective_logging/log_changes_user.rb
 - lib/effective_logging/log_page_views.rb
+- lib/effective_logging/set_current_user.rb
 - lib/effective_logging/user_logger.rb
 - lib/effective_logging/version.rb
 - lib/generators/effective_logging/install_generator.rb

data/app/controllers/admin/trash_controller.rb

@@ -1,28 +0,0 @@
-# This copies the permissions of The Logs controller
-
-module Admin
-  class TrashController < ApplicationController
-    respond_to?(:before_action) ? before_action(:authenticate_user!) : before_filter(:authenticate_user!) # Devise
-
-    layout (EffectiveLogging.layout.kind_of?(Hash) ? EffectiveLogging.layout[:admin_trash] : EffectiveLogging.layout)
-
-    skip_log_page_views quiet: true
-    helper EffectiveLoggingHelper
-
-    def index
-      @datatable = Effective::Datatables::Trash.new()
-      @page_title = 'Trash'
-
-      EffectiveLogging.authorized?(self, :restore, Effective::Log)
-      EffectiveLogging.authorized?(self, :admin, :effective_logging)
-    end
-
-    def show
-      @trash = Effective::Log.trash.find(params[:id])
-      @page_title = "Trash item - #{@trash.to_s}"
-
-      EffectiveLogging.authorized?(self, :restore, @trash)
-      EffectiveLogging.authorized?(self, :admin, :effective_logging)
-    end
-  end
-end

data/app/controllers/effective/trash_controller.rb

@@ -1,44 +0,0 @@
-module Effective
-  class TrashController < ApplicationController
-    if respond_to?(:before_action) # Devise
-      before_action :authenticate_user!
-    else
-      before_filter :authenticate_user!
-    end
-
-    # This is the User index event
-    def index
-      @datatable = Effective::Datatables::Trash.new(user_id: current_user.id)
-      @page_title = 'Trash'
-
-      EffectiveLogging.authorized?(self, :restore, Effective::Log.new(user_id: current_user.id))
-    end
-
-    # This is the User show event
-    def show
-      @trash = Effective::Log.trash.find(params[:id])
-      @page_title = "Trash item - #{@trash.to_s}"
-
-      EffectiveLogging.authorized?(self, :restore, @trash)
-    end
-
-    def restore
-      @trash = Effective::Log.trash.find(params[:id])
-      EffectiveLogging.authorized?(self, :restore, @trash)
-
-      Effective::Log.transaction do
-        begin
-          @trash.restore_trashable!
-          @trash.destroy!
-          flash[:success] = "Successfully restored #{@trash}"
-        rescue => e
-          flash[:danger] = "Unable to restore: #{e.message}"
-          raise ActiveRecord::Rollback
-        end
-      end
-
-      redirect_back(fallback_location: effective_logging.trash_path)
-    end
-
-  end
-end

data/app/models/concerns/acts_as_trashable.rb

@@ -1,40 +0,0 @@
-module ActsAsTrashable
-  extend ActiveSupport::Concern
-
-  module ActiveRecord
-    def acts_as_trashable(*options)
-      @acts_as_trashable_options = options.try(:first) || {}
-
-      unless @acts_as_trashable_options.kind_of?(Hash)
-        raise ArgumentError.new("invalid arguments passed to (effective_trash) acts_as_trashable. Expecting no options.")
-      end
-
-      include ::ActsAsTrashable
-    end
-  end
-
-  included do
-    has_one :trash, -> { where(status: EffectiveLogging.trashable_status) }, as: :associated, class_name: Effective::Log
-
-    before_destroy do
-      EffectiveLogging::ActiveRecordLogger.new(self, acts_as_trashable_options).trashed!
-      true
-    end
-
-    # Parse Options
-    acts_as_trashable_options = {
-      only: Array(@acts_as_trashable_options[:only]).map { |attribute| attribute.to_s },
-      except: Array(@acts_as_trashable_options[:except]).map { |attribute| attribute.to_s },
-      additionally: Array(@acts_as_trashable_options[:additionally]).map { |attribute| attribute.to_s }
-    }
-
-    self.send(:define_method, :acts_as_trashable_options) { acts_as_trashable_options }
-  end
-
-  module ClassMethods
-  end
-
-  # Regular instance methods
-
-end
-

data/app/models/effective/datatables/trash.rb

@@ -1,53 +0,0 @@
-if defined?(EffectiveDatatables)
-  module Effective
-    module Datatables
-      class Trash < Effective::Datatable
-        include EffectiveLoggingHelper
-
-        datatable do
-          default_order :created_at, :desc
-
-          table_column :created_at, label: 'Destroyed at'
-          table_column :id, visible: false
-
-          unless attributes[:user_id] || attributes[:user] || (attributes[:user] == false)
-            table_column :user, label: 'Destroyed by', visible: false
-          end
-
-          table_column :associated_type, label: 'Type'
-          table_column :associated_id, label: 'Original Id', visible: false
-          table_column :message, label: 'Item'
-
-          table_column :details, visible: true, sortable: false do |trash|
-            tableize_hash(trash.details.except(:trash), th: true, sub_th: false, width: '100%')
-          end
-
-          unless attributes[:actions] == false
-            actions_column partial: 'admin/trash/actions', partial_local: :trash
-          end
-        end
-
-        # A nil attributes[:log_id] means give me all the top level log entries
-        # If we set a log_id then it's for sub logs
-        def collection
-          collection = Effective::Log.trash.includes(:user)
-
-          if attributes[:user_id].present?
-            collection = collection.where(user_id: attributes[:user_id])
-          end
-
-          if attributes[:user].present?
-            collection = collection.where(user: attributes[:user])
-          end
-
-          if attributes[:associated_id] && attributes[:associated_type]
-            collection = collection.where(associated_id: attributes[:associated_id], associated_type: attributes[:associated_type])
-          end
-
-          collection
-        end
-
-      end
-    end
-  end
-end

data/app/views/admin/trash/_actions.html.haml

@@ -1,15 +0,0 @@
-:ruby
-  show_path =
-    if datatables_active_admin_path?
-      admin_effective_trash_path(trash)
-    elsif datatables_admin_path?
-      effective_logging.admin_trash_path(trash)
-    else
-      effective_logging.trash_path(trash)
-    end
-
-= link_to show_path, title: 'view' do
-  %span.glyphicon.glyphicon-eye-open
-
-= link_to effective_logging.restore_trash_path(trash), title: 'Restore', data: {confirm: 'Restore this item?'} do
-  %span.glyphicon.glyphicon-retweet

data/app/views/admin/trash/index.html.haml

@@ -1,3 +0,0 @@
-%h1.effective-admin-heading= @page_title
-
-= render_datatable(@datatable)

data/app/views/admin/trash/show.html.haml

@@ -1,4 +0,0 @@
-%h1.effective-admin-heading= @page_title
-
-= render_trash(@trash)
-

data/app/views/effective/trash/index.html.haml

@@ -1,6 +0,0 @@
-%h1.effective-heading= @page_title
-
-- if @datatable.present?
-  = render_datatable(@datatable)
-- else
-  %p You have no previously trashed items

data/app/views/effective/trash/show.html.haml

@@ -1,3 +0,0 @@
-%h1.effective-heading= @page_title
-
-= render_trash(@trash)