track_history 0.0.1

data/lib/track_history.rb

@@ -0,0 +1,109 @@
+module TrackHistory
+
+  autoload :VERSION, File.join(File.dirname(__FILE__), 'track_history', 'version')
+  require 'active_record'
+
+  def self.install
+    ActiveRecord::Base.send(:include, self)
+  end
+
+  def self.included(base)
+    base.extend ActsAsMethods
+    base.send(:include, InstanceMethods)
+  end
+
+  module ActsAsMethods
+
+    # Make a model historical
+    # Takes a hash of options, which can only be :model_name to force a different model name
+    # Default model name is ModelHistory
+    def track_history(options = {})
+      @historical_fields = []
+      @historical_tracks = {}
+      define_historical_model(self, options[:model_name])
+      yield if block_given?
+    end
+
+    def annotate(field, &block) # haha
+      @historical_tracks ||= []
+      @historical_tracks[field] = block
+      unless @klass_reference.columns_hash.has_key?(field.is_a?(Symbol) ? field.to_s : field) 
+        raise ActiveRecord::StatementInvalid.new("No such attribute '#{field}' on #{@klass_reference.name}")
+      end
+    end
+
+    def historical_fields
+      @historical_fields
+    end
+
+    def historical_tracks
+      @historical_tracks
+    end
+
+    private
+
+    def define_historical_model(base, class_name)
+
+      class_name ||= "#{base.name}History"
+      klass = Object.const_set(class_name, Class.new(ActiveRecord::Base))
+      @klass_reference = klass
+     
+      # infer fields
+      klass.columns_hash.each_key do |k| 
+        matches = k.match(/(.+?)_before$/)
+        if matches && matches.size == 2 && field_name = matches[1]
+          @historical_fields << field_name if klass.columns_hash.has_key?("#{field_name}_after")
+        end
+      end
+     
+      # create the history class
+      rel = base.name.singularize.underscore.downcase.to_sym
+      klass.belongs_to rel
+      klass.send(:alias_method, :historical_relation, rel)
+      klass.send(:include, HistoricalHelpers)
+
+      # tell the other class about us
+      # purposely don't define these until after getting historical_fields
+      has_many :histories, :class_name => class_name, :order => 'created_at desc'
+      before_save :record_historical_changes
+
+    end
+
+  end
+
+  module HistoricalHelpers
+
+    # Get a list of the modifications in a given history
+    def modifications
+      historical_relation.class.historical_fields.reject do |field|
+        send(:"#{field}_before") == send(:"#{field}_after")
+      end
+    end
+
+  end
+
+  module InstanceMethods
+
+    private
+
+    def record_historical_changes
+      return if self.class.historical_fields.empty?
+      # go through each and build the hashes
+      attributes = {}
+      self.class.historical_fields.each do |field|
+        next unless send(:"#{field}_changed?")
+        attributes.merge! :"#{field}_before" => send(:"#{field}_was"), :"#{field}_after" => send(field.to_sym)
+      end
+      return if attributes.empty? # nothing changed - skip out 
+      # then go through each track
+      self.class.historical_tracks.each do |field, block|
+        attributes[field] = block.nil? ? send(field) : (block.arity == 1 ? block.call(self) : instance_eval(&block)) # give access to the user object
+      end
+      self.histories.create(attributes)
+    end
+
+  end
+
+end
+
+TrackHistory::install

data/lib/track_history/version.rb

@@ -0,0 +1,5 @@
+module TrackHistory
+
+  VERSION = '0.0.1'
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: track_history
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Crepezzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Smart, performant model auditing
+email: john.crepezzi@patch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/track_history/version.rb
+- lib/track_history.rb
+has_rdoc: true
+homepage: http://github.com/seejohnrun/historical
+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: historical
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Smart model auditing
+test_files: []
+