toys-core 0.12.2 → 0.13.0

data/lib/toys/flag_group.rb

@@ -56,6 +56,7 @@ module Toys
       # Create a flag group.
       # This argument list is subject to change. Use {Toys::FlagGroup.create}
       # instead for a more stable interface.
+      #
       # @private
       #
       def initialize(name, desc, long_desc)
@@ -168,12 +169,16 @@ module Toys
         self
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def <<(flag)
         flags << flag
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def validation_errors(_seen)
         []
       end
@@ -183,7 +188,9 @@ module Toys
     # A FlagGroup containing all required flags
     #
     class Required < Base
-      ## @private
+      ##
+      # @private
+      #
       def validation_errors(seen)
         results = []
         flags.each do |flag|
@@ -206,7 +213,9 @@ module Toys
     # A FlagGroup in which exactly one flag must be set
     #
     class ExactlyOne < Base
-      ## @private
+      ##
+      # @private
+      #
       def validation_errors(seen)
         seen_names = []
         flags.each do |flag|
@@ -229,7 +238,9 @@ module Toys
     # A FlagGroup in which at most one flag must be set
     #
     class AtMostOne < Base
-      ## @private
+      ##
+      # @private
+      #
       def validation_errors(seen)
         seen_names = []
         flags.each do |flag|
@@ -249,7 +260,9 @@ module Toys
     # A FlagGroup in which at least one flag must be set
     #
     class AtLeastOne < Base
-      ## @private
+      ##
+      # @private
+      #
       def validation_errors(seen)
         flags.each do |flag|
           return [] if seen.include?(flag.key)

data/lib/toys/input_file.rb

@@ -5,12 +5,16 @@
 # is parsed, a module is created under this parent for that file's constants.
 #
 module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
-  ## @private
+  ##
+  # @private
+  #
   def self.__binding
     binding
   end
 
-  ## @private
+  ##
+  # @private
+  #
   def self.evaluate(tool_class, words, priority, remaining_words, source, loader)
     namespace = ::Module.new
     namespace.module_eval do
@@ -33,7 +37,9 @@ module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
     end
   end
 
-  ## @private
+  ##
+  # @private
+  #
   def self.build_eval_string(module_name, string)
     index = string.index(/^\s*[^#\s]/)
     return nil if index.nil?

data/lib/toys/loader.rb

@@ -8,9 +8,6 @@ module Toys
   # appropriate tool given a set of command line arguments.
   #
   class Loader
-    # @private
-    BASE_PRIORITY = -999_999
-
     ##
     # Create a Loader
     #
@@ -44,19 +41,17 @@ module Toys
     # @param template_lookup [Toys::ModuleLookup] A lookup for
     #     well-known template classes. Defaults to an empty lookup.
     #
-    def initialize(
-      index_file_name: nil,
-      preload_dir_name: nil,
-      preload_file_name: nil,
-      data_dir_name: nil,
-      lib_dir_name: nil,
-      middleware_stack: [],
-      extra_delimiters: "",
-      mixin_lookup: nil,
-      middleware_lookup: nil,
-      template_lookup: nil,
-      git_cache: nil
-    )
+    def initialize(index_file_name: nil,
+                   preload_dir_name: nil,
+                   preload_file_name: nil,
+                   data_dir_name: nil,
+                   lib_dir_name: nil,
+                   middleware_stack: [],
+                   extra_delimiters: "",
+                   mixin_lookup: nil,
+                   middleware_lookup: nil,
+                   template_lookup: nil,
+                   git_cache: nil)
       if index_file_name && ::File.extname(index_file_name) != ".rb"
         raise ::ArgumentError, "Illegal index file name #{index_file_name.inspect}"
       end
@@ -74,12 +69,12 @@ module Toys
       @tool_data = {}
       @roots_by_priority = {}
       @max_priority = @min_priority = 0
-      @stop_priority = BASE_PRIORITY
+      @stop_priority = -999_999
       @min_loaded_priority = 999_999
       @middleware_stack = Middleware.stack(middleware_stack)
       @delimiter_handler = DelimiterHandler.new(extra_delimiters)
       @git_cache = git_cache
-      get_tool([], BASE_PRIORITY)
+      get_tool([], -999_999)
     end
 
     ##
@@ -213,7 +208,7 @@ module Toys
       @mutex.synchronize do
         raise "Cannot add a git source after tool loading has started" if @loading_started
         priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
-        path = git_cache.find(git_remote, path: git_path, commit: git_commit, update: update)
+        path = git_cache.get(git_remote, path: git_path, commit: git_commit, update: update)
         source = SourceInfo.create_git_root(git_remote, git_path, git_commit, path, priority,
                                             context_directory: context_directory,
                                             data_dir_name: @data_dir_name,
@@ -453,7 +448,7 @@ module Toys
     #
     def load_git(parent_source, git_remote, git_path, git_commit, words, remaining_words, priority,
                  update: false)
-      path = git_cache.find(git_remote, path: git_path, commit: git_commit, update: update)
+      path = git_cache.get(git_remote, path: git_path, commit: git_commit, update: update)
       source = parent_source.git_child(git_remote, git_path, git_commit, path)
       @mutex.synchronize do
         load_validated_path(source, words, remaining_words, priority)
@@ -499,6 +494,120 @@ module Toys
       end
     end
 
+    ##
+    # Tool data
+    #
+    # @private
+    #
+    class ToolData
+      ##
+      # @private
+      #
+      def initialize(words)
+        @words = validate_words(words)
+        @definitions = {}
+        @top_priority = @active_priority = nil
+        @mutex = ::Monitor.new
+      end
+
+      ##
+      # @private
+      #
+      def cur_definition
+        @mutex.synchronize { active_definition || top_definition }
+      end
+
+      ##
+      # @private
+      #
+      def empty?
+        @definitions.empty?
+      end
+
+      ##
+      # @private
+      #
+      def get_tool(priority, loader, tool_class = nil)
+        @mutex.synchronize do
+          if @top_priority.nil? || @top_priority < priority
+            @top_priority = priority
+          end
+          if tool_class && @definitions.include?(priority)
+            raise ToolDefinitionError, "Tool already defined for #{@words.inspect}"
+          end
+          @definitions[priority] ||= loader.build_tool(@words, priority, tool_class)
+        end
+      end
+
+      ##
+      # @private
+      #
+      def activate_tool(priority, loader)
+        @mutex.synchronize do
+          return active_definition if @active_priority == priority
+          return nil if @active_priority && @active_priority > priority
+          @active_priority = priority
+          get_tool(priority, loader)
+        end
+      end
+
+      private
+
+      def validate_words(words)
+        words.each do |word|
+          if /[[:cntrl:] #"$&'()*;<>\[\\\]\^`{|}]/.match(word)
+            raise ToolDefinitionError, "Illegal characters in name #{word.inspect}"
+          end
+        end
+      end
+
+      def top_definition
+        @top_priority ? @definitions[@top_priority] : nil
+      end
+
+      def active_definition
+        @active_priority ? @definitions[@active_priority] : nil
+      end
+    end
+
+    ##
+    # An object that handles name delimiting.
+    #
+    # @private
+    #
+    class DelimiterHandler
+      ##
+      # @private
+      #
+      def initialize(extra_delimiters)
+        unless %r{^[[:space:]./:]*$}.match?(extra_delimiters)
+          raise ::ArgumentError, "Illegal delimiters in #{extra_delimiters.inspect}"
+        end
+        chars = ::Regexp.escape(extra_delimiters.chars.uniq.join)
+        @delimiters = ::Regexp.new("[[:space:]#{chars}]")
+      end
+
+      ##
+      # @private
+      #
+      def split_path(str)
+        str.split(@delimiters)
+      end
+
+      ##
+      # @private
+      #
+      def find_orig_prefix(args)
+        first_split = (args.first || "").split(@delimiters)
+        if first_split.size > 1
+          args = first_split + args.slice(1..-1)
+          return [first_split, args]
+        end
+        orig_prefix = args.take_while { |arg| !arg.start_with?("-") }
+        [orig_prefix, args]
+      end
+    end
+
     private
 
     def all_cur_definitions
@@ -648,100 +757,5 @@ module Toys
         index += 1
       end
     end
-
-    ##
-    # Tool data
-    #
-    # @private
-    #
-    class ToolData
-      # @private
-      def initialize(words)
-        @words = validate_words(words)
-        @definitions = {}
-        @top_priority = @active_priority = nil
-        @mutex = ::Monitor.new
-      end
-
-      # @private
-      def cur_definition
-        @mutex.synchronize { active_definition || top_definition }
-      end
-
-      # @private
-      def empty?
-        @definitions.empty?
-      end
-
-      # @private
-      def get_tool(priority, loader, tool_class = nil)
-        @mutex.synchronize do
-          if @top_priority.nil? || @top_priority < priority
-            @top_priority = priority
-          end
-          if tool_class && @definitions.include?(priority)
-            raise ToolDefinitionError, "Tool already defined for #{@words.inspect}"
-          end
-          @definitions[priority] ||= loader.build_tool(@words, priority, tool_class)
-        end
-      end
-
-      # @private
-      def activate_tool(priority, loader)
-        @mutex.synchronize do
-          return active_definition if @active_priority == priority
-          return nil if @active_priority && @active_priority > priority
-          @active_priority = priority
-          get_tool(priority, loader)
-        end
-      end
-
-      private
-
-      def validate_words(words)
-        words.each do |word|
-          if /[[:cntrl:] #"$&'()*;<>\[\\\]\^`{|}]/.match(word)
-            raise ToolDefinitionError, "Illegal characters in name #{word.inspect}"
-          end
-        end
-      end
-
-      def top_definition
-        @top_priority ? @definitions[@top_priority] : nil
-      end
-
-      def active_definition
-        @active_priority ? @definitions[@active_priority] : nil
-      end
-    end
-
-    ##
-    # An object that handles name delimiting.
-    #
-    # @private
-    #
-    class DelimiterHandler
-      def initialize(extra_delimiters)
-        unless %r{^[[:space:]./:]*$}.match?(extra_delimiters)
-          raise ::ArgumentError, "Illegal delimiters in #{extra_delimiters.inspect}"
-        end
-        chars = ::Regexp.escape(extra_delimiters.chars.uniq.join)
-        @delimiters = ::Regexp.new("[[:space:]#{chars}]")
-      end
-
-      def split_path(str)
-        str.split(@delimiters)
-      end
-
-      def find_orig_prefix(args)
-        first_split = (args.first || "").split(@delimiters)
-        if first_split.size > 1
-          args = first_split + args.slice(1..-1)
-          return [first_split, args]
-        end
-        orig_prefix = args.take_while { |arg| !arg.start_with?("-") }
-        [orig_prefix, args]
-      end
-    end
   end
 end

data/lib/toys/middleware.rb

@@ -140,7 +140,9 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def spec_from_array(array)
         middleware = array.first
         if !middleware.is_a?(::String) && !middleware.is_a?(::Symbol) && !middleware.is_a?(::Class)
@@ -238,16 +240,12 @@ module Toys
       #
       attr_reader :block
 
-      ## @private
-      def initialize(object, name, args, kwargs, block)
-        @object = object
-        @name = name
-        @args = args
-        @kwargs = kwargs
-        @block = block
-      end
-
-      ## @private
+      ##
+      # Equality check
+      #
+      # @param other [Object]
+      # @return [Boolean]
+      #
       def ==(other)
         other.is_a?(Spec) &&
           object.eql?(other.object) &&
@@ -258,10 +256,25 @@ module Toys
       end
       alias eql? ==
 
-      ## @private
+      ##
+      # Return the hash code
+      #
+      # @return [Integer]
+      #
       def hash
         [object, name, args, kwargs, block].hash
       end
+
+      ##
+      # @private
+      #
+      def initialize(object, name, args, kwargs, block)
+        @object = object
+        @name = name
+        @args = args
+        @kwargs = kwargs
+        @block = block
+      end
     end
 
     ##
@@ -319,14 +332,12 @@ module Toys
         (@pre_specs + @default_specs + @post_specs).map { |spec| spec.build(middleware_lookup) }
       end
 
-      ## @private
-      def initialize(default_specs: nil, pre_specs: nil, post_specs: nil)
-        @pre_specs = pre_specs || []
-        @post_specs = post_specs || []
-        @default_specs = default_specs || []
-      end
-
-      ## @private
+      ##
+      # Equality check
+      #
+      # @param other [Object]
+      # @return [Boolean]
+      #
       def ==(other)
         other.is_a?(Stack) &&
           pre_specs.eql?(other.pre_specs) &&
@@ -335,10 +346,23 @@ module Toys
       end
       alias eql? ==
 
-      ## @private
+      ##
+      # Return the hash code
+      #
+      # @return [Integer]
+      #
       def hash
         [@pre_specs, @default_specs, @post_specs].hash
       end
+
+      ##
+      # @private
+      #
+      def initialize(default_specs: nil, pre_specs: nil, post_specs: nil)
+        @pre_specs = pre_specs || []
+        @post_specs = post_specs || []
+        @default_specs = default_specs || []
+      end
     end
   end
 end

data/lib/toys/mixin.rb

@@ -92,12 +92,6 @@ module Toys
       mixin_mod
     end
 
-    ## @private
-    def self.included(mod)
-      return if mod.respond_to?(:on_initialize)
-      mod.extend(ModuleMethods)
-    end
-
     ##
     # Methods that will be added to a mixin module object.
     #
@@ -148,5 +142,13 @@ module Toys
       #
       attr_accessor :inclusion
     end
+
+    ##
+    # @private
+    #
+    def self.included(mod)
+      return if mod.respond_to?(:on_initialize)
+      mod.extend(ModuleMethods)
+    end
   end
 end

data/lib/toys/positional_arg.rb

@@ -5,23 +5,6 @@ module Toys
   # Representation of a formal positional argument
   #
   class PositionalArg
-    ##
-    # Create a PositionalArg definition.
-    # This argument list is subject to change. Use {Toys::PositionalArg.create}
-    # instead for a more stable interface.
-    # @private
-    #
-    def initialize(key, type, acceptor, default, completion, desc, long_desc, display_name)
-      @key = key
-      @type = type
-      @acceptor = Acceptor.create(acceptor)
-      @default = default
-      @completion = Completion.create(completion, **{})
-      @desc = WrappableString.make(desc)
-      @long_desc = WrappableString.make_array(long_desc)
-      @display_name = display_name || key.to_s.tr("-", "_").gsub(/\W/, "").upcase
-    end
-
     ##
     # Create a PositionalArg definition.
     #
@@ -159,5 +142,23 @@ module Toys
       @long_desc.concat(WrappableString.make_array(long_desc))
       self
     end
+
+    ##
+    # Create a PositionalArg definition.
+    # This argument list is subject to change. Use {Toys::PositionalArg.create}
+    # instead for a more stable interface.
+    #
+    # @private
+    #
+    def initialize(key, type, acceptor, default, completion, desc, long_desc, display_name)
+      @key = key
+      @type = type
+      @acceptor = Acceptor.create(acceptor)
+      @default = default
+      @completion = Completion.create(completion, **{})
+      @desc = WrappableString.make(desc)
+      @long_desc = WrappableString.make_array(long_desc)
+      @display_name = display_name || key.to_s.tr("-", "_").gsub(/\W/, "").upcase
+    end
   end
 end