jazz_fingers 5.0.0 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4999936c5383de2179cf7bc5d77a6fd222d3de26
-  data.tar.gz: cb9a42ec388dcf1a9350ec07819d884562f5e25e
+SHA256:
+  metadata.gz: 23ec179734e2fa4ef28b3352075a7c54557f406907fb287818e5df935865dccf
+  data.tar.gz: a2d70183f7ab4d41f952d2b325ddab9b1bd4ebf52b398626def3c7d60f3dec69
 SHA512:
-  metadata.gz: 0e7754ab8b9f32c1219e1841d1c5345f3d2a6956ab6f5ef42a9de2c2e315ae864db7ba95d5894648a52640b1dae63d711814977e95e0f954e26ae0348cbddae0
-  data.tar.gz: fb570df06f4a74a8d2c93d3773ad883f8a40a1e93a33dd0b761a5b329d3fa3892e753420ce38929bb1f48259dcca2c30a63925830dfb98d6ca01656764801ecb
+  metadata.gz: 86bd06b63b658828bfcf6f27986a0c89e5419bee9cf31a42b38d8d8c3135e9bdff0e0a224fce62d96da1ff49aff05c2490403228d5953b830e107e9506c83036
+  data.tar.gz: 2d3e975c8686f6b1936f3501a60a10e429fcee142cb48672797385f5b673039f6dd8edbeb34fe3e490ff4ea8122186844369e3b8fc2dd82485569de736c400f4

data/.hound.yml

@@ -0,0 +1 @@
+.rubocop.yml

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.6.6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 5.1.0.rc1 (2020-04-25)
+* Change deprecated method on pry > 0.13.0
+* Improve naming context
+
+## 5.0.1 (2019-06-02)
+* Remove documentation for removed dependency
+* Use non deprecated method of `pry` if existent
+
 ## 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

data/README.md

@@ -32,8 +32,6 @@ end
 
 That's it. Run `pry` 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

data/lib/jazz_fingers.rb

@@ -6,6 +6,9 @@ require 'readline'
 require 'forwardable'
 
 module JazzFingers
+  autoload :AWESOME_PRINT, 'jazz_fingers/awesome_print'
+  autoload :CodeRay, 'jazz_fingers/coderay'
+  autoload :Commands, 'jazz_fingers/commands'
   autoload :Configuration, 'jazz_fingers/configuration'
   autoload :Input, 'jazz_fingers/input'
   autoload :Print, 'jazz_fingers/print'
@@ -45,13 +48,32 @@ module JazzFingers
     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')
+      Pry.editor = 'vi'
+      Pry.config.ls.separator = "\n"
+      Pry.config.ls.heading_color = :magenta
+      Pry.config.ls.public_method_color = :green
+      Pry.config.ls.protected_method_color = :yellow
+      Pry.config.ls.private_method_color = :bright_black
+
+      JazzFingers::Commands.constants(false).each do |constant|
+        command = JazzFingers::Commands.const_get(constant)
+        Pry.config.commands.import(command)
+      end
+
+      if JazzFingers.awesome_print?
+        require 'awesome_print'
+
+        AwesomePrint.defaults = JazzFingers::AWESOME_PRINT
+        Pry.print = print
+      end
+
+      JazzFingers::CodeRay.setup!
 
       true
     end

data/lib/jazz_fingers/awesome_print.rb

@@ -0,0 +1,26 @@
+module JazzFingers
+  AWESOME_PRINT = {
+    indent: 2,
+    sort_keys: true,
+    color: {
+      args: :greenish,
+      array: :pale,
+      bigdecimal: :blue,
+      class: :yellow,
+      date: :greenish,
+      falseclass: :red,
+      fixnum: :blue,
+      float: :blue,
+      hash: :pale,
+      keyword: :cyan,
+      method: :purpleish,
+      nilclass: :red,
+      string: :yellowish,
+      struct: :pale,
+      symbol: :cyanish,
+      time: :greenish,
+      trueclass: :green,
+      variable: :cyanish
+    }
+  }
+end

data/lib/jazz_fingers/coderay.rb

@@ -0,0 +1,20 @@
+module JazzFingers
+  module CodeRay
+    autoload :ESCAPED_COLORS, 'jazz_fingers/coderay/escaped_colors'
+    autoload :UNESCAPED_COLORS, 'jazz_fingers/coderay/unescaped_colors'
+
+    def self.setup!
+      ::CodeRay.scan("example", :ruby).term
+
+      if ::CodeRay::VERSION >= '1.1.0'
+        ESCAPED_COLORS.each do |key, value|
+          ::CodeRay::Encoders::Terminal::TOKEN_COLORS[key] = value
+        end
+      else
+        UNESCAPED_COLORS.each do |key, value|
+          ::CodeRay::Encoders::Terminal::TOKEN_COLORS[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/jazz_fingers/coderay/escaped_colors.rb

@@ -0,0 +1,74 @@
+module JazzFingers
+  module CodeRay
+    ESCAPED_COLORS = {
+      attribute_name: "\e[33m",
+      attribute_value: "\e[31m",
+      binary: "\e[1;35m",
+      char: {
+        self: "\e[36m",
+        delimiter: "\e[34m"
+      },
+      class: "\e[1;35m",
+      class_variable: "\e[36m",
+      color: "\e[32m",
+      comment: "\e[37m",
+      complex: "\e[34m",
+      constant: "\e[34m\e[4m",
+      decoration: "\e[35m",
+      definition: "\e[1;32m",
+      directive: "\e[32m\e[4m",
+      doc: "\e[46m",
+      doctype: "\e[1;30m",
+      doc_string: "\e[31m\e[4m",
+      entity: "\e[33m",
+      error: "\e[1;33m\e[41m",
+      exception: "\e[1;31m",
+      float: "\e[1;35m",
+      function: "\e[1;34m",
+      global_variable: "\e[42m",
+      hex: "\e[1;36m",
+      include: "\e[33m",
+      integer: "\e[1;34m",
+      key: "\e[35m",
+      label: "\e[1;15m",
+      local_variable: "\e[33m",
+      octal: "\e[1;35m",
+      operator_name: "\e[1;29m",
+      predefined_constant: "\e[1;36m",
+      predefined_type: "\e[1;30m",
+      predefined: "\e[4m\e[1;34m",
+      preprocessor: "\e[36m",
+      pseudo_class: "\e[34m",
+      regexp: {
+        self: "\e[31m",
+        content: "\e[31m",
+        delimiter: "\e[1;29m",
+        modifier: "\e[35m",
+        function: "\e[1;29m"
+      },
+      reserved: "\e[1;31m",
+      shell: {
+        self: "\e[42m",
+        content: "\e[1;29m",
+        delimiter: "\e[37m",
+      },
+      string: {
+        self: "\e[36m",
+        modifier: "\e[1;32m",
+        escape: "\e[1;36m",
+        delimiter: "\e[1;32m",
+      },
+      symbol: "\e[1;31m",
+      tag: "\e[34m",
+      type: "\e[1;34m",
+      value: "\e[36m",
+      variable: "\e[34m",
+
+      insert: "\e[42m",
+      delete: "\e[41m",
+      change: "\e[44m",
+      head: "\e[45m"
+    }.freeze
+  end
+end
+

data/lib/jazz_fingers/coderay/unescaped_colors.rb

@@ -0,0 +1,74 @@
+module JazzFingers
+  module CodeRay
+    UNESCAPED_COLORS = {
+      attribute_name: '33',
+      attribute_value: '31',
+      binary: '1;35',
+      char: {
+        self: '36',
+        delimiter: '34'
+      },
+      class: '1;35',
+      class_variable: '36',
+      color: '32',
+      comment: '37',
+      complex: '34',
+      constant: ['34', '4'],
+      decoration: '35',
+      definition: '1;32',
+      directive: ['32', '4'],
+      doc: '46',
+      doctype: '1;30',
+      doc_string: ['31', '4'],
+      entity: '33',
+      error: ['1;33', '41'],
+      exception: '1;31',
+      float: '1;35',
+      function: '1;34',
+      global_variable: '42',
+      hex: '1;36',
+      include: '33',
+      integer: '1;34',
+      key: '35',
+      label: '1;15',
+      local_variable: '33',
+      octal: '1;35',
+      operator_name: '1;29',
+      predefined_constant: '1;36',
+      predefined_type: '1;30',
+      predefined: ['4', '1;34'],
+      preprocessor: '36',
+      pseudo_class: '34',
+      regexp: {
+        self: '31',
+        content: '31',
+        delimiter: '1;29',
+        modifier: '35',
+        function: '1;29'
+      },
+      reserved: '1;31',
+      shell: {
+        self: '42',
+        content: '1;29',
+        delimiter: '37',
+      },
+      string: {
+        self: '36',
+        modifier: '1;32',
+        escape: '1;36',
+        delimiter: '1;32',
+      },
+      symbol: '1;31',
+      tag: '34',
+      type: '1;34',
+      value: '36',
+      variable: '34',
+
+      insert: '42',
+      delete: '41',
+      change: '44',
+      head: '45'
+    }.freeze
+  end
+end
+

data/lib/jazz_fingers/commands.rb

@@ -0,0 +1,7 @@
+module JazzFingers
+  module Commands
+    autoload :CALLER_METHOD, 'jazz_fingers/commands/caller_method'
+    autoload :COPY, 'jazz_fingers/commands/copy'
+    autoload :SQL, 'jazz_fingers/commands/sql'
+  end
+end

data/lib/jazz_fingers/commands/caller_method.rb

@@ -0,0 +1,16 @@
+module JazzFingers
+  module Commands
+    CALLER_METHOD = Pry::CommandSet.new do
+      command "caller_method" do |depth|
+        depth = depth.to_i || 1
+        if /^(.+?):(\d+)(?::in `(.*)')?/ =~ caller(depth+1).first
+          file   = Regexp.last_match[1]
+          line   = Regexp.last_match[2].to_i
+          method = Regexp.last_match[3]
+          output.puts [file, line, method]
+        end
+      end
+    end
+  end
+end
+

data/lib/jazz_fingers/commands/copy.rb

@@ -0,0 +1,10 @@
+module JazzFingers
+  module Commands
+    COPY = Pry::CommandSet.new do
+      command "copy", "Copy argument to the clip-board" do |str|
+        IO.popen('pbcopy', 'w') { |f| f << str.to_s }
+      end
+    end
+  end
+end
+

data/lib/jazz_fingers/commands/sql.rb

@@ -0,0 +1,14 @@
+module JazzFingers
+  module Commands
+    SQL = Pry::CommandSet.new do
+      command "sql", "Send sql over AR." do |query|
+        if defined?(Rails)
+          pp ActiveRecord::Base.connection.select_all(query)
+        else
+          pp "Rails not defined"
+        end
+      end
+    end
+  end
+end
+

data/lib/jazz_fingers/configuration.rb

@@ -39,10 +39,19 @@ module JazzFingers
     end
 
     def application_name
-      return "(#{underscore(@application_name)})" unless @application_name.nil?
-      return "(#{Rails.application.class.parent_name.underscore})" if defined?(Rails)
+      return underscore(@application_name) unless @application_name.nil?
 
-      '(jazz_fingers)'
+      if defined?(Rails)
+        application_class = Rails.application.class
+
+        if application_class.respond_to?(:module_parent_name)
+          return application_class.module_parent_name.underscore
+        else
+          return application_class.parent_name.underscore
+        end
+      end
+
+      "jazz_fingers"
     end
 
     private

data/lib/jazz_fingers/print.rb

@@ -5,7 +5,7 @@ module JazzFingers
     class << self
       def config
         lambda do |_output, value, pry_object|
-          pretty = value.ai(indent: 2)
+          pretty = value.ai
           pry_object.pager.page("=> #{pretty}\n")
         end
       end

data/lib/jazz_fingers/prompt.rb

@@ -1,5 +1,18 @@
+# frozen_string_literal: true
+
 module JazzFingers
   class Prompt
+    OBJECT_INSTANCE = /#<(.+)>/
+
+    autoload :PryVersion013AndLater, 'jazz_fingers/prompt/pry_version_013_and_later'
+    autoload :PryVersion012AndPrior, 'jazz_fingers/prompt/pry_version_012_and_prior'
+
+    if Pry::VERSION >= "0.13.0"
+      include PryVersion013AndLater
+    else
+      include PryVersion012AndPrior
+    end
+
     def initialize(options = {})
       @colored = options.fetch(:colored)
       @separator = options.fetch(:separator)
@@ -28,44 +41,75 @@ module JazzFingers
       "\001\e[1m\002#{text}\001\e[0m\002"
     end
 
-    def separator
+    def main_separator
       red_text(@separator)
     end
 
-    def name
-      blue_text(@application_name)
+    def wait_separator
+      "*"
     end
 
-    def line_number(pry)
-      "[#{bold_text(pry.input_array.size)}]"
-    end
+    # Return the current Pry context
+    #
+    # When the Pry context is `"main"` or `"nil"`, use the application name from
+    # the JazzFingers config. Examples: "(my_rails_app_name)", "(jazz_fingers)".
+    #
+    # When in the context of an object instance, use the abbreviated object
+    # path. Example: "(#<Pry::Prompt>)", "(#<RSpec::...::ClassName>)"
+    #
+    # Fall back to the raw context provided by Pry.view_clip.
+    # Example: "(Pry::Prompt)"
+    def context(module_name = "main")
+      name =
+        case module_name
+        when "main", "nil"
+          @application_name
+        when OBJECT_INSTANCE
+          abbreviated_context(module_name)
+        else
+          module_name
+        end
 
-    def text(object, level)
-      level = 0 if level < 0
-      text = Pry.view_clip(object)
+      blue_text("(#{name})")
+    end
 
-      if text == 'main'
-        ''
+    def line_number(pry)
+      if pry.respond_to? :input_ring
+        bold_text(pry.input_ring.size)
       else
-        "(#{'../' * level}#{text})"
+        bold_text(pry.input_array.size)
       end
     end
 
-    def main_prompt
-      lambda do |_object, _level, pry|
-        "#{RUBY_VERSION} #{name}#{line_number(pry)} #{separator} "
-      end
-    end
+    # Abbreviate the object path in the given `object_label` string so the
+    # prompt doesn't overflow. Display only the root and leaf namespaces.
+    #
+    # Examples:
+    #   In:  #<Class1::Class2::Class3::Class4::Class5>
+    #   Out: #<Class1::...::Class5>
+    #
+    #   In:  #<Class1::Class2>
+    #   Out: #<Class1::Class2>
+    #
+    #   In:  #<NoPathJustASingleLongClassName>
+    #   Out: #<NoPathJustASingleLongClassName>
+    def abbreviated_context(object_label)
+      object_path = object_label[OBJECT_INSTANCE, 1]
+      object_path_components = object_path.split("::")
+      return object_label if object_path_components.length <= 2
 
-    def block_prompt
-      lambda do |_object, level, pry|
-        spaces = '  ' * level
-        "#{RUBY_VERSION} #{name}#{line_number(pry)} * #{spaces}"
-      end
+      root, *_, leaf = object_path_components
+      "#<#{root}::...::#{leaf}>"
     end
 
-    def config
-      [main_prompt, block_prompt]
+    def template(module_name, pry, separator)
+      format(
+        "%<ruby>s %<context>s[%<line>s] %<separator>s ",
+        ruby: RUBY_VERSION,
+        context: context(module_name),
+        line: line_number(pry),
+        separator: separator
+      )
     end
   end
 end

data/lib/jazz_fingers/prompt/pry_version_012_and_prior.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module JazzFingers
+  class Prompt
+    # For Pry < 0.13.
+    module PryVersion012AndPrior
+      def config
+        [main_prompt, wait_prompt]
+      end
+
+      def main_prompt
+        lambda do |context, _nesting, pry|
+          template(Pry.view_clip(context), pry, main_separator)
+        end
+      end
+
+      def wait_prompt
+        lambda do |context, _nesting, pry|
+          template(Pry.view_clip(context), pry, wait_separator)
+        end
+      end
+    end
+  end
+end

data/lib/jazz_fingers/prompt/pry_version_013_and_later.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module JazzFingers
+  class Prompt
+    # For Pry >= 0.13.
+    module PryVersion013AndLater
+      # Add the JazzFingers prompt to the Pry::Prompt hash to enable changing it
+      # with `change-prompt`.
+      #
+      # Return the Pry::Prompt object.
+      def config
+        return Pry::Prompt[:jazz_fingers] if Pry::Prompt[:jazz_fingers]
+
+        Pry::Prompt.add(
+          :jazz_fingers,
+          "A spruced-up prompt provided by jazz_fingers.",
+          [main_separator, wait_separator]
+        ) do |context, _nesting, pry, separator|
+          template(Pry.view_clip(context), pry, separator)
+        end
+
+        Pry::Prompt[:jazz_fingers]
+      end
+    end
+  end
+end

data/lib/jazz_fingers/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jazz_fingers
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.2
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -102,16 +102,26 @@ files:
 - Rakefile
 - jazz_fingers.gemspec
 - lib/jazz_fingers.rb
+- lib/jazz_fingers/awesome_print.rb
+- lib/jazz_fingers/coderay.rb
+- lib/jazz_fingers/coderay/escaped_colors.rb
+- lib/jazz_fingers/coderay/unescaped_colors.rb
+- lib/jazz_fingers/commands.rb
+- lib/jazz_fingers/commands/caller_method.rb
+- lib/jazz_fingers/commands/copy.rb
+- lib/jazz_fingers/commands/sql.rb
 - lib/jazz_fingers/configuration.rb
 - lib/jazz_fingers/input.rb
 - lib/jazz_fingers/print.rb
 - lib/jazz_fingers/prompt.rb
+- lib/jazz_fingers/prompt/pry_version_012_and_prior.rb
+- lib/jazz_fingers/prompt/pry_version_013_and_later.rb
 - lib/jazz_fingers/version.rb
 homepage: https://github.com/plribeiro3000/jazz_fingers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,9 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Exercise those fingers. Pry-based enhancements for the default Ruby console.
 test_files: []

data/.hound.yml

@@ -1,5 +0,0 @@
-Metrics/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false