cache-object 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3312382f303270f6529c1b4c4ff709bfc987dd79
-  data.tar.gz: aae75915fd361af70fa6dcd89c7907dd69e08ebd
+  metadata.gz: 1485233396171f659819ed221040368678fbe00e
+  data.tar.gz: d7fdcd4e545b9a80d89118f3b2e5869f53951802
 SHA512:
-  metadata.gz: 23a1990e9456e0e4b5b16134933e2579990757cb7863ff4d75bab0181604e734534a17afc98d25e1ceab77e0cacacbe369348857107fee4114c09bff7ad4faa0
-  data.tar.gz: 4ba38810903f4ebd84202ca4a09da7d34682e07ce4e18babb2fc62a3365ad6293d2b76220704ce2bdd776f7fe5b924d76784ea68a229cf2d068cdaa9217f1929
+  metadata.gz: 7dd097dcc97365356c283c40237a74e4252689c0899ca6ce05887245ae3f803d369a15ff6d474e8a2bc92048052d263557111c9a8651486f2549ebdcc381f6a3
+  data.tar.gz: 8119eef50f1435f73f3c838ac92a16a18d3cf31709803ee0fc3b66b00c536848dfb41f5d9fb19a594b95a019279a3417c7a3c5d251481620b028bd43a4861243

data/README.md

@@ -1,6 +1,6 @@
 # Cache::Object
 
-TODO: Write a gem description
+Cache ActiveRecord objects in memcached!
 
 ## Installation
 
@@ -18,7 +18,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add a Rails initializer, for instance at `config/initializers/cache-object.rb` 
+
+```ruby
+# Use the Rails cache.
+Cache::Object.configure do |c|
+  c.cache = Rails.cache
+end
+
+# Use an arbitrary Dalli connection in your environment.
+Cache::Object.configure do |c|
+  hosts = Array(Settings.caching.memcached.hosts).clone
+  hosts << {namespace: 'my.namespace',
+            expires_in: 1.day,
+            compress: true,
+            keepalive: true,
+            socket_timeout: Settings.caching.memcached.socket_timeout}
+
+  c.cache = ActiveSupport::Cache::DalliStore.new(hosts)
+end
+```
+
+Include the `Cache::Object::ActiveRecord` module into your model. When a record is saved, its attributes will be
+marshalled into the cache.
+
+```ruby
+class User < ActiveRecord::Base
+  include Cache::Object::ActiveRecord
+end
+```
+
+By default the record is cached by the primary id. If another key should be used, `object_cache_on` can be used:
+
+```ruby
+class User < ActiveRecord::Base
+  include Cache::Object::ActiveRecord
+  object_cache_on :username
+end
+```
+
+If instance variables that are not ActiveRecord attributes need to be cached, `object_cache_include` can be used:
+
+```ruby
+class User < ActiveRecord::Base
+  include Cache::Object::ActiveRecord
+  object_cache_include :shoe_size
+  
+  attr_accessor :shoe_size
+end
+```
+
 
 ## Contributing
 

data/cache-object.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 3.0"
+  spec.add_dependency "activerecord", [">= 3.0", "< 4.2"]
   spec.add_dependency "ruby-usdt"
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/lib/cache/object/active_record.rb

@@ -11,6 +11,10 @@ module Cache
             @_object_cache_attr_mappings ||= []
           end
 
+          def _object_cache_include
+            @_object_cache_include ||= []
+          end
+
           after_destroy :expire_cache!
           after_save :write_cache!
           after_rollback :expire_cache!
@@ -18,10 +22,19 @@ module Cache
       end
 
       def _dump(level = 0)
-        Marshal.dump(attributes)
+        additional_attributes = {}.tap do |h|
+          self.class._object_cache_include.flatten.each do |key|
+            h[key.to_s] = self.send(key)
+          end
+        end
+        Marshal.dump(attributes.merge(additional_attributes))
       end
 
       def load_from_cache(attributes)
+        self.class._object_cache_include.flatten.each do |key|
+          send("#{key}=", attributes.delete(key.to_s))
+        end
+
         @attributes = self.class.initialize_attributes(attributes)
         @relation = nil
 
@@ -74,6 +87,10 @@ module Cache
           Cache::Object::MultiGet.new(self).fetch_all(ids)
         end
 
+        def object_cache_include(*accessors)
+          self._object_cache_include << accessors
+        end
+
         def object_cache_on(*attrs)
           self._object_cache_attr_mappings << attrs
           define_singleton_method("find_by_#{attrs.join('_and_')}") do |*args|

data/lib/cache/object/version.rb

@@ -1,5 +1,5 @@
 module Cache
   module Object
-    VERSION = "0.0.7"
+    VERSION = "0.1.0"
   end
 end

data/spec/features/cache_object_spec.rb

@@ -108,5 +108,13 @@ RSpec.describe "Caching" do
     end
   end
 
+  describe "object_cache_include" do
+    it "has expected additional attribute" do
+      user.shoe_size = '14'
+      user.write_cache!
+
+      expect(User.find(user.id).shoe_size).to eq('14')
+    end
+  end
 
 end

data/spec/support/models.rb

@@ -40,6 +40,9 @@ end
 class User < ActiveRecord::Base
   include Cache::Object::ActiveRecord
 
+  object_cache_include :shoe_size
+  attr_accessor :shoe_size
+
   object_cache_on :name, :age
 
   after_save :asplode_if_name_is_asplode

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache-object
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Camuto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: ruby-usdt
   requirement: !ruby/object:Gem::Requirement
@@ -213,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Object R/W Caching
@@ -227,4 +233,3 @@ test_files:
 - spec/features/cache_object_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-has_rdoc: