dirty_history 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Gavin Todes
+
+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,84 @@
+= Dirty History
+
+Dirty History is a simple gem that allows you to keep track of changes to specific fields in your Rails models using the ActiveRecord::Dirty module.
+                                                                                                                               
+== Installation
+
+Add dirty_history to your Gemfile:
+  
+  gem "dirty_history"
+  
+Install it using Bundler
+  
+  bundle install
+
+Generate the Dirty History migration and migrate your database
+  
+  rails generate dirty_history:migration
+  rake db:migrate
+  
+== Usage
+
+Dirty History must be set up within the ActiveRecord model (or models) you want to use. Simply call the has_dirty_history class method on your model(s), passing the attributes that you would like to track changes to.
+
+For example, assume you want to use Dirty History in your Widget model to keep track of changes to name and price fields as outlined below:
+
+  class Widget < ActiveRecord::Base
+    has_dirty_history :name, :price
+  end        
+  
+You can optionally track the creator of dirty history records by passing a creator proc that will be called when a DirtyHistoryRecord is being saved for your object.
+
+  class Widget < ActiveRecord::Base
+    has_dirty_history :name, :price, :creator => proc { User.current_user }
+  end      
+  
+  widget = Widget.last 
+  widget.name
+    # => "Box"
+  widget.name = "Heart Shaped Box"
+  widget.save 
+  widget.dirty_history_records
+    # => returns all changes to the widget
+
+  dirty_history = widget.dirty_history_records.last
+  dirty_history.old_value
+    # => "Thing"
+  dirty_history.new_value
+    # => "Heard Shaped Box"
+             
+  user   = User.find(123)
+  widget.dirty_history_records.created_by(user) 
+    # => returns all changes to the widget performed by the specified user
+  
+  class User < ActiveRecord::Base
+    creates_dirty_history
+  end    
+  
+  user = User.find(123)
+  user.dirty_history_records 
+    # => returns changes made by the specified user
+  
+Now, suppose you want to access all of a user's changes to objects of type Foo:
+
+  user = User.find(123)
+  user.dirty_history_records.for_object_type("Foo") 
+    # => returns the user's changes made only objects of type Foo
+
+# TODO: add more documentation
+
+== Contributing to Dirty History
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Gavin Todes. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "dirty_history"
+  gem.homepage = "http://github.com/GAV1N/dirty_history"
+  gem.license = "MIT"
+  gem.summary = "Easily keep track of changes to specific model fields."
+  gem.description = "Dirty History is a simple gem that allows you to keep track of changes to specific fields in your Rails models using the ActiveRecord::Dirty module."
+  gem.email = "gavin.todes@gmail.com"
+  gem.authors = ["Gavin Todes"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dirty_history #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/dirty_history.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dirty_history}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gavin Todes"]
+  s.date = %q{2011-05-01}
+  s.description = %q{Dirty History is a simple gem that allows you to keep track of changes to specific fields in your Rails models using the ActiveRecord::Dirty module.}
+  s.email = %q{gavin.todes@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "dirty_history.gemspec",
+    "init.rb",
+    "lib/dirty_history.rb",
+    "lib/dirty_history/dirty_history_mixin.rb",
+    "lib/dirty_history/dirty_history_record.rb",
+    "lib/generators/dirty_history/migration/migration_generator.rb",
+    "lib/generators/dirty_history/migration/templates/active_record/migration.rb",
+    "rails/init.rb",
+    "test/helper.rb",
+    "test/test_dirty_history.rb"
+  ]
+  s.homepage = %q{http://github.com/GAV1N/dirty_history}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Easily keep track of changes to specific model fields.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_dirty_history.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + '/rails/init')

data/lib/dirty_history.rb

@@ -0,0 +1,10 @@
+require "active_record"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "dirty_history/dirty_history_record" 
+require "dirty_history/dirty_history_mixin"  
+
+$LOAD_PATH.shift
+
+ActiveRecord::Base.send :include, DirtyHistory::Mixin

data/lib/dirty_history/dirty_history_mixin.rb

@@ -0,0 +1,92 @@
+module DirtyHistory
+  
+  module Mixin
+
+    def self.included base
+      base.class_eval do 
+        extend ClassMethods
+      end
+    end       
+
+    module ClassMethods        
+    
+      # call the dirty_history class method on models with fields that you want to track changes on.
+      # example usage:
+      # class User < ActiveRecord::Base
+      #   has_dirty_history :email, :first_name, :last_name
+      # end
+
+      # pass an optional proc to assign a creator to the dirty_history object
+      # example usage:
+      # class User < ActiveRecord::Base
+      #   has_dirty_history :email, :first_name, :last_name, :creator => proc { User.current_user }
+      # end
+  
+      def has_dirty_history *args 
+        # Mix in the module, but ensure to do so just once.
+        metaclass = (class << self; self; end)
+        return if metaclass.included_modules.include?(DirtyHistory::Mixin::ObjectInstanceMethods)
+
+        has_many        :dirty_history_records, :as => :object
+        before_save     :add_dirty_history
+        cattr_accessor  :dirty_history_columns
+
+        self.dirty_history_columns ||= []
+    
+        if args.present?
+          args.each do |arg| 
+            if [String,Symbol].include?(arg.class)     
+              arg = arg.to_sym
+              self.dirty_history_columns << arg unless self.dirty_history_columns.include?(arg)
+            elsif arg.is_a?(Hash)                      
+              creator_proc = arg.delete(:creator)
+              send :define_method, "creator_for_dirty_history" do 
+                begin
+                  creator_proc.is_a?(Proc) ? creator_proc.call : nil
+                rescue
+                  nil
+                end
+              end
+            end
+          end
+          include DirtyHistory::Mixin::ObjectInstanceMethods
+        end
+      end # has_dirty_history
+  
+      def creates_dirty_history 
+        # Mix in the module, but ensure to do so just once.
+        metaclass = (class << self; self; end)
+        return if metaclass.included_modules.include?(DirtyHistory::Mixin::CreatorInstanceMethods)
+      
+        has_many        :dirty_history_records, :as => :creator
+        include DirtyHistory::Mixin::CreatorInstanceMethods
+      end # creates_dirty_history
+    end # ClassMethods
+
+    module ObjectInstanceMethods
+      def add_dirty_history 
+        return true unless self.changed?                                               
+        new_dirty_history = self.class.dirty_history_columns.inject({}) { |changes_hash, col| 
+          changes_hash[col] = self.send("#{col}_change") if self.send("#{col}_changed?")
+          changes_hash
+        }
+        new_dirty_history.map { |col,vals| 
+          DirtyHistoryRecord.new  :creator      => (self.creator_for_dirty_history rescue nil),
+                                  :column_name  => col,
+                                  :column_type  => self.class.columns_hash[col.to_s].type,
+                                  :old_value    => vals[0],
+                                  :new_value    => vals[1]
+        }.each { |dirty_history_record| self.dirty_history_records << dirty_history_record }
+      end    
+    end # ObjectInstanceMethods
+
+    module CreatorInstanceMethods
+  
+    end # CreatorInstanceMethods
+
+  end # Mixin
+  
+end  # DirtyHistory
+
+
+ActiveRecord::Base.send :include, DirtyHistory::Mixin

data/lib/dirty_history/dirty_history_record.rb

@@ -0,0 +1,38 @@
+class DirtyHistoryRecord < ActiveRecord::Base   
+  belongs_to :creator,  :polymorphic => true
+  belongs_to :object,   :polymorphic => true
+  validates_presence_of :object_type, :object_id, :column_name, :column_type, :old_value, :new_value
+  
+  scope :created_by,      lambda { |creator| where(:creator_id => creator.id, :creator_type => creator.class.name) }
+  scope :for_object_type, lambda { |object_type| where(:object_type => object_type.to_s.classify) }
+    
+  [:new_value, :old_value].each do |attribute|
+    define_method "#{attribute}" do 
+      val_to_col_type(attribute)
+    end
+    define_method "#{attribute}=" do |val|
+      self[attribute] = val.to_s
+      instance_variable_set "@#{attribute}", val
+    end
+  end 
+  
+  private
+  
+  def val_to_col_type attribute
+    val_as_string = self[attribute]
+    return nil if val_as_string.nil?
+    case self[:column_type].to_sym
+    when :integer, :boolean
+      val_as_string.to_i
+    when :decimal, :float
+      val_as_string.to_f
+    when :datetime
+      Time.parse val_as_string
+    when :date
+      Date.parse val_as_string
+    else # :string, :text
+      val_as_string
+    end
+  end
+  
+end

data/lib/generators/dirty_history/migration/migration_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/migration'
+
+module DirtyHistory
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for DirtyHistoryRecord model"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+    
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/create_dirty_history_records'
+      end
+    end
+  end
+end
+

data/lib/generators/dirty_history/migration/templates/active_record/migration.rb

@@ -0,0 +1,20 @@
+class CreateDirtyHistoryRecords < ActiveRecord::Migration
+  def self.up
+    create_table :dirty_history_records do |t|                                           
+      t.references :creator,  :polymorphic => true # creates creator_type and creator_id field
+      t.references :object,   :polymorphic => true # creates object_type and object_id field            
+      t.string     :column_name, :length => 64
+      t.string     :column_type, :length => 16 # :string, :text, :integer, :decimal, :float, :datetime, :boolean
+      t.text       :old_value
+      t.text       :new_value
+    
+      t.datetime   :created_at
+    end
+    add_index :dirty_history_records, [:creator_id, :creator_type]
+    add_index :dirty_history_records, [:object_id,  :object_type]
+  end
+
+  def self.down
+    drop_table :dirty_history_records
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'dirty_history'                      

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dirty_history'
+
+class Test::Unit::TestCase
+end

data/test/test_dirty_history.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDirtyHistory < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: dirty_history
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Gavin Todes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-01 00:00:00.000000000 %:z
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2152602180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152602180
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152690100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152690100
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152883280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *2152883280
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2153025260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153025260
+description: Dirty History is a simple gem that allows you to keep track of changes
+  to specific fields in your Rails models using the ActiveRecord::Dirty module.
+email: gavin.todes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- dirty_history.gemspec
+- init.rb
+- lib/dirty_history.rb
+- lib/dirty_history/dirty_history_mixin.rb
+- lib/dirty_history/dirty_history_record.rb
+- lib/generators/dirty_history/migration/migration_generator.rb
+- lib/generators/dirty_history/migration/templates/active_record/migration.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_dirty_history.rb
+has_rdoc: true
+homepage: http://github.com/GAV1N/dirty_history
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3022031599709161522
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easily keep track of changes to specific model fields.
+test_files:
+- test/helper.rb
+- test/test_dirty_history.rb