toys-core 0.3.2 → 0.3.3

data/lib/toys/utils/module_lookup.rb

@@ -48,18 +48,21 @@ module Toys
         # @return [String] Converted string
         #
         def to_path_name(str)
-          str.to_s.gsub(/([a-zA-Z])([A-Z])/) { |_m| "#{$1}_#{$2.downcase}" }.downcase
+          str = str.to_s.sub(/^_/, "").sub(/_$/, "").gsub(/_+/, "_")
+          while str.sub!(/([^_])([A-Z])/, "\\1_\\2") do end
+          str.downcase
         end
 
         ##
         # Convert the given string to a module name. Specifically, converts
-        # to `UpperCamelCase`.
+        # to `UpperCamelCase`, and then to a symbol.
         #
         # @param [String,Symbol] str String to convert.
-        # @return [String] Converted string
+        # @return [Symbol] Converted name
         #
         def to_module_name(str)
-          str.to_s.gsub(/(^|_)([a-zA-Z0-9])/) { |_m| $2.upcase }
+          str = str.to_s.sub(/^_/, "").sub(/_$/, "").gsub(/_+/, "_")
+          str.to_s.gsub(/(^|_)([a-zA-Z])/) { |_m| $2.upcase }.to_sym
         end
 
         ##
@@ -77,7 +80,16 @@ module Toys
         #
         def lookup!(collection, name)
           require "toys/#{to_path_name(collection)}/#{to_path_name(name)}"
-          ::Toys.const_get(to_module_name(collection)).const_get(to_module_name(name))
+          collection_sym = to_module_name(collection)
+          unless ::Toys.constants.include?(collection_sym)
+            raise ::NameError, "Module does not exist: Toys::#{collection_sym}"
+          end
+          collection_mod = ::Toys.const_get(collection_sym)
+          name_sym = to_module_name(name)
+          unless collection_mod.constants.include?(name_sym)
+            raise ::NameError, "Module does not exist: Toys::#{collection_sym}::#{name_sym}"
+          end
+          collection_mod.const_get(name_sym)
         end
 
         ##

data/lib/toys/utils/usage.rb

@@ -37,6 +37,18 @@ module Toys
     # and related options.
     #
     class Usage
+      ##
+      # Default width of first column
+      # @return [Integer]
+      #
+      DEFAULT_LEFT_COLUMN_WIDTH = 32
+
+      ##
+      # Default indent
+      # @return [Integer]
+      #
+      DEFAULT_INDENT = 4
+
       ##
       # Create a usage helper given an execution context.
       #
@@ -44,22 +56,22 @@ module Toys
       # @return [Toys::Utils::Usage]
       #
       def self.from_context(context)
-        new(context[Context::TOOL], context[Context::BINARY_NAME], context[Context::LOADER])
+        new(context[Context::TOOL], context[Context::LOADER], context[Context::BINARY_NAME])
       end
 
       ##
       # Create a usage helper.
       #
       # @param [Toys::Tool] tool The tool for which to generate documentation.
-      # @param [String] binary_name The name of the binary. e.g. `"toys"`.
       # @param [Toys::Loader] loader A loader that can provide subcommands.
+      # @param [String] binary_name The name of the binary. e.g. `"toys"`.
       #
       # @return [Toys::Utils::Usage]
       #
-      def initialize(tool, binary_name, loader)
+      def initialize(tool, loader, binary_name)
         @tool = tool
-        @binary_name = binary_name
         @loader = loader
+        @binary_name = binary_name
       end
 
       ##
@@ -71,27 +83,29 @@ module Toys
       #     listing subcommands. Defaults to `nil` which finds all subcommands.
       # @param [Boolean] show_path If true, shows the path to the config file
       #     containing the tool definition (if set). Defaults to false.
+      # @param [Integer] left_column_width Width of the first column. Default
+      #     is {DEFAULT_LEFT_COLUMN_WIDTH}.
+      # @param [Integer] indent Indent width. Default is {DEFAULT_INDENT}.
       #
       # @return [String] A usage string.
       #
-      def string(recursive: false, search: nil, show_path: false)
-        optparse = ::OptionParser.new
-        optparse.banner = @tool.includes_executor? ? tool_banner : group_banner
-        unless @tool.effective_long_desc.empty?
-          optparse.separator("")
-          optparse.separator(@tool.effective_long_desc)
-        end
-        if show_path && @tool.definition_path
-          optparse.separator("")
-          optparse.separator("Defined in #{@tool.definition_path}")
-        end
-        add_switches(optparse)
+      def string(recursive: false, search: nil, show_path: false,
+                 left_column_width: nil, indent: nil,
+                 wrap_width: nil, right_column_wrap_width: nil)
+        left_column_width ||= DEFAULT_LEFT_COLUMN_WIDTH
+        indent ||= DEFAULT_INDENT
+        right_column_wrap_width ||= wrap_width - left_column_width - indent - 1 if wrap_width
+        lines = []
+        lines << (@tool.includes_executor? ? tool_banner : group_banner)
+        add_description(lines, wrap_width, show_path)
+        add_switches(lines, indent, left_column_width, right_column_wrap_width)
         if @tool.includes_executor?
-          add_positional_arguments(optparse)
+          add_positional_arguments(lines, indent, left_column_width, right_column_wrap_width)
         else
-          add_command_list(optparse, recursive, search)
+          add_command_list(lines, recursive, search, indent,
+                           left_column_width, right_column_wrap_width)
         end
-        optparse.to_s
+        lines.join("\n") + "\n"
       end
 
       private
@@ -118,40 +132,62 @@ module Toys
       # Returns the banner string for a group
       #
       def group_banner
-        list = ["Usage:", @binary_name] +
-               @tool.full_name +
-               ["<command>", "<command-arguments...>"]
-        list.join(" ")
+        banner = ["Usage:", @binary_name] +
+                 @tool.full_name +
+                 ["<command>", "<command-arguments...>"]
+        banner.join(" ")
+      end
+
+      def add_description(lines, wrap_width, show_path)
+        long_desc = @tool.effective_long_desc(wrap_width: wrap_width)
+        unless long_desc.empty?
+          lines << ""
+          lines.concat(long_desc)
+        end
+        if show_path && @tool.definition_path
+          lines << ""
+          lines << "Defined in #{@tool.definition_path}"
+        end
       end
 
       #
       # Add switches from the tool to the given optionparser. Causes the
       # optparser to generate documentation for those switches.
       #
-      def add_switches(optparse)
+      def add_switches(lines, indent, left_column_width, right_column_wrap_width)
         return if @tool.switch_definitions.empty?
-        optparse.separator("")
-        optparse.separator("Options:")
+        lines << ""
+        lines << "Options:"
         @tool.switch_definitions.each do |switch|
-          optparse.on(*switch.optparse_info)
+          add_switch(lines, switch, indent, left_column_width, right_column_wrap_width)
         end
       end
 
+      #
+      # Add a single switch
+      #
+      def add_switch(lines, switch, indent, left_column_width, right_column_wrap_width)
+        switches_str = (switch.single_switch_syntax.map(&:str_without_value) +
+                        switch.double_switch_syntax.map(&:str_without_value)).join(", ")
+        switches_str << switch.value_delim << switch.value_label if switch.value_label
+        switches_str = "    #{switches_str}" if switch.single_switch_syntax.empty?
+        add_doc(lines, switches_str, switch.wrapped_docs(right_column_wrap_width),
+                indent, left_column_width)
+      end
+
       #
       # Add documentation for the tool's positional arguments, to the given
       # option parser.
       #
-      def add_positional_arguments(optparse)
+      def add_positional_arguments(lines, indent, left_column_width, right_column_wrap_width)
         args_to_display = @tool.required_arg_definitions + @tool.optional_arg_definitions
         args_to_display << @tool.remaining_args_definition if @tool.remaining_args_definition
         return if args_to_display.empty?
-        optparse.separator("")
-        optparse.separator("Positional arguments:")
+        lines << ""
+        lines << "Positional arguments:"
         args_to_display.each do |arg_info|
-          optparse.separator("    #{arg_info.canonical_name.ljust(31)}  #{arg_info.doc.first}")
-          (arg_info.doc[1..-1] || []).each do |d|
-            optparse.separator("                                     #{d}")
-          end
+          add_doc(lines, arg_info.canonical_name, arg_info.wrapped_docs(right_column_wrap_width),
+                  indent, left_column_width)
         end
       end
 
@@ -159,23 +195,40 @@ module Toys
       # Add documentation for the tool's subcommands, to the given option
       # parser.
       #
-      def add_command_list(optparse, recursive, search)
+      def add_command_list(lines, recursive, search, indent,
+                           left_column_width, right_column_wrap_width)
         name_len = @tool.full_name.length
         subtools = find_commands(recursive, search)
         return if subtools.empty?
-        optparse.separator("")
-        if search
-          optparse.separator("Commands with search term #{search.inspect}:")
-        else
-          optparse.separator("Commands:")
-        end
+        lines << ""
+        lines << (search ? "Commands with search term #{search.inspect}:" : "Commands:")
         subtools.each do |subtool|
-          tool_name = subtool.full_name.slice(name_len..-1).join(" ").ljust(31)
-          if subtool.is_a?(Alias)
-            optparse.separator("    #{tool_name}  (Alias of #{subtool.display_target})")
+          tool_name = subtool.full_name.slice(name_len..-1).join(" ")
+          doc =
+            if subtool.is_a?(Alias)
+              ["(Alias of #{subtool.display_target})"]
+            else
+              subtool.effective_desc(wrap_width: right_column_wrap_width)
+            end
+          add_doc(lines, tool_name, doc, indent, left_column_width)
+        end
+      end
+
+      #
+      # Add a line with possible documentation strings.
+      #
+      def add_doc(lines, initial, doc, indent, left_column_width)
+        initial = "#{' ' * indent}#{initial.ljust(left_column_width)}"
+        remaining_doc =
+          if initial.size <= indent + left_column_width
+            lines << "#{initial} #{doc.first}"
+            doc[1..-1] || []
           else
-            optparse.separator("    #{tool_name}  #{subtool.effective_desc}")
+            lines << initial
+            doc
           end
+        remaining_doc.each do |d|
+          lines << "#{' ' * (indent + left_column_width)} #{d}"
         end
       end
 
@@ -187,8 +240,9 @@ module Toys
         return subtools if search.nil? || search.empty?
         regex = Regexp.new("(^|\\s)#{Regexp.escape(search)}(\\s|$)", Regexp::IGNORECASE)
         subtools.find_all do |tool|
-          regex =~ tool.display_name || regex =~ tool.effective_desc ||
-            regex =~ tool.effective_long_desc
+          regex =~ tool.display_name ||
+            tool.effective_desc.find { |d| regex =~ d } ||
+            tool.effective_long_desc.find { |d| regex =~ d }
         end
       end
     end

data/lib/toys/utils/wrappable_string.rb

@@ -0,0 +1,92 @@
+# Copyright 2018 Daniel Azuma
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+;
+
+module Toys
+  module Utils
+    ##
+    # A string intended to be wrapped.
+    #
+    class WrappableString
+      ##
+      # Create a wrapped string.
+      # @param [String] string The string.
+      #
+      def initialize(string = "")
+        @string = string
+      end
+
+      ##
+      # Returns the string.
+      # @return [String]
+      #
+      attr_reader :string
+
+      ##
+      # Returns the string.
+      # @return [String]
+      #
+      def to_s
+        string
+      end
+
+      ## @private
+      def ==(other)
+        other.is_a?(WrappableString) ? other.string == string : false
+      end
+      alias eql? ==
+
+      ## @private
+      def hash
+        string.hash
+      end
+
+      ##
+      # Wraps the string to the given width.
+      #
+      # @param [Integer] width Width in characters.
+      # @return [Array<String>] Wrapped lines
+      #
+      def wrap(width)
+        lines = []
+        str = string.gsub(/\s/, " ").sub(/^\s+/, "")
+        until str.empty?
+          i = str.index(/\S(\s|$)/) + 1
+          loop do
+            next_i = str.index(/\S(\s|$)/, i)
+            break if next_i.nil? || next_i >= width
+            i = next_i + 1
+          end
+          lines << str[0, i]
+          str = str[i..-1].sub(/^\s+/, "")
+        end
+        lines
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +114,9 @@ files:
 - lib/toys/errors.rb
 - lib/toys/helpers.rb
 - lib/toys/helpers/exec.rb
-- lib/toys/helpers/file_utils.rb
+- lib/toys/helpers/fileutils.rb
+- lib/toys/helpers/highline.rb
+- lib/toys/helpers/spinner.rb
 - lib/toys/loader.rb
 - lib/toys/middleware.rb
 - lib/toys/middleware/add_verbosity_switches.rb
@@ -119,6 +135,7 @@ files:
 - lib/toys/tool.rb
 - lib/toys/utils/module_lookup.rb
 - lib/toys/utils/usage.rb
+- lib/toys/utils/wrappable_string.rb
 homepage: https://github.com/dazuma/toys
 licenses:
 - BSD-3-Clause