planter-cli 3.0.1 → 3.0.3

data/lib/tty-spinner/tasks/spec.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = "spec/{unit,integration}{,/*/**}/*_spec.rb"
+  end
+
+  namespace :spec do
+    desc "Run unit specs"
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = "spec/unit{,/*/**}/*_spec.rb"
+    end
+
+    desc "Run integration specs"
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = "spec/integration{,/*/**}/*_spec.rb"
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/lib/tty-spinner/tty-spinner.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/tty/spinner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-spinner"
+  spec.version       = TTY::Spinner::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = ["piotr@piotrmurach.com"]
+  spec.summary       = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.description   = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.homepage      = "https://ttytoolkit.org"
+  spec.license       = "MIT"
+  if spec.respond_to?(:metadata=)
+    spec.metadata = {
+      "allowed_push_host" => "https://rubygems.org",
+      "bug_tracker_uri"   => "https://github.com/piotrmurach/tty-spinner/issues",
+      "changelog_uri"     => "https://github.com/piotrmurach/tty-spinner/blob/master/CHANGELOG.md",
+      "documentation_uri" => "https://www.rubydoc.info/gems/tty-spinner",
+      "funding_uri"       => "https://github.com/sponsors/piotrmurach",
+      "homepage_uri"      => spec.homepage,
+      "rubygems_mfa_required" => "true",
+      "source_code_uri"   => "https://github.com/piotrmurach/tty-spinner"
+    }
+  end
+  spec.files         = Dir["lib/**/*"]
+  spec.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "tty-cursor", "~> 0.7"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

data/scripts/runtests.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
 cd /planter
-bundle install
+bundle update
 rake test

data/spec/cli_spec.rb

@@ -0,0 +1,27 @@
+require 'open3'
+require 'spec_helper'
+
+include PlanterHelpers
+
+describe 'CLI' do
+  TEST_DIR = File.join(File.dirname(__FILE__), 'test')
+
+  before do
+    FileUtils.rm_rf(TEST_DIR)
+    FileUtils.mkdir_p(TEST_DIR)
+  end
+
+  after do
+    FileUtils.rm_rf(TEST_DIR)
+  end
+
+  it 'displays help message' do
+    output, stderr, status = planter('--help')
+    expect(output).not_to be_empty
+  end
+
+  it 'plants a new project' do
+    output, stderr, status = planter('--defaults', "--in=#{TEST_DIR}", 'test')
+    expect(File.exist?(File.join(TEST_DIR, 'bollocks_and_beans.rtf'))).to be true
+  end
+end

data/spec/planter/string_spec.rb

@@ -114,6 +114,33 @@ describe ::String do
     end
   end
 
+  describe '.apply_logic' do
+    it 'applies a single logic replacement' do
+      template = 'Hello %%if language == ruby%%World%%else%%There%%end%%!'
+      logic = { language: 'ruby' }
+      expect(template.apply_logic(logic)).to eq 'Hello World!'
+    end
+
+    it 'handles quotes in logic' do
+      template = 'Hello %%if language == "ruby"%%World%%else%%There%%end%%!'
+      logic = { language: 'ruby' }
+      expect(template.apply_logic(logic)).to eq 'Hello World!'
+    end
+
+    it 'handles no logic replacements' do
+      template = 'Hello, World!'
+      logic = {}
+      expect(template.apply_logic(logic)).to eq 'Hello, World!'
+    end
+
+    it 'Operates in place' do
+      template = 'Hello %%if language == "ruby"%%World%%else%%There%%end%%!'
+      logic = { language: 'ruby' }
+      template.apply_logic!(logic)
+      expect(template).to eq 'Hello World!'
+    end
+  end
+
   describe '.apply_regexes' do
     it 'applies a single regex replacement' do
       template = 'Hello, World!'
@@ -171,15 +198,15 @@ describe ::String do
     end
 
     it 'normalizes a multiline type' do
-      expect("multi".normalize_type.to_s).to eq "multiline"
+      expect("para".normalize_type.to_s).to eq "multiline"
     end
 
     it 'normalizes a class type' do
-      expect("c".normalize_type.to_s).to eq "class"
+      expect("cl".normalize_type.to_s).to eq "class"
     end
 
-    it 'normalizes a module type' do
-      expect("m".normalize_type.to_s).to eq "module"
+    it 'normalizes a multiple choice type' do
+      expect("choice".normalize_type.to_s).to eq "choice"
     end
   end
 

data/spec/spec_helper.rb

@@ -24,3 +24,29 @@ RSpec.configure do |c|
   end
   c.add_formatter 'd'
 end
+
+require 'open3'
+require 'time'
+
+module PlanterHelpers
+  PLANTER_EXEC = File.join(File.dirname(__FILE__), '..', 'exe', 'plant')
+
+  def planter_with_env(env, *args, stdin: nil)
+    pread(env, 'bundle', 'exec', PLANTER_EXEC, "--base-dir=#{File.dirname(__FILE__)}", *args, stdin: stdin)
+  end
+
+  def pread(env, *cmd, stdin: nil)
+    out, err, status = Open3.capture3(env, *cmd, stdin_data: stdin)
+    unless status.success?
+      raise [
+        "Error (#{status}): #{cmd.inspect} failed", "STDOUT:", out.inspect, "STDERR:", err.inspect
+      ].join("\n")
+    end
+
+    [out, err, status]
+  end
+
+  def planter(*args, stdin: nil)
+    planter_with_env({}, *args, stdin: stdin)
+  end
+end

data/spec/templates/test/_planter.yml

@@ -1,12 +1,9 @@
 ---
 variables:
-- key: var_key
+- key: project
   prompt: CLI Prompt
-  type: "[string, float, integer, number, date]"
-  value: "(optional, for date type can be today, time, now, etc., empty to prompt)"
-  default: "(optional default value, leave empty or remove key for no default)"
-  min: "(optional, for number type set a minimum value)"
-  max: "(optional, for number type set a maximum value)"
+  type: string
+  default: "bollocks and beans"
 git_init: false
 files:
   "*.tmp": ignore

data/src/_README.md

@@ -32,9 +32,9 @@ git_init: false
 preserve_tags: true
 ```
 
-### Scripts.
+### Scripts
 
-Scripts for execution after planting can be stored in `~/.config/planter/scripts` and referenced by filename only. Alternatively, scripts may be stored within a template in a `_scritps` subfolder.
+Scripts for execution after planting can be stored in `~/.config/planter/scripts` and referenced by filename only. Alternatively, scripts may be stored within a template in a `_scripts` subfolder.
 
 Scripts can be executable files in any language, and receive the template directory and the planted directory as arguments $1 and $2.
 
@@ -52,7 +52,7 @@ First, there's a `variables` section that defines variables used in the template
 variables:
   - key: var_key
     prompt: Prompt text
-    type: string # [string,multiline,float,integer,number,date] defaults to string
+    type: string # [string,paragraph,float,integer,number,date,choice] defaults to string
     # value: (force value, string can include %%variables%% and regexes will be replaced. For date type can be today, time, now, etc.)
     default: Untitled
     min: 1
@@ -69,6 +69,85 @@ repo: # If a repository URL is provided, it will be pulled and duplicated instea
 
 In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration. This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
 
+#### Multiple choice type
+
+If the `type` is set to `choice`, then the key `choices` can contain a hash or array of choices. The key that accepts the choice should be surrounded with parenthesis (required for each choice).
+
+If a Hash is defined, each choice can have a result string:
+
+```yaml
+variables:
+  - key: shebang
+    prompt: Shebang line
+    type: choice
+    default: r
+    choices:
+      (r)uby: "#! /usr/bin/env ruby"
+      (j)avascript: "#! /usr/bin/env node"
+      (p)ython: "#! /usr/bin/env python"
+      (b)ash: "#! /bin/bash"
+      (z)sh: "#! /bin/zsh"
+```
+
+If an array is defined, the string of the choice will also be its result:
+
+```yaml
+variables:
+  - key: language
+    prompt: Programming language
+    type: choice
+    default: 1
+    choices:
+      - 1. ruby
+      - 1. javascript
+      - 1. python
+      - 1. bash
+      - 1. zsh
+```
+
+If the choice starts with a number (as above), then a numeric list will be generated and typing the associated index number will accept that choice. Numeric lists are automatically numbered, so the preceding digit doesn't matter, as long as it's a digit. In this case a default can be defined with an integer for its placement in the list (starting with 1), and parenthesis aren't required.
+
+#### If/then logic
+
+A template can use if/then logic, which is useful with multiple choice types. It can be applied to any type, though.
+
+The format for if/then logic is:
+
+```
+%%if KEY OPERATOR VALUE%%
+content
+%%else if KEY OPERATOR VALUE2%%
+content 2
+%%else%%
+content 3
+%%endif%%
+```
+
+There should be no spaces around the comparison, e.g. `%% if language == javascript %%` won't work. The block must start with an `if` statement and end with `%%endif%%` or `%%end%%`. The `%%else%%` statement is optional -- if it doesn't exist then the entire block will be removed if no conditions are met.
+
+The key should be an existing key defined in `variables`. The operator can be any of:
+
+- `==` or `=` (equals)
+- `=~` (matches regex)
+- `*=` (contains)
+- `^=` (starts with)
+- `$=` (ends with)
+- `>` (greater than)
+- `>=` (greater than or equal)
+- `<` (less than)
+- `<=` (less than or equal)
+
+The value after the operator doesn't need to be quoted, anything after the operator will be compared to the value of the key.
+
+Logic can be used on multiple lines like the example above, or on a single line (useful for filenames):
+
+```
+%%project%%.%%if language == javascript%%js%%else if language == ruby%%rb%%else%%sh%%endif%%
+```
+
+Content within if/else blocks can contain variables.
+
+
 ### File-specific handling
 
 A `files` dictionary can specify how to handle specific files. Options are `copy`, `overwrite`, `merge`, or `ask`. The key for each entry is a filename or glob that matches the source filename (accounting for template variables if applicable):
@@ -79,6 +158,8 @@ files:
   "%%title%%.md": overwrite
 ```
 
+Filenames can include wildcards (`*`, `?`), and Bash-ish globbing (`[0-9]`, `[a-z]`, `{one,two,three}`).
+
 If `merge` is specified, then the source file is scanned for merge comments and those are merged if they don't exist in the copied/existing file. If no merge comments are defined, then the entire contents of the source file are appended to the destination file (unless the file already matches the source). Merge comments start with `merge` and end with `/merge` and can have any comment syntax preceding them, for example:
 
 ```
@@ -109,7 +190,7 @@ replacements:
   "(main|app)\.js": "%%script:lower%%.js"
 ```
 
-Replacements are performed on both file/directory names and file contents.
+Replacements are performed on both file/directory names and file contents. This is especially handy when the source of the plant is a Git repo, allowing the replacement of elements without having to create %%templated%% filenames and contents.
 
 ### Finder Tags
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -342,6 +342,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".gitmodules"
 - ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
@@ -359,8 +360,10 @@ files:
 - docker/Dockerfile-2.6
 - docker/Dockerfile-2.7
 - docker/Dockerfile-3.0
+- docker/Dockerfile-3.3
 - docker/bash_profile
 - docker/inputrc
+- docker/sources.list
 - lib/.rubocop.yml
 - lib/planter.rb
 - lib/planter/array.rb
@@ -377,10 +380,90 @@ files:
 - lib/planter/symbol.rb
 - lib/planter/tag.rb
 - lib/planter/version.rb
+- lib/tty-spinner/.editorconfig
+- lib/tty-spinner/.github/FUNDING.yml
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/BUG_REPORT.md
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/config.yml
+- lib/tty-spinner/.github/PULL_REQUEST_TEMPLATE.md
+- lib/tty-spinner/.github/workflows/ci.yml
+- lib/tty-spinner/.gitignore
+- lib/tty-spinner/.rspec
+- lib/tty-spinner/.rubocop.yml
+- lib/tty-spinner/CHANGELOG.md
+- lib/tty-spinner/CODE_OF_CONDUCT.md
+- lib/tty-spinner/Gemfile
+- lib/tty-spinner/LICENSE.txt
+- lib/tty-spinner/README.md
+- lib/tty-spinner/Rakefile
+- lib/tty-spinner/appveyor.yml
+- lib/tty-spinner/bin/console
+- lib/tty-spinner/bin/setup
+- lib/tty-spinner/demo.gif
+- lib/tty-spinner/examples/auto_spin.rb
+- lib/tty-spinner/examples/basic.rb
+- lib/tty-spinner/examples/clear.rb
+- lib/tty-spinner/examples/color.rb
+- lib/tty-spinner/examples/error.rb
+- lib/tty-spinner/examples/formats.rb
+- lib/tty-spinner/examples/hide_cursor.rb
+- lib/tty-spinner/examples/log.rb
+- lib/tty-spinner/examples/multi/basic.rb
+- lib/tty-spinner/examples/multi/basic_top_level.rb
+- lib/tty-spinner/examples/multi/custom_style.rb
+- lib/tty-spinner/examples/multi/files.rb
+- lib/tty-spinner/examples/multi/jobs.rb
+- lib/tty-spinner/examples/multi/multi.rb
+- lib/tty-spinner/examples/multi/multi_top_level.rb
+- lib/tty-spinner/examples/multi/pause.rb
+- lib/tty-spinner/examples/multi/threaded.rb
+- lib/tty-spinner/examples/pause.rb
+- lib/tty-spinner/examples/run.rb
+- lib/tty-spinner/examples/success.rb
+- lib/tty-spinner/examples/threaded.rb
+- lib/tty-spinner/examples/update.rb
+- lib/tty-spinner/lib/tty-spinner.rb
+- lib/tty-spinner/lib/tty/spinner.rb
+- lib/tty-spinner/lib/tty/spinner/formats.rb
+- lib/tty-spinner/lib/tty/spinner/multi.rb
+- lib/tty-spinner/lib/tty/spinner/version.rb
+- lib/tty-spinner/spec/spec_helper.rb
+- lib/tty-spinner/spec/unit/auto_spin_spec.rb
+- lib/tty-spinner/spec/unit/clear_spec.rb
+- lib/tty-spinner/spec/unit/error_spec.rb
+- lib/tty-spinner/spec/unit/events_spec.rb
+- lib/tty-spinner/spec/unit/formats_spec.rb
+- lib/tty-spinner/spec/unit/frames_spec.rb
+- lib/tty-spinner/spec/unit/hide_cursor_spec.rb
+- lib/tty-spinner/spec/unit/job_spec.rb
+- lib/tty-spinner/spec/unit/join_spec.rb
+- lib/tty-spinner/spec/unit/log_spec.rb
+- lib/tty-spinner/spec/unit/multi/auto_spin_spec.rb
+- lib/tty-spinner/spec/unit/multi/error_spec.rb
+- lib/tty-spinner/spec/unit/multi/line_inset_spec.rb
+- lib/tty-spinner/spec/unit/multi/on_spec.rb
+- lib/tty-spinner/spec/unit/multi/register_spec.rb
+- lib/tty-spinner/spec/unit/multi/spin_spec.rb
+- lib/tty-spinner/spec/unit/multi/stop_spec.rb
+- lib/tty-spinner/spec/unit/multi/success_spec.rb
+- lib/tty-spinner/spec/unit/new_spec.rb
+- lib/tty-spinner/spec/unit/pause_spec.rb
+- lib/tty-spinner/spec/unit/reset_spec.rb
+- lib/tty-spinner/spec/unit/run_spec.rb
+- lib/tty-spinner/spec/unit/spin_spec.rb
+- lib/tty-spinner/spec/unit/stop_spec.rb
+- lib/tty-spinner/spec/unit/success_spec.rb
+- lib/tty-spinner/spec/unit/tty_spec.rb
+- lib/tty-spinner/spec/unit/update_spec.rb
+- lib/tty-spinner/tasks/console.rake
+- lib/tty-spinner/tasks/coverage.rake
+- lib/tty-spinner/tasks/spec.rake
+- lib/tty-spinner/tty-spinner.gemspec
 - planter-cli.gemspec
 - scripts/deploy.rb
 - scripts/runtests.sh
 - spec/.rubocop.yml
+- spec/cli_spec.rb
 - spec/config.yml
 - spec/planter.yml
 - spec/planter/array_spec.rb
@@ -430,6 +513,7 @@ specification_version: 4
 summary: Plant files and directories using templates
 test_files:
 - spec/.rubocop.yml
+- spec/cli_spec.rb
 - spec/config.yml
 - spec/planter.yml
 - spec/planter/array_spec.rb