wt_activerecord_index_spy 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139af66e444d627962e5c1012c22bb950aaf2e4f5ca4626068174beb75664bb6
-  data.tar.gz: 5f0d2385cf19cee78366660c2d647dbe468a86f189589a4c745c91df18d84bf9
+  metadata.gz: 80c60b9f84a74e7e6a712ab694cde7d9df2d7bd7b5f02c19e0203c0c3f6a337d
+  data.tar.gz: c0997eb1f14fbf0a5a136cf977dd2778f02ef09f1951aa28fbdd933e6d47854e
 SHA512:
-  metadata.gz: 0f211a9e65df94123ce1404e35a13c615eafe0a9fe5189ccf0397d64fc357dba80e099e7f08c6c4f28c738e1dc10fa52f41bfab3e3f0579cf751768684ea37fb
-  data.tar.gz: f753b9c6c7362464de58317d0bfcadd9fdf1ce587468568a07524fe9fecbb371460c1604b2a800563ae2bbacd705ffa1c1542519361f6aae4278151289df6998
+  metadata.gz: 95643efc73118307c0c090e5ce3c1887c2039e74b6049cebb0132ec0b57266783485f972bf7ba3f6f904240814eb2df978f7f484a5ee69b473d4e375886f8177
+  data.tar.gz: be4478bfce890caeae51f703bed4e13772c60443b9bdb06172a6ed8f52fe5ab228d71c9e03f795a02eb7e49da4bb097fd1eed2e0869ab740e207253e259bc07f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.1
+* Fix issue with missing identifier from ActiveRecord (#21)
+
 ## 0.4.0
 * change `NotificationListener` to ignore queries to INFORMATION_SCHEMA
 * change `NotificationListener` to not ignore queries with an empty identifier, for example, when running with `ActiveRecord::Base.connection.execute`

data/CONTRIBUTORS.md

@@ -1,3 +1,4 @@
 - @fabioperrella
 - @julik
 - @lorenzograndi4
+- @lloydwatkin

data/README.md

@@ -75,6 +75,36 @@ it 'uses an index for all the queries' do
 end
 ```
 
+#### Run for all rspec tests
+
+By adding the following to your `rspec` configuration the `have_used_db_indexes` will run on each individual test and error if an index has not been used:
+
+```ruby
+Rspec.configure do |config|
+  config.around(:each) do |example|
+    unless example.metadata[:skip_index_spy]
+      expect { example.run }.to(have_used_db_indexes)
+    else
+      example.run
+    end
+  end
+
+  config.after(:all) do
+    WtActiverecordIndexSpy.export_html_results
+  end
+end
+```
+
+If you wish to skip index checking for specific tests you can then annotate your test as follows:
+
+```ruby
+describe 'Will not check indexes', :skip_index_spy do
+# ...or...
+context 'Does not check indexes', :skip_index_spy do
+# ...or...
+it 'will not check indexes', :skip_index_spy do
+```
+
 ### 2 - Watching all queries from a start point
 
 Add this line to enable it:

data/lib/wt_activerecord_index_spy/notification_listener.rb

@@ -42,7 +42,7 @@ module WtActiverecordIndexSpy
     def call(_name, _start, _finish, _message_id, values)
       query = values[:sql]
       logger.debug "query: #{query}"
-      identifier = values[:name]
+      identifier = values[:name].to_s
 
       if ignore_query?(query: query, name: identifier)
         logger.debug "query type ignored, name: #{identifier}, query: #{query}"
@@ -70,7 +70,6 @@ module WtActiverecordIndexSpy
         origin: reduce_origin(origin),
         certainity_level: certainity_level
       )
-
       @aggregator.add(item)
     end
     # rubocop:enable Metrics/AbcSize

data/lib/wt_activerecord_index_spy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WtActiverecordIndexSpy
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wt_activerecord_index_spy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Fabio Perrella
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord