toys 0.14.7 → 0.15.0

data/lib/toys/templates/rspec.rb

@@ -343,17 +343,28 @@ module Toys
                          complete: :file_system,
                          desc: "Paths to the specs to run (defaults to all specs)"
 
-          to_run do
-            gem_requirements = Array(template.gem_version)
-            gem "rspec", *gem_requirements
+          static :libs, template.libs
+          static :gem_version, template.gem_version
+          static :rspec_options, template.options
+
+          # @private
+          def run # rubocop:disable all
+            gem "rspec", *gem_version
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               ruby_args = []
-              libs = Array(template.libs)
               ruby_args << "-I#{libs.join(::File::PATH_SEPARATOR)}" unless libs.empty?
               ruby_args << "-w" if warnings
-              ruby_args << "-"
-              ruby_args << "--options" << template.options if template.options
+
+              code = <<~CODE
+                gem 'rspec', *#{gem_version.inspect}
+                require 'rspec/core'
+                ::RSpec::Core::Runner.invoke
+              CODE
+              ruby_args << "-e" << code
+
+              ruby_args << "--"
+              ruby_args << "--options" << rspec_options if rspec_options
               ruby_args << "--order" << order if order
               ruby_args << "--format" << format if format
               ruby_args << "--out" << out if out
@@ -364,11 +375,7 @@ module Toys
               ruby_args << "--tag" << tag if tag
               ruby_args.concat(files)
 
-              result = exec_ruby(ruby_args, in: :controller) do |controller|
-                controller.in.puts("gem 'rspec', *#{gem_requirements.inspect}")
-                controller.in.puts("require 'rspec/core'")
-                controller.in.puts("::RSpec::Core::Runner.invoke")
-              end
+              result = exec_ruby(ruby_args)
               if result.error?
                 logger.error("RSpec failed!")
                 exit(result.exit_code)

data/lib/toys/templates/rubocop.rb

@@ -173,25 +173,31 @@ module Toys
 
           set_context_directory template.context_directory if template.context_directory
 
+          static :gem_version, template.gem_version
+          static :rubocop_options, template.options
+          static :fail_on_error, template.fail_on_error
+
           include :gems
           include :exec
 
           bundler_settings = template.bundler_settings
           include :bundler, **bundler_settings if bundler_settings
 
-          to_run do
-            gem "rubocop", *template.gem_version
+          # @private
+          def run
+            gem "rubocop", *gem_version
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               logger.info "Running RuboCop..."
-              result = exec_ruby([], in: :controller) do |controller|
-                controller.in.puts("gem 'rubocop', *#{template.gem_version.inspect}")
-                controller.in.puts("require 'rubocop'")
-                controller.in.puts("exit(::RuboCop::CLI.new.run(#{template.options.inspect}))")
-              end
+              code = <<~CODE
+                gem 'rubocop', *#{gem_version.inspect}
+                require 'rubocop'
+                exit(::RuboCop::CLI.new.run(#{rubocop_options.inspect}))
+              CODE
+              result = exec_ruby(["-e", code])
               if result.error?
                 logger.error "RuboCop failed!"
-                exit(1) if template.fail_on_error
+                exit(1) if fail_on_error
               end
             end
           end

data/lib/toys/templates/yardoc.rb

@@ -464,6 +464,23 @@ module Toys
             static :generate_output, template.generate_output
           end
 
+          static :gem_version, template.gem_version
+          static :template_files, template.files
+          static :run_options, template.options.dup
+          static :stats_options, template.stats_options.dup
+          static :fail_on_undocumented_objects, template.fail_on_undocumented_objects
+          static :fail_on_warning, template.fail_on_warning
+          static :output_dir, template.output_dir
+          static :show_public, template.show_public
+          static :show_protected, template.show_protected
+          static :show_private, template.show_private
+          static :hide_private_tag, template.hide_private_tag
+          static :readme, template.readme
+          static :markup, template.markup
+          static :yard_template, template.template
+          static :template_path, template.template_path
+          static :yard_format, template.format
+
           include :exec
           include :terminal
           include :gems
@@ -471,60 +488,60 @@ module Toys
           bundler_settings = template.bundler_settings
           include :bundler, **bundler_settings if bundler_settings
 
-          to_run do
-            gem_requirements = template.gem_version
-            gem "yard", *gem_requirements
+          # @private
+          def run # rubocop:disable all
+            gem "yard", *gem_version
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do
               files = []
-              template.files.each do |pattern|
+              template_files.each do |pattern|
                 files.concat(::Dir.glob(pattern))
               end
               files.uniq!
 
-              run_options = template.options.dup
-              stats_options = template.stats_options.dup
-              stats_options << "--list-undoc" if template.fail_on_undocumented_objects
-              run_options << "--fail-on-warning" if template.fail_on_warning
+              stats_options << "--list-undoc" if fail_on_undocumented_objects
+              run_options << "--fail-on-warning" if fail_on_warning
               run_options << "--no-output" unless generate_output
-              run_options << "--output-dir" << template.output_dir if template.output_dir
-              run_options << "--no-public" unless template.show_public
-              run_options << "--protected" if template.show_protected
-              run_options << "--private" if template.show_private
-              run_options << "--no-private" if template.hide_private_tag
-              run_options << "-r" << template.readme if template.readme
-              run_options << "-m" << template.markup if template.markup
-              run_options << "-t" << template.template if template.template
-              run_options << "-p" << template.template_path if template.template_path
-              run_options << "-f" << template.format if template.format
+              run_options << "--output-dir" << output_dir if output_dir
+              run_options << "--no-public" unless show_public
+              run_options << "--protected" if show_protected
+              run_options << "--private" if show_private
+              run_options << "--no-private" if hide_private_tag
+              run_options << "-r" << readme if readme
+              run_options << "-m" << markup if markup
+              run_options << "-t" << yard_template if yard_template
+              run_options << "-p" << template_path if template_path
+              run_options << "-f" << yard_format if yard_format
               unless stats_options.empty?
                 run_options << "--no-stats"
                 stats_options << "--use-cache"
               end
               run_options.concat(files)
 
-              result = exec_ruby([], in: :controller) do |controller|
-                controller.in.puts("gem 'yard', *#{gem_requirements.inspect}")
-                controller.in.puts("require 'yard'")
-                controller.in.puts("::YARD::CLI::Yardoc.run(*#{run_options.inspect})")
-              end
+              code = <<~CODE
+                gem 'yard', *#{gem_version.inspect}
+                require 'yard'
+                ::YARD::CLI::Yardoc.run(*#{run_options.inspect})
+              CODE
+              result = exec_ruby(["-e", code])
               if result.error?
                 puts("Yardoc encountered errors", :red, :bold) unless verbosity.negative?
                 exit(1)
               end
               unless stats_options.empty?
-                result = exec_ruby([], in: :controller, out: :capture) do |controller|
-                  controller.in.puts("gem 'yard', *#{gem_requirements.inspect}")
-                  controller.in.puts("require 'yard'")
-                  controller.in.puts("::YARD::CLI::Stats.run(*#{stats_options.inspect})")
-                end
+                code = <<~CODE
+                  gem 'yard', *#{gem_version.inspect}
+                  require 'yard'
+                  ::YARD::CLI::Stats.run(*#{stats_options.inspect})
+                CODE
+                result = exec_ruby(["-e", code], out: :capture)
                 puts result.captured_out
                 if result.error?
                   puts("Yardoc encountered errors", :red, :bold) unless verbosity.negative?
                   exit(1)
                 end
                 exit_on_nonzero_status(result)
-                if template.fail_on_undocumented_objects && result.captured_out =~ /Undocumented\sObjects:/
+                if fail_on_undocumented_objects && result.captured_out =~ /Undocumented\sObjects:/
                   unless verbosity.negative?
                     puts("Yardoc encountered undocumented objects", :red, :bold)
                   end

data/lib/toys/testing.rb

@@ -53,7 +53,7 @@ module Toys
     #     end
     #   end
     #
-    #   # You can test the `message` method as follows:
+    #   # You can test the `message` method in isolation as follows:
     #
     #   class MyTest < Minitest::Test
     #     include Toys::Testing

data/lib/toys/version.rb

@@ -5,5 +5,5 @@ module Toys
   # Current version of the Toys command line executable.
   # @return [String]
   #
-  VERSION = "0.14.7"
+  VERSION = "0.15.0"
 end

data/lib/toys.rb

@@ -8,6 +8,7 @@ require "toys/version"
 # don't get clobbered in case someone sets up bundler later.
 unless ::ENV.key?("TOYS_CORE_LIB_PATH")
   path = ::File.expand_path("../../toys-core-#{::Toys::VERSION}/lib", __dir__)
+  path = ::File.expand_path("../../toys-core/lib", __dir__) unless path && ::File.directory?(path)
   unless path && ::File.directory?(path)
     require "rubygems"
     dep = ::Gem::Dependency.new("toys-core", "= #{::Toys::VERSION}")
@@ -30,6 +31,24 @@ require "toys-core"
 # workflows. It can also be used as a Rake replacement, providing a more
 # natural command line interface for your project's build tasks.
 #
+# This set of documentation includes classes from both Toys-Core, the
+# underlying command line framework, and the Toys executable itself. Most of
+# the actual classes you will likely need to look up are from Toys-Core.
+#
+# ## Common starting points
+#
+# * For information on the DSL used to write tools, start with
+#   {Toys::DSL::Tool}.
+# * The base class for tool runtime (i.e. that defines the basic methods
+#   available to a tool's implementation) is {Toys::Context}.
+# * For information on writing mixins, see {Toys::Mixin}.
+# * For information on writing templates, see {Toys::Template}.
+# * For information on writing acceptors, see {Toys::Acceptor}.
+# * For information on writing custom shell completions, see {Toys::Completion}.
+# * Standard mixins are defined under the {Toys::StandardMixins} module.
+# * Various utilities are defined under {Toys::Utils}. Some of these serve as
+#   the implementations of corresponding mixins.
+#
 module Toys
   ##
   # Path to the Toys executable.
@@ -47,6 +66,9 @@ module Toys
   ##
   # Namespace for standard template classes.
   #
+  # These templates are provided by Toys and can be expanded by name by passing
+  # a symbol to {Toys::DSL::Tool#expand}.
+  #
   module Templates; end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys
 version: !ruby/object:Gem::Version
-  version: 0.14.7
+  version: 0.15.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toys-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.7
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.7
+        version: 0.15.0
 description: Toys is a configurable command line tool. Write commands in Ruby using
   a simple DSL, and Toys will provide the command line executable and take care of
   all the details such as argument parsing, online help, and error reporting. Toys
@@ -98,6 +98,7 @@ files:
 - core-docs/toys/utils/git_cache.rb
 - core-docs/toys/utils/help_text.rb
 - core-docs/toys/utils/pager.rb
+- core-docs/toys/utils/standard_ui.rb
 - core-docs/toys/utils/terminal.rb
 - core-docs/toys/utils/xdg.rb
 - core-docs/toys/wrappable_string.rb
@@ -120,10 +121,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys/v0.14.7/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys/v0.15.0/file.CHANGELOG.html
   source_code_uri: https://github.com/dazuma/toys/tree/main/toys
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys/v0.14.7
+  documentation_uri: https://dazuma.github.io/toys/gems/toys/v0.15.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A configurable command line tool