active_record_multiple_query_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00050eb28914caff20e2c4a00c6597a734effcf1
+  data.tar.gz: f7ccb81d7ab5034ee4d270c1eb1fca9162aa7271
+SHA512:
+  metadata.gz: 85d1785a38917b157d5d94bda59446cab464750ca4f9fb818a47d0fe20bf6ed8ec3337c390aafc8582b459458a9b78aaf50948e1aa72b77f0e2990a7014c09f5
+  data.tar.gz: 4b64956e9d7995e7208625a257c645d1eb135d6cd333bc0b17cc9ca937b1faa2e6d21143975d3aa81d58753138a0ac8e3a4f720501a98262eedcd4abd8125634

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 alpaca-tc
+
+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,38 @@
+# ActiveRecordMultipleQueryCache
+
+Enable the query_cache for your abstract base class inherited from ActiveRecord::Base.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_multiple_query_cache'
+```
+
+## Usage
+
+```ruby
+# your custom base class
+class ApplicationSlaveRecord < ActiveRecord::Base
+  self.abstract_class = true
+  establish_connection(:"slave_#{Rails.env}")
+end
+
+# config/initializers/active_record_multiple_query_cache.rb
+ActiveRecordMultipleQueryCache.install_query_cache('ApplicationSlaveRecord')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alpaca-tc/active_record_multiple_query_cache.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/active_record_multiple_query_cache.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_multiple_query_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_multiple_query_cache'
+  spec.version       = ActiveRecordMultipleQueryCache::VERSION
+  spec.authors       = ['alpaca-tc']
+  spec.email         = ['alpaca-tc@alpaca.tc']
+
+  spec.summary       = %q{Enable the query_cache for your abstract base class inherited from ActiveRecord::Base}
+  spec.homepage      = 'https://github.com/alpaca-tc/active_record_multiple_query_cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activerecord', '>= 4.2')
+
+  # for test
+  spec.add_development_dependency('sqlite3')
+  spec.add_development_dependency('rack')
+
+  spec.add_development_dependency('bundler')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord_multiple_query_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(__FILE__)

data/bin/setup

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

data/lib/active_record_multiple_query_cache.rb

@@ -0,0 +1,19 @@
+require 'active_record_multiple_query_cache/version'
+require 'active_record_multiple_query_cache/rails4_query_cache'
+
+module ActiveRecordMultipleQueryCache
+  autoload :Rails4QueryCache, 'active_record_multiple_query_cache/rails4_query_cache'
+  autoload :Rails5QueryCache, 'active_record_multiple_query_cache/rails5_query_cache'
+
+  def self.install_query_cache(activerecord_base_class_name, rails = Rails)
+    if rails.gem_version >= Gem::Version.new('5.0.0')
+      executor = ActiveSupport::Executor
+      query_cache = Rails5QueryCache.new(activerecord_base_class_name)
+
+      executor.register_hook(hook)
+    else
+      middleware = ActiveRecordMultipleQueryCache::Rails4QueryCache.new(activerecord_base_class_name)
+      rails.configuration.app_middleware.insert_after('::ActionDispatch::Callbacks', middleware)
+    end
+  end
+end

data/lib/active_record_multiple_query_cache/rails4_query_cache.rb

@@ -0,0 +1,49 @@
+require 'rack'
+require 'active_support/core_ext/string/inflections'
+
+module ActiveRecordMultipleQueryCache
+  class Rails4QueryCache
+    def initialize(active_record_base_class)
+      active_record_base_class = active_record_base_class.constantize if active_record_base_class.is_a?(String)
+      @active_record_base_class = active_record_base_class
+    end
+
+    def new(app)
+      @app = app
+      self
+    end
+
+    def call(env)
+      connection = @active_record_base_class.connection
+      enabled = connection.query_cache_enabled
+      connection_id = @active_record_base_class.connection_id
+      connection.enable_query_cache!
+
+      response = @app.call(env)
+      response[2] = Rack::BodyProxy.new(response[2]) do
+        restore_query_cache_settings(connection_id, enabled)
+      end
+
+      response
+    rescue Exception
+      restore_query_cache_settings(connection_id, enabled)
+      raise
+    end
+
+    def name
+      self.class.name
+    end
+
+    def to_s
+      %{#<#{self.class} @active_record_class: "#{@active_record_base_class}">}
+    end
+
+    private
+
+    def restore_query_cache_settings(connection_id, enabled)
+      @active_record_base_class.connection_id = connection_id
+      @active_record_base_class.connection.clear_query_cache
+      @active_record_base_class.connection.disable_query_cache! unless enabled
+    end
+  end
+end

data/lib/active_record_multiple_query_cache/rails5_query_cache.rb

@@ -0,0 +1,22 @@
+module ActiveRecordMultipleQueryCache
+  class Rails5QueryCache
+    def initialize(active_record_base_class)
+      activerecord_base_class = active_record_base_class.constantize if active_record_base_class.is_a?(String)
+
+      @active_record_base_class = active_record_base_class
+    end
+
+    def run
+      caching_pool = @active_record_base_class.connection_pool
+      caching_was_enabled = caching_pool.query_cache_enabled
+
+      caching_pool.enable_query_cache!
+
+      [caching_pool, caching_was_enabled]
+    end
+
+    def complete((caching_pool, caching_was_enabled))
+      caching_pool.disable_query_cache! unless caching_was_enabled
+    end
+  end
+end

data/lib/active_record_multiple_query_cache/version.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: active_record_multiple_query_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alpaca-tc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: rack
+  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: bundler
+  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: 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'
+description: 
+email:
+- alpaca-tc@alpaca.tc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_multiple_query_cache.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_multiple_query_cache.rb
+- lib/active_record_multiple_query_cache/rails4_query_cache.rb
+- lib/active_record_multiple_query_cache/rails5_query_cache.rb
+- lib/active_record_multiple_query_cache/version.rb
+homepage: https://github.com/alpaca-tc/active_record_multiple_query_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.5.2
+signing_key: 
+specification_version: 4
+summary: Enable the query_cache for your abstract base class inherited from ActiveRecord::Base
+test_files: []