thor-zsh_completion 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd91ee306a415b0689fcdb5f58ad3c52f1d049e1
-  data.tar.gz: 692e2d425ff2779550b3d2b5e0edd13de418262b
+SHA256:
+  metadata.gz: 5c434b47625fe4feb58ca29949aaf4779c35b83274b15f45c5e2cb7fdd0f2999
+  data.tar.gz: c57e8350114e0455a693b6adae1ead9d231e07923fe6cab73a770be23bf3dd08
 SHA512:
-  metadata.gz: 638a502306f9c061ee9f1d3689a497709e414227829430341aa7c66a73f9bca56a038d8882b947d3498f7d89d775f942b3914b21255de240466d4f28052e9910
-  data.tar.gz: d17f7a4fd9339fec15f08951af2cecbef1af08147febc75e89a4c9aa1cdcc9858bff8787a30a939cab9b45a6deb8e2cd9dd2dd8d4a149954cb46def2c840b81b
+  metadata.gz: 176936a07f7b4873cadf6002b8ef1e42832c066c51c6fc5ba208677888cae3962845ad2ee2f4bcd9cc56de37ce531bc0ca0f2478d15b0b17d88deed2e2a7996a
+  data.tar.gz: f0b5a195a450729a04e8a6b3429fc9fe1b9d411a4ad7b144518692f5a0b78f1eea7e70959ec4a4a20aa438da8fc916d2cd82102e5b31ce80c804065a86b4d56d

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,46 @@
+### 0.1.8
+
+Misc
+
+- update `thor` dependency
+
+### 0.1.7
+
+Misc
+
+- fix the generation of zsh completion scripts to prevent all [ShellCheck](https://www.shellcheck.net/) warnings
+
+### 0.1.6
+
+Misc
+
+- fix the generation of zsh completion scripts to prevent [ShellCheck](https://www.shellcheck.net/) warnings (@joehorsnell)
+
+### 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/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

@@ -47,7 +47,7 @@ class Thor
           name: "__#{name}",
           description: nil,
           options: [],
-          subcommands: subcommand_metadata(thor)
+          subcommands: subcommand_metadata(thor),
         }
 
         erb = File.read("#{File.dirname(__FILE__)}/template/main.erb")
@@ -65,33 +65,42 @@ 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)
@@ -110,6 +119,10 @@ class Thor
           "{" + names.join(",") + "}"
         end
       end
+
+      def hyphenate(s)
+        s.gsub("_", "-")
+      end
     end
   end
 end

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

@@ -1,6 +1,6 @@
 #compdef <%= name %>
-
-local state
+# shellcheck disable=SC2034
+# https://github.com/koalaman/shellcheck/wiki/SC2034
 
 _<%= name %>() {
   __<%= name %>

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

@@ -3,30 +3,38 @@
   readonly local DEPTH=<%= depth %>
 
   case $CURRENT in
-    $DEPTH)
+    "$DEPTH")
       _arguments \
         <%- subcommand[:options].each do |option| -%>
         <%= escape_option_names(option[:names]) %><%= quote(bracket(option[:description])) if option[:description] %> \
         <%- end -%>
         '*: :->subcommands'
 
-      case $state in
+      case ${state:?} in
         subcommands)
           _values \
             'subcommand' \
             <%- subcommand[:subcommands].each do |subcommand| -%>
             <%= 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
@@ -45,7 +53,7 @@
     <%- end -%>
     '*: :->rest'
 
-  case $state in
+  case ${state:?} in
     rest)
       # complete rest arguments
       _files

data/lib/thor/zsh_completion/version.rb

@@ -1,5 +1,5 @@
 class Thor
   module ZshCompletion
-    VERSION = "0.1.2"
+    VERSION = "0.1.8".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", "< 2"
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: thor-zsh_completion
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.8
 platform: ruby
 authors:
 - labocho
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2020-11-24 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
+        version: '2'
+  type: :runtime
   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
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 description: Create zsh completion script for Thor subclass
 email:
 - labocho@penguinlab.jp
@@ -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
@@ -80,7 +56,7 @@ homepage: https://github.com/labocho/thor-zsh_completion
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Create zsh completion script for Thor subclass
 test_files: []