rails-cache-extended 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDA5YzJjYjBhZjFmOGIyZmNhNmM2YzM2YWE2ZjcyMWFiMTQ0YzI2NA==
+  data.tar.gz: !binary |-
+    ZjNhMTgxY2UzYTA3MzdlNjhkZjlmNmFmMTMzMjU2M2YyZWRkNzJiYw==
+SHA512:
+  metadata.gz: !binary |-
+    MTRkYzMzZGZmZWZlYWQ4ODJiZmI1YzQ3ZGQyZDYxNWE2ODQ0ZTkyNGQyNjY2
+    NjI1MjhiY2Q2NzQyMmEzOGQ3NjY4MTcxYmZlZWMyMWU5MGNlN2JmMTE5YWEx
+    YWYwN2IxMjFjMGMzMmQ0Y2M2Nzk5OTUxNDQ5YWZmNTYyMzY1YTg=
+  data.tar.gz: !binary |-
+    ZWI5N2ViNjdjZDUzNThhNTgyNDU3MzNkMDM1YmZmMWMzMThiYWNlNTc0ZDA5
+    OTc3ZmY2ZTEzNDFjNTdjZTI0MGZkNzE3MzNlMzY1NjkwZTZhNDdlYWFhNzhi
+    ZDU5NTBlMzY2ODA4NjIxMjc2MDQxZjYwOGUwNzc1ZjlhNjkzN2U=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 telzamek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Rails::Cache::Extended
+
+This allows to generate an auto-expiring cache key for a collection of records
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-cache-extended'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-cache-extended
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/rails-cache-extended.rb

@@ -0,0 +1,3 @@
+require 'rails/cache/extended'
+require 'rails/cache/logging'
+require 'rails/cache/version'

data/lib/rails/cache/extended.rb

@@ -0,0 +1,10 @@
+require 'rails/cache/version'
+
+  module ActiveRecord
+    class Base
+      def self.cache_key
+        Digest::MD5.hexdigest "#{scoped.maximum(:updated_at).try(:to_i)}-#{scoped.count}"
+        #scoped.select("md5(COALESCE(date_part('epoch', MAX(updated_at))::char, '') || '-' || COUNT(*)) AS collection_cache_key").first.collection_cache_key
+      end
+    end
+  end

data/lib/rails/cache/logging.rb

@@ -0,0 +1,34 @@
+
+unless Rails.env.production?
+  ActiveSupport::Cache::Store.instrument = true
+
+  module ActiveSupport
+    class CacheLogSubscriber < LogSubscriber
+      def cache_read(event)
+        return if event.payload[:super_operation] == :fetch
+
+        message_string = event.payload[:hit] ? "hit" : "miss"
+        message = "  cache #{message_string}: #{event.payload[:key]}"
+        message << " (%.1fms)" % event.duration
+
+        event.payload[:hit] ? logger.debug(message) : logger.info(message)
+      end
+
+      def cache_fetch_hit(event)
+        message = "  cache hit: #{event.payload[:key]}"
+        message << " (%.1fms)" % event.duration
+
+        logger.debug message
+      end
+
+      def cache_write(event)
+        message = "  cache write: #{event.payload[:key]}"
+        message << " (%.1fms)" % event.duration
+
+        logger.info message
+      end
+    end
+  end
+
+  ActiveSupport::CacheLogSubscriber.attach_to :active_support
+end

data/lib/rails/cache/version.rb

@@ -0,0 +1,3 @@
+module CacheExtended
+  VERSION = "0.0.1"
+end

data/spec/active_support_cache_log_subscriber_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'rails/cache/logging'
+
+describe ActiveSupport::CacheLogSubscriber do
+  let!(:log_subscriber) { ActiveSupport::CacheLogSubscriber.new }
+
+  describe '.cache_read' do
+    it 'returns a valid response' do
+      event = double(payload: {super_operation: :test, hit: true}, duration: 2)
+      logger = double(debug: 1, info: 2)
+
+      ActiveSupport::CacheLogSubscriber.stub(:logger).and_return(logger)
+
+      expect(log_subscriber.cache_read(event)).to eq(1)
+    end
+
+    it 'returns nil when super_operation == fetch' do
+      event = double(payload: {super_operation: :fetch})
+
+      expect(log_subscriber.cache_read(event)).to be_nil
+    end
+
+    describe 'logger method call' do
+      let!(:logger) { double(debug: 1, info: 2) }
+
+      before do
+        ActiveSupport::CacheLogSubscriber.stub(:logger).and_return(logger)
+      end
+
+      it 'should call debug on logger' do
+        event = double(payload: {super_operation: :test, hit: true, key: 'key'}, duration: 2)
+
+        logger.should_receive(:debug).with('  cache hit: key (2.0ms)')
+        log_subscriber.cache_read(event)
+      end
+
+      it 'should call debug on logger' do
+        event = double(payload: {super_operation: :test, hit: false, key: 'key2'}, duration: 2)
+
+        logger.should_receive(:info).with('  cache miss: key2 (2.0ms)')
+        log_subscriber.cache_read(event)
+      end
+    end
+  end
+
+  describe '.cache_fetch_hit' do
+    let!(:logger) { double(debug: 1) }
+    let!(:event) { double(payload: {key: 'test'}, duration: 2) }
+
+    before do
+      ActiveSupport::CacheLogSubscriber.stub(:logger).and_return(logger)
+    end
+
+    it 'returns a valid response' do
+      expect(log_subscriber.cache_fetch_hit(event)).to eq(1)
+    end
+
+    it 'should call debug on logger' do
+      logger.should_receive(:debug).with('  cache hit: test (2.0ms)')
+      log_subscriber.cache_fetch_hit(event)
+    end
+  end
+
+  describe '.cache_write' do
+    let!(:logger) { double(info: 1) }
+    let!(:event) { double(payload: {key: 'test'}, duration: 2) }
+
+    before do
+      ActiveSupport::CacheLogSubscriber.stub(:logger).and_return(logger)
+    end
+
+    it 'returns a valid response' do
+      expect(log_subscriber.cache_write(event)).to eq(1)
+    end
+
+    it 'should call info on logger' do
+      logger.should_receive(:info).with('  cache write: test (2.0ms)')
+      log_subscriber.cache_write(event)
+    end
+  end
+end
+
+

data/spec/cache_active_record_base_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'rails/cache/extended'
+
+describe Cache::ActiveRecord::Base do
+  it 'generates valid cache key' do
+    scope = double(maximum: '2', count: 1)
+    Cache::ActiveRecord::Base.stub(:scoped).and_return(scope)
+    expected_result = Digest::MD5.hexdigest '2-1'
+    expect(Cache::ActiveRecord::Base::cache_key).to eq(expected_result)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV["RAILS_ENV"] ||= 'test'
+require 'rails/all'
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rails-cache-extended
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thibault El Zamek, Cédric Darné, Lionel Oto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'This allows to generate an auto-expiring cache key for a collection
+  of records '
+email:
+- thibault.elzamek@c4mprod.com, cedric.darne@c4mprod.com, lionel.oto@c4mprod.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rails-cache-extended.rb
+- lib/rails/cache/version.rb
+- lib/rails/cache/extended.rb
+- lib/rails/cache/logging.rb
+- spec/spec_helper.rb
+- spec/cache_active_record_base_spec.rb
+- spec/active_support_cache_log_subscriber_spec.rb
+homepage: https://github.com/c4mprod/rails-cache-extended
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: This allows to generate an auto-expiring cache key for a collection of records
+test_files:
+- spec/spec_helper.rb
+- spec/cache_active_record_base_spec.rb
+- spec/active_support_cache_log_subscriber_spec.rb