thor_template 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44d85a7deb099da700004cc428aef7ed734df492
-  data.tar.gz: ddd667d6c802e10439166ef320aba8745cceecb6
+  metadata.gz: ab6ae7155ca474bcc468b645793b3f0ce331032d
+  data.tar.gz: 3f9260280b4788cd605e8f205d45507cca97e57f
 SHA512:
-  metadata.gz: 515e6f2b5530463b3a58e09fbd74a0267d16e325b33894cc9c2163b952171e0c12be86970c7e1194732d466a4c81011b55b877fa158ef52f2da1197847b6f18a
-  data.tar.gz: fda470e98ee5156d51dccb747d4853037a1d1f1f0f7683c021e47b7e786e51c39c5e7f83cb49506ced328a29a50e9205cf5b4e8d10dcd532198b0057234290b1
+  metadata.gz: c1b93e6a5b2faf163e5e7030659f9474a64f71ab40343660680e36d2677974d50933d0392989e0ee3d80df7f0340e982f28ea6d2bf291db314df2e5eeb434d8e
+  data.tar.gz: 0d4f7e668e79df3d3d806889fa13a8cead2211800bbb5c7dc27cc6e1f841aae79d996cf1b68dad57cb4e96039a21ddd74dee74f399a26357f6843f1d63ad92a4

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.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

data/README.md

@@ -1,9 +1,11 @@
+[![Build Thor CLI Project in Under a Second](https://img.youtube.com/vi/GcVhdoneZYk/0.jpg)](https://www.youtube.com/watch?v=GcVhdoneZYk)
+
 # ThorTemplate
 
 [![Build Status](https://travis-ci.org/tongueroo/thor_template.svg?branch=generator)](https://travis-ci.org/tongueroo/thor_template)
 [![Code Climate](https://codeclimate.com/github/tongueroo/thor_template.png)](https://codeclimate.com/github/tongueroo/thor_template)
 
-This is a generator tool that builds a starter cli project based on thor.
+`thor_template` is a generator tool that builds a starter CLI project based on [Thor](). This 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), also covers usage and also contains a video demo.
 
 ## Installation
 
@@ -14,12 +16,12 @@ gem install thor_template
 ## Usage
 
 ```sh
-thor_template new foo
-cd foo
-bin/foo hello world
+thor_template new mycli
+cd mycli
+bin/mycli hello world
 ```
 
-The above generated a starter cli project called foo with a working hello command.  The generated project also has starter specs for you 😁
+The above generated a starter CLI project called mycli with a working hello command.  The generated project also has starter specs for you 😁
 
 ```sh
 $ rake
@@ -32,26 +34,3 @@ Finished in 0.09672 seconds (files took 0.20945 seconds to load)
 1 example, 0 failures
 $
 ```
-
-## Dashes Problem
-
-Names with dashes don't work quite right with this tool.  For example:
-
-```
-thor_template new my-project
-```
-
-This results in some the files and text not being renamed correctly.  I usually work around this by creating a project with the underscored name first:
-
-```
-thor_template new my_project
-```
-
-Then I rename things 3 spots:
-
-* my_project.gemspec - Change the name from my_project to my-project.  So the gem name has a dash.
-* bin/my_project - Change the name from bin/my_project to bin/my-project.  So the binary has a dash.  The require in the file also needs to be fixed.
-* lib/my_project.rb - Change the name from lib/my_project.rb to lib/my-project.rb. So if the project is required it is `require my-project`.
-* spec/spec_helper.rb - Change the require lib/my_project.rb to lib/my-project.rb. And spec/lib/cli_spec.  So the test passes.
-
-Hope to fix this one day! Also, pull request are appreciated!

data/lib/starter_project/Gemfile

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

data/lib/starter_project/Guardfile

@@ -1,12 +1,12 @@
-guard 'rspec' do
+guard "rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})      { "spec/thor_template_spec.rb" }
   watch(%r{^lib/thor_template/(.+)\.rb$})  { "spec/thor_template_spec.rb" }
-  watch('spec/spec_helper.rb')   { "spec/thor_template_spec.rb" }
+  watch("spec/spec_helper.rb")   { "spec/thor_template_spec.rb" }
   watch(%r{^lib/thor_template/(.+)\.rb$})   { |m| "spec/lib/#{m[1]}_spec.rb" }
 end
 
-guard 'bundler' do
-  watch('Gemfile')
+guard "bundler" do
+  watch("Gemfile")
   watch(/^.+\.gemspec/)
 end

data/lib/starter_project/README.md

@@ -12,7 +12,7 @@ TODO: Write a gem description
 
 Add this line to your application's Gemfile:
 
-    gem 'thor_template'
+    gem "thor_template"
 
 And then execute:
 
@@ -32,13 +32,13 @@ rake rename
 rm -rf .git
 git init
 git add .
-git commit -m 'init commit'
+git commit -m "init commit"
 </pre>
 
 ## 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'`)
+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/starter_project/Rakefile

@@ -1,32 +1,6 @@
-# require "bundler/gem_tasks"
+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['**/thor_template*']
-  begin
-    from = dir.pop
-    if from
-      to = from.split('/')
-      to[-1].gsub!('thor_template', name)
-      FileUtils.mv(from, to.join('/'))
-    end
-  end while dir.length > 0
-  Dir["**/*"].each do |path|
-    if File.file?(path)
-      `sed -i '' 's/thor_template/#{name}/g' #{path}`
-      `sed -i '' 's/ThorTemplate/#{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/lib/starter_project/bin/thor_template

@@ -7,8 +7,8 @@ Signal.trap("INT") {
   exit
 }
 
-$:.unshift(File.expand_path('../../lib', __FILE__))
-require 'thor_template'
-require 'thor_template/cli'
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "USER_PROVIDED_NAME"
+require "thor_template/cli"
 
 ThorTemplate::CLI.start(ARGV)

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

@@ -1,5 +1,5 @@
-require 'thor'
-require 'thor_template/cli/help'
+require "thor"
+require "thor_template/cli/help"
 
 module ThorTemplate
 
@@ -9,7 +9,7 @@ module ThorTemplate
 
     desc "hello NAME", "say hello to NAME"
     long_desc Help.hello
-    option :from, desc: 'from person'
+    option :from, desc: "from person"
     def hello(name)
       puts "from: #{options[:from]}" if options[:from]
       puts "Hello #{name}"

data/lib/starter_project/lib/thor_template/command.rb

@@ -1,4 +1,4 @@
-require 'thor'
+require "thor"
 
 module ThorTemplate
   class Command < Thor

data/lib/starter_project/lib/thor_template.rb

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

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

@@ -1,8 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
-# to run specs with what's remembered from vcr
+# 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 ThorTemplate::CLI do
@@ -10,9 +10,9 @@ describe ThorTemplate::CLI do
     @args = "--from Tung"
   end
 
-  describe "thor_template" do
+  describe "USER_PROVIDED_NAME" do
     it "should hello world" do
-      out = execute("bin/thor_template hello world #{@args}")
+      out = execute("bin/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,18 +1,18 @@
-ENV['TEST'] = '1'
+ENV["TEST"] = "1"
 
-require 'simplecov'
+require "simplecov"
 SimpleCov.start
 
 require "pp"
 
-root = File.expand_path('../../', __FILE__)
-require "#{root}/lib/thor_template"
+root = File.expand_path("../../", __FILE__)
+require "#{root}/lib/USER_PROVIDED_NAME"
 
 module Helpers
   def execute(cmd)
-    puts "Running: #{cmd}" if ENV['DEBUG']
+    puts "Running: #{cmd}" if ENV["DEBUG"]
     out = `#{cmd}`
-    puts out if ENV['DEBUG']
+    puts out if ENV["DEBUG"]
     out
   end
 end

data/lib/starter_project/thor_template.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'thor_template/version'
+require "thor_template/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "thor_template"

data/lib/thor_template/generator.rb

@@ -1,17 +1,20 @@
 require 'fileutils'
+require 'colorize'
+require 'active_support/core_ext/string'
+require "byebug"
 
 module ThorTemplate
   class Generator
     attr_reader :options
     def initialize(options={})
       @options = options
+      Dir.chdir(options[:cwd]) if options[:cwd]
       @name = options[:name]
     end
 
     def run
       copy
       rename
-      rewrite
       git
       puts "Created #{@name} project!"
     end
@@ -26,9 +29,9 @@ module ThorTemplate
         dest = "#{project_root}/#{dest}"
 
         if File.exist?(dest) and !options[:force]
-          puts "already exists: #{dest}" unless options[:quiet]
+          puts "already exists: #{dest}".colorize(:yellow) unless options[:quiet]
         else
-          puts "creating: #{dest}" unless options[:quiet]
+          puts "creating: #{dest}".colorize(:green) unless options[:quiet]
           dirname = File.dirname(dest)
           FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
           FileUtils.cp(src, dest)
@@ -37,11 +40,7 @@ module ThorTemplate
     end
 
     def rename
-      system("cd #{@name} && rake rename")
-    end
-
-    def rewrite
-      template("Rakefile", "Rakefile")
+      Renamer.new(@name).rename!
     end
 
     def git

data/lib/thor_template/renamer.rb

@@ -0,0 +1,63 @@
+module ThorTemplate
+  class Renamer
+    def initialize(name)
+      @name = name
+    end
+
+    def rename!
+      Dir.chdir(@name) do
+        Dir.glob("**/*") do |path|
+          next unless File.file?(path)
+          rename_content(path)
+
+          next unless File.file?(path)
+          rename_path(path)
+        end # Dir.glob
+
+        remove_empty_directories
+      end
+    end
+
+    def rename_content(path)
+      content = IO.readlines(path)
+      result = content.map do |line|
+        line = line.gsub(/ThorTemplate/, @name.underscore.camelize)
+        line = line.gsub(/thor_template/, @name.underscore)
+        line = line.gsub("USER_PROVIDED_NAME", @name) # special case
+        line
+      end
+      IO.write(path, result.join(''))
+    end
+
+    def rename_path(src)
+      dest = special_rename?(src) ?
+        src.gsub(/thor_template/, @name) :
+        src.gsub(/thor_template/, @name.underscore)
+
+      folder = File.dirname(dest)
+      FileUtils.mkdir_p(folder) unless File.exist?(folder)
+
+      FileUtils.mv(src, dest) unless src == dest
+    end
+
+    # These paths should be rename with the actually named provied by the
+    # user, the the underscored version.
+    def special_rename?(path)
+      %w[
+        thor_template.gemspec
+        bin/thor_template
+        lib/thor_template.rb
+      ].include?(path)
+    end
+
+    # Thanks https://stackoverflow.com/users/123094/db
+    # https://stackoverflow.com/questions/1290670/ruby-how-do-i-recursively-find-and-remove-empty-directories
+    def remove_empty_directories
+      Dir['**/*'].
+        select { |d| File.directory? d }.
+        select { |d| (Dir.entries(d) - %w[ . .. ]).empty? }.
+        each   { |d| Dir.rmdir d }
+    end
+
+  end
+end

data/lib/thor_template/version.rb

@@ -1,3 +1,3 @@
 module ThorTemplate
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/thor_template.rb

@@ -6,4 +6,5 @@ module ThorTemplate
   autoload :Command, 'thor_template/command'
   autoload :Version, 'thor_template/version'
   autoload :Generator, 'thor_template/generator'
+  autoload :Renamer, 'thor_template/renamer'
 end

data/spec/lib/cli_spec.rb

@@ -2,7 +2,7 @@ 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 ThorTemplate::CLI do
@@ -11,13 +11,45 @@ describe ThorTemplate::CLI do
   end
 
   describe "new" do
-    it "should generate" do
-      out = execute("cd tmp && ../bin/thor_template new hello #{@args}")
-      expect(out).to include("Created hello project!")
+    context("simple single name") do
+      it "should generate" do
+        out = execute("cd tmp && ../bin/thor_template new hello #{@args}")
+        expect(out).to include("Created hello 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 && ../bin/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")
+      end
+    end
+
+    context("dasherized name") do
+      it "should generate" do
+        out = execute("cd tmp && ../bin/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")
+      end
+    end
+
+    # CamelCase is ugly :(
+    context("simple CamelCase name") do
+      it "should generate" do
+        out = execute("cd tmp && ../bin/thor_template new MyCli #{@args}")
+        expect(out).to include("Created MyCli project!")
+        out = execute("cd tmp/MyCli && rake")
+        expect(out).to include("0 failures")
+      end
     end
   end
 end
 
 VCR.configure do |config|
   config.ignore_hosts 'codeclimate.com'
-end
+end

data/spec/lib/generator_spec.rb

@@ -2,20 +2,21 @@ 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 ThorTemplate::Generator do
   before(:each) do
     options = {
-      name: "tmp/hello"
+      cwd: "tmp",
+      name: "hello"
     }
     @generator = ThorTemplate::Generator.new(options)
   end
 
   it "should generate" do
     @generator.run
-    expect(File.exist?("tmp/hello")).to be_truthy
-    expect(File.exist?("tmp/hello/hello.gemspec")).to be_truthy
+    expect(File.exist?("hello")).to be_truthy
+    expect(File.exist?("hello/hello.gemspec")).to be_truthy
   end
 end

data/spec/spec_helper.rb

@@ -27,7 +27,8 @@ RSpec.configure do |c|
   c.include Helpers
   c.before(:all) do
     FileUtils.mkdir('tmp') unless File.exist?('tmp')
-    FileUtils.rm_rf("tmp/hello")
+    FileUtils.rm_rf("tmp")
+    FileUtils.mkdir("tmp")
   end
   c.around(:each) do |example|
     VCR.use_cassette(example.metadata[:full_description], :serialize_with => :json) do

data/thor_template.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "hashie"
   spec.add_dependency "colorize"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -28,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thor_template
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !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
@@ -136,6 +150,20 @@ dependencies:
     - - ">="
       - !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: Generates starter cli tool project.
 email:
 - tongueroo@gmail.com
@@ -168,12 +196,12 @@ files:
 - lib/starter_project/spec/lib/cli_spec.rb
 - lib/starter_project/spec/spec_helper.rb
 - lib/starter_project/thor_template.gemspec
-- lib/templates/Rakefile
 - 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/renamer.rb
 - lib/thor_template/version.rb
 - spec/lib/cli_spec.rb
 - spec/lib/generator_spec.rb

data/lib/templates/Rakefile

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