rspec-index-usage 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62522b9854e0ad0cd7d84b44dfa1b019f0ebca89a1121837d885e9b5d1782bfe
-  data.tar.gz: 6aa5e60ec2a3247fc07a0a131b2e05e8902c21e589c8e442c54d73b051aba03e
+  metadata.gz: f00b23350b41a0c0245b26ac250c514173c348f4ebe0eb75a386fad27de8c65e
+  data.tar.gz: fdabba3a7d4e83bd0ab3498bc8053982214f9c707704c3a8199ec178411e6fb4
 SHA512:
-  metadata.gz: d848cf6f41f25b8ba1907ae344e65dcdc93f0ebc37d035f21a9326443567e94a5ddb1b038609838d00372177d7d83e3942bc30fc824da924dc5264bf10082b1b
-  data.tar.gz: c087d3c28fa3f1e13ab05ca6137cb8a7dd4c5bd7fef8e1eaca32fa235c09863488463135be21de3de52688535b4af14c3f5e71bf5ddf5899dab94fd6f35b09cb
+  metadata.gz: 8f1f8be9656e054d5e1554868d25660a7d2f46b27bcf1ad3f5d90f38611c900135a04229b57084e30f9b2e6c30db467b1ea6017e1e10ac92d22bcd12bc08039b
+  data.tar.gz: 987303893e5072213b754bb8f553c1adfaeb219697966a064dba15f547f6687c71120460f5edf9a8c033d73f99868fa6954095c373071f0a04eb441513c56299

data/lib/rspec/matchers/have_used_index.rb

@@ -18,7 +18,9 @@ RSpec::Matchers.define :have_used_index do |expected_index|
       sql = event.payload[:sql]
       next unless sql
 
-      queries << sql if sql.start_with?('SELECT') && !sql.match?(/\A(EXPLAIN|BEGIN|COMMIT|ROLLBACK)/i)
+      if sql.start_with?('SELECT') && !sql.match?(/\A(EXPLAIN|BEGIN|COMMIT|ROLLBACK)/i)
+        queries << { sql: sql, binds: event.payload[:binds] }
+      end
     end
 
     block.call
@@ -29,15 +31,14 @@ RSpec::Matchers.define :have_used_index do |expected_index|
     checker_class = IndexChecker.for_adapter(connection)
     checker = checker_class.new
 
-    queries.any? { |sql| checker.check_sql(sql, expected_index, connection) }
+    queries.any? { |query| checker.check_sql(query[:sql], expected_index, connection, binds: query[:binds]) }
   end
 
-  failure_message do |block|
+  failure_message do |_block|
     "expected the block to execute a query using index '#{expected_index}', but none did"
   end
 
-  failure_message_when_negated do |block|
+  failure_message_when_negated do |_block|
     "expected the block not to execute a query using index '#{expected_index}', but one did"
   end
 end
-

data/lib/rspec/matchers/use_index.rb

@@ -10,11 +10,12 @@ RSpec::Matchers.define :use_index do |expected_index|
     checker.check(query, expected_index, connection)
   end
 
-  failure_message do |query|
+  failure_message do |_query|
     "expected query to use index '#{expected_index}', but it didn't"
   end
 
-  failure_message_when_negated do |query|
+  failure_message_when_negated do |_query|
     "expected query not to use index '#{expected_index}', but it did"
   end
-end
+end
+

data/lib/uses_index/index_checkers/base.rb

@@ -17,7 +17,7 @@ class IndexChecker
     raise NotImplementedError, 'Subclasses must implement check'
   end
 
-  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection)
+  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection, binds: nil)
     raise NotImplementedError, 'Subclasses must implement check_sql'
   end
 end

data/lib/uses_index/index_checkers/postgresql.rb

@@ -6,11 +6,22 @@ class PostgresqlIndexChecker < IndexChecker
     check_sql(sql, expected_index, connection)
   end
 
-  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection)
+  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection, binds: nil)
+    sql = substitute_binds(sql, binds, connection) if binds
     explain_sql = "EXPLAIN #{sql}"
     result = connection.execute(explain_sql)
-    plan = result.map { |row| row[0] }.join("\n")
-    plan.include?(expected_index)
+    plan = result.map { |row| row['QUERY PLAN'] }.join("\n")
+    plan.downcase.include?(expected_index.downcase)
   end
-end
 
+  private
+
+  def substitute_binds(sql, binds, connection)
+    binds.each_with_index do |bind, index|
+      placeholder = "$#{index + 1}"
+      quoted_value = connection.quote(bind.value)
+      sql = sql.gsub(placeholder, quoted_value)
+    end
+    sql
+  end
+end

data/lib/uses_index/index_checkers/sqlite.rb

@@ -6,11 +6,21 @@ class SqliteIndexChecker < IndexChecker
     check_sql(sql, expected_index, connection)
   end
 
-  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection)
+  def check_sql(sql, expected_index, connection = ActiveRecord::Base.connection, binds: nil)
+    sql = substitute_binds(sql, binds, connection) if binds
     explain_sql = "EXPLAIN QUERY PLAN #{sql}"
     result = connection.execute(explain_sql)
     plan = result.map { |row| row.values.join(' ') }.join(' ')
-    plan.include?(expected_index)
+    plan.downcase.include?(expected_index.downcase)
   end
-end
 
+  private
+
+  def substitute_binds(sql, binds, connection)
+    parts = sql.split('?')
+    if parts.size - 1 == binds.size
+      sql = parts.zip(binds.map { |bind| connection.quote(bind.value) }).flatten.compact.join
+    end
+    sql
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-index-usage
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pedro Sena