active-record-forcible-index 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f85f6913f9f90a1861129eca443d923e4b7415ff
+  data.tar.gz: 6a7bb3bb166a18642ed4c9324082893ffee50b4d
+SHA512:
+  metadata.gz: b4cbf8fb091696a75e0161280fa49d95c6b5694e1e8fc99a3ebbe382fd19baa95f30897eb68902362ace4fbdb2163ba81fed1cddd2adeb4b4d0faed5a67b2ef3
+  data.tar.gz: 7dd8f577701500e20871aaa444272157eebaa84f3ae857e632f32d688887447e046766e36fd7a7ab367de2e7750c0adc2e4050cbd2784b6a1192de53f2ef7b9c

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in env_status.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'ZenTest'
+  gem 'autotest'
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    active-record-forcible-index (0.0.1)
+      activerecord (~> 4.0)
+      bundler (~> 1.3)
+      rake
+      rspec (~> 2.0)
+      rspec-given
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.10.0)
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    given_core (3.5.4)
+      sorcerer (>= 0.3.7)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-given (3.5.4)
+      given_core (= 3.5.4)
+      rspec (>= 2.12)
+    rspec-mocks (2.14.6)
+    sorcerer (1.0.2)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  active-record-forcible-index!
+  autotest
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 SC 2Parale Afiliere S.R.L.
+
+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,44 @@
+# ActiveRecord::ForcibleIndex
+
+ActiveRecord extension that implements USE INDEX and FORCE INDEX.
+
+## How to use
+
+Add it to your ```Gemfile```.
+
+```
+  # ...
+  gem 'active-record-forcible-index'
+  # ...
+```
+
+Having the model bellow:
+
+```
+  class DummyModel < ActiveRecord::Base
+    include ActiveRecordForcibleIndex
+  end
+```
+
+You can use ```#use_index``` or ```#force_index``` by invoking:
+
+```
+  # code here
+  DummyModel.all.use_index('dummy_index')
+  # code here
+```
+
+Note: Get *dummy_index* value from your SQL database.
+
+## Authors
+[Catalin Ilinca](https://github.com/ducknorris) and [Alexandru Emil Lupu](https://github.com/alecslupu)
+
+## Contributing
+
+Thanks to our [contributors](https://github.com/2Parale/active-record-forcible-index/graphs/contributors).
+
+1. Fork it
+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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/active-record-forcible-index.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_forcible_index'
+
+Gem::Specification.new do |spec|
+  spec.name             = "active-record-forcible-index"
+  spec.version          = "0.0.1"
+  spec.authors          = ["Catalin Ilinca", "Alexandru Emil Lupu"]
+  spec.email            = ["c@talin.ro", "contact@alecslupu.ro"]
+  spec.description      = %q{ActiveRecord extension that gives USE and FORCE index to any ActiveRecord Model.}
+  spec.summary          = %q{Use the desired index}
+  spec.homepage         = "https://github.com/2Parale/active-record-forcible-index"
+  spec.license          = "MIT"
+  spec.extra_rdoc_files = [
+    "README.md",
+    "CHANGELOG.md"
+  ]
+
+  spec.files         = `git ls-files`.split($/)
+  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.0'
+  spec.add_dependency 'rspec', '~> 2.0'
+  spec.add_dependency "rspec-given"
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_dependency "rake"
+end

data/lib/active_record_forcible_index.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+
+module ActiveRecordForcibleIndex
+  class << self
+    def included(klass)
+      klass.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+  end
+
+  module InstanceMethods
+  end
+
+  module ClassMethods
+    def use_index(index)
+      from("#{self.table_name} USE INDEX(#{index})")
+    end
+
+    def force_index(index)
+      from("#{self.table_name} FORCE INDEX(#{index})")
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecordForcibleIndex)

data/spec/active_record_forcible_index_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+class DummyModel < ActiveRecord::Base
+  include ActiveRecordForcibleIndex
+end
+
+describe ActiveRecordForcibleIndex do
+
+  describe "#use_index" do
+    describe "responsiveness" do
+      Given { }
+
+      Then { expect(DummyModel).to respond_to(:use_index) }
+    end
+
+    describe "sql output" do
+      Given(:active_record_relation) { DummyModel.use_index('dummy_index') }
+      Given { active_record_relation.stub to_sql: 'SELECT `dummy_models`.* FROM dummy_models USE INDEX(dummy_index) ' }
+
+      Then { expect(active_record_relation.to_sql).to eq('SELECT `dummy_models`.* FROM dummy_models USE INDEX(dummy_index) ') }
+    end
+  end
+
+  describe "#force_index" do
+    describe "responsiveness" do
+      Given { }
+
+      Then { expect(DummyModel).to respond_to(:force_index) }
+    end
+
+    describe "sql output" do
+      Given(:active_record_relation) { DummyModel.force_index('dummy_index') }
+      Given { active_record_relation.stub to_sql: 'SELECT `dummy_models`.* FROM dummy_models FORCE INDEX(dummy_index) ' }
+
+      Then { expect(active_record_relation.to_sql).to eq('SELECT `dummy_models`.* FROM dummy_models FORCE INDEX(dummy_index) ') }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'active_record_forcible_index'
+require 'rspec-given'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: active-record-forcible-index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Catalin Ilinca
+- Alexandru Emil Lupu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  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.3'
+  type: :runtime
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord extension that gives USE and FORCE index to any ActiveRecord
+  Model.
+email:
+- c@talin.ro
+- contact@alecslupu.ro
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active-record-forcible-index.gemspec
+- lib/active_record_forcible_index.rb
+- spec/active_record_forcible_index_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/2Parale/active-record-forcible-index
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Use the desired index
+test_files:
+- spec/active_record_forcible_index_spec.rb
+- spec/spec_helper.rb