activerecord-analyze 0.6.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef55b677ccdab275d0b76db680c55e8c8534b7e03245dc76f622eca81cb3b244
-  data.tar.gz: 3ee9e2dc7ce0251cab913d79ee3c5b5760b571d27bdf98b132cb8d8751c7c7da
+  metadata.gz: '09f3c691a676a55f45059cbfd0e12161e42f7ab87acdc834c1f496a2ceae1c1f'
+  data.tar.gz: c83a3d1bb42bdbbb82ca80f00acc55d420de1c7589660f8fd72f103f19aca0c4
 SHA512:
-  metadata.gz: 5a1057165667e384853cc9fc83e98b4c98377c2af41057cbe52427cd7a25b8fff99f50321435e4bab1645be97e2d989e026fe3ba85d0d825e53992d1d373ac3b
-  data.tar.gz: 43019fbfa8dff77b956e62eba3750f63b4925eb179876348750414a77c91c0406892a12a3eb719d51e100b8e00e7274a7b41db0054c06d9a061a8887b4be807a
+  metadata.gz: 96e5ba8e107b9d005f59e6ffe3ff0925b872c753b51ef9deee505919d415e3165a67d5bfe1cffa6f29dbd34eb6726e65f93f14d52389bcdd736edc636c25d0e5
+  data.tar.gz: 957325a0f295e28c76689b504a92a4d0aa636965f6a71326004c3662256aef769ca24bf75bd81a823d2fd3281b9f49d805e0a63dedda3bc5c392f7790cfd0cde

data/README.md

@@ -1,4 +1,4 @@
-# ActiveRecord Analyze [![Gem Version](https://badge.fury.io/rb/activerecord-analyze.svg)](https://badge.fury.io/rb/ruby-pg-extras) [![CircleCI](https://circleci.com/gh/pawurb/activerecord-analyze.svg?style=svg)](https://circleci.com/gh/pawurb/activerecord-analyze)
+# ActiveRecord Analyze [![Gem Version](https://badge.fury.io/rb/activerecord-analyze.svg)](https://badge.fury.io/rb/activerecord-analyze) [![CircleCI](https://circleci.com/gh/pawurb/activerecord-analyze.svg?style=svg)](https://circleci.com/gh/pawurb/activerecord-analyze)
 
 This gem adds an `analyze` method to Active Record query objects. It executes `EXPLAIN ANALYZE` on a query SQL.
 
@@ -23,21 +23,21 @@ gem 'activerecord-analyze'
 The `analyze` method supports the following EXPLAIN query options ([PostgreSQL docs reference](https://www.postgresql.org/docs/12/sql-explain.html)):
 
 ```
-VERBOSE [ boolean ]
-COSTS [ boolean ]
-SETTINGS [ boolean ]
-BUFFERS [ boolean ]
-TIMING [ boolean ]
-SUMMARY [ boolean ]
-FORMAT { TEXT | XML | JSON | YAML }
+buffers: [ boolean ]
+verbose: [ boolean ]
+costs: [ boolean ]
+settings: [ boolean ]
+timing: [ boolean ]
+summary: [ boolean ]
+format: { :text | :json | :xml | :yaml | :pretty_json }
 ```
 
 You can execute it like that:
 
 ```ruby
 
-User.all.analyze(
-  format: :json,
+puts User.all.analyze(
+  format: :pretty_json, # :pretty_json format option generates a formatted JSON output
   verbose: true,
   costs: true,
   settings: true,

data/lib/activerecord-analyze/main.rb

@@ -6,15 +6,19 @@ module ActiveRecord
           format_sql = if fmt = opts[:format].presence
             case fmt
             when :json
-              "FORMAT JSON,"
+              "FORMAT JSON, "
             when :hash
-              "FORMAT JSON,"
+              "FORMAT JSON, "
+            when :pretty_json
+              "FORMAT JSON, "
             when :yaml
-              "FORMAT YAML,"
+              "FORMAT YAML, "
             when :text
-              "FORMAT TEXT,"
+              "FORMAT TEXT, "
             when :xml
-              "FORMAT XML,"
+              "FORMAT XML, "
+            else
+              ""
             end
           end
 
@@ -48,7 +52,7 @@ module ActiveRecord
             "ANALYZE"
           end
 
-          opts_sql = "(#{format_sql} #{analyze_sql}#{verbose_sql}#{costs_sql}#{settings_sql}#{buffers_sql}#{timing_sql}#{summary_sql})"
+          opts_sql = "(#{format_sql}#{analyze_sql}#{verbose_sql}#{costs_sql}#{settings_sql}#{buffers_sql}#{timing_sql}#{summary_sql})"
           .strip.gsub(/\s+/, " ")
           .gsub(/\(\s?\s?\s?,/, "(")
           .gsub(/\s,\s/, " ")
@@ -66,8 +70,8 @@ module ActiveRecord
   class Relation
     def analyze(opts = {})
       res = exec_analyze(collecting_queries_for_explain { exec_queries }, opts)
-      if [:json, :hash].include?(opts[:format])
-        start = res.index("[")
+      if [:json, :hash, :pretty_json].include?(opts[:format])
+        start = res.index("[\n")
         finish = res.rindex("]")
         raw_json = res.slice(start, finish - start + 1)
 
@@ -75,6 +79,8 @@ module ActiveRecord
           JSON.parse(raw_json).to_json
         elsif opts[:format] == :hash
           JSON.parse(raw_json)
+        elsif opts[:format] == :pretty_json
+          JSON.pretty_generate(JSON.parse(raw_json))
         end
       else
         res

data/lib/activerecord-analyze/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordAnalyze
-  VERSION = "0.6.0"
+  VERSION = "0.9.1"
 end

data/spec/main_spec.rb

@@ -40,4 +40,27 @@ describe "ActiveRecord analyze" do
       ]
     end
   end
+
+  describe "format pretty" do
+    it "works" do
+      result = User.all.analyze(format: :pretty_json)
+      expect(JSON.parse(result)[0].keys.sort).to eq [
+        "Execution Time", "Plan", "Planning Time", "Triggers"
+      ]
+    end
+  end
+
+  describe "supports options" do
+    it "works" do
+      result = User.all.limit(10).where.not(email: nil).analyze(
+        format: :hash,
+        costs: true,
+        timing: true,
+        summary: true
+      )
+      expect(result[0].keys.sort).to eq [
+        "Execution Time", "Plan", "Planning Time", "Triggers"
+      ]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-analyze
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails