pgcli-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83026651c327b19b11a0e4c18905a69f13ad7966
-  data.tar.gz: f611bed8246d687bfa5b8f31c76689e0ec21679b
+  metadata.gz: 678b1aa5df2b4558367b5b91103879f8f78fe071
+  data.tar.gz: 88d8f732d3c86475d8aeceb014734b1e63db773d
 SHA512:
-  metadata.gz: a86b77a1f3b9675da09fa74e7860ddfc4133ee5b2b488f1df9a8b1290ed29518ce667acdcaec5ef774791d61fb30fdef931854238a2aa07305ed2642c5a523db
-  data.tar.gz: a081ff500c7bf4ad706e6b4365b7e367f051693a2a6665e2372fe82bc75e2041dbf8cc76f6d26481b2336dac1c846d5ee87e5f6b9023ad296e76d7ebdd43fe73
+  metadata.gz: 1483bc2a3c3dde8baa4449563585d6daabf619508cf5b3bcf776e2f1609d0c8f0e780d534dfc737288ebd99be8b2dfc73f5b8d76c3f0e8d3c58784cc2c0e1930
+  data.tar.gz: 0266878584a16289ea4c489b13f887b1080e489ec2fb484c8b0551e334853101a3e2ebb5be4fd6bd3a0710b51405ef13b6f5a27884592432df952bee984ec5bc

data/CHANGELOG.md

@@ -8,8 +8,15 @@ pgcli-rails is in a pre-1.0 state. This means that its APIs and behavior are sub
 
 * Your contribution here!
 
+## [0.2.0][] (2016-07-18)
+
+* Rewrite as a Rake task instead of a monkey patch
+* New usage: `bin/rake pgcli`
+
 ## 0.1.0 (2016-07-15)
 
 * Initial release
 
 [Semver]: http://semver.org
+[Unreleased]: https://github.com/mattbrictson/pgcli-rails/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/mattbrictson/pgcli-rails/compare/v0.1.0...v0.2.0

data/README.md

@@ -2,16 +2,22 @@
 
 [![Gem Version](https://badge.fury.io/rb/pgcli-rails.svg)](http://badge.fury.io/rb/pgcli-rails)
 
-Wouldn't it be great if `rails dbconsole` used [pgcli][] instead of psql?
+[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?
+
+That's where the pgcli-rails gem comes in. It adds a `pgcli` Rake task to your Rails app. Use it in place of `rails dbconsole`.
+
+# Usage
+
+Add the gem to your Gemfile and run `bundle install`:
 
 ```ruby
-gem "pgcli-rails", groups: %w(development test)
+gem "pgcli-rails"
 ```
 
-Now it does.
+Running the `pgcli` Rake task automatically uses your `database.yml` to launch pgcli with the correct connection options:
 
 ```
-$ rails dbconsole
+$ bin/rake pgcli
 Version: 1.0.0
 Chat: https://gitter.im/dbcli/pgcli
 Mail: https://groups.google.com/forum/#!forum/pgcli
@@ -23,6 +29,16 @@ my_app_development>
  [F2] Smart Completion: ON  [F3] Multiline: OFF  [F4] Emacs-mode
 ```
 
+Other ways to use it:
+
+```
+# Rails 5 also supports running Rake tasks via the rails command
+bin/rails pgcli
+
+# Connect to the test database
+RAILS_ENV=test bin/rake pgcli
+```
+
 ## Requirements
 
 * Rails 4.2+ using PostgreSQL
@@ -31,21 +47,11 @@ my_app_development>
 
 ## How it works
 
-pgcli-rails is a monkey patch. Using a `Rails::Railtie` callback, it hooks into the Rails load process and patches the `Rails::DBConsole` class 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 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.
 
 ## Configuration
 
-There is no configuration to speak of, but you can control which environment(s) use `pgcli` by specifying the appropriate group in the Gemfile.
-
-```ruby
-# Use pgcli in *all* environments (including production)
-gem "pgcli-rails"
-```
-
-```ruby
-# Use pgcli only in development and test environments
-gem "pgcli-rails", groups: %w(development test)
-```
+There is no configuration. Like `rails dbconsole`, it simply uses your ActiveRecord database connection as specified in `database.yml`.
 
 ## Roadmap
 

data/lib/pgcli/rails/dbconsole.rb

@@ -0,0 +1,15 @@
+require "rails/commands/dbconsole"
+
+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

data/lib/pgcli/rails/railtie.rb

@@ -1,20 +1,8 @@
 module Pgcli
   module Rails
     class Railtie < ::Rails::Railtie
-      # This code executes when Rails loads but before the dbconsole command is
-      # executed. Monkey patches the Rails::DBConsole class to change the
-      # executable that is used for the pg adapter from "psql" to "pgcli".
-      config.before_configuration do
-        require "rails/commands/dbconsole"
-        class ::Rails::DBConsole
-          protected
-
-          alias original_find_cmd_and_exec find_cmd_and_exec
-          def find_cmd_and_exec(commands, *args)
-            commands = "pgcli" if commands == "psql"
-            original_find_cmd_and_exec(commands, *args)
-          end
-        end
+      rake_tasks do
+        load File.expand_path("../tasks.rake", __FILE__)
       end
     end
   end

data/lib/pgcli/rails/tasks.rake

@@ -0,0 +1,10 @@
+desc "Start pgcli using connection info from database.yml"
+task :pgcli do
+  require "pgcli/rails/dbconsole"
+
+  # APP_PATH constant must be set for DBConsole to work
+  APP_PATH = Rails.root.join("config", "application") unless defined?(APP_PATH)
+
+  console = Pgcli::Rails::DBConsole.new(["--include-password"])
+  console.start
+end

data/lib/pgcli/rails/version.rb

@@ -1,5 +1,5 @@
 module Pgcli
   module Rails
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/pgcli-rails.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "chandler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.2"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "rubocop", ">= 0.37.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgcli-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,9 @@ files:
 - bin/console
 - bin/setup
 - lib/pgcli/rails.rb
+- lib/pgcli/rails/dbconsole.rb
 - lib/pgcli/rails/railtie.rb
+- lib/pgcli/rails/tasks.rake
 - lib/pgcli/rails/version.rb
 - pgcli-rails.gemspec
 homepage: https://github.com/mattbrictson/pgcli-rails