audit_model 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fbf268b640ba3489c07ed6ff20a40f454a44ac2
-  data.tar.gz: 137cbed98f5cb719d63b38abce211db531b2ec0b
+  metadata.gz: 0ecfdf66cff271315a58dde4a53b3699c26cd513
+  data.tar.gz: e8f1672bce78f28ccabe6bd41a0f0451cdd285b1
 SHA512:
-  metadata.gz: 7168fbf66da9d93b435e64458e8d48f16e088bda655a2d9a4ddf28ca0f220e32355cb8096d9bca92bfaacbb4a4cc13a4d1e17fc09504da624e49cc4f3f42c7f0
-  data.tar.gz: e11de75b2c0c50d62c4dd972efd52fb06af0a1b0ae4ca0bcd85e3c6d7db1a93cde291bee8fed53ca9d549c7561959d585837906e5551d66b6cca36477ccdac0a
+  metadata.gz: 9dd4a6f127ad3dd0b21ad950b0f2b075ecac5b349ff1d763a30aca684ac0230043530ee37ba60e67997980db403575bd6a2ae96dd4e64858fd374d91aff2254a
+  data.tar.gz: 151fe8095d9822825490bc931654c0d317f7f362c4b8ef6dffe7d2c2495ec798b00779dce21bd6e1708b19bc9e3f5c5d196fb92e083dc46d20897e6b6865df44

data/lib/audit_model.rb

@@ -1,5 +1,27 @@
+require 'active_support'
+require 'active_support/rails'
 require "audit_model/version"
 
 module AuditModel
-  # Your code goes here...
+  extend ActiveSupport::Autoload
+
+  autoload :Config, 'audit_model/config'
+
+  module Controllers
+    autoload :Helpers, 'audit_model/controllers/helpers'
+  end
+
+  module Models
+    autoload :Base, 'audit_model/models/base'
+    autoload :Revision, 'audit_model/models/revision'
+    autoload :Helpers, 'audit_model/models/helpers'
+  end
+
+  class << self
+    def setup
+      yield Config
+    end
+  end
 end
+
+require "audit_model/railtie" if defined?(Rails::Railtie)

data/lib/audit_model/config.rb

@@ -0,0 +1,5 @@
+module AuditModel
+  module Config
+    mattr_accessor :user_method
+  end
+end

data/lib/audit_model/controllers/helpers.rb

@@ -0,0 +1,27 @@
+module AuditModel
+  module Controllers
+    module Helpers
+      extend ActiveSupport::Concern
+      included do
+        send :include, InstanceMethods
+        before_filter :set_current_user
+        after_action :clear_current_user
+      end
+
+      module InstanceMethods
+        def set_current_user
+          Thread.current[:user_id] = get_user.try(:id)
+        end
+
+        def clear_current_user
+          Thread.current[:user_id] = nil
+        end
+
+        private
+        def get_user
+          send(Config.user_method) if respond_to? Config.user_method 
+        end
+      end
+    end
+  end
+end

data/lib/audit_model/models/base.rb

@@ -0,0 +1,42 @@
+module AuditModel
+  module Models
+    class Base < ActiveRecord::Base
+      self.abstract_class = true
+      
+      BLACK_LIST = [
+        "id", 
+        "created_at", 
+        "updated_at"
+      ]
+
+      def who
+        revision.user
+      end
+
+      class << self
+        def audit(model, type)
+          revision = Revision.new({
+            model: model,
+            user_id: Thread.current[:user_id],
+            revison_date: Time.now
+          })
+          revision.audit = new sanitizer_args(model, type)
+          revision.save!
+        end
+
+        private
+
+        def sanitizer_args(model, type) 
+          args = model.attributes.merge(model.changed_attributes)
+          args.except!(*BLACK_LIST).select! {|k,v| copy?(k) }
+          args[:rev_type] = type
+          args
+        end
+
+        def copy?(attribute)
+          attribute_names.include?(attribute)
+        end
+      end
+    end
+  end
+end

data/lib/audit_model/models/helpers.rb

@@ -0,0 +1,63 @@
+module AuditModel
+  module Models
+    module Helpers
+      extend ActiveSupport::Concern
+
+      included do
+        send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        def auditable(options = {}) 
+          options[:on] ||= [:update, :destroy]
+          setup_callbacks options[:on]
+          setup_model
+          has_many :revisions, as: :model, class_name: "AuditModel::Models::Revision"
+          has_many :audits, through: :revisions, source: :audit, source_type: audit_class
+        end
+
+        private
+        def setup_callbacks(options_on = [])
+          options_on.each do |option|
+            send "callback_on_#{option}"
+          end
+        end
+
+        def setup_model
+          Object.const_set audit_class, Class.new(Models::Base)
+        end
+
+        def callback_on_create
+          after_create :audit_on_create
+        end
+
+        def callback_on_update
+          before_update :audit_on_update
+        end
+
+        def callback_on_destroy
+          before_destroy :audit_on_destroy
+        end
+
+        def audit_class 
+          "#{name}Audit"
+        end
+      end
+
+      module InstanceMethods
+        def audit_on_create
+          "#{self.class}Audit".constantize.audit(self, :create)
+        end
+
+        def audit_on_update
+          "#{self.class}Audit".constantize.audit(self, :update)
+        end
+
+        def audit_on_destroy
+          "#{self.class}Audit".constantize.audit(self, :destroy)
+        end
+
+      end
+    end
+  end
+end

data/lib/audit_model/models/revision.rb

@@ -0,0 +1,8 @@
+module AuditModel
+  module Models
+    class Revision < ActiveRecord::Base
+      belongs_to :model, polymorphic: true
+      belongs_to :audit, polymorphic: true
+    end
+  end
+end

data/lib/audit_model/railtie.rb

@@ -0,0 +1,16 @@
+module AuditModel
+  class Railtie < Rails::Railtie
+    config.audit_model = Config
+    initializer "audit_model.controllers.include_helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        include Controllers::Helpers
+      end
+    end
+
+    initializer "audit_model.models.include_helpers" do
+      ActiveSupport.on_load(:active_record) do
+        include Models::Helpers
+      end
+    end
+  end
+end

data/lib/audit_model/version.rb

@@ -1,3 +1,3 @@
 module AuditModel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/audit_model/audit/audit_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+require 'generators/audit_model/column_not_found_error'
+module AuditModel
+  module Generators
+    class AuditGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :properties, type: :array, default: []
+
+      def klass
+        begin
+          class_name.constantize
+        rescue
+          raise "#{class_name} not defined"
+        end
+      end
+
+      def valid_properties?
+        properties.each do |propertie|
+          raise AuditModel::ColumnNotFoundError.new(klass: class_name, column: propertie) unless klass.attribute_names.include? propertie 
+        end
+      end
+
+      def create_audit_migration
+        migration_template "audit_migration.rb", "db/migrate/create_#{table_name}.rb"
+      end
+
+      def audited_properties
+        klass.columns.select {|column| properties.include? column.name }
+      end
+
+      def table_name
+        "#{class_name}_audits".downcase
+      end
+
+      def migration_class_name
+        "Create#{table_name.camelize}"
+      end
+    end
+  end
+end

data/lib/generators/audit_model/audit/templates/audit_migration.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<% audited_properties.each do |column| -%>
+      t.<%= column.type %> :<%= column.name %>
+<% end -%>
+      t.string :rev_type
+    end
+  end
+end

data/lib/generators/audit_model/column_not_found_error.rb

@@ -0,0 +1,7 @@
+module AuditModel
+  class ColumnNotFoundError < StandardError
+    def initialize(info)
+      super("The column #{info[:column]} doesn't exist in #{info[:klass]}!")
+    end
+  end
+end

data/lib/generators/audit_model/install/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/active_record'
+module AuditModel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        copy_file "audit_model.rb", "config/initializers/audit_model.rb"
+      end
+      def copy_migration
+        migration_template "revision.rb", "db/migrate/create_revisions.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/audit_model/install/templates/audit_model.rb

@@ -0,0 +1,3 @@
+AuditModel.setup do |config|
+  config.user_method = "current_user"  
+end

data/lib/generators/audit_model/install/templates/revision.rb

@@ -0,0 +1,13 @@
+class CreateRevisions < ActiveRecord::Migration
+  create_table :revisions do |t|
+    t.integer   :user_id, index: true
+    t.integer   :model_id
+    t.string    :model_type
+    t.integer   :audit_id
+    t.string    :audit_type
+
+    t.timestamp :revison_date
+  end
+  add_index :revisions, [:model_id, :model_type], :name => 'model_index'
+  add_index :revisions, [:audit_id, :audit_type], :name => 'audit_index'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alisson Bruno
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -86,8 +87,24 @@ files:
 - README.md
 - Rakefile
 - audit_model.gemspec
+- lib/.DS_Store
 - lib/audit_model.rb
+- lib/audit_model/.DS_Store
+- lib/audit_model/config.rb
+- lib/audit_model/controllers/helpers.rb
+- lib/audit_model/models/base.rb
+- lib/audit_model/models/helpers.rb
+- lib/audit_model/models/revision.rb
+- lib/audit_model/railtie.rb
 - lib/audit_model/version.rb
+- lib/generators/.DS_Store
+- lib/generators/audit_model/.DS_Store
+- lib/generators/audit_model/audit/audit_generator.rb
+- lib/generators/audit_model/audit/templates/audit_migration.rb
+- lib/generators/audit_model/column_not_found_error.rb
+- lib/generators/audit_model/install/install_generator.rb
+- lib/generators/audit_model/install/templates/audit_model.rb
+- lib/generators/audit_model/install/templates/revision.rb
 homepage: https://bitbucket.org/alissonbruno/audit_model
 licenses:
 - MIT