toys 0.11.5 → 0.12.0

data/lib/toys/templates/gem_build.rb

@@ -49,6 +49,8 @@ module Toys
       #     a git remote. You may specify which remote by setting the value to
       #     a string. Otherwise, if the value is simply `true`, the "origin"
       #     remote is used by default.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: nil,
                      gem_name: nil,
@@ -57,7 +59,8 @@ module Toys
                      push_gem: false,
                      install_gem: false,
                      tag: false,
-                     push_tag: false)
+                     push_tag: false,
+                     context_directory: nil)
         @name = name
         @gem_name = gem_name
         @output = output
@@ -66,6 +69,7 @@ module Toys
         @install_gem = install_gem
         @tag = tag
         @push_tag = push_tag
+        @context_directory = context_directory
       end
 
       ##
@@ -137,6 +141,14 @@ module Toys
       #
       attr_writer :push_tag
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       # @private
       attr_reader :output
       # @private
@@ -145,6 +157,8 @@ module Toys
       attr_reader :install_gem
       # @private
       attr_reader :tag
+      # @private
+      attr_reader :context_directory
 
       # @private
       def name
@@ -152,9 +166,11 @@ module Toys
       end
 
       # @private
-      def gem_name
+      def gem_name(context_dir = nil)
         return @gem_name if @gem_name
-        candidates = ::Dir.glob("*.gemspec")
+        glob = "*.gemspec"
+        glob = ::File.join(context_dir, glob) if context_dir
+        candidates = ::Dir.glob(glob)
         if candidates.empty?
           raise ToolDefinitionError, "Could not find a gemspec"
         end
@@ -181,7 +197,9 @@ module Toys
 
       on_expand do |template|
         tool(template.name) do
-          desc "#{template.task_names} the gem: #{template.gem_name}"
+          set_context_directory template.context_directory if template.context_directory
+
+          desc "#{template.task_names} the gem: #{template.gem_name(context_directory)}"
 
           flag :yes, "-y", "--yes", desc: "Do not ask for interactive confirmation"
           if template.output_flags.empty?

data/lib/toys/templates/minitest.rb

@@ -55,6 +55,8 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -63,7 +65,8 @@ module Toys
                      seed: nil,
                      verbose: false,
                      warnings: true,
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @name = name
         @gem_version = gem_version
         @libs = libs
@@ -72,6 +75,7 @@ module Toys
         @verbose = verbose
         @warnings = warnings
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -135,6 +139,14 @@ module Toys
       #
       attr_writer :warnings
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for this tool.
       #
@@ -169,6 +181,8 @@ module Toys
       attr_reader :verbose
       # @private
       attr_reader :warnings
+      # @private
+      attr_reader :context_directory
 
       # @private
       def name
@@ -204,6 +218,8 @@ module Toys
         tool(template.name) do
           desc "Run minitest on the current project."
 
+          set_context_directory template.context_directory if template.context_directory
+
           include :exec
           include :gems
 

data/lib/toys/templates/rake.rb

@@ -31,17 +31,21 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(gem_version: nil,
                      rakefile_path: nil,
                      only_described: false,
                      use_flags: false,
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @gem_version = gem_version
         @rakefile_path = rakefile_path
         @only_described = only_described
         @use_flags = use_flags
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -80,6 +84,14 @@ module Toys
       #
       attr_writer :use_flags
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for all Rake tools.
       #
@@ -112,6 +124,8 @@ module Toys
       attr_reader :only_described
       # @private
       attr_reader :use_flags
+      # @private
+      attr_reader :context_directory
 
       # @private
       def gem_version
@@ -135,7 +149,9 @@ module Toys
       on_expand do |template|
         gem "rake", *template.gem_version
         require "rake"
-        rakefile_path = Templates::Rake.find_rakefile(template.rakefile_path, context_directory)
+        rakefile_path = Templates::Rake.find_rakefile(
+          template.rakefile_path, template.context_directory || context_directory
+        )
         raise "Cannot find #{template.rakefile_path}" unless rakefile_path
         context_dir = ::File.dirname(rakefile_path)
         rake = Templates::Rake.prepare_rake(rakefile_path, context_dir)

data/lib/toys/templates/rdoc.rb

@@ -60,6 +60,8 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -71,7 +73,8 @@ module Toys
                      template: nil,
                      generator: nil,
                      options: [],
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @name = name
         @gem_version = gem_version
         @files = files
@@ -83,6 +86,7 @@ module Toys
         @generator = generator
         @options = options
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -174,6 +178,14 @@ module Toys
       #
       attr_writer :options
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for this tool.
       #
@@ -213,7 +225,7 @@ module Toys
       # @private
       attr_reader :generator
       # @private
-      attr_reader :options
+      attr_reader :context_directory
 
       # @private
       def name
@@ -236,6 +248,11 @@ module Toys
         @output_dir || DEFAULT_OUTPUT_DIR
       end
 
+      # @private
+      def options
+        Array(@options)
+      end
+
       # @private
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
@@ -249,6 +266,8 @@ module Toys
         tool(template.name) do
           desc "Run rdoc on the current project."
 
+          set_context_directory template.context_directory if template.context_directory
+
           include :exec, exit_on_nonzero_status: true
           include :gems
 
@@ -256,7 +275,7 @@ module Toys
           include :bundler, **bundler_settings if bundler_settings
 
           to_run do
-            gem_requirements = Array(template.gem_version)
+            gem_requirements = template.gem_version
             gem "rdoc", *gem_requirements
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do

data/lib/toys/templates/rspec.rb

@@ -68,6 +68,8 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -79,7 +81,8 @@ module Toys
                      backtrace: false,
                      pattern: nil,
                      warnings: true,
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @name = name
         @gem_version = gem_version
         @libs = libs
@@ -91,6 +94,7 @@ module Toys
         @pattern = pattern
         @warnings = warnings
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -181,6 +185,14 @@ module Toys
       #
       attr_writer :warnings
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for this tool.
       #
@@ -217,6 +229,8 @@ module Toys
       attr_reader :backtrace
       ## @private
       attr_reader :warnings
+      # @private
+      attr_reader :context_directory
 
       # @private
       def name
@@ -262,6 +276,8 @@ module Toys
         tool(template.name) do
           desc "Run rspec on the current project."
 
+          set_context_directory template.context_directory if template.context_directory
+
           include :exec
           include :gems
 

data/lib/toys/templates/rubocop.rb

@@ -36,17 +36,21 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: DEFAULT_TOOL_NAME,
                      gem_version: nil,
                      fail_on_error: true,
                      options: [],
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @name = name
         @gem_version = gem_version
         @fail_on_error = fail_on_error
         @options = options
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -84,6 +88,14 @@ module Toys
       #
       attr_writer :options
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for this tool.
       #
@@ -114,8 +126,8 @@ module Toys
 
       ## @private
       attr_reader :fail_on_error
-      ## @private
-      attr_reader :options
+      # @private
+      attr_reader :context_directory
 
       # @private
       def name
@@ -128,6 +140,11 @@ module Toys
         @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
       end
 
+      # @private
+      def options
+        Array(@options)
+      end
+
       # @private
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
@@ -141,6 +158,8 @@ module Toys
         tool(template.name) do
           desc "Run rubocop on the current project."
 
+          set_context_directory template.context_directory if template.context_directory
+
           include :gems
           include :exec
 

data/lib/toys/templates/yardoc.rb

@@ -78,6 +78,8 @@ module Toys
       #     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.
+      # @param context_directory [String] A custom context directory to use
+      #     when executing this tool.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -98,7 +100,8 @@ module Toys
                      format: nil,
                      options: [],
                      stats_options: [],
-                     bundler: false)
+                     bundler: false,
+                     context_directory: nil)
         @name = name
         @gem_version = gem_version
         @files = files
@@ -119,6 +122,7 @@ module Toys
         @options = options
         @stats_options = stats_options
         @bundler = bundler
+        @context_directory = context_directory
       end
 
       ##
@@ -286,6 +290,14 @@ module Toys
       #
       attr_writer :stats_options
 
+      ##
+      # Custom context directory for this tool.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :context_directory
+
       ##
       # Set the bundler state and options for this tool.
       #
@@ -341,9 +353,7 @@ module Toys
       # @private
       attr_reader :format
       # @private
-      attr_reader :options
-      # @private
-      attr_reader :stats_options
+      attr_reader :context_directory
 
       # @private
       def name
@@ -366,6 +376,16 @@ module Toys
         @output_dir || DEFAULT_OUTPUT_DIR
       end
 
+      # @private
+      def options
+        Array(@options)
+      end
+
+      # @private
+      def stats_options
+        Array(@stats_options)
+      end
+
       # @private
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
@@ -379,6 +399,8 @@ module Toys
         tool(template.name) do
           desc "Run yardoc on the current project."
 
+          set_context_directory template.context_directory if template.context_directory
+
           if template.generate_output_flag
             flag :generate_output, "--[no-]output",
                  default: template.generate_output,
@@ -447,13 +469,11 @@ module Toys
                   exit(1)
                 end
                 exit_on_nonzero_status(result)
-                if template.fail_on_undocumented_objects
-                  if result.captured_out =~ /Undocumented\sObjects:/
-                    unless verbosity.negative?
-                      puts("Yardoc encountered undocumented objects", :red, :bold)
-                    end
-                    exit(1)
+                if template.fail_on_undocumented_objects && result.captured_out =~ /Undocumented\sObjects:/
+                  unless verbosity.negative?
+                    puts("Yardoc encountered undocumented objects", :red, :bold)
                   end
+                  exit(1)
                 end
               end
             end