spirit_hands 2.0.8-java

data/lib/spirit_hands/hirb/fixes/pager.rb

@@ -0,0 +1,144 @@
+# Fixes pager_command
+require 'hirb'
+require 'shellwords'
+
+module Hirb
+  # This class provides class methods for paging and an object which can conditionally page given a terminal size that is exceeded.
+  class Pager
+    class << self
+      # Pages using a configured or detected shell command.
+      def command_pager(output, options={})
+        if valid_pager_command?(pc = options[:pager_command])
+          basic_pager(output, pc)
+        end
+      end
+
+      # Exposed to allow user-custom, external-driven formatting
+      def basic_pager(output, override_pager_command=nil)
+        pc = basic_pager_command(override_pager_command)
+        pager = IO.popen(pc, "w")
+        begin
+          save_stdout = STDOUT.clone
+          STDOUT.reopen(pager)
+          STDOUT.puts output
+        rescue Errno::EPIPE
+        ensure
+         STDOUT.reopen(save_stdout)
+         save_stdout.close
+         pager.close
+        end
+      end
+
+      def pager_command=(*commands) #:nodoc:
+        @pager_command = pager_command_select(*commands)
+      end
+
+      def pager_command #:nodoc:
+        @pager_command || pager_command_select
+      end
+
+      # Pages with a ruby-only pager which either pages or quits.
+      def default_pager(output, options={})
+        pager = new(options[:width], options[:height])
+        while pager.activated_by?(output, options[:inspect])
+          puts pager.slice!(output, options[:inspect])
+          return unless continue_paging?
+        end
+        puts output
+        puts "=== Pager finished. ==="
+      end
+
+      def page(string, inspect_mode, pgr_cmd, width, height)
+        if valid_pager_command?(pgr_cmd)
+          command_pager(string, :pager_command=>pgr_cmd)
+        else
+          default_pager(string, :width=>width, :height=>height, :inspect=>inspect_mode)
+        end
+      end
+
+      private
+
+      #:stopdoc:
+      def valid_pager_command?(cmd)
+        cmd && Util.command_exists?(cmd.shellsplit[0])
+      end
+
+      # Default pager commands to try
+      def pager_command_fallbacks #:nodoc:
+        candidates = %w[less more pager cat]
+        candidates.unshift ENV['PAGER'] if ENV['PAGER']
+        candidates
+      end
+
+      # Pick the first valid command from commands
+      def pager_command_select(*commands)
+        commands += pager_command_fallbacks
+        commands.flatten.compact.uniq.find { |c| valid_pager_command? c }
+      end
+
+      # Actual command basic_pager needs to perform
+      def basic_pager_command(override_pager_command)
+        if valid_pager_command?(override_pager_command)
+          override_pager_command
+        else
+          pager_command
+        end
+      end
+
+      def continue_paging?
+        puts "=== Press enter/return to continue or q to quit: ==="
+        !$stdin.gets.chomp[/q/i]
+      end
+      #:startdoc:
+    end # class methods
+
+    attr_reader :width, :height, :options
+
+    def initialize(width, height, options={})
+      resize(width, height)
+      @options = options
+    end
+
+    def pager_command
+      options[:pager_command] || self.class.pager_command
+    end
+
+    # Pages given string using configured pager.
+    def page(string, inspect_mode)
+      self.class.page(string, inspect_mode, pager_command, @width, @height)
+    end
+
+    def slice!(output, inspect_mode=false) #:nodoc:
+      effective_height = @height - 2 # takes into account pager prompt
+      if inspect_mode
+        sliced_output = String.slice(output, 0, @width * effective_height)
+        output.replace String.slice(output, char_count(sliced_output), String.size(output))
+        sliced_output
+      else
+        # could use output.scan(/[^\n]*\n?/) instead of split
+        sliced_output = output.split("\n").slice(0, effective_height).join("\n")
+        output.replace output.split("\n").slice(effective_height..-1).join("\n")
+        sliced_output
+      end
+    end
+
+    # Determines if string should be paged based on configured width and height.
+    def activated_by?(string_to_page, inspect_mode=false)
+      inspect_mode ? (String.size(string_to_page) > @height * @width) : (string_to_page.count("\n") > @height)
+    end
+
+    if String.method_defined? :chars
+      def char_count(string) #:nodoc:
+        string.chars.count
+      end
+    else
+      def char_count(string) #:nodoc:
+        String.size(string)
+      end
+    end
+
+    def resize(width, height) #:nodoc:
+      @width, @height = View.determine_terminal_size(width, height)
+    end
+  end # Pager
+end # Hirb

data/lib/spirit_hands/hirb/fixes/util.rb

@@ -0,0 +1,19 @@
+require 'hirb'
+require 'pathname'
+
+class << Hirb::Util
+  # Determines if a shell command exists by searching for it in ENV['PATH'].
+  # (Fixed version)
+  def command_exists?(command)
+    if c = Pathname.new(command)
+      return true if c.absolute? && c.exist?
+    end
+    executable_file_exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).any? do |d|
+      executable_file_exts.any? do |ext|
+        f = File.expand_path(command + ext, d)
+        File.executable?(f) && !File.directory?(f)
+      end
+    end
+  end
+end # Hirb::Util.self

data/lib/spirit_hands/hirb/fixes/view.rb

@@ -0,0 +1,10 @@
+# Integrate Hirb + SpiritHands print output (AwesomePrint / inspect)
+require 'hirb'
+require 'spirit_hands'
+
+class << Hirb::View
+  def view_or_page_output(str)
+    view_output(str) ||
+      page_output(::SpiritHands::Print.pretty(str), true)
+  end
+end # Hirb::View.self

data/lib/spirit_hands/hirb/fixes.rb

@@ -0,0 +1,5 @@
+require 'hirb'
+require 'spirit_hands/hirb/fixes/pager'
+require 'spirit_hands/hirb/fixes/util'
+require 'spirit_hands/hirb/fixes/view'
+require 'spirit_hands/hirb/fixes/enabled'

data/lib/spirit_hands/hirb.rb

@@ -0,0 +1,2 @@
+require 'hirb'
+require 'spirit_hands/hirb/fixes'

data/lib/spirit_hands/mattr_accessor_with_default.rb

@@ -0,0 +1,44 @@
+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
+end # Module

data/lib/spirit_hands/melody.rb

@@ -0,0 +1,24 @@
+require 'pry'
+
+class << SpiritHands
+  # This modifies pry to play our tune
+  def melody!(app = nil)
+    return false if @installed
+    @installed = true
+
+    SpiritHands.app = app unless app.nil?
+    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!
+  end
+end # SpiritHands.self

data/lib/spirit_hands/options/color.rb

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

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,41 @@
+require 'shellwords'
+
+module SpiritHands
+  DEFAULT_LESS_COLORIZE = true
+  LESS_R_LONG = '--RAW-CONTROL-CHARS'.freeze
+  LESS_R = /\A(.*-[^-R]*)R(.*)\z/.freeze
+
+  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
+end

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

@@ -0,0 +1,36 @@
+require 'shellwords'
+
+module SpiritHands
+  DEFAULT_LESS_SHOW_RAW_UNICODE = true
+  LESS_SHOW_RAW_BINFMT = '*n%c'.freeze
+
+  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
+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,59 @@
+# 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
+  ### 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, -> {
+    if defined?(::Rails)
+      ::Rails.application
+    else
+      # Trumpet emoji or pry
+      (Terminal.unicode?) ? "\u{1F3BA}" : 'pry'
+    end
+  }
+
+  # <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/print.rb

@@ -0,0 +1,75 @@
+module SpiritHands
+  module Print
+    class << self
+      PRINT_FUNCTION = ->(_output, value, _pry_) do
+        ::SpiritHands::Print.print(_output, value, _pry_)
+      end
+
+      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.open do |pager|
+          pager.print ::SpiritHands.value_prompt
+          pager.puts pretty(value)
+        end 
+      end
+
+      private
+
+      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 # self
+  end # Print
+end # SpiritHands