activerecord-mysql-index-hint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b947256880defc67e564ff3b5710672ef010b8d8
+  data.tar.gz: acd5aeea0b4cdc5aa6ef031a96831b678c5f7c7f
+SHA512:
+  metadata.gz: e2375a761ac04b91400e5483b492612c242ce50a07e516def9dc5dc5101f941482ec662d890c3901e4d9fea9b1d8bfc274ba870328711945d46d8682af6729ad
+  data.tar.gz: 1fb48165d7f17a309cc09090738b8d39bd3964f44d36bad6dd38917fee7b9ea510b812c644282c4bf6d2c758df93a17afe27066d04d12c66f32c18a7f75658a2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+install: bundle install
+script: bundle exec rake spec
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "3.2" do
+  gem "activerecord", "~> 3.2.15"
+  gem "activerecord-mysql-index-hint", :path => "../"
+end
+
+appraise "4.0" do
+  gem "activerecord", "~> 4.0.0"
+  gem "activerecord-mysql-index-hint", :path => "../"
+end

data/ChangeLog.md

@@ -0,0 +1,3 @@
+# ChangeLog
+## 0.0.1
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Issei Naruta
+
+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,19 @@
+[![Build Status](https://travis-ci.org/mirakui/activerecord-mysql-index-hint.png)](https://travis-ci.org/mirakui/activerecord-mysql-index-hint)
+
+# activerecord-mysql-index-hint
+
+MySQL index hint support for ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-mysql-index-hint'
+
+## Usage
+
+    class Product < ActiveRecord::Base
+    end
+
+    Product.where(user_id: 1).force_index(:idx_user_id).first
+    # => SELECT `products`.* FROM `products` FORCE INDEX(`idx_user_id`) WHERE `products`.`user_id` = 1 LIMIT 1

data/Rakefile

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

data/activerecord-mysql-index-hint.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord-mysql-index-hint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-mysql-index-hint"
+  spec.version       = ActiveRecordMysqlIndexHint::VERSION
+  spec.authors       = ["Issei Naruta"]
+  spec.email         = ["naruta@cookpad.com"]
+  spec.description   = %q{MySQL index hint support for ActiveRecord}
+  spec.summary       = %q{MySQL index hint support for ActiveRecord}
+  spec.homepage      = "https://github.com/mirakui/activerecord-mysql-index-hint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 3.1'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'mysql2'
+end

data/gemfiles/3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.15"
+gem "activerecord-mysql-index-hint", :path=>"../"
+
+gemspec :path=>"../"

data/gemfiles/4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "activerecord-mysql-index-hint", :path=>"../"
+
+gemspec :path=>"../"

data/lib/activerecord-mysql-index-hint.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'active_record/relation/query_methods'
+
+module ActiveRecordMysqlIndexHint
+  def use_index(*args)
+    from_with_index_hint 'USE', *args
+  end
+
+  def force_index(*args)
+    from_with_index_hint 'FORCE', *args
+  end
+
+  def ignore_index(*args)
+    from_with_index_hint 'IGNORE', *args
+  end
+
+  private
+  def from_with_index_hint(hint_type, *args)
+    return self if args.blank?
+    indexes = args.map {|index| connection.quote_column_name index }
+    self.from("#{quoted_table_name} #{hint_type} INDEX(#{indexes.join(', ')})")
+  end
+end
+
+ActiveRecord::Base.send :extend, ActiveRecordMysqlIndexHint
+ActiveRecord::Relation.send :include, ActiveRecordMysqlIndexHint

data/lib/activerecord-mysql-index-hint/version.rb

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

data/spec/activerecord-mysql-index-hint_spec.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+require 'mysql2'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'activerecord-mysql-index-hint'
+
+module Mysql2
+  class Client
+    def initialize(opts={})
+      @query_options = @@default_query_options.dup.merge opts
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::Mysql2Adapter.class_eval do
+  def quote_string(string)
+    string
+  end
+  def configure_connection
+  end
+end
+
+Arel::Visitors::ToSql.class_eval do
+  def column_for o
+    nil
+  end
+end
+
+class Product < ActiveRecord::Base
+  establish_connection 'mysql2://user@host/db'
+end
+
+describe 'ActiveRecord Index Hint' do
+  context 'with AR::Relation' do
+    it do
+      expect(
+        Product.limit(1).use_index(:idx1).to_sql
+      ).to eq('SELECT  `products`.* FROM `products` USE INDEX(`idx1`)  LIMIT 1')
+    end
+
+    it do
+      expect(
+        Product.limit(1).force_index(:idx1).to_sql
+      ).to eq('SELECT  `products`.* FROM `products` FORCE INDEX(`idx1`)  LIMIT 1')
+    end
+
+    it do
+      expect(
+        Product.limit(1).ignore_index(:idx1).to_sql
+      ).to eq('SELECT  `products`.* FROM `products` IGNORE INDEX(`idx1`)  LIMIT 1')
+    end
+  end
+
+  context 'with AR::Base' do
+    it do
+      expect(
+        Product.use_index(:idx1).limit(1).to_sql
+      ).to eq('SELECT  `products`.* FROM `products` USE INDEX(`idx1`)  LIMIT 1')
+    end
+  end
+
+  context 'with multiple indexes' do
+    it do
+      expect(
+        Product.limit(1).use_index(:idx1, :idx2).to_sql
+      ).to eq('SELECT  `products`.* FROM `products` USE INDEX(`idx1`, `idx2`)  LIMIT 1')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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,146 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-mysql-index-hint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Issei Naruta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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: appraisal
+  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: mysql2
+  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: MySQL index hint support for ActiveRecord
+email:
+- naruta@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-mysql-index-hint.gemspec
+- gemfiles/3.2.gemfile
+- gemfiles/4.0.gemfile
+- lib/activerecord-mysql-index-hint.rb
+- lib/activerecord-mysql-index-hint/version.rb
+- spec/activerecord-mysql-index-hint_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mirakui/activerecord-mysql-index-hint
+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: MySQL index hint support for ActiveRecord
+test_files:
+- spec/activerecord-mysql-index-hint_spec.rb
+- spec/spec_helper.rb