query_tracker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36bdfeaac971e0d3feb504cc6b99bd1ced63405f081bee5f15a104a7edc21d7
-  data.tar.gz: 519e7814892c3ba01e71cacc2c03591fd2657a85725582090ed90b71aa133734
+  metadata.gz: 7d45ba7b0de192f250a1c7a747fb0f7692b84e892c6814a53b1677b0b995648b
+  data.tar.gz: 85321b29452918c9d0c23e8f03fd7ce6eef9f00d7075259df09c826f2f090145
 SHA512:
-  metadata.gz: 56026f5ad302e525ba269ee5ff6bb88287a46b6777c14ac526df5de6903864301ada972fb03602b52ae2b704ef376a3bb06f083c294860c9d6d510bc7ba5f20c
-  data.tar.gz: a1c346e6b192ad8f53dadadd7edc3473fa96f83ac4c673d64dcb617c7ffcba1c476daead1ecf9995420218231df1ef5d4ad97d3b3bd6057615b0b3d6452c43cc
+  metadata.gz: 22bed0698b39c950ad90d3a533a51ece4551b0f0499da2fbdbf67a4f48587c0af1af2e313311f8a07007e06f7523a317723df0b67d214e98d98022db11028a84
+  data.tar.gz: 0aa2e1e6550da7b6013ef2947c3ebd22c963ace0628bfac0004ac72b51cca81978267a1cdd28053a8e95879d632bb730a655fe0f01760ecacd5d51b3df24ac6c

data/README.md

@@ -1,5 +1,6 @@
 # QueryTracker
 
+(DEPRECATED use active-record-query-count instead)
 `QueryTracker` is a Ruby gem designed to help you track and analyze SQL queries executed by your ActiveRecord models. By subscribing to ActiveSupport notifications, it provides detailed insights into the queries being run, including the tables involved and the locations in your code where the queries are generated.
 There are three things this gem allows you to do
 
@@ -18,18 +19,18 @@ gem 'query_tracker'
 And then execute:
 
 ```bash
-    bundle install
+bundle install
 ```
 
 Or install it yourself as:
 
 ```bash
-    gem install query_tracker
+gem install query_tracker
 ```
 
 ## Usage
 
-There are three ways of using this gem:
+There are four ways of using this gem:
 
 1. With a block of code
 
@@ -74,8 +75,6 @@ this will open up a graph comparing the quantity of SQL of the two codes
   config.after_initialize do
     QueryTracker.configure do |configuration|
       configuration.enable_middleware = true
-      configuration.ignore_table_count = 1
-      configuration.max_locations_per_table = 4
     end
   end
 ```
@@ -84,6 +83,31 @@ this will open up a graph comparing the quantity of SQL of the two codes
 
 There are two ways of displaying the collected queries data, `:console` and `:html`, to select one pass the printer argument to `start_with_block` o `end_recording` methods.
 
+If you use `html` with WSL enviroment, you need to set on your enviroments variables the `WSL_DISTRIBUTION` that you are using, so the dependency Launchy work as expected.
+
+### Configuration options
+
+When visualizing the html table or the console output, tables with less than `ignore_table_count` will not be shown. Also, the ammount of locations to show is given by `max_locations_per_table`
+
+```ruby
+config.after_initialize do
+    QueryTracker.configure do |configuration|
+      configuration.ignore_table_count = 1
+      configuration.max_locations_per_table = 4
+    end
+  end
+end
+```
+
+## Examples of visualization
+
+1. Console output
+   ![Console output](images/console.png)
+2. HTML output
+   ![HTML output](images/html.png)
+3. Bar chart output
+   ![Bar chart output](images/bar_chart.png)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.

data/lib/query_tracker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QueryTracker
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jose Lara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -215,6 +215,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/setup
+- images/bar_chart.png
+- images/console.png
+- images/html.png
 - lib/query_tracker.rb
 - lib/query_tracker/compare/comparator.rb
 - lib/query_tracker/configuration.rb
@@ -232,7 +235,7 @@ files:
 - lib/query_tracker/recording/base.rb
 - lib/query_tracker/recording/tracker.rb
 - lib/query_tracker/version.rb
-homepage: https://github.com/jvlara/query_tracker
+homepage: https://github.com/jvlara/active-record-query-count
 licenses:
 - MIT
 metadata: {}
@@ -254,5 +257,6 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: Display an overview of quantity of queries and their origin in Rails applications.
+summary: "(DEPRECATED use active-record-query-count instead) Display an overview of
+  quantity of queries and their origin in Rails applications."
 test_files: []