thor-completion 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691cb833f0cc214e326a1b186f6c884cab5abe6102dc4357f1eee7cd6f82ed1e
-  data.tar.gz: fb8a29b2ceb7ae67e907d3e63e02717acfa6e44ab68a229ed85bc6c1f91db3a5
+  metadata.gz: 04d13f1834c0add34287b632d18e8e854457c28f42394e0bd44f5f70f6c132d8
+  data.tar.gz: a6095ce17d6b6f41c834d88ee078c7c5adadea8027cdeae51d34c51dc2aa3c25
 SHA512:
-  metadata.gz: bd116f5e939b154e1dce77cd86bb02ccf07f832c5591d6ba782aa3b8b0aa9d0fdf459fd9e6eddb0ecf500ccaf0fb911579a40b7f435996a9b417d42bfb63f4f5
-  data.tar.gz: 19120d0dba101995ae46132e91e45eea1c674ef47b27d4ca86c022c5bff6a6569b2c3dd7028db693840dcb74d8a6f5dbdc1f4260baff13cb88be33ebe42b026d
+  metadata.gz: e0d00a39ec7b612794d7d0271f102729073efc28c5b280c5556dc25188b1d6624197e429635a4dcd79c22434ad2ffd799c482e7acf37b658e423da3ee3ba6b70
+  data.tar.gz: 04d07083431b0c28fb4a4f000d6d8601c14a81789851d48768ad83b98358a03b066db0f38dbd3e940e822884a42a822bd5f9a3361637fbe94ab06a6b2450016e

data/CHANGELOG.md

@@ -11,6 +11,12 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.4
+
+- [Fixed] Escape newlines in option descriptions for zsh completions.
+- [Fixed] Properly escape single quotes in zsh completion strings.
+- [Fixed] Properly normalize command names.
+
 ## v0.0.3
 
 - [Fixed] Map Thor's `numeric` type to schema's `float` type.

data/lib/thor/completion/builder.rb

@@ -7,8 +7,8 @@ class Thor
 
       def self.call(name:, description:, version:, cli:)
         schema = {
-          name:,
-          description:,
+          name: normalize_name(name),
+          description: normalize_description(description),
           version:,
           commands: [],
           subcommands: [],
@@ -24,6 +24,25 @@ class Thor
         schema
       end
 
+      def self.dasherize(text) = text.to_s.tr("_", "-")
+
+      def self.normalize_description(description)
+        description.to_s.gsub(/(\r?\n)+/, " ")
+      end
+
+      def self.normalize_name(name)
+        case name
+        when "_run"
+          # Thor reserves the name `run` for its internal use.
+          # I've done ARGV manipulation to replace `run` with `_run` so that
+          # users can still use `run` as a command name. Let's assume this
+          # is the case and rename it back to `run`.
+          "run"
+        else
+          dasherize(name)
+        end
+      end
+
       def self.build_command(cli, parent)
         cli.options.each_value do |option|
           parent[:options] += build_option(option)
@@ -31,8 +50,8 @@ class Thor
 
         cli.all_commands.each_value do |command|
           cmd_schema = {
-            name: command.name,
-            description: command.description || "",
+            name: normalize_name(command.name),
+            description: normalize_description(command.description),
             options: command.options.each_value.flat_map { build_option(_1) }
           }
 
@@ -78,8 +97,8 @@ class Thor
       def self.build_subcommands(cli, parent)
         cli.all_commands.each_value do |command|
           subcmd_schema = {
-            name: command.name,
-            description: command.description || "",
+            name: normalize_name(command.name),
+            description: normalize_description(command.description),
             options: command.options.each_value.flat_map { build_option(_1) }
           }
 
@@ -111,7 +130,7 @@ class Thor
 
         values.map do |type, name|
           arg_hash = {
-            name: name.to_s,
+            name: normalize_name(name),
             description: name.to_s.tr("_", " ").capitalize,
             required: type == :req,
             variadic: type == :rest
@@ -126,15 +145,14 @@ class Thor
       end
 
       def self.build_option(option)
-        dasherize = proc { _1.to_s.tr("_", "-") }
-        name = dasherize.call(option.name)
+        name = dasherize(option.name)
 
         [].tap do |list|
-          short_opts = option.aliases.map { dasherize.call(_1.gsub(/^-+/, "")) }
+          short_opts = option.aliases.map { dasherize(_1.gsub(/^-+/, "")) }
           opt_hash = {
-            name:,
+            name: normalize_name(name),
             type: normalize_type(option.type),
-            description: option.description || "",
+            description: normalize_description(option.description),
             required: option.required,
             repeatable: option.repeatable || false,
             default: option.default,

data/lib/thor/completion/version.rb

@@ -2,6 +2,6 @@
 
 class Thor
   module Completion
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/thor/completion/zsh.rb

@@ -293,7 +293,7 @@ class Thor
 
       private def add_completion_spec(spec, completion)
         comp_spec = format_completion(completion)
-        spec.sub(/\]$/, "]:value:#{comp_spec}'")
+        spec + "]:value:#{comp_spec}'"
       end
 
       private def format_completion(completion)
@@ -324,11 +324,11 @@ class Thor
       end
 
       private def escape_description(desc)
-        desc.to_s.gsub(/[\[\]']/, '\\\\\&')
+        desc.to_s.gsub("\n", " ").gsub("'", "'\\\\''"  ).gsub(/[\[\]]/, '\\\\\&')
       end
 
       private def escape_value(value)
-        value.to_s.gsub(/[\s']/, '\\\\\&')
+        value.to_s.gsub("'", "'\\\\''"  ).gsub(/[\s]/, '\\\\\&')
       end
 
       private def quote(str)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thor-completion
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nando Vieira
@@ -165,10 +165,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/thor-completion
   bug_tracker_uri: https://github.com/fnando/thor-completion/issues
-  source_code_uri: https://github.com/fnando/thor-completion/tree/v0.0.3
-  changelog_uri: https://github.com/fnando/thor-completion/tree/v0.0.3/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/thor-completion/tree/v0.0.3/README.md
-  license_uri: https://github.com/fnando/thor-completion/tree/v0.0.3/LICENSE.md
+  source_code_uri: https://github.com/fnando/thor-completion/tree/v0.0.4
+  changelog_uri: https://github.com/fnando/thor-completion/tree/v0.0.4/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/thor-completion/tree/v0.0.4/README.md
+  license_uri: https://github.com/fnando/thor-completion/tree/v0.0.4/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib