redcrumbs 0.2.5 → 0.3.0

data/README.md

@@ -137,6 +137,32 @@ end
 
 It's not best practice but since the emphasis is on easing the load on our main database we have bent a few rules in order to reduce the calls on the database to, ideally, zero. In any given app you may be tracking several models and this results in a lot of SQL we could do without.
 
+#### Versions >= 0.3.0
+
+`redcrumbed` accepts a `:store` option to which you can pass a hash of options similar to that of the ActiveRecord `as_json` method. These are attributes of the subject that you'd like to store on the crumb object itself. Use it sparingly if you know that, for example, you are only ever going to really use a couple of attributes of the subject and you want to avoid loading the whole thing from the database.
+
+Examples:
+
+```
+class Venue
+  redcrumbed :only => [:name, :latlng], :store => {:only => [:id, :name]}
+end
+```
+
+```
+class Venue
+  redcrumbed :only => [:name, :latlng], :store => {:except => [:updated_at, :created_at]}
+end
+```
+
+```
+class Venue
+  redcrumbed :only => [:name, :latlng], :store => {:only => [:id, :name], :methods => [:checkins]}
+end
+```
+
+#### Versions  < 0.3.0
+
 `redcrumbed` accepts a `:store` option to which you can pass an array of attributes of the subject that you'd like to store on the crumb object itself. Use it sparingly if you know that, for example, you are only ever going to really use a couple of attributes of the subject and you want to avoid loading the whole thing from the database.
 
 ```
@@ -145,7 +171,13 @@ class Venue
 end
 ```
 
-So now if you call `crumb.subject` instead of loading the Venue from your database it will instantiate a new Venue with the same `id` and `name` attributes. You can always retrieve the original by calling `crumb.full_subject`.
+#### Using the stored object
+
+So now if you call `crumb.subject` instead of loading the Venue from your database it will instantiate a new Venue with the only the attributes you have stored. You can always retrieve the original by calling `crumb.full_subject`.
+
+_ If you plan to use the `methods` option to store data on the Crumb you should only use it to store attr_accessors unless you won't be instantiating the subject itself _
+
+#### Creator and Target storage
 
 As you might expect, you can also do this for the creator and target of the crumb. See the redcrumbs.rb initializer for how to set this as a global configuration.
 

data/app/models/redcrumbs/crumb/setters.rb

@@ -4,7 +4,7 @@ module Redcrumbs
     
     def subject=(subject)
       self._subject = subject
-      self.stored_subject = subject.storeable_attributes
+      self.stored_subject = subject.storeable_attributes_and_method_attributes
       self.subject_type = subject.class.to_s
       self.subject_id = subject.id
     end

data/lib/redcrumbs/creation.rb

@@ -12,7 +12,30 @@ module Redcrumbs
       end
 
       def storeable_attributes
-        attributes.reject {|k,v| !self.class.redcrumbs_options[:store].include?(k.to_sym)}
+        store = self.class.redcrumbs_options[:store]
+        if store.has_key?(:only)
+          attributes.reject {|k,v| !store[:only].include?(k.to_sym)}
+        elsif store.has_key?(:except)
+          attributes.reject {|k,v| store[:except].include?(k.to_sym)}
+        else
+          {}
+        end
+      end
+      
+      def attributes_from_storeable_methods
+        store = self.class.redcrumbs_options[:store]
+        if store.has_key?(:methods)
+          # get the methods that actually exist on the model
+          methods = methods_from_array(store[:methods])
+          # inject them into a hash with their outcomes as values
+          methods.inject({}) {|h,a| h.merge(a => send(a))}
+        else
+          {}
+        end
+      end
+      
+      def storeable_attributes_and_method_attributes
+        storeable_attributes.merge(attributes_from_storeable_methods)
       end
       
       def create_crumb
@@ -24,6 +47,12 @@ module Redcrumbs
       def notify_changes
         create_crumb unless watched_changes.empty?
       end
+      
+      private
+      
+      def methods_from_array(array)
+        self.class.instance_methods.select {|method| array.include?(method.to_sym)}
+      end
     end
   end
 end

data/lib/redcrumbs/options.rb

@@ -14,7 +14,7 @@ module Redcrumbs
         options.reverse_merge!(defaults)
         
         options[:only] = Array(options[:only])
-        options[:store] = Array(options[:store])
+        options[:store] = options[:store]
         
         class_attribute :redcrumbs_options
         class_attribute :redcrumbs_callback_options

data/lib/redcrumbs/version.rb

@@ -1,3 +1,3 @@
 module Redcrumbs
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 +01:00
+date: 2012-09-11 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_mapper
-  requirement: &2156957200 !ruby/object:Gem::Requirement
+  requirement: &2152134000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156957200
+  version_requirements: *2152134000
 - !ruby/object:Gem::Dependency
   name: dm-redis-adapter
-  requirement: &2156956660 !ruby/object:Gem::Requirement
+  requirement: &2152133500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: 0.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156956660
+  version_requirements: *2152133500
 description: Fast and unobtrusive activity tracking of ActiveRecord models using DataMapper
   and Redis
 email: