pgcli-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83026651c327b19b11a0e4c18905a69f13ad7966
+  data.tar.gz: f611bed8246d687bfa5b8f31c76689e0ec21679b
+SHA512:
+  metadata.gz: a86b77a1f3b9675da09fa74e7860ddfc4133ee5b2b488f1df9a8b1290ed29518ce667acdcaec5ef774791d61fb30fdef931854238a2aa07305ed2642c5a523db
+  data.tar.gz: a081ff500c7bf4ad706e6b4365b7e367f051693a2a6665e2372fe82bc75e2041dbf8cc76f6d26481b2336dac1c846d5ee87e5f6b9023ad296e76d7ebdd43fe73

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 1.9
+  Exclude:
+    - "*.gemspec"
+
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# pgcli-rails Change Log
+
+All notable changes to this project will be documented in this file.
+
+pgcli-rails is in a pre-1.0 state. This means that its APIs and behavior are subject to breaking changes without deprecation notices. Until 1.0, version numbers will follow a [Semver][]-ish `0.y.z` format, where `y` is incremented when new features or breaking changes are introduced, and `z` is incremented for lesser changes or bug fixes.
+
+## [Unreleased][]
+
+* Your contribution here!
+
+## 0.1.0 (2016-07-15)
+
+* Initial release
+
+[Semver]: http://semver.org

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at matt@mattbrictson.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to pgcli-rails
+
+Have a feature idea, bug fix, or refactoring suggestion? Contributions are welcome!
+
+## Pull requests
+
+1. Check [Issues][] to see if your contribution has already been discussed and/or implemented.
+2. If not, open an issue to discuss your contribution. I won't accept all changes and do not want to waste your time.
+3. Once you have the :thumbsup:, fork the repo, make your changes, and open a PR.
+4. Don't forget to add your contribution and credit yourself in `CHANGELOG.md`!
+
+## Coding guidelines
+
+* This project has a coding style enforced by [RuboCop][]. Use hash rockets and double-quoted strings, and otherwise try to follow the [Ruby style guide][style].
+* Writing tests is strongly encouraged! This project uses Minitest.
+
+## Getting started
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Use `rake` to execute all of pgcli-rails's tests and RuboCop checks
+
+[Issues]: https://github.com/mattbrictson/pgcli-rails/issues
+[RuboCop]: https://github.com/bbatsov/rubocop
+[style]: https://github.com/bbatsov/ruby-style-guide

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pgcli-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Brictson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# pgcli-rails
+
+[![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?
+
+```ruby
+gem "pgcli-rails", groups: %w(development test)
+```
+
+Now it does.
+
+```
+$ rails dbconsole
+Version: 1.0.0
+Chat: https://gitter.im/dbcli/pgcli
+Mail: https://groups.google.com/forum/#!forum/pgcli
+Home: http://pgcli.com
+my_app_development>
+
+
+
+ [F2] Smart Completion: ON  [F3] Multiline: OFF  [F4] Emacs-mode
+```
+
+## Requirements
+
+* Rails 4.2+ using PostgreSQL
+* Ruby 1.9.3+
+* [pgcli][] (`brew install pgcli` to install on macOS)
+
+## 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.
+
+## 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)
+```
+
+## Roadmap
+
+pgcli-rails is little more than a proof-of-concept at this point. Next steps are:
+
+* Add tests
+* Use [Appraisal][] to test against multiple versions of Rails
+* Set up Travis CI
+
+If you have other ideas, open an issue on GitHub!
+
+## Contributing
+
+Code contributions are also welcome! Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[pgcli]: http://pgcli.com
+[Appraisal]: https://github.com/thoughtbot/appraisal

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "chandler/tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task "release:rubygem_push" => "chandler:push"
+task :default => [:test, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pgcli/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pgcli/rails.rb

@@ -0,0 +1,2 @@
+require "pgcli/rails/version"
+require "pgcli/rails/railtie" if defined?(Rails)

data/lib/pgcli/rails/railtie.rb

@@ -0,0 +1,21 @@
+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
+      end
+    end
+  end
+end

data/lib/pgcli/rails/version.rb

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

data/pgcli-rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pgcli/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pgcli-rails"
+  spec.version       = Pgcli::Rails::VERSION
+  spec.authors       = ["Matt Brictson"]
+  spec.email         = ["opensource@mattbrictson.com"]
+
+  spec.summary       = "Patches Rails dbconsole to use pgcli instead of psql"
+  spec.homepage      = "https://github.com/mattbrictson/pgcli-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "chandler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "rubocop", ">= 0.37.2"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: pgcli-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Brictson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: chandler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+description: 
+email:
+- opensource@mattbrictson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pgcli/rails.rb
+- lib/pgcli/rails/railtie.rb
+- lib/pgcli/rails/version.rb
+- pgcli-rails.gemspec
+homepage: https://github.com/mattbrictson/pgcli-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Patches Rails dbconsole to use pgcli instead of psql
+test_files: []