cli-template 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf247e389131d796f851f63170b372317765995899ac852510ae2e08d6807b7
-  data.tar.gz: c6c607ea96e976aaa38791f1d4a16a3630f6ae2ef3a548093f6305cb69a9fba1
+  metadata.gz: 17cbbe8fe23b402c5d7186db07b36efb7558de259644e26b16bdcec71aef8e2d
+  data.tar.gz: 4786c899d4991565425a177028c0392af5d99d89578ebe16266f8b9d21eeb0a9
 SHA512:
-  metadata.gz: ba5b206f2bfd776d993e00bc78ff39b539a70505082992af8935985ae76b6b67d17fd92913c9a997f460bd6578562b7b87c78b3ccaa5a031492842f5afe095ac
-  data.tar.gz: e23520496b7e64d9c6563c9dd9a5b57ab921f5c069ea25a6c314047f4084785e96dfa6a81aa66401f8443414f84fbf79f56ec8f6ad6e516d8142be2033944eb3
+  metadata.gz: 62acac1019b70985dbcc86c45249ecd8d7ead6730780b8b90379981ae2a244c1716d3c93eb1fb6f23d5bc8057517fc7d4062548b5be633427794636ab61c0f59
+  data.tar.gz: 0a9b85c698aabcde90a88f8b47cb400dfee8ced3761d926ea7201752a287e487cf99630af0fd544bd8037e3cb4f49c4663b95897508bd86560b21b4865822d1e

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [3.3.0]
+- fix completer for thor group and use public_instance_methods(false)
+- fix shared new options for thor group and cli
+
 ## [3.2.0]
 - Merge pull request #2 from tongueroo/basic: the deafult template is a basic Thor CLI instead of the colon_namespaces one.
 - cache eager_load call and handle Thor::InvocationError

data/cli-template.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   spec.version       = CliTemplate::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.description   = %q{Generate a CLI tool quickly}
   spec.summary       = %q{Generate a CLI tool quickly}
   spec.homepage      = "https://gitub.com/tongueroo/cli-template"
   spec.license       = "MIT"

data/lib/cli-template.rb

@@ -8,5 +8,5 @@ module CliTemplate
   autoload :Version, 'cli-template/version'
   autoload :Sequence, 'cli-template/sequence'
   autoload :New, 'cli-template/new'
-  autoload :Helpers, 'cli-template/helpers'
+  autoload :Helper, 'cli-template/helper'
 end

data/lib/cli-template/{helpers.rb → helper.rb}

@@ -1,4 +1,4 @@
-module CliTemplate::Helpers
+module CliTemplate::Helper
   def project_class_name
     project_name.underscore.camelize
   end

data/lib/cli-template/new.rb

@@ -5,6 +5,7 @@ module CliTemplate
     # Ugly, but when the class_option is only defined in the Thor::Group class
     # it doesnt show up with cli-template new help :(
     # If anyone knows how to fix this let me know.
+    # Also options from the cli can be pass through to here
     def self.cli_options
       [
         [:repo, desc: "GitHub repo to use. Format: user/repo"],

data/lib/cli-template/sequence.rb

@@ -6,7 +6,7 @@ require 'bundler'
 
 class CliTemplate::Sequence < Thor::Group
   include Thor::Actions
-  include CliTemplate::Helpers
+  include CliTemplate::Helper
 
   def self.source_root
     template = ENV['TEMPLATE'] || 'default'

data/lib/cli-template/version.rb

@@ -1,3 +1,3 @@
 module CliTemplate
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/templates/colon_namespaces/%project_name%.gemspec.tt

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = <%= project_class_name %>::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.description   = "Generated with cli-template tool. Please write a gem description"
   spec.summary       = "Generated with cli-template tool. Please write a gem summary"
-  spec.homepage      = ""
+  spec.description   = "Generated with cli-template tool. Write a longer description or delete this line."
+  spec.homepage      = "Generated with cli-template tool. Put your gem's website or public repo URL here."
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/templates/colon_namespaces/spec/spec_helper.rb.tt

@@ -9,7 +9,7 @@ require "pp"
 root = File.expand_path("../../", __FILE__)
 require "#{root}/lib/<%= project_name %>"
 
-module Helpers
+module Helper
   def execute(cmd)
     puts "Running: #{cmd}" if show_command?
     out = `#{cmd}`
@@ -25,5 +25,5 @@ module Helpers
 end
 
 RSpec.configure do |c|
-  c.include Helpers
+  c.include Helper
 end

data/lib/templates/default/%project_name%.gemspec.tt

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = <%= project_class_name %>::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.description   = "Generated with cli-template tool. Please write a gem description"
   spec.summary       = "Generated with cli-template tool. Please write a gem summary"
-  spec.homepage      = ""
+  spec.description   = "Generated with cli-template tool. Write a longer description or delete this line."
+  spec.homepage      = "Generated with cli-template tool. Put your gem's website or public repo URL here."
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/templates/default/lib/%underscored_name%/completer.rb.tt

@@ -1,59 +1,74 @@
-# Code Explanation.  This is mainly focused on the run method.
-#
-# There are 3 main branches of logic for completion:
-#
-#   1. top-level commands - when there are zero completed words
-#   2. params completion - when a command has some required params
-#   3. options completion - when we have finished auto-completing the top-level command and required params, the rest of the completion words will be options
-#
-# Terms:
-#
-#   params - these are params in the command itself. Example: for the method `scale(service, count)` the params would be `service, count`.
-#   options - these are cli options flags.  Examples: --noop, --verbose
-#
-# When we are done processing method params, the completion will be only options. When the detected params size is greater than the arity we are have finished auto-completing the parameters in the method declaration.  For example, say you had a method for a CLI command with the following form:
-#
-#   scale(service, count) = arity of 2
-#
-#   <%= project_name %> scale service count [TAB] # there are 3 params including the "scale" command
-#
-# So the completion will be something like:
-#
-#   --noop --verbose etc
-#
-# A note about artity values:
-#
-# We are using the arity of the command method to determine if we have finish auto-completing the params completion. When the ruby method has a splat param, it's arity will be negative.  Here are some example methods and their arities.
-#
-#    ship(service) = 1
-#    scale(service, count) = 2
-#    ships(*services) = -1
-#    foo(example, *rest) = -2
-#
-# Fortunately, negative and positive arity values are processed the same way. So we take simply take the abs of the arity.
-#
-# To test:
-#
-#   <%= project_name %> completion
-#   <%= project_name %> completion hello
-#   <%= project_name %> completion hello name
-#   <%= project_name %> completion hello name --
-#   <%= project_name %> completion hello name --noop
-#
-#   <%= project_name %> completion
-#   <%= project_name %> completion sub:goodbye
-#   <%= project_name %> completion sub:goodbye name
-#
-# Note when testing, the first top-level word must be an exact match
-#
-#   <%= project_name %> completion hello # works fine
-#   <%= project_name %> completion he # incomplete, this will just break
-#
-# The completion assumes that the top-level word that is being passed in
-# from completor/scripts.sh will always match exactly.  This must be the
-# case.  For parameters, the word does not have to match exactly.
-#
-module <%= project_class_name %>
+=begin
+Code Explanation:
+
+There are 3 types of things to auto-complete:
+
+  1. command: the command itself
+  2. parameters: command parameters.
+  3. options: command options
+
+Here's an example:
+
+  mycli hello name --from me
+
+  * command: hello
+  * parameters: name
+  * option: --from
+
+When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
+
+## Arity
+
+For example, say you had a method for a CLI command with the following form:
+
+  ufo scale service count --cluster development
+
+It's equivalent ruby method:
+
+  scale(service, count) = has an arity of 2
+
+So typing:
+
+  ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.
+
+So the completion should only show options, something like this:
+
+  --noop --verbose --cluster
+
+## Splat Arguments
+
+When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
+
+   ship(service) = 1
+   scale(service, count) = 2
+   ships(*services) = -1
+   foo(example, *rest) = -2
+
+Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
+
+Here are some test cases, hit TAB after typing the command:
+
+  <%= project_name %> completion
+  <%= project_name %> completion hello
+  <%= project_name %> completion hello name
+  <%= project_name %> completion hello name --
+  <%= project_name %> completion hello name --noop
+
+  <%= project_name %> completion
+  <%= project_name %> completion sub:goodbye
+  <%= project_name %> completion sub:goodbye name
+
+## Subcommands and Thor::Group Registered Commands
+
+Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.
+
+  * regular command: ufo ship
+  * subcommand: ufo docker
+  * Thor::Group command: ufo init
+
+Auto-completion accounts for each of these type of commands.
+=end
+module Ufo
   class Completer
     autoload :Script, '<%= underscored_name %>/completer/script'
 
@@ -79,10 +94,10 @@ module <%= project_class_name %>
 
       # will only get to here if command aws found (above)
       arity = @command_class.instance_method(@current_command).arity.abs
-      if @params.size <= arity
-        puts params_completion
-      else
+      if @params.size > arity or thor_group_command?
         puts options_completion
+      else
+        puts params_completion
       end
     end
 
@@ -90,8 +105,13 @@ module <%= project_class_name %>
       @command_class.subcommands.include?(command)
     end
 
+    # hacky way to detect that command is a registered Thor::Group command
+    def thor_group_command?
+      command_params(raw=true) == [[:rest, :args]]
+    end
+
     def found?(command)
-      public_methods = @command_class.public_instance_methods - Object.methods
+      public_methods = @command_class.public_instance_methods(false)
       command && public_methods.include?(command.to_sym)
     end
 
@@ -103,17 +123,19 @@ module <%= project_class_name %>
       commands.keys
     end
 
-    def params_completion
-      method_params = @command_class.instance_method(@current_command).parameters
+    def command_params(raw=false)
+      params = @command_class.instance_method(@current_command).parameters
       # Example:
       # >> Sub.instance_method(:goodbye).parameters
       # => [[:req, :name]]
       # >>
-      method_params.map!(&:last)
+      raw ? params : params.map!(&:last)
+    end
 
+    def params_completion
       offset = @params.size - 1
-      offset_params = method_params[offset..-1]
-      method_params[offset..-1].first
+      offset_params = command_params[offset..-1]
+      command_params[offset..-1].first
     end
 
     def options_completion

data/lib/templates/default/spec/spec_helper.rb.tt

@@ -9,7 +9,7 @@ require "byebug"
 root = File.expand_path("../", File.dirname(__FILE__))
 require "#{root}/lib/<%= project_name %>"
 
-module Helpers
+module Helper
   def execute(cmd)
     puts "Running: #{cmd}" if show_command?
     out = `#{cmd}`
@@ -25,5 +25,5 @@ module Helpers
 end
 
 RSpec.configure do |c|
-  c.include Helpers
+  c.include Helper
 end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require "pp"
 root = File.expand_path('../../', __FILE__)
 require "#{root}/lib/cli-template"
 
-module Helpers
+module Helper
   def execute(cmd)
     puts "Running: #{cmd}" if show_command?
     out = `#{cmd}`
@@ -25,7 +25,7 @@ module Helpers
 end
 
 RSpec.configure do |c|
-  c.include Helpers
+  c.include Helper
   c.before(:all) do
     FileUtils.rm_rf("tmp")
     FileUtils.mkdir_p("tmp")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-template
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate a CLI tool quickly
+description: 
 email:
 - tongueroo@gmail.com
 executables:
@@ -160,7 +160,7 @@ files:
 - lib/cli-template/command.rb
 - lib/cli-template/help.rb
 - lib/cli-template/help/new.md
-- lib/cli-template/helpers.rb
+- lib/cli-template/helper.rb
 - lib/cli-template/new.rb
 - lib/cli-template/sequence.rb
 - lib/cli-template/version.rb