cache_finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2683c37cf48d2d6efc2fba15a6ac2a4629c2477
+  data.tar.gz: f6649e98e3b25b144c92a9a892224e07bf9a5322
+SHA512:
+  metadata.gz: 75f33e9aa498771f77d4566db54226d777e81f30425deaf1beb22dcebb38855ae6ac6bd2f734559e8c6e21a74b0a63385648e84832ac72d47ef03c7d84466db3
+  data.tar.gz: ed97007fea95d75f5b2b09593f08918c26127388adb410f8bc8f3a350ea73e669858f74ce86e81f3f7f5bd6f584f4223ef5bdd19e942701f4d771f372265b339

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store
+.idea/
+db/*.db

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex
+
+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 @@
+# CacheFinder
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_finder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_finder
+
+## 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/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/cache_finder.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cache_finder'
+  spec.version = CacheFinder::VERSION
+  spec.authors = ['Shilov Alexander']
+  spec.email = ['sashapashamasha@gmail.com']
+  spec.description = 'A little cache managing system for Rails'
+  spec.summary = ''
+  spec.homepage = 'https://github.com/shlima/CacheFinder'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_dependency 'activesupport', '>= 3.2', '< 5.0'
+  spec.add_dependency 'actionpack', '>= 3.2', '< 5.0'
+end

data/lib/cache_finder.rb

@@ -0,0 +1,27 @@
+require 'cache_finder/version'
+
+# Custom
+require 'cache_finder/finder/find_by_id'
+require 'cache_finder/finder/container'
+require 'cache_finder/cleaner/clean_by_id'
+require 'cache_finder/cleaner/cleaner'
+
+module CacheFinder
+
+  module Finder
+    module Singleton
+      include CacheFinder::FindById
+      include CacheFinder::Container
+    end
+
+    def self.included(base)
+      base.extend Singleton
+    end
+  end
+
+  module Cleaner
+    extend ActiveSupport::Concern
+    include CacheCleaner::CleanById
+    include CacheCleaner::Cleaner
+  end
+end

data/lib/cache_finder/cleaner/clean_by_id.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module CacheCleaner
+
+  # Adding the after_save callback to the model.
+  # After saving the method will automatically drop cache
+  # by key: ['Class_name', id]
+
+  module CleanById
+    extend ActiveSupport::Concern
+    included do
+      after_save { drop_cache_by_id }
+    end
+
+    def drop_cache_by_id
+      Rails.cache.delete([self.class.name, self.id])
+    end
+  end
+end

data/lib/cache_finder/cleaner/cleaner.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module CacheCleaner
+
+  module Cleaner
+    include CacheFinder::Helper
+
+    def cache_cleaner(*keys)
+      keys.each do |key|
+        Rails.cache.delete(cache_container_key?(key))
+      end
+    end
+
+    # CacheFinder::Cleaner.cache
+    def cache(*keys)
+      keys.each do |key|
+        Rails.cache.delete(key)
+      end
+    end
+
+    module_function :cache
+  end
+end

data/lib/cache_finder/finder/container.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+
+module CacheFinder
+
+  module Helper
+    # Helper method.
+    # You could find out the way of generating keys by calling
+    # this method on a class.
+    #
+    # Example:
+    #   Chain.cache_container_key?(:name) # => ["Chain", :name]
+    #
+    def cache_container_key?(data)
+      key = *data
+      key.unshift(self.name)
+      key
+    end
+  end
+
+  # Will cached everything placed in a block.
+  #
+  # Example of using:
+  #   Company.cache_container(key: :companies) { Company.all }
+  #
+  # Included in a module, the *cache_container* method will automatically
+  # add a *Class_name* to the key of the cache. In this way the key will be:
+  #   ['Class_name', key]
+  #
+  # You can use container standalone, example of using:
+  #   CacheFinder::Container.cache(key: [:company, :name]) { 'Microsoft' }
+  #
+  module Container
+    include CacheFinder::Helper
+
+    def cache_container(options, &block)
+      key = cache_container_key?(options[:key])
+      Rails.cache.fetch(key) { block.call }
+    end
+
+    # CacheFinder::Container.cache
+    def cache(options, &block)
+      key = options[:key]
+      Rails.cache.fetch(key) { block.call }
+    end
+    module_function :cache
+  end
+end

data/lib/cache_finder/finder/find_by_id.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+module CacheFinder
+
+  # Will find and cached the entity by it's id.
+  #
+  # Example of using:
+  #   Company.cache_find(10)
+  #
+  # Will produce the cache accessible by the key:
+  #   ['Company', 10]
+
+  module FindById
+    def cache_find(id)
+      Rails.cache.fetch([self.name, id]) { find(id) }
+    end
+  end
+end

data/lib/cache_finder/version.rb

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

data/spec/find/cache_finder_spec.rb

@@ -0,0 +1,26 @@
+#require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'CacheFinder' do
+  before(:all) do
+    @company = Company.create(name: 'Brothers & Co.', phone: '315297032596', street: 'Time Square')
+  end
+
+  it 'works' do
+    @company.name.should == Company.find(@company.id).name
+  end
+
+  it 'cache_container_key?' do
+    Company.cache_container_key?(:name).should == ['Company', :name]
+  end
+
+  it 'cache_finder works' do
+    all = Company.cache_container(key: [:companies, :all]) { Company.all }
+    Rails.cache.read([Company.name, :companies, :all]).should == all
+  end
+
+  it 'cache_cleaner works' do
+    @company.name = 'Warner'
+    @company.save
+    Rails.cache.read([:companies, :all]).should == nil
+  end
+end

data/spec/find/find_and_clear_by_id_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Company do
+
+  before(:all) do
+    @company = Company.create(name: 'Brothers & Co.', phone: '315297032596', street: 'Time Square')
+  end
+
+  it 'works' do
+    @company.name.should == Company.find(@company.id).name
+  end
+
+  it 'cache_find works' do
+    @company.name.should == Company.cache_find(@company.id).name
+  end
+
+  it 'caching works' do
+    Rails.cache.read([Company.name, @company.id]).should == @company
+  end
+
+  it 'caching-clear works' do
+    @company.name = 'Shliman'
+    @company.save
+    Rails.cache.read([Company.name, @company.id]).should == nil
+  end
+end

data/spec/find/stadalone_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Company do
+  before(:all) do
+    @company = Company.create(name: 'Brothers & Co.', phone: '315297032596', street: 'Time Square')
+  end
+
+  it 'Clearing cache by string key' do
+    key = :cache
+    msg = 'Hola, Viola!'
+    CacheFinder::Container.cache(key: key) { msg }
+    Rails.cache.read(key).should == msg
+    CacheCleaner::Cleaner.cache(key)
+    Rails.cache.read(key).should == nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+require 'action_view'
+
+require 'cache_finder'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: "#{root}/db/cache_finder_test.db"
+)
+
+# stub the Rails module functionality
+RAILS_CACHE = ActiveSupport::Cache.lookup_store(:memory_store)
+module Rails
+  def self.cache
+    RAILS_CACHE
+  end
+end
+
+# Fake DB
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'companies'")
+ActiveRecord::Base.connection.create_table(:companies) do |t|
+  t.string :name
+  t.string :phone
+  t.string :street
+end
+
+class Company < ActiveRecord::Base
+  include CacheFinder::Finder, CacheFinder::Cleaner
+  after_save { cache_cleaner [:companies, :all] }
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: cache_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shilov Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !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
+  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: activerecord
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A little cache managing system for Rails
+email:
+- sashapashamasha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_finder.gemspec
+- db/.keep
+- lib/cache_finder.rb
+- lib/cache_finder/cleaner/clean_by_id.rb
+- lib/cache_finder/cleaner/cleaner.rb
+- lib/cache_finder/finder/container.rb
+- lib/cache_finder/finder/find_by_id.rb
+- lib/cache_finder/version.rb
+- spec/find/cache_finder_spec.rb
+- spec/find/find_and_clear_by_id_spec.rb
+- spec/find/stadalone_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shlima/CacheFinder
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/find/cache_finder_spec.rb
+- spec/find/find_and_clear_by_id_spec.rb
+- spec/find/stadalone_spec.rb
+- spec/spec_helper.rb