ruby-pg-extras 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 771a487899452aae45b3491ef7b5c4704ff627abe1768c9342d64a6ae5c2e050
-  data.tar.gz: 98b7ccbc8b3c74e4b623be5cc932d73110676cf8de6610ceeffa0127c25c750b
+  metadata.gz: 3fdc09221bd85ddacc607f1aa91aa6bd29ebe3d1f5193ec176c14a2f80739718
+  data.tar.gz: 2377afa5338292f230cefb60afc85e80c174412df6bac422bfb8cbab392e7d61
 SHA512:
-  metadata.gz: 4b7f48a2907f36db39033aa81801eef6cc397c8e2670024ad2b0f5d06984792bc7cfc664e3aab34b5f6d84268dc6bb312c345a078f7914fa858eb7dfa0aa1fe2
-  data.tar.gz: cf675a7c8364d01468602aee27961f008a33a6168ab11afd406cfaa7eb9b97c1197f6e0e455ba1801d9c4282d95502cb8041644b992e4455431e5eed6c5c4f1a
+  metadata.gz: a0140f50e9719f4740e99cb678edc5d78cfb2352398765a49565f4031a7d0aaea473710ef2811fcb8856acca3b6ce414648ce3f590c7beb3f7a437b37b4da3ea
+  data.tar.gz: fe5c2b267931dcbf4993576da5721d7bfc2435b5a16f050d7494942c334a80484c1a9b39708782574e6138ed1ad8490765308f227844744aeca39a5e440aa119

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.6.5
+        environment:
+          DATABASE_URL: postgresql://postgres:secret@localhost:5432/ruby-pg-extras-test
+      - image: circleci/postgres:11.5
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: ruby-pg-extras-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 install postgresql-client
+      - 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,6 +1,6 @@
-# Rails PG Extras [![Gem Version](https://badge.fury.io/rb/ruby-pg-extras.svg)](https://badge.fury.io/rb/ruby-pg-extras) [![CircleCI](https://circleci.com/gh/pawurb/ruby-pg-extras.svg?style=svg)](https://circleci.com/gh/pawurb/ruby-pg-extras)
+# Ruby PG Extras [![Gem Version](https://badge.fury.io/rb/ruby-pg-extras.svg)](https://badge.fury.io/rb/ruby-pg-extras) [![CircleCI](https://circleci.com/gh/pawurb/ruby-pg-extras.svg?style=svg)](https://circleci.com/gh/pawurb/ruby-pg-extras)
 
-Rails port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras). The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default Heroku PostgreSQL plugin.
+Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras). The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Ruby apps that are not using the default Heroku PostgreSQL plugin.
 
 Included rake tasks and Ruby methods can be used to obtain information about a Postgres instance, that may be useful when analyzing performance issues. This includes information about locks, index usage, buffer cache hit ratios and vacuum statistics. Ruby API enables developers to easily integrate the tool into e.g. automatic monitoring tasks.
 
@@ -14,12 +14,6 @@ gem 'ruby-pg-extras'
 
 ### Usage
 
-Each command can be used as a rake task, or a directly from the Ruby code.
-
-```bash
-rake pg_extras:cache_hit
-```
-
 ```ruby
 RubyPGExtras.cache_hit
 ```
@@ -55,8 +49,10 @@ RubyPGExtras.cache_hit(in_format: :raw) =>
 
 #### `cache_hit`
 
-```bash
-$ rake pg_extras:cache_hit
+```ruby
+
+RubyPGExtras.cache_hit
+
       name      |         ratio
 ----------------+------------------------
  index hit rate | 0.99957765013541945832
@@ -68,8 +64,10 @@ This command provides information on the efficiency of the buffer cache, for bot
 
 #### `index_usage`
 
-```
-$ rake pg_extras:index_usage
+```ruby
+
+RubyPGExtras.index_usage
+
        relname       | percent_of_times_index_used | rows_in_table
 ---------------------+-----------------------------+---------------
  events              |                          65 |       1217347
@@ -84,8 +82,10 @@ This command provides information on the efficiency of indexes, represented as w
 
 ### `locks`
 
-```
-$ rake pg_extras:locks
+```ruby
+
+RubyPGExtras.locks
+
  procpid | relname | transactionid | granted |     query_snippet     |       age
 ---------+---------+---------------+---------+-----------------------+-----------------
    31776 |         |               | t       | <IDLE> in transaction | 00:19:29.837898
@@ -101,16 +101,20 @@ This command displays queries that have taken out an exlusive lock on a relation
 
 ### `all_locks`
 
-```
-$ rake pg_extras:all_locks
+```ruby
+
+RubyPGExtras.all_locks
+
 ```
 
 This command displays all the current locks, regardless of their type.
 
 ### `outliers`
 
-```
-$ rake pg_extras:outliers
+```ruby
+
+RubyPGExtras.outliers
+
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
  SELECT * FROM archivable_usage_events.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00
@@ -132,8 +136,10 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 
 ### `calls`
 
-```
-$ rake pg_extras:calls
+```ruby
+
+RubyPGExtras.calls
+
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
  SELECT * FROM usage_events WHERE (alp.. | 01:18:11.073333  | 0.6%           | 102,120,780 | 00:00:00
@@ -153,8 +159,10 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 
 ### `blocking`
 
-```
-$ rake pg_extras:blocking
+```ruby
+
+RubyPGExtras.blocking
+
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
 -------------+--------------------------+-------------------+--------------+------------------------------------------------------------------------------------+------------------
          461 | select count(*) from app | 00:00:03.838314   |        15682 | UPDATE "app" SET "updated_at" = '2013-03-04 15:07:04.746688' WHERE "id" = 12823149 | 00:00:03.821826
@@ -165,8 +173,10 @@ This command displays statements that are currently holding locks that other sta
 
 #### `total_index_size`
 
-```
-$ rake pg_extras:total_index_size
+```ruby
+
+RubyPGExtras.total_index_size
+
   size
 -------
  28194 MB
@@ -177,8 +187,10 @@ This command displays the total size of all indexes on the database, in MB. It i
 
 ### `index_size`
 
-```
-$ rake pg_extras:index_size
+```ruby
+
+RubyPGExtras.index_size
+
                              name                              |  size
 ---------------------------------------------------------------+---------
  idx_activity_attemptable_and_type_lesson_enrollment           | 5196 MB
@@ -203,8 +215,10 @@ This command displays the size of each each index in the database, in MB. It is
 
 ### `table_size`
 
-```
-$ rake pg_extras:table_size
+```ruby
+
+RubyPGExtras.table_size
+
                              name                              |  size
 ---------------------------------------------------------------+---------
  learning_coaches                                              |  196 MB
@@ -219,8 +233,10 @@ This command displays the size of each table in the database, in MB. It is calcu
 
 ### `table_indexes_size`
 
-```
-$ rake pg_extras:table-indexes-size
+```ruby
+
+RubyPGExtras.table_indexes_size
+
                              table                             | indexes_size
 ---------------------------------------------------------------+--------------
  learning_coaches                                              |    153 MB
@@ -235,8 +251,10 @@ This command displays the total size of indexes for each table, in MB. It is cal
 
 ### `total_table_size`
 
-```
-$ rake pg_extras:total_table_size
+```ruby
+
+RubyPGExtras.total_table_size
+
                              name                              |  size
 ---------------------------------------------------------------+---------
  learning_coaches                                              |  349 MB
@@ -251,8 +269,10 @@ This command displays the total size of each table in the database, in MB. It is
 
 ### `unused_indexes`
 
-```
-$ rake pg_extras:unused_indexes
+```ruby
+
+RubyPGExtras.unused_indexes
+
           table      |                       index                | index_size | index_scans
 ---------------------+--------------------------------------------+------------+-------------
  public.grade_levels | index_placement_attempts_on_grade_level_id | 97 MB      |           0
@@ -265,8 +285,10 @@ This command displays indexes that have < 50 scans recorded against them, and ar
 
 ### `seq_scans`
 
-```
-$ rake pg_extras:seq_scans
+```ruby
+
+RubyPGExtras.seq_scans
+
 
                name                |  count
 -----------------------------------+----------
@@ -293,8 +315,10 @@ This command displays the number of sequential scans recorded against all tables
 
 ### long_running_queries
 
-```
-$ rake pg_extras:long_running_queries
+```ruby
+
+RubyPGExtras.long_running_queries
+
 
   pid  |    duration     |                                      query
 -------+-----------------+---------------------------------------------------------------------------------------
@@ -308,8 +332,10 @@ This command displays currently running queries, that have been running for long
 
 ### records_rank
 
-```
-$ rake pg_extras:records_rank
+```ruby
+
+RubyPGExtras.records_rank
+
                name                | estimated_count
 -----------------------------------+-----------------
  tastypie_apiaccess                |          568891
@@ -325,8 +351,10 @@ This command displays an estimated count of rows per table, descending by estima
 
 ### bloat
 
-```
-$ rake pg_extras:bloat
+```ruby
+
+RubyPGExtras.bloat
+
 
  type  | schemaname |           object_name         | bloat |   waste
 -------+------------+-------------------------------+-------+----------
@@ -341,8 +369,10 @@ This command displays an estimation of table "bloat" – space allocated to a re
 
 ### vacuum_stats
 
-```
-$ rake pg_extras:vacuum_stats
+```ruby
+
+RubyPGExtras.vacuum_stats
+
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
 --------+-----------------------+-------------+------------------+----------------+----------------+----------------------+-------------------
  public | log_table             |             | 2013-04-26 17:37 |         18,030 |              0 |          3,656       |
@@ -356,8 +386,10 @@ This command displays statistics related to vacuum operations for each table, in
 
 ### mandelbrot
 
-```
-$ rake pg_extras:mandelbrot
+```ruby
+
+RubyPGExtras.mandelbrot
+
 ```
 
 This command outputs the Mandelbrot set, calculated through SQL.

data/lib/ruby-pg-extras/version.rb

@@ -1,3 +1,3 @@
 module RubyPGExtras
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/ruby-pg-extras.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 require 'terminal-table'
+require 'uri'
+require 'pg'
 
 module RubyPGExtras
+  @@database_url = nil
+
   QUERIES = %i(
     bloat blocking cache_hit
     calls extensions
@@ -23,7 +27,7 @@ module RubyPGExtras
   end
 
   def self.run_query(query_name:, in_format:)
-    result = connection.execute(
+    result = connection.exec(
       sql_for(query_name: query_name)
     )
 
@@ -78,7 +82,23 @@ module RubyPGExtras
   end
 
   def self.connection
-    ActiveRecord::Base.connection
+    database_uri = URI.parse(database_url)
+
+    @_connection ||= PG.connect(
+      dbname: database_uri.path[1..-1],
+      host: database_uri.host,
+      port: database_uri.port,
+      user: database_uri.user,
+      password: database_uri.password
+    )
+  end
+
+  def self.database_url=(value)
+    @@database_url = value
+  end
+
+  def self.database_url
+    @@database_url || ENV.fetch("DATABASE_URL")
   end
 
   %i(

data/spec/smoke_spec.rb

@@ -25,4 +25,13 @@ describe RubyPGExtras do
       end.not_to raise_error
     end
   end
+
+  describe "#database_url=" do
+    it "setting custom database URL works" do
+      RubyPGExtras.database_url = ENV.fetch("DATABASE_URL")
+      expect do
+        RubyPGExtras.bloat(in_format: :hash)
+      end.not_to raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -5,15 +5,3 @@ require 'bundler/setup'
 require_relative '../lib/ruby-pg-extras'
 
 ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:5432/ruby-pg-extras-test"
-
-RSpec.configure do |config|
-  config.before :suite do
-    ActiveRecord::Base.establish_connection(
-      ENV.fetch("DATABASE_URL")
-    )
-  end
-
-  config.after :suite do
-    ActiveRecord::Base.remove_connection
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - pawurb
@@ -75,6 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -101,7 +102,6 @@ files:
 - lib/ruby-pg-extras/queries/total_table_size.sql
 - lib/ruby-pg-extras/queries/unused_indexes.sql
 - lib/ruby-pg-extras/queries/vacuum_stats.sql
-- lib/ruby-pg-extras/tasks/all.rake
 - lib/ruby-pg-extras/version.rb
 - ruby-pg-extras.gemspec
 - spec/smoke_spec.rb

data/lib/ruby-pg-extras/tasks/all.rake

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'ruby-pg-extras'
-
-namespace :pg_extras do
-  RubyPGExtras::QUERIES.each do |query_name|
-    desc RubyPGExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :environment do
-      RubyPGExtras.public_send(query_name)
-    end
-  end
-end