cli-template 3.0.0

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

@@ -0,0 +1,9 @@
+module <%= project_class_name %>::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/templates/skeleton/lib/%underscored_name%/help/hello.md.tt

@@ -0,0 +1,3 @@
+Examples:
+
+  <%= project_name %> hello

data/lib/templates/skeleton/lib/%underscored_name%/help/sub/goodbye.md.tt

@@ -0,0 +1,3 @@
+Examples:
+
+  <%= project_name %> sub:goodbye

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

@@ -0,0 +1,21 @@
+require "thor"
+
+module <%= project_class_name %>
+  class Main < Command
+    class_option :verbose, type: :boolean
+    class_option :noop, type: :boolean
+
+    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
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require "rake"
+
+class <%= project_class_name %>::RakeCommand
+  class << self
+    # Same signature as <%= project_class_name %>::Command.perform.
+    def perform(namespaced_command, thor_args)
+      if thor_args.first == "help"
+        puts help_message(namespaced_command)
+        return
+      end
+
+      require_rake
+
+      ARGV.unshift(namespaced_command) # Prepend the task, so Rake knows how to run it.
+
+      rake.standard_exception_handling do
+        rake.init("<%= project_name %>")
+        rake.load_rakefile
+        rake.top_level
+      end
+    end
+
+    # Useful for CLI.lookup.
+    def namespaced_commands
+      formatted_rake_tasks(true).map(&:first)
+    end
+
+    def formatted_rake_tasks(all=false)
+      rake_tasks(all).map do |t|
+        comment = "# #{t.comment}" if t.comment
+        [ t.name_with_args, comment ]
+      end
+    end
+
+    def rake_tasks(all=false)
+      require_rake
+
+      Rake::TaskManager.record_task_metadata = true
+      rake.instance_variable_set(:@name, "<%= project_name %>")
+      load "Rakefile" if File.exist?("Rakefile")
+      tasks = rake.tasks
+      tasks = tasks.select(&:comment) unless all
+      tasks
+    end
+
+    def help_message(namespaced_command)
+      task = rake_tasks(true).find { |t| t.name == namespaced_command }
+      message = "Help provided by rake task:\n\n"
+      message << "<%= project_name %> #{task.name_with_args.dup}\n"
+      message << "    #{task.full_comment}"
+      message
+    end
+
+  private
+    def rake
+      Rake.application
+    end
+
+    def require_rake
+      require "rake" # Defer booting Rake until we know it's needed.
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module <%= project_class_name %>
+  class Sub < Command
+
+    desc "goodbye NAME", "say goodbye to NAME"
+    long_desc Help.text("sub:goodbye")
+    option :from, desc: "from person"
+    def goodbye(name="you")
+      puts "from: #{options[:from]}" if options[:from]
+      puts "Goodbye #{name}"
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module <%= project_class_name %>
+  VERSION = "0.1.0"
+end

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

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+# to run specs with what"s remembered from vcr
+#   $ rake
+#
+# to run specs with new fresh data from aws api calls
+#   $ rake clean:vcr ; time rake
+describe <%= project_class_name %>::CLI do
+  before(:all) do
+    @args = "--from Tung"
+  end
+
+  describe "<%= project_name %>" do
+    it "should hello world" do
+      out = execute("exe/<%= project_name %> hello world #{@args}")
+      expect(out).to include("from: Tung\nHello world")
+    end
+
+    it "should goodbye world" do
+      out = execute("exe/<%= project_name %> sub:goodbye world #{@args}")
+      expect(out).to include("from: Tung\nGoodbye world")
+    end
+  end
+end

data/lib/templates/skeleton/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/spec/lib/cli_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+# This spec tests the generator with various forms of project names:
+#
+#   hello, my_cli, my-cli, MyCLI
+#
+# The tests shell out and execute the new command to ensures a high level of
+# confidence that the CLI generator works in real life.
+#
+# It also executes the generates specs of the new project to ensure specs
+# also pass.
+#
+# Because it shells out tests take about 20 seconds to run this spec file.
+describe CliTemplate::CLI do
+  before(:all) do
+    @args = "--noop"
+  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
+
+    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
+
+    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
+
+    # 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")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+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/cli-template"
+
+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
+  c.before(:all) do
+    FileUtils.rm_rf("tmp")
+    FileUtils.mkdir_p("tmp")
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: cli-template
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a CLI tool quickly
+email:
+- tongueroo@gmail.com
+executables:
+- cli-template
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cli-template.gemspec
+- exe/cli-template
+- lib/cli-template.rb
+- lib/cli-template/cli.rb
+- lib/cli-template/command.rb
+- lib/cli-template/help.rb
+- lib/cli-template/help/new.md
+- lib/cli-template/helpers.rb
+- lib/cli-template/new.rb
+- lib/cli-template/sequence.rb
+- lib/cli-template/version.rb
+- lib/templates/skeleton/%project_name%.gemspec.tt
+- lib/templates/skeleton/.gitignore
+- lib/templates/skeleton/.rspec
+- lib/templates/skeleton/CHANGELOG.md
+- lib/templates/skeleton/Gemfile.tt
+- lib/templates/skeleton/Guardfile
+- lib/templates/skeleton/LICENSE.txt
+- lib/templates/skeleton/README.md.tt
+- lib/templates/skeleton/Rakefile
+- lib/templates/skeleton/exe/%project_name%.tt
+- lib/templates/skeleton/lib/%project_name%.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/cli.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/command.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/help.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/help/hello.md.tt
+- lib/templates/skeleton/lib/%underscored_name%/help/sub/goodbye.md.tt
+- lib/templates/skeleton/lib/%underscored_name%/main.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/rake_command.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/sub.rb.tt
+- lib/templates/skeleton/lib/%underscored_name%/version.rb.tt
+- lib/templates/skeleton/spec/lib/cli_spec.rb.tt
+- lib/templates/skeleton/spec/spec_helper.rb.tt
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitub.com/tongueroo/cli-template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Generate a CLI tool quickly
+test_files:
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb