auditrail 0.0.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,3 @@
+**/*.swp
+**/*.DS_Store
+spec/tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@auditrail --create

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    auditrail (0.0.1)
+      activerecord (~> 3.0.1)
+      railties (~> 3.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rspec-rails (2.0.1)
+      rspec (~> 2.0.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.1)
+  auditrail!
+  railties (~> 3.0.1)
+  rspec-rails (~> 2.0.1)
+  sqlite3-ruby

data/README.md

@@ -0,0 +1,93 @@
+# auditrail
+An easy and unobtrusive way to track changes on Active Record models.
+
+
+## How it works
+This will generate a table named **audits**. **auditrail** will save an *audit entry* each time 
+an *audited model* changes.
+
+You can find an example application that shows how to use **auditrail** 
+[here](https://github.com/MGalv/auditrails_test_app).
+
+
+## Installing
+It has only been tested on rails3, in order to install it do:
+
+    gem install auditrail
+
+
+## Usage
+First run the generator to create the *audits* table:
+  
+    rails g auditrail:create
+
+That will create a migration. Now Simply add *auditable* to your models like this:
+
+    class User < ActiveRecord::Base
+      auditable
+    end
+
+
+### Options
+You can define parameter options with a block.
+
+#### for_attributes
+Using *for_attributes* you select the fields that you want to be audited. For example:
+
+    auditable do
+      for_attributes "name", "email"
+    end
+
+This will create an *audit entry* by each time that the fields *name* or *email* change.
+
+#### by_user
+Using *by_user* you control who was the *action invoker* or *fields modifier*:
+
+    auditable do
+      by_user "user"
+    end
+
+Also, you can call the method *by_user* with a block as parameter. For example:
+
+    auditable do
+      by_user do
+        "user"
+      end
+    end
+
+This way you may dynamically control what will be saved as the *action invoker* or 
+*fields modifier*.
+
+
+# Development
+If you want to make changes to the gem, then fork it, and first install bundler:
+
+    gem install bundler
+
+Afterwards, install the bundle:
+
+    bundle install
+
+
+## Running the test suite
+Simply run:
+
+    rake
+
+
+# Changelog
+Nothing yet.
+
+
+# To Do
+* Refactor auditrail.rb and its tests.
+* Let the implementor configure where to store the audits.
+* What the audit table name will be.
+
+# About the Author
+[Crowd Interactive](http://www.crowdint.com) is an American web design and development 
+company that happens to work in Colima, Mexico. We specialize in building and growing 
+online retail stores. We don’t work with everyone – just companies we believe in. Call 
+us today to see if there’s a fit.
+
+Find more info [here](http://www.crowdint.com)!

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t| 
+  t.rspec_path = 'rspec'
+  t.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/auditrail.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "auditrail/version"
+
+Gem::Specification.new do |s|
+  s.name        = "auditrail"
+  s.version     = Auditrail::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luis Galaviz", "Emmanuel Delgado"]
+  s.email       = ["emmanuel@crowdint.com", "luis.galaviz@crowdint.com"]
+  s.homepage    = ""
+  s.summary     = %q{Audits models using serialization}
+  s.description = %q{Audits models using serialization}
+
+  s.rubyforge_project = "auditrail"
+  s.add_dependency("activerecord", "~> 3.0.1")
+  s.add_dependency("railties", "~> 3.0.1")
+  s.add_development_dependency("rspec-rails", "~> 2.0.1")
+  s.add_development_dependency("sqlite3-ruby")
+
+  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"]
+end

data/lib/auditrail.rb

@@ -0,0 +1,85 @@
+require 'active_record'
+require 'active_support/concern'
+require 'yaml'
+require 'generators/migrations'
+require 'generators/model'
+
+module Auditrail
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    class AuditOptions
+
+      def initialize(&block)
+        instance_eval &block if block
+      end
+      
+      def user
+        @user
+      end
+      
+      def attributes
+        @attributes
+      end
+      
+      private
+      def by_user(user = nil, &block)
+        @user = block ? block.call : user
+      end
+      
+      def for_attributes(*attributes)
+        @attributes = attributes
+      end
+
+    end
+    
+    def auditable(&block)
+      audit_options = block ? AuditOptions.new(&block) : AuditOptions.new
+
+      class_eval do
+        before_create do
+          track_changes(:creating, audit_options.user) if attributes_changed?(*audit_options.attributes)
+        end
+
+        before_update do
+          track_changes(:updating, audit_options.user) if attributes_changed?(*audit_options.attributes)
+        end
+
+        after_save do
+          save_tracked_changes if attributes_changed?(*audit_options.attributes)
+        end
+      end
+
+    end
+
+  end
+
+  module InstanceMethods
+
+    private
+    def attributes_changed?(*options)
+      (options - changes.keys) != options || options.empty?
+    end
+    
+    
+    def track_changes(*options)
+      action = options[0]
+      @audit = Audit.new
+      @audit.dumped_changes = YAML.dump(changes)
+      @audit.model_changed = self.class
+      @audit.action = action
+      @audit.invoker = YAML.dump(options[1])
+    end
+
+    def save_tracked_changes
+      @audit.element_id = id
+      @audit.save
+    end
+    
+  end
+
+end
+
+ActiveRecord::Base.send(:include, Auditrail)

data/lib/auditrail/version.rb

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

data/lib/generators/migrations.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Auditrail
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", File.dirname(__FILE__))
+      
+      def prepare
+        migrations_dir = File.join("db", "migrate")
+        file_name = ::ActiveRecord::Generators::Base.next_migration_number(migrations_dir)
+        copy_file("audits_table.rb", File.join(migrations_dir, "#{file_name.to_s}_create_audits.rb"))
+      end
+    end
+  end
+end

data/lib/generators/model.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Auditrail
+  module Generators
+    class ModelGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", File.dirname(__FILE__))
+      
+      def prepare
+        copy_file("audit_model.rb", File.join("app", "models", "audit.rb"))
+      end
+    end
+  end
+end

data/lib/generators/templates/audit_model.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+
+class Audit < ActiveRecord::Base
+  def action_invoker
+    YAML.load(invoker)
+  end
+  
+  def self.model_filter(model_changed)
+    where("model_changed = ?", model_changed.to_s.camelize)
+  end
+
+  def self.action_filter(action)
+    where("action = ?", action.to_s)
+  end
+end

data/lib/generators/templates/audits_table.rb

@@ -0,0 +1,17 @@
+class CreateAudits < ActiveRecord::Migration
+  def self.up
+    create_table :audits do |t|
+      t.string :dumped_changes
+      t.string :action
+      t.string :model_changed
+      t.integer :element_id
+      t.string :invoker
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/spec/auditrail_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+require 'yaml'
+require 'support/active_record'
+
+describe 'A test class' do
+  include Auditrail::Test::ActiveRecord
+
+  before do
+    connection_open
+    generate_migration
+    migrate
+
+    # the blocked passed to auditable will determine the action invoker
+    # that will be serialized
+    @test_class.class_eval do
+      auditable do
+        # When using the options by_user you can also pass the parameters as a block.
+        # by_user 465
+        # or
+        # by_user do
+        #  465
+        # end
+
+        by_user 465
+      end
+    end
+  end
+
+  after do
+    clean_tmp_path
+    connection_close
+  end
+
+  context 'its class should be auditable' do
+    it 'contains an auditable method' do
+      @test_class.should respond_to(:auditable)
+    end
+  end
+
+  context 'basic Audit behavior' do
+    
+    before do
+      @test_class.create(:name => "Text")
+    end
+
+    context 'creates a new object' do
+
+      it "should track the changes in the Test object" do
+        audit_changes = @audit_class.first.dumped_changes
+        changes_hash = YAML.load(audit_changes)
+        changes_hash["name"][0].should eq(nil)
+        changes_hash["name"][1].should eq("Text")
+      end
+      
+      it "should receive a creating status" do
+        @audit_class.first.action.should eq("creating")
+      end
+
+      it "should save the model name of the audited object" do
+        @audit_class.first.model_changed.should eq("Test")
+      end
+
+      it 'should save the id of the original affected object' do
+        instance = @test_class.first
+        @audit_class.first.element_id.should eq(instance.id)
+      end
+
+      it 'should return the action invoker' do
+        @audit_class.first.action_invoker.should eq(465)
+      end
+
+    end
+
+    context 'updates an existing object' do
+      it "should receive a creating status" do
+        instance = @test_class.first
+        instance.name = "Text change"
+        instance.save
+        @audit_class.last.action.should eq("updating")
+      end
+    end 
+
+  end
+
+  context "basic query content behavior" do
+
+    before do
+      @user_class.class_eval do
+        auditable
+      end
+      10.times do
+        @test_class.create(:name => "Text")
+      end
+
+      5.times do |item_number|
+        @user_class.create(:name => "User #{item_number}", :age => 15 + item_number, :email => "abc#{item_number}@abc.com")
+      end
+    end
+
+    it "should find the audits by model" do
+      @audit_class.model_filter(:user).should have_exactly(5).items
+      @audit_class.model_filter(:test).should have_exactly(10).items
+      @audit_class.model_filter(:admin).should have_exactly(0).items
+    end
+
+    it "should find the audits by action" do
+      5.times do |item_number|
+        test = @test_class.first
+        test.name = "Text changed #{item_number}"
+        test.save
+      end
+
+      3.times do |item_number|
+        user = @user_class.first
+        user.name = "User 1 name changed #{item_number}"
+        user.save
+      end
+
+      @audit_class.action_filter(:creating).should have_exactly(15).items
+      @audit_class.action_filter(:updating).should have_exactly(8).items
+      @audit_class.action_filter(:other).should have_exactly(0).items
+    end
+  end
+
+  context "track changes only for selected attributes" do
+    before do
+      @user_class.class_eval do
+        auditable do
+          for_attributes "name", "email"
+        end
+      end
+      @user_class.create(:name => "Marco", :age => 15, :email => "marco@abc.com")
+    end
+
+    it "should track only for name and email" do
+      user = @user_class.first
+      user.name = "Polo"
+      user.save
+
+      user = @user_class.first
+      user.email = "polo@abc.com"
+      user.save
+
+      @audit_class.all.should have_exactly(3).items
+    end
+
+    it "should not track changes for age" do
+      user = @user_class.first
+      user.age = 16
+      user.save
+
+      @audit_class.all.should have_exactly(1).items
+    end
+  end
+end

data/spec/migrations_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'support/active_record'
+
+describe Auditrail::Generators::MigrationsGenerator do
+  include Auditrail::Test::ActiveRecord
+  
+  before {generate_migration}
+  
+  after {clean_tmp_path}
+  
+  it "should generate the migration for the audits tabble into the db/migrate folder" do
+    Dir.glob(File.join(File.expand_path(File.join(DESTINATION, "db", "migrate")), "*_create_audits.rb")).should have_exactly(1).items
+  end
+end

data/spec/model_generator_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'support/active_record'
+
+describe Auditrail::Generators::ModelGenerator do
+  include Auditrail::Test::ActiveRecord
+  
+  before { generate_model }
+  
+  after {clean_tmp_path}
+
+  it "should generate the Audit model" do
+    file = File.expand_path(File.join(DESTINATION, "app", "models", "audit.rb"))
+    File.exist?(file).should be(true)
+  end 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__))
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'auditrail'
+require 'generators/migrations'
+require 'generators/model'
+require 'rails'
+require 'fileutils'
+require 'rake'
+
+ENV["RAILS_ENV"] = "test"
+ENV["RAILS_ROOT"] = "tmp"
+DESTINATION = File.expand_path(File.join("spec","tmp"))
+ENV['SCHEMA'] = File.join(DESTINATION, "db", "schema.rb")
+
+module Auditrail
+  class Application < Rails::Application; end 
+end

data/spec/support/active_record.rb

@@ -0,0 +1,62 @@
+require 'active_record'
+
+module Auditrail
+  module Test
+    module ActiveRecord
+      
+      def migrate
+        rake_app = Rake::Application.new
+        Rake.application = rake_app
+        Rake.application.rake_require File.join("active_record", "railties", "databases")
+        Rake::Task.define_task(:environment)
+
+        ::ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+        ::ActiveRecord::Migrator.migrate(File.join(DESTINATION, "db", "migrate"), ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        rake_app["db:migrate"].invoke if ::ActiveRecord::Base.schema_format == :ruby
+        generate_model
+        load File.join(DESTINATION, 'app', 'models', 'audit.rb')
+        @audit_class = ::Audit
+      end
+
+      def connection_open
+        #::ActiveRecord::Base.logger = Logger.new(STDOUT)
+        ::ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+        ::ActiveRecord::Schema.define(:version => 1) do
+          create_table :tests do |t|
+            t.string :name
+          end
+          
+          create_table :users do |t|
+            t.string :name
+            t.string :email
+            t.integer :age
+          end
+        end
+        
+        @test_class = Object.const_set(:Test, Class.new(::ActiveRecord::Base))
+        @user_class = Object.const_set(:User, Class.new(::ActiveRecord::Base))
+      end
+
+      def connection_close
+        Object.send(:remove_const, :Test)
+        Object.send(:remove_const, :User)
+        ::ActiveRecord::Base.connection.tables.each do |table|
+          ::ActiveRecord::Base.connection.drop_table(table)
+        end
+      end 
+
+      def clean_tmp_path
+        FileUtils.rm_rf(DESTINATION)
+      end
+      
+      def generate_migration
+        Auditrail::Generators::MigrationsGenerator.start([] , :destination_root => DESTINATION)
+      end
+      
+      def generate_model
+        Auditrail::Generators::ModelGenerator.start([] , :destination_root => DESTINATION)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: auditrail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luis Galaviz
+- Emmanuel Delgado
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: railties
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Audits models using serialization
+email: 
+- emmanuel@crowdint.com
+- luis.galaviz@crowdint.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .bundle/config
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- auditrail.gemspec
+- lib/auditrail.rb
+- lib/auditrail/version.rb
+- lib/generators/migrations.rb
+- lib/generators/model.rb
+- lib/generators/templates/audit_model.rb
+- lib/generators/templates/audits_table.rb
+- spec/auditrail_spec.rb
+- spec/migrations_spec.rb
+- spec/model_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: auditrail
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Audits models using serialization
+test_files: []
+