thor_template 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584d7fe13f8296ed7a0d8c8531600b762567c0bc
-  data.tar.gz: c7853d032960135539476d542901c63a7819a022
+  metadata.gz: 1761a5aa4a73d962066765feeb7949f606440d04
+  data.tar.gz: c001211c5758678b4a382b4381358d87fac1a127
 SHA512:
-  metadata.gz: aba061fa571a435c39450fefd77d5efdff672bd0aa4e6c7672a8585a1955bc1a48a55c1d4e952a6647a1af127edd8a98a400a6a14d0a3abbdc6d74c92f92562a
-  data.tar.gz: 21c60b09d5ccd58ac030f0cfc2b4e0c3ae80a5f28b5e2d354f776d98a6b3281e04ddfcc5e035ed9b12a9fc5fa1cd773053d8b6213457392894435c1d2d4ea006
+  metadata.gz: 64b2a7d826cea332c687535c79d7739a5f2456594f7608fe5b91e6c989d55435e881ce7ca8f86a87bc0784e75d965734d6c3fcfd53a5676a601cf48117acb574
+  data.tar.gz: f74a3bc2cafeae3d4317233c699657852c1be5002c9ce1857c2fc57a809577ada22feb2f0b880d1108ad19ab02324623ae8004ae1eeaf8b5d09048995bb59124

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.
 
+## [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

data/README.md

@@ -18,7 +18,7 @@ gem install thor_template
 ```sh
 thor_template new mycli
 cd mycli
-bin/mycli hello world
+exe/mycli hello world
 ```
 
 The above generated a starter CLI project called mycli with a working hello command.  The generated project also has starter specs for you 😁

data/lib/starter_project/README.md

@@ -30,7 +30,7 @@ $ gem install thor_template
 ## Usage
 
 ```sh
-bin/thor_template hello yourname
+exe/thor_template hello yourname
 ```
 
 ## Contributing

data/lib/starter_project/lib/thor_template.rb

@@ -2,6 +2,7 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "thor_template/version"
 
 module ThorTemplate
+  autoload :Help, "thor_template/help"
   autoload :Command, "thor_template/command"
   autoload :CLI, "thor_template/cli"
 end

data/lib/starter_project/lib/thor_template/cli.rb

@@ -1,16 +1,12 @@
-require "thor"
-require "thor_template/cli/help"
-
 module ThorTemplate
-
   class CLI < Command
     class_option :verbose, type: :boolean
     class_option :noop, type: :boolean
 
     desc "hello NAME", "say hello to NAME"
-    long_desc Help.hello
+    long_desc Help.text(:hello)
     option :from, desc: "from person"
-    def hello(name)
+    def hello(name="you")
       puts "from: #{options[:from]}" if options[:from]
       puts "Hello #{name}"
     end

data/lib/starter_project/lib/thor_template/help.rb

@@ -0,0 +1,9 @@
+module ThorTemplate::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/starter_project/lib/thor_template/help/hello.md

@@ -0,0 +1,3 @@
+Examples:
+
+$ USER_PROVIDED_NAME hello

data/lib/starter_project/spec/lib/cli_spec.rb

@@ -12,7 +12,7 @@ describe ThorTemplate::CLI do
 
   describe "USER_PROVIDED_NAME" do
     it "should hello world" do
-      out = execute("bin/USER_PROVIDED_NAME hello world #{@args}")
+      out = execute("exe/USER_PROVIDED_NAME hello world #{@args}")
       expect(out).to include("from: Tung\nHello world")
     end
   end

data/lib/starter_project/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 ENV["TEST"] = "1"
 
-require "simplecov"
-SimpleCov.start
+# require "simplecov"
+# SimpleCov.start
 
 require "pp"
 

data/lib/starter_project/thor_template.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"]
 

data/lib/thor_template.rb

@@ -1,8 +1,9 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "thor/vcr" if ENV['VCR'] == '1'
-require "thor_template/cli"
+require "thor_template/version"
 
 module ThorTemplate
+  autoload :Help, 'thor_template/help'
   autoload :Command, 'thor_template/command'
   autoload :Version, 'thor_template/version'
   autoload :Generator, 'thor_template/generator'

data/lib/thor_template/cli.rb

@@ -1,17 +1,12 @@
-require 'thor'
-require 'thor_template/command'
-require 'thor_template/cli/help'
-
 module ThorTemplate
-
   class CLI < Command
     class_option :verbose, :type => :boolean
     class_option :noop, :type => :boolean
 
     desc "new NAME", "generates project based on thor template"
+    long_desc Help.text(:new)
     def new(name)
       Generator.new(options.merge(name: name)).run
     end
-
   end
 end

data/lib/thor_template/help.rb

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

@@ -0,0 +1,5 @@
+Examples:
+
+$ thor_template new hello
+
+$ thor_template new another_project

data/lib/thor_template/renamer.rb

@@ -45,7 +45,7 @@ module ThorTemplate
     def special_rename?(path)
       %w[
         thor_template.gemspec
-        bin/thor_template
+        exe/thor_template
         lib/thor_template.rb
       ].include?(path)
     end

data/lib/thor_template/version.rb

@@ -1,3 +1,3 @@
 module ThorTemplate
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/spec/lib/cli_spec.rb

@@ -13,7 +13,7 @@ describe ThorTemplate::CLI do
   describe "new" do
     context("simple single name") do
       it "should generate" do
-        out = execute("cd tmp && ../bin/thor_template new hello #{@args}")
+        out = execute("cd tmp && ../exe/thor_template new hello #{@args}")
         expect(out).to include("Created hello project!")
         out = execute("cd tmp/hello && rake")
         expect(out).to include("0 failures")
@@ -22,7 +22,7 @@ describe ThorTemplate::CLI do
 
     context("underscored name") do
       it "should generate" do
-        out = execute("cd tmp && ../bin/thor_template new my_cli #{@args}")
+        out = execute("cd tmp && ../exe/thor_template new my_cli #{@args}")
         expect(out).to include("Created my_cli project!")
         out = execute("cd tmp/my_cli && rake")
         expect(out).to include("0 failures")
@@ -31,7 +31,7 @@ describe ThorTemplate::CLI do
 
     context("dasherized name") do
       it "should generate" do
-        out = execute("cd tmp && ../bin/thor_template new my-cli #{@args}")
+        out = execute("cd tmp && ../exe/thor_template new my-cli #{@args}")
         expect(out).to include("Created my-cli project!")
         out = execute("cd tmp/my-cli && rake")
         expect(out).to include("0 failures")
@@ -41,7 +41,7 @@ describe ThorTemplate::CLI do
     # CamelCase is ugly :(
     context("simple CamelCase name") do
       it "should generate" do
-        out = execute("cd tmp && ../bin/thor_template new MyCli #{@args}")
+        out = execute("cd tmp && ../exe/thor_template new MyCli #{@args}")
         expect(out).to include("Created MyCli project!")
         out = execute("cd tmp/MyCli && rake")
         expect(out).to include("0 failures")

data/spec/spec_helper.rb

@@ -6,8 +6,8 @@
 ENV['VCR'] ? ENV['VCR'] : ENV['VCR'] = '1'
 ENV['TEST'] = '1'
 
-require 'simplecov'
-SimpleCov.start
+# require 'simplecov'
+# SimpleCov.start
 
 require "pp"
 

data/thor_template.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thor_template
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -179,7 +179,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/thor_template
+- exe/thor_template
 - lib/starter_project/.gitignore
 - lib/starter_project/.rspec
 - lib/starter_project/Gemfile
@@ -187,20 +187,22 @@ files:
 - lib/starter_project/LICENSE.txt
 - lib/starter_project/README.md
 - lib/starter_project/Rakefile
-- lib/starter_project/bin/thor_template
+- lib/starter_project/exe/thor_template
 - lib/starter_project/lib/thor_template.rb
 - lib/starter_project/lib/thor_template/cli.rb
-- lib/starter_project/lib/thor_template/cli/help.rb
 - lib/starter_project/lib/thor_template/command.rb
+- lib/starter_project/lib/thor_template/help.rb
+- lib/starter_project/lib/thor_template/help/hello.md
 - lib/starter_project/lib/thor_template/version.rb
 - lib/starter_project/spec/lib/cli_spec.rb
 - lib/starter_project/spec/spec_helper.rb
 - lib/starter_project/thor_template.gemspec
 - lib/thor_template.rb
 - lib/thor_template/cli.rb
-- lib/thor_template/cli/help.rb
 - lib/thor_template/command.rb
 - lib/thor_template/generator.rb
+- lib/thor_template/help.rb
+- lib/thor_template/help/new.md
 - lib/thor_template/renamer.rb
 - lib/thor_template/version.rb
 - spec/lib/cli_spec.rb

data/lib/starter_project/lib/thor_template/cli/help.rb

@@ -1,13 +0,0 @@
-module ThorTemplate
-  class CLI < Command
-    class Help
-      class << self
-        def hello
-<<-EOL
-Hello world example
-EOL
-        end
-      end
-    end
-  end
-end

data/lib/thor_template/cli/help.rb

@@ -1,17 +0,0 @@
-module ThorTemplate
-  class CLI < Command
-    class Help
-      class << self
-        def generate
-<<-EOL
-Examples:
-
-$ thor_template new hello
-
-$ thor_template new another_project
-EOL
-        end
-      end
-    end
-  end
-end