thor-zsh_completion 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d2b258587a459e70ec955724fb631aafc73786f
-  data.tar.gz: 24905d7c013630ac13c9bea4e6a29cfb3af9f2b3
+SHA256:
+  metadata.gz: a14bd88f01d2f3389989eb8325cf4fefeb441bf73678a9e35665f27d4420a052
+  data.tar.gz: 632f050d06d11c50355e318867037ec31a1b53e151e379c21b85d66bf739dc33
 SHA512:
-  metadata.gz: 1b30db3b9e7649a2f3253aa6f54d061d40db7b5381829ceae9b923d6435ff68653f3c7d582a677dd304e73c84e0cd5b091f7028f82b7507c79548f6cde369877
-  data.tar.gz: b69f1767db423e6f957573fe30f866adf44d7e0bd17b70a9cb3b06f77cdc5136a23feea4749ab5db07d3e481fcb52bc97070449fc59ff99b387da29e7f0fd4ed
+  metadata.gz: 6cf2c8c5c8cf1f61851bec0570810ba00e628d2374b7c7a05e812dce088d94edc80933debe86c70f9a937eeac9d6621737208f54d4fb12b3fd150ddcf6400188
+  data.tar.gz: 9015c85103b6a35f150bc74bd139194b22a7102dd8b76d82c9227e92079e27f1e5cf50cd50ad9cf6d4a9ae209a9d3b7b51046a3c1265faaff1908ba4ff9ddbfe

data/.rubocop.yml

@@ -0,0 +1,127 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - node_modules/**/*
+  NewCops: enable
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: only_before
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+    - "**/*.rake"
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%w': '()'
+    '%r': '()'
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+### 0.1.6
+
+Misc
+
+- fix the generation of zsh completion scripts to prevent [ShellCheck](https://www.shellcheck.net/) warnings (@joehorsnell)†verz
+
+### 0.1.5
+
+Bugfixes
+
+- remove unnecessary `local state` in generated script. (reported by @aoyama-val)
+
+### 0.1.4
+
+Bugfixes
+
+- support `Thor.map`. (by @Zhomart)
+
+### 0.1.3
+
+Bugfixes
+
+- fix invalid script generation bug for option description. (by @tbpgr)
+- fix invalid script generation bug for not aliased option.
+
+### 0.1.1
+
+Features
+
+- support ruby 1.9.3.
+
+### 0.1.0
+
+- initial release.

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in thor-zsh_completion.gemspec
 gemspec
+
+gem "bundler", "~> 2.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.9"
+gem "rubocop", "~> 0.86"

data/README.md

@@ -69,6 +69,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
+### Testing completion script
+
+    source spec/thor/zsh_completion/generator_spec.zsh
+    generator_spec [TAB]
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/thor-zsh_completion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/thor/zsh_completion/generator.rb

@@ -1,7 +1,7 @@
 class Thor
   module ZshCompletion
     class Generator
-      SUBCOMMAND_FUNCTION_TEMPLATE = ERB.new(File.read("#{__dir__}/template/subcommand_function.erb"), nil, "-")
+      SUBCOMMAND_FUNCTION_TEMPLATE = ERB.new(File.read("#{File.dirname(__FILE__)}/template/subcommand_function.erb"), nil, "-")
       attr_reader :thor, :name
 
       def initialize(thor, name)
@@ -47,15 +47,17 @@ class Thor
           name: "__#{name}",
           description: nil,
           options: [],
-          subcommands: subcommand_metadata(thor)
+          subcommands: subcommand_metadata(thor),
         }
 
-        erb = File.read("#{__dir__}/template/main.erb")
+        erb = File.read("#{File.dirname(__FILE__)}/template/main.erb")
         ERB.new(erb, nil, "-").result(binding)
       end
 
       private
-      def render_subcommand_function(subcommand, prefix: [])
+      def render_subcommand_function(subcommand, options = {})
+        prefix = options[:prefix] || []
+
         source = []
 
         prefix = (prefix + [subcommand[:name]])
@@ -63,33 +65,63 @@ class Thor
         depth = prefix.size + 1
 
         source << SUBCOMMAND_FUNCTION_TEMPLATE.result(binding)
-        subcommand[:subcommands].each do |subcommand|
-          source << render_subcommand_function(subcommand, prefix: prefix)
+
+        subcommand[:subcommands].each do |nested|
+          source << render_subcommand_function(nested, prefix: prefix)
         end
         source.join("\n").strip + "\n"
       end
 
       def subcommand_metadata(thor)
-        thor.tasks.map do |(name, command)|
-          if subcommand_class = thor.subcommand_classes[name]
-            subcommands = subcommand_metadata(subcommand_class)
-          else
-            subcommands = []
-          end
-          { name: command.name.gsub("_", "-"),
-            usage: command.usage,
-            description: command.description,
-            options: thor.class_options.map{|_, o| option_metadata(o) } +
-                     command.options.map{|(_, o)| option_metadata(o) },
-            subcommands: subcommands
-          }
+        result = []
+        thor.tasks.each do |(name, command)|
+          aliases = thor.map.select {|_, original_name|
+            name == original_name
+          }.map(&:first)
+          result << generate_command_information(thor, name, command, aliases)
+        end
+        result
+      end
+
+      def generate_command_information(thor, name, command, aliases)
+        subcommands = if (subcommand_class = thor.subcommand_classes[name])
+          subcommand_metadata(subcommand_class)
+        else
+          []
         end
+        {name: hyphenate(name),
+         aliases: aliases.map {|a| hyphenate(a) },
+         usage: command.usage,
+         description: command.description,
+         options: thor.class_options.map {|_, o| option_metadata(o) } +
+           command.options.map {|(_, o)| option_metadata(o) },
+         subcommands: subcommands,}
       end
 
       def option_metadata(option)
-        { names: ["--#{option.name}"] + option.aliases.map{|a| "-#{a}" },
-          description: option.description,
-        }
+        {names: ["--#{option.name}"] + option.aliases.map {|a| "-#{a}" },
+         description: option.description,}
+      end
+
+      def quote(s)
+        escaped = s.gsub(/'/, "''")
+        %('#{escaped}')
+      end
+
+      def bracket(s)
+        %([#{s}])
+      end
+
+      def escape_option_names(names)
+        if names.size == 1
+          names.first
+        else
+          "{" + names.join(",") + "}"
+        end
+      end
+
+      def hyphenate(s)
+        s.gsub("_", "-")
       end
     end
   end

data/lib/thor/zsh_completion/template/main.erb

@@ -1,7 +1,5 @@
 #compdef <%= name %>
 
-local state
-
 _<%= name %>() {
   __<%= name %>
 }

data/lib/thor/zsh_completion/template/subcommand_function.erb

@@ -6,7 +6,7 @@
     $DEPTH)
       _arguments \
         <%- subcommand[:options].each do |option| -%>
-        {<%= option[:names].join(",") %>}<%= option[:description].gsub(/'/, "''") if option[:description] %> \
+        <%= escape_option_names(option[:names]) %><%= quote(bracket(option[:description])) if option[:description] %> \
         <%- end -%>
         '*: :->subcommands'
 
@@ -15,18 +15,26 @@
           _values \
             'subcommand' \
             <%- subcommand[:subcommands].each do |subcommand| -%>
-            '<%= subcommand[:name] %>[<%= subcommand[:description].gsub(/'/, "''") %>]' \
+            <%= quote(subcommand[:name] + bracket(subcommand[:description])) %> \
+            <%- subcommand[:aliases].each do |_alias| -%>
+            <%= quote(_alias + bracket(subcommand[:description])) %> \
+            <%- end -%>
             <%- end -%>
             ;
           ;;
       esac
       ;;
     *)
-      case $words[$DEPTH] in
+      case ${words[$DEPTH]} in
         <%- subcommand[:subcommands].each do |subcommand| -%>
         <%= subcommand[:name] %>)
           <%= function_name %>_<%= subcommand[:name] %>
           ;;
+        <%- subcommand[:aliases].each do |_alias| -%>
+        <%= _alias %>)
+          <%= function_name %>_<%= subcommand[:name] %>
+          ;;
+        <%- end -%>
         <%- end -%>
         *)
           # if does not match any subcommand
@@ -41,7 +49,7 @@
 <%= function_name %>() {
   _arguments \
     <%- subcommand[:options].each do |option| -%>
-    {<%= option[:names].join(",") %>}<%= option[:description].gsub(/'/, "''") if option[:description] %> \
+    <%= escape_option_names(option[:names]) %><%= quote(bracket(option[:description])) if option[:description] %> \
     <%- end -%>
     '*: :->rest'
 

data/lib/thor/zsh_completion/version.rb

@@ -1,5 +1,5 @@
 class Thor
   module ZshCompletion
-    VERSION = "0.1.0"
+    VERSION = "0.1.6".freeze
   end
 end

data/thor-zsh_completion.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'thor/zsh_completion/version'
+require "thor/zsh_completion/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "thor-zsh_completion"
@@ -9,17 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ["labocho"]
   spec.email         = ["labocho@penguinlab.jp"]
 
-  spec.summary       = %q{Create zsh completion script for Thor subclass}
-  spec.description   = %q{Create zsh completion script for Thor subclass}
+  spec.summary       = "Create zsh completion script for Thor subclass"
+  spec.description   = "Create zsh completion script for Thor subclass"
   spec.homepage      = "https://github.com/labocho/thor-zsh_completion"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r(^exe/)) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency "thor", "~> 0"
 end

metadata

@@ -1,55 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: thor-zsh_completion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - labocho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Create zsh completion script for Thor subclass
@@ -61,13 +33,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - lib/thor/zsh_completion.rb
 - lib/thor/zsh_completion/command.rb
@@ -95,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Create zsh completion script for Thor subclass