cli-template 3.1.0 → 3.2.0

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

@@ -1,29 +1,29 @@
 # Code Explanation.  This is mainly focused on the run method.
 #
-# There are 3 main branches of logic for completions:
+# There are 3 main branches of logic for completion:
 #
 #   1. top-level commands - when there are zero completed words
-#   2. params completions - when a command has some required params
-#   3. options completions - when we have finished auto-completing the top-level command and required params, the rest of the completion words will be options
+#   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 completions 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:
+# 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 completions will be something like:
+# 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 completions. When the ruby method has a splat param, it's arity will be negative.  Here are some example methods and their arities.
+# 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
@@ -34,22 +34,22 @@
 #
 # To test:
 #
-#   <%= project_name %> completions
-#   <%= project_name %> completions hello
-#   <%= project_name %> completions hello name
-#   <%= project_name %> completions hello name --
-#   <%= project_name %> completions hello name --noop
+#   <%= 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 %> completions
-#   <%= project_name %> completions sub:goodbye
-#   <%= project_name %> completions sub:goodbye name
+#   <%= 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 %> completions hello # works fine
-#   <%= project_name %> completions he # incomplete, this will just break
+#   <%= project_name %> completion hello # works fine
+#   <%= project_name %> completion he # incomplete, this will just break
 #
-# The completions assumes that the top-level word that is being passed in
+# 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.
 #
@@ -57,56 +57,54 @@ module <%= project_class_name %>
   class Completer
     autoload :Script, '<%= underscored_name %>/completer/script'
 
-    def initialize(*params)
+    def initialize(command_class, *params)
       @params = params
+      @current_command = @params[0]
+      @command_class = command_class # CLI initiall
     end
 
-    def current_command
-      @params[0]
-    end
-
-    # Example: sub:goodbye => "sub"
-    def namespace
-      return nil unless current_command
-
-      if current_command.include?(':')
-        words = current_command.split(':')
-        words.pop
-        words.join(':')
+    def run
+      if subcommand?(@current_command)
+        subcommand_class = @command_class.subcommand_classes[@current_command]
+        @params.shift # destructive
+        Completer.new(subcommand_class, *@params).run # recursively use subcommand
+        return
       end
-    end
-
-    # Example: sub:goodbye => "goodbye"
-    def trailing_command
-      current_command.split(':').last
-    end
 
-    def run
-      if @params.size == 0
+      # full command has been found!
+      unless found?(@current_command)
         puts all_commands
         return
       end
 
-      # will only get to here if the top-level command has been fully auto-completed.
-      arity = command_class.instance_method(trailing_command).arity.abs
+      # 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_completions(current_command)
+        puts params_completion
       else
-        puts options_completions(current_command)
+        puts options_completion
       end
     end
 
+    def subcommand?(command)
+      @command_class.subcommands.include?(command)
+    end
+
+    def found?(command)
+      public_methods = @command_class.public_instance_methods - Object.methods
+      command && public_methods.include?(command.to_sym)
+    end
+
     # all top-level commands
     def all_commands
-      # Interesing, extra :help commands show up here but no whne using
-      # <%= project_class_name %>::Command.help_list in main_help -> thor_list
-      # We'll filter out :help for auto-completion.
-      commands = <%= project_class_name %>::Command.namespaced_commands
-      commands.reject { |c| c =~ /:help$/ }
+      commands = @command_class.all_commands.reject do |k,v|
+        v.is_a?(Thor::HiddenCommand)
+      end
+      commands.keys
     end
 
-    def params_completions(current_command)
-      method_params = command_class.instance_method(trailing_command).parameters
+    def params_completion
+      method_params = @command_class.instance_method(@current_command).parameters
       # Example:
       # >> Sub.instance_method(:goodbye).parameters
       # => [[:req, :name]]
@@ -118,21 +116,24 @@ module <%= project_class_name %>
       method_params[offset..-1].first
     end
 
-    def options_completions(current_command)
+    def options_completion
       used = ARGV.select { |a| a.include?('--') } # so we can remove used options
 
-      method_options = command_class.all_commands[trailing_command].options.keys
-      class_options = command_class.class_options.keys
+      method_options = @command_class.all_commands[@current_command].options.keys
+      class_options = @command_class.class_options.keys
 
-      all_options = method_options + class_options
+      all_options = method_options + class_options + ['help']
 
-      all_options.map! { |o| "--#{o.to_s.dasherize}" }
+      all_options.map! { |o| "--#{o.to_s.gsub('_','-')}" }
       filtered_options = all_options - used
-      filtered_options
+      filtered_options.uniq
     end
 
-    def command_class
-      @command_class ||= <%= project_class_name %>::Command.klass_from_namespace(namespace)
+    # Useful for debugging. Using puts messes up completion.
+    def log(msg)
+      File.open("/tmp/complete.log", "a") do |file|
+        file.puts(msg)
+      end
     end
   end
 end

data/lib/templates/default/lib/%underscored_name%/completer/script.sh.tt

@@ -1,16 +1,10 @@
 _<%= project_name %>() {
   COMPREPLY=()
   local word="${COMP_WORDS[COMP_CWORD]}"
-
-  if [ "$COMP_CWORD" -eq 1 ]; then
-    local completions=$(<%= project_name %> completions)
-    COMPREPLY=( $(compgen -W "$completions" -- "$word") )
-  else
-    local words=("${COMP_WORDS[@]}")
-    unset words[0]
-    local completions=$(<%= project_name %> completions ${words[@]})
-    COMPREPLY=( $(compgen -W "$completions" -- "$word") )
-  fi
+  local words=("${COMP_WORDS[@]}")
+  unset words[0]
+  local completion=$(<%= project_name %> completion ${words[@]})
+  COMPREPLY=( $(compgen -W "$completion" -- "$word") )
 }
 
 complete -F _<%= project_name %> <%= project_name %>

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

@@ -0,0 +1,15 @@
+module <%= project_class_name %>
+  class Completion < Command
+    desc "script", "generates script that can be eval to setup auto-completion"
+    long_desc Help.text("completion:script")
+    def script
+      Completer::Script.generate
+    end
+
+    desc "completions *PARAMS", "prints words for auto-completion"
+    long_desc Help.text("completion:list")
+    def list(*params)
+      Completer.new(*params).run
+    end
+  end
+end

data/lib/templates/default/lib/%underscored_name%/help/completion.md.tt

@@ -0,0 +1,22 @@
+Example:
+
+  <%= project_name %> completion
+
+Prints words for TAB auto-completion.
+
+Examples:
+
+  <%= project_name %> completion
+  <%= project_name %> completion hello
+  <%= project_name %> completion hello name
+
+To enable, TAB auto-completion add the following to your profile:
+
+  eval $(<%= project_name %> completion script)
+
+Auto-completion example usage:
+
+  <%= project_name %> [TAB]
+  <%= project_name %> hello [TAB]
+  <%= project_name %> hello name [TAB]
+  <%= project_name %> hello name --[TAB]

data/lib/templates/default/lib/%underscored_name%/help/completion_script.md.tt

@@ -0,0 +1,3 @@
+To use, add the following to your ~/.bashrc or ~/.profile
+
+  eval $(<%= project_name %> completion script)

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

@@ -12,26 +12,27 @@ describe <%= project_class_name %>::CLI do
     end
 
     it "goodbye" do
-      out = execute("exe/<%= project_name %> sub:goodbye world #{@args}")
+      out = execute("exe/<%= project_name %> sub goodbye world #{@args}")
       expect(out).to include("from: Tung\nGoodbye world")
     end
 
-    it "completions" do
-      out = execute("exe/<%= project_name %> completions")
-      expect(out).to include("hello")
-      expect(out).to include("sub:goodbye")
-
-      out = execute("exe/<%= project_name %> completions hello")
-      expect(out).to include("name")
-
-      out = execute("exe/<%= project_name %> completions hello name")
-      expect(out).to include("--from")
-
-      out = execute("exe/<%= project_name %> completions sub:goodbye")
-      expect(out).to include("name")
-
-      out = execute("exe/<%= project_name %> completions sub:goodbye name")
-      expect(out).to include("--from")
+    commands = {
+      "hell" => "hello",
+      "hello" => "name",
+      "hello -" =>  "--from",
+      "hello name" => "--from",
+      "hello name --" => "--from",
+      "sub goodb" => "goodbye",
+      "sub goodbye" => "name",
+      "sub goodbye name" => "--from",
+      "sub goodbye name --" => "--from",
+      "sub goodbye name --from" => "--help",
+    }
+    commands.each do |command, expected_word|
+      it "completion #{command}" do
+        out = execute("exe/<%= project_name %> completion #{command}")
+        expect(out).to include(expected_word) # only checking for one word for simplicity
+      end
     end
   end
 end

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

@@ -5,8 +5,8 @@ ENV["TEST"] = "1"
 # SimpleCov.start
 
 require "pp"
-
-root = File.expand_path("../../", __FILE__)
+require "byebug"
+root = File.expand_path("../", File.dirname(__FILE__))
 require "#{root}/lib/<%= project_name %>"
 
 module Helpers

data/spec/lib/cli_spec.rb

@@ -12,49 +12,60 @@ require 'spec_helper'
 #
 # Because it shells out tests take about 20 seconds to run this spec file.
 describe CliTemplate::CLI do
-  before(:all) do
-    @args = "--noop"
+  before(:each) do
+    FileUtils.rm_rf("tmp")
+    FileUtils.mkdir("tmp")
   end
 
-  describe "new" do
-    context("simple single name") do
-      it "should generate" do
-        out = execute("cd tmp && ../exe/cli-template new hello #{@args}")
-        expect(out).to include("Creating new project called hello")
-        expect(out).to include("You have successfully created a CLI project")
-        out = execute("cd tmp/hello && rake")
-        expect(out).to include("0 failures")
-      end
-    end
+  def create_new(name)
+    execute("cd tmp && ../exe/cli-template new #{name}")
+  end
 
-    context("underscored name") do
-      it "should generate" do
-        out = execute("cd tmp && ../exe/cli-template new my_cli #{@args}")
-        expect(out).to include("Creating new project called my_cli")
-        expect(out).to include("You have successfully created a CLI project")
-        out = execute("cd tmp/my_cli && rake")
-        expect(out).to include("0 failures")
-      end
-    end
+  templates = %w[default colon_namespaces]
+  templates.each do |template|
+    ENV['TEMPLATE'] = template
+    context("template #{template}") do
+      describe "cli-template new" do
+        context("simple single name") do
+          it "should generate new" do
+            out = create_new("hello")
+            expect(out).to include("Creating new project called hello")
+            expect(out).to include("You have successfully created a CLI project")
+            out = execute("cd tmp/hello && rake")
+            expect(out).to include("0 failures")
+          end
+        end
 
-    context("dasherized name") do
-      it "should generate" do
-        out = execute("cd tmp && ../exe/cli-template new my-cli #{@args}")
-        expect(out).to include("Creating new project called my-cli")
-        expect(out).to include("You have successfully created a CLI project")
-        out = execute("cd tmp/my-cli && rake")
-        expect(out).to include("0 failures")
-      end
-    end
+        context("underscored name") do
+          it "should generate my_cli" do
+            out = create_new("my_cli")
+            expect(out).to include("Creating new project called my_cli")
+            expect(out).to include("You have successfully created a CLI project")
+            out = execute("cd tmp/my_cli && rake")
+            expect(out).to include("0 failures")
+          end
+        end
+
+        context("dasherized name") do
+          it "should generate my-cli" do
+            out = create_new("my-cli")
+            expect(out).to include("Creating new project called my-cli")
+            expect(out).to include("You have successfully created a CLI project")
+            out = execute("cd tmp/my-cli && rake")
+            expect(out).to include("0 failures")
+          end
+        end
 
-    # CamelCase is ugly :(
-    context("simple CamelCase name") do
-      it "should generate" do
-        out = execute("cd tmp && ../exe/cli-template new MyCli #{@args}")
-        expect(out).to include("Creating new project called MyCli")
-        expect(out).to include("You have successfully created a CLI project")
-        out = execute("cd tmp/MyCli && rake")
-        expect(out).to include("0 failures")
+        # CamelCase is ugly :(
+        context("simple CamelCase name") do
+          it "should generate MyCli" do
+            out = create_new("MyCli")
+            expect(out).to include("Creating new project called MyCli")
+            expect(out).to include("You have successfully created a CLI project")
+            out = execute("cd tmp/MyCli && rake")
+            expect(out).to include("0 failures")
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-template
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2018-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -164,10 +164,40 @@ files:
 - lib/cli-template/new.rb
 - lib/cli-template/sequence.rb
 - lib/cli-template/version.rb
+- lib/templates/colon_namespaces/%project_name%.gemspec.tt
+- lib/templates/colon_namespaces/.gitignore
+- lib/templates/colon_namespaces/.rspec
+- lib/templates/colon_namespaces/CHANGELOG.md
+- lib/templates/colon_namespaces/Gemfile.tt
+- lib/templates/colon_namespaces/Guardfile
+- lib/templates/colon_namespaces/LICENSE.txt.tt
+- lib/templates/colon_namespaces/README.md.tt
+- lib/templates/colon_namespaces/Rakefile
+- lib/templates/colon_namespaces/exe/%project_name%.tt
+- lib/templates/colon_namespaces/lib/%project_name%.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/cli.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/command.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/completer.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/completer/script.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/completer/script.sh.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/completions.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help/completions.md.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help/completions/script.md.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help/hello.md.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help/main.md.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/help/sub/goodbye.md.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/main.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/rake_command.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/sub.rb.tt
+- lib/templates/colon_namespaces/lib/%underscored_name%/version.rb.tt
+- lib/templates/colon_namespaces/spec/lib/cli_spec.rb.tt
+- lib/templates/colon_namespaces/spec/spec_helper.rb.tt
 - lib/templates/default/%project_name%.gemspec.tt
 - lib/templates/default/.gitignore
 - lib/templates/default/.rspec
 - lib/templates/default/CHANGELOG.md
+- lib/templates/default/Gemfile.lock.tt
 - lib/templates/default/Gemfile.tt
 - lib/templates/default/Guardfile
 - lib/templates/default/LICENSE.txt
@@ -180,14 +210,12 @@ files:
 - lib/templates/default/lib/%underscored_name%/completer.rb.tt
 - lib/templates/default/lib/%underscored_name%/completer/script.rb.tt
 - lib/templates/default/lib/%underscored_name%/completer/script.sh.tt
-- lib/templates/default/lib/%underscored_name%/completions.rb.tt
+- lib/templates/default/lib/%underscored_name%/completion.rb.tt
 - lib/templates/default/lib/%underscored_name%/help.rb.tt
-- lib/templates/default/lib/%underscored_name%/help/completions.md.tt
-- lib/templates/default/lib/%underscored_name%/help/completions/script.md.tt
+- lib/templates/default/lib/%underscored_name%/help/completion.md.tt
+- lib/templates/default/lib/%underscored_name%/help/completion_script.md.tt
 - lib/templates/default/lib/%underscored_name%/help/hello.md.tt
 - lib/templates/default/lib/%underscored_name%/help/sub/goodbye.md.tt
-- lib/templates/default/lib/%underscored_name%/main.rb.tt
-- lib/templates/default/lib/%underscored_name%/rake_command.rb.tt
 - lib/templates/default/lib/%underscored_name%/sub.rb.tt
 - lib/templates/default/lib/%underscored_name%/version.rb.tt
 - lib/templates/default/spec/lib/cli_spec.rb.tt