awesome_rails_console 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85dd83732a6ff6d243a291db31b8e1ef130d9457
-  data.tar.gz: 1a1e4ca8b6760e0c1d8bc59654f2fa418b1bb8b5
+  metadata.gz: 3c6d0377a61aebe9e4bc5fb4f46407180f7329aa
+  data.tar.gz: 46ec9cbf75236b7ea1c6363f0eeb3e48e930aafa
 SHA512:
-  metadata.gz: 971dffe646a635ee12dd8a27906ce7fa1a1b66fd24571344a244fe4398bab4dde788e709af0c3e3b04320a71077cf8d4682b6c71bf0158765691032a8ffb5e88
-  data.tar.gz: 798c60f3704eb46c9ccae48ca41843a854bee2c4a3372ded6e5c525911a2ca9921da462aaa5b4e2544f7d955c72d34fb9033e71a92d34a3b932fc72df207eafe
+  metadata.gz: e954bdbedb1bd139e94a3bba449cf0dfaa5b7639a3efe2f39cdeb5c4d79b302e433db6a2a3bd7f884e88460d5b74d0b16da83235d5ef35d0aa514c0ea74d8314
+  data.tar.gz: 7487cdbbbdbba8d3172544a0173386290dfb96aacfdb563393630e25b5ac2d801977bf13c8bd312fcb2c885fc7a80ae2fe10261107a0d816d94ca1f552182819

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.4.0
+
+* Add `pry-byebug`, `pry-stack_explorer` and `hirb` back as optional enhancement. (Run `rails generate awesome_rails_console:install` to install them)
+
 ## v0.3.0
 
 * Remove `pry-byebug`, `pry-stack_explorer` and `hirb` dependency. Please add them into your application `Gemfile` if you still want to use.

data/README.md

@@ -1,15 +1,25 @@
-# Make Your Rails Console Awesome With One-line
+# Make Your Rails Console Awesome
 
 This gem was inspired by [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 `AwesomeRailsConsole` are:
+The pros of `awesome_rails_console` are:
 
-* Less gem dependances (Require infrequent used gems only when you want it)
-* Simpler prompt modification (More like the default pry prompt you're familiar with)
-* No configurable options at all (You don't need to worry about configuration)
-* No debugger or hirb dependancy. Which debugger to use is fully controlled by you.
+* Less gem dependances (You can remove enhancement gems easily)
+* Simpler prompt modification (Closer to the default pry prompt you're familiar with)
+* No need to worry about configuration (Not much configurable options available)
 
-> If you really want to do a lot of customization. You may consider just editing your `Gemfile`, `.pryrc` and `config/initializers/pry.rb`. Or fork this project.
+## TL; DR;
+
+``` ruby Gemfile
+gem 'awesome_rails_console'
+```
+
+``` sh (terminal)
+bundle
+rails g awesome_rails_console:install
+spring stop
+rails c
+```
 
 ## Features
 
@@ -34,19 +44,39 @@ 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)
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'awesome_rails_console'
 ```
 
-And then execute:
+And then execute in terminal:
 
     $ bundle
 
-And restart your rails console. (You may need to restart spring also)
+Install and config enhancement gems: (optinal)
+
+    $ rails generate awesome_rails_console:install
+
+Finally, restart your rails console. (You may need to restart `spring` also)
 
 ## Changelog
 

data/lib/awesome_rails_console/version.rb

@@ -1,3 +1,3 @@
 module AwesomeRailsConsole
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/generators/awesome_rails_console/install/USAGE

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

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

@@ -0,0 +1,34 @@
+require 'rails/generators/base'
+
+class AwesomeRailsConsole::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def update_gemfile
+    gem_group :development, :test do
+      gem 'hirb'
+      gem '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/awesome_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_rails_console
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bruce Li
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -116,6 +116,9 @@ files:
 - lib/awesome_rails_console.rb
 - lib/awesome_rails_console/railtie.rb
 - lib/awesome_rails_console/version.rb
+- lib/generators/awesome_rails_console/install/USAGE
+- lib/generators/awesome_rails_console/install/install_generator.rb
+- lib/generators/awesome_rails_console/install/templates/.pryrc
 homepage: https://github.com/ascendbruce/awesome_rails_console
 licenses:
 - MIT