has_history 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Zimmer, Andras
+
+MIT License
+
+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.md

@@ -0,0 +1,61 @@
+# HasHistory
+
+This gem adds a simple but effective changes history to your ActiveRecord models.  It is compatible with Rails but can be used without as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_history'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_history
+
+## Usage
+
+First you have to set up `has_history`:
+
+    $ rails g has_history:install
+
+and then migrate your database (`rake db:migrate`).
+
+From then on whenever you add `has_history` to your ActiveRecord model like this:
+
+    class MyModel < ActiveRecord::Base
+      ...
+      has_history
+      ...
+    end
+
+An then you 'magically' have history for the changes.  You can access history via
+
+    MyModel.history_entries
+
+Each entry has a `modifications` attribute that contains the changes in array of hashes:
+
+    [{ attribute1 => {:before => value1_before, :after => value1_after} }, ..., { attributeN => {:before => valueN_before, :after => valueN_after} }]
+
+## Configuration
+
+`has_history` has a few options to control its behavior.
+
+- `ignore_attributes` controls which attributes are *not* included in the history tracking
+- `updater_id` sets to user who made the changes (it can be taken from the record or via some other method)
+- `resolution_map` holds foreign key references to attributes whose value is to be materializes (that is instead of post_id it is possible to save the title of the referenced post)
+
+For more details see `config/initializers/has_history.rb`.
+
+Configuration has defaults, can be set through the initializer, or can be passed in on a per-model base (as params to the `has_model` method).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run unit tests on gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/has_history.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/has_history/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["fastcatch"]
+  gem.email         = ["andras.zimmer@gmail.com"]
+  gem.description   = %q{Adds history to ActiveRecord models.}
+  gem.summary       = %q{Add has_history to your ActiveRecord model and you'll instantly have access to the full history of changes of the record.}
+  gem.homepage      = "https://github.com/fastcatch/has_history"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "has_history"
+  gem.require_paths = ["lib"]
+  gem.version       = HasHistory::VERSION
+end

data/lib/generators/has_history/install_generator.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module HasHistory
+  class InstallGenerator < Rails::Generators::Base
+    desc "Copies a config initializer to config/initializers/has_history.rb"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      template        'has_history.rb', 'config/initializers/has_history.rb'
+    end
+  end
+end

data/lib/generators/templates/has_history.rb

@@ -0,0 +1,18 @@
+require 'lib/has_history.rb'
+
+# Array of attributes whose changes do not need to be saved to history
+# Defaults to [:updated_at, :updater_id, :created_at, :creator_id, :updated_on, :created_on]
+# HasHistory::History.ignore_attributes = [:updated_at, :updater_id, :created_at, :creator_id, :updated_on, :created_on]
+
+# Determines the id(!) of the user who made the change
+#   if it is a symbol or a string, it is sent to the record (e.g. :updated_by)
+#   if it is a proc, it gets called with the record as a param (e.g. Proc.new{ User.current_user })
+# Defaults to :updated_by
+# HasHistory::History.updater_id = :updated_by
+
+# Hash map to resolve foreign keys (in the form of :attribute_id => :value_method)
+#   changes in keys will save values from the referenced entity
+#   :value_method is sent to the referenced entity to fetch value to store
+#   e.g. { :user_id => :full_name, :post_id => :title
+# Defaults to {}
+# HasHistory::History.resolution_map = {}

data/lib/has_history/ar_extension.rb

@@ -0,0 +1,16 @@
+module HasHistory
+  module ClassMethods
+
+    #
+    # put has_history in your model class and your changes will be saved
+    #
+    #   available options: see initializer
+    #
+    def has_history(*args)
+      options = args.extract_options!
+      has_many :history_entries, :class_name => 'HistoryEntry', :as => :entity, :dependent => :destroy
+      after_update Proc.new{|record| HasHistory::History.create(record, options)}
+    end
+  end
+  ActiveRecord::Base.extend(ClassMethods)
+end

data/lib/has_history/has_history.rb

@@ -0,0 +1,124 @@
+module HasHistory
+
+  class History
+    CONFIGURABLES = [:ignore_attributes, :updater_id, :resolution_map]
+
+    if respond_to?(:class_attribute)
+      class_attribute *CONFIGURABLES
+    else
+      class_inheritable_accessor *CONFIGURABLES
+    end
+
+    self.ignore_attributes = [:updated_at, :updater_id, :created_at, :creator_id, :updated_on, :created_on]
+    self.updater_id = :updated_by
+    self.resolution_map = {}
+
+    def initialize(options = {})
+      @options = options
+      # passed in values take precedence over config values over baked-in defaults
+      CONFIGURABLES.each do |key|
+        @options[key] ||= self.send( key)
+      end
+    end
+
+    # Creates a new history entry (if needed)
+    # class method
+    def self.create(record, options)
+      history = History.new(options)
+      history.save(record)
+    end
+
+    # Check if entry has to be created and do it
+    def save(record)
+      changes = record.changes
+
+      # some values obviously change but we don't care
+      changes.delete_if {|key,value|  @options[:ignore_attributes].include? key.to_sym}
+
+      # also remove keys for which AR reports changes but in fact there are none
+      changes.delete_if {|key,value| value[0]==value[1]}
+
+      # create history entry if meaningful
+      if !changes.empty?
+        HistoryEntry.create(
+          :entity => record,
+          :modified_by_id => updated_by(record),
+          :modifications => format_for_history(record, changes)
+        )
+      end
+    end
+
+  private
+    def format_for_history(record, changes)
+      # replace "*_id" references with values
+      formatted_changes = materialize_references(record, changes, @options[:resolution_map])
+
+=begin
+    # replace time and date values with display style values
+    formatted_changes.each_pair do |key, values|
+      attribute_type = (record.send key.to_sym).class.name
+      if attribute_type =~ /Date|Time/
+        old_value = values[0].present? ? I18n.l(values[0], :locale=>locale) : ""
+        new_value = values[1].present? ? I18n.l(values[1], :locale=>locale) : ""
+        formatted_changes[key] = [old_value, new_value]
+      end
+    end
+
+    # more to come: process formatters
+=end
+      formatted_changes.collect do |ch|
+        { ch[0] => {:before => ch[1][0], :after => ch[1][1]} }
+      end
+    end
+
+    def materialize_references(record, changes, mapping)
+      # replace "*_id" references with values with the provided mapping, leave other changes intact
+      changes.inject({}) do |memo, change|
+        resolution_attribute = mapping[change[0]] || mapping[change[0].to_sym]
+        cleaned = resolution_attribute ? resolve_reference(record, change, resolution_attribute) : change
+        memo.merge!({cleaned[0] => cleaned[1]})
+      end
+    end
+
+    def resolve_reference(record, change, resolution_attribute)
+      # record is an instance with the new values
+      # change is an array of the format [key_with_id, [old_id, new_id]]
+      # returns [old_value, new_value] by replacing references with resolution_attribute of the referenced entity
+      # => e.g. (Activity, salesrep_id => [1,2], "full_name") returns ["salesrep", ["John Past", "Jerry Comes"]]
+      # Please note that change should only contain one tuple!!!
+
+      key, old_id, new_id = change.flatten
+      attribute = key.to_s[0...-3]      # remove the "_id" part
+
+      if new_id.present?
+        dummy_record = record.clone
+        dummy_record[key] = new_id
+        new_value = dummy_record.send(attribute.to_sym).send(resolution_attribute.to_sym)
+      else
+        new_value = nil
+      end
+
+      # use AR to get the old value on a dummy duplicate
+      if old_id.present?
+        dummy_record = record.clone
+        dummy_record[key] = old_id
+        old_value = dummy_record.send(attribute.to_sym).send(resolution_attribute.to_sym)
+      else
+        old_value = nil
+      end
+
+      result = [attribute, [old_value, new_value]]
+      result
+    end
+
+    # returns the id of the user that updated the record
+    def updated_by(record)
+      if @options[:updater_id].is_a?(Symbol) || @options[:updater_id].is_a?(String)
+        record.send(@options[:updater_id].to_sym)
+      elsif @options[:updater_id].is_a? Proc
+        @options[:updater_id].call(record)
+      end
+    end
+
+  end
+end

data/lib/has_history/history_entry.rb

@@ -0,0 +1,9 @@
+class HistoryEntry < ActiveRecord::Base
+  belongs_to :entity, :polymorphic => true
+
+  # modifications is an array of changes, each member is of the format:
+  #   { attribute => {:before => value_before, :after => value_after} }
+  serialize :modifications
+
+  validates_presence_of :entity, :modified_by_id
+end

data/lib/has_history/version.rb

@@ -0,0 +1,3 @@
+module HasHistory
+  VERSION = "0.1.0"
+end

data/lib/has_history.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'has_history', "version")
+require File.join(File.dirname(__FILE__), 'has_history', "history_entry")
+require File.join(File.dirname(__FILE__), 'has_history', "ar_extension")
+require File.join(File.dirname(__FILE__), 'has_history', "has_history")
+

data/test/app/models/post.rb

@@ -0,0 +1,5 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+  has_history :updater_id => Proc.new{-1},     # we don't have authentication for the test so fake it
+              :resolution_map => {:user_id => :name}
+end

data/test/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :posts
+end

data/test/db/schema.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Schema.define do
+  create_table "users", :force => true do |t|
+    t.column "name", :string
+    t.column "email", :string
+  end
+  
+  create_table "posts", :force => true do |t|
+    t.column "title", :string
+    t.column "body", :text
+    t.column "user_id", :integer
+  end
+
+  create_table "history_entries", :force => true do |t|
+    t.integer  "entity_id"
+    t.string   "entity_type"
+    t.text     "modifications"
+    t.integer  "modified_by_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+require 'lib/has_history'
+Dir['test/app/models/*.rb'].each { |f| require f }
+require 'test/unit'
+
+class ActiveSupport::TestCase
+
+  ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => ":memory:"
+  )
+  load 'test/db/schema.rb'
+  
+end

data/test/unit/has_history_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+# NB: User model is not set up for has_history, the Post model is
+
+class HasHistoryTest < ActiveSupport::TestCase
+
+  def test_ar_extension_available
+    assert_respond_to ActiveRecord::Base, :has_history, "ActiveRecord has_history extension is missing"
+  end
+
+  def test_if_models_are_valid
+    assert_nothing_raised { Post.new }
+    assert_nothing_raised { User.new }
+    assert_nothing_raised { HistoryEntry.new }
+  end
+
+  def test_no_history_case
+    user = User.create(:name => "Test User")
+    assert_not_nil user, "User not created"
+    user.email = "testuser@example.com"
+    history_count = HistoryEntry.count
+    assert user.save, "User not updated"
+    assert_equal HistoryEntry.count, history_count, "A history entry is generated when none should have been"
+  end
+
+  def test_base_case
+    history_count = HistoryEntry.count
+
+    user = User.create(:name => "Test User")
+    assert_not_nil user, "User not created"
+    post = Post.create(:title => "Test title", :body => "Test body", :user => user)
+    assert_not_nil post, "Post not created"
+    post.body = "New body"
+    assert post.save, "Post not updated"
+
+    assert_equal HistoryEntry.count, history_count+1, "History entry not generated"
+    
+    history_entry = HistoryEntry.last
+    assert_equal Post.first, history_entry.entity, "History entry points to a wrong entity"
+    assert_equal -1, history_entry.modified_by_id, "History entry does not reference the modifier properly"
+    
+    assert_equal 1, history_entry.modifications.size, "History entry modifications count is off"
+    modification = history_entry.modifications.first
+    assert modification.has_key?("body"), "History entry modifications does not contain change"
+    assert_equal "Test body", modification["body"][:before], "History entry modifications has a before value off"
+    assert_equal "New body", modification["body"][:after], "History entry modifications has an after value off"
+  end
+
+  def test_reference_resolution
+    history_count = HistoryEntry.count
+
+    user = User.create(:name => "Test User")
+    assert_not_nil user, "User not created"
+    post = Post.create(:title => "Test title", :body => "Test body", :user => user)
+    assert_not_nil post, "Post not created"
+    post.user = nil
+    assert post.save, "Post not updated"
+
+    assert_equal HistoryEntry.count, history_count+1, "History entry not generated"
+    
+    history_entry = HistoryEntry.last
+    modification = history_entry.modifications.first
+    assert modification.has_key?("user"), "History entry modifications does not contain change"
+    assert_equal "Test User", modification["user"][:before], "History entry modifications has a before value off"
+    assert_equal nil, modification["user"][:after], "History entry modifications has an after value off"
+  end
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: has_history
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- fastcatch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-29 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Adds history to ActiveRecord models.
+email: 
+- andras.zimmer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_history.gemspec
+- lib/generators/has_history/install_generator.rb
+- lib/generators/templates/has_history.rb
+- lib/has_history.rb
+- lib/has_history/ar_extension.rb
+- lib/has_history/has_history.rb
+- lib/has_history/history_entry.rb
+- lib/has_history/version.rb
+- test/app/models/post.rb
+- test/app/models/user.rb
+- test/db/schema.rb
+- test/test_helper.rb
+- test/unit/has_history_test.rb
+has_rdoc: true
+homepage: https://github.com/fastcatch/has_history
+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: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Add has_history to your ActiveRecord model and you'll instantly have access to the full history of changes of the record.
+test_files: 
+- test/app/models/post.rb
+- test/app/models/user.rb
+- test/db/schema.rb
+- test/test_helper.rb
+- test/unit/has_history_test.rb