activerecord-turntable 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf0ede019f3de7c07755243eef39d924ba553535
-  data.tar.gz: 7790c3e307778292759c3683c5381b7f1c8c1525
+  metadata.gz: 0183e069709e21d8fd4f93be3b443e9dab8ae88c
+  data.tar.gz: c2f793eebeaa9d49278d09892eef7060fddcd757
 SHA512:
-  metadata.gz: 22af41085ea74b9b442dec5f7e26b5ddff9086e404486ec6e16c2b56dd2febd333d90b29dfcc912b3d409cec185a1970577db66deead6827dcc3787ff2b1787c
-  data.tar.gz: 2b5292a67a7c018733515d79fb52ce3ee0474d7b67a551d5f6be159643c780f1187a336caf1b5bbed46651c49b6a37d514b963baed8b7512fe931228ebeb1ae4
+  metadata.gz: 3e2305795803f74373a78c8bae47f24054b8abc358d54e49b106f09993b262e96ea8081d37268db7e7c38b5c56a4701720b1c2a3d09669bc5655d38cf20e6b22
+  data.tar.gz: c17da81b6c308cb370183d96edfff8b39a9f4431f9af6e76b3e2778c80f414c6cdab1172db34ff0e7e62899bb64619961f658915a24f7988bb2d4cb4151639af

data/.travis.yml

@@ -15,3 +15,5 @@ script: bundle exec rake spec
 matrix:
   allow_failures:
     - rvm: ruby-head
+sudo: false
+cache: bundler

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## activerecord-turntable 2.3.0 ##
+
+### Features
+
+* Support index hint
+
 ## activerecord-turntable 2.2.2 ##
 
 ### Bugfix

data/lib/active_record/turntable/sql_tree_patch.rb

@@ -9,14 +9,22 @@ module SQLTree
 end
 
 class SQLTree::Token
-  KEYWORDS << 'BINARY'
-  KEYWORDS << 'LIMIT'
-  KEYWORDS << 'OFFSET'
-  const_set('BINARY', Class.new(SQLTree::Token::Keyword))
-  const_set('LIMIT', Class.new(SQLTree::Token::Keyword))
-  const_set('OFFSET', Class.new(SQLTree::Token::Keyword))
+  extended_keywords = ['BINARY', 'LIMIT', 'OFFSET', 'INDEX', 'KEY', 'USE', 'FORCE', 'IGNORE']
+  KEYWORDS.concat(extended_keywords)
+
+  extended_keywords.each do |kwd|
+    const_set(kwd, Class.new(SQLTree::Token::Keyword))
+  end
 
   BINARY_ESCAPE = Class.new(SQLTree::Token).new('x')
+
+  def possible_index_hint?
+    [SQLTree::Token::USE, SQLTree::Token::FORCE, SQLTree::Token::IGNORE].include?(self.class)
+  end
+
+  def index_keyword?
+    [SQLTree::Token::INDEX, SQLTree::Token::KEY].include?(self.class)
+  end
 end
 
 class SQLTree::Tokenizer
@@ -141,9 +149,16 @@ module SQLTree::Node
   end
 
   class TableReference < Base
+    leaf :index_hint
+
+    def initialize(table, table_alias = nil, index_hint = nil)
+      @table, @table_alias, @index_hint = table, table_alias, index_hint
+    end
+
     def to_sql(options={})
       sql = (SQLTree::Node::SubQuery === table) ? table.to_sql : quote_field_name(table)
       sql << " AS " << quote_field_name(table_alias) if table_alias
+      sql << " " << index_hint.to_sql if index_hint
       return sql
     end
 
@@ -151,10 +166,14 @@ module SQLTree::Node
       if SQLTree::Token::Identifier === tokens.peek
         tokens.next
         table_reference = self.new(tokens.current.literal)
-        if SQLTree::Token::AS === tokens.peek || SQLTree::Token::Identifier === tokens.peek
+        if tokens.peek && !tokens.peek.possible_index_hint? &&
+            (SQLTree::Token::AS === tokens.peek || SQLTree::Token::Identifier === tokens.peek)
           tokens.consume(SQLTree::Token::AS) if SQLTree::Token::AS === tokens.peek
           table_reference.table_alias = tokens.next.literal
         end
+        if tokens.peek && tokens.peek.possible_index_hint? && tokens.peek(2).index_keyword?
+          table_reference.index_hint = SQLTree::Node::IndexHint.parse(tokens)
+        end
         return table_reference
       elsif SQLTree::Token::SELECT === tokens.peek(2)
         table_reference = self.new(SQLTree::Node::SubQuery.parse(tokens))
@@ -169,6 +188,35 @@ module SQLTree::Node
     end
   end
 
+  class IndexHint < Base
+    leaf :hint_method
+    leaf :hint_key
+    leaf :index_list
+
+    def initialize(hint_method, hint_key, index_list)
+      @hint_method, @hint_key, @index_list = hint_method, hint_key, index_list
+    end
+
+    def to_sql(options={})
+      sql = "#{hint_method} #{hint_key} "
+      sql << "(#{index_list.map {|idx| idx.to_sql }.join(' ')})"
+      sql
+    end
+
+    def self.parse(tokens)
+      hint_method = tokens.next.literal
+      if tokens.peek.index_keyword?
+        hint_key = tokens.next.literal
+        tokens.consume(SQLTree::Token::LPAREN)
+        index_list = parse_list(tokens, SQLTree::Node::Expression::Field)
+        tokens.consume(SQLTree::Token::RPAREN)
+        self.new(hint_method, hint_key, index_list)
+      else
+        raise SQLTree::Parser::UnexpectedToken.new(tokens.current)
+      end
+    end
+  end
+
   class Expression < Base
     class BinaryOperator < SQLTree::Node::Expression
       TOKEN_PRECEDENCE[2] << SQLTree::Token::BETWEEN

data/lib/active_record/turntable/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Turntable
-    VERSION = "2.2.2"
+    VERSION = "2.3.0"
   end
 end

data/spec/active_record/turntable/sql_tree_patch_spec.rb

@@ -11,4 +11,24 @@ describe SQLTree do
     it { expect { subject }.to_not raise_error }
     its(:to_sql) { is_expected.to include("x'deadbeef") }
   end
+
+  context "Select query with index hint" do
+    ["FORCE INDEX", "IGNORE INDEX", "USE INDEX"].each do |hint|
+      context hint do
+        subject { SQLTree["SELECT * FROM table #{hint} (`foo`) WHERE field = 'value'"] }
+        it { expect { subject }.to_not raise_error }
+        its(:to_sql) { is_expected.to include("#{hint} (`foo`)") }
+      end
+    end
+  end
+
+  context "Select query without index hint" do
+    subject { SQLTree["SELECT * FROM table WHERE field = 'value'"] }
+    it { expect { subject }.to_not raise_error }
+  end
+
+  context "Delete query" do
+    subject { SQLTree["DELETE FROM table"] }
+    it { expect { subject }.to_not raise_error }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turntable
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - gussan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -522,4 +522,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/matchers/be_saved_to.rb
 - spec/support/turntable_helper.rb
-has_rdoc: