toys-core 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc309cbbf273bc8b6bc6785be154812412177cef293f809536509365fc9596d0
-  data.tar.gz: ff8eeab3686c33c1032ea9ce473701f6214d4a319ed1a0c724699537b8933be4
+  metadata.gz: 55fb96e74b22786912b754dbd969e5ead0825afe8ac8182f3a0b06520a46b867
+  data.tar.gz: e85f258b34362a5ab66f47115805898807432560680bd6bde074b25979caa9cd
 SHA512:
-  metadata.gz: 590d56a355b406eb998eec466fb73a34e2fb09301e7387d0fd197d599bfb29a58496220a5a8bba1a75300c05d136f9dc89409debe9e401f4f01e81c590fae5af
-  data.tar.gz: 6fade3e0622fb8f5877a9b759fda60132a2cd6f70c9d7a268e3167e38035319e58b064b5cb511f1d35c09d62bd64a6aaa140014b2077c59dfd00893083716cea
+  metadata.gz: 408586c952bc613bed26f549883e39fecc49cca4c298bdd22b40fe44a365c2fe23bae0016622a54ddfeb69cf7b72357310183fc8bd56e4614e476480de9527a6
+  data.tar.gz: 0afaf0c2a723277074e0b772b8166db55b5bc2d8f86150bd2a9367f5254ee770f9c82d09ef98d38c444b269ade5a59857b145f086609efb5bdc4176457ccc5c7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+### 0.4.2 / 2018-07-08
+
+* FIXED: Raise an error rather than cause unexpected behavior if a mixin is included twice.
+* IMPROVED: The `include?` method extended to support mixin names in a tool dsl.
+
 ### 0.4.1 / 2018-07-03
 
 * FIXED: Terminal#confirm uppercased "N" for the wrong default.

data/lib/toys/core_version.rb

@@ -34,5 +34,5 @@ module Toys
   # Current version of Toys core
   # @return [String]
   #
-  CORE_VERSION = "0.4.1"
+  CORE_VERSION = "0.4.2"
 end

data/lib/toys/dsl/arg.rb

@@ -51,7 +51,9 @@ module Toys
 
       ##
       # Set the OptionParser acceptor.
+      #
       # @param [Object] accept
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def accept(accept)
         @accept = accept
@@ -60,7 +62,9 @@ module Toys
 
       ##
       # Set the default value.
+      #
       # @param [Object] default
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def default(default)
         @default = default
@@ -69,7 +73,9 @@ module Toys
 
       ##
       # Set the name of this arg as it appears in help screens.
+      #
       # @param [String] display_name
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def display_name(display_name)
         @display_name = display_name
@@ -81,6 +87,7 @@ module Toys
       # formats.
       #
       # @param [String,Array<String>,Toys::Utils::WrappableString] desc
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def desc(desc)
         @desc = desc
@@ -93,6 +100,7 @@ module Toys
       # allowed formats.
       #
       # @param [String,Array<String>,Toys::Utils::WrappableString...] long_desc
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def long_desc(*long_desc)
         @long_desc += long_desc

data/lib/toys/dsl/flag.rb

@@ -53,7 +53,9 @@ module Toys
       ##
       # Add flags in OptionParser format. This may be called multiple times,
       # and the results are cumulative.
+      #
       # @param [String...] flags
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def flags(*flags)
         @flags += flags
@@ -62,7 +64,9 @@ module Toys
 
       ##
       # Set the OptionParser acceptor.
+      #
       # @param [Object] accept
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def accept(accept)
         @accept = accept
@@ -71,7 +75,9 @@ module Toys
 
       ##
       # Set the default value.
+      #
       # @param [Object] default
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def default(default)
         @default = default
@@ -86,6 +92,7 @@ module Toys
       # responding to the `call` method) or you may pass a block.
       #
       # @param [Proc] handler
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def handler(handler = nil, &block)
         @handler = handler || block
@@ -97,6 +104,7 @@ module Toys
       # already in use or marked as disabled.
       #
       # @param [Boolean] setting
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def report_collisions(setting)
         @report_collisions = setting
@@ -108,6 +116,7 @@ module Toys
       # formats.
       #
       # @param [String,Array<String>,Toys::Utils::WrappableString] desc
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def desc(desc)
         @desc = desc
@@ -120,6 +129,7 @@ module Toys
       # allowed formats.
       #
       # @param [String,Array<String>,Toys::Utils::WrappableString...] long_desc
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def long_desc(*long_desc)
         @long_desc += long_desc

data/lib/toys/dsl/tool.rb

@@ -108,6 +108,7 @@ module Toys
       # @param [String] name The acceptor name.
       # @param [Regexp,Array,nil] validator The validator.
       # @param [Proc,nil] converter The validator.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def acceptor(name, validator = nil, converter = nil, &block)
         cur_tool = DSL::Tool.current_tool(self, false)
@@ -134,6 +135,7 @@ module Toys
       # You should pass a block and define methods in that block.
       #
       # @param [String] name Name of the mixin
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def mixin(name, &block)
         cur_tool = DSL::Tool.current_tool(self, false)
@@ -158,6 +160,7 @@ module Toys
       # define how to expand the template.
       #
       # @param [String] name Name of the template
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def template(name, &block)
         cur_tool = DSL::Tool.current_tool(self, false)
@@ -178,6 +181,7 @@ module Toys
       # old definition is discarded and replaced with the new definition.
       #
       # @param [String] word The name of the subtool
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def tool(word, &block)
         word = word.to_s
@@ -196,6 +200,7 @@ module Toys
       #
       # @param [String] word The name of the alias
       # @param [String] target The target of the alias
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def alias_tool(word, target)
         @__loader.make_alias(@__words + [word.to_s], @__words + [target.to_s], @__priority)
@@ -203,9 +208,11 @@ module Toys
       end
 
       ##
-      # Include another config file or directory at the current location.
+      # Load another config file or directory, as if its contents were inserted
+      # at the current location.
       #
-      # @param [String] path The file or directory to include.
+      # @param [String] path The file or directory to load.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def load(path)
         @__loader.load_path(path, @__words, @__remaining_words, @__priority)
@@ -221,6 +228,7 @@ module Toys
       # @param [Class,String,Symbol] template_class The template, either as a
       #     class or a well-known name.
       # @param [Object...] args Template arguments
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def expand(template_class, *args)
         cur_tool = DSL::Tool.current_tool(self, true)
@@ -268,6 +276,7 @@ module Toys
       #     desc ["This sentence will not be wrapped."]
       #
       # @param [Toys::Utils::WrappableString,String,Array<String>] str
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def desc(str)
         cur_tool = DSL::Tool.current_tool(self, true)
@@ -294,6 +303,7 @@ module Toys
       #               ["This line will not be wrapped."]
       #
       # @param [Toys::Utils::WrappableString,String,Array<String>...] strs
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def long_desc(*strs)
         DSL::Tool.current_tool(self, true)&.append_long_desc(strs)
@@ -342,6 +352,7 @@ module Toys
       #     arguments.) Defaults to the empty array.
       # @yieldparam flag_dsl [Toys::DSL::Flag] An object that lets you
       #     configure this flag in a block.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def flag(key, *flags,
                accept: nil, default: nil, handler: nil,
@@ -390,6 +401,7 @@ module Toys
       #     arguments.) Defaults to the empty array.
       # @yieldparam arg_dsl [Toys::DSL::Arg] An object that lets you configure
       #     this argument in a block.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def required_arg(key,
                        accept: nil, display_name: nil,
@@ -441,6 +453,7 @@ module Toys
       #     arguments.) Defaults to the empty array.
       # @yieldparam arg_dsl [Toys::DSL::Arg] An object that lets you configure
       #     this argument in a block.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def optional_arg(key,
                        default: nil, accept: nil, display_name: nil,
@@ -491,6 +504,7 @@ module Toys
       #     arguments.) Defaults to the empty array.
       # @yieldparam arg_dsl [Toys::DSL::Arg] An object that lets you configure
       #     this argument in a block.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def remaining_args(key,
                          default: [], accept: nil, display_name: nil,
@@ -517,6 +531,7 @@ module Toys
       # @param [String,Symbol] key The key to use to retrieve the value from
       #     the execution context.
       # @param [Object] value The value to set.
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def static(key, value = nil)
         cur_tool = DSL::Tool.current_tool(self, true)
@@ -541,6 +556,8 @@ module Toys
       # This directive is mutually exclusive with any of the directives that
       # declare arguments or flags.
       #
+      # @return [Toys::DSL::Tool] self, for chaining.
+      #
       def disable_argument_parsing
         DSL::Tool.current_tool(self, true)&.disable_argument_parsing
         self
@@ -552,6 +569,7 @@ module Toys
       # defining a particular flag.
       #
       # @param [String...] flags The flags to disable
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def disable_flag(*flags)
         DSL::Tool.current_tool(self, true)&.disable_flag(*flags)
@@ -559,8 +577,12 @@ module Toys
       end
 
       ##
-      # Specify how to run this tool. You can do this by providing a block to
-      # this directive, or by defining the `run` method in the tool.
+      # Specify how to run this tool. Typically you do this by defining a
+      # method namd `run`. Alternatively, you can pass a block to this method.
+      # You may want to do this if your method needs access to local variables
+      # in the lexical scope.
+      #
+      # @return [Toys::DSL::Tool] self, for chaining.
       #
       def to_run(&block)
         define_method(:run, &block)
@@ -581,14 +603,9 @@ module Toys
       def include(mod, *args)
         cur_tool = DSL::Tool.current_tool(self, true)
         return if cur_tool.nil?
-        name = mod.to_s
-        if mod.is_a?(::String)
-          mod = cur_tool.resolve_mixin(mod)
-        elsif mod.is_a?(::Symbol)
-          mod = @__loader.resolve_standard_mixin(name)
-        end
-        if mod.nil?
-          raise ToolDefinitionError, "Module not found: #{name.inspect}"
+        mod = DSL::Tool.resolve_mixin(mod, cur_tool, @__loader)
+        if included_modules.include?(mod)
+          raise ToolDefinitionError, "Mixin already included: #{mod.name}"
         end
         if mod.respond_to?(:initialization_callback) && mod.initialization_callback
           cur_tool.add_initializer(mod.initialization_callback, *args)
@@ -599,6 +616,23 @@ module Toys
         super(mod)
       end
 
+      ##
+      # Determine if the given module/mixin has already been included.
+      #
+      # You may provide either a module, the string name of a mixin that you
+      # have defined in this tool or one of its ancestors, or the symbol name
+      # of a well-known mixin.
+      #
+      # @param [Module,Symbol,String] mod Module or module name.
+      # @return [Boolean,nil] A boolean value, or `nil` if the current tool
+      #     is not active.
+      #
+      def include?(mod)
+        cur_tool = DSL::Tool.current_tool(self, false)
+        return if cur_tool.nil?
+        super(DSL::Tool.resolve_mixin(mod, cur_tool, @__loader))
+      end
+
       ## @private
       def self.new_class(words, priority, loader)
         tool_class = ::Class.new(::Toys::Tool)
@@ -657,6 +691,20 @@ module Toys
           end
         end
       end
+
+      ## @private
+      def self.resolve_mixin(mod, cur_tool, loader)
+        name = mod.to_s
+        if mod.is_a?(::String)
+          mod = cur_tool.resolve_mixin(mod)
+        elsif mod.is_a?(::Symbol)
+          mod = loader.resolve_standard_mixin(name)
+        end
+        unless mod.is_a?(::Module)
+          raise ToolDefinitionError, "Module not found: #{name.inspect}"
+        end
+        mod
+      end
     end
   end
 end

data/lib/toys/standard_mixins/terminal.rb

@@ -93,7 +93,7 @@ module Toys
       ##
       # @see Toys::Utils::Terminal#confirm
       #
-      def confirm(prompt = "Proceed?", default: false)
+      def confirm(prompt = "Proceed?", default: nil)
         terminal.confirm(prompt, default: default)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline