activerecord-analyze 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3e8c5511121ff7c9a7e2aab56d1638e1f42286477bfb97a72ae6d284f719b1
-  data.tar.gz: 0a6eba3afdf108a616ad837d9520148a2a387ab0ab3441afbbe2e9851e974e1e
+  metadata.gz: ef55b677ccdab275d0b76db680c55e8c8534b7e03245dc76f622eca81cb3b244
+  data.tar.gz: 3ee9e2dc7ce0251cab913d79ee3c5b5760b571d27bdf98b132cb8d8751c7c7da
 SHA512:
-  metadata.gz: 94223f7a2f15534a7b1d648cb5a019f4aeab0efef044a104ff70e4ee876cdc332de67dfdc86fb325aac5b847a515ae6b02846fed2a19c1b342df4e43b14c7e3d
-  data.tar.gz: 14aa9186a5e14d00dc6b6475d9d7052e00942d82bb5deafcb14f7c170a80282216c05597e102e9ce55c934807ceee145462d6f416ece2030ae21cfbbd495f3d8
+  metadata.gz: 5a1057165667e384853cc9fc83e98b4c98377c2af41057cbe52427cd7a25b8fff99f50321435e4bab1645be97e2d989e026fe3ba85d0d825e53992d1d373ac3b
+  data.tar.gz: 43019fbfa8dff77b956e62eba3750f63b4925eb179876348750414a77c91c0406892a12a3eb719d51e100b8e00e7274a7b41db0054c06d9a061a8887b4be807a

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.6.5
+        environment:
+          DATABASE_URL: postgresql://postgres:secret@localhost:5432/activerecord-analyze-test
+      - image: circleci/postgres:11.5
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: activerecord-analyze-test
+          POSTGRES_PASSWORD: secret
+    parallelism: 1
+    steps:
+      - checkout
+      - run: gem update --system
+      - run: gem install bundler
+      - run: bundle install --path vendor/bundle
+      - run: sudo apt-get update
+      - run: sudo apt install postgresql-client-11
+      - run: dockerize -wait tcp://localhost:5432 -timeout 1m
+      - run:
+          name: Run specs
+          command: |
+            bundle exec rspec spec/
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

data/README.md

@@ -1,9 +1,13 @@
-# ActiveRecord Analyze
+# 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)
 
 This gem adds an `analyze` method to Active Record query objects. It executes `EXPLAIN ANALYZE` on a query SQL.
 
 You can check out this blog post for more info on how to [debug and fix slow queries in Rails apps](https://pawelurbanek.com/slow-rails-queries).
 
+The following `format` options are supported `:json, :hash, :yaml, :text, :xml`. Especially the `:json` format is useful because it let's you visualize a query plan using [a visualizer tool](https://tatiyants.com/pev/#/plans/new).
+
+![PG Query visualizer plan](https://raw.githubusercontent.com/pawurb/activerecord-analyze/master/query-plan.png)
+
 ## Installation
 
 In your Gemfile:
@@ -92,8 +96,6 @@ User.all.analyze(
 
 ```
 
-The following `format` options are supported `:json, :hash, :yaml, :text, :xml`. Especially the `:json` format is useful because it allows you to visualize a query plan using [a visualizer tool](https://tatiyants.com/pev/#/plans/new).
-
 Optionally you can disable running the `ANALYZE` query and only generate the plan:
 
 ```ruby

data/activerecord-analyze.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
   gem.add_dependency "rails", ">= 5.1.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pg"
+  gem.add_development_dependency "rspec"
 end

data/docker-compose.yml.sample

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  postgres:
+    image: postgres:11.5-alpine
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: ruby-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5432:5432'

data/lib/activerecord-analyze/main.rb

@@ -67,7 +67,9 @@ module ActiveRecord
     def analyze(opts = {})
       res = exec_analyze(collecting_queries_for_explain { exec_queries }, opts)
       if [:json, :hash].include?(opts[:format])
-        raw_json = "[" + res[/\[(.*?)(\(\d row)/m, 1]
+        start = res.index("[")
+        finish = res.rindex("]")
+        raw_json = res.slice(start, finish - start + 1)
 
         if opts[:format] == :json
           JSON.parse(raw_json).to_json

data/lib/activerecord-analyze/version.rb

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

data/spec/main_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require "migrations/create_users_migration.rb"
+
+class User < ActiveRecord::Base; end
+
+describe "ActiveRecord analyze" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection(
+      ENV.fetch("DATABASE_URL")
+    )
+
+    @schema_migration = ActiveRecord::Base.connection.schema_migration
+    ActiveRecord::Migrator.new(:up, [CreateUsers.new], @schema_migration).migrate
+  end
+
+  describe "no opts" do
+    it "works" do
+      expect do
+        User.all.analyze
+      end.not_to raise_error
+    end
+  end
+
+  describe "format json" do
+    it "works" do
+      result = User.all.analyze(format: :json)
+      expect(JSON.parse(result)[0].keys.sort).to eq [
+        "Execution Time", "Plan", "Planning Time", "Triggers"
+      ]
+    end
+  end
+
+  describe "format hash" do
+    it "works" do
+      result = User.all.analyze(format: :hash)
+      expect(result[0].keys.sort).to eq [
+        "Execution Time", "Plan", "Planning Time", "Triggers"
+      ]
+    end
+  end
+end

data/spec/migrations/create_users_migration.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration::Current
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require "active_record/railtie"
+require 'bundler/setup'
+require_relative '../lib/activerecord-analyze'
+
+ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:5432/activerecord-analyze-test"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-analyze
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-24 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ' Gem adds an "analyze" method to all Active Record query objects. Compatible
   with PostgreSQL database. '
 email:
@@ -32,15 +74,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-analyze.gemspec
+- docker-compose.yml.sample
 - lib/activerecord-analyze.rb
 - lib/activerecord-analyze/main.rb
 - lib/activerecord-analyze/version.rb
+- query-plan.png
+- spec/main_spec.rb
+- spec/migrations/create_users_migration.rb
+- spec/spec_helper.rb
 homepage: http://github.com/pawurb/activerecord-analyze
 licenses:
 - MIT
@@ -64,4 +112,7 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Add EXPLAIN ANALYZE to Active Record query objects
-test_files: []
+test_files:
+- spec/main_spec.rb
+- spec/migrations/create_users_migration.rb
+- spec/spec_helper.rb