arel-mysql-index-hint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b494fd4bb3092702e7964b5c9cfc1b0b2f9b6e69
+  data.tar.gz: 39d422ba66f4ef1cd670a1228aeb19ace36cd1ae
+SHA512:
+  metadata.gz: 0c4b471e7da946caf78029c2d3f8f0c41fada63d10db3b2a741a39d2413eeb565cdf37db1c3040a8c5ba7e825be69e280b32eb2684eb501ac885a8a6a7848cae
+  data.tar.gz: c0e5a925a0177f4f4fb1dcedc5a6d9b58a5b3563ee83b918360a1ef2b74a56329822f6d18253c98ed5b2a9cae16b0b616843ab3e0fddb54df54af805a5bbcfb1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+script:
+  - bundle install
+  - bundle exec rake

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genki Sugawara
+
+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,33 @@
+# arel-mysql-index-hint
+
+Add index hint to MySQL query in Arel.
+
+[![Gem Version](https://badge.fury.io/rb/arel-mysql-index-hint.svg)](http://badge.fury.io/rb/arel-mysql-index-hint)
+[![Build Status](https://travis-ci.org/winebarrel/arel-mysql-index-hint.svg?branch=master)](https://travis-ci.org/winebarrel/arel-mysql-index-hint)
+[![Coverage Status](https://img.shields.io/coveralls/winebarrel/arel-mysql-index-hint.svg)](https://coveralls.io/r/winebarrel/arel-mysql-index-hint?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arel-mysql-index-hint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arel-mysql-index-hint
+
+## Usage
+
+```ruby
+Article.joins(:comments).hint(articles: {idx_article: :use})
+# => "SELECT `articles`.* FROM `articles` use INDEX (idx_article) INNER JOIN `comments` ON `comments`
+
+Article.joins(:comments).hint(comments: {idx_comment: :force})
+# => "SELECT `articles`.* FROM `articles` INNER JOIN `comments` force INDEX (idx_comment) ON `comments"
+```

data/Rakefile

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

data/Schemafile

@@ -0,0 +1,33 @@
+  create_table "microposts", force: true do |t|
+    t.string   "content"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "microposts", ["user_id", "created_at"], name: "index_microposts_on_user_id_and_created_at"
+
+  create_table "relationships", force: true do |t|
+    t.integer  "follower_id"
+    t.integer  "followed_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "relationships", ["followed_id"], name: "index_relationships_on_followed_id"
+  add_index "relationships", ["follower_id", "followed_id"], name: "index_relationships_on_follower_id_and_followed_id", unique: true
+  add_index "relationships", ["follower_id"], name: "index_relationships_on_follower_id"
+
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "password_digest"
+    t.string   "remember_token"
+    t.boolean  "admin"
+  end
+
+  add_index "users", ["email"], name: "index_users_on_email", unique: true
+  add_index "users", ["remember_token"], name: "index_users_on_remember_token"
+

data/arel-mysql-index-hint.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "arel-mysql-index-hint"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Genki Sugawara"]
+  spec.email         = ["sgwr_dts@yahoo.co.jp"]
+  spec.summary       = %q{Add index hint to MySQL query in Arel.}
+  spec.description   = %q{Add index hint to MySQL query in Arel.}
+  spec.homepage      = "https://github.com/winebarrel/arel-mysql-index-hint"
+  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_dependency "activerecord", "~> 4.1.0"
+  spec.add_dependency "arel", "~> 5.0.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "coveralls"
+end

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

@@ -0,0 +1,5 @@
+require "active_record"
+
+require "arel-mysql-index-hint/active_record-hint_methods"
+require "arel-mysql-index-hint/active_record-querying"
+require "arel-mysql-index-hint/arel-visitors-mysql"

data/lib/arel-mysql-index-hint/active_record-hint_methods.rb

@@ -0,0 +1,11 @@
+module ActiveRecord::HintMethods
+  def hint(index_hint_by_table)
+    thread_index_hint_by_table = (Thread.current[Arel::Visitors::MySQL::INDEX_HINT_BY_TABLE_THREAD_KEY] ||= {}.with_indifferent_access)
+    thread_index_hint_by_table.update(index_hint_by_table)
+    self
+  end
+end
+
+ActiveRecord::Relation.class_eval do
+  include ActiveRecord::HintMethods
+end

data/lib/arel-mysql-index-hint/active_record-querying.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Querying.class_eval do
+  delegate :hint, :to => :all
+end

data/lib/arel-mysql-index-hint/arel-visitors-mysql.rb

@@ -0,0 +1,42 @@
+class Arel::Visitors::MySQL
+  INDEX_HINT_BY_TABLE_THREAD_KEY = "INDEX_HINT_BY_TABLE_THREAD_KEY"
+
+  def accept_with_index_hint(object)
+    retval = accept_without_index_hint(object)
+    clear_index_hint_by_table
+    retval
+  end
+
+  alias_method_chain :accept, :index_hint
+
+  def visit_Arel_Table_with_index_hint(o, a)
+    sql = visit_Arel_Table_without_index_hint(o, a)
+    index_hint = get_index_hint(o.name)
+
+    if index_hint
+      append_index_hint(sql, index_hint)
+    else
+      sql
+    end
+  end
+
+  alias_method_chain :visit_Arel_Table, :index_hint
+
+  private
+
+  def get_index_hint(table)
+    index_hint_by_table = Thread.current[INDEX_HINT_BY_TABLE_THREAD_KEY]
+    index_hint_by_table.try(:[], table)
+  end
+
+  def clear_index_hint_by_table
+    Thread.current[INDEX_HINT_BY_TABLE_THREAD_KEY] = nil
+  end
+
+  def append_index_hint(sql, index_hint)
+    sql + " " + index_hint.map {|index, hint_type|
+      index = Array(index)
+      "#{hint_type} INDEX (#{index.join(', ')})"
+    }.join(", ")
+  end
+end

data/spec/arel-mysql-index-hint/eager_load_spec.rb

@@ -0,0 +1,53 @@
+describe "arel-mysql-index-hint" do
+  describe "#eager_load" do
+    context "when single index" do
+      subject do
+        User.
+          eager_load(:microposts).
+          where(microposts: {id: 1}).
+          hint(microposts: {index_microposts_on_user_id_and_created_at: hint_type}).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.`id` AS t0_r0, `users`.`name` AS t0_r1, `users`.`email` AS t0_r2, `users`.`created_at` AS t0_r3, `users`.`updated_at` AS t0_r4, `users`.`password_digest` AS t0_r5, `users`.`remember_token` AS t0_r6, `users`.`admin` AS t0_r7, `microposts`.`id` AS t1_r0, `microposts`.`content` AS t1_r1, `microposts`.`user_id` AS t1_r2, `microposts`.`created_at` AS t1_r3, `microposts`.`updated_at` AS t1_r4 " +
+        "FROM `users` " +
+        "LEFT OUTER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id` " +
+        "WHERE `microposts`.`id` = 1"
+      end
+
+      let(:hint_type) { :force }
+
+      it { is_expected.to eq sql }
+    end
+
+    context "when multiple indexes" do
+      subject do
+        User.
+          eager_load(:microposts).
+          where(microposts: {id: 1}).
+          hint(
+            users: {index_users_on_email: hint_type},
+            microposts: {index_microposts_on_user_id_and_created_at: hint_type},
+          ).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.`id` AS t0_r0, `users`.`name` AS t0_r1, `users`.`email` AS t0_r2, `users`.`created_at` AS t0_r3, `users`.`updated_at` AS t0_r4, `users`.`password_digest` AS t0_r5, `users`.`remember_token` AS t0_r6, `users`.`admin` AS t0_r7, `microposts`.`id` AS t1_r0, `microposts`.`content` AS t1_r1, `microposts`.`user_id` AS t1_r2, `microposts`.`created_at` AS t1_r3, `microposts`.`updated_at` AS t1_r4 " +
+        "FROM `users` " +
+        "force INDEX (index_users_on_email) " +
+        "LEFT OUTER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id` " +
+        "WHERE `microposts`.`id` = 1"
+      end
+
+      let(:hint_type) { :force }
+
+      it { is_expected.to eq sql }
+    end
+  end
+end

data/spec/arel-mysql-index-hint/includes_spec.rb

@@ -0,0 +1,53 @@
+describe "arel-mysql-index-hint" do
+  describe "#includes" do
+    context "when single index" do
+      subject do
+        User.
+          includes(:microposts).
+          where(microposts: {id: 1}).
+          hint(microposts: {index_microposts_on_user_id_and_created_at: hint_type}).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.`id` AS t0_r0, `users`.`name` AS t0_r1, `users`.`email` AS t0_r2, `users`.`created_at` AS t0_r3, `users`.`updated_at` AS t0_r4, `users`.`password_digest` AS t0_r5, `users`.`remember_token` AS t0_r6, `users`.`admin` AS t0_r7, `microposts`.`id` AS t1_r0, `microposts`.`content` AS t1_r1, `microposts`.`user_id` AS t1_r2, `microposts`.`created_at` AS t1_r3, `microposts`.`updated_at` AS t1_r4 " +
+        "FROM `users` " +
+        "LEFT OUTER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id` " +
+        "WHERE `microposts`.`id` = 1"
+      end
+
+      let(:hint_type) { :force }
+
+      it { is_expected.to eq sql }
+    end
+
+    context "when multiple indexes" do
+      subject do
+        User.
+          includes(:microposts).
+          where(microposts: {id: 1}).
+          hint(
+            users: {index_users_on_email: hint_type},
+            microposts: {index_microposts_on_user_id_and_created_at: hint_type},
+          ).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.`id` AS t0_r0, `users`.`name` AS t0_r1, `users`.`email` AS t0_r2, `users`.`created_at` AS t0_r3, `users`.`updated_at` AS t0_r4, `users`.`password_digest` AS t0_r5, `users`.`remember_token` AS t0_r6, `users`.`admin` AS t0_r7, `microposts`.`id` AS t1_r0, `microposts`.`content` AS t1_r1, `microposts`.`user_id` AS t1_r2, `microposts`.`created_at` AS t1_r3, `microposts`.`updated_at` AS t1_r4 " +
+        "FROM `users` " +
+        "force INDEX (index_users_on_email) " +
+        "LEFT OUTER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id` " +
+        "WHERE `microposts`.`id` = 1"
+      end
+
+      let(:hint_type) { :force }
+
+      it { is_expected.to eq sql }
+    end
+  end
+end

data/spec/arel-mysql-index-hint/joins_spec.rb

@@ -0,0 +1,105 @@
+describe "arel-mysql-index-hint" do
+  describe "#joins" do
+    context "when single index" do
+      subject do
+        User.
+          joins(:microposts).
+          hint(microposts: {index_microposts_on_user_id_and_created_at: hint_type}).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.* FROM `users` " +
+        "INNER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id`"
+      end
+
+      context "force index" do
+        let(:hint_type) { :force }
+        it { is_expected.to eq sql }
+      end
+
+      context "use index" do
+        let(:hint_type) { :user }
+        it { is_expected.to eq sql }
+      end
+
+      context "ignore index" do
+        let(:hint_type) { :ignore }
+        it { is_expected.to eq sql }
+      end
+    end
+
+    context "when multiple indexes" do
+      subject do
+        User.
+          joins(:microposts).
+          hint(
+            users: {index_users_on_email: hint_type},
+            microposts: {index_microposts_on_user_id_and_created_at: hint_type},
+          ).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.* FROM `users` " +
+        "#{hint_type} INDEX (index_users_on_email) " +
+        "INNER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id`"
+      end
+
+      context "force index" do
+        let(:hint_type) { :force }
+        it { is_expected.to eq sql }
+      end
+
+      context "use index" do
+        let(:hint_type) { :user }
+        it { is_expected.to eq sql }
+      end
+
+      context "ignore index" do
+        let(:hint_type) { :ignore }
+        it { is_expected.to eq sql }
+      end
+    end
+
+    context "when add hint before joins" do
+      subject do
+        User.
+          hint(microposts: {index_microposts_on_user_id_and_created_at: hint_type}).
+          joins(:microposts).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.* FROM `users` " +
+        "INNER JOIN `microposts` " +
+        "#{hint_type} INDEX (index_microposts_on_user_id_and_created_at) " +
+        "ON `microposts`.`user_id` = `users`.`id`"
+      end
+
+      let(:hint_type) { :force }
+
+      it { is_expected.to eq sql }
+    end
+
+    context "when without index" do
+      subject do
+        User.
+          joins(:microposts).
+          to_sql
+      end
+
+      let(:sql) do
+        "SELECT `users`.* FROM `users` " +
+        "INNER JOIN `microposts` " +
+        "ON `microposts`.`user_id` = `users`.`id`"
+      end
+
+      it { is_expected.to eq sql }
+    end
+  end
+end

data/spec/arel-mysql-index-hint/preload_spec.rb

@@ -0,0 +1,22 @@
+describe "arel-mysql-index-hint" do
+  describe "#preload" do
+    subject do
+      User.
+        where(id: 1).
+        preload(:microposts).
+        hint(users: {index_users_on_email: hint_type}).
+        to_sql
+    end
+
+    let(:sql) do
+      "SELECT `users`.* " +
+      "FROM `users` " +
+      "force INDEX (index_users_on_email)  " +
+      "WHERE `users`.`id` = 1"
+    end
+
+    let(:hint_type) { :force }
+
+    it { is_expected.to eq sql }
+  end
+end

data/spec/arel-mysql-index-hint/without_join_spec.rb

@@ -0,0 +1,103 @@
+describe "arel-mysql-index-hint" do
+  describe "#all" do
+    subject do
+      User.
+        all.
+        hint(users: {index_users_on_email: hint_type}).
+        to_sql
+    end
+
+    let(:sql) do
+      "SELECT `users`.* " +
+      "FROM `users` " +
+      "#{hint_type} INDEX (index_users_on_email)"
+    end
+
+    let(:hint_type) { :force }
+
+    it { is_expected.to eq sql }
+  end
+
+  describe "call nothing" do
+    subject do
+      User.
+        hint(users: {index_users_on_email: hint_type}).
+        to_sql
+    end
+
+    let(:sql) do
+      "SELECT `users`.* " +
+      "FROM `users` " +
+      "#{hint_type} INDEX (index_users_on_email)"
+    end
+
+    let(:hint_type) { :force }
+
+    it { is_expected.to eq sql }
+  end
+
+  describe "#limit" do
+    subject do
+      User.
+        limit(1).
+        hint(users: {index_users_on_email: hint_type}).
+        to_sql
+    end
+
+    let(:sql) do
+      "SELECT  `users`.* " +
+      "FROM `users` " +
+      "#{hint_type} INDEX (index_users_on_email)  " +
+      "LIMIT 1"
+    end
+
+    let(:hint_type) { :force }
+
+    it { is_expected.to eq sql }
+  end
+
+  describe "#first" do
+    subject do
+      User.
+        hint(users: {index_users_on_email: hint_type}).
+        first
+    end
+
+    let(:sql) do
+      "SELECT  `users`.* FROM `users` " +
+      "#{hint_type} INDEX (index_users_on_email)   " +
+      "ORDER BY `users`.`id` ASC " +
+      "LIMIT 1"
+    end
+
+    let(:hint_type) { :force }
+
+    it do
+      subject
+
+      expect(sql_log).to include sql
+    end
+  end
+
+  describe "#take" do
+    subject do
+      User.
+        hint(users: {index_users_on_email: hint_type}).
+        take
+    end
+
+    let(:sql) do
+      "SELECT  `users`.* FROM `users` " +
+      "#{hint_type} INDEX (index_users_on_email)  " +
+      "LIMIT 1"
+    end
+
+    let(:hint_type) { :force }
+
+    it do
+      subject
+
+      expect(sql_log).to include sql
+    end
+  end
+end

data/spec/init.sql

@@ -0,0 +1,45 @@
+# original: https://github.com/railstutorial/sample_app_rails_4
+
+DROP DATABASE IF EXISTS `arel_mysql_index_hint_test`;
+CREATE DATABASE `arel_mysql_index_hint_test` DEFAULT CHARSET=utf8;
+
+USE `arel_mysql_index_hint_test`;
+
+DROP TABLE IF EXISTS `microposts`;
+CREATE TABLE `microposts` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `content` varchar(255) DEFAULT NULL,
+  `user_id` int(11) DEFAULT NULL,
+  `created_at` datetime DEFAULT NULL,
+  `updated_at` datetime DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_microposts_on_user_id_and_created_at` (`user_id`,`created_at`)
+) DEFAULT CHARSET=utf8;
+
+DROP TABLE IF EXISTS `relationships`;
+CREATE TABLE `relationships` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `follower_id` int(11) DEFAULT NULL,
+  `followed_id` int(11) DEFAULT NULL,
+  `created_at` datetime DEFAULT NULL,
+  `updated_at` datetime DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `index_relationships_on_follower_id_and_followed_id` (`follower_id`,`followed_id`),
+  KEY `index_relationships_on_followed_id` (`followed_id`),
+  KEY `index_relationships_on_follower_id` (`follower_id`)
+) DEFAULT CHARSET=utf8;
+
+DROP TABLE IF EXISTS `users`;
+CREATE TABLE `users` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(255) DEFAULT NULL,
+  `email` varchar(255) DEFAULT NULL,
+  `created_at` datetime DEFAULT NULL,
+  `updated_at` datetime DEFAULT NULL,
+  `password_digest` varchar(255) DEFAULT NULL,
+  `remember_token` varchar(255) DEFAULT NULL,
+  `admin` tinyint(1) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `index_users_on_email` (`email`),
+  KEY `index_users_on_remember_token` (`remember_token`)
+) DEFAULT CHARSET=utf8;

data/spec/models.rb

@@ -0,0 +1,37 @@
+# original: https://github.com/railstutorial/sample_app_rails_4
+require "factory_girl"
+
+class Micropost < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Relationship < ActiveRecord::Base
+  belongs_to :follower, class_name: "User"
+  belongs_to :followed, class_name: "User"
+end
+
+class User < ActiveRecord::Base
+  has_many :microposts, dependent: :destroy
+  has_many :relationships, foreign_key: "follower_id", dependent: :destroy
+  has_many :followed_users, through: :relationships, source: :followed
+  has_many :reverse_relationships, foreign_key: "followed_id",
+                                   class_name:  "Relationship",
+                                   dependent:   :destroy
+  has_many :followers, through: :reverse_relationships, source: :follower
+end
+
+FactoryGirl.define do
+  factory :user do
+    sequence(:name)  { |n| "Person #{n}" }
+    sequence(:email) { |n| "person_#{n}@example.com"}
+
+    factory :admin do
+      admin true
+    end
+  end
+
+  factory :micropost do
+    content "Lorem ipsum"
+    user
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+if ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+
+  SimpleCov.start do
+    add_filter "spec/"
+  end
+end
+
+require "arel-mysql-index-hint"
+require "models"
+
+$__arel_mysql_index_hint_sql_log__ = []
+
+ActiveSupport::Notifications.subscribe('sql.active_record') do |name, start, finish, id, payload|
+  $__arel_mysql_index_hint_sql_log__ << payload[:sql]
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    init_database
+
+    ActiveRecord::Base.establish_connection(
+      adapter: 'mysql2',
+      database: 'arel_mysql_index_hint_test'
+    )
+  end
+
+  config.before(:each) do
+    $__arel_mysql_index_hint_sql_log__.clear
+  end
+end
+
+def init_database
+  sql_file = File.expand_path('../init.sql', __FILE__)
+  system("mysql -uroot < #{sql_file}")
+end
+
+def sql_log
+  $__arel_mysql_index_hint_sql_log__.dup
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: arel-mysql-index-hint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: coveralls
+  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: Add index hint to MySQL query in Arel.
+email:
+- sgwr_dts@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Schemafile
+- arel-mysql-index-hint.gemspec
+- lib/arel-mysql-index-hint.rb
+- lib/arel-mysql-index-hint/active_record-hint_methods.rb
+- lib/arel-mysql-index-hint/active_record-querying.rb
+- lib/arel-mysql-index-hint/arel-visitors-mysql.rb
+- spec/arel-mysql-index-hint/eager_load_spec.rb
+- spec/arel-mysql-index-hint/includes_spec.rb
+- spec/arel-mysql-index-hint/joins_spec.rb
+- spec/arel-mysql-index-hint/preload_spec.rb
+- spec/arel-mysql-index-hint/without_join_spec.rb
+- spec/init.sql
+- spec/models.rb
+- spec/spec_helper.rb
+homepage: https://github.com/winebarrel/arel-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.14
+signing_key: 
+specification_version: 4
+summary: Add index hint to MySQL query in Arel.
+test_files:
+- spec/arel-mysql-index-hint/eager_load_spec.rb
+- spec/arel-mysql-index-hint/includes_spec.rb
+- spec/arel-mysql-index-hint/joins_spec.rb
+- spec/arel-mysql-index-hint/preload_spec.rb
+- spec/arel-mysql-index-hint/without_join_spec.rb
+- spec/init.sql
+- spec/models.rb
+- spec/spec_helper.rb