jazz_hands 0.3.1 → 0.4.0

data/.rbenv-version

@@ -1 +1 @@
-1.9.3-p0
+1.9.3-p327

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.4.0 (2012-12-27)
+
+* Add [pry-rails][pry-rails] 0.2.2 for maintained console hooks and new
+  `show-routes`, `show-models`, and `show-middleware` commands.
+* Add `JazzHands.colored_prompt` and `JazzHands.prompt_separator` options.
+  Detect readline library to turn off incompatible colored prompt or Unicode
+  prompt separator where appropriate. Fixes #1 and #2.
+* Upgrade [pry][pry] to the latest 0.9.10, [pry-doc][pry-doc] 0.4.4,
+  [pry-stack_explorer][pry-stack_explorer] 0.4.7, [pry-remote][pry-remote]
+  0.1.6, [pry-debugger][pry-debugger] 0.2.1, [hirb][hirb] 0.7.0,
+  [Coolline][coolline] 0.4.0, [coderay][coderay] 1.0.8,
+  [awesome_print][awesome_print] 1.1.0. Fixes #4.
+
 ## 0.3.1 (2012-06-11)
 
 * Upgrade [pry-debugger][pry-debugger] to 0.2.0.
@@ -84,3 +97,5 @@
 [coderay]:            https://github.com/rubychan/coderay
 [hirb]:               https://github.com/cldwalker/hirb
 [pry-stack_explorer]: https://github.com/pry/pry-stack_explorer
+[pry-debugger]:       https://github.com/nixme/pry-debugger
+[pry-rails]:          https://github.com/rweng/pry-rails

data/README.md

@@ -9,6 +9,8 @@ hard-working hands!
 * [**Pry**][pry] for a powerful shell alternative to IRB.
 * [**Awesome Print**][awesome_print] for stylish pretty print.
 * [**Hirb**][hirb] for tabular collection output.
+* [**Pry Rails**][pry-rails] for additional commands (`show-routes`,
+  `show-models`, `show-middleware`) in the Rails console.
 * [**Pry Doc**][pry-doc] to browse Ruby source, including C, directly from the
   console.
 * [**Pry Git**][pry-git] to teach the console about git. Diffs, blames, and
@@ -35,10 +37,42 @@ That's it. Run `rails console` as usual.
 
 [Hirb][hirb] isn't enabled by default. To use, run `Hirb.enable` in the console.
 
+Ruby compiled against a proper readline library, ideally GNU readline, is
+recommended. Alternatively, [`gem install rb-readline`][rb-readline] for an
+acceptible backup. Using ruby compiled against a `libedit` wrapper (primarily OS
+X) will work but is not recommended.
+
+
+## Options
+
+Change the following options by creating an initializer in your Rails project
+Example `config/initializers/jazz_hands.rb`:
+
+```ruby
+JazzHands.colored_prompt = false
+JazzHands.enable_syntax_highlighting_as_you_type!
+```
+
+### `colored_prompt`
+
+Color the console prompt? Defaults to `true` when the current ruby is compiled
+against GNU readline or `rb-readline`, which don't have issues counting
+characters in colored prompts. `false` for libedit.
+
+Note: `Pry.color = false` trumps this setting and disables all console coloring.
+
+### `prompt_separator`
+
+Separator string between the application name and line input. Defaults to `»`
+for GNU readline or libedit. Defaults to `>` for `rb-readline` which fails on
+mixed encodings.
+
+### Syntax highlighting
+
 Syntax highlighting as you type via [Coolline][coolline] and [Coderay][coderay]
 is disabled by default due to slightly buggy behavior. To enable, add
-`JazzHands.enable_syntax_highlighting_as_you_type` to an initializer. Only works
-with MRI 1.9.3.
+`JazzHands.enable_syntax_highlighting_as_you_type!` to the initializer. Only
+works with MRI 1.9.3.
 
 
 ## Contributing
@@ -50,6 +84,7 @@ file an [issue][issues]. [Project changelog][changelog].
 [pry]:                http://pry.github.com
 [awesome_print]:      https://github.com/michaeldv/awesome_print
 [hirb]:               https://github.com/cldwalker/hirb
+[pry-rails]:          https://github.com/rweng/pry-rails
 [pry-doc]:            https://github.com/pry/pry-doc
 [pry-git]:            https://github.com/pry/pry-git
 [pry-debugger]:       https://github.com/nixme/pry-debugger
@@ -57,6 +92,7 @@ file an [issue][issues]. [Project changelog][changelog].
 [pry-stack_explorer]: https://github.com/pry/pry-stack_explorer
 [coolline]:           https://github.com/Mon-Ouie/coolline
 [coderay]:            https://github.com/rubychan/coderay
+[rb-readline]:        https://github.com/luislavena/rb-readline
 [pullrequests]:       https://github.com/nixme/jazz_hands/pulls
 [issues]:             https://github.com/nixme/jazz_hands/issues
 [changelog]:          https://github.com/nixme/jazz_hands/blob/master/CHANGELOG.md

data/jazz_hands.gemspec

@@ -19,15 +19,16 @@ Gem::Specification.new do |gem|
 
   # Dependencies
   gem.required_ruby_version = '>= 1.9.2'
-  gem.add_runtime_dependency 'pry', '~> 0.9.9'
-  gem.add_runtime_dependency 'pry-doc', '~> 0.4.2'
+  gem.add_runtime_dependency 'pry', '~> 0.9.10'
+  gem.add_runtime_dependency 'pry-rails', '~> 0.2.2'
+  gem.add_runtime_dependency 'pry-doc', '~> 0.4.4'
   gem.add_runtime_dependency 'pry-git', '~> 0.2.3'
-  gem.add_runtime_dependency 'pry-stack_explorer', '~> 0.4.2'
-  gem.add_runtime_dependency 'pry-remote', '>= 0.1.4'
-  gem.add_runtime_dependency 'pry-debugger', '~> 0.2.0'
-  gem.add_runtime_dependency 'hirb', '~> 0.6.2'
-  gem.add_runtime_dependency 'coolline', '>= 0.1.0'
-  gem.add_runtime_dependency 'coderay', '~> 1.0.6'
-  gem.add_runtime_dependency 'awesome_print', '~> 1.0.2'
+  gem.add_runtime_dependency 'pry-stack_explorer', '~> 0.4.7'
+  gem.add_runtime_dependency 'pry-remote', '>= 0.1.6'
+  gem.add_runtime_dependency 'pry-debugger', '~> 0.2.1'
+  gem.add_runtime_dependency 'hirb', '~> 0.7.0'
+  gem.add_runtime_dependency 'coolline', '>= 0.4.0'
+  gem.add_runtime_dependency 'coderay', '~> 1.0.8'
+  gem.add_runtime_dependency 'awesome_print', '~> 1.1.0'
   gem.add_runtime_dependency 'railties', '~> 3.0'
 end

data/lib/jazz_hands.rb

@@ -1,39 +1,66 @@
 require 'jazz_hands/version'
 require 'jazz_hands/railtie' if defined?(Rails)
+require 'active_support'
+require 'readline'
 
 module JazzHands
-  extend self
 
-  # Enable syntax highlighting as you type in the Rails console via coolline and
-  # coderay (MRI 1.9.3+ only). Disabled by default as it's a bit buggy.
+  ### Options ###
+
+  # Color the prompt?
   #
-  # Call from a Rails initializer:
+  # A different setting than Pry.color since some may like colored output, but a
+  # plain prompt.
   #
-  #   JazzHands.enable_syntax_highlighting_as_you_type
+  # Default: 'true' for GNU readline or rb-readline which correctly count line
+  # widths with color codes when using \001 and \002 hints. 'false' for
+  # libedit-based wrapper (standard on OS X unless ruby is explicitly compiled
+  # otherwise).
   #
-  def enable_syntax_highlighting_as_you_type
-    raise 'Syntax highlighting only supported on 1.9.3+' unless RUBY_VERSION >= '1.9.3'
+  mattr_accessor :colored_prompt
+  self.colored_prompt = (Readline::VERSION !~ /EditLine/)
 
-    # Use coolline with CodeRay for syntax highlighting as you type.
-    # Only works on >= 1.9.3 because coolline depends on io/console.
+  # Separator between application name and input in the prompt.
+  #
+  # Default: right angle quote, or '>' when using rb-readline which doesn't
+  # handle mixed encodings well.
+  #
+  mattr_accessor :prompt_separator
+  self.prompt_separator = defined?(RbReadline) ? '>' : "\u00BB"
 
-    require 'coolline'
-    require 'coderay'
 
-    Pry.config.input = Coolline.new do |c|
-      c.transform_proc = proc do
-        CodeRay.scan(c.line, :ruby).term
-      end
+  class << self
+    # Enable syntax highlighting as you type in the Rails console via coolline and
+    # coderay (MRI 1.9.3+ only). Disabled by default as it's a bit buggy.
+    #
+    # Call from a Rails initializer:
+    #
+    #   JazzHands.enable_syntax_highlighting_as_you_type!
+    #
+    def enable_syntax_highlighting_as_you_type!
+      raise 'Syntax highlighting only supported on 1.9.3+' unless RUBY_VERSION >= '1.9.3'
 
-      c.completion_proc = proc do
-        word = c.completed_word
-        Object.constants.map(&:to_s).select { |w| w.start_with? word }
+      # Use coolline with CodeRay for syntax highlighting as you type.
+      # Only works on >= 1.9.3 because coolline depends on io/console.
+
+      require 'coolline'
+      require 'coderay'
+
+      Pry.config.input = Coolline.new do |c|
+        c.transform_proc = proc do
+          CodeRay.scan(c.line, :ruby).term
+        end
+
+        c.completion_proc = proc do
+          word = c.completed_word
+          Object.constants.map(&:to_s).select { |w| w.start_with? word }
+        end
       end
     end
+    alias :enable_syntax_highlighting_as_you_type :enable_syntax_highlighting_as_you_type!
   end
 
-
   ### Internal methods ###
 
-  attr_accessor :hirb_output
+  mattr_accessor :_hirb_output
 end

data/lib/jazz_hands/hirb_ext.rb

@@ -7,12 +7,12 @@ class << Hirb::View
 
   def enable_output_method
     @output_method = true
-    JazzHands.hirb_output = true
+    JazzHands._hirb_output = true
     enable_output_method_existing
   end
 
   def disable_output_method
-    JazzHands.hirb_output = false
+    JazzHands._hirb_output = false
     disable_output_method_existing
   end
 end

data/lib/jazz_hands/railtie.rb

@@ -1,4 +1,5 @@
 require 'pry'
+require 'pry-rails'
 require 'pry-doc'
 require 'pry-git'
 require 'pry-remote'
@@ -12,30 +13,37 @@ module JazzHands
   class Railtie < Rails::Railtie
     initializer 'jazz_hands.initialize' do |app|
       silence_warnings do
-        ::IRB = Pry                      # Replace IRB with Pry completely
-
-        # Rails 3.2 injects commands into IRB::ExtendCommandBundle. Make sure
-        # Pry is compatible enough so Rails boot works.
-        unless defined? IRB::ExtendCommandBundle   # Latest Pry defines it
-          module IRB::ExtendCommandBundle; end
-        end
-
         # We're managing the loading of plugins. So don't let pry autoload them.
         Pry.config.should_load_plugins = false
 
         # Use awesome_print for output, but keep pry's pager. If Hirb is
         # enabled, try printing with it first.
         Pry.config.print = ->(output, value) do
-          return if JazzHands.hirb_output && Hirb::View.view_or_page_output(value)
+          return if JazzHands._hirb_output && Hirb::View.view_or_page_output(value)
           pretty = value.ai(indent: 2)
           Pry::Helpers::BaseHelpers.stagger_output("=> #{pretty}", output)
         end
 
-        # Friendlier prompt - nesting levels look like directory paths
+        # Friendlier prompt - line number, app name, nesting levels look like
+        # directory paths.
+        #
+        # Heavy use of lazy lambdas so configuration (like Pry.color) can be
+        # changed later or even during console usage.
+        #
+        # Custom color helpers using hints \001 and \002 so that good readline
+        # libraries (GNU, rb-readline) correctly ignore color codes when
+        # calculating line length.
+
+        color = -> { Pry.color && JazzHands.colored_prompt }
+        red  = ->(text) { color[] ? "\001\e[0;31m\002#{text}\001\e[0m\002" : text.to_s }
+        blue = ->(text) { color[] ? "\001\e[0;34m\002#{text}\001\e[0m\002" : text.to_s }
+        bold = ->(text) { color[] ? "\001\e[1m\002#{text}\001\e[0m\002"    : text.to_s }
+
+        separator = -> { red.(JazzHands.prompt_separator) }
         name = app.class.parent_name.underscore
-        colored_name = Pry::Helpers::Text.blue(name)
-        raquo = Pry::Helpers::Text.red("\u00BB")
-        line = ->(pry) { "[#{Pry::Helpers::Text.bold(pry.input_array.size)}] " }
+        colored_name = -> { blue.(name) }
+
+        line = ->(pry) { "[#{bold.(pry.input_array.size)}] " }
         target_string = ->(object, level) do
           level = 0 if level < 0
           unless (string = Pry.view_clip(object)) == 'main'
@@ -44,29 +52,21 @@ module JazzHands
             ''
           end
         end
+
         Pry.config.prompt = [
-          ->(object, level, pry) do
-            "#{line.(pry)}#{colored_name}#{target_string.(object, level)} #{raquo}  "
+          ->(object, level, pry) do      # Main prompt
+            "#{line.(pry)}#{colored_name.()}#{target_string.(object, level)} #{separator.()}  "
           end,
-          ->(object, level, pry) do
+          ->(object, level, pry) do      # Wait prompt in multiline input
             spaces = ' ' * (
               "[#{pry.input_array.size}] ".size +  # Uncolored `line.(pry)`
               name.size +
               target_string.(object, level).size
             )
-            "#{spaces} #{raquo}  "
+            "#{spaces} #{separator.()}  "
           end
         ]
       end
     end
-
-    console do
-      # Mimic the IRB's ExtendCommandBundle injection used in Rails 3.2
-      if defined? Rails::ConsoleMethods
-        # We inject into the TOPLEVEL_BINDING's self so only the repl's Object
-        # instance is affected, not all objects.
-        TOPLEVEL_BINDING.eval('self').extend Rails::ConsoleMethods
-      end
-    end
   end
 end

data/lib/jazz_hands/version.rb

@@ -1,3 +1,3 @@
 module JazzHands
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,137 +1,208 @@
 --- !ruby/object:Gem::Specification
 name: jazz_hands
 version: !ruby/object:Gem::Version
-  version: 0.3.1
   prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Gopal Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+    none: false
   name: pry
-  requirement: &70127173400200 !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.2.2
+    none: false
+  name: pry-rails
   type: :runtime
   prerelease: false
-  version_requirements: *70127173400200
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: &70127173399560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.4
+    none: false
+  name: pry-doc
   type: :runtime
   prerelease: false
-  version_requirements: *70127173399560
-- !ruby/object:Gem::Dependency
-  name: pry-git
-  requirement: &70127173399000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.3
+    none: false
+  name: pry-git
   type: :runtime
   prerelease: false
-  version_requirements: *70127173399000
-- !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
-  requirement: &70127173398460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.7
+    none: false
+  name: pry-stack_explorer
   type: :runtime
   prerelease: false
-  version_requirements: *70127173398460
-- !ruby/object:Gem::Dependency
-  name: pry-remote
-  requirement: &70127173397760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.6
+    none: false
+  name: pry-remote
   type: :runtime
   prerelease: false
-  version_requirements: *70127173397760
-- !ruby/object:Gem::Dependency
-  name: pry-debugger
-  requirement: &70127173397240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
+    none: false
+  name: pry-debugger
   type: :runtime
   prerelease: false
-  version_requirements: *70127173397240
-- !ruby/object:Gem::Dependency
-  name: hirb
-  requirement: &70127173396300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
+    none: false
+  name: hirb
   type: :runtime
   prerelease: false
-  version_requirements: *70127173396300
-- !ruby/object:Gem::Dependency
-  name: coolline
-  requirement: &70127173395100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.0
+    none: false
+  name: coolline
   type: :runtime
   prerelease: false
-  version_requirements: *70127173395100
-- !ruby/object:Gem::Dependency
-  name: coderay
-  requirement: &70127173394100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.0.8
+    none: false
+  name: coderay
   type: :runtime
   prerelease: false
-  version_requirements: *70127173394100
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: &70127173392980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.8
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
+    none: false
+  name: awesome_print
   type: :runtime
   prerelease: false
-  version_requirements: *70127173392980
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: &70127173391740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
+  name: railties
   type: :runtime
   prerelease: false
-  version_requirements: *70127173391740
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
 description: Spending hours in the rails console? Spruce it up and show off those
   hard-working hands! jazz_hands replaces IRB with Pry, improves output through awesome_print,
   and has some other goodies up its sleeves.
@@ -160,20 +231,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Exercise those fingers. Pry-based enhancements for the default Rails console.