pgcli-rails 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbab19637a46e7a7f097af1d3b312411469c330d717be8d3f025c7558d55692
-  data.tar.gz: 82eb2f746f696b4e16fa63ec227594bf53aadb88220af6c1325100a14162122f
+  metadata.gz: 3fcf132264e4377997cfe3c761a4f40defd41ec677b20953fe87c012e5c9f87f
+  data.tar.gz: c3b5f858539b5fd498611bc3b1b3cb65cfb39844449cdec8167e82cb3463f196
 SHA512:
-  metadata.gz: 351bbf4f0f7b209c488dc698d364d05ad786991fc78b13de8f8aaddfadfc947f2bb1605f42bdabbf0d6968209f0bba91a22793c31eb0abc15230dd002fcb2960
-  data.tar.gz: 72373571948af3606f6ffcb08aff0d9466c0e3a5979c4ab2e1e92f2a611aab35e905227c3046627b3ec7078e904602b9e2a329e896c1c270760b3a0d400b74a2
+  metadata.gz: dcd32ff24c09273cab3a5077bb64238ef5f853ced0fd2e05ae8dea265055ad937665ea7a44d8ef2b678e507a6e88188b69951c495bcd55c14bd1868b76f12843
+  data.tar.gz: 39d38025056b0a972005659a9a547a752aded31ed90032364942208479e6a58e05d90db713ca428407ace9bbfa39169e6a71a94d1526aae10538b441c1ecd254

data/README.md

@@ -1,7 +1,8 @@
 # pgcli-rails
 
-[![Gem Version](https://badge.fury.io/rb/pgcli-rails.svg)](http://badge.fury.io/rb/pgcli-rails)
-[![Build Status](https://mattbrictson.semaphoreci.com/badges/pgcli-rails/branches/main.svg?style=shields)](https://mattbrictson.semaphoreci.com/projects/pgcli-rails)
+[![Gem Version](https://img.shields.io/gem/v/pgcli-rails)](https://rubygems.org/gems/pgcli-rails)
+[![Gem Downloads](https://img.shields.io/gem/dt/pgcli-rails)](https://www.ruby-toolbox.com/projects/pgcli-rails)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mattbrictson/pgcli-rails/ci.yml)](https://github.com/mattbrictson/pgcli-rails/actions/workflows/ci.yml)
 
 [pgcli][] is a command-line interface for PostgreSQL that offers many improvements over `psql`, like auto-completion and syntax highlighting. Wouldn't it be nice to have a convenient way to use `pgcli` with your Rails app?
 
@@ -48,7 +49,7 @@ RAILS_ENV=test bin/rake pgcli
 
 ## How it works
 
-pgcli-rails is simply a Rake task that reuses the existing `Rails::DBConsole` command class provided by Rails. It subclasses DBConsole to execute `pgcli` instead of `psql`. All you need to do is require the pgcli-rails gem by placing it in your Gemfile.
+pgcli-rails is simply a Rake task that reuses the existing `Rails::DBConsole` command class provided by Rails. It applies a monkey patch so that `pgcli` is executed instead of `psql`. All you need to do is require the pgcli-rails gem by placing it in your Gemfile.
 
 ## Configuration
 

data/lib/pgcli/rails/monkey_patch.rb

@@ -0,0 +1,19 @@
+module Pgcli
+  module Rails
+    module MonkeyPatch
+      def self.apply!
+        if ::Rails.gem_version >= Gem::Version.new("7.1.0")
+          require "active_record/connection_adapters/postgresql_adapter"
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.singleton_class.prepend self
+        else
+          ::Rails::DBConsole.prepend self
+        end
+      end
+
+      def find_cmd_and_exec(commands, *args)
+        commands = "pgcli" if commands == "psql"
+        super(commands, *args)
+      end
+    end
+  end
+end

data/lib/pgcli/rails/tasks.rake

@@ -1,16 +1,22 @@
 desc "Start pgcli using connection info from database.yml"
 task :pgcli do
-  require "pgcli/rails/dbconsole"
+  begin
+    require "rails/commands/dbconsole"
+  rescue LoadError
+    require "rails/commands/dbconsole/dbconsole_command"
+  end
 
   # APP_PATH constant must be set for DBConsole to work
   APP_PATH = Rails.root.join("config", "application") unless defined?(APP_PATH)
 
-  opt = if Rails.version >= "5.1"
+  opt = if Rails.gem_version >= Gem::Version.new("5.1.0")
           { "--include-password" => true }
         else
           ["--include-password"]
         end
 
-  console = Pgcli::Rails::DBConsole.new(opt)
+  require "pgcli/rails/monkey_patch"
+  Pgcli::Rails::MonkeyPatch.apply!
+  Rails::DBConsole.new(opt).start
   console.start
 end

data/lib/pgcli/rails/version.rb

@@ -1,5 +1,5 @@
 module Pgcli
   module Rails
-    VERSION = "0.7.0".freeze
+    VERSION = "0.8.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgcli-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -34,7 +34,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pgcli/rails.rb
-- lib/pgcli/rails/dbconsole.rb
+- lib/pgcli/rails/monkey_patch.rb
 - lib/pgcli/rails/railtie.rb
 - lib/pgcli/rails/tasks.rake
 - lib/pgcli/rails/version.rb
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Replaces the Rails PostgreSQL dbconsole with the much nicer pgcli

data/lib/pgcli/rails/dbconsole.rb

@@ -1,19 +0,0 @@
-begin
-  require "rails/commands/dbconsole"
-rescue LoadError
-  require "rails/commands/dbconsole/dbconsole_command"
-end
-
-module Pgcli
-  module Rails
-    # Subclass the built-in Rails DBConsole to override "psql" with "pgcli".
-    class DBConsole < ::Rails::DBConsole
-      protected
-
-      def find_cmd_and_exec(commands, *args)
-        commands = "pgcli" if commands == "psql"
-        super(commands, *args)
-      end
-    end
-  end
-end