track_history 0.0.9 → 0.0.10

data/lib/track_history/historical_relation_helpers.rb

@@ -0,0 +1,17 @@
+module HistoricalRelationHelpers
+
+  # Get a list of the modifications in a given history
+  def modifications
+    self.class.historical_fields.reject do |field, options|
+      send(options[:before]) == send(options[:after])
+    end.keys
+  end
+
+  def to_s
+    return 'modified nothing' if modifications.empty?
+    str = 'modified ' + modifications.sort.join(', ')
+    str += " on #{historical_relation}" if self.class.instance_variable_get(:@track_historical_reference)
+    str
+  end
+
+end

data/lib/track_history/history_methods.rb

@@ -0,0 +1,38 @@
+module HistoryMethods
+
+  attr_reader :historical_fields, :historical_action_field
+
+  def track_historical_reference?
+    @track_historical_reference
+  end
+
+  def historical_fields
+    @historical_fields ||= {}
+  end
+
+  def historical_tracks
+    @historical_tracks ||= {}
+  end
+
+  def field(field, options = {})
+    options.assert_valid_keys(:before, :after)
+    field_s = field.is_a?(String) ? field : field.to_s
+    historical_fields[field_s] = { 
+      :before => options[:before] || nil,
+      :after => options[:after] || nil
+    }
+    nil
+  end
+
+  def annotate(field, options = {}, &block) # haha
+    options.assert_valid_keys(:as)
+    save_as = options.has_key?(:as) ? options[:as] : field
+
+    unless columns_hash.has_key?(save_as.to_s)
+      raise ActiveRecord::StatementInvalid.new("No such attribute '#{save_as}' on #{self.name}")
+    end
+
+    historical_tracks[save_as] = block.nil? ? field : block
+  end
+
+end

data/lib/track_history/version.rb

@@ -1,5 +1,5 @@
 module TrackHistory
 
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 
 end

data/lib/track_history.rb

@@ -1,13 +1,24 @@
 module TrackHistory
 
-  autoload :VERSION, File.join(File.dirname(__FILE__), 'track_history', 'version')
   require 'rubygems'
   require 'active_record'
 
+  autoload :VERSION, 'track_history/version'
+  autoload :HistoryMethods, 'track_history/history_methods'
+  autoload :HistoricalRelationHelpers, 'track_history/historical_relation_helpers'
+
   def self.install
     ActiveRecord::Base.send(:include, self)
   end
 
+  def self.warnings_disabled?
+    @warnings_disabled ||= false
+  end
+
+  def self.disable_warnings
+    @warnings_disabled = true
+  end
+
   def self.included(base)
     base.extend ActsAsMethods
     base.send(:include, InstanceMethods)
@@ -37,28 +48,28 @@ module TrackHistory
       @klass_reference.send(:table_name=, table_name) unless table_name.nil?
 
       unless @klass_reference.table_exists?
-        STDERR.puts "[TrackHistory] No such table exists: #{@klass_reference.table_name}"
+        $stderr.puts "[TrackHistory] No such table exists: #{@klass_reference.table_name} - #{self.name} history will not be tracked" unless TrackHistory.warnings_disabled?
         return
       end
  
       # get the history class in line
       @klass_reference.send(:extend, HistoryMethods)
+ 
+      # figure out the field for tracking action (enum)
+      @klass_reference.instance_variable_set(:@historical_action_field, @klass_reference.columns_hash.has_key?('action') ? 'action' : nil)
+      @klass_reference.instance_variable_set(:@track_historical_reference, track_reference) 
+
+      # allow other things to be specified
+      @klass_reference.module_eval(&block) if block_given?
 
       # infer fields
       @klass_reference.columns_hash.each_key do |k| 
         matches = k.match(/(.+?)_before$/)
         if matches && matches.size == 2 && field_name = matches[1]
-          next if @klass_reference.historical_fields.has_key?(field_name) # override inferrences
+          next if @klass_reference.historical_fields.has_key?(field_name) || @klass_reference.historical_tracks.has_key?(field_name) # override inferrences
           @klass_reference.historical_fields[field_name] = { :before => "#{field_name}_before".to_sym, :after => "#{field_name}_after".to_sym }
         end
       end
- 
-      # figure out the field for tracking action (enum)
-      @klass_reference.instance_variable_set(:@historical_action_field, @klass_reference.columns_hash.has_key?('action') ? 'action' : nil)
-      @klass_reference.instance_variable_set(:@track_historical_reference, track_reference) 
-
-      # allow other things to be specified
-      @klass_reference.module_eval(&block) if block_given?
       
       # create the history class
       rel = base.name.singularize.underscore.downcase.to_sym
@@ -85,62 +96,6 @@ module TrackHistory
 
   end
 
-  module HistoryMethods
-
-    attr_reader :historical_fields, :historical_action_field
-
-    def track_historical_reference?
-      @track_historical_reference
-    end
-
-    def historical_fields
-      @historical_fields ||= {}
-    end
-
-    def historical_tracks
-      @historical_tracks ||= {}
-    end
-
-    def field(field, options = {})
-      field_s = field.is_a?(String) ? field : field.to_s
-      historical_fields[field_s] = { 
-        :before => options[:before] || "#{field}_before".to_sym,
-        :after => options[:after] || "#{field}_after".to_sym
-      }
-      nil
-    end
-
-    def annotate(field, options = {}, &block) # haha
-      options.assert_valid_keys(:as)
-      save_as = options.has_key?(:as) ? options[:as] : field
-
-      unless columns_hash.has_key?(save_as.to_s)
-        raise ActiveRecord::StatementInvalid.new("No such attribute '#{field}' on #{@klass_reference.name}")
-      end
-
-      historical_tracks[save_as] = block.nil? ? field : block
-    end
-
-  end
-
-  module HistoricalRelationHelpers
-
-    # Get a list of the modifications in a given history
-    def modifications
-      self.class.historical_fields.reject do |field, options|
-        send(options[:before]) == send(options[:after])
-      end.keys
-    end
-
-    def to_s
-      return 'modified nothing' if modifications.empty?
-      str = 'modified ' + modifications.sort.join(', ')
-      str += " on #{historical_relation}" if self.class.instance_variable_get(:@track_historical_reference)
-      str
-    end
-
-  end
-
   module InstanceMethods
 
     private
@@ -153,8 +108,8 @@ module TrackHistory
       attributes = {}
       historical_fields.each do |field, field_options|
         next if !send(:"#{field}_changed?") && action == 'update'
-        after_value = action == 'destroy' ? nil : send(field.to_sym) # special tracking on deletions
-        attributes.merge! field_options[:before] => send(:"#{field}_was"), field_options[:after] => after_value
+        attributes[field_options[:after]] = (action == 'destroy' ? nil : send(field.to_sym)) if field_options[:after] # special tracking on deletions
+        attributes[field_options[:before]]  = send(:"#{field}_was") if field_options[:before]
       end
       return if attributes.empty? && action == 'update' # nothing changed - skip out 
       # then go through each track

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: track_history
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - John Crepezzi
@@ -55,6 +55,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/track_history/historical_relation_helpers.rb
+- lib/track_history/history_methods.rb
 - lib/track_history/version.rb
 - lib/track_history.rb
 has_rdoc: true