gris 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9fe08cd20a13729cd7233e2f0bf1d3e9449073a
-  data.tar.gz: 0f9b45250044716c25debc2e7b6e49b81ebd71b3
+  metadata.gz: 4ee4df75cb4ac7a293b7f2796ab5e53b3cbb6219
+  data.tar.gz: 798bec39179c86bf2dbef41d368d6047c80081e2
 SHA512:
-  metadata.gz: f1670b79cc1848f4606dc952e13bb03027625b588679fadb628d6f424f0e335f9a0ea09b5619782467a88352e583df72e63c83729aea69c9355021f689d89d6d
-  data.tar.gz: 61cd72f59c6e5b3169ad5868139d8199114b53dcadb5bf7532c6412d289930ce2717ea1a468b0393b8d589468f8f08039e43f3cb61d189c36b3c280081bb8421
+  metadata.gz: 3f37e39acf05cc99b2ae5ca09d933adbe69a36d741897cf30cb523e2f3c940bebde14f4e14ff2571a361ba3dddead63d131c5ee568cefc12e55c07e9bb8abab9
+  data.tar.gz: 5c94ff4ce3a9c260c140b3948fdab806dbd484c0176c5f954c0a86e70b834033182a64709219325a74d26c934c25e0150813a40dbbd6f3cf6b791d43c71ad92f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gris (0.3.8)
+    gris (0.3.9)
       activesupport (~> 4.2, >= 4.2.0)
       chronic (~> 0.10.0)
       dalli (~> 2.7)
@@ -84,7 +84,7 @@ GEM
       rack-accept
       rack-mount
       virtus (>= 1.0.0)
-    grape-entity (0.4.5)
+    grape-entity (0.4.7)
       activesupport
       multi_json (>= 1.3.2)
     grape-roar (0.3.0)

data/README.md

@@ -57,13 +57,21 @@ Commands:
 You can use caching by including this module in your ActiveRecord models,
 
     class OfferEvent < ActiveRecord::Base
-      include Gris::CacheKey
+      include Gris::Caching
     end
 
 and then cache inside GET requests like this
 
     offer_event =  OfferEvent.cached_find(id)
 
+To expire the cache for an object, call
+
+    OfferEvent.expire_cache_for(id)
+
+or, if you have an instance, use
+
+    offer_event.expire_cache
+
 ### The name
 
 Gris is named for [Juan Gris](https://www.artsy.net/artist/juan-gris) (but also works in the wine-based word context of Grape and Napa). Cleverness!

data/lib/gris/caching.rb

@@ -0,0 +1,29 @@
+module Gris
+  module Caching
+    extend ActiveSupport::Concern
+
+    included do
+      def expire_cache
+        self.class.expire_cache_for(id)
+      end
+    end
+
+    class_methods do
+      def cached_find(id)
+        Gris.cache.fetch(cache_key_for(id)) do
+          find(id)
+        end
+      end
+
+      def expire_cache_for(id)
+        Gris.cache.delete(cache_key_for(id))
+      end
+
+      private
+
+      def cache_key_for(id)
+        "#{model_name.cache_key}/#{id}"
+      end
+    end
+  end
+end

data/lib/gris/version.rb

@@ -1,5 +1,5 @@
 module Gris
-  VERSION = '0.3.8'
+  VERSION = '0.3.9'
 
   class Version
     class << self

data/lib/gris.rb

@@ -12,7 +12,7 @@ require 'hashie-forbidden_attributes'
 
 # require internal files
 require 'gris/application'
-require 'gris/cache_key'
+require 'gris/caching'
 require 'gris/deprecations'
 require 'gris/grape_extensions/crud_helpers'
 require 'gris/grape_extensions/error_helpers'

data/spec/cache_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
-require 'gris/identity'
 
 describe 'Gris.cache' do
-  before(:each) do
-    @cache = Gris.cache
+  let(:cache) { Gris.cache }
+
+  it 'returns nil by default' do
+    expect(cache.read('x')).to be_nil
   end
 
-  it 'caches things' do
-    expect(@cache.read('x')).to be_nil
-    @cache.write('x', 'abc')
-    expect(@cache.read('x')).to eq('abc')
+  it 'permits writing to and retrieving from cache' do
+    cache.write('x', 'abc')
+    expect(cache.read('x')).to eq('abc')
   end
 end

data/spec/caching_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Gris::Caching' do
+  let(:id) { SecureRandom.random_number(500) }
+
+  it 'uses the cache for cached_find' do
+    foo = CachingHelper.cached_find(id)
+    expect(foo.id).to eq(id)
+    allow(Gris.cache).to receive(:fetch).and_return('cached-result')
+    expect(CachingHelper.cached_find(id)).to eq('cached-result')
+  end
+
+  it 'expires cache for a given id' do
+    allow(Gris.cache).to receive(:delete).with("cache_key_helper/#{id}")
+    CachingHelper.expire_cache_for(id)
+    expect(Gris.cache).to have_received(:delete).with("cache_key_helper/#{id}")
+  end
+
+  it 'expires cache for a given instance' do
+    allow(Gris.cache).to receive(:delete).with("cache_key_helper/#{id}")
+    instance = CachingHelper.new(id: id)
+    instance.expire_cache
+    expect(Gris.cache).to have_received(:delete).with("cache_key_helper/#{id}")
+  end
+end

data/spec/support/{cache_key_helper.rb → caching_helper.rb}

@@ -1,8 +1,8 @@
 require 'active_model'
 
-class CacheKeyHelper
+class CachingHelper
   include ActiveModel::Model
-  include Gris::CacheKey
+  include Gris::Caching
 
   attr_accessor :id
 
@@ -12,11 +12,11 @@ class CacheKeyHelper
 
   class << self
     def find(id)
-      CacheKeyHelper.new(id: id)
+      CachingHelper.new(id: id)
     end
 
     def model_name
-      CacheKeyHelper
+      CachingHelper
     end
 
     def cache_key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gris
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -329,7 +329,7 @@ files:
 - lib/gris.rb
 - lib/gris/application.rb
 - lib/gris/application/configuration.rb
-- lib/gris/cache_key.rb
+- lib/gris/caching.rb
 - lib/gris/cli.rb
 - lib/gris/deprecations.rb
 - lib/gris/deprecations/gris_setup.rb
@@ -384,8 +384,8 @@ files:
 - lib/gris/version.rb
 - lib/tasks/db.rake
 - lib/tasks/routes.rake
-- spec/cache_key_spec.rb
 - spec/cache_spec.rb
+- spec/caching_spec.rb
 - spec/generators/api_generator_spec.rb
 - spec/generators/migration_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
@@ -396,7 +396,7 @@ files:
 - spec/identity_spec.rb
 - spec/integration/token_authentication_spec.rb
 - spec/spec_helper.rb
-- spec/support/cache_key_helper.rb
+- spec/support/caching_helper.rb
 - spec/support/integration_setup.rb
 - spec/support/spec_api_auth_helper.rb
 - spec/support/spec_api_error_helper.rb
@@ -428,8 +428,8 @@ signing_key:
 specification_version: 4
 summary: A simple api microservice generator framework.
 test_files:
-- spec/cache_key_spec.rb
 - spec/cache_spec.rb
+- spec/caching_spec.rb
 - spec/generators/api_generator_spec.rb
 - spec/generators/migration_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
@@ -440,7 +440,7 @@ test_files:
 - spec/identity_spec.rb
 - spec/integration/token_authentication_spec.rb
 - spec/spec_helper.rb
-- spec/support/cache_key_helper.rb
+- spec/support/caching_helper.rb
 - spec/support/integration_setup.rb
 - spec/support/spec_api_auth_helper.rb
 - spec/support/spec_api_error_helper.rb

data/lib/gris/cache_key.rb

@@ -1,31 +0,0 @@
-module Gris
-  module CacheKey
-    extend ActiveSupport::Concern
-
-    included do
-      def cache_key
-        case
-        when new_record?
-          fail NotImplementedError
-        when timestamp = try(:updated_at)
-          timestamp = timestamp.utc.to_s(:number)
-          "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
-        else
-          "#{self.class.model_name.cache_key}/#{id}"
-        end
-      end
-    end
-
-    class_methods do
-      def cache_key_for(id)
-        "#{model_name.cache_key}/#{id}"
-      end
-
-      def cached_find(id)
-        Gris.cache.fetch(cache_key_for(id)) do
-          find(id)
-        end
-      end
-    end
-  end
-end

data/spec/cache_key_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe 'Gris::CacheKey' do
-  it 'raises an error when cache_key is called on a blank object' do
-    @foo = CacheKeyHelper.new
-    expect { @foo.cache_key }.to raise_error(NotImplementedError)
-  end
-
-  it 'returns a value for cache_key' do
-    @foo = CacheKeyHelper.new(id: SecureRandom.random_number(500))
-    expect(@foo.cache_key).to eq("cache_key_helper/#{@foo.id}")
-  end
-
-  it 'returns a value for cache_key_for' do
-    id = SecureRandom.random_number(500)
-    expect(CacheKeyHelper.cache_key_for(id)).to eq("cache_key_helper/#{id}")
-  end
-
-  it 'uses the cache for cached_find' do
-    id = SecureRandom.random_number(500)
-    foo = CacheKeyHelper.cached_find(id)
-    expect(foo.id).to eq(id)
-    allow(Gris.cache).to receive(:fetch).and_return('cached-result')
-    expect(CacheKeyHelper.cached_find(id)).to eq('cached-result')
-  end
-end