cli-template 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cec11731996364ad6e192824c457ce0800423eb72ac4782bdf72bfb8fd32155
-  data.tar.gz: 8a5748d23604d64f35a5ecc98d6fbf1610cde7ac848c8480be36629d4dd3d5b3
+  metadata.gz: ebf247e389131d796f851f63170b372317765995899ac852510ae2e08d6807b7
+  data.tar.gz: c6c607ea96e976aaa38791f1d4a16a3630f6ae2ef3a548093f6305cb69a9fba1
 SHA512:
-  metadata.gz: 1ad85e072ea3ca0c17b63c568034d0d962b3d12baa8c848efa585c6d21aa3bd8c49c2f6305ca73fd63002fbafd1a7c600037e0952419336ffcf2420562ffcc36
-  data.tar.gz: 33a433e8b3b050a39f9fd11563d6c12843e7979d18a0f0401a5d1b61813e6dd419cb6b0f6fd57a1d18ed1328c045f2ded87968a061915787940211d6e9fdcaa4
+  metadata.gz: ba5b206f2bfd776d993e00bc78ff39b539a70505082992af8935985ae76b6b67d17fd92913c9a997f460bd6578562b7b87c78b3ccaa5a031492842f5afe095ac
+  data.tar.gz: e23520496b7e64d9c6563c9dd9a5b57ab921f5c069ea25a6c314047f4084785e96dfa6a81aa66401f8443414f84fbf79f56ec8f6ad6e516d8142be2033944eb3

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.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
+
 ## [3.1.0]
 - Merge pull request #1 from tongueroo/completions: support for TAB auto-completion
 - add completions command to starter project

data/README.md

@@ -3,17 +3,22 @@
 [![CircleCI](https://circleci.com/gh/tongueroo/cli-template.svg?style=svg)](https://circleci.com/gh/tongueroo/cli-template)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6c4f26aaafccab10baf/maintainability)](https://codeclimate.com/github/tongueroo/cli-template/maintainability)
 
-`cli-template` is a generator tool that builds a starter CLI project based on [Thor](http://whatisthor.com/). It is the successor tool to [thor_template](https://github.com/tongueroo/thor_template), which is also a tool that generates CLI projects.  The main difference is `cli-template` uses colons for namespaced commands.  The usage section demonstrates a namespaced command below.
+`cli-template` is a generator tool that builds a starter CLI project based on [Thor](http://whatisthor.com/). It is the successor tool to [thor_template](https://github.com/tongueroo/thor_template), which is also a tool that generates CLI projects.
 
 The predecessor tool is covered in this original blog post, [Build Thor CLI Project in Under a Second](https://blog.boltops.com/2017/09/14/build-thor-cli-project-in-under-a-second). It covers usage and also contains a video demo.  An updated blog post will eventually be made, for now, refer to the original blog post.
 
+The generated CLI project comes with:
+
+* example passing specs
+* auto-completion
+
 ## Usage
 
 ```sh
 cli-template new mycli
 cd mycli
 exe/mycli hello world
-exe/mycli sub:goodbye world
+exe/mycli sub:goodbye world # namespaced command with colons
 ```
 
 The above generated a starter CLI project called `mycli` with a working hello command.  The created project also has starter specs for you 😁
@@ -45,13 +50,47 @@ rake release
 
 When installed as a gem, you no longer have to prepend exe in front of the command.  For example, `exe/mycli` becomes the `mycli` command.
 
+## Different starter templates
+
+There are 2 different templates that the tool generates from:
+
+1. basic thor project: A standard CLI tool based on basic usage of Thor.
+2. colon namespaced project: The generated CLI project still uses Thor but it does some manipulation in order to allow defining namespaced methods with colons instead of spaces.  Example: `mycli sub:command` vs `mycli sub command`.
+
+To use the different templates:
+
+```
+TEMPLATE=colon_namespaces cli-template new mycli
+TEMPLATE=default cli-template new mycli
+cli-template new mycli # same as TEMPLATE=default
+```
+
 ## Auto Completion
 
-The generated CLI tool supports TAB auto-completion.  To enable auto, you can add this to your `~/.bashrc` or `~/.profile`:
+There is support for TAB completion in the newly generated CLI project for the default template.  To enable auto completion, add this to `~/.bashrc` or `~/.profile`:
+
+    eval $(mycli completion_script)
+
+Remember to re-load the shell. Note, the auto completion will only work if the cli command is avaialble in your PATH.  You can do this by installing the gem.  You can also create a wrapper bash script that calls to your development cli command like so:
+
+```
+cat > /usr/local/bin/mycli << 'EOL'
+#!/bin/bash
+exec ~/src/mycli/exe/mycli "$@"
+EOL
+chmod a+x /usr/local/bin/mycli
+```
+
+### Experimental Auto Completion Support for colon_namespaces Template
+
+The auto-completion for the colon_namespaces template CLI project is experimental. Ran into a few issues:
 
-  eval $(mycli completions:script)
+1. Slow as to make auto-completion useless. This because the generated CLI invokes autoloading when it detects the methods for the completion words. Ideas on speeding this would be appreciated! Right now it takes about 1 second.
+2. Does not work with colons currently.  Will have to look into this post [Bash Command-Line Tab Completion Colon Character
+](https://stackoverflow.com/questions/25362968/bash-command-line-tab-completion-colon-character).
+3. Does not work with the last two characters are `--`.
 
-Remember to re-load your shell. Note, the auto completion will only work once you tool is installed and it's binary is avaialble in your PATH.
+Suggestions to are appreciated!
 
 ## Installation
 

data/lib/cli-template/helpers.rb

@@ -9,4 +9,7 @@ module CliTemplate::Helpers
   def underscored_name
     project_name.underscore
   end
+
+  # project_name is also available from new.rb:
+  #   argument :project_name
 end

data/lib/cli-template/sequence.rb

@@ -9,7 +9,8 @@ class CliTemplate::Sequence < Thor::Group
   include CliTemplate::Helpers
 
   def self.source_root
-    File.expand_path("../../templates/default", __FILE__)
+    template = ENV['TEMPLATE'] || 'default'
+    File.expand_path("../../templates/#{template}", __FILE__)
   end
 
 private
@@ -27,9 +28,9 @@ private
   end
 
   def confirm_cli_project
-    jets_project = File.exist?("#{project_name}/config/application.rb")
-    unless jets_project
-      puts "It does not look like the repo #{options[:repo]} is a jets project. Maybe double check that it is?  Exited.".colorize(:red)
+    cli_project = File.exist?("#{project_name}/config/application.rb")
+    unless cli_project
+      puts "It does not look like the repo #{options[:repo]} is a cli project. Maybe double check that it is?  Exited.".colorize(:red)
       exit 1
     end
   end

data/lib/cli-template/version.rb

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

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

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "<%= underscored_name %>/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= project_name %>"
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+  spec.add_dependency "rake"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec"
+end

data/lib/templates/colon_namespaces/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+doc/
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/lib/templates/colon_namespaces/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/lib/templates/colon_namespaces/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+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.
+
+## [0.1.0]
+- Initial release.

data/lib/templates/colon_namespaces/Gemfile.tt

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem dependencies in <%= project_name %>.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/lib/templates/colon_namespaces/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/lib/templates/colon_namespaces/LICENSE.txt.tt

@@ -0,0 +1,22 @@
+Copyright (c) <%= Time.now.strftime("%Y") %> Tung Nguyen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/templates/colon_namespaces/README.md.tt

@@ -0,0 +1,47 @@
+# <%= project_class_name %>
+
+[![Gem Version](https://badge.fury.io/rb/GEMNAME.png)](http://badge.fury.io/rb/GEMNAME)
+[![CircleCI](https://circleci.com/gh/USER/REPO.svg?style=svg)](https://circleci.com/gh/USER/REPO)
+[![Dependency Status](https://gemnasium.com/USER/REPO.png)](https://gemnasium.com/USER/REPO)
+[![Coverage Status](https://coveralls.io/repos/USER/REPO/badge.png)](https://coveralls.io/r/USER/REPO)
+[![Join the chat at https://gitter.im/USER/REPO](https://badges.gitter.im/USER/REPO.svg)](https://gitter.im/USER/REPO?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Support](https://img.shields.io/badge/get-support-blue.svg)](https://boltops.com?utm_source=badge&utm_medium=badge&utm_campaign=cli-template)
+
+TODO: Write a gem description
+
+## Usage
+
+```sh
+<%= project_name %> hello yourname
+<%= project_name %> sub:goodbye yourname
+```
+
+The CLI tool also detects and tasks in the current folder's Rakefile and delegate to those tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```sh
+gem "<%= project_name %>"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install <%= project_name %>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/templates/colon_namespaces/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new

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

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "<%= project_name %>"
+require "<%= underscored_name %>/cli"
+
+<%= project_class_name %>::CLI.start(ARGV)

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

@@ -0,0 +1,12 @@
+$:.unshift(File.expand_path("../", __FILE__))
+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 :Completer, "<%= underscored_name %>/completer"
+end

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

@@ -0,0 +1,166 @@
+require "thor"
+require "active_support" # for autoload
+require "active_support/core_ext"
+
+module <%= project_class_name %>
+  class 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(':')
+      end
+    end
+
+    def meth
+      return nil unless full_command
+
+      if full_command.include?(':')
+        full_command.split(':').pop
+      else
+        full_command
+      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
+      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 Help.text(:main) + "\n"
+    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
+      end
+    end
+
+    def show_all_tasks
+      @given_args.include?("--all") || @given_args.include?("-A")
+    end
+  end
+end