jazz_fingers 5.0.1 → 5.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b393eef001d85320069330c948fdd7236e6e7d7f4de9629d8f840d232fc418ca
-  data.tar.gz: e7e153cf459ed83b1d6bcb468b8bfb4034e8b10db6de1bdefd9683960024b8ef
+  metadata.gz: dfc72ca8fb88d61751cd5452ff6f597d769524e3164e87b9b139ee80c5811513
+  data.tar.gz: cde39ec620a826e7a3148d7a8df8e86f033be1692bade1e00c376a92a2f2db41
 SHA512:
-  metadata.gz: e2516d198ba0e449a6924c08dbb353d267cecb72dba81bb017fab65e9b23cb27fcd56ec8ce75a4dff4e843626139b0626420822dca7570f04017cd2c7bfbad16
-  data.tar.gz: 0f8ece831786a3cb2b6a6169f400f0c0b0ebf4822d008889a727d9523e45dee60d2b609092cd2215fa40acf2a23616046d4e3732807901a241ad77c63631f369
+  metadata.gz: d17ad8070588368567d2296e6a5c8da63866d71b7e993bdfd96af57dfa59a60d7ec8aade44d0abb65bbae4f7d49e4b3e8c0ebf2de24e775886a8ca8b07cd3c9e
+  data.tar.gz: 949d5fb0d2d2e5836185f4f361c486db5e15c3aa6ccca61b3f8b9f97c434aafcc437b5b53613840ebca2c542eceab3ed040511656f9c8d021907579ad5c57104

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

data/lib/jazz_fingers/configuration.rb

@@ -39,10 +39,10 @@ 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?
+      return Rails.application.class.parent_name.underscore if defined?(Rails)
 
-      '(jazz_fingers)'
+      "jazz_fingers"
     end
 
     private

data/lib/jazz_fingers/prompt.rb

@@ -1,5 +1,17 @@
+# frozen_string_literal: true
+
 module JazzFingers
   class Prompt
+    OBJECT_INSTANCE = /#<(.+)>/
+
+    if Pry::VERSION >= "0.13.0"
+      require_relative "prompt/pry_version_013_and_later"
+      include PryVersion013AndLater
+    else
+      require_relative "prompt/pry_version_012_and_prior"
+      include PryVersion012AndPrior
+    end
+
     def initialize(options = {})
       @colored = options.fetch(:colored)
       @separator = options.fetch(:separator)
@@ -28,48 +40,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)
-      if pry.respond_to? :input_ring
-        "[#{bold_text(pry.input_ring.size)}]"
-      else
-        "[#{bold_text(pry.input_array.size)}]"
-      end
-    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.1'.freeze
+  VERSION = '5.1.0.rc1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jazz_fingers
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0.rc1
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-02 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -106,6 +106,8 @@ files:
 - 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:
@@ -122,11 +124,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Exercise those fingers. Pry-based enhancements for the default Ruby console.