jazz_hands 0.0.6 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.1.0 (2012-01-04)
+
+* For performance, enable [pry-nav][pry-nav] only on MRI 1.9.3 by default. To
+  use on MRI 1.9.2, add `JazzHands.enable_pry_nav` to a Rails initializer.
+* Due to buggy behavior, syntax highlighting as you type via
+  [Coolline][coolline] and [Coderay][coderay] is disabled by default. Enable
+  with `JazzHands.enable_syntax_highlighting_as_you_type` in a Rails
+  initializer. MRI 1.9.3 only.
+* Fix [Hirb][hirb] support.
+* Upgrade [awesome_print][awesome_print] to 1.0.2.
+
 ## 0.0.6 (2011-12-03)
 
 * Add line numbers to the prompt for easy reference when using `_in_` and

data/README.md

@@ -4,7 +4,7 @@ Jazz Hands
 Spending hours in the rails console? Spruce it up and show off those
 hard-working hands!
 
-**jazz_hands** combines multiple console-related gems and a bit of glue:
+**jazz_hands** is an opinionated set of console-related gems and a bit of glue:
 
 * [**Pry**][pry] for a powerful shell alternative to IRB.
 * [**Awesome Print**][awesome_print] for stylish pretty print.
@@ -12,15 +12,16 @@ hard-working hands!
 * **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
   commits on methods and classes, not just files.
-* [**Pry Nav**][pry-nav] to turn the console into a simple debugger.
 * [**Pry Remote**][pry-remote] to connect remotely to a Pry console.
+* [**Pry Nav**][pry-nav] to turn the console into a simple debugger. _Ruby 1.9.3
+  recommended_
 * [**Coolline**][coolline] and [**Coderay**][coderay] for syntax highlighting as
-  you type. _Ruby 1.9.3 only_
+  you type. _Optional. Ruby 1.9.3 only_
 
 
 ## Usage
 
-Rails 3 and above only. Add to your project Gemfile:
+Ruby 1.9.2+, Rails 3+ only. Add to your project Gemfile:
 
 ```ruby
 group :development, :test do
@@ -32,6 +33,14 @@ That's it. Run `rails console` as usual.
 
 [Hirb][hirb] isn't enabled by default. To use, run `Hirb.enable` in the console.
 
+For performance, [pry-nav][pry-nav] is only enabled on 1.9.3 by default. To
+manually enable for 1.9.2, add `JazzHands.enable_pry_nav` to an initializer.
+
+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 1.9.3.
+
 
 ## Contributing
 

data/jazz_hands.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'hirb', '= 0.6.0'
   gem.add_runtime_dependency 'coolline', '>= 0.1.0'
   gem.add_runtime_dependency 'coderay', '>= 0.9.8'
-  gem.add_runtime_dependency 'awesome_print', '~> 1.0.1'
+  gem.add_runtime_dependency 'awesome_print', '~> 1.0.2'
+  gem.add_runtime_dependency 'railties', '~> 3.0'
 end

data/lib/jazz_hands.rb

@@ -1,2 +1,51 @@
 require 'jazz_hands/version'
 require 'jazz_hands/railtie' if defined?(Rails)
+
+module JazzHands
+  extend self
+
+  # Enable pry-nav.
+  #
+  # For performance reasons, pry-nav is enabled by default for only MRI 1.9.3+.
+  # To use with MRI 1.9.2, call this method from a Rails initializer:
+  #
+  #   JazzHands.enable_pry_nav
+  #
+  def enable_pry_nav
+    require 'pry-nav'
+  end
+
+
+  # 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'
+
+    # 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
+
+
+  ### Internal methods ###
+
+  attr_accessor :hirb_output
+end

data/lib/jazz_hands/hirb_ext.rb

@@ -7,20 +7,12 @@ class << Hirb::View
 
   def enable_output_method
     @output_method = true
-
-    # Adjust Pry output to try Hirb before its existing mechanism
-    @old_pry_print = Pry.config.print
-    Pry.config.print = ->(output, value) do
-      view_or_page_output(value) || @old_pry_print.call(output, value)
-    end
-
+    JazzHands.hirb_output = true
     enable_output_method_existing
   end
 
   def disable_output_method
-    # Set Pry back to its existing output mechanism
-    Pry.config.print = @old_pry_print
-
+    JazzHands.hirb_output = false
     disable_output_method_existing
   end
 end

data/lib/jazz_hands/railtie.rb

@@ -2,14 +2,12 @@ require 'pry'
 require 'pry-doc'
 require 'pry-git'
 require 'pry-remote'
-require 'pry-nav'
 require 'awesome_print'
 require 'jazz_hands/hirb_ext'
 
-if RUBY_VERSION >= '1.9.3'
-  require 'coolline'
-  require 'coderay'
-end
+# Enable pry-nav by default on MRI 1.9.3 only
+require 'pry-nav' if RUBY_VERSION >= '1.9.3'
+
 
 module JazzHands
   class Railtie < Rails::Railtie
@@ -17,23 +15,15 @@ module JazzHands
       silence_warnings do
         ::IRB = Pry    # Replace IRB with Pry completely
 
-        # Use coolline with CodeRay for syntax highlighting as you type
-        # Only works on >= 1.9.3 because coolline depends on io/console
-        if RUBY_VERSION >= '1.9.3'
-          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
+        # We're managing the loading of plugins, especially pry-nav which
+        # shouldn't be loaded on 1.9.2. So don't let pry autoload them.
+        Pry.config.should_load_plugins = false
+        Pry.config.plugins.enabled = false
 
-        # Use awesome_print for output, but keep pry's pager
+        # 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)
           pretty = value.ai(indent: 2)
           Pry::Helpers::BaseHelpers.stagger_output("=> #{pretty}", output)
         end

data/lib/jazz_hands/version.rb

@@ -1,3 +1,3 @@
 module JazzHands
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazz_hands
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-03 00:00:00.000000000 Z
+date: 2012-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70305225757160 !ruby/object:Gem::Requirement
+  requirement: &70123331636700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *70305225757160
+  version_requirements: *70123331636700
 - !ruby/object:Gem::Dependency
   name: pry-doc
-  requirement: &70305225755060 !ruby/object:Gem::Requirement
+  requirement: &70123331634820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70305225755060
+  version_requirements: *70123331634820
 - !ruby/object:Gem::Dependency
   name: pry-git
-  requirement: &70305225753260 !ruby/object:Gem::Requirement
+  requirement: &70123331632940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70305225753260
+  version_requirements: *70123331632940
 - !ruby/object:Gem::Dependency
   name: pry-remote
-  requirement: &70305225751380 !ruby/object:Gem::Requirement
+  requirement: &70123331631140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70305225751380
+  version_requirements: *70123331631140
 - !ruby/object:Gem::Dependency
   name: pry-nav
-  requirement: &70305225750060 !ruby/object:Gem::Requirement
+  requirement: &70123331630080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *70305225750060
+  version_requirements: *70123331630080
 - !ruby/object:Gem::Dependency
   name: hirb
-  requirement: &70305225747380 !ruby/object:Gem::Requirement
+  requirement: &70123331627580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -76,10 +76,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70305225747380
+  version_requirements: *70123331627580
 - !ruby/object:Gem::Dependency
   name: coolline
-  requirement: &70305221645000 !ruby/object:Gem::Requirement
+  requirement: &70123331457820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70305221645000
+  version_requirements: *70123331457820
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &70305221644160 !ruby/object:Gem::Requirement
+  requirement: &70123331456960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,18 +98,29 @@ dependencies:
         version: 0.9.8
   type: :runtime
   prerelease: false
-  version_requirements: *70305221644160
+  version_requirements: *70123331456960
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70305221643000 !ruby/object:Gem::Requirement
+  requirement: &70123331455840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70305221643000
+  version_requirements: *70123331455840
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70123331454880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123331454880
 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.