rcache 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+dump.rdb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 novikov
+
+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,48 @@
+# Rcache
+
+Caches activerecord query results to memory and redis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rcache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rcache
+
+In your initializers:
+
+    Rcache.configure do |config|
+        config.redis = <your connect to redis>
+    end
+
+Optional settings:
+
+1. expires_in (default 60)
+2. log_cached_queries (default true)
+3. key_prefix (default rcache::)
+
+
+## Usage
+
+Cache find result for 60 seconds:
+
+    Client.rcache.find(2)
+
+Cache where results with includes for 10 seconds and not show cached queries in log:
+
+    Event.limit(2).includes(:thumbnails, :type => :variable).rcache(:expires_in => 10.seconds, :log_cached_queries => false)
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/rcache/association.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class Association #:nodoc:
+        def build_scope
+          scope = klass.scoped
+
+          scope = scope.where(process_conditions(options[:conditions]))
+          scope = scope.where(process_conditions(preload_options[:conditions]))
+
+          scope = scope.select(preload_options[:select] || options[:select] || table[Arel.star])
+          scope = scope.includes(preload_options[:include] || options[:include])
+
+          if options[:as]
+            scope = scope.where(
+              klass.table_name => {
+                reflection.type => model.base_class.sti_name
+              }
+            )
+          end
+          scope = scope.rcache(preload_options[:rcache_value]) if preload_options[:rcache_value]
+
+          scope
+        end
+      end
+    end
+  end
+end

data/lib/rcache/preloader.rb

@@ -0,0 +1,12 @@
+module ActiveRecord
+  module Associations
+    class Preloader #:nodoc:
+      def preload_hash(association)
+        association.each do |parent, child|
+          Preloader.new(records, parent, options).run
+          Preloader.new(records.map { |record| record.send(parent) }.flatten, child, options.select { |k,v| k == :rcache_value }).run
+        end
+      end
+    end
+  end
+end

data/lib/rcache/query_cache.rb

@@ -0,0 +1,50 @@
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module QueryCache
+      attr_accessor :rcache_value
+
+      def select_all(arel, name = nil, binds = [])
+        if @rcache_value && !locked?(arel) && (@rcache_value[:expires_in] || Rcache.expires_in).to_i > 0
+          sql = to_sql(arel, binds)
+          redis_cache_sql(sql, binds) { super(sql, name, binds) }
+        elsif @query_cache_enabled && !locked?(arel)
+          sql = to_sql(arel, binds)
+          cache_sql(sql, binds) { super(sql, name, binds) }
+        else
+          super
+        end
+      end
+
+      private
+
+      def redis_cache_sql(sql, binds)
+        [:redis, :expires_in, :log_cached_queries, :key_prefix].each do |attr|
+          instance_variable_set("@#{attr}", @rcache_value.has_key?(attr) ? @rcache_value[attr] : Rcache.send(attr))
+        end
+
+        result =
+          # return from memory
+          if @query_cache[sql].key?(binds)
+            ActiveSupport::Notifications.instrument("sql.active_record", :sql => sql, :binds => binds, :name => "CACHE", :connection_id => object_id) if @log_cached_queries
+            @query_cache[sql][binds]
+          # write to memory from redis and return
+          elsif res = (JSON.parse(@redis.get(redis_cache_key(sql, binds, @key_prefix))) rescue nil)
+            ActiveSupport::Notifications.instrument("sql.active_record", :sql => sql, :binds => binds, :name => "REDIS", :connection_id => object_id) if @log_cached_queries
+            @query_cache[sql][binds] = res
+          # write to memory and redis from db and return
+          else
+            res = yield
+            @query_cache[sql][binds] = res
+            @redis.setex(redis_cache_key(sql, binds, @key_prefix), @expires_in, res.to_json)
+            res
+          end
+
+        result.collect { |row| row.dup }
+      end
+
+      def redis_cache_key(sql, binds, key_prefix)
+        key_prefix + Digest::MD5.hexdigest(sql + binds.to_s)
+      end
+    end
+  end
+end

data/lib/rcache/query_methods.rb

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module QueryMethods
+    def rcache(opts = {})
+      connection.rcache_value = opts
+      self
+    end
+  end
+end

data/lib/rcache/querying.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Querying
+    delegate :rcache, :to => :scoped
+  end
+end

data/lib/rcache/relation.rb

@@ -0,0 +1,37 @@
+module ActiveRecord
+  class Relation
+    def exec_queries
+      return @records if loaded?
+  
+      default_scoped = with_default_scope
+  
+      if default_scoped.equal?(self)
+        @records = if @readonly_value.nil? && !@klass.locking_enabled?
+          eager_loading? ? find_with_associations : @klass.find_by_sql(arel, @bind_values)
+        else
+          IdentityMap.without do
+            eager_loading? ? find_with_associations : @klass.find_by_sql(arel, @bind_values)
+          end
+        end
+  
+        preload = @preload_values
+        preload +=  @includes_values unless eager_loading?
+        preload.each do |associations|
+          # this line distincts only
+          ActiveRecord::Associations::Preloader.new(@records, associations, :rcache_value => @klass.connection.rcache_value).run
+        end
+  
+        # @readonly_value is true only if set explicitly. @implicit_readonly is true if there
+        # are JOINS and no explicit SELECT.
+        readonly = @readonly_value.nil? ? @implicit_readonly : @readonly_value
+        @records.each { |record| record.readonly! } if readonly
+      else
+        @records = default_scoped.to_a
+      end
+  
+      @loaded = true
+      @records
+    end
+    private :exec_queries
+  end
+end

data/lib/rcache/version.rb

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

data/lib/rcache.rb

@@ -0,0 +1,23 @@
+require "rcache/version"
+require "json"
+require "digest/md5"
+require "rcache/query_cache"
+require "rcache/query_methods"
+require "rcache/relation"
+require "rcache/association"
+require "rcache/querying"
+require "rcache/preloader"
+
+module Rcache
+  class << self
+    attr_accessor :redis, :expires_in, :log_cached_queries, :key_prefix
+
+    def configure
+      yield self
+    end
+  end
+
+  self.expires_in = 60
+  self.log_cached_queries = true
+  self.key_prefix = 'rcache::'
+end

data/rcache.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rcache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rcache"
+  spec.version       = Rcache::VERSION
+  spec.authors       = ["novikov"]
+  spec.email         = ["novikov@inventos.ru"]
+  spec.description   = %q{ActiveRecord redis query cache}
+  spec.summary       = %q{ActiveRecord redis query cache}
+  spec.homepage      = ""
+  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_runtime_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rcache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- novikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord redis query cache
+email:
+- novikov@inventos.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rcache.rb
+- lib/rcache/association.rb
+- lib/rcache/preloader.rb
+- lib/rcache/query_cache.rb
+- lib/rcache/query_methods.rb
+- lib/rcache/querying.rb
+- lib/rcache/relation.rb
+- lib/rcache/version.rb
+- rcache.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3051535261146459295
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3051535261146459295
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ActiveRecord redis query cache
+test_files: []