custom_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8b1f13ab73f777a1f7347da60918f75d8767917
+  data.tar.gz: 1026ed87191cd16bc1486a2a1cf3661bc7b18822
+SHA512:
+  metadata.gz: aa25fc5d180681ae5d5c83c3d55c7dddabde23598de169342da9c9fe67601c3e9403e1477fc144d0d86ee2ea65edc02a7f18f8a33e3c732f3bc0a39f8c3bb7b1
+  data.tar.gz: e2ffe8b9194ec23b743e6eadd5bfd79df37c47db6e7d25191fdc134de9369deb6f9bd26d15adfebe2be6927ac36a1956852a49038afba12f4ea11d358f77c4ce

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Chirag Viradiya
+
+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,30 @@
+# custom_cache
+
+A wrapper over Rails cache to provide request and session cache
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'custom_cache'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install custom_cache
+
+## Usage
+
+The request_cache can be used to share information over the request between controller, models etc without re-fetching it
+
+    Rails.request_cache.write('current_product_id', 'd4f30996-4dba-4805-8114-6b35d1272858')
+    Rails.request_cache.read('current_product_id')
+
+The session_cache can be used to share information across the requests between controller, models etc without re-fetching it
+
+    Rails.session_cache.write('capabilities', ['REPORTS_VIEW', 'PRODUCT_CRUD'])
+    Rails.session_cache.read('capabilities')
+

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CustomCache'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/custom_cache/acts_as_custom_cache.rb

@@ -0,0 +1,24 @@
+module CustomCache
+  module ActsAsCustomCache
+
+    extend ActiveSupport::Concern
+
+    included do
+
+    end
+
+    module ClassMethods
+
+      def session_cache
+         CustomCache::SessionCache.instance
+      end
+
+      def request_cache
+        CustomCache::RequestCache.instance
+      end
+
+    end
+
+    Rails.send :include, CustomCache::ActsAsCustomCache
+  end
+end

data/lib/custom_cache/base.rb

@@ -0,0 +1,5 @@
+module CustomCache
+  class Base
+
+  end
+end

data/lib/custom_cache/middleware.rb

@@ -0,0 +1,16 @@
+module CustomCache
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request =  ActionDispatch::Request.new(env)
+      CustomCache::RequestCache.create(request.uuid)
+      CustomCache::SessionCache.create(request.session.id)
+      @app.call(env)
+    ensure
+      CustomCache::RequestCache.clear!
+    end
+  end
+end

data/lib/custom_cache/railtie.rb

@@ -0,0 +1,9 @@
+module CustomCache
+  class Railtie < Rails::Railtie
+    initializer 'custom_cache.insert_middleware' do |app|
+
+      app.config.middleware.insert_after ActionDispatch::Flash, CustomCache::Middleware
+
+    end
+  end
+end

data/lib/custom_cache/request_cache.rb

@@ -0,0 +1,42 @@
+module CustomCache
+
+  class RequestCache < Base
+
+    include Singleton
+
+    attr_accessor :request_id
+
+    def self.create(request_id)
+      self.instance.request_id = request_id
+    end
+
+    def cache_key
+      "_request_#{request_id}_cache" if request_id.present?
+    end
+
+    def read(key)
+      if cache_key.present?
+        content = Rails.cache.read(cache_key)
+        content[key] if content.present?
+      end
+    end
+
+    def write(key, content)
+      if cache_key.present?
+        cached_content = Rails.cache.read(cache_key) || {}
+        cached_content[key] = content
+        Rails.cache.write(cache_key, cached_content)
+      end
+    end
+
+    def clear
+      Rails.cache.delete(cache_key) if cache_key.present?
+    end
+
+    def self.clear!
+      self.instance.clear
+    end
+
+  end
+
+end

data/lib/custom_cache/scope_cache.rb

@@ -0,0 +1,7 @@
+module CustomCache
+
+  class ScopeCache < Base
+
+  end
+
+end

data/lib/custom_cache/session_cache.rb

@@ -0,0 +1,42 @@
+module CustomCache
+
+    class SessionCache < Base
+
+      include Singleton
+
+      attr_accessor :session_id
+
+      def self.create(session_id)
+        self.instance.session_id = session_id
+      end
+
+      def cache_key
+        "_session_#{session_id}_cache" if session_id.present?
+      end
+
+      def read(key)
+        if cache_key.present?
+          content = Rails.cache.read(cache_key)
+          content[key] if content.present?
+        end
+      end
+
+      def write(key, content)
+        if cache_key.present?
+          cached_content = Rails.cache.read(cache_key) || {}
+          cached_content[key] = content
+          Rails.cache.write(cache_key, cached_content)
+        end
+      end
+
+      def clear
+        Rails.cache.delete(cache_key) if cache_key.present?
+      end
+
+      def self.clear!
+        self.instance.clear
+      end
+
+    end
+
+end

data/lib/custom_cache/version.rb

@@ -0,0 +1,3 @@
+module CustomCache
+  VERSION = '0.0.1'
+end

data/lib/custom_cache.rb

@@ -0,0 +1,9 @@
+require 'custom_cache/acts_as_custom_cache'
+require 'custom_cache/base'
+require 'custom_cache/request_cache'
+require 'custom_cache/session_cache'
+require 'custom_cache/middleware'
+require 'custom_cache/railtie' if defined?(Rails::Railtie)
+
+module CustomCache
+end

data/lib/tasks/custom_cache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :custom_cache do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: custom_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chirag Viradiya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.10
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: A wrapper over Rails cache to provide request and session cache.
+email:
+- chirag.viradiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/custom_cache.rb
+- lib/custom_cache/acts_as_custom_cache.rb
+- lib/custom_cache/base.rb
+- lib/custom_cache/middleware.rb
+- lib/custom_cache/railtie.rb
+- lib/custom_cache/request_cache.rb
+- lib/custom_cache/scope_cache.rb
+- lib/custom_cache/session_cache.rb
+- lib/custom_cache/version.rb
+- lib/tasks/custom_cache_tasks.rake
+homepage: http://rubygems.org/gems/custom_cache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper over Rails cache to provide request and session cache.
+test_files: []
+has_rdoc: