restrict_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4a37b2b0b86aaf69fda3297713e32fdd1951722
+  data.tar.gz: f221ff5b19e8c16e2844d0e45e70aa1989226ac8
+SHA512:
+  metadata.gz: a80b5f4e4070bf06a1bd4ec645c1d05f320f5b69dce451779c524677168b5578dab87744061d127502185cad5171677f7a8775164f7ffec1a4df1053ba0a8cda
+  data.tar.gz: 2833d2da4631d6873c4e7b5fc8ba3a5f6809850d7f78a0e12e1432851a5752740e3c9969fb47ccb5f6328a43bbe4f3178b211488ff6d6928c416d3c7870adec7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in restrict_cache.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 i2bskn
+
+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,55 @@
+# RestrictCache
+
+Restricted cache in the rack request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restrict_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restrict_cache
+
+## Usage
+
+Using the middleware or callbacks to clear the cache for each request.  
+
+#### Rack Middleware
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.middleware.use RestrictCache::CacheSweeper
+  end
+end
+```
+
+#### Callbacks (Around Action)
+
+```ruby
+class MyModel < ActiveRecord::Base; end
+MyModel.find_with_restrict_cache(id_or_ids)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/i2bskn/restrict_cache/fork )
+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 a new Pull Request
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restrict_cache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/restrict_cache/accessible.rb

@@ -0,0 +1,16 @@
+module RestrictCache
+  module Accessible
+    THREAD_KEY = :restrict_cache
+
+    def collection
+      Thread.current[THREAD_KEY] ||= Cacheable.new
+    end
+
+    def clear
+      Thread.current[THREAD_KEY] = nil
+    end
+  end
+
+  extend Accessible
+end
+

data/lib/restrict_cache/action_controller_ext.rb

@@ -0,0 +1,21 @@
+module RestrictCache
+  class ActionControllerExt
+    include ActiveSupport::Concern
+
+    module ClassMethods
+      def cache_sweep_action(*args)
+        options = args.extract_options!
+        actions = args.empty? ? {} : {only: args}
+        options.merge! actions unless actions.empty?
+        around_action :sweep_restrict_cache, options
+      end
+    end
+
+    def sweep_restrict_cache
+      yield
+    ensure
+      RestrictCache.clear
+    end
+  end
+end
+

data/lib/restrict_cache/active_record_ext.rb

@@ -0,0 +1,53 @@
+module RestrictCache
+  module ActiveRecordExt
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def find_and_restrict_cache(arg)
+        records = find(arg)
+        Array(records).each(&:restrict_cache)
+        records
+      end
+
+      def find_from_restrict_cache(arg)
+        contents = RestrictCache.collection.active_record.contents(self.table_name)
+        return nil unless contents
+
+        case arg
+        when Integer
+          contents[arg]
+        when String
+          contents[arg.to_i]
+        when Array
+          args.map {|index| contents[index.to_i] }
+        else
+          raise "unknown argument: #{arg.inspect}"
+        end
+      end
+
+      def find_with_restrict_cache(arg)
+        if restrict_cached?(Array(arg))
+          records = Array(arg).map {|index| find_from_restrict_cache(index) }
+          records.size > 1 ? records : records.first
+        else
+          find_and_restrict_cache(arg)
+        end
+      end
+
+      private
+        def restrict_cached?(args)
+          content = RestrictCache.collection.active_record.contents(self.table_name)
+          return false unless content
+          ids = content.keys
+          args.all? {|index| ids.include?(index) }
+        end
+    end
+
+    def restrict_cache
+      RestrictCache.collection.add(self)
+    end
+  end
+end
+

data/lib/restrict_cache/cache_sweeper.rb

@@ -0,0 +1,14 @@
+module RestrictCache
+  class CacheSweeper
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    ensure
+      RestrictCache.clear
+    end
+  end
+end
+

data/lib/restrict_cache/cacheable/active_record_cache.rb

@@ -0,0 +1,20 @@
+module RestrictCache
+  class Cacheable
+    class ActiveRecordCache < Base
+      def add(content)
+        @caches[table_name(content)] ||= {}
+        @caches[table_name(content)][content.id] = content
+      end
+
+      def contents(_table_name)
+        @caches[_table_name.to_sym]
+      end
+
+      private
+        def table_name(content)
+          content.class.table_name.to_sym
+        end
+    end
+  end
+end
+

data/lib/restrict_cache/cacheable/base.rb

@@ -0,0 +1,22 @@
+module RestrictCache
+  class Cacheable
+    class Base
+      def initialize
+        @caches = {}
+      end
+
+      def add(content)
+        raise NotImplementedError
+      end
+
+      def contents(_table_name)
+        raise NotImplementedError
+      end
+
+      def size
+        @caches.size
+      end
+    end
+  end
+end
+

data/lib/restrict_cache/cacheable/custom_cache.rb

@@ -0,0 +1,13 @@
+module RestrictCache
+  class Cacheable
+    class CustomCache < Base
+      def add(cache_key, content)
+        @caches[cache_key.to_sym] = content
+      end
+
+      def contents(cache_key = nil)
+        cache_key ? @caches[cache_key.to_sym] : nil
+      end
+    end
+  end
+end

data/lib/restrict_cache/cacheable.rb

@@ -0,0 +1,55 @@
+require "restrict_cache/cacheable/base"
+require "restrict_cache/cacheable/active_record_cache"
+require "restrict_cache/cacheable/custom_cache"
+
+module RestrictCache
+  class Cacheable
+    module CacheKey
+      ACTIVERECORD = :active_record_cache
+      CUSTOM = :custom_cache
+      ALL = [ACTIVERECORD, CUSTOM]
+
+      def self.get(content)
+        if defined?(ActiveRecord) && content.class < ActiveRecord::Base
+          return ACTIVERECORD
+        end
+        CUSTOM
+      end
+    end
+
+    class << self
+      def build_inner_cache(key)
+        const_get(key.to_s.classify, false).new
+      end
+    end
+
+    CacheKey::ALL.each do |inner_cache_key|
+      define_method inner_cache_key do
+        inner_cache inner_cache_key
+      end
+    end
+
+    def initialize
+      @cache_collection = {}
+    end
+
+    def add(content)
+      inner_cache(CacheKey.get(content)).add(content)
+    end
+
+    def [](key)
+      return nil unless key
+      @cache_collection[key]
+    end
+
+    def cache_keys
+      CacheKey::ALL
+    end
+
+    private
+      def inner_cache(key)
+        @cache_collection[key] ||= self.class.build_inner_cache(key)
+      end
+  end
+end
+

data/lib/restrict_cache/railtie.rb

@@ -0,0 +1,17 @@
+module RestrictCache
+  class Railtie < ::Rails::Railtie
+    initializer "restrict_cache" do
+      require "restrict_cache/action_controller_ext"
+      require "restrict_cache/active_record_ext"
+
+      ActiveSupport.on_load(:action_controller) do
+        ::ActionController::Base.send(:include, RestrictCache::ActionControllerExt)
+      end
+
+      ActiveSupport.on_load(:active_record) do
+         ::ActiveRecord::Base.send(:include, RestrictCache::ActiveRecordExt)
+      end
+    end
+  end
+end
+

data/lib/restrict_cache/version.rb

@@ -0,0 +1,3 @@
+module RestrictCache
+  VERSION = "0.1.0"
+end

data/lib/restrict_cache.rb

@@ -0,0 +1,6 @@
+require "restrict_cache/version"
+require "restrict_cache/accessible"
+require "restrict_cache/cacheable"
+require "restrict_cache/cache_sweeper"
+require "restrict_cache/railtie" if defined?(Rails)
+

data/restrict_cache.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restrict_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restrict_cache"
+  spec.version       = RestrictCache::VERSION
+  spec.authors       = ["i2bskn"]
+  spec.email         = ["i2bskn@gmail.com"]
+
+  spec.summary       = %q{Restricted cache in the rack request.}
+  spec.description   = %q{Restricted cache in the rack request.}
+  spec.homepage      = "https://github.com/i2bskn/restrict_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: restrict_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- i2bskn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Restricted cache in the rack request.
+email:
+- i2bskn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restrict_cache.rb
+- lib/restrict_cache/accessible.rb
+- lib/restrict_cache/action_controller_ext.rb
+- lib/restrict_cache/active_record_ext.rb
+- lib/restrict_cache/cache_sweeper.rb
+- lib/restrict_cache/cacheable.rb
+- lib/restrict_cache/cacheable/active_record_cache.rb
+- lib/restrict_cache/cacheable/base.rb
+- lib/restrict_cache/cacheable/custom_cache.rb
+- lib/restrict_cache/railtie.rb
+- lib/restrict_cache/version.rb
+- restrict_cache.gemspec
+homepage: https://github.com/i2bskn/restrict_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.4.5
+signing_key: 
+specification_version: 4
+summary: Restricted cache in the rack request.
+test_files: []