pretty_rails_console 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55492e44098377ca078fc95505c15fca9a1e665c702f65b3ab9cc854fb46cd1d
+  data.tar.gz: d974584b17ce38991500b99a9784292340fa81e7a7c32bb9de75cf2c58ecf754
+SHA512:
+  metadata.gz: 8291456ba27f2a9ca3cbaff7940c28840811614b67a35fb85a2b281b9a39fc4dbd6bcef8affdba6704b9ff443105c63f56f4746b52768529996b5841ec96fd5d
+  data.tar.gz: 19032e4364fb44d940c1fbb74bb231c4186c310c8949c8b5d3a2f7e1518cbfdcb9b57b329b26c094e3820c096bf258de6022a36a614430b025a965287f71699a

data/.gitignore

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

data/.rpec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v0.1.0
+
+- First release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 haidar
+
+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,70 @@
+# Make Your Rails Console Pretty
+
+This gem was inspired by [awesome_rails_console](https://github.com/ascendbruce/awesome_rails_console), [Using pry in production](https://bugsnag.com/blog/production-pry), [jazz_hands](https://github.com/nixme/jazz_hands) and [jazz_fingers](https://github.com/plribeiro3000/jazz_fingers).
+
+The pros of `pretty_rails_console` are:
+
+- Less gem dependances (Only pry-rails and awesome_print other than rails. The rest are optional)
+- Simpler prompt modification (Similar to the default prompt you're already familiar with)
+- No need to worry about configuration (because there are not much options anyway)
+
+## Installation
+
+Gemfile:
+
+```ruby
+gem 'pretty_rails_console'
+```
+
+In terminal:
+
+```sh
+bundle
+rails g pretty_rails_console:install # This will include dependency gems to the gemfile
+# you should review your Gemfile at this point (and adjust if needed)
+```
+
+```sh
+bundle
+spring stop # to restart spring, if you are using it
+rails c
+```
+
+## Features
+
+### Show Rails env and project name in the prompt
+
+Prevents you from accidentally changing production data to the wrong project.
+
+![](http://i.imgur.com/CKrJYqk.png)
+
+### Beautiful formatting with pry and awesome_print
+
+Make it easy to read. Reduce the pain while debugging.
+
+```ruby
+# Try following statements in rails console:
+[:apple, :orange, :banana]
+{ a: 1, b: 2, c: 3 }
+1.methods
+(1..100).to_a
+ap (1..100).to_a, limit: 5
+```
+
+![](http://i.imgur.com/I1iV8n9.png)
+
+### Print table in console
+
+With Hirb (optional enhancement)
+
+Very handy when you need to paste some data into issue tracking system.
+
+![](http://i.imgur.com/9z3XDSU.png)
+
+### Debugger
+
+With pry-byebug (optional enhancement)
+
+Insert `binding.pry` (break point) to start debugging. See [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) For detail.
+
+![](http://i.imgur.com/mJbC24h.png)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/pretty_rails_console/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Install hirb, pry-byebug, pry-stack_explorer to make your rails console even more pretty
+
+Example:
+    rails generate pretty_rails_console:install

data/lib/generators/pretty_rails_console/install/install_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/base'
+
+class PrettyRailsConsole::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def update_gemfile
+    gem_group :development, :test do
+      gem 'hirb'
+      gem 'hirb-unicode-steakknife', require: 'hirb-unicode'
+      gem 'pry-byebug'
+      gem 'pry-stack_explorer'
+    end
+
+    inject_into_file 'Gemfile', indication, before: gem_group_declaration
+  end
+
+  def write_to_pryrc_file
+    copy_file '.pryrc', '.pryrc'
+  end
+
+  private
+
+  def indication
+     "# Please clean up duplicated gems if any.\n"\
+       "# Feel free to remove gems that you don't want to use or "\
+       "if they conflict with other gem dependencies. "\
+       "(you might need to update .pryrc also)\n"
+  end
+
+  def gem_group_declaration
+    "group :development, :test do\n"\
+      "  gem 'hirb'\n"
+  end
+end

data/lib/generators/pretty_rails_console/install/templates/.pryrc

@@ -0,0 +1,4 @@
+if Rails.env.development? || Rails.env.test?
+  # This introduces the `table` statement
+  extend Hirb::Console
+end

data/lib/pretty_rails_console/railtie.rb

@@ -0,0 +1,46 @@
+require "pry-rails"
+require "awesome_print"
+
+module PrettyRailsConsole
+  class Railtie < Rails::Railtie
+    initializer "pretty_rails_console.initialize" do |app|
+      disables_pry_plugin_loading
+      use_awesome_print_for_formatting
+      set_prompt_name_to_project_name
+      show_rails_env_name_before_prompt
+    end
+
+    private
+
+    def disables_pry_plugin_loading
+      Pry.config.should_load_plugins = false
+    end
+
+    def use_awesome_print_for_formatting
+      AwesomePrint.pry!
+    end
+
+    def set_prompt_name_to_project_name
+      # ref from https://github.com/rweng/pry-rails/blob/035d5c8203521f5eaac0001300152281c765df88/lib/pry-rails/prompt.rb
+      Pry.config.prompt_name =
+        if Rails::VERSION::MAJOR >= 6
+          Rails.application.class.module_parent_name.underscore
+        else
+          Rails.application.class.parent_name.underscore
+        end
+    end
+
+    def show_rails_env_name_before_prompt
+      old_prompt = Pry::Prompt[:default]
+
+      Pry.config.prompt = Pry::Prompt.new(
+        "pretty",
+        "pretty rails console",
+        [
+          proc { |*a| "#{Rails.env.classify} #{old_prompt.wait_proc.call(*a)}"  },
+          proc { |*a| "#{Rails.env.classify} #{old_prompt.incomplete_proc.call(*a)}" },
+        ],
+      )
+    end
+  end
+end

data/lib/pretty_rails_console/version.rb

@@ -0,0 +1,3 @@
+module PrettyRailsConsole
+  VERSION = "0.1.1"
+end

data/lib/pretty_rails_console.rb

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

data/pretty_rails_console.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_rails_console/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pretty_rails_console"
+  spec.version       = PrettyRailsConsole::VERSION
+  spec.authors       = ["Haidar Pinulung"]
+  spec.email         = ["haidarpinulung@gmail.com"]
+
+  spec.summary       = %q{Simple and useful rails console enhancements}
+  spec.description   = %q{Enhance rails console by using awesome_print, pry and several pry plugins. And useful prompt tweaks. Makes rails console pretty by default.}
+  spec.homepage      = "https://github.com/9edang/pretty_rails_console"
+
+  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.required_ruby_version = ">= 2.0.0"
+  spec.license               = "MIT"
+
+  # Runtime dependencies
+  spec.add_dependency "railties"
+  spec.add_dependency "pry-rails"
+  spec.add_dependency "awesome_print"
+
+  # gem development dependency
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: pretty_rails_console
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Haidar Pinulung
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Enhance rails console by using awesome_print, pry and several pry plugins.
+  And useful prompt tweaks. Makes rails console pretty by default.
+email:
+- haidarpinulung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rpec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/pretty_rails_console/install/USAGE
+- lib/generators/pretty_rails_console/install/install_generator.rb
+- lib/generators/pretty_rails_console/install/templates/.pryrc
+- lib/pretty_rails_console.rb
+- lib/pretty_rails_console/railtie.rb
+- lib/pretty_rails_console/version.rb
+- pretty_rails_console.gemspec
+homepage: https://github.com/9edang/pretty_rails_console
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Simple and useful rails console enhancements
+test_files: []