spirit_hands 2.0.0

data/lib/spirit_hands/load_plugins.rb

@@ -0,0 +1,10 @@
+require 'spirit_hands/plugin'
+
+# awesome_print is autoloaded by Hirb::View patch and/or SpiritHands::Print
+# pry was loaded earlier
+SpiritHands.plugin 'pry-coolline'
+SpiritHands.plugin 'pry-doc'
+SpiritHands.plugin 'pry-git'
+# pry-rails was loaded earlier (if needed)
+SpiritHands.plugin 'pry-remote'
+# hirb is autoloaded by SpiritHands.hirb = true

data/lib/spirit_hands/mattr_accessor_with_default.rb

@@ -0,0 +1,48 @@
+class Module
+  def mattr_accessor_with_default(property, default = nil, &block)
+    if block_given?
+      if default
+        raise ArgumentError, 'Must specify only one of +default+ or &block'
+      end
+      default = block
+    end
+
+    getter = property.to_sym
+    setter = "#{property}=".to_sym
+    class_var = "@@#{property}".to_sym
+
+    # self.property=
+    define_singleton_method(setter) do |value|
+      if value.nil?
+        remove_class_variable(class_var)
+      else
+        class_variable_set(class_var, value)
+      end
+    end
+
+    # self.property
+    if default.respond_to?(:call) # default is callable
+      define_singleton_method(getter) do
+        if class_variable_defined?(class_var)
+          class_variable_get(class_var)
+        else
+          default.()
+        end
+      end
+    else # default is literal object
+      default_value_name = "DEFAULT_#{property}".upcase.to_sym
+      const_set(default_value_name, default)
+      define_singleton_method(getter) do
+        if class_variable_defined?(class_var)
+          class_variable_get(class_var)
+        else
+          const_get(default_value_name)
+        end
+      end
+    end
+  end
+
+  private
+
+  NO_OP = -> { }.freeze
+end

data/lib/spirit_hands/melody.rb

@@ -0,0 +1,41 @@
+require 'pry'
+
+# We're managing the loading of plugins. So don't let pry autoload them.
+::Pry.config.should_load_plugins = false
+
+if defined? ::Rails
+  STDERR.puts 'JF pry-rails' if ENV['SPIRIT_FINGERS_PLUGIN_DEBUG']
+  require 'pry-rails'
+end
+
+module SpiritHands
+  autoload :Print,  'spirit_hands/print'
+  autoload :Prompt, 'spirit_hands/prompt'
+
+  class << self
+    @installed = false
+    # This modifies pry to play our tune
+    def melody!(app = nil)
+      return false if @installed
+
+      # Require all of our pry plugins
+      require 'spirit_hands/load_plugins'
+
+      setup_less_colorize
+      setup_less_show_raw_unicode
+      setup_hirb
+
+      # Use awesome_print for output, but keep pry's pager. If Hirb is
+      # enabled, try printing with it first.
+      ::SpiritHands::Print.install!
+
+      # Friendlier prompt - line number, app name, nesting levels look like
+      # directory paths.
+      #
+      # Configuration (like Pry.color) can be changed later or even during console usage.
+      ::SpiritHands::Prompt.install!(app)
+
+      @installed = true
+    end
+  end
+end

data/lib/spirit_hands/options/color.rb

@@ -0,0 +1,12 @@
+module SpiritHands
+  class << self
+    # Alias for Pry.color
+    def color
+      ::Pry.color
+    end
+
+    def color=(v)
+      ::Pry.color = v
+    end
+  end
+end

data/lib/spirit_hands/options/hirb.rb

@@ -0,0 +1,34 @@
+autoload :Hirb, 'spirit_hands/hirb'
+
+module SpiritHands
+  class << self
+    # Is hirb enabled?
+    def hirb
+      ::Hirb.enabled?
+    end
+
+    # Set whether hirb is enabled (default: true)
+    def hirb=(h)
+      h = DEFAULT_HIRB if h.nil?
+      if hirb != h
+        if h
+          ::Hirb.enable
+        else
+          ::Hirb.disable
+        end
+      end
+      @hirb = !!h
+    end
+
+    private
+
+    def setup_hirb
+      self.hirb = nil unless @hirb
+    end
+  end
+
+  DEFAULT_HIRB = true
+
+  # Whether to use hirb/unicode when hirb is enabled (default: true)
+  mattr_accessor_with_default :hirb_unicode, true
+end

data/lib/spirit_hands/options/less/colorize.rb

@@ -0,0 +1,42 @@
+require 'shellwords'
+
+module SpiritHands
+  class << self
+    # Allow less to display colorized output (default: true)
+    # (If, set updates LESS env var)
+    def less_colorize
+      ENV['LESS'].to_s.shellsplit.any? { |arg| arg == LESS_R_LONG || arg =~ LESS_R }
+    end
+
+    #  true: add -R to LESS env var (default)
+    # false: remove -R from LESS env var
+    #   nil: set to default (true)
+    def less_colorize=(n)
+      n = DEFAULT_LESS_COLORIZE if n.nil?
+
+      args = ENV['LESS'].to_s.shellsplit.map do |arg|
+        next if arg == LESS_R_LONG
+        if arg =~ LESS_R
+          arg = $1 + $2
+        end
+        arg unless arg.empty?
+      end
+      args << '-R' if n
+      new_less = args.collect.to_a.shelljoin
+      ENV['LESS'] = new_less.empty? ? nil : new_less
+      @less_colorize = !!n
+    end
+
+    private
+
+    def setup_less_colorize
+      self.less_colorize = nil unless @less_colorize
+    end
+  end
+
+  private
+
+  DEFAULT_LESS_COLORIZE = true
+  LESS_R_LONG = '--RAW-CONTROL-CHARS'.freeze
+  LESS_R = /\A(.*-[^-R]*)R(.*)\z/.freeze
+end

data/lib/spirit_hands/options/less/show_raw_unicode.rb

@@ -0,0 +1,38 @@
+require 'shellwords'
+
+module SpiritHands
+  class << self
+    # Allow less to display colorized output (default: true)
+    # (If, set updates LESS env var)
+    def less_show_raw_unicode
+      ENV['LESSUTFBINFMT'] == LESS_SHOW_RAW_BINFMT
+    end
+
+    # true: set LESSUTFBINFMT to %*c
+    # false: unset LESSUTFBINFMT
+    # String: set custom LESSUTFBINFMT
+    # nil: set default(true)
+    def less_show_raw_unicode=(n)
+      n = DEFAULT_LESS_SHOW_RAW_UNICODE if n.nil?
+      ENV['LESSUTFBINFMT'] = if n.is_a?(String)
+        n
+      elsif n
+        LESS_SHOW_RAW_BINFMT
+      else
+        nil
+      end
+      @less_show_raw_unicode = !!n
+    end
+
+    private
+
+    def setup_less_show_raw_unicode
+      self.less_show_raw_unicode = nil unless @less_show_raw_unicode
+    end
+  end
+
+  private
+
+  DEFAULT_LESS_SHOW_RAW_UNICODE = true
+  LESS_SHOW_RAW_BINFMT = '*n%c'.freeze
+end

data/lib/spirit_hands/options/less.rb

@@ -0,0 +1,2 @@
+require 'spirit_hands/options/less/colorize'
+require 'spirit_hands/options/less/show_raw_unicode'

data/lib/spirit_hands/options.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+require 'readline'
+require 'spirit_hands/mattr_accessor_with_default'
+require 'spirit_hands/options/color'
+require 'spirit_hands/options/less'
+require 'spirit_hands/options/hirb'
+
+module SpiritHands
+  autoload :Terminal, 'spirit_hands/terminal'
+
+  ### Options ###
+
+  # When printing values, start with this (default: '=> ')
+  mattr_accessor_with_default :value_prompt, '=> '
+
+  # Spaces to indent value (default: 2 spaces)
+  mattr_accessor_with_default :value_indent, 2
+
+  # Name of the app, which can be displayed to <app/> tag in prompt
+  mattr_accessor_with_default :app, -> {
+    # Trumpet emoji or pry
+    (Terminal.unicode?) ? "\u{1F3BA}" : 'pry'
+  }
+
+  # <color>...</color>
+  # <bold>...</color>
+  # <cmd/>  command number
+  # <app/>  SpiritHands.app, which can be String or a Rails Applicatino object
+  # <sep/>  SpiritHands.prompt_separator
+  #
+  # Use \ to escape literal <, so in a Ruby string constant, "\\<"
+  #
+  mattr_accessor_with_default :prompt,
+    '<b>[<cmd/>]</b> <blue><app/></blue><tgt/>  <red><sep/></red>  '
+
+  # 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_with_default :colored_prompt, -> { ::Readline::VERSION !~ /EditLine/ }
+
+  # Separator between application name and input in the prompt.
+  #
+  # Default: right angle quote (chevron) or >
+  #
+  mattr_accessor_with_default :prompt_separator, -> {
+    (Terminal.unicode?) ? "\u{BB}" : '>'
+  }
+
+  # Enable or disable AwesomePrint (default: true)
+  mattr_accessor_with_default :awesome_print, true
+end

data/lib/spirit_hands/plugin.rb

@@ -0,0 +1,28 @@
+module SpiritHands
+  class << self
+    # A thin wrapper around require for troubleshooting
+    def plugin(*requires)
+      cond = requires.pop if requires.last.respond_to? :call
+      requires.each do |r|
+        begin
+          if cond && !cond.()
+            plugin_debug "JF require #{r} (skipped)"
+            next
+          end
+          res = require r
+        rescue LoadError
+          plugin_debug "JF require #{r} FAILED"
+        else
+          plugin_debug "JF require #{r} -> #{res}"
+        end
+      end
+    end
+
+    private
+
+    def plugin_debug(*args)
+      return if !ENV['SPIRIT_FINGERS_PLUGIN_DEBUG']
+      STDERR.puts(*args)
+    end
+  end
+end

data/lib/spirit_hands/print.rb

@@ -0,0 +1,72 @@
+module SpiritHands
+  module Print
+    class << self
+      def install!
+        ::Pry.config.print = PRINT_FUNCTION
+      end
+
+      def pretty(value)
+        if ::SpiritHands.awesome_print
+          require 'awesome_print' unless defined?(AwesomePrint)
+          opts = { :indent => ::SpiritHands.value_indent }
+          opts[:plain] = true if !SpiritHands.color
+          value.ai(opts)
+        else
+          value.inspect
+        end
+      end
+
+      def hirb_unicode_enabled?
+        ::Hirb::Formatter.dynamic_config.keys.any? do |key|
+          if opts = ::Hirb::Formatter.dynamic_config[key][:options]
+            opts && opts[:unicode]
+          end
+        end
+      end
+
+      def print(_output, value, _pry_)
+        if ::Hirb.enabled?
+          setup_hirb_unicode
+          return if ::Hirb::View.view_or_page_output(value)
+        end
+        _pry_.pager.page("#{::SpiritHands.value_prompt}#{pretty(value)}")
+      end
+
+      private
+
+      PRINT_FUNCTION = ->(_output, value, _pry_) do
+        ::SpiritHands::Print.print(_output, value, _pry_)
+      end
+
+      def hirb_unicode_enable
+        return false unless ::SpiritHands::Terminal.unicode?
+        require 'hirb/unicode'
+
+        ::Hirb::Formatter.dynamic_config.keys.each do |key|
+          ::Hirb::Formatter.dynamic_config[key][:options] ||= {}
+          ::Hirb::Formatter.dynamic_config[key][:options][:unicode] = true
+        end
+        true
+      end
+
+      def hirb_unicode_disable
+        ::Hirb::Formatter.dynamic_config.keys.each do |key|
+          ::Hirb::Formatter.dynamic_config[key][:options] ||= {}
+          ::Hirb::Formatter.dynamic_config[key][:options][:unicode] = false
+        end
+        false
+      end
+
+      def setup_hirb_unicode
+        if hirb_unicode_enabled? != SpiritHands.hirb_unicode
+          if SpiritHands.hirb_unicode
+            hirb_unicode_enable
+          else
+            hirb_unicode_disable
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/spirit_hands/prompt/base.rb

@@ -0,0 +1,249 @@
+module SpiritHands
+  module Prompt
+    class << self
+      private
+
+      def render(state, prompt, color = true)
+        r = Render.new(state, prompt, color)
+        res = r.to_s
+        STDERR.puts "\n" + (r.errors * "\n") + "\n" if r.errors?
+        res
+      end
+    end
+
+    # :object     Object
+    # :level      Fixnum
+    # :pry        Pry
+    # :app        String or Rails::Application
+    # :multiline  false: normal prompt,  true: multiline prompt
+    State = Struct.new(:object, :level, :pry, :app, :multiline)
+
+    # <....>
+    # <..../>
+    # </....>
+    #
+    class Render
+      # <tag> ... </tag>, tag -> inner part of escape codes
+      MATCHED_TAG_CODES = {
+        'b'             => 1,
+        'bold'          => 1,
+        'bright'        => 1,
+        'strong'        => 1,
+
+        'dark'          => 2,
+        'faint'         => 2,
+
+        'i'             => 3,
+        'italic'        => 3,
+        'em'            => 3,
+
+        'u'             => 4,
+        'underline'     => 4,
+
+        'blink'         => 5,  # evil
+        'flash'         => 5,
+
+        'rapid-blink'   => 6, # sinister
+        'rapid-flash'   => 6,
+
+        'reverse'       => 7,
+        'negative'      => 7,
+        'inverse'       => 7,
+
+        'concealed'     => 8,
+
+        'strike'        => 9,
+        'strikethrough' => 9,
+
+        'black'         => 30,
+        'red'           => 31,
+        'green'         => 32,
+        'yellow'        => 33,
+        'blue'          => 34,
+        'magenta'       => 35,
+        'cyan'          => 36,
+        'white'         => 37,
+
+        'bgblack'       => 40,
+        'bgred'         => 41,
+        'bggreen'       => 42,
+        'bgyellow'      => 43,
+        'bgblue'        => 44,
+        'bgmagenta'     => 45,
+        'bgcyan'        => 46,
+        'bgwhite'       => 47,
+      }
+
+      # <.../>
+      SINGLE_TAGS = {
+        # <cmd/>: command number
+        'cmd' => ->(state) { state.pry.input_array.size },
+
+        # <tgt/>: target string
+        'tgt' => ->(state) {
+          unless (str = Pry.view_clip(state.object)) == 'main'
+            state.level = 0 if state.level < 0
+            "(#{'../' * state.level}#{str})"
+          else
+            ''
+          end
+        },
+
+        # <app/>: state.app (Object) converted to String
+        'app' => ->(state) {
+          app = state.app
+          if app.class.respond_to?(:parent_name) && \
+             app.class.parent_name.respond_to?(:underscore)
+            app.class.parent_name.underscore
+          elsif app
+            app.to_s
+          else
+            ::SpiritHands.app
+          end
+        },
+
+        # <sep/>: SpiritHands.prompt_separator
+        'sep' => ->(_state) {
+          ::SpiritHands.prompt_separator
+        }
+      }
+
+      # Array<String>
+      attr_reader :errors
+
+      def errors?
+        errors.any?
+      end
+
+      # :state   SpiritHands::Prompt::State
+      # :prompt  String
+      # :color   true or false/nil
+      def initialize(state, prompt, color)
+        @state = state
+        @prompt = prompt
+        @color = color
+      end
+
+      def to_s
+        @errors = []
+        @tag_stack = []
+        @result = ''
+        @color_applied = false
+        @in_tag = false
+
+        @prompt.each_char do |c|
+          if @in_tag
+            tag_char(c)
+          else
+            nontag_char(c)
+          end
+        end
+
+        # @tag_stack.any? --> error/s
+        @tag_stack.each { |t| errors << "<#{t}>: Missing </#{t}>" }
+
+        (errors?) ? '' : @result
+      end
+
+      private
+
+      def tag_char(c)
+        case c
+        when '/'
+          # close: </
+          # single <.+/
+          @tag_type = (@tag.blank?) ? :close : :single
+        when '>' # close tag
+          @tag.downcase!
+          send @tag_type # :start, :close or :single
+          @in_tag = false
+        else # append to existing tag
+          @tag += c
+        end
+      end
+
+      def nontag_char(c)
+        if @escape
+          nontag_escaped_char(c)
+        else
+          nontag_unescaped_char(c)
+        end
+      end
+
+      def nontag_escaped_char(c)
+        @escape = false
+        @result += (@state.multiline) ? ' ' : c
+      end
+
+      def nontag_unescaped_char(c)
+        case c
+        when '\\' # escape next char
+          @escape = true
+        when '<' # start tag
+          @in_tag = true
+          @tag_type = :start
+          @tag = ''
+        else # normal char
+          @result += (@state.multiline) ? ' ' : c
+        end
+      end
+
+      # <...>
+      def start
+        code = MATCHED_TAG_CODES[@tag]
+        if !code
+          errors << "Unknown <#{@tag}>"
+          return
+        end
+        @result += esc(code)
+        @tag_stack << @tag
+      end
+
+      # </...>
+      def close
+        code = MATCHED_TAG_CODES[@tag]
+        if !code
+          errors << "Unknown </#{@tag}>"
+          return
+        end
+        idx = @tag_stack.rindex @tag
+        if idx.nil?
+          errors << "</#{@tag}>: missing start <#{@tag}>"
+          return
+        end
+        # remove the now closed tag from the stack
+        @tag_stack.delete_at idx
+        # reset and reapply all codes on the @tag_stack
+        @result += reset
+        @tag_stack.each { |tag| @result += esc(MATCHED_TAG_CODES[tag]) }
+      end
+
+      # <.../>
+      def single
+        f = SINGLE_TAGS[@tag]
+        if !f
+          errors << "Unknown </#{@tag}>"
+          return
+        end
+        result = f.(@state).to_s
+
+        # blank out all but sep for multiline prompt, vs. main (normal)
+        if @state.multiline && @tag != 'sep'
+          result = ' ' * result.length
+        end
+        @result += result
+      end
+
+      def reset
+        esc(0)
+      end
+
+      # convert a code to an actual character
+      def esc(code)
+        return '' if !@color
+        @color_applied = true
+        "\001\e[#{code}m\002".freeze
+      end
+    end
+  end
+end

data/lib/spirit_hands/prompt/main.rb

@@ -0,0 +1,18 @@
+require 'spirit_hands/prompt/base'
+
+module SpiritHands
+  module Prompt
+    class << self
+      private
+
+      # Normal, main pry prompt
+      def main
+        ->(object, level, pry) do
+          s = State.new(object, level, pry, ::SpiritHands.app, false)
+          color = ::SpiritHands.color && ::SpiritHands.colored_prompt
+          render(s, ::SpiritHands.prompt, color)
+        end
+      end
+    end
+  end
+end

data/lib/spirit_hands/prompt/multiline.rb

@@ -0,0 +1,17 @@
+require 'spirit_hands/prompt/base'
+
+module SpiritHands
+  module Prompt
+    class << self
+      private
+
+      # Wait pry prompt in multiline input
+      def multiline
+        ->(object, level, pry) {
+          s = State.new(object, level, pry, ::SpiritHands.app, true)
+          render(s, ::SpiritHands.prompt, ::SpiritHands.color && ::SpiritHands.colored_prompt)
+        }
+      end
+    end
+  end
+end

data/lib/spirit_hands/prompt.rb

@@ -0,0 +1,13 @@
+require 'spirit_hands/prompt/main'
+require 'spirit_hands/prompt/multiline'
+
+module SpiritHands
+  module Prompt
+    class << self
+      def install!(app = nil)
+        ::SpiritHands.app ||= app
+        ::Pry.config.prompt = [ main, multiline ].freeze
+      end
+    end
+  end
+end