reuse_query_results 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1b2157313e9aeacb8ad1bfdaebd928d5f8b40a6
+  data.tar.gz: 870d10bf386099250a44715c6c8392537720faa7
+SHA512:
+  metadata.gz: 0615bc0a42cfd1fd36c3c5c457afc8d81aa234a2cb2ce010973b98f318c7c0da651217c22060224d5567249442a65802d527de991803ca515756d1ee37e33617
+  data.tar.gz: 8be939634b718a13344da664e0da03748de6ff95b575e360cb2edcecda8bec91c4dcf3738a18f608aed8e8793d904b246d5b3acb24f70517bf33a49064dfbd67

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reuse_query_results.gemspec
+gemspec
+
+
+group :development, :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-rails', '~> 2.14.2'
+  gem 'rescue_tracer', '~> 0.0.2'
+  gem 'byebug'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 COOKPAD Inc.
+
+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,42 @@
+# ReuseQueryResults
+Improve development environment speed.
+Reuse query results and clear cache when insert update and delete record.
+No more db requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reuse_query_results', git: 'https://github.com/cookpad/reuse_query_results'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reuse_query_results
+
+## Usage
+run command on development environment .
+```
+REUSE_QUERY_RESULTS=1 rails server
+```
+
+Can share update status between separated applications.
+```ruby
+# initializers/reuse_query_results.rb
+memcache = ActiveSupport::Cache.lookup_store(:dalli_store, address)
+ReuseQueryResults.storage = ReuseQueryResults::Storage.new(sync_client: memcache)
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/reuse_query_results/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'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :noop do; end
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec => :noop)
+

data/lib/reuse_query_results.rb

@@ -0,0 +1,41 @@
+require "reuse_query_results/version"
+require "reuse_query_results/storage"
+
+module ReuseQueryResults
+  class << self
+    def storage
+      @storage ||= Storage.new
+    end
+
+    def storage=(storage)
+      @storage = storage
+    end
+
+
+    def cache(connection, sql, &block)
+      database = connection.instance_variable_get(:'@config')[:database]
+      case sql.strip
+      when (/\AINSERT INTO (?:\.*[`"]?([^.\s`"]+)[`"]?)*/i)
+        return storage.clear_and_execute(database, $1, &block)
+      when (/\ADELETE FROM (?:\.*[`"]?([^.\s`"]+)[`"]?)*/i)
+        return storage.clear_and_execute(database, $1, &block)
+      when (/\AUPDATE (?:\.*[`"]?([^.\s`"]+)[`"]?)*/i)
+        return storage.clear_and_execute(database, $1, &block)
+      when (/\ASELECT\s+.*FROM\s+"?([^\.\s'"]+)"?/im)
+        return storage.fetch_or_execute(database, tables(sql), sql, &block)
+      end
+      block.call
+    end
+
+    def tables(sql)
+      sql.scan(/(?:FROM|JOIN)\s+[`"]?([^\.\s'`"]+)(?:[`"]?)/).flatten.sort
+    end
+  end
+end
+
+begin
+  require 'rails'
+  require_relative 'reuse_query_results/railtie'
+rescue LoadError
+  require_relative "reuse_query_results/active_record_monkey_patch"
+end

data/lib/reuse_query_results/active_record_monkey_patch.rb

@@ -0,0 +1,31 @@
+module ReuseQueryResults
+  module Cache
+    def execute(sql, *)
+      ReuseQueryResults.cache(self, sql) do
+        super
+      end
+    end
+
+    def exec_query(sql, *)
+      ReuseQueryResults.cache(self, sql) do
+        super
+      end
+    end
+  end
+end
+
+begin
+  require 'active_record/connection_adapters/sqlite3_adapter'
+  ::ActiveRecord::ConnectionAdapters::SQLite3Adapter.send :prepend, ReuseQueryResults::Cache
+rescue LoadError
+end
+begin
+  require 'active_record/connection_adapters/postgresql_adapter'
+  ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :prepend, ReuseQueryResults::Cache
+rescue LoadError
+end
+begin
+  require 'active_record/connection_adapters/abstract_mysql_adapter'
+  ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.send :prepend, ReuseQueryResults::Cache
+rescue LoadError
+end

data/lib/reuse_query_results/railtie.rb

@@ -0,0 +1,10 @@
+module ReuseQueryResults
+  class Railtie < ::Rails::Railtie
+    initializer 'resque_query_results', after: 'active_record.initialize_database' do
+      ActiveSupport.on_load :active_record do
+        Rails.logger.info("load reuse_query_results")
+        require_relative "active_record_monkey_patch" if ENV["REUSE_QUERY_RESULTS"] && Rails.env.development?
+      end
+    end
+  end
+end

data/lib/reuse_query_results/storage.rb

@@ -0,0 +1,68 @@
+module ReuseQueryResults
+  class Storage
+    attr_reader :databases
+    def initialize(sync_client: nil)
+      @sync_client = sync_client
+      clear_all
+    end
+
+    def add(database, tables, sql, result)
+      @databases[database][tables][sql] = { data: result, timestamp: Time.now.to_i }
+    end
+
+    def clear_all
+      @databases = Hash.new do |h, k| 
+        h[k] = Hash.new { |h2, k2| h2[k2] = {} }
+      end
+      return unless sync_mode?
+      @sync_client.clear
+    end
+
+    def clear(database, table)
+      @databases[database].keys.select { |tables|
+        tables.include?(table)
+      }.each { |tables| 
+        @databases[database][tables] = {}
+      }
+      return unless sync_mode?
+      update_modified_timestamp(database, table)
+    end
+
+    def fetch_or_execute(database, tables, sql, &block)
+      cached_result = fetch(database, tables, sql)
+      if cached_result
+        Rails.logger.debug("REUSE CACHE: #{sql}")
+        return cached_result
+      end
+      block.call.tap { |result| add(database, tables, sql, result) }
+    end
+
+    def clear_and_execute(database, table, &block)
+      clear(database, table)
+      block.call
+    end
+
+    def fetch(database, tables, sql)
+      result = @databases[database][tables][sql]
+      return nil unless result
+      return result[:data] unless sync_mode?
+      return updated?(database, tables, result[:timestamp]) ? nil : result[:data]
+    end
+
+    def sync_mode?
+      !!@sync_client
+    end
+
+    def update_modified_timestamp(database, table)
+      @sync_client.write("#{database}+#{table}", Time.now.to_i)
+    end
+
+    def updated?(database, tables, cached_timestamp)
+      tables.any? do |table|
+        next unless updated_timestamp = @sync_client.read("#{database}+#{table}")
+        next if updated_timestamp < cached_timestamp
+        next true
+      end
+    end
+  end
+end

data/lib/reuse_query_results/version.rb

@@ -0,0 +1,3 @@
+module ReuseQueryResults
+  VERSION = "0.1"
+end

data/reuse_query_results.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reuse_query_results/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reuse_query_results"
+  spec.version       = ReuseQueryResults::VERSION
+  spec.authors       = ["morita shingo"]
+  spec.email         = ["eudoxa.jp@gmail.com"]
+  spec.summary       = "Reuse sql query results on development"
+  spec.description       = "Reuse sql query results on development"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/caching_query_spec.rb

@@ -0,0 +1,151 @@
+
+require 'spec_helper'
+
+module ReuseQueryResults
+  describe Storage do
+    before do
+      ReuseQueryResults.storage = ReuseQueryResults::Storage.new
+    end
+
+    def test_database_name
+      Bar.connection.instance_variable_get(:'@config')[:database]
+    end
+
+    def alter_database_name
+      AlterBar.connection.instance_variable_get(:'@config')[:database]
+    end
+
+    describe 'multi databases' do
+      it 'fetch from cache from each databases' do
+        allow(ReuseQueryResults.storage).to receive(:add).and_call_original
+        expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(bars), anything, anything).once.and_call_original
+        expect(ReuseQueryResults.storage).to receive(:add).with(alter_database_name, %w(bars), anything, anything).once.and_call_original
+        2.times { Bar.first.to_s }
+        2.times { AlterBar.first.to_s }
+      end
+
+      it "does not clear by other database's same name table" do
+        Bar.first
+        AlterBar.create!
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars)].keys.size).to eq 1
+      end
+    end
+
+    it 'cache result' do
+      Foo.first
+      expect(ReuseQueryResults.storage.databases[test_database_name][%w(foos)].keys.size).to eq 1
+    end
+
+    it 'add result first time' do
+      allow(ReuseQueryResults.storage).to receive(:add).and_call_original
+      expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(foos), anything, anything).once.and_call_original
+      Foo.first
+    end
+
+    it 'fetch from cache second time' do
+      allow(ReuseQueryResults.storage).to receive(:add).and_call_original
+      expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(foos), anything, anything).once.and_call_original
+      2.times { Foo.first.to_s }
+    end
+
+    it 'clear cache when insert' do
+      Foo.first
+      Foo.create!
+      expect(ReuseQueryResults.storage.databases[test_database_name][%w(foos)].keys.size).to eq 0
+    end
+
+    it 'clear cache when delete' do
+      Foo.create!
+      Foo.first
+      Foo.first.destroy
+      expect(ReuseQueryResults.storage.databases[test_database_name][%w(foos)].keys.size).to eq 0
+    end
+
+    it 'clear cache when update' do
+      Foo.create!(name: 'new')
+      Foo.first
+      Foo.first.update_attributes!(name: 'updated')
+      expect(ReuseQueryResults.storage.databases[test_database_name][%w(foos)].keys.size).to eq 0
+    end
+
+    context 'with join' do
+      it 'cache result' do
+        Foo.joins(:bar).first
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars foos)].keys.size).to eq 1
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(foos)].keys.size).to eq 0
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars)].keys.size).to eq 0
+      end
+
+      it 'clear cache when insert' do
+        Foo.joins(:bar).first
+        Foo.create!
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars foos)].keys.size).to eq 0
+      end
+    end
+
+    context 'with join' do
+      it 'cache result' do
+        Bar.create!(foo_id: Foo.create!.id)
+        Foo.joins(:bar).first
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars foos)].keys.size).to eq 1
+      end
+
+      it 'clear cache when insert' do
+        Foo.joins(:bar).first
+        Foo.create!
+        expect(ReuseQueryResults.storage.databases[test_database_name][%w(bars foos)].keys.size).to eq 0
+      end
+    end
+
+    describe 'sync mode' do
+      let(:sync_client_mock) do
+        double(:sync_client).tap do |client|
+          client.stub(:clear)
+        end
+      end
+
+      before do
+        ReuseQueryResults.storage = ReuseQueryResults::Storage.new(sync_client: sync_client_mock)
+        allow(sync_client_mock).to receive(:write)
+        allow(sync_client_mock).to receive(:read)
+        allow(ReuseQueryResults.storage).to receive(:add).and_call_original
+      end
+
+      it 'sync mode' do
+        expect(ReuseQueryResults.storage).to be_sync_mode
+      end
+
+      it 'update timestamp' do
+        expect(sync_client_mock).to receive(:write).with("#{test_database_name}+foos", kind_of(Numeric))
+        Foo.create!
+      end
+
+      it 'does not reuse query when table updated' do
+        expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(foos), anything, anything).twice.and_call_original
+        sync_client_mock.stub(:read).with("#{test_database_name}+foos") { (Time.now + 1.day).to_i }
+        2.times { Foo.first }
+      end
+
+      it 'reuse query when table no updated' do
+        expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(foos), anything, anything).once.and_call_original
+        sync_client_mock.stub(:read).with("#{test_database_name}+foos") { (Time.now - 1.day).to_i }
+        2.times { Foo.first }
+      end
+
+      describe 'joinned table' do
+        it 'does not reuse query when table updated' do
+          expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(bars foos), anything, anything).twice.and_call_original
+          sync_client_mock.stub(:read).with("#{test_database_name}+bars") { (Time.now + 1.day).to_i }
+          2.times { Foo.joins(:bar).first }
+        end
+
+        it 'reuse query when table no updated' do
+          expect(ReuseQueryResults.storage).to receive(:add).with(test_database_name, %w(bars foos), anything, anything).once.and_call_original
+          sync_client_mock.stub(:read).with("#{test_database_name}+bars") { (Time.now - 1.day).to_i }
+          2.times { Foo.joins(:bar).first }
+        end
+      end
+    end
+
+  end
+end

data/spec/config/database.yml

@@ -0,0 +1,11 @@
+test:
+  adapter: sqlite3
+  database: test.sqlite3
+  pool: 5
+  timeout: 5000
+
+alter_test:
+  adapter: sqlite3
+  database: test_alter.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/fake_app.rb

@@ -0,0 +1,38 @@
+require 'active_record/connection_handling'
+require 'active_record/railtie'
+require 'active_record/migration'
+
+module ReuseQueryResultsTestApp
+  Application = Class.new(Rails::Application) do
+    config.root = __dir__
+    config.eager_load = false
+    config.active_support.deprecation = :log
+  end.initialize!
+end
+
+
+# models
+class Foo < ActiveRecord::Base
+  has_one :bar
+end
+
+class Bar < ActiveRecord::Base
+  belongs_to :foo
+end
+
+class AlterBar < ActiveRecord::Base
+  self.table_name = 'bars'
+  establish_connection :alter_test
+end
+# migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:foos) {|t| t.string :name }
+    create_table(:bars) {|t| t.string :name; t.integer :foo_id }
+
+    test2_connection = ActiveRecord::Base.establish_connection(:alter_test).connection
+    test2_connection.create_table(:bars) {|t| t.string :name }
+
+    ActiveRecord::Base.establish_connection :test
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(__dir__)
+
+
+require 'rails'
+require 'reuse_query_results'
+require 'reuse_query_results/active_record_monkey_patch'
+require 'fake_app'
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'foos'
+  end
+
+  config.after :each do
+    ReuseQueryResults.storage.clear_all
+    [Foo, Bar, AlterBar].each {|m| m.delete_all }
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: reuse_query_results
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- morita shingo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rails
+  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'
+description: Reuse sql query results on development
+email:
+- eudoxa.jp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/reuse_query_results.rb
+- lib/reuse_query_results/active_record_monkey_patch.rb
+- lib/reuse_query_results/railtie.rb
+- lib/reuse_query_results/storage.rb
+- lib/reuse_query_results/version.rb
+- reuse_query_results.gemspec
+- spec/caching_query_spec.rb
+- spec/config/database.yml
+- spec/fake_app.rb
+- spec/spec_helper.rb
+homepage: ''
+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.14
+signing_key: 
+specification_version: 4
+summary: Reuse sql query results on development
+test_files:
+- spec/caching_query_spec.rb
+- spec/config/database.yml
+- spec/fake_app.rb
+- spec/spec_helper.rb