historyable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODVjM2I0MTUxOTZjM2FiNTUwNGNkNDU2ZjUyNDg5M2Y3MmM3YTMzZQ==
+    YTM5ODJlNzZkMzQ0YzUyZGRhNDUzMzM4MjhhZTIwODRiMGUzMmM0Yg==
   data.tar.gz: !binary |-
-    ZTRlMDEwMDBhNmYyZGQ5MmE2OTI3MTVkOTdhYmNkY2YyMWZkODdkYg==
+    YTE5MWRmNWJhNGUyNDhmYzBkYjNjMTNmZjRkZDA0ZjlmYmQzNjBiOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWM1NjE2OGQwMjlkNDkyNmRjZTljOTQ5N2IyOTdlNTFjMjM3YjA2MThkNjg1
-    NjUxYmNiNTYzY2M3NmViMGYxNjk2NDZhNjJhMTBkZTBiZmE4ZWU5NGVmNjIx
-    NGJhZjFjYjNhZWI4MjBhYjg4ZWE2M2Y5Nzk0NjdlMTk2NzMxNTQ=
+    ZWYzNDQ2NTMyYjc1OWVhODJhZmUxMjg5NGQ1ZWQzMDllY2JiN2M0ZTdiYmJk
+    YThhODc1NjFhNmU4YjJmMzQwOWJkNzQ1ODUyNjI1ODVmMjdiN2MxOGMzOTBi
+    NGM5NmVlMzRmNGFlZTFjN2UyZGYxYWM4YTRkYjQyNjE5OTY2MDU=
   data.tar.gz: !binary |-
-    NWQzMjJmZDkzZTJmZWQxMWY0MmY5NDBjNmRjMTI0ZTBlMTBiNzUzODRjMWM0
-    YmRmNTk1ZTY1NWNhNWI0ZWY4MDVhODE5YzBiMjJlYTYxZjNhZDU4NTc2ZmRm
-    MTdhM2FiNDFjOGFmN2ExOTc4NTk0ZDc3NDg4MGVlMmIzYTgyYjY=
+    NmMyYjg2NWI2ZGM4ZjU1MDk2ODhhN2VkZmNjNGJiMzQzOTRlNzdkYzMzYzI1
+    Y2ZhMzY1NmE3ODljZDE5OWVkYjFiMmNiOTJkMDkxMTBiOGIzOTU5ZWNmZGM1
+    M2YyMWQxNzNhYTE3ZWM1MWJhZWY0ODNkMzZkODZmZDE3ODE5MjQ=

data/lib/historyable.rb

@@ -4,7 +4,7 @@ require "active_record"
 require "historyable/change"
 
 module Historyable
-  class Item < Struct.new(:attribute, :association_name); end
+  class Item < Struct.new(:attribute_name, :association_name); end
 
   extend ActiveSupport::Concern
 
@@ -18,10 +18,10 @@ module Historyable
     # @param attributes [Array, Symbol]
     def has_history(*attributes)
       self.historyable_items = attributes.map do |attribute|
-        attribute        = attribute.to_sym
+        attribute_name   = attribute.to_sym
         association_name = attribute.to_s.insert(-1, '_changes').to_sym
 
-        Historyable::Item.new(attribute, association_name)
+        Historyable::Item.new(attribute_name, association_name)
       end
 
       # Associations
@@ -38,10 +38,14 @@ module Historyable
 
         # attribute_history_raw
         #
+        # @example
+        #
+        #   @user.name_history_raw
+        #
         # @return [ActiveRecord::Relation]
-        define_method("#{historyable.attribute.to_s}_history_raw") do
+        define_method("#{historyable.attribute_name.to_s}_history_raw") do
           send(historyable.association_name)
-            .where(object_attribute: historyable.attribute)
+            .where(object_attribute: historyable.attribute_name)
             .order('created_at DESC')
             .select(:object_attribute_value, :created_at)
         end
@@ -49,12 +53,16 @@ module Historyable
 
         # attribute_history
         #
+        # @example
+        #
+        #   @user.name_history
+        #
         # @return [Array]
-        define_method("#{historyable.attribute.to_s}_history") do
-          unless instance_variable_get("@#{historyable.attribute.to_s}_history".to_sym)
+        define_method("#{historyable.attribute_name.to_s}_history") do
+          unless instance_variable_get("@#{historyable.attribute_name.to_s}_history".to_sym)
             array = []
 
-            records = send("#{historyable.attribute}_history_raw")
+            records = send("#{historyable.attribute_name}_history_raw")
                          .pluck(:object_attribute_value, :created_at)
             records.map do |attribute_value, created_at|
               hash = HashWithIndifferentAccess.new
@@ -65,12 +73,23 @@ module Historyable
             end
 
             # Sets attribute_history cache
-            instance_variable_set("@#{historyable.attribute.to_s}_history".to_sym, array)
+            instance_variable_set("@#{historyable.attribute_name.to_s}_history".to_sym, array)
             array
           else
-            instance_variable_get("@#{historyable.attribute.to_s}_history".to_sym)
+            instance_variable_get("@#{historyable.attribute_name.to_s}_history".to_sym)
           end
         end
+
+        # attribute_history?
+        #
+        # @example
+        #
+        #   @user.name_history?
+        #
+        # @return [Boolean]
+        define_method("#{historyable.attribute_name.to_s}_history?") do
+          send("#{historyable.attribute_name}_history_raw").any?
+        end
       end
 
 
@@ -85,16 +104,16 @@ module Historyable
   # Creates a Change record when an attribute marked as 'historyable' changes
   def save_changes
     changed_historyable_items = historyable_items.select do |historyable|
-      changed.include?(historyable.attribute.to_s)
+      changed.include?(historyable.attribute_name.to_s)
     end
 
     yield # saves the records
 
     changed_historyable_items.each do |historyable|
-      send(historyable.association_name).create(object_attribute: historyable.attribute,
-                                                object_attribute_value: send(historyable.attribute))
+      send(historyable.association_name).create(object_attribute: historyable.attribute_name,
+                                                object_attribute_value: send(historyable.attribute_name))
       # Expires attribute_history cache
-      instance_variable_set("@#{historyable.attribute.to_s}_history".to_sym, nil)
+      instance_variable_set("@#{historyable.attribute_name.to_s}_history".to_sym, nil)
     end
 
     true

data/lib/historyable/version.rb

@@ -1,3 +1,3 @@
 module Historyable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: historyable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Philippe Dionne
@@ -38,7 +38,7 @@ cert_chain:
   aW9OckllMC8xNWRIcERvSUVESUxhNnpVNDZCClhEdHAxWXhkZVZHSUJ1Tm9Q
   MXZqRFN2TktZajBwTWpSQUVQcnFLMzlqS0U9Ci0tLS0tRU5EIENFUlRJRklD
   QVRFLS0tLS0K
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false