cli-template 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 042da28b0ec9d9d406c3204bb08210c996c98022f2b75a2bfc454d7b79916c1e
+  data.tar.gz: 8ce3733852b7f5790a466699572323f82862a2ed18f92a42a7247a815d050879
+SHA512:
+  metadata.gz: cfe099ee8efae48d4752a570652361ae6e147fd7be9716dcd9bfb35f58fcd61ce0d24a53749c24817abdb57f0f3dc0c8f3f9ed3ea28de537e6a38960e6b7f3a2
+  data.tar.gz: ad5c81b830fe057937dd74419bbac0e19de6e41f84b967572babb61ea2c8631a84f7c1899fdec6f3a4356d00d7e6aca51305adfdaa4364aa27fcb7c239d76336

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      - run:
+          name: configure git
+          command: |
+            git config --global user.email "tongueroo@gmail.com"
+            git config --global user.name "Tung Nguyen"
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            gem install bundler # think need this because the specs shell out
+            mkdir /tmp/test-results
+            bundle exec rspec
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--exclude-pattern spec/fixtures/apps/**/*
+

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# 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.
+
+## [3.0.0]
+- tool is now called cli-template
+- namespaced commands support
+- using Thor::Group as the generator
+
+## [2.2.1]
+- add -v as a version flag too
+
+## [2.2.0]
+- simple help formatting
+- add version command
+
+## [2.1.1]
+
+- starter project use version 0.1.0
+
+## [2.1.0]
+
+- improve help class
+- comment out SimpleCov
+- reanme bin folder to exe
+
+## [2.0.1]
+
+- fix gem name that gets build for the starter project
+
+## [2.0.0]
+
+- Fix project names that are named with dashes and camel case.
+- Add legit specs that test each case.
+
+## [1.0.1]
+
+- require "fileutils" fix
+
+## [1.0.0]
+
+- allow --help or -h at the end of the command
+- major version bump. been in used and tested for a while now
+
+## [0.0.7]
+
+- Update starter project to use newer ruby syntax

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cli-template.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})      { "spec/cli-template_spec.rb" }
+  watch(%r{^lib/cli-template/(.+)\.rb$})  { "spec/cli-template_spec.rb" }
+  watch('spec/spec_helper.rb')   { "spec/cli-template_spec.rb" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/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/README.md

@@ -0,0 +1,58 @@
+# CLI Template
+
+[![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` allows for namespace commands.  The usage section demonstrates a namespace command below.
+
+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.
+
+## Usage
+
+```sh
+cli-template new mycli
+cd mycli
+exe/mycli hello world
+exe/mycli sub:goodbye world
+```
+
+The above generated a starter CLI project called `mycli` with a working hello command.  The created project also has starter specs for you 😁
+
+```sh
+$ rake
+Mycli::CLI
+  mycli
+    should hello world
+    should goodbye world
+
+Finished in 1.12 seconds (files took 0.71706 seconds to load)
+2 examples, 0 failures
+```
+
+## Release
+
+Once you are satisfied with the CLI tool, you can release it as a gem.
+
+    1. edit the mycli.gemspec
+    2. edit lib/mycli/version.rb
+    3. update the CHANGELOG.md
+
+And run:
+
+```
+rake release
+```
+
+## Installation
+
+```sh
+gem install cli-template
+```
+
+## 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/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+
+# DELETE AFTER USING
+desc "Rename project"
+task :rename do
+  name = ENV['NAME'] || File.basename(Dir.pwd)
+  camelize = lambda do |str|
+    str.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+  dir = Dir['**/cli-template*']
+  begin
+    from = dir.pop
+    if from
+      to = from.split('/')
+      to[-1].gsub!('cli-template', name)
+      FileUtils.mv(from, to.join('/'))
+    end
+  end while dir.length > 0
+  Dir["**/*"].each do |path|
+    if File.file?(path)
+      `sed -i 's/cli-template/#{name}/g' #{path}`
+      `sed -i 's/CliTemplate/#{camelize.call(name)}/g' #{path}`
+      no_space = File.read(path).gsub(/\s+\z/, '')
+      File.open(path, 'w') { |f| f.write(no_space) }
+    end
+  end
+end

data/cli-template.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli-template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli-template"
+  spec.version       = CliTemplate::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.description   = %q{Generate a CLI tool quickly}
+  spec.summary       = %q{Generate a CLI tool quickly}
+  spec.homepage      = "https://gitub.com/tongueroo/cli-template"
+  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 "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "byebug"
+end

data/exe/cli-template

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'cli-template'
+require 'cli-template/cli'
+
+CliTemplate::CLI.start(ARGV)

data/lib/cli-template.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "cli-template/version"
+
+module CliTemplate
+  autoload :Help, 'cli-template/help'
+  autoload :CLI, 'cli-template/cli'
+  autoload :Command, 'cli-template/command'
+  autoload :Version, 'cli-template/version'
+  autoload :Sequence, 'cli-template/sequence'
+  autoload :New, 'cli-template/new'
+  autoload :Helpers, 'cli-template/helpers'
+end

data/lib/cli-template/cli.rb

@@ -0,0 +1,17 @@
+module CliTemplate
+  class CLI < Command
+    class_option :verbose, :type => :boolean
+    class_option :noop, :type => :boolean
+
+    long_desc Help.text(:new)
+    New.cli_options.each do |args|
+      option *args
+    end
+    register(New, "new", "new NAME", "generates new CLI project")
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
+  end
+end

data/lib/cli-template/command.rb

@@ -0,0 +1,47 @@
+require 'thor'
+
+# 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 CliTemplate
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # 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_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   cli-template version
+        #   cli-template --version
+        #   cli-template -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/cli-template/help.rb

@@ -0,0 +1,9 @@
+module CliTemplate::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/cli-template/help/new.md

@@ -0,0 +1,4 @@
+Examples:
+
+  cli-template new hello
+  cli-template new another_project

data/lib/cli-template/helpers.rb

@@ -0,0 +1,12 @@
+module CliTemplate::Helpers
+  def project_class_name
+    project_name.underscore.camelize
+  end
+
+  # Files should be named with underscores instead of dashes even
+  # though project name can contain a dash. This is because autoloading
+  # works will underscores in the filenames only.
+  def underscored_name
+    project_name.underscore
+  end
+end

data/lib/cli-template/new.rb

@@ -0,0 +1,74 @@
+module CliTemplate
+  class New < Sequence
+    argument :project_name
+
+    # Ugly, but when the class_option is only defined in the Thor::Group class
+    # it doesnt show up with cli-template new help :(
+    # If anyone knows how to fix this let me know.
+    def self.cli_options
+      [
+        [:repo, desc: "GitHub repo to use. Format: user/repo"],
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:git, type: :boolean, default: true, desc: "Git initialize the project"],
+      ]
+    end
+
+    cli_options.each do |args|
+      class_option *args
+    end
+
+    def create_project
+      options[:repo] ? clone_project : copy_project
+
+      destination_root = "#{Dir.pwd}/#{project_name}"
+      self.destination_root = destination_root
+      FileUtils.cd("#{Dir.pwd}/#{project_name}")
+    end
+
+    def make_executable
+      chmod("bin", 0755 & ~File.umask, verbose: false) if File.exist?("bin")
+      chmod("exe", 0755 & ~File.umask, verbose: false) if File.exist?("exe")
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        system("BUNDLE_IGNORE_CONFIG=1 bundle install")
+      end
+    end
+
+    def git_init
+      return if !options[:git]
+      return unless git_installed?
+      return if File.exist?(".git") # this is a clone repo
+
+      run("git init")
+      run("git add .")
+      run("git commit -m 'first commit'")
+    end
+
+    def user_message
+      puts <<-EOL
+#{"="*64}
+Congrats 🎉 You have successfully created a CLI project.
+
+Test the CLI:
+
+  cd #{project_name}
+  exe/#{project_name} hello       # top-level commands
+  exe/#{project_name} sub:goodbye # sub commands
+  bundle exec rspec
+
+To publish your CLI as a gem:
+
+  1. edit the #{project_name}.gemspec
+  2. edit lib/#{project_name}/version.rb
+  3. update the CHANGELOG.md
+
+And run:
+
+  rake release
+
+EOL
+    end
+  end
+end