mimeo 0.0.5 → 0.0.6

data/README.md

@@ -1,11 +1,14 @@
 # Mimeo
 
-This lets you easily call your Ohm model's save from within your Rails models after_save.
+This is a gem to let you easily access your Ohm models from within your Rails models after_save.
 
 It creates an after_save callback insider your ActiveRecord model. The callback finds the matching Redis record and updates it with the content of the AR instance.
 If a matching record is not found, a new one is created and saved.
 
 All accessible attributes (attr_accessible) are used to populate the Redis record. There should be a one-to-one correspondence between the Rails and the Redis attribute names.
+If :field_map is specified in the options, then only those in the field_map hash are used to populate the Redis record.
+
+It also adds an ohm_instance convenience method into the ActiveRecord instance.
 
 ## Installation
 
@@ -29,11 +32,25 @@ Inside your ActiveRecord model, add:
 
 where ModelName is the name of your Ohm model.
 
+If you want to customize the field mapping:
+
+    ohm_model <ModelName>,
+      field_map: {
+        active_record_attr1: :ohm_model_attr1,
+        active_record_attr2: :ohm_model_attr2
+        ...
+      }
+
 Inside your Ohm model, add:
 
     attribute :rails_id, Type::Integer
     index :rails_id
 
+Once setup, your ActiveRecord model instances have access to the corresponding Ohm record, like so:
+
+    user = User.find(1)
+    puts user.ohm_instance.ohm_instance_attribute
+
 ## Contributing
 
 1. Fork it

data/lib/mimeo/version.rb

@@ -1,3 +1,3 @@
 module Mimeo
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/mimeo.rb

@@ -32,7 +32,7 @@ module Mimeo
       return true
     end
 
-    def get_redis_record
+    def ohm_instance
       ohm_model_class.find(rails_id: self.id).first || ohm_model_class.new
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mimeo
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies: []
 description: ActiveRecord extension for saving data to Redis using a given Ohm model.
 email: