toys 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d6fa44786470e7dea559db8463b92ed619a3805aa7d586e29e0562a089381c
-  data.tar.gz: 519cf0c80675393e82e0c0c84162259d2e731ba0235ac5959e30ebf2cfb61e4f
+  metadata.gz: 0b6bf7f26f6ec380fcff62d91f671dd0ac535c740c5dab496ea681f9a94ec93c
+  data.tar.gz: 84b17a1f483b441c3944fa5dc46a9a672b2a339b71c2b5521ce01a7fe117be28
 SHA512:
-  metadata.gz: 0a795038540a8d44268fefe2bcea67aafb4a1c058a712a106436277917aa13edb2d560b0b10f4082f09f34775e621b682ce5dd36d1e129196d79a19c42790c2d
-  data.tar.gz: c0d28144d730e4637cf78e581cb8eae91978dc7ed1bc1e472a7a486e004a082cf8933785cd09bcae3c0db5cdc5952cc115f6486e5e2606b1ba21e27fd943fe4a
+  metadata.gz: dbdc0f5c476a6bd8e46623b7d62b1263ef5e259bc1936991e31294d94083cd551ec078c30f4c05b1bbd966d34c3c49c76ab2f05b37cba68f79b8cf8565995d48
+  data.tar.gz: 4b46179105d491e4860418d2737c3dd190fd199a93f0cdcd7496943c2c05510d4fd0b787df0265b50a65bd962a36129258899ef4fd29faa9b609a4efc0ed37ee

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release History
 
+### 0.3.4 / 2018-05-14
+
+* CHANGED: Renamed switch to flag
+* CHANGED: Renamed docs: parameter again, to desc: and long_desc: to match tool desc.
+* CHANGED: desc is now a single string rather than an array.
+* CHANGED: accept: parameter now controls whether a switch takes a value by default
+* IMPROVED: Nicer help page format
+* IMPROVED: gem_build template can suppress interactive confirmation.
+* IMPROVED: system update builtin can optionally ask for confirmation.
+* IMPROVED: Error reporting is significantly improved.
+* IMPROVED: Logger colors the header when possible.
+* IMPROVED: Style support for spinner helper
+* IMPROVED: Set default descriptions for flags and args
+* ADDED: Alias DSL methods `required`, `optional`, and `remaining`.
+* FIXED: Subtools with no desc now properly pick up the default
+* FIXED: Usage errors and show-help now interact in the right way
+
 ### 0.3.3 / 2018-05-09
 
 * CHANGED: Renamed file_utils helper to fileutils.

data/builtins/do.rb

@@ -29,9 +29,25 @@
 
 desc "Run multiple tools in order"
 
-switch(:delim, "-d", "--delim=VALUE", default: ",", docs: "Set the delimiter")
+long_desc \
+  "The \"toys do\" builtin provides a convenient interface for running multiple tools in" \
+    " sequence. Provide the tools to run as arguments, separated by a delimiter (which is" \
+    " the string \",\" by default). Toys will run them in order, stopping if any tool" \
+    " returns a nonzero exit code.",
+  "",
+  "Example: Suppose you have a \"rails build\" tool and a \"deploy\" tool, each with some" \
+    " flags. You could run them in order, with their flags, like this:",
+  ["    toys do rails build --staging , deploy --migrate"],
+  "",
+  "You may change the delimiter using the --delim flag. For example:",
+  ["    toys do --delim=/ rails build --staging / deploy --migrate"]
 
-remaining_args(:args, docs: "Tools to run")
+flag :delim, "-d", "--delim=VALUE",
+     default: ",",
+     desc: "Set the delimiter",
+     long_desc: "Sets the delimiter that separates tool invocations. The default value is \",\"."
+
+remaining_args :args, desc: "A series of tools to run, separated by the delimiter"
 
 execute do
   delim = self[:delim]

data/builtins/system.rb

@@ -29,6 +29,8 @@
 
 desc "A group of system commands for toys"
 
+long_desc "Contains tools that inspect, configure, and update toys itself."
+
 tool "version" do
   desc "Print current toys version."
 
@@ -40,7 +42,13 @@ end
 tool "update" do
   desc "Update toys if a newer version is available."
 
+  long_desc "Checks rubygems for a newer version of toys. If one is available, downloads" \
+            " and installs it."
+
+  flag :yes, "-y", "--yes", desc: "Do not ask for interactive confirmation"
+
   use :exec
+  use :highline
 
   execute do
     logger.info "Checking rubygems for the latest toys release..."
@@ -49,7 +57,8 @@ tool "update" do
       latest_version = ::Gem::Version.new($1)
       cur_version = ::Gem::Version.new(::Toys::VERSION)
       if latest_version > cur_version
-        logger.warn("Updating toys from #{cur_version} to #{latest_version}...")
+        exit(1) unless options[:yes] ||
+                       agree("Update toys from #{cur_version} to #{latest_version}? (y/n) ")
         sh("gem install toys")
       elsif latest_version < cur_version
         logger.warn("Toys is already at experimental version #{cur_version}, which is later than" \

data/lib/toys/standard_cli.rb

@@ -74,18 +74,21 @@ module Toys
     #
     BINARY_NAME = "toys".freeze
 
+    ##
+    # Short description for the standard root tool
+    # @return [String]
+    #
+    DEFAULT_ROOT_DESC = "Your personal command line tool.".freeze
+
     ##
     # Help text for the standard root tool
     # @return [String]
     #
-    DEFAULT_ROOT_DESC =
-      Utils::WrappableString.new(
-        "Toys is your personal command line tool. You can add to the list of" \
-        " commands below by writing scripts in Ruby using a simple DSL, and" \
-        " toys will organize and document them, and make them available" \
-        " globally or scoped to specific directories that you choose." \
-        " For detailed information, see https://www.rubydoc.info/gems/toys"
-      )
+    DEFAULT_ROOT_LONG_DESC =
+      "Toys is your personal command line tool. You can add to the list of commands below by" \
+      " writing scripts in Ruby using a simple DSL, and toys will organize and document them" \
+      " and make them available globally or scoped to specific directories that you choose." \
+      " For detailed information, see https://www.rubydoc.info/gems/toys".freeze
 
     ##
     # Create a standard CLI, configured with the appropriate paths and
@@ -135,20 +138,47 @@ module Toys
       cli
     end
 
+    # rubocop:disable Metrics/MethodLength
+
     ##
     # Returns a the middleware for the standard Toys CLI.
     #
     # @return [Array]
     #
     def self.default_middleware_stack
-      version_displayer = Middleware::ShowVersion.root_version_displayer(::Toys::VERSION)
       [
-        [:set_default_descriptions, default_root_desc: DEFAULT_ROOT_DESC],
-        [:handle_usage_errors],
-        [:show_version, version_displayer: version_displayer],
-        [:show_usage],
-        [:add_verbosity_switches]
+        [
+          :set_default_descriptions,
+          default_root_desc: DEFAULT_ROOT_DESC,
+          default_root_long_desc: DEFAULT_ROOT_LONG_DESC
+        ],
+        [
+          :show_help,
+          help_flags: true,
+          usage_flags: true,
+          recursive_flags: true,
+          search_flags: true,
+          allow_root_args: true
+        ],
+        [
+          :show_version,
+          version_displayer: Middleware::ShowVersion.root_version_displayer(::Toys::VERSION)
+        ],
+        [
+          :handle_usage_errors
+        ],
+        [
+          :show_help,
+          fallback_execution: true,
+          recursive_flags: true,
+          search_flags: true
+        ],
+        [
+          :add_verbosity_flags
+        ]
       ]
     end
+
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/toys/version.rb

@@ -32,5 +32,5 @@ module Toys
   # Current version of the Toys command line binary
   # @return [String]
   #
-  VERSION = "0.3.3".freeze
+  VERSION = "0.3.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-14 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.3.3
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement