audits 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dd77ffe6dabb842251a2ca814290071d1d81bc1
+  data.tar.gz: 1ef8e6018ad750aeb1f81f7b838d6f6fe10f3bc5
+SHA512:
+  metadata.gz: 4b48ee5027a327a1fac51a19345fedef17b1474010cada6ff6cb20de565868596c24be143542e1c42779b0634b19a279032992eb88c5b6f6a60fa419372f3aa4
+  data.tar.gz: cf2fab06225aa0192459d64189045e843a8d6cc3251f8fef34de858fc0a9744f7e4a7d1f461b42b7fe1db6f52a6b67eb8349ba0cca74bc9fcafc630b4eaf5e7d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Juan Manuel Vallejo
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Audits
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Audits'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/audits.rb

@@ -0,0 +1,77 @@
+require 'change.rb'
+
+class ActiveRecord::Base
+
+	before_save :before_save
+
+	@@auditable_properties = {}
+	@@parent_models = {}
+	@@current_user_id = nil
+
+	def self.auditable_properties
+		return @@auditable_properties[self.to_s] if !@@auditable_properties.blank?
+		return nil
+	end
+
+	def self.parent_model
+		return @@parent_models[self.to_s] if !@@parent_models.blank?
+		return nil
+	end
+
+	def self.audits(*properties)
+		@@auditable_properties[self.to_s] = properties
+		# puts "Calling audits from class #{self.to_s}"
+	end
+
+	def self.audit_parent(parent_model)
+		@@parent_models[self.to_s] = parent_model
+	end
+
+	def log_changes(parent_model_class_name = nil, parent_model_id = nil)
+		auditable_properties_list = self.class.auditable_properties
+		return if self.id.blank? or auditable_properties_list.blank?
+		auditable_properties_list.each do |property|
+			# Create Change object
+			original_value = self.send "#{property.to_s}_was"
+			new_value = self.send property.to_s
+			next if original_value.eql? new_value
+		
+			c = Change.new
+			c.model_class_name = self.class.name.demodulize
+			c.model_id = self.id
+			c.property_name = property.to_s
+			c.parent_model_class_name = parent_model_class_name
+			c.parent_model_id = parent_model_id
+			c.original_value = original_value.to_s if !original_value.blank?
+			c.new_value = new_value.to_s if !new_value.blank?
+			c.created_at = DateTime.now
+			c.created_by_id = Thread.current[:user].id if !Thread.current[:user].blank?
+			c.save!
+
+		end
+	end
+
+	def before_save
+		return if self.class.auditable_properties.blank?
+
+		parent = self.class.parent_model.blank? ? nil : self.send(self.class.parent_model.to_s)
+		parent_model_id = parent.blank? ? nil : parent.id
+		parent_model_class_name = parent.blank? ? nil : parent.class.name.demodulize
+
+		self.log_changes(parent_model_class_name, parent_model_id)
+	end
+
+	def get_changes
+		return nil if self.class.auditable_properties.blank? or self.id.blank?
+
+		return Change.get_model_changes(self.class.name.demodulize, self.id)
+	end
+end
+
+class ActionController::Base
+	before_filter :set_audit_user
+	
+	def set_audit_user
+		Thread.current[:user] = current_admin if defined? current_admin and !current_admin.blank?
+	end
+end

data/lib/audits/version.rb

@@ -0,0 +1,3 @@
+module Audits
+  VERSION = "0.0.1"
+end

data/lib/change.rb

@@ -0,0 +1,21 @@
+class Change < ActiveRecord::Base
+	# Associations
+	belongs_to :user, :class_name => 'User', :foreign_key => 'created_by_id'
+
+	# Validations
+	validates :model_class_name, :model_id, :property_name, :created_at, :presence => true
+
+	def self.get_model_changes(model_class_name, model_id)
+		return Change.where("(model_id = ? and model_class_name = ?) or (parent_model_id = ? and parent_model_class_name = ?)", model_id, model_class_name, model_id, model_class_name).order("created_at desc")
+	end
+
+	def full_model_class_name
+		return self.model_class_name if self.parent_model_class_name.blank?
+		return "#{self.parent_model_class_name}.#{self.model_class_name}"
+	end
+
+	def full_property_name
+		return self.property_name if self.parent_model_class_name.blank?
+		return "#{self.model_class_name}.#{self.property_name}"
+	end
+end

data/lib/generators/audits_install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate audits_install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/audits_install/audits_install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class AuditsInstallGenerator < Rails::Generators::Base
+	include ::Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_migration_file
+  	migration_template 'create_changes.rb', 'db/migrate/create_changes.rb'
+  end
+
+  # def copy_mailer_templates
+  # 	copy_file 'monitored_process_mailer.rb', 'app/mailers/monitored_process_mailer.rb'
+  # 	copy_file 'process_execution_result_email.html.erb', 'app/views/monitored_process_mailer/process_execution_result_email.html.erb'
+  # end
+
+  def self.next_migration_number(dirname)
+  	::ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+end

data/lib/generators/audits_install/templates/create_changes.rb

@@ -0,0 +1,16 @@
+class CreateChanges < ActiveRecord::Migration
+  def change
+    create_table :changes do |t|
+      t.string :model_class_name
+      t.integer :model_id
+      t.string :property_name
+      t.string :parent_model_class_name
+      t.integer :parent_model_id
+      t.string :original_value
+      t.string :new_value
+      t.integer :created_by_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/audits_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :audits do
+#   # Task goes here
+# end

data/test/audits_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AuditsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Audits
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,3 @@
+class Product < ActiveRecord::Base
+	audits :name, :description
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "audits"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3