toys-core 0.3.5 → 0.3.6

data/lib/toys/utils/exec.rb

@@ -112,7 +112,7 @@ module Toys
       #
       # @param [Hash] opts New default options to set
       #
-      def config_defaults(opts = {})
+      def configure_defaults(opts = {})
         @default_opts.add(opts)
         self
       end

data/lib/toys/utils/help_text.rb

@@ -107,6 +107,8 @@ module Toys
       #     display all subcommands recursively. Defaults to false.
       # @param [String,nil] search An optional string to search for when
       #     listing subcommands. Defaults to `nil` which finds all subcommands.
+      # @param [Boolean] show_source_path If true, shows the source path
+      #     section. Defaults to false.
       # @param [Integer] indent Indent width. Default is {DEFAULT_INDENT}.
       # @param [Integer] indent2 Second indent width. Default is
       #     {DEFAULT_INDENT}.
@@ -116,12 +118,12 @@ module Toys
       #
       # @return [String] A usage string.
       #
-      def help_string(recursive: false, search: nil,
+      def help_string(recursive: false, search: nil, show_source_path: false,
                       indent: nil, indent2: nil, wrap_width: nil, styled: true)
         indent ||= DEFAULT_INDENT
         indent2 ||= DEFAULT_INDENT
         subtools = find_subtools(recursive, search)
-        assembler = HelpStringAssembler.new(@tool, @binary_name, subtools, search,
+        assembler = HelpStringAssembler.new(@tool, @binary_name, subtools, search, show_source_path,
                                             indent, indent2, wrap_width, styled)
         assembler.result
       end
@@ -199,9 +201,11 @@ module Toys
         end
 
         def add_flag(flag)
-          flags_str = (flag.single_flag_syntax + flag.double_flag_syntax)
-                      .map(&:str_without_value).join(", ")
-          flags_str << flag.value_delim << flag.value_label if flag.value_label
+          flags = flag.single_flag_syntax + flag.double_flag_syntax
+          last_index = flags.size - 1
+          flags_str = flags.each_with_index.map do |fs, i|
+            i == last_index ? fs.canonical_str : fs.str_without_value
+          end.join(", ")
           flags_str = "    #{flags_str}" if flag.single_flag_syntax.empty?
           add_right_column_desc(flags_str, wrap_desc(flag.desc))
         end
@@ -269,12 +273,13 @@ module Toys
 
       ## @private
       class HelpStringAssembler
-        def initialize(tool, binary_name, subtools, search_term,
+        def initialize(tool, binary_name, subtools, search_term, show_source_path,
                        indent, indent2, wrap_width, styled)
           @tool = tool
           @binary_name = binary_name
           @subtools = subtools
           @search_term = search_term
+          @show_source_path = show_source_path
           @indent = indent
           @indent2 = indent2
           @wrap_width = wrap_width
@@ -359,7 +364,7 @@ module Toys
         end
 
         def add_source_section
-          return unless @tool.definition_path
+          return unless @tool.definition_path && @show_source_path
           @lines << ""
           @lines << bold("SOURCE")
           @lines << indent_str("Defined in #{@tool.definition_path}")
@@ -387,15 +392,16 @@ module Toys
         end
 
         def flag_spec_string(flag)
-          single_flags = flag.single_flag_syntax.map do |fs|
+          flag.flag_syntax.map do |fs|
             str = bold(fs.str_without_value)
-            flag.value_label ? "#{str} #{underline(flag.value_label)}" : str
-          end
-          double_flags = flag.double_flag_syntax.map do |fs|
-            str = bold(fs.str_without_value)
-            flag.value_label ? "#{str}#{flag.value_delim}#{underline(flag.value_label)}" : str
-          end
-          (single_flags + double_flags).join(", ")
+            if fs.flag_type != :value
+              str
+            elsif fs.value_type == :optional
+              "#{str}#{fs.value_delim}[#{underline(fs.value_label)}]"
+            else
+              "#{str}#{fs.value_delim}#{underline(fs.value_label)}"
+            end
+          end.join(", ")
         end
 
         def add_positional_arguments_section

data/lib/toys/utils/line_output.rb

@@ -49,6 +49,7 @@ module Toys
           else
             styled ? true : false
           end
+        @buffer = ""
       end
 
       ##
@@ -61,7 +62,7 @@ module Toys
       # Whether output is styled
       # @return [Boolean]
       #
-      attr_reader :styled
+      attr_accessor :styled
 
       ##
       # If the sink is a Logger, the level to log, otherwise `nil`.
@@ -76,29 +77,45 @@ module Toys
       # @param [Symbol...] styles Styles to apply to the entire line.
       #
       def puts(str = "", *styles)
-        if styled
-          str = color(str, *styles) unless styles.empty?
-        else
-          str = ::HighLine.uncolor(str)
-        end
+        str = @buffer + apply_styles(str, styles)
+        @buffer = ""
         case sink
         when ::Logger
           sink.log(log_level, str)
         when ::IO
           sink.puts(str)
+          sink.flush
         end
         self
       end
 
       ##
-      # Apply the given styles to a string
+      # Write a newline and flush the current line.
+      #
+      def newline
+        puts
+      end
+
+      ##
+      # Buffer a partial line but do not write it out yet because the line
+      # may not yet be complete.
       #
-      # @param [String] str The string
-      # @param [Symbol...] styles Styles to apply to the string.
-      # @return [String] The string with styles applied.
+      # @param [String] str The line to write
+      # @param [Symbol...] styles Styles to apply to the partial line.
       #
-      def color(str, *styles)
-        ::HighLine.color(str, *styles)
+      def write(str = "", *styles)
+        @buffer << apply_styles(str, styles)
+        self
+      end
+
+      private
+
+      def apply_styles(str, styles)
+        if styled
+          styles.empty? ? str : ::HighLine.color(str, *styles)
+        else
+          ::HighLine.uncolor(str)
+        end
       end
     end
   end

data/lib/toys/utils/wrappable_string.rb

@@ -135,6 +135,29 @@ module Toys
         result = [] if result.all?(&:empty?)
         result
       end
+
+      ##
+      # Make the given object a WrappableString.
+      # If the object is already a WrappableString, return it. Otherwise,
+      # treat it as a string or an array of strings and wrap it in a
+      # WrappableString.
+      #
+      # @param [Toys::Utils::WrappableString,String,Array<String>] obj
+      # @return [Toys::Utils::WrappableString]
+      #
+      def self.make(obj)
+        obj.is_a?(Utils::WrappableString) ? obj : Utils::WrappableString.new(obj)
+      end
+
+      ##
+      # Make the given object an array of WrappableString.
+      #
+      # @param [Array<Toys::Utils::WrappableString,String,Array<String>>] objs
+      # @return [Array<Toys::Utils::WrappableString>]
+      #
+      def self.make_array(objs)
+        Array(objs).map { |obj| make(obj) }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -126,7 +126,7 @@ files:
 - lib/toys/middleware/handle_usage_errors.rb
 - lib/toys/middleware/set_default_descriptions.rb
 - lib/toys/middleware/show_help.rb
-- lib/toys/middleware/show_version.rb
+- lib/toys/middleware/show_root_version.rb
 - lib/toys/template.rb
 - lib/toys/templates.rb
 - lib/toys/templates/clean.rb
@@ -135,6 +135,9 @@ files:
 - lib/toys/templates/rubocop.rb
 - lib/toys/templates/yardoc.rb
 - lib/toys/tool.rb
+- lib/toys/tool/acceptor.rb
+- lib/toys/tool/arg_definition.rb
+- lib/toys/tool/flag_definition.rb
 - lib/toys/utils/exec.rb
 - lib/toys/utils/help_text.rb
 - lib/toys/utils/line_output.rb