activerecord-indexhint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36f572d0c8ee57d4b63c1d2f0757bbdefe36b7e8
+  data.tar.gz: d028e8e1853337c51b585d5a4ea58c7f9c2663d8
+SHA512:
+  metadata.gz: 6a69da9a0d84c18c11e9d9f17107df08584b982aea428e4010107a8f8b7060752836c73a10fe5f8c1f81fbc25013d8430f3974360cc5dbd72b34ef8293ff89b0
+  data.tar.gz: cebd12473a6ea794f360203e401169a4a77e526db99ac19d492065d8ce8f50baf89645d02535262b9e287d918f22c6ed86e98822bf92381b71939a9913412e67

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
+log
+vendor

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  DisplayCopNames: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/GuardClause:
+  MinBodyLength: 5
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+
+Metrics/LineLength:
+  Max: 160
+  Exclude:
+    - "db/migrate/*.rb"
+
+NumericLiterals:
+  MinDigits: 7
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/BlockAlignment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
+FileName:
+  Exclude:
+    - 'lib/activerecord-indexhint.rb'
+    - 'spec/tasks/activerecord-indexhint_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.1.7
+  - 2.0.0-p647
+before_install: gem install bundler -v 1.10.6
+services:
+  - mysql
+script:
+  - bundle exec rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 hirocaster
+
+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,45 @@
+# Activerecord::Indexhint
+
+[![Build Status](https://travis-ci.org/hirocaster/activerecord-indexhint.svg?branch=master)](https://travis-ci.org/hirocaster/activerecord-indexhint) [![Coverage Status](https://coveralls.io/repos/hirocaster/activerecord-slave/badge.svg?branch=master&service=github)](https://coveralls.io/github/hirocaster/activerecord-slave?branch=master) [![Code Climate](https://codeclimate.com/github/hirocaster/activerecord-indexhint/badges/gpa.svg)](https://codeclimate.com/github/hirocaster/activerecord-indexhint) [![Dependency Status](https://gemnasium.com/hirocaster/activerecord-indexhint.svg)](https://gemnasium.com/hirocaster/activerecord-indexhint)
+
+Add method, index hint(use/ignore/force index) for ActiveRecord(MySQL).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-indexhint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-indexhint
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+end
+
+index_name = "index_users_on_name"
+
+User.use_index(index_name).where(name: "foo")
+# => "SELECT `users`.* FROM `users` USE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"
+
+User.ignore_index(index_name).where(name: "foo")
+# => "SELECT `users`.* FROM `users` IGNORE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"
+
+User.force_index(index_name).where(name: "foo")
+# => "SELECT `users`.* FROM `users` FORCE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/hirocaster/activerecord-indexhint/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-indexhint.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/index_hint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-indexhint"
+  spec.version       = ActiveRecord::IndexHint::VERSION
+  spec.authors       = ["hirocaster"]
+  spec.email         = ["hohtsuka@gmail.com"]
+  spec.summary       = "Add index hints method(use/ignore/force index) to ActiveRecord"
+  spec.description   = "Add index hints method(use/ignore/force index) to ActiveRecord"
+  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.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency "activerecord", ">= 4.1.0"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "database_rewinder"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/active_record/index_hint/errors.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module IndexHint
+    class Error < ::StandardError
+    end
+
+    class StatementInvalid < Error
+    end
+  end
+end

data/lib/active_record/index_hint/model.rb

@@ -0,0 +1,38 @@
+require "active_support/concern"
+require "active_support/core_ext"
+
+module ActiveRecord
+  module IndexHint
+    module Model
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def use_index(*index_names)
+          from_index :use, *index_names
+        end
+
+        def ignore_index(*index_names)
+          ignore_indexes = validate_index_lists(*index_names)
+          from_index :ignore, *ignore_indexes
+        end
+
+        def force_index(*index_names)
+          force_indexes = validate_index_lists(*index_names)
+          from_index :force, *force_indexes
+        end
+
+        private
+
+          def validate_index_lists(*index_names)
+            index_lists = index_names.compact
+            raise ActiveRecord::IndexHint::StatementInvalid, "You have an error in your SQL syntax; Please, set index_names" if index_lists.blank?
+            index_lists
+          end
+
+          def from_index(index_hint, *index_lists)
+            from "#{quoted_table_name} #{index_hint.upcase} INDEX (#{index_lists.join ', '})"
+          end
+      end
+    end
+  end
+end

data/lib/active_record/index_hint/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module IndexHint
+    VERSION = "0.0.1"
+  end
+end

data/lib/activerecord-indexhint.rb

@@ -0,0 +1,11 @@
+require "active_support/lazy_load_hooks"
+require "active_record"
+
+require "active_record/index_hint/version"
+require "active_record/index_hint/errors"
+
+ActiveSupport.on_load(:active_record) do
+  require "active_record/index_hint/model"
+
+  ActiveRecord::Base.send(:include, ActiveRecord::IndexHint::Model)
+end

data/spec/active_record/index_hint/model_spec.rb

@@ -0,0 +1,85 @@
+describe "ActiveRecord::IndexHint::Model" do
+  describe ".create" do
+    it "return Model object" do
+      expect(User.create name: "foobar").to be_a User
+    end
+  end
+
+  describe ".use_index" do
+    it "has use_index method" do
+      expect(User.respond_to? :use_index).to be true
+    end
+
+    context "Give non hint, not use index" do
+      it "`USE INDEX` in SQL Query" do
+        expect(User.use_index(nil).to_sql).to be_include "FROM `users` USE INDEX ()"
+      end
+    end
+
+    context "Give one hint" do
+      it "`USE INDEX` in SQL Query" do
+        expect(User.use_index("PRIMARY").to_sql).to be_include "FROM `users` USE INDEX (PRIMARY)"
+      end
+    end
+
+    context "Give two hint" do
+      it "`USE INDEX` in SQL Query" do
+        expect(User.use_index("index_users_on_name", "PRIMARY").to_sql).to be_include "FROM `users` USE INDEX (index_users_on_name, PRIMARY)"
+      end
+    end
+  end
+
+  describe ".ignore_index" do
+    it "has ignore_index method" do
+      expect(User.respond_to? :ignore_index).to be true
+    end
+
+    context "Give non hint" do
+      it "raise SQL Syntax Error" do
+        expect { User.ignore_index nil }.to raise_error ActiveRecord::IndexHint::StatementInvalid
+      end
+    end
+
+    context "Give two hint" do
+      it "`IGNORE INDEX` in SQL Query" do
+        expect(User.ignore_index("index_users_on_name", "PRIMARY").to_sql).to be_include "FROM `users` IGNORE INDEX (index_users_on_name, PRIMARY)"
+      end
+    end
+
+    context "nil in hints" do
+      it "Deleted nil, `IGNORE INDEX` in SQL Query" do
+        expect(User.ignore_index("index_users_on_name", nil, "PRIMARY").to_sql).to be_include "FROM `users` IGNORE INDEX (index_users_on_name, PRIMARY)"
+      end
+    end
+  end
+
+  describe ".force_index" do
+    it "has force_index method" do
+      expect(User.respond_to? :force_index).to be true
+    end
+
+    context "Give non hint" do
+      it "raise SQL Syntax Error" do
+        expect { User.force_index nil }.to raise_error ActiveRecord::IndexHint::StatementInvalid
+      end
+    end
+
+    context "Give one hint" do
+      it "`FORCE INDEX` in SQL Query" do
+        expect(User.force_index("PRIMARY").to_sql).to be_include "FROM `users` FORCE INDEX (PRIMARY)"
+      end
+    end
+
+    context "Give two hint" do
+      it "`FORCE INDEX` in SQL Query" do
+        expect(User.force_index("index_users_on_name", "PRIMARY").to_sql).to be_include "FROM `users` FORCE INDEX (index_users_on_name, PRIMARY)"
+      end
+    end
+
+    context "nil in hints" do
+      it "Deleted nil, `FORCE INDEX` in SQL Query" do
+        expect(User.force_index("index_users_on_name", nil, "PRIMARY").to_sql).to be_include "FROM `users` FORCE INDEX (index_users_on_name, PRIMARY)"
+      end
+    end
+  end
+end

data/spec/active_record/index_hint/version_spec.rb

@@ -0,0 +1,5 @@
+describe "ActiveRecord::IndexHint::VERSION" do
+  it "return version number" do
+    expect(ActiveRecord::IndexHint::VERSION).to be_a String
+  end
+end

data/spec/models.rb

@@ -0,0 +1,10 @@
+base = { "adapter" => "mysql2", "encoding" => "utf8", "pool" => 5, "username" => "root", "password" => "", "host" => "127.0.0.1" }
+
+ActiveRecord::Base.configurations = {
+  "test" => base.merge("database" => "test")
+}
+
+ActiveRecord::Base.establish_connection(:test)
+
+class User < ActiveRecord::Base
+end

data/spec/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table "users", force: :cascade do |t|
+    t.string "name", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+
+    t.index "name", unique: false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require "simplecov"
+require "coveralls"
+require "codeclimate-test-reporter"
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter,
+  CodeClimate::TestReporter::Formatter
+]
+SimpleCov.start do
+  add_filter "/spec"
+  add_filter "/vendor"
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "activerecord-indexhint"
+require "pry"
+require "pry-byebug"
+require "awesome_print"
+require "database_rewinder"
+
+require_relative "models"
+
+log_directry = File.expand_path("../../log/", __FILE__)
+Dir.mkdir log_directry unless Dir.exist? log_directry
+ActiveRecord::Base.logger = Logger.new("#{log_directry}/test.log")
+
+RSpec.configure do |config|
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.before(:suite) do
+    ActiveRecord::Tasks::DatabaseTasks.db_dir = File.expand_path "..", __FILE__
+    ActiveRecord::Tasks::DatabaseTasks.root   = File.expand_path "../..", __FILE__
+    ActiveRecord::Tasks::DatabaseTasks.env    = "test"
+
+    configuration = ActiveRecord::Base.configurations["test"]
+    ActiveRecord::Tasks::DatabaseTasks.drop(configuration)
+    ActiveRecord::Tasks::DatabaseTasks.create(configuration)
+
+    ActiveRecord::Tasks::DatabaseTasks.load_schema_for configuration, :ruby
+
+    DatabaseRewinder["test"]
+  end
+
+  config.after(:each) do
+    DatabaseRewinder.clean
+  end
+
+  config.after(:suite) do
+    configuration = ActiveRecord::Base.configurations["test"]
+    ActiveRecord::Tasks::DatabaseTasks.drop(configuration)
+  end
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-indexhint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hirocaster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-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.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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: awesome_print
+  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: database_rewinder
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  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 hints method(use/ignore/force index) to ActiveRecord
+email:
+- hohtsuka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-indexhint.gemspec
+- lib/active_record/index_hint/errors.rb
+- lib/active_record/index_hint/model.rb
+- lib/active_record/index_hint/version.rb
+- lib/activerecord-indexhint.rb
+- spec/active_record/index_hint/model_spec.rb
+- spec/active_record/index_hint/version_spec.rb
+- spec/models.rb
+- spec/schema.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: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Add index hints method(use/ignore/force index) to ActiveRecord
+test_files:
+- spec/active_record/index_hint/model_spec.rb
+- spec/active_record/index_hint/version_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb