rails_admin_histeroid 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rails_admin_histeroid.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+Rails Admin Histeroid
+===============
+
+a basic implementation of the history auditing of Rails Admin 0.1.1 for Mongoid 3.1
+
+Installation
+-------------------
+
+in your Gemfile:
+
+```ruby
+gem 'rails_admin_histeroid', git: 'https://github.com/franc/rails_admin_histeroid.git'
+```
+
+then run
+
+```
+bundle install
+```
+
+in your rails_admin initializer:
+
+```ruby
+config.audit_with :histeroid, User
+```
+
+your rails app should now have a working RailsAdmin with history support.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails_admin_histeroid/auditing_adapter.rb

@@ -0,0 +1,37 @@
+module RailsAdmin
+  module Extensions
+    module Histeroid
+      class AuditingAdapter
+        def initialize(controller, user_class = User)
+          @controller = controller
+          @user_class = user_class.to_s.constantize
+          require 'rails_admin_histeroid/histeroid'
+        end
+
+        def latest
+          ::RailsAdmin::Histeroid.latest
+        end
+
+        def delete_object(message, object, model, user)
+          ::RailsAdmin::Histeroid.create_history_item(message, object, model, user)
+        end
+
+        def update_object(model, object, associations_before, associations_after, modified_associations, old_object, user)
+          ::RailsAdmin::Histeroid.create_update_history(model, object, associations_before, associations_after, modified_associations, old_object, user)
+        end
+
+        def create_object(message, object, abstract_model, user)
+          ::RailsAdmin::Histeroid.create_history_item(message, object, abstract_model, user)
+        end
+
+        def listing_for_model(model, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+          ::RailsAdmin::Histeroid.history_for_model(model, query, sort, sort_reverse, all, page, per_page)
+        end
+
+        def listing_for_object(model, object, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+          ::RailsAdmin::Histeroid.history_for_object(model, object, query, sort, sort_reverse, all, page, per_page)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_histeroid/histeroid.rb

@@ -0,0 +1,85 @@
+class RailsAdmin::Histeroid
+  include Mongoid::Document
+  store_in :collection => "rails_admin_histories"
+  
+  field :message, type: String
+  field :item, type: String
+  field :table, type: String
+  field :username, type: String
+  
+  include Mongoid::Timestamps
+
+  IGNORED_ATTRS = Set[:_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
+
+  attr_accessible :message, :item, :table, :username
+
+  default_scope order_by(_id: :desc)
+
+  def self.latest
+    self.limit(100)
+  end
+
+  def self.create_update_history(model, object, associations_before, associations_after, modified_associations, old_object, user)
+    messages = []
+    changed_property_list = []
+    properties = model.properties.reject{|p| IGNORED_ATTRS.include?(p[:name])}
+
+    properties.each do |p|
+      property_name = p[:name].to_param
+      if old_object.safe_send(property_name) != object.safe_send(property_name)
+        changed_property_list << " #{property_name} : #{old_object.safe_send(property_name)} -> #{object.safe_send(property_name)} "
+      end
+    end
+
+    model.associations.each do |t|
+      assoc = changed_property_list.index(t[:foreign_key].to_param)
+      changed_property_list[assoc] = "associated #{t[:pretty_name]} #{t[:foreign_key].to_param}" if assoc
+    end
+
+    associations_after.each do |key, current|
+      removed_ids = (associations_before[key] - current).map{|m| '#' + m.to_s}
+      added_ids = (current - associations_before[key]).map{|m| '#' + m.to_s}
+      messages << "Removed #{key.to_s.capitalize} #{removed_ids.join(', ')} associations" if removed_ids.any?
+      messages << "Added #{key.to_s.capitalize} #{added_ids.join(', ')} associations" if added_ids.any?
+    end
+
+    modified_associations.uniq.each { |t| changed_property_list << "associated #{t}" }
+
+    unless changed_property_list.empty?
+      if object.respond_to? 'name'
+        messages << object.name
+      end  
+      messages << "Changed #{changed_property_list.join(", ")}"
+    end
+    create_history_item(messages, object, model, user) unless messages.empty?
+  end
+
+  def self.create_history_item(message, object, abstract_model, user)
+    create(
+       :message => [message].flatten.join(', '),
+       :item => object.id,
+       :table => abstract_model.pretty_name,
+       :username => user.try(:email)
+     )
+  end
+
+  def self.history_for_model(model, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+    history = where(table: model.pretty_name)
+    history = history.any_of(message: /.*#{query}.*/, username: /.*#{query}.*/) if query
+    if sort
+      order = sort_reverse == "true" ? :desc : :asc
+      history = history.order_by(sort.to_sym => order)
+    end
+    all ? history.entries : history.send(Kaminari.config.page_method_name, page.presence || "1").per(per_page)
+  end
+
+  def self.history_for_object(model, object, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+    history = where(:table => model.pretty_name, :item => object.id)
+    history = history.any_of(message: /.*#{query}.*/, username: /.*#{query}.*/) if query
+    if sort
+      order = sort_reverse == "true" ? :desc : :asc
+      history = history.order_by(sort.to_sym => order)
+    end
+    all ? history.entries : history.send(Kaminari.config.page_method_name, page.presence || "1").per(per_page)
+  end
+end

data/lib/rails_admin_histeroid/version.rb

@@ -0,0 +1,3 @@
+module RailsAdminHisteroid
+  VERSION = "0.0.2"
+end

data/lib/rails_admin_histeroid.rb

@@ -0,0 +1,8 @@
+require "rails_admin_histeroid/version"
+require 'rails_admin_histeroid/auditing_adapter'
+
+module RailsAdminHisteroid
+  RailsAdmin.add_extension(:histeroid, RailsAdmin::Extensions::Histeroid, {
+    :auditing => true
+  })
+end

data/rails_admin_histeroid.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_admin_histeroid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_admin_histeroid"
+  s.version     = RailsAdminHisteroid::VERSION
+  s.authors     = ["Francois Paul"]
+  s.email       = ["francois@rails.co.za"]
+  s.homepage    = "https://github.com/franc/rails_admin_histeroid"
+  s.summary     = %q{a basic implementation of the history auditing of Rails Admin for Mongoid 3.1}
+  s.description = %q{add support for Mongoid as a history auditing store to Rails Admin}
+
+  s.rubyforge_project = "rails_admin_histeroid"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'rails_admin', '>= 0.1.1'
+  s.add_runtime_dependency 'mongoid', '>= 3.1.0'
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: rails_admin_histeroid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Francois Paul
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails_admin
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :runtime
+  version_requirements: *id002
+description: add support for Mongoid as a history auditing store to Rails Admin
+email: 
+- francois@rails.co.za
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rails_admin_histeroid.rb
+- lib/rails_admin_histeroid/auditing_adapter.rb
+- lib/rails_admin_histeroid/histeroid.rb
+- lib/rails_admin_histeroid/version.rb
+- rails_admin_histeroid.gemspec
+has_rdoc: true
+homepage: https://github.com/franc/rails_admin_histeroid
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rails_admin_histeroid
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a basic implementation of the history auditing of Rails Admin for Mongoid 3.1
+test_files: []
+