cli-template 3.5.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ad7e02c673bacf1fe9a65104f9d54a1ffa76bbc4014d4b9435789c460671b8
-  data.tar.gz: 7aca4368ee8502b178e77a9003e7eb40c08c3b60a0e2bd70bb11434dcfc2181d
+  metadata.gz: b53337284c8b96dbc2542077b822c17bc84aef700324434f2516f3dc1e49fec8
+  data.tar.gz: 8919ffcd06b6080fb07e098f495180379c8de7fecf6f7463d22292eb15c89c14
 SHA512:
-  metadata.gz: a1685a9f2fe64d485e5dfea66fc9eb749036986cef7d89c3e31bede04f7c148ca7f767145cb431aa884d3b79a0b03ba8189baf806f547c18a32eda8509b732f2
-  data.tar.gz: 51f589a255e1f5f4411d2466d372febb81cc3015e1198b5738697fd7c953a25a172e00a4cc0bf69287a0a1f00f2c7d3be7c39507ca05692b4dea52b3a8b37fd3
+  metadata.gz: 463553b6d137103f0fdcb7c0ee79e5f8852116442940f3d86385e7e05473cbc0360cb0f90bb94ceeff6e5ea73745a9f74ef717620e5d4861266196cb3c4c27a8
+  data.tar.gz: be52eb5f0f27e5bb0e1cd9c5b789df36829329eb82bae2a09a9fc401196a5c8fdcc563a6c7d502e031a0afd4ff4254339c3149ef98fcaca7375160580e0775b5

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.
 
+## [4.0.0]
+- use zeitwerk for autoload
+
 ## [3.5.1]
 - #4 from sco11morgan/move-activesupport-to-dev
 - ensure docs/_includes is created

data/Gemfile

@@ -3,4 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cli-template.gemspec
 gemspec
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+# Some gems are included because the generated project contains these gems
+# We use bundle exec to run specs in circleci.
+# This workaround ensures those gems are also installed with the first bundle install.
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "cli_markdown"
+end

data/cli-template.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cli-template/version'
+require 'cli_template/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "cli-template"
@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
   spec.add_dependency "rainbow"
+  spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler"

data/exe/cli-template

@@ -3,7 +3,7 @@
 require 'rubygems'
 
 $:.unshift(File.expand_path('../../lib', __FILE__))
-require 'cli-template'
-require 'cli-template/cli'
+require 'cli_template'
+require 'cli_template/cli'
 
 CliTemplate::CLI.start(ARGV)

data/lib/cli-template.rb

@@ -1,12 +1 @@
-$:.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 :Helper, 'cli-template/helper'
-end
+require_relative "cli_template"

data/lib/cli_template.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "cli_template/version"
+require "cli_template/autoloader"
+CliTemplate::Autoloader.setup
+
+module CliTemplate
+  class Error < StandardError; end
+end

data/lib/cli_template/autoloader.rb

@@ -0,0 +1,22 @@
+require "zeitwerk"
+
+module CliTemplate
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.ignore("#{File.dirname(__dir__)}/cli-template.rb")
+        loader.setup
+      end
+    end
+  end
+end

data/lib/{cli-template → cli_template}/new.rb

@@ -11,6 +11,7 @@ module CliTemplate
         [: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"],
+        [:subcommand, type: :boolean, default: false, desc: "Include subcommand example"],
       ]
     end
 
@@ -56,7 +57,6 @@ Test the CLI:
   cd #{project_name}
   bundle
   exe/#{project_name} hello       # top-level commands
-  exe/#{project_name} sub:goodbye # sub commands
   bundle exec rspec
 
 To publish your CLI as a gem:

data/lib/{cli-template → cli_template}/sequence.rb

@@ -38,7 +38,34 @@ private
 
   def copy_project
     puts "Creating new project called #{project_name}."
-    directory ".", project_name
+    directory ".", project_name, copy_options
+    if project_name.include?("-")
+      dashed_path = "#{project_name}/lib/#{project_name}.rb"
+      underscored_path = "#{project_name}/lib/#{underscored_name}.rb"
+
+      FileUtils.mv(dashed_path, underscored_path)
+      IO.write(dashed_path, <<~EOL)
+        require_relative "#{underscored_name}"
+      EOL
+    end
+  end
+
+  def copy_options
+    excludes = if @options[:subcommand]
+      []
+    else
+      %w[
+        help/sub
+        sub.rb
+      ]
+    end
+
+    if excludes.empty?
+      {}
+    else
+      pattern = Regexp.new(excludes.join('|'))
+      {exclude_pattern: pattern }
+    end
   end
 
   def git_installed?

data/lib/{cli-template → cli_template}/version.rb

@@ -1,3 +1,3 @@
 module CliTemplate
-  VERSION = "3.5.1"
+  VERSION = "4.0.0"
 end

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

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rainbow"
   spec.add_dependency "rake"
   spec.add_dependency "activesupport"
+  spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

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

@@ -11,27 +11,15 @@ describe <%= project_class_name %>::CLI do
       expect(out).to include("from: Tung\nHello world")
     end
 
-    it "goodbye" do
-      out = execute("exe/<%= project_name %> sub:goodbye world #{@args}")
-      expect(out).to include("from: Tung\nGoodbye world")
-    end
-
     it "completions" do
       out = execute("exe/<%= project_name %> completions")
       expect(out).to include("hello")
-      expect(out).to include("sub:goodbye")
 
       out = execute("exe/<%= project_name %> completions hello")
       expect(out).to include("name")
 
       out = execute("exe/<%= project_name %> completions hello name")
       expect(out).to include("--from")
-
-      out = execute("exe/<%= project_name %> completions sub:goodbye")
-      expect(out).to include("name")
-
-      out = execute("exe/<%= project_name %> completions sub:goodbye name")
-      expect(out).to include("--from")
     end
   end
 end

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

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "rainbow"
   spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/templates/default/{LICENSE.txt → LICENSE.txt.tt}

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Tung Nguyen
+Copyright (c) <%= Time.now.strftime("%Y") %> Tung Nguyen
 
 MIT License
 

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

@@ -3,7 +3,7 @@
 # Trap ^C
 Signal.trap("INT") {
   puts "\nCtrl-C detected. Exiting..."
-  sleep 1
+  sleep 0.1
   exit
 }
 

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

@@ -2,13 +2,9 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "<%= underscored_name %>/version"
 require "rainbow/ext/string"
 
+require "<%= underscored_name %>/autoloader"
+<%= project_class_name %>::Autoloader.setup
+
 module <%= project_class_name %>
   class Error < StandardError; end
-
-  autoload :CLI, "<%= underscored_name %>/cli"
-  autoload :Command, "<%= underscored_name %>/command"
-  autoload :Completer, "<%= underscored_name %>/completer"
-  autoload :Completion, "<%= underscored_name %>/completion"
-  autoload :Help, "<%= underscored_name %>/help"
-  autoload :Sub, "<%= underscored_name %>/sub"
 end

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

@@ -0,0 +1,24 @@
+require "zeitwerk"
+
+module <%= project_class_name %>
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+<% if project_name.include?('-') -%>
+        loader.ignore("#{File.dirname(__dir__)}/<%= project_name %>.rb")
+<% end -%>
+        loader.setup
+      end
+    end
+  end
+end

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

@@ -10,10 +10,11 @@ module <%= project_class_name %>
       puts "from: #{options[:from]}" if options[:from]
       puts "Hello #{name}"
     end
-
+<% if options[:subcommand] -%>
     desc "sub SUBCOMMAND", "sub subcommands"
     long_desc Help.text(:sub)
     subcommand "sub", Sub
+<% end -%>
 
     desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text("completion")

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

@@ -70,8 +70,6 @@ Auto-completion accounts for each of these type of commands.
 =end
 module <%= project_class_name %>
   class Completer
-    autoload :Script, '<%= underscored_name %>/completer/script'
-
     def initialize(command_class, *params)
       @params = params
       @current_command = @params[0]

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

@@ -11,22 +11,12 @@ describe <%= project_class_name %>::CLI do
       expect(out).to include("from: Tung\nHello world")
     end
 
-    it "goodbye" do
-      out = execute("exe/<%= project_name %> sub goodbye world #{@args}")
-      expect(out).to include("from: Tung\nGoodbye world")
-    end
-
     commands = {
       "hell" => "hello",
       "hello" => "name",
       "hello -" =>  "--from",
       "hello name" => "--from",
       "hello name --" => "--from",
-      "sub goodb" => "goodbye",
-      "sub goodbye" => "name",
-      "sub goodbye name" => "--from",
-      "sub goodbye name --" => "--from",
-      "sub goodbye name --from" => "--help",
     }
     commands.each do |command, expected_word|
       it "completion #{command}" do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cli-template
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -156,14 +170,16 @@ files:
 - 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/helper.rb
-- lib/cli-template/new.rb
-- lib/cli-template/sequence.rb
-- lib/cli-template/version.rb
+- lib/cli_template.rb
+- lib/cli_template/autoloader.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/helper.rb
+- lib/cli_template/new.rb
+- lib/cli_template/sequence.rb
+- lib/cli_template/version.rb
 - lib/templates/colon_namespaces/%project_name%.gemspec.tt
 - lib/templates/colon_namespaces/.gitignore
 - lib/templates/colon_namespaces/.rspec
@@ -199,11 +215,12 @@ files:
 - lib/templates/default/CHANGELOG.md
 - lib/templates/default/Gemfile.tt
 - lib/templates/default/Guardfile
-- lib/templates/default/LICENSE.txt
+- lib/templates/default/LICENSE.txt.tt
 - lib/templates/default/README.md.tt
 - lib/templates/default/Rakefile.tt
 - lib/templates/default/exe/%project_name%.tt
 - lib/templates/default/lib/%project_name%.rb.tt
+- lib/templates/default/lib/%underscored_name%/autoloader.rb.tt
 - lib/templates/default/lib/%underscored_name%/cli.rb.tt
 - lib/templates/default/lib/%underscored_name%/command.rb.tt
 - lib/templates/default/lib/%underscored_name%/completer.rb.tt
@@ -239,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Generate a CLI tool quickly