toys-core 0.12.2 → 0.13.0

data/lib/toys/utils/help_text.rb

@@ -200,8 +200,13 @@ module Toys
               .map { |source, subtools| [source&.source_name || "unknown source", subtools] }
       end
 
-      ## @private
+      ##
+      # @private
+      #
       class UsageStringAssembler
+        ##
+        # @private
+        #
         def initialize(tool, executable_name, subtools, separate_sources,
                        indent, left_column_width, wrap_width)
           @tool = tool
@@ -216,6 +221,9 @@ module Toys
           assemble
         end
 
+        ##
+        # @private
+        #
         attr_reader :result
 
         private
@@ -330,8 +338,13 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       class HelpStringAssembler
+        ##
+        # @private
+        #
         def initialize(tool, executable_name, delegates, subtools, search_term,
                        show_source_path, separate_sources, indent, indent2, wrap_width, styled)
           require "toys/utils/terminal"
@@ -349,6 +362,9 @@ module Toys
           assemble
         end
 
+        ##
+        # @private
+        #
         attr_reader :result
 
         private
@@ -638,8 +654,13 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       class ListStringAssembler
+        ##
+        # @private
+        #
         def initialize(tool, subtools, recursive, search_term, separate_sources,
                        indent, wrap_width, styled)
           require "toys/utils/terminal"
@@ -653,6 +674,9 @@ module Toys
           assemble(styled)
         end
 
+        ##
+        # @private
+        #
         attr_reader :result
 
         private

data/lib/toys/utils/terminal.rb

@@ -120,7 +120,7 @@ module Toys
         @output = output
         @styled =
           if styled.nil?
-            output.respond_to?(:tty?) && output.tty?
+            output.respond_to?(:tty?) && output.tty? && !::ENV["NO_COLOR"]
           else
             styled ? true : false
           end
@@ -431,8 +431,13 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       class SpinDriver
+        ##
+        # @private
+        #
         def initialize(terminal, frames, style, frame_length)
           @mutex = ::Monitor.new
           @terminal = terminal
@@ -446,6 +451,9 @@ module Toys
           @thread = @terminal.output.tty? ? start_thread : nil
         end
 
+        ##
+        # @private
+        #
         def stop
           @mutex.synchronize do
             @stopping = true

data/lib/toys/wrappable_string.rb

@@ -50,14 +50,21 @@ module Toys
     end
     alias to_s string
 
-    ## @private
+    ##
+    # Tests two wrappable strings for equality
+    # @param other [Object]
+    # @return [Boolean]
+    #
     def ==(other)
       return false unless other.is_a?(WrappableString)
       other.fragments == fragments
     end
     alias eql? ==
 
-    ## @private
+    ##
+    # Returns a hash code for this object
+    # @return [Integer]
+    #
     def hash
       fragments.hash
     end

data/lib/toys-core.rb

@@ -17,16 +17,21 @@ module Toys
   # Namespace for DSL classes. These classes provide the directives that can be
   # used in configuration files. Most are defined in {Toys::DSL::Tool}.
   #
-  module DSL; end
+  module DSL
+  end
 
   ##
   # Namespace for standard middleware classes.
   #
   module StandardMiddleware
-    ## @private
+    ##
+    # @private
+    #
     COMMON_FLAG_GROUP = :__common
 
-    ## @private
+    ##
+    # @private
+    #
     def self.append_common_flag_group(tool)
       tool.add_flag_group(type: :optional, name: COMMON_FLAG_GROUP,
                           desc: "Common Flags", report_collisions: false)
@@ -37,7 +42,8 @@ module Toys
   ##
   # Namespace for standard mixin classes.
   #
-  module StandardMixins; end
+  module StandardMixins
+  end
 
   ##
   # Namespace for common utility classes.
@@ -46,7 +52,8 @@ module Toys
   # For example, before using {Toys::Utils::Exec}, you must
   # `require "toys/utils/exec"`.
   #
-  module Utils; end
+  module Utils
+  end
 
   class << self
     ##
@@ -59,7 +66,9 @@ module Toys
     attr_accessor :executable_path
   end
 
+  ##
   # @private
+  #
   CORE_LIB_PATH = __dir__
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies: []
 description: Toys-Core is the command line tool framework underlying Toys. It can
   be used to create command line executables using the Toys DSL and classes.
@@ -76,10 +76,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.12.2/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.13.0/file.CHANGELOG.html
   source_code_uri: https://github.com/dazuma/toys/tree/main/toys-core
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.12.2
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.13.0
 post_install_message: 
 rdoc_options: []
 require_paths: