cli-template 3.0.0

data/lib/cli-template/sequence.rb

@@ -0,0 +1,45 @@
+require 'fileutils'
+require 'colorize'
+require 'active_support/core_ext/string'
+require 'thor'
+require 'bundler'
+
+class CliTemplate::Sequence < Thor::Group
+  include Thor::Actions
+  include CliTemplate::Helpers
+
+  def self.source_root
+    File.expand_path("../../templates/skeleton", __FILE__)
+  end
+
+private
+  def clone_project
+    unless git_installed?
+      abort "Unable to detect git installation on your system.  Git needs to be installed in order to use the --repo option."
+    end
+
+    if File.exist?(project_name)
+      abort "The folder #{project_name} already exists."
+    else
+      run "git clone https://github.com/#{options[:repo]} #{project_name}"
+    end
+    confirm_cli_project
+  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)
+      exit 1
+    end
+  end
+
+  def copy_project
+    puts "Creating new project called #{project_name}."
+    directory ".", project_name
+  end
+
+  def git_installed?
+    system("type git > /dev/null")
+  end
+end

data/lib/cli-template/version.rb

@@ -0,0 +1,3 @@
+module CliTemplate
+  VERSION = "3.0.0"
+end

data/lib/templates/skeleton/%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/skeleton/.gitignore

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

data/lib/templates/skeleton/.rspec

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

data/lib/templates/skeleton/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/skeleton/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/skeleton/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/skeleton/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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/skeleton/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/skeleton/Rakefile

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

data/lib/templates/skeleton/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/skeleton/lib/%project_name%.rb.tt

@@ -0,0 +1,10 @@
+$:.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"
+end

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

@@ -0,0 +1,170 @@
+require "thor"
+require "active_support" # for autoload
+require "active_support/core_ext"
+
+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 stripe
+  # 2. 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
+  # 3. help menu with all commands when both Thor and Rake tasks are not found
+  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)
+
+    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
+    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/skeleton/lib/%underscored_name%/command.rb.tt

@@ -0,0 +1,164 @@
+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
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+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.  Not using full_command.
+      #
+      # To call a thor task via ruby.
+      # Signature is a little weird with the 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
+
+          # special mapping cases
+          special_cases = {
+            "<%= project_class_name %>::Cli" => "<%= project_class_name %>::CLI",
+            "<%= project_class_name %>::Version" => "<%= project_class_name %>::VERSION",
+          }
+          class_name = special_cases[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
+
+      # Fully qualifed task names. Examples:
+      #   build
+      #   process:controller
+      #   dynamodb:migrate:down
+      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
+        end
+
+        list.sort_by! { |array| array[0] }
+      end
+
+      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.constantize
+        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']
+      end
+    end
+  end
+end