jazz_fingers 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f7803378737e2a5abab5af11528a62698006071
-  data.tar.gz: aab9be62d8ca3739ba4a5112843bd82e1bc4b227
+  metadata.gz: 4999936c5383de2179cf7bc5d77a6fd222d3de26
+  data.tar.gz: cb9a42ec388dcf1a9350ec07819d884562f5e25e
 SHA512:
-  metadata.gz: f1df8c48619f2585ae452121fd087098faad067d201785f3459f52114460069291fb53d813f6d4b4432805c2441314f700584d2237be4a19ff602bbdc0dccd09
-  data.tar.gz: 48c3fadbda08c48affaeb829e0076853ba45bfdac760665d286c8d62c48d964d2719eecceebc90d8e98132a4afa7cb9978bbfcb81d236ff407de72a11b41b6c3
+  metadata.gz: 0e7754ab8b9f32c1219e1841d1c5345f3d2a6956ab6f5ef42a9de2c2e315ae864db7ba95d5894648a52640b1dae63d711814977e95e0f954e26ae0348cbddae0
+  data.tar.gz: fb570df06f4a74a8d2c93d3773ad883f8a40a1e93a33dd0b761a5b329d3fa3892e753420ce38929bb1f48259dcca2c30a63925830dfb98d6ca01656764801ecb

data/.hound.yml

@@ -1,17 +1,5 @@
 Metrics/LineLength:
-  Enabled: false
-
-Style/EachWithObject:
-  Enabled: false
+  Max: 120
 
-Style/Encoding:
-  EnforcedStyle: when_needed
-
-Style/FormatString:
+Style/Documentation:
   Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/.rubocop.yml

@@ -1,17 +1,5 @@
 Metrics/LineLength:
-  Enabled: false
-
-Style/EachWithObject:
-  Enabled: false
+  Max: 120
 
-Style/Encoding:
-  EnforcedStyle: when_needed
-
-Style/FormatString:
+Style/Documentation:
   Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 5.0.0 (2018-05-02)
+* Remove [pry-doc][pry-doc] dependency to reduce memory footprint
+* Remove [hirb][hirb] dependency since its not being actively maintained
+
 ## 4.0.1 (2016-05-26)
 * Remove requires for `pry-remote`
 

data/Gemfile

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

data/README.md

@@ -10,11 +10,15 @@ hard-working fingers!
 
 * [**Pry**][pry] for a powerful shell alternative to IRB.
 * [**Awesome Print**][awesome_print] for stylish pretty print.
-* [**Hirb**][hirb] for tabular collection output.
-* [**Pry Doc**][pry-doc] to browse Ruby source, including C, directly from the
   console.
 * [**Pry Coolline**][pry-coolline] for syntax highlighting as you type.
 
+## Notes on Update to `5.0.0`
+* [**Hirb**][hirb] was removed since it is not actively being maintained
+* [**Pry-Doc**][pry-doc] was removed since it adds a lot of memory footprint which makes `JazzFingers` too heavy to use in production.
+Add it to your `Gemfile` if you want it back
+* `jazz_fingers/setup` is not needed since the setup is done automatically after the configuration block ends
+* Call `JazzFingers.setup!` if you are using the default configurations
 
 ## Usage
 
@@ -38,8 +42,7 @@ X) will work but is not recommended.
 
 ## Options
 
-Change the following options by creating an initializer
-Example `config/initializers/jazz_fingers.rb`:
+Some configurations can be overwritten:
 
 ```ruby
 if defined?(JazzFingers)
@@ -49,8 +52,6 @@ if defined?(JazzFingers)
     config.coolline = false
     config.application_name = MyAwesomeProject
   end
-
-  require 'jazz_fingers/setup'
 end
 ```
 

data/Rakefile

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

data/jazz_fingers.gemspec

@@ -1,30 +1,29 @@
-# -*- encoding: utf-8 -*-
-
-require File.expand_path("../lib/jazz_fingers/version", __FILE__)
+require File.expand_path('lib/jazz_fingers/version', __dir__)
 
 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 Ruby console."
-  gem.description   = "Spending hours in the ruby 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.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 Ruby console.'
+  description =
+    'Spending hours in the ruby 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.description   = description
 
   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-doc", "~> 0.6"
-  gem.add_runtime_dependency "pry-byebug", "~> 3.4"
-  gem.add_runtime_dependency "hirb", "~> 0.7"
-  gem.add_runtime_dependency "pry-coolline", "~> 0.2"
-  gem.add_runtime_dependency "awesome_print", "~> 1.6"
+  gem.required_ruby_version = '>= 2.0'
+  gem.add_runtime_dependency 'awesome_print', '~> 1.6'
+  gem.add_runtime_dependency 'pry', '~> 0.10'
+  gem.add_runtime_dependency 'pry-byebug', '~> 3.4'
+  gem.add_runtime_dependency 'pry-coolline', '~> 0.2'
 
-  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency 'rubocop'
 end

data/lib/jazz_fingers/configuration.rb

@@ -1,7 +1,7 @@
 module JazzFingers
   class Configuration
     attr_writer :colored_prompt, :prompt_separator, :coolline, :awesome_print,
-      :application_name
+                :application_name
 
     # Color the prompt?
     #
@@ -23,7 +23,7 @@ module JazzFingers
     # Default: right angle quote, or '>' when using rb-readline which doesn't
     # handle mixed encodings well.
     def prompt_separator
-      @prompt_separator ||= defined?(RbReadline) ? ">" : "\u00BB"
+      @prompt_separator ||= defined?(RbReadline) ? '>' : "\u00BB"
     end
 
     def coolline?
@@ -40,22 +40,19 @@ module JazzFingers
 
     def application_name
       return "(#{underscore(@application_name)})" unless @application_name.nil?
+      return "(#{Rails.application.class.parent_name.underscore})" if defined?(Rails)
 
-      if defined?(Rails)
-        return "(#{Rails.application.class.parent_name.underscore})"
-      else
-        return "(jazz_fingers)"
-      end
+      '(jazz_fingers)'
     end
 
     private
 
     def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
+      camel_cased_word.to_s.gsub(/::/, '/')
+                      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                      .tr('-', '_')
+                      .downcase
     end
   end
 end

data/lib/jazz_fingers/input.rb

@@ -1,5 +1,5 @@
-require "pry-coolline"
-require "coderay"
+require 'pry-coolline'
+require 'coderay'
 
 module JazzFingers
   class Input

data/lib/jazz_fingers/print.rb

@@ -1,11 +1,10 @@
-require "awesome_print"
+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}\n")
         end

data/lib/jazz_fingers/prompt.rb

@@ -44,8 +44,8 @@ module JazzFingers
       level = 0 if level < 0
       text = Pry.view_clip(object)
 
-      if text == "main"
-        ""
+      if text == 'main'
+        ''
       else
         "(#{'../' * level}#{text})"
       end
@@ -59,7 +59,7 @@ module JazzFingers
 
     def block_prompt
       lambda do |_object, level, pry|
-        spaces = "  " * level
+        spaces = '  ' * level
         "#{RUBY_VERSION} #{name}#{line_number(pry)} * #{spaces}"
       end
     end

data/lib/jazz_fingers/version.rb

@@ -1,3 +1,3 @@
 module JazzFingers
-  VERSION = "4.0.1"
+  VERSION = '5.0.0'.freeze
 end

data/lib/jazz_fingers.rb

@@ -1,20 +1,22 @@
 ENV['HOME'] ||= '/dev/null'
 
-require "hirb"
-require "pry"
-require "pry-byebug"
-require "pry-doc"
-require "readline"
-require "jazz_fingers/hirb_ext"
+require 'pry'
+require 'pry-byebug'
+require 'readline'
+require 'forwardable'
 
 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"
+  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'
 
   class << self
+    extend Forwardable
+
+    def_delegators :config, :awesome_print?, :coolline?
+
     def print
       @print ||= Print.config
     end
@@ -35,10 +37,23 @@ module JazzFingers
 
     def configure
       yield @config ||= Configuration.new
+      setup!
     end
 
     def config
       @config ||= Configuration.new
     end
+
+    def setup!
+      Pry.print = print if JazzFingers.awesome_print?
+      Pry.prompt = prompt
+      Pry.input = input if JazzFingers.coolline?
+      Pry.config.should_load_plugins = false
+      Pry.commands.alias_command('c', 'continue')
+      Pry.commands.alias_command('s', 'step')
+      Pry.commands.alias_command('n', 'next')
+
+      true
+    end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jazz_fingers
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: hirb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: pry-coolline
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Spending hours in the ruby console? Spruce it up and show off those hard-working
-  hands! jazz_fingers replaces IRB with Pry, improves output through awesome_print,
+  hands! jazz_fingersreplaces IRB with Pry, improves output through awesome_print,
   and has some other goodies up its sleeves.
 email: plribeiro3000@gmail.com
 executables: []
@@ -131,11 +103,9 @@ files:
 - jazz_fingers.gemspec
 - lib/jazz_fingers.rb
 - lib/jazz_fingers/configuration.rb
-- lib/jazz_fingers/hirb_ext.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:
@@ -162,4 +132,3 @@ signing_key:
 specification_version: 4
 summary: Exercise those fingers. Pry-based enhancements for the default Ruby console.
 test_files: []
-has_rdoc: 

data/lib/jazz_fingers/hirb_ext.rb

@@ -1,15 +0,0 @@
-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.config.awesome_print = true
-    enable_output_method_existing
-  end
-
-  def disable_output_method
-    JazzFingers.config.awesome_print = false
-    disable_output_method_existing
-  end
-end

data/lib/jazz_fingers/setup.rb

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