cli-template 3.1.0 → 3.2.0

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

@@ -0,0 +1,29 @@
+ENV["TEST"] = "1"
+
+# CodeClimate test coverage: https://docs.codeclimate.com/docs/configuring-test-coverage
+# require 'simplecov'
+# SimpleCov.start
+
+require "pp"
+
+root = File.expand_path("../../", __FILE__)
+require "#{root}/lib/<%= project_name %>"
+
+module Helpers
+  def execute(cmd)
+    puts "Running: #{cmd}" if show_command?
+    out = `#{cmd}`
+    puts out if show_command?
+    out
+  end
+
+  # Added SHOW_COMMAND because DEBUG is also used by other libraries like
+  # bundler and it shows its internal debugging logging also.
+  def show_command?
+    ENV['DEBUG'] || ENV['SHOW_COMMAND']
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

data/lib/templates/default/.gitignore

@@ -3,10 +3,10 @@
 .bundle
 .config
 .yardoc
-InstalledFiles
 _yardoc
 coverage
 doc/
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc

data/lib/templates/default/Gemfile.lock.tt

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    <%= project_name %> (0.1.0)
+      activesupport
+      colorize
+      rake
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (0.9.4)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  codeclimate-test-reporter
+  <%= project_name %>!
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/lib/templates/default/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tung Nguyen
+Copyright (c) 2018 Tung Nguyen
 
 MIT License
 

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

@@ -4,9 +4,8 @@ require "<%= underscored_name %>/version"
 module <%= project_class_name %>
   autoload :Help, "<%= underscored_name %>/help"
   autoload :Command, "<%= underscored_name %>/command"
-  autoload :RakeCommand, "<%= underscored_name %>/rake_command"
   autoload :CLI, "<%= underscored_name %>/cli"
   autoload :Sub, "<%= underscored_name %>/sub"
-  autoload :Completions, "<%= underscored_name %>/completions"
+  autoload :Completion, "<%= underscored_name %>/completion"
   autoload :Completer, "<%= underscored_name %>/completer"
 end

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

@@ -1,176 +1,35 @@
-require "thor"
-require "active_support" # for autoload
-require "active_support/core_ext"
+module <%= project_class_name %>
+  class CLI < Command
+    class_option :verbose, type: :boolean
+    class_option :noop, type: :boolean
 
-class <%= project_class_name %>::CLI
-  def self.start(given_args=ARGV)
-    new(given_args).start
-  end
-
-  def self.thor_tasks
-    <%= project_class_name %>::Command.namespaced_commands
-  end
-
-  def initialize(given_args=ARGV, **config)
-    @given_args = given_args.dup
-    @config = config
-  end
-
-  def start
-    setup_auto_load
-    command_class = lookup(full_command)
-    if command_class
-      command_class.perform(full_command, thor_args)
-    else
-      main_help
-    end
-  end
-
-  def setup_auto_load
-    autoload_paths = [File.expand_path("../../", __FILE__)]
-    ActiveSupport::Dependencies.autoload_paths += autoload_paths
-  end
-
-  # thor_args normalized the args Array to work with our Thor command
-  # subclasses.
-  # 1. The namespace is stripped
-  # 2. The help is shifted in front if a help flag is detected
-  def thor_args
-    args = @given_args.clone
-
-    # Allow calling for help via:
-    #   cli-template command help
-    #   cli-template command -h
-    #   cli-template command --help
-    #   cli-template command -D
-    #
-    # as well thor's normal way:
-    #
-    #   cli-template help command
-    help_args = args & help_flags
-    if help_args.empty?
-      args[0] = meth # reassigns the command without the namespace
-    else
-      # Allow using help flags at the end of the command to trigger help menu
-      args -= help_flags # remove "help" and help flags from args
-      args[0] = meth # first command will always be the meth now since
-        # we removed the help flags
-      args.unshift("help")
-    end
-    args.compact
-  end
-
-  def full_command
-    # Removes any args that starts with -, those are option args.
-    # Also remove "help" flag.
-    args = @given_args.reject {|o| o =~ /^-/ } - help_flags
-    command = args[0] # first argument should always be the command
-    <%= project_class_name %>::Command.autocomplete(command)
-  end
-
-  # 1. look up Thor tasks
-  # 2. look up Rake tasks - currently disabled
-  # 3. help menu with all commands when both Thor and Rake tasks are not found
-  #
-  # Example:
-  #
-  #   lookup("sub:hello") => Sub
-  def lookup(full_command)
-    thor_task_found = <%= project_class_name %>::Command.namespaced_commands.include?(full_command)
-    if thor_task_found
-      return <%= project_class_name %>::Command.klass_from_namespace(namespace)
-    end
-
-    rake_task_found = <%= project_class_name %>::RakeCommand.namespaced_commands.include?(full_command)
-    if rake_task_found
-      return <%= project_class_name %>::RakeCommand
-    end
-  end
-
-  def version_flags
-    ["--version", "-v"]
-  end
-
-  # ["-h", "-?", "--help", "-D", "help"]
-  def help_flags
-    Thor::HELP_MAPPINGS + ["help"]
-  end
-
-  def namespace
-    return nil unless full_command
-
-    if full_command.include?(':')
-      words = full_command.split(':')
-      words.pop
-      words.join(':')
+    desc "hello NAME", "say hello to NAME"
+    long_desc Help.text(:hello)
+    option :from, desc: "from person"
+    def hello(name="you")
+      puts "from: #{options[:from]}" if options[:from]
+      puts "Hello #{name}"
     end
-  end
 
-  def meth
-    return nil unless full_command
+    desc "sub SUBCOMMAND", "sub subcommands"
+    long_desc Help.text(:sub)
+    subcommand "sub", Sub
 
-    if full_command.include?(':')
-      full_command.split(':').pop
-    else
-      full_command
+    desc "completion *PARAMS", "prints words for auto-completion"
+    long_desc Help.text("completion")
+    def completion(*params)
+      Completer.new(CLI, *params).run
     end
-  end
-
-  # Allow calling version via:
-  #   <%= project_name %> version
-  #   <%= project_name %> --version
-  #   <%= project_name %> -v
-  def version_flag?
-    args = @given_args
-    args.length == 1 && !(args & version_flags).empty?
-  end
 
-  def main_help
-    if version_flag?
-      <%= project_class_name %>::Main.perform("version", ["version"])
-      return
+    desc "completion_script", "generates script that can be eval to setup auto-completion", hide: true
+    long_desc Help.text("completion_script")
+    def completion_script
+      Completer::Script.generate
     end
 
-    shell = Thor::Shell::Basic.new
-    shell.say "Commands:"
-    shell.print_table(thor_list, :indent => 2, :truncate => true)
-
-    # TODO: commenting out for now, feels weird to show the rake tasks
-    # automatically also by default. Maybe add an option for this.
-    # unless rake_list.empty?
-    #   shell.say "\nCommands via rake:"
-    #   shell.print_table(rake_list, :indent => 2, :truncate => true)
-    # end
-
-    shell.say "\n"
-    shell.say main_help_body
-  end
-
-  def thor_list
-    <%= project_class_name %>::Command.help_list(show_all_tasks)
-  end
-
-  def rake_list
-    list = <%= project_class_name %>::RakeCommand.formatted_rake_tasks(show_all_tasks)
-    list.map do |array|
-      array[0] = "<%= project_name %> #{array[0]}"
-      array
+    desc "version", "prints version"
+    def version
+      puts VERSION
     end
   end
-
-  def show_all_tasks
-    @given_args.include?("--all") || @given_args.include?("-A")
-  end
-
-  def main_help_body
-    <<-EOL
-Add -h to any of the commands for more help.  Examples:
-
-  <%= project_name %> hello -h
-  <%= project_name %> version
-  <%= project_name %> -h
-
-EOL
-  end
-
 end

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

@@ -1,6 +1,4 @@
 require "thor"
-require "active_support" # for autoload
-require "active_support/core_ext"
 
 # Override thor's long_desc identation behavior
 # https://github.com/erikhuda/thor/issues/398
@@ -18,159 +16,31 @@ end
 module <%= project_class_name %>
   class Command < Thor
     class << self
-      # thor_args is an array of commands. Examples:
-      #   ["help"]
-      #   ["dynamodb:migrate"]
-      #
-      # Same signature as RakeCommand.perform.  Signature is a little weird
-      # with some repetition.  Examples:
-      #
-      #   <%= project_class_name %>::Main.perform("hello", ["hello"])
-      #   <%= project_class_name %>::Main.perform("dynamodb:migrate", ["migrate"])
-      #
-      def perform(full_command, thor_args)
-        config = {} # doesnt seem like config is used
-        dispatch(nil, thor_args, nil, config)
-      end
-
-      # Track all command subclasses.
-      def subclasses
-        @subclasses ||= []
-      end
-
-      def inherited(base)
-        super
-
-        if base.name
-          self.subclasses << base
-        end
-      end
-
-      # Useful for help menu when we need to have all the definitions loaded.
-      # Using constantize instead of require so we dont care about
-      # order. The eager load actually uses autoloading.
-      def eager_load!
-        path = File.expand_path("../../", __FILE__)
-        Dir.glob("#{path}/**/*.rb").select do |path|
-          next if !File.file?(path)
-
-          class_name = path
-                        .sub(/\.rb$/,'')
-                        .sub(%r{.*/lib/},'')
-                        .classify
-
-          if class_name.include?('-')
-            puts "WARN: Unable to autoload a class with a dash in the name" if debug?
-            next
-          end
-
-          class_name = class_map[class_name] || class_name
-
-          puts "eager_load! loading path: #{path} class_name: #{class_name}" if debug?
-          class_name.constantize # dont have to worry about order.
-        end
-      end
-
-      # Special class mapping cases. This is because ActiveSupport's autoloading
-      # forces a specific naming convention.
-      def class_map
-        map = {
-          "<%= project_class_name %>::Cli" => "<%= project_class_name %>::CLI",
-          "<%= project_class_name %>::Version" => "<%= project_class_name %>::VERSION",
-          "<%= project_class_name %>::Completion" => "<%= project_class_name %>::Completions",
-        }
-        map.merge(additional_class_map)
-        map
-      end
-
-      # Override this if you need add addtional class mappings.
-      def additional_class_map
-        {}
-      end
-
-      # Fully qualifed task names. Examples:
-      #   hello
-      #   sub:goodbye
-      def namespaced_commands
-        eager_load!
-        subclasses.map do |klass|
-          klass.all_tasks.keys.map do |task_name|
-            klass = klass.to_s.sub('<%= project_class_name %>::','')
-            namespace = klass =~ /^Main/ ? nil : klass.underscore.gsub('/',':')
-            [namespace, task_name].compact.join(':')
-          end
-        end.flatten.sort
-      end
-
-      # Use <%= project_class_name %> banner instead of Thor to account for namespaces in commands.
-      def banner(command, namespace = nil, subcommand = false)
-        namespace = namespace_from_class(self)
-        command_name = command.usage # set with desc when defining tht Thor class
-        namespaced_command = [namespace, command_name].compact.join(':')
-
-        "<%= project_name %> #{namespaced_command}"
-      end
-
-      def namespace_from_class(klass)
-        namespace = klass.to_s.sub('<%= project_class_name %>::', '').underscore.gsub('/',':')
-        namespace unless namespace == "main"
-      end
-
-      def help_list(all=false)
-        # hack to show hidden comands when requested
-        Thor::HiddenCommand.class_eval do
-          def hidden?; false; end
-        end if all
-
-        list = []
-        eager_load!
-        subclasses.each do |klass|
-          commands = klass.printable_commands(true, false)
-          commands.reject! { |array| array[0].include?(':help') }
-          list += commands
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   <%= project_name %> command help
+        #   <%= project_name %> command -h
+        #   <%= project_name %> command --help
+        #   <%= project_name %> command -D
+        #
+        # as well thor's normal way:
+        #
+        #   <%= project_name %> help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
         end
 
-        list.sort_by! { |array| array[0] }
-      end
-
-      # Example:
-      #    klass_from_namespace(nil) => Main
-      #    klass_from_namespace("sub") => Sub
-      def klass_from_namespace(namespace)
-        if namespace.nil?
-          <%= project_class_name %>::Main
-        else
-          class_name = namespace.gsub(':','/')
-          class_name = "<%= project_class_name %>::#{class_name.classify}"
-          class_name = class_map[class_name] || class_name
-          class_name.constantize
+        #   <%= project_name %> version
+        #   <%= project_name %> --version
+        #   <%= project_name %> -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
         end
-      end
-
-      # If this fails to match then it'l just return the original full command
-      def autocomplete(full_command)
-        return nil if full_command.nil? # <%= project_name %> help
-
-        eager_load!
-
-        words = full_command.split(':')
-        namespace = words[0..-2].join(':') if words.size > 1
-        command = words.last
 
-        # Thor's normalize_command_name autocompletes the command but then we need to add the namespace back
-        begin
-          thor_subclass = klass_from_namespace(namespace) # could NameError
-          command = thor_subclass.normalize_command_name(command) # could Thor::AmbiguousCommandError
-          [namespace, command].compact.join(':')
-        rescue NameError
-          full_command # return original full_command
-        rescue Thor::AmbiguousCommandError => e
-          full_command # return original full_command
-        end
-      end
-
-      def debug?
-        ENV['DEBUG'] && !ENV['TEST']
+        super
       end
     end
   end