jazz_fingers 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f303845ae64b80312267fb5d81515ecaa31b0de3
-  data.tar.gz: 63d21f69ea114302c01cbe867abb6dfec829a9ed
+  metadata.gz: aaecd076918e8c0a873af5007079f239c6da8b94
+  data.tar.gz: 19fb8b5fdb8ef30f55e9737f9bcb6344dc2253b3
 SHA512:
-  metadata.gz: 3af3c692c957104534bf4ce2c1bab348c936b635d817e21a460ee27787c0161b25edacba4c845e6238bf6ff82e41beab0e36dd2c340c88e665f32e92d754c0bf
-  data.tar.gz: 9fba66e645e51368223c0b2d0296c6b0ca2e477890a8719cf1c05f791dafcb4d5760e320bb94f579a1033c39236159493142c0ea006c65341c903ca0e358704b
+  metadata.gz: f6e8dc5f3708373499ac583f108d7fd55ae4b6efca65a5af5b8c65f1345ce49300ef2d832a6556aa1ef03c39f89a7581b65c67c45ad575d8a4cb8bbf7d61a58d
+  data.tar.gz: 52ca34d63cbb53f6580728581edd113ea56b588ed9addbceea459f72327172243c004e0dcd8ca810d04bc934f3259322894b50199b922e60f6d2cb9889382158

data/.hound.yml

@@ -10,9 +10,6 @@ Style/Encoding:
 Style/FormatString:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
 Style/SignalException:
   EnforcedStyle: only_raise
 

data/.rubocop.yml

@@ -10,9 +10,6 @@ Style/Encoding:
 Style/FormatString:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
 Style/SignalException:
   EnforcedStyle: only_raise
 

data/CHANGELOG.md

@@ -1,7 +1,20 @@
+## 2.0.0 (2015-05-31)
+
+* Add alias to the most used commands
+* Update [pry-byebug][pry-byebug] to ~> v3.1
+* Improve abstraction by creating models to handle specific responsibilities
+* Add configuration to enable/disable [pry-coolline][pry-coolline]
+* Add configuration to enable/disable [awesome_print][awesome_print]
+* Remove [pry-rails][pry-rails] dependency
+* Remove [railties][railties] dependency
+
+## 1.0.0 (2015-02-05)
+* Downgrade [pry-byebug][pry-byebug] to v1.3.3
+
 ## 0.5.5 (2015-02-03)
 
 * Update [pry-byebug][pry-byebug] to v2.0.0
-* Update [awesome-print][awesome-print] to v1.6.1
+* Update [awesome_print][awesome_print] to v1.6.1
 
 ## 0.5.4 (2014-11-06)
 
@@ -139,3 +152,4 @@
 [pry-debugger]:       https://github.com/nixme/pry-debugger
 [pry-rails]:          https://github.com/rweng/pry-rails
 [pry-byebug]:         https://github.com/deivid-rodriguez/pry-byebug
+[railties]:           https://github.com/rails/rails

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
 gemspec

data/README.md

@@ -3,16 +3,14 @@ Jazz Fingers
 
 This repo is a fork, with updates and bug fixes based on [`jazz_hands`](https://github.com/nixme/jazz_hands).
 
-Spending hours in the rails console? Spruce it up and show off those
-hard-working hands!
+Spending hours in the pry console? Spruce it up and show off those
+hard-working fingers!
 
 **jazz_fingers** 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.
 * [**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
@@ -23,7 +21,7 @@ hard-working hands!
 
 ## Usage
 
-Ruby 2.0.0+, Rails 3 or 4 only. Add to your project Gemfile:
+Ruby 2.0.0+. Add to your project Gemfile:
 
 ```ruby
 group :development, :test do
@@ -31,7 +29,7 @@ group :development, :test do
 end
 ```
 
-That's it. Run `rails console` as usual.
+That's it. Run `pry` as usual.
 
 [Hirb][hirb] isn't enabled by default. To use, run `Hirb.enable` in the console.
 
@@ -43,12 +41,18 @@ X) will work but is not recommended.
 
 ## Options
 
-Change the following options by creating an initializer in your Rails project
+Change the following options by creating an initializer
 Example `config/initializers/jazz_fingers.rb`:
 
 ```ruby
 if defined?(JazzFingers)
-  JazzFingers.colored_prompt = false
+  JazzFingers.configure do |config|
+    config.colored_prompt = false
+    config.awesome_print = false
+    config.coolline = false
+  end
+
+  require 'jazz_fingers/setup'
 end
 ```
 
@@ -70,7 +74,6 @@ mixed encodings.
 [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-remote]:         https://github.com/Mon-Ouie/pry-remote

data/Rakefile

@@ -1,3 +1,3 @@
 #!/usr/bin/env rake
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"

data/jazz_fingers.gemspec

@@ -1,32 +1,31 @@
 # -*- encoding: utf-8 -*-
 
-require File.expand_path('../lib/jazz_fingers/version', __FILE__)
+require File.expand_path("../lib/jazz_fingers/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = 'jazz_fingers'
+  gem.name          = "jazz_fingers"
   gem.version       = JazzFingers::VERSION
-  gem.author        = 'Paulo Henrique Lopes Ribeiro'
-  gem.email         = 'plribeiro3000@gmail.com'
-  gem.license       = 'MIT'
-  gem.homepage      = 'https://github.com/plribeiro3000/jazz_fingers'
-  gem.summary       = 'Exercise those fingers. Pry-based enhancements for the default Rails console.'
+  gem.author        = "Paulo Henrique Lopes Ribeiro"
+  gem.email         = "plribeiro3000@gmail.com"
+  gem.license       = "MIT"
+  gem.homepage      = "https://github.com/plribeiro3000/jazz_fingers"
+  gem.summary       = "Exercise those fingers. Pry-based enhancements for the default Rails console."
   gem.description   = "Spending hours in the rails console? Spruce it up and show off those hard-working hands! jazz_fingers replaces IRB with Pry, improves output through awesome_print, and has some other goodies up its sleeves."
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.require_paths = ['lib']
+  gem.require_paths = ["lib"]
 
   # Dependencies
-  gem.required_ruby_version = '>= 2.0'
-  gem.add_runtime_dependency 'pry', '~> 0.10'
-  gem.add_runtime_dependency 'pry-rails', '~> 0.3'
-  gem.add_runtime_dependency 'pry-doc', '~> 0.6'
-  gem.add_runtime_dependency 'pry-git', '~> 0.2'
-  gem.add_runtime_dependency 'pry-remote', '>= 0.1.7'
-  gem.add_runtime_dependency 'pry-byebug', '1.3.3'
-  gem.add_runtime_dependency 'hirb', '~> 0.7'
-  gem.add_runtime_dependency 'pry-coolline', '~> 0.2'
-  gem.add_runtime_dependency 'awesome_print', '~> 1.6.1'
-  gem.add_runtime_dependency 'railties', '>= 3.0', '< 5.0'
+  gem.required_ruby_version = ">= 2.0"
+  gem.add_runtime_dependency "pry", "~> 0.10"
+  gem.add_runtime_dependency "pry-doc", "~> 0.6"
+  gem.add_runtime_dependency "pry-git", "~> 0.2"
+  gem.add_runtime_dependency "pry-remote", ">= 0.1.7"
+  gem.add_runtime_dependency "pry-byebug", "~> 3.1"
+  gem.add_runtime_dependency "hirb", "~> 0.7"
+  gem.add_runtime_dependency "pry-coolline", "~> 0.2"
+  gem.add_runtime_dependency "awesome_print", "~> 1.6"
+  gem.add_development_dependency "rubocop"
 end

data/lib/jazz_fingers/configuration.rb

@@ -0,0 +1,40 @@
+module JazzFingers
+  class Configuration
+    attr_writer :colored_prompt, :prompt_separator, :coolline, :awesome_print
+
+    # Color the prompt?
+    #
+    # A different setting than Pry.color since some may like colored output, but a
+    # plain prompt.
+    #
+    # 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 colored_prompt
+      return (Readline::VERSION !~ /EditLine/) && Pry.color if @colored_prompt.nil?
+
+      @colored_prompt
+    end
+
+    # 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.
+    def prompt_separator
+      @prompt_separator ||= defined?(RbReadline) ? ">" : "\u00BB"
+    end
+
+    def coolline?
+      return false if @coolline.nil?
+
+      @coolline
+    end
+
+    def awesome_print?
+      return true if @awesome_print.nil?
+
+      @awesome_print
+    end
+  end
+end

data/lib/jazz_fingers/hirb_ext.rb

@@ -1,18 +1,15 @@
-require 'hirb'
-require 'pry'
-
 class << Hirb::View
   alias_method :enable_output_method_existing, :enable_output_method
   alias_method :disable_output_method_existing, :disable_output_method
 
   def enable_output_method
     @output_method = true
-    JazzFingers._hirb_output = true
+    JazzFingers.config.awesome_print = true
     enable_output_method_existing
   end
 
   def disable_output_method
-    JazzFingers._hirb_output = false
+    JazzFingers.config.awesome_print = false
     disable_output_method_existing
   end
 end

data/lib/jazz_fingers/input.rb

@@ -0,0 +1,27 @@
+require "pry-coolline"
+require "coderay"
+
+module JazzFingers
+  class Input
+    class << self
+      def config
+        {
+          cool: cool_input
+        }
+      end
+
+      def cool_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
+    end
+  end
+end

data/lib/jazz_fingers/print.rb

@@ -0,0 +1,15 @@
+require "awesome_print"
+
+module JazzFingers
+  class Print
+    class << self
+      def config
+        lambda do |_output, value, pry_object|
+          return if Hirb::View.view_or_page_output(value)
+          pretty = value.ai(indent: 2)
+          pry_object.pager.page("=> #{pretty}")
+        end
+      end
+    end
+  end
+end

data/lib/jazz_fingers/prompt.rb

@@ -0,0 +1,76 @@
+module JazzFingers
+  class Prompt
+    def initialize(options = {})
+      @colored = options.fetch(:colored)
+      @separator = options.fetch(:separator)
+    end
+
+    def colored?
+      @colored
+    end
+
+    def red_text(text)
+      return text.to_s unless colored?
+
+      "\001\e[0;31m\002#{text}\001\e[0m\002"
+    end
+
+    def blue_text(text)
+      return text.to_s unless colored?
+
+      "\001\e[0;34m\002#{text}\001\e[0m\002"
+    end
+
+    def bold_text(text)
+      return text.to_s unless colored?
+
+      "\001\e[1m\002#{text}\001\e[0m\002"
+    end
+
+    def separator
+      red_text(@separator)
+    end
+
+    def name
+      if respond_to?(:app)
+        name = "(#{app.class.parent_name.underscore})"
+      else
+        name = "(jazz_fingers)"
+      end
+
+      blue_text(name)
+    end
+
+    def line_number(pry)
+      "[#{bold_text(pry.input_array.size)}]"
+    end
+
+    def text(object, level)
+      level = 0 if level < 0
+      text = Pry.view_clip(object)
+
+      if text == "main"
+        ""
+      else
+        "(#{'../' * level}#{text})"
+      end
+    end
+
+    def main_prompt
+      lambda do |_object, _level, pry|
+        "#{RUBY_VERSION} #{name}#{line_number(pry)} #{separator} "
+      end
+    end
+
+    def block_prompt
+      lambda do |_object, level, pry|
+        spaces = "  " * level
+        "#{RUBY_VERSION} #{name}#{line_number(pry)} * #{spaces}"
+      end
+    end
+
+    def config
+      [main_prompt, block_prompt]
+    end
+  end
+end

data/lib/jazz_fingers/setup.rb

@@ -0,0 +1,9 @@
+# JazzFingers dance
+Pry.print = JazzFingers.print if JazzFingers.config.awesome_print?
+Pry.prompt = JazzFingers.prompt
+Pry.input = JazzFingers.input if JazzFingers.config.coolline?
+
+# Command Shortcuts
+Pry.commands.alias_command('c', 'continue')
+Pry.commands.alias_command('s', 'step')
+Pry.commands.alias_command('n', 'next')

data/lib/jazz_fingers/version.rb

@@ -1,3 +1,3 @@
 module JazzFingers
-  VERSION = '1.0.0'
+  VERSION = "2.0.0"
 end

data/lib/jazz_fingers.rb

@@ -1,34 +1,38 @@
-require 'jazz_fingers/version'
-require 'jazz_fingers/railtie' if defined?(Rails)
-require 'active_support'
-require 'readline'
+require "hirb"
+require "pry"
+require "pry-doc"
+require "pry-git"
+require "pry-remote"
+require "readline"
+require "jazz_fingers/hirb_ext"
 
 module JazzFingers
+  autoload :Configuration, "jazz_fingers/configuration"
+  autoload :Input, "jazz_fingers/input"
+  autoload :Print, "jazz_fingers/print"
+  autoload :Prompt, "jazz_fingers/prompt"
+  autoload :VERSION, "jazz_fingers/version"
 
-  ### Options ###
+  class << self
+    def print
+      @print ||= Print.config
+    end
 
-  # Color the prompt?
-  #
-  # A different setting than Pry.color since some may like colored output, but a
-  # plain prompt.
-  #
-  # 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).
-  #
-  mattr_accessor :colored_prompt
-  self.colored_prompt = (Readline::VERSION !~ /EditLine/)
+    def prompt
+      @prompt ||= Prompt.new(colored: config.colored_prompt, separator: config.prompt_separator)
+      @prompt.config
+    end
 
-  # 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"
+    def input
+      @input ||= Input.config
+    end
 
-  ### Internal methods ###
+    def configure
+      yield @config ||= Configuration.new
+    end
 
-  mattr_accessor :_hirb_output
+    def config
+      @config ||= Configuration.new
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jazz_fingers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: pry-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +70,16 @@ dependencies:
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
@@ -128,34 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: Spending hours in the rails console? Spruce it up and show off those
   hard-working hands! jazz_fingers replaces IRB with Pry, improves output through
   awesome_print, and has some other goodies up its sleeves.
@@ -178,8 +158,12 @@ files:
 - Rakefile
 - jazz_fingers.gemspec
 - lib/jazz_fingers.rb
+- lib/jazz_fingers/configuration.rb
 - lib/jazz_fingers/hirb_ext.rb
-- lib/jazz_fingers/railtie.rb
+- lib/jazz_fingers/input.rb
+- lib/jazz_fingers/print.rb
+- lib/jazz_fingers/prompt.rb
+- lib/jazz_fingers/setup.rb
 - lib/jazz_fingers/version.rb
 homepage: https://github.com/plribeiro3000/jazz_fingers
 licenses:

data/lib/jazz_fingers/railtie.rb

@@ -1,70 +0,0 @@
-require 'awesome_print'
-require 'pry'
-require 'pry-coolline'
-require 'pry-doc'
-require 'pry-git'
-require 'pry-rails'
-require 'pry-remote'
-require 'jazz_fingers/hirb_ext'
-
-module JazzFingers
-  class Railtie < Rails::Railtie
-    initializer 'jazz_fingers.initialize' do |app|
-      silence_warnings do
-        # 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, _pry_) do
-          return if JazzFingers._hirb_output && Hirb::View.view_or_page_output(value)
-          pretty = value.ai(indent: 2)
-          _pry_.pager.page("=> #{pretty}")
-        end
-
-        # 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 && JazzFingers.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.(JazzFingers.prompt_separator) }
-        name = app.class.parent_name.underscore
-        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'
-            "(#{'../' * level}#{string})"
-          else
-            ''
-          end
-        end
-
-        Pry.config.prompt = [
-          ->(object, level, pry) do      # Main prompt
-            "#{line.(pry)}#{colored_name.()}#{target_string.(object, level)} #{separator.()}  "
-          end,
-          ->(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} #{separator.()}  "
-          end
-        ]
-      end
-    end
-  end
-end