toys 0.9.4 → 0.10.0

data/lib/toys.rb

@@ -1,25 +1,24 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
+require "toys/version"
+
+# Add toys-core to the load path. The Toys debug scripts will set this
+# environment variable explicitly, but in production, we get it from rubygems.
+# We prepend to $LOAD_PATH directly rather than calling Kernel.gem, so that we
+# don't get clobbered in case someone sets up bundler later.
+::ENV["TOYS_CORE_LIB_PATH"] ||= begin
+  path = ::File.expand_path("../../toys-core-#{::Toys::VERSION}/lib", __dir__)
+  unless path && ::File.directory?(path)
+    require "rubygems"
+    dep = ::Gem::Dependency.new("toys-core", "= #{::Toys::VERSION}")
+    path = dep.to_spec.full_require_paths.first
+  end
+  abort "Unable to find toys-core gem!" unless path && ::File.directory?(path)
+  path
+end
+$LOAD_PATH.unshift(::ENV["TOYS_CORE_LIB_PATH"])
+
+require "toys-core"
 
 ##
 # Toys is a configurable command line tool. Write commands in config files
@@ -45,17 +44,6 @@ module Toys
   module Templates; end
 end
 
-require "toys/version"
-
-# Add toys-core to the load path. The Toys debug scripts will set this
-# environment variable explicitly, but in production, we get it from rubygems.
-# We prepend to $LOAD_PATH directly rather than calling Kernel.gem, so that we
-# don't get clobbered in case someone sets up bundler later.
-::ENV["TOYS_CORE_LIB_PATH"] ||= begin
-  dep = Gem::Dependency.new("toys-core", "= #{::Toys::VERSION}")
-  dep.to_spec.full_require_paths.first
-end
-$LOAD_PATH.unshift(::ENV["TOYS_CORE_LIB_PATH"])
+::Toys.executable_path = ::Toys::EXECUTABLE_PATH
 
-require "toys-core"
 require "toys/standard_cli"

data/lib/toys/standard_cli.rb

@@ -1,28 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
-require "logger"
-
 module Toys
   ##
   # Subclass of `Toys::CLI` configured for the behavior of the standard Toys

data/lib/toys/templates/clean.rb

@@ -1,26 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
 module Toys
   module Templates
     ##
@@ -43,13 +22,36 @@ module Toys
       # @param paths [Array<String>] An array of glob patterns indicating what
       #     to clean.
       #
-      def initialize(name: DEFAULT_TOOL_NAME, paths: [])
+      def initialize(name: nil, paths: [])
         @name = name
         @paths = paths
       end
 
-      attr_accessor :name
-      attr_accessor :paths
+      ##
+      # Name of the tool to create.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :name
+
+      ##
+      # An array of glob patterns indicating what to clean.
+      #
+      # @param value [Array<String>]
+      # @return [Array<String>]
+      #
+      attr_writer :paths
+
+      # @private
+      def paths
+        Array(@paths)
+      end
+
+      # @private
+      def name
+        @name || DEFAULT_TOOL_NAME
+      end
 
       on_expand do |template|
         tool(template.name) do
@@ -60,8 +62,7 @@ module Toys
           to_run do
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               files = []
-              patterns = Array(template.paths)
-              patterns.each do |pattern|
+              template.paths.each do |pattern|
                 files.concat(::Dir.glob(pattern))
               end
               files.uniq.each do |file|

data/lib/toys/templates/gem_build.rb

@@ -1,26 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
 module Toys
   module Templates
     ##
@@ -42,16 +21,23 @@ module Toys
       #
       DEFAULT_OUTPUT_FLAGS = ["-o", "--output"].freeze
 
+      ##
+      # Default remote for pushing tags.
+      # @return [String]
+      #
+      DEFAULT_PUSH_REMOTE = "origin"
+
       ##
       # Create the template settings for the GemBuild template.
       #
       # @param name [String] Name of the tool to create. Defaults to
       #     {DEFAULT_TOOL_NAME}.
       # @param gem_name [String] Name of the gem to build. If not provided,
-      #     defaults to the first gemspec file it finds.
+      #     searches the context and current directories and uses the first
+      #     gemspec file it finds.
       # @param output [String] Path to the gem package to generate. Optional.
-      #     If not provided, generates a default file name based on the gem
-      #     name and version, under the "pkg" directory.
+      #     If not provided, defaults to a file name based on the gem name and
+      #     version, under "pkg" in the current directory.
       # @param output_flags [Array<String>,true] Provide flags on the tool that
       #     set the output path. Optional. If not provided, no flags are
       #     created. You may set this to an array of flags (e.g. `["-o"]`) or
@@ -64,7 +50,7 @@ module Toys
       #     a string. Otherwise, if the value is simply `true`, the "origin"
       #     remote is used by default.
       #
-      def initialize(name: DEFAULT_TOOL_NAME,
+      def initialize(name: nil,
                      gem_name: nil,
                      output: nil,
                      output_flags: nil,
@@ -75,50 +61,138 @@ module Toys
         @name = name
         @gem_name = gem_name
         @output = output
-        @output_flags = output_flags == true ? DEFAULT_OUTPUT_FLAGS : output_flags
+        @output_flags = output_flags
         @push_gem = push_gem
         @install_gem = install_gem
         @tag = tag
         @push_tag = push_tag
       end
 
-      attr_accessor :name
-      attr_accessor :gem_name
-      attr_accessor :output
-      attr_accessor :output_flags
-      attr_accessor :push_gem
-      attr_accessor :install_gem
-      attr_accessor :tag
-      attr_accessor :push_tag
+      ##
+      # Name of the tool to create.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :name
 
-      on_expand do |template|
-        unless template.gem_name
-          candidates = ::Dir.chdir(context_directory || ::Dir.getwd) do
-            ::Dir.glob("*.gemspec")
-          end
-          if candidates.empty?
-            raise ToolDefinitionError, "Could not find a gemspec"
-          end
-          template.gem_name = candidates.first.sub(/\.gemspec$/, "")
+      ##
+      # Name of the gem to build. If `nil`, searches the context and current
+      # directories and uses the first gemspec file it finds.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :gem_name
+
+      ##
+      # Path to the gem package to generate. If `nil`, defaults to a file name
+      # based on the gem name and version, under "pkg" in the current directory.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :output
+
+      ##
+      # Flags that set the output path on the generated tool. If `nil`, no
+      # flags are generated. If set to `true`, {DEFAULT_OUTPUT_FLAGS} is used.
+      #
+      # @param value [Array<String>,true,nil]
+      # @return [Array<String>,true,nil]
+      #
+      attr_writer :output_flags
+
+      ##
+      # Whether the tool should push the gem to Rubygems.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :push_gem
+
+      ##
+      # Whether the tool should install the built gen locally.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :install_gem
+
+      ##
+      # Whether to tag the git repo with the gem version.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :tag
+
+      ##
+      # Whether to push the new tag to a git remote. This may be set to the
+      # name of the remote as a string, to `true` to use {DEFAULT_PUSH_REMOTE}
+      # by default, or to `false` to disable pushing.
+      #
+      # @param value [Boolean,String]
+      # @return [Boolean,String]
+      #
+      attr_writer :push_tag
+
+      # @private
+      attr_reader :output
+      # @private
+      attr_reader :push_gem
+      # @private
+      attr_reader :install_gem
+      # @private
+      attr_reader :tag
+
+      # @private
+      def name
+        @name || DEFAULT_TOOL_NAME
+      end
+
+      # @private
+      def gem_name
+        return @gem_name if @gem_name
+        candidates = ::Dir.glob("*.gemspec")
+        if candidates.empty?
+          raise ToolDefinitionError, "Could not find a gemspec"
         end
-        task_names = []
-        task_names << "Install" if template.install_gem
-        task_names << "Release" if template.push_gem
-        task_names = task_names.empty? ? "Build" : task_names.join(" and ")
+        candidates.first.sub(/\.gemspec$/, "")
+      end
+
+      # @private
+      def output_flags
+        @output_flags == true ? DEFAULT_OUTPUT_FLAGS : Array(@output_flags)
+      end
 
+      # @private
+      def push_tag
+        @push_tag == true ? DEFAULT_PUSH_REMOTE : @push_tag
+      end
+
+      # @private
+      def task_names
+        names = []
+        names << "Install" if @install_gem
+        names << "Release" if @push_gem
+        names.empty? ? "Build" : names.join(" and ")
+      end
+
+      on_expand do |template|
         tool(template.name) do
-          desc "#{task_names} the gem: #{template.gem_name}"
+          desc "#{template.task_names} the gem: #{template.gem_name}"
 
           flag :yes, "-y", "--yes", desc: "Do not ask for interactive confirmation"
-          if template.output_flags
+          if template.output_flags.empty?
+            static :output, template.output
+          else
             flag :output do
-              flags(Array(template.output_flags).map { |f| "#{f} VAL" })
+              flags(template.output_flags.map { |f| "#{f} VAL" })
               desc "output gem with the given filename"
               default template.output
               complete_values :file_system
             end
-          else
-            static :output, template.output
           end
 
           include :exec, exit_on_nonzero_status: true
@@ -126,6 +200,7 @@ module Toys
           include :terminal
 
           to_run do
+            require "rubygems"
             require "rubygems/package"
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               gem_name = template.gem_name
@@ -152,7 +227,6 @@ module Toys
                 if template.tag
                   exec(["git", "tag", "v#{version}"])
                   if template.push_tag
-                    template.push_tag = "origin" if template.push_tag == true
                     exec(["git", "push", template.push_tag, "v#{version}"])
                   end
                 end

data/lib/toys/templates/minitest.rb

@@ -1,26 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
 module Toys
   module Templates
     ##
@@ -33,7 +12,7 @@ module Toys
       # Default version requirements for the minitest gem.
       # @return [Array<String>]
       #
-      DEFAULT_GEM_VERSION_REQUIREMENTS = "~> 5.0"
+      DEFAULT_GEM_VERSION_REQUIREMENTS = ["~> 5.0"].freeze
 
       ##
       # Default tool name
@@ -59,13 +38,23 @@ module Toys
       # @param name [String] Name of the tool to create. Defaults to
       #     {DEFAULT_TOOL_NAME}.
       # @param gem_version [String,Array<String>] Version requirements for
-      #     the minitest gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
+      #     the minitest gem. Optional. If not provided, uses the bundled
+      #     version if bundler is enabled, or defaults to
+      #     {DEFAULT_GEM_VERSION_REQUIREMENTS} if bundler is not enabled.
       # @param libs [Array<String>] An array of library paths to add to the
       #     ruby require path. Defaults to {DEFAULT_LIBS}.
       # @param files [Array<String>] An array of globs indicating the test
       #     files to load. Defaults to {DEFAULT_FILES}.
+      # @param seed [Integer] The random seed, if any. Optional.
+      # @param verbose [Boolean] Whether to produce verbose output. Defaults to
+      #     false.
       # @param warnings [Boolean] If true, runs tests with Ruby warnings.
       #     Defaults to true.
+      # @param bundler [Boolean,Hash] If `false` (the default), bundler is not
+      #     enabled for this tool. If `true` or a Hash of options, bundler is
+      #     enabled. See the documentation for the
+      #     [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      #     for information on available options.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -73,23 +62,143 @@ module Toys
                      files: nil,
                      seed: nil,
                      verbose: false,
-                     warnings: true)
-        @name = name || DEFAULT_TOOL_NAME
-        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
-        @libs = libs || DEFAULT_LIBS
-        @files = files || DEFAULT_FILES
+                     warnings: true,
+                     bundler: false)
+        @name = name
+        @gem_version = gem_version
+        @libs = libs
+        @files = files
         @seed = seed
         @verbose = verbose
         @warnings = warnings
+        @bundler = bundler
       end
 
-      attr_accessor :name
-      attr_accessor :gem_version
-      attr_accessor :libs
-      attr_accessor :files
-      attr_accessor :seed
-      attr_accessor :verbose
-      attr_accessor :warnings
+      ##
+      # Name of the tool to create.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :name
+
+      ##
+      # Version requirements for the minitest gem.
+      # If set to `nil`, uses the bundled version if bundler is enabled, or
+      # defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS} if bundler is not
+      # enabled.
+      #
+      # @param value [String,Array<String>,nil]
+      # @return [String,Array<String>,nil]
+      #
+      attr_writer :gem_version
+
+      ##
+      # An array of library paths to add to the ruby require path.
+      # If set to `nil`, defaults to {DEFAULT_LIBS}.
+      #
+      # @param value [String,Array<String>,nil]
+      # @return [String,Array<String>,nil]
+      #
+      attr_writer :libs
+
+      ##
+      # An array of globs indicating the test files to load.
+      # If set to `nil`, defaults to {DEFAULT_FILES}.
+      #
+      # @param value [String,Array<String>,nil]
+      # @return [String,Array<String>,nil]
+      #
+      attr_writer :files
+
+      ##
+      # The random seed, or `nil` if not specified.
+      #
+      # @param value [Integer,nil]
+      # @return [Integer,nil]
+      #
+      attr_writer :seed
+
+      ##
+      # Whether to produce verbose output.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :verbose
+
+      ##
+      # Whether to run tests with Ruby warnings.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :warnings
+
+      ##
+      # Set the bundler state and options for this tool.
+      #
+      # Pass `false` to disable bundler. Pass `true` or a hash of options to
+      # enable bundler. See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param value [Boolean,Hash]
+      # @return [Boolean,Hash]
+      #
+      attr_writer :bundler
+
+      ##
+      # Use bundler for this tool.
+      #
+      # See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param opts [keywords] Options for bundler
+      # @return [self]
+      #
+      def use_bundler(**opts)
+        @bundler = opts
+        self
+      end
+
+      # @private
+      attr_reader :seed
+      # @private
+      attr_reader :verbose
+      # @private
+      attr_reader :warnings
+
+      # @private
+      def name
+        @name || DEFAULT_TOOL_NAME
+      end
+
+      # @private
+      def libs
+        @libs ? Array(@libs) : DEFAULT_LIBS
+      end
+
+      # @private
+      def files
+        @files ? Array(@files) : DEFAULT_FILES
+      end
+
+      # @private
+      def gem_version
+        return Array(@gem_version) if @gem_version
+        @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
+      end
+
+      # @private
+      def bundler_settings
+        if @bundler && !@bundler.is_a?(::Hash)
+          {}
+        else
+          @bundler
+        end
+      end
 
       on_expand do |template|
         tool(template.name) do
@@ -98,6 +207,9 @@ module Toys
           include :exec
           include :gems
 
+          bundler_settings = template.bundler_settings
+          include :bundler, **bundler_settings if bundler_settings
+
           flag :seed, "-s", "--seed SEED",
                default: template.seed, desc: "Sets random seed."
           flag :warnings, "-w", "--[no-]warnings",
@@ -113,7 +225,7 @@ module Toys
                          desc: "Paths to the tests to run (defaults to all tests)"
 
           to_run do
-            gem "minitest", *Array(template.gem_version)
+            gem "minitest", *template.gem_version
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               ruby_args = []