toys-core 0.11.5 → 0.13.0

data/lib/toys/mixin.rb

@@ -9,7 +9,7 @@ module Toys
   # class, so it has access to the same methods that can be called by the tool,
   # such as {Toys::Context#get}.
   #
-  # ## Usage
+  # ### Usage
   #
   # To create a mixin, define a module, and include this module. Then define
   # the methods you want to be available.
@@ -34,7 +34,7 @@ module Toys
   # methods specific to the mixin. Define the inclusion block by calling
   # {Toys::Mixin::ModuleMethods#on_include}.
   #
-  # ## Example
+  # ### Example
   #
   # This is an example that implements a simple counter. Whenever the counter
   # is incremented, a log message is emitted. The tool can also retrieve the
@@ -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.
     #
@@ -37,11 +20,11 @@ module Toys
     # @param display_name [String] A name to use for display (in help text and
     #     error reports). Defaults to the key in upper case.
     # @param desc [String,Array<String>,Toys::WrappableString] Short
-    #     description for the flag. See {Toys::DSL::Tool#desc} for a
+    #     description for the flag. See {Toys::ToolDefintion#desc} for a
     #     description of the allowed formats. Defaults to the empty string.
     # @param long_desc [Array<String,Array<String>,Toys::WrappableString>]
-    #     Long description for the flag. See {Toys::DSL::Tool#long_desc} for
-    #     a description of the allowed formats. (But note that this param
+    #     Long description for the flag. See {Toys::ToolDefintion#long_desc}
+    #     for a description of the allowed formats. (But note that this param
     #     takes an Array of description lines, rather than a series of
     #     arguments.) Defaults to the empty array.
     # @return [Toys::PositionalArg]
@@ -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