shiba 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1976edef35324cc1d8c62239938ef8fa2ceaa247
-  data.tar.gz: 26425a11975b434ca85f100e1608ac79812b2b8d
+  metadata.gz: ad898fa0f36457fbd570698c276b567f6f09f1a2
+  data.tar.gz: '028e8a99dff1f8c843bcb222151a0c100f0ebbe1'
 SHA512:
-  metadata.gz: 728df84438f0eb7d40dc3c05a718ee913dafc6a7a9275859f489875e91ccf6ba73ddb5431eb61650f7e4ddf8be9b39f3f52dbfec3a8f45bfe8b893429bb77fdb
-  data.tar.gz: 113296428f8336a3a21e639415badf893bd0ed178c17b536aa282e4575ecd6e6b2dc385bae336ca88ce5ceafe216e3da2c2943cb615b969294d0e449779947a7
+  metadata.gz: 716210a01a6fded73a217b03992371c4d8dcff472f1a69a6195cb53e1dfb122b8c43c512fa7f4ef30bbf776ee8eff3fcabe356bb3e5f4967cec5a4383ec1675a
+  data.tar.gz: 4f7434ec7c78fa7134947ecfe90d9706e4cb22e800eb8036b03216522dee96c8d42e2a33409c5b40e9f4fbb478e48bf6a5e127c3fe0c05284819bd9d87f392ea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shiba (0.2.2)
+    shiba (0.2.3)
       activesupport
 
 GEM

data/README.md

@@ -14,19 +14,21 @@ By default, it will pretty much only detect queries that miss indexes. As it's f
 Install using bundler. Note: this gem is not designed to be run on production.
 
 ```ruby
-gem 'shiba', :group => :test, :require => true
+# Gemfile
+gem 'shiba', :group => :test
 ```
 
-If this doesn't magically work, you can manually configure it using an initializer:
+If your application lazy loads gems, you will to manually require it.
 
 ```ruby
-  require 'shiba/activerecord_integration'
-  Shiba::ActiveRecordIntegration.install!
+# config/environments/test.rb or test/test_helper.rb
+require 'shiba/setup'
 ```
 
 ## Usage
 
 A report will only be generated when problem queries are detected.
+To verify shiba is actually running, you can run your tests with SHIBA_DEBUG=true.
 
 ```ruby
 # Install
@@ -35,11 +37,17 @@ bundle
 # Run some tests using to generate a SQL report
 rake test:functional
 rails test test/controllers/users_controller_test.rb
+SHIBA_DEBUG=true ruby test/controllers/users_controller_test.rb
 
 # 1 problematic query detected
 # Report available at /tmp/shiba-explain.log-1550099512
 ```
 
+### Screenshot
+`open /tmp/shiba-explain.log-1550099512`
+![screenshot](/data/screenshot.png?raw=true)
+
+
 ## Typical query problems
 
 Here are some typical query problems Shiba can detect. We'll assume the following schema:
@@ -85,7 +93,7 @@ With more data, Shiba can help detect this issue when it appears in a pull reque
 
 ## Going beyond table scans
 
-For smarter analysis, Shiba requires general statistics about production data, such as the number of rows in a table and how unique columns are.
+Without more information, Shiba acts as a simple missed index detector. To catch other problems that can bring down production (or at least cause some performance issues), Shiba requires general statistics about production data, such as the number of rows in a table and how unique columns are.
 
 This information can be obtained by running the bin/dump_stats command in production.
 
@@ -100,7 +108,9 @@ scp production:~/shiba_index.yml RAILS_PROJECT/config
 ```
 
 The stats file will look similar to the following:
-
+```console
+local$ head <rails_project>/config/shiba_index.yml
+```
 ```yaml
 users:
   count: 10000

data/lib/shiba/setup.rb

@@ -0,0 +1,3 @@
+require 'shiba'
+require 'shiba/activerecord_integration'
+Shiba::ActiveRecordIntegration.install!

data/lib/shiba/version.rb

@@ -1,3 +1,3 @@
 module Shiba
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/web/results.html.erb

@@ -43,7 +43,7 @@
 
       Query.prototype = {
         hasTag: function(tag) {
-          this.tags.includes(tag);
+          return this.tags.includes(tag);
         },
         splitSQL: function() {
           this.sqlFragments = this.sql.match(/(SELECT\s)(.*?)(\s+FROM .*)/i);
@@ -175,7 +175,8 @@
         <div class="row">
           <div v-if="hasFuzzed" class="alert alert-warning" role="alert">
             This query analysis was generated using estimated table sizes.
-            <a href="https://github.com/burrito-brothers/shiba/blob/master/README.md#going-beyond-table-scans">Find out how to get a more accurate analysis by feeding Shiba index stats</a>
+            To improve these results and find other problem queries beyond missing indexes, we'll need more stats.<br/>
+            <a target="_blank" href="https://github.com/burrito-brothers/shiba/blob/master/README.md#going-beyond-table-scans">Find out how to get a more accurate analysis by feeding Shiba index stats</a>
           </div>
 
           <div class="col-12">We found {{ queries.length }} queries that deserve your attention: </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shiba
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ben Osheroff
@@ -102,6 +102,7 @@ files:
 - lib/shiba/output/tags.yaml
 - lib/shiba/query.rb
 - lib/shiba/query_watcher.rb
+- lib/shiba/setup.rb
 - lib/shiba/table_stats.rb
 - lib/shiba/version.rb
 - shiba.gemspec