foobar_templates 2.0.1.rc4 → 2.0.1.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c933bd134506713bc01168f73ba617aeb22f7d3dc10a472455da258189136528
-  data.tar.gz: 0a5bcd41cff0ef149b6950e5a6868e444eaff671e7eef5043cf89ea5f24f917c
+  metadata.gz: 2de721ac516850803ef2197289a766487833355196ecc4c613642edc6a1761e6
+  data.tar.gz: 5c8f819dce4a1af6a442f85577f31f3a01d342245a3a7172de25d96185ae87ce
 SHA512:
-  metadata.gz: a036cca148228d0cd1b6d7f1f8d0d81249108dd1aa4b029d146838b64b26ea018857a9f4a175f3e8c9bbc229f77035a68c4bc7dadbacae0e0a8b2ffaf38c3143
-  data.tar.gz: fa889a9eb2be2514d2b1347458b624491a460e1f7bc7faf25e7577a62da623e85ca29ec31b4ecb6633a4042d5ba75b66e37c72a21b2b3c67a88ef1a9c77ba3b9
+  metadata.gz: 2339d804f08da3320e3a981b89c6193a5f41942358e71bdd9ba523ea7c750436d027e0080352f8b70705ed17e6f17a38ecfb00761f8e71ed316b629c440d6818
+  data.tar.gz: 0be856b92d4ec8e243e42c9d2f9adf1404bd53e11b77a54d57102bafce844189ea53168d7d4dbd8812876d4bc7380a4ca33dfe7abb623555462a3c5d8cd7536e

data/README.md

@@ -153,3 +153,20 @@ If you would find additional variables handy, set me up with a PR and assuming i
 - Use `FOO_` prefixed placeholders for non-name variables: `FOO_AUTHOR`, `FOO_EMAIL`, `FOO_GIT_REPO_URL`, etc.
 - Running `foobar_templates --cheat-sheet` will list off available template variables
 - File **names** containing `foo-bar` or `foo_bar` will have those replaced by the project name
+
+
+## Release Process
+
+Cut a pre-release with:
+
+```
+rake release
+```
+
+Days or months later, promote it to a release:
+
+```
+git checkout OLD_RELEASE
+rake promote
+```
+

data/Rakefile

@@ -19,12 +19,26 @@ module ReleaseHelper
   end
 
   def current_version
+    return ENV['GEM_VERSION'] if ENV['GEM_VERSION']
+
     src = File.read(VERSION_FILE)
-    m = src.match(/VERSION\s*=\s*"([^"]+)"/)
+    m = src.match(/VERSION\s*=\s*["']([^"']+)["']/)
     abort "Could not parse VERSION from #{VERSION_FILE}" unless m
     m[1]
   end
 
+  def strip_rc(version)
+    m = version.match(RC_RE)
+    return nil unless m
+    maj, min, pat, _rc = m.captures
+    "#{maj}.#{min}.#{pat}"
+  end
+
+  def rc_tag_on_head
+    tags = `git tag --points-at HEAD`.strip.split("\n")
+    tags.find { |t| t.match?(/\Av\d+\.\d+\.\d+\.rc\d+\z/) }
+  end
+
   def next_version(v)
     if (m = v.match(RC_RE))
       maj, min, pat, rc = m.captures.map(&:to_i)
@@ -168,6 +182,49 @@ task :release do
   puts "=" * 60
 end
 
+desc "Promote a pre-release commit to a final release (no new commit needed)"
+task :promote, [:version] do |_t, args|
+  include_helper = ReleaseHelper
+
+  include_helper.preflight!
+
+  # Determine the RC tag on HEAD
+  rc_tag = include_helper.rc_tag_on_head
+  abort "No pre-release tag (vX.Y.Z.rcN) found on HEAD. Checkout a tagged RC commit first." unless rc_tag
+  rc_version = rc_tag.sub(/\Av/, '')
+
+  # Determine target release version
+  release_version = args[:version] || include_helper.strip_rc(rc_version)
+  abort "Could not derive release version from #{rc_version}" unless release_version
+  abort "Target version #{release_version} is not a release format (expected MAJOR.MINOR.PATCH)" unless release_version.match?(ReleaseHelper::REL_RE)
+
+  sha = `git rev-parse --short HEAD`.strip
+  puts "Promoting commit #{sha} (tagged #{rc_tag}) \u2192 v#{release_version}"
+  unless include_helper.confirm!("Continue?", default: false)
+    puts "Aborted."
+    exit 0
+  end
+
+  # Build gem with the release version (override via ENV, no file edit)
+  ENV['GEM_VERSION'] = release_version
+  Rake::Task[:build].invoke
+
+  gem_file = "pkg/#{GEM_NAME}-#{release_version}.gem"
+  abort "Built gem not found at #{gem_file}" unless File.exist?(gem_file)
+
+  # Tag and push
+  tag = "v#{release_version}"
+  include_helper.sh! %(git tag -a #{tag} -m "Release #{tag}")
+  include_helper.push! "git push origin #{tag}"
+  include_helper.push! "gem push #{gem_file}"
+
+  puts ""
+  puts "=" * 60
+  puts "Promoted: #{rc_tag} \u2192 #{tag}"
+  puts "Tag: https://github.com/TheNotary/#{GEM_NAME}/releases/tag/#{tag}"
+  puts "=" * 60
+end
+
 desc "Run unit specs"
 RSpec::Core::RakeTask.new(:unit) do |t|
   t.rspec_opts = %w(-fd -c)

data/lib/foobar_templates/cli/cli.rb

@@ -1,3 +1,4 @@
 require 'foobar_templates/cli/dir_to_template'
 require 'foobar_templates/cli/cheat_sheet'
 require 'foobar_templates/cli/setup_personal_templates_repo'
+require 'foobar_templates/cli/template_generator'

data/lib/foobar_templates/cli/template_generator.rb

@@ -77,7 +77,7 @@ module FoobarTemplates::CLI
           puts cmd
           time_it("bootstrap_command") do
             Dir.chdir(target) do
-              `#{cmd}`
+              puts `#{cmd}`
             end
           end
         end
@@ -178,8 +178,9 @@ module FoobarTemplates::CLI
 
       reserved = Array(rules[:reserved_names]).map(&:to_s)
       if reserved.include?(name)
-        $stderr.puts "Invalid project name '#{name}': reserved by template '#{@options[:template]}'. Please choose another name."
-        raise
+        raise FoobarTemplates::CLIError, <<~HEREDOC
+          Invalid project name '#{name}': reserved by template '#{@options[:template]}'. Please choose another name.
+        HEREDOC
       end
 
       pattern = rules[:regex_validator]
@@ -187,13 +188,15 @@ module FoobarTemplates::CLI
         begin
           regex = Regexp.new(pattern.to_s)
         rescue RegexpError => e
-          $stderr.puts "Template '#{@options[:template]}' has an invalid name_validation.regex_validator: #{e.message}"
-          raise "invalid name_validation.regex_validator"
+          raise FoobarTemplates::CLIError, <<~HEREDOC
+            Template '#{@options[:template]}' has an invalid name_validation.regex_validator: #{e.message}
+          HEREDOC
         end
 
         unless regex.match?(name)
-          $stderr.puts "Invalid project name '#{name}': does not match #{regex.inspect} required by template '#{@options[:template]}'."
-          raise
+          raise FoobarTemplates::CLIError, <<~HEREDOC
+            Invalid project name '#{name}': does not match #{regex.inspect} required by template '#{@options[:template]}'.
+          HEREDOC
         end
       end
     end
@@ -463,31 +466,28 @@ module FoobarTemplates::CLI
     end
 
     def raise_no_files_in_template_error!
-      err_no_files_in_template = <<-HEREDOC
-Ooops, the template was found for '#{@options[:template]}' in ~/.foobar/templates,
-but no files were found within it.
+      raise FoobarTemplates::CLIError, <<~HEREDOC
+        The template was found for '#{@options[:template]}' in ~/.foobar/templates,
+        but no files were found within it.
 
-Exiting...
+        Exiting...
       HEREDOC
-      puts err_no_files_in_template
-      raise
     end
 
     def raise_project_with_that_name_already_exists!
-      err_project_with_that_name_exists = <<-HEREDOC
-Ooops, a project with the name #{target} already exists.
-Can't make project.  Either delete that folder or choose a new project name
+      raise FoobarTemplates::CLIError, <<~HEREDOC
+        A project with the name #{target} already exists.
+        Can't make project.  Either delete that folder or choose a new project name
 
-Exiting...
+        Exiting...
       HEREDOC
-      puts err_project_with_that_name_exists
-      raise
     end
 
     def raise_template_not_found!
-      err_missing_template = "Could not find template folder '#{@options[:template]}' in `~/.foobar/templates/`. Please check to make sure your desired template exists."
-      $stderr.puts err_missing_template
-      raise
+      raise FoobarTemplates::CLIError, <<~HEREDOC
+        Template not found for '#{@options[:template]}' in `~/.foobar/templates/`. 
+        Please check to make sure your desired template exists.
+      HEREDOC
     end
 
     def time_it(label = nil)
@@ -509,8 +509,9 @@ Exiting...
     # and won't overlap with a foobar_templates constant apparently...
     def ensure_safe_project_name(name, constant_array)
       if name =~ /^\d/
-        $stderr.puts "Invalid gem name #{name} Please give a name which does not start with numbers."
-        raise
+        raise FoobarTemplates::CLIError, <<~HEREDOC
+          Invalid gem name #{name}. Please give a name which does not start with numbers.
+        HEREDOC
       end
     end
 

data/lib/foobar_templates/version.rb

@@ -1,3 +1,5 @@
+VERSION = "2.0.1.rc5"
+
 module FoobarTemplates
-  VERSION = "2.0.1.rc4"
+  VERSION = ENV.fetch("GEM_VERSION", VERSION)
 end

data/lib/foobar_templates.rb

@@ -80,9 +80,7 @@ module FoobarTemplates
     end
 
     def generate_template(options, gem_name)
-      require 'foobar_templates/cli/template_generator'
-
-      template_generator = CLI::TemplateGenerator.new(options, gem_name).run
+      CLI::TemplateGenerator.new(options, gem_name).run
     rescue FoobarTemplates::CLIError => e
       msg = e.message
       $stderr.puts msg if msg && !msg.empty? && msg != e.class.name

data/spec/foobar_templates_spec.rb

@@ -9,6 +9,7 @@ describe FoobarTemplates do
 
     reset_test_env
     FileUtils.chdir(@dst_dir)
+    @dst_dir = FileUtils.pwd  # We need to resolve the /tmp dir incase it's a mac with /private/tmp
   end
 
   it 'has a version number' do
@@ -205,7 +206,7 @@ describe FoobarTemplates do
     5000.times { |i| File.write("#{template_dir}/node_modules/file_#{i}.rb", "ignored #{i}") }
     `git init #{template_dir}`
 
-    capture_stdout do 
+    capture_stdout do
       FoobarTemplates.generate_template(options, gem_name)
     end
 
@@ -242,6 +243,36 @@ describe FoobarTemplates do
     expect(output).to include "echo #{gem_name}"
   end
 
+  it "prints stdout of a multi-line bootstrap_command" do
+    # this is quite pointless, we're literally allowing the user to execute a command on their shell...
+    template_dir = create_user_defined_template("testing", "template-user-supplied")
+    options = { bin: false, ext: false, coc:  false, template: "template-user-supplied" }
+    gem_name = "good-dog"
+
+    yaml_content = <<~YAML
+      bootstrap_command: |
+        echo 'foo-bar'
+        pwd
+        cd ..
+        pwd
+    YAML
+
+    File.write("#{template_dir}/foobar.yml", yaml_content)
+    File.write("#{template_dir}/README.md", "# Readme...")
+    `git init #{template_dir}`
+
+    output = capture_stdout { FoobarTemplates.generate_template(options, gem_name) }
+
+    expect(output).to end_with <<~OUTPUT
+      pwd
+      good-dog
+      #{@dst_dir}/good-dog
+      #{@dst_dir}
+
+      Complete.
+    OUTPUT
+  end
+
   describe "name_validation" do
     it "rejects names listed in reserved_names and skips bootstrap_command" do
       template_dir = create_user_defined_template("testing", "template-user-supplied")
@@ -255,9 +286,7 @@ describe FoobarTemplates do
       File.write("#{template_dir}/README.md", "# Readme")
       `git init #{template_dir}`
 
-      expect {
-        capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
-      }.to raise_error(RuntimeError)
+      capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
 
       expect($captured_stderr).to include "reserved by template"
       expect(File).not_to exist("#{@dst_dir}/#{gem_name}")
@@ -292,9 +321,7 @@ describe FoobarTemplates do
       File.write("#{template_dir}/README.md", "# Readme")
       `git init #{template_dir}`
 
-      expect {
-        capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
-      }.to raise_error(RuntimeError)
+      capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
 
       expect($captured_stderr).to include "does not match"
       expect(File).not_to exist("#{@dst_dir}/#{gem_name}")
@@ -329,9 +356,7 @@ describe FoobarTemplates do
       File.write("#{template_dir}/README.md", "# Readme")
       `git init #{template_dir}`
 
-      expect {
-        capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
-      }.to raise_error(RuntimeError)
+      capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
 
       expect($captured_stderr).to include "reserved"
     end
@@ -348,9 +373,7 @@ describe FoobarTemplates do
       File.write("#{template_dir}/README.md", "# Readme")
       `git init #{template_dir}`
 
-      expect {
-        capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
-      }.to raise_error(RuntimeError)
+      capture_stdout { capture_stderr { FoobarTemplates.generate_template(options, gem_name) } }
 
       expect($captured_stderr).to include "invalid name_validation.regex_validator"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobar_templates
 version: !ruby/object:Gem::Version
-  version: 2.0.1.rc4
+  version: 2.0.1.rc5
 platform: ruby
 authors:
 - TheNotary
@@ -130,9 +130,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/TheNotary/foobar_templates/issues
-  changelog_uri: https://github.com/TheNotary/foobar_templates/releases/tag/v2.0.1.rc4
+  changelog_uri: https://github.com/TheNotary/foobar_templates/releases/tag/v2.0.1.rc5
   documentation_uri: https://github.com/TheNotary/foobar_templates
-  source_code_uri: https://github.com/TheNotary/foobar_templates/tree/v2.0.1.rc4
+  source_code_uri: https://github.com/TheNotary/foobar_templates/tree/v2.0.1.rc5
 rdoc_options: []
 require_paths:
 - lib