planter-cli 3.0.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b54e16d9836121fd1fa5831a1c7433056f45e9372b9985640a6052a2852aab
-  data.tar.gz: d2a57bd628c33f9dcccdc605577a11e4aaacbeef3a0c261f96835771f8fc0223
+  metadata.gz: 06c272d8c938a24e24d8ad5ec220ba9100f6f35fbe6e8d9765a33c982607dbd0
+  data.tar.gz: f9a21781e985fce37c419fcf5f4e6f33cd13c951cd882468b6c90e3a19b50fdd
 SHA512:
-  metadata.gz: 0001cffb09df38704dbeadb6b68b42418a0b02741430fd3932fcdf845d53052945d1e51dd5bd6227c8f02cd70fbbd86f8d037bd1ef2da7547c5ae3f859320a93
-  data.tar.gz: b612aa38f0aaa7d1746b8715e032e93550735510b9e0e5f90cbdaef35d0cb0eea3f9afbc8c1f001f03eb40c0de41f7773e5ef7f4799e1792a4543be36ff4074b
+  metadata.gz: ffbd475e7f56a2c96cf325cd1a681e9a7541d191c9cc9f669c06e2b3a74b4c889b2256290c5b390ea36aa408bc5e262f605ed0106e4ec409b2dece751adbbcbc
+  data.tar.gz: cc9241c6c6ac2a10ac2d5b82cdf2e6c204472c18834b113499af57e18615706a429c2900d19bdb9aa287c2d77bbe0f0a0a22c29288c10fceb292d623a23c86c3

data/.gitignore

@@ -46,3 +46,4 @@ Gemfile.lock
 spec/test/
 spec/noop
 bundle
+.vscode

data/.rubocop.yml

@@ -11,7 +11,7 @@ AllCops:
     - Gemfile
     - Guardfile
     - Rakefile
-    - bin/planter
+    - bin/plant
     - lib/**/*.rb
   Exclude:
     - pkg/**/*.rb
@@ -41,7 +41,6 @@ Metrics/BlockLength:
   Max: 45
   Exclude:
     - Rakefile
-    - bin/untitled
     - lib/*.rb
 
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 3.0.4
+
+2024-09-02 08:43
+
+#### FIXED
+
+- Incorrect binary name in help banner
+
+### 3.0.3
+
+2024-09-02 08:02
+
+#### CHANGED
+
+- Multiline is now "paragraph"
+- Module type now requires "mod" at minimum
+
+#### NEW
+
+- Multiple choice variable type (ch|mu)
+- If/then logic in templates
+
 ### 3.0.2
 
 2024-09-01 09:46

data/README.md

@@ -8,10 +8,6 @@ Plant a directory structure and files using templates.
 
 If you run into errors, try `gem install --user-install planter-cli`, or as a last ditch effort, `sudo gem install planter-cli`.
 
-### Optional
-
-If [Gum](https://github.com/charmbracelet/gum) is available it will be used for command line input.
-
 ## Configuration
 
 Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
@@ -37,7 +33,7 @@ Scripts can be executable files in any language, and receive the template direct
 
 Templates are directories found in `~/.config/planter/templates/[TEMPLATE_NAME]`. All files and directories inside of these template directories are copied when that template is called. Filenames, directory names, and file contents can all use template placeholders.
 
-Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. %%KEY%% placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
+Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. `%%KEY%%` placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
 
 Each template contains a `_planter.yml` file that defines variables and other configuration options. The file format for all configuration files is [YAML](https://yaml.org/spec/1.2.2/).
 
@@ -47,22 +43,108 @@ 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
     max: 5
+```
+
+A configuration can include additional keys:
+
+```yaml
 script: # array of scripts, args passed as [script and args] TEMPLATE_DIR PWD
   - process.py
 git_init: false # if true, initialize a git repository in the newly-planted directory
 files: # Dictionary for file handling (see [File-specific handling](#file-specific-handling))
 replacements: # Dictionary of pattern/replacments for regex substitution, see [Regex replacements](#regex-replacements)
-repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
+repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying an existing file structure
 ```
 
 #### Default values in template strings
 
-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%%`.
+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 (or doesn't exist). 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/Dictionary 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"
+```
+
+When a choice is selected from a dictionary, the result string will be inserted instead of the choice title.
+
+If an array is defined, the string of the choice will also be its result (minus any parenthesis):
+
+```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 (in the `defaults:` key) 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
 
@@ -74,7 +156,7 @@ files:
   "%%title%%.md": overwrite
 ```
 
-Filenames can include wildcards (`*`, `?`), and Bash-style globbing (`[0-9]`, `[a-z]`, `{one,two,three}`).
+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:
 
@@ -117,7 +199,7 @@ If `preserve_tags` is set to `true` in the config (either base or template), the
 The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.
 
 ```
-Usage: planter [options] TEMPLATE
+Usage: plant [options] TEMPLATE
     --defaults                       Accept default values for all variables
     -i, --in TARGET                  Plant in TARGET instead of current directory
     -o, --overwrite                  Overwrite existing files

data/bin/plant

@@ -26,7 +26,7 @@ Planter.base_dir = ENV['PLANTER_DIR'] || File.expand_path('~/.config/planter')
 Planter::Color.coloring = $stdout.isatty
 
 opts = OptionParser.new
-opts.banner = 'Usage: planter [options] TEMPLATE'
+opts.banner = 'Usage: plant [options] TEMPLATE'
 
 Planter.accept_defaults = false
 opts.on('--defaults', 'Accept default values for all variables') do

data/docker/Dockerfile-2.6

@@ -4,7 +4,8 @@ WORKDIR /planter
 RUN gem install bundler:2.2.29
 COPY ./docker/sources.list /etc/apt/sources.list
 RUN apt-get update -y --allow-insecure-repositories || true
-RUN apt-get install -y less vim
+RUN apt-get install -y sudo || true
+RUN sudo apt-get install -y less vim || true
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-2.7

@@ -4,7 +4,8 @@ WORKDIR /planter
 RUN gem install bundler:2.2.29
 COPY ./docker/sources.list /etc/apt/sources.list
 RUN apt-get update -y --allow-insecure-repositories || true
-RUN apt-get install -y less vim
+RUN apt-get install -y sudo || true
+RUN sudo apt-get install -y less vim || true
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-3.0

@@ -4,7 +4,8 @@ WORKDIR /planter
 RUN gem install bundler:2.2.29
 COPY ./docker/sources.list /etc/apt/sources.list
 RUN apt-get update -y --allow-insecure-repositories || true
-RUN apt-get install -y less vim
+RUN apt-get install -y sudo || true
+RUN sudo apt-get install -y less vim || true
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-3.3

@@ -5,7 +5,8 @@ WORKDIR /planter
 RUN gem install bundler:2.2.29
 COPY ./docker/sources.list /etc/apt/sources.list
 RUN apt-get update -y --allow-insecure-repositories || true
-RUN apt-get install -y less vim
+RUN apt-get install -y sudo || true
+RUN sudo apt-get install -y less vim || true
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
 CMD ["/planter/scripts/runtests.sh"]

data/docker/bash_profile

@@ -2,6 +2,7 @@
 export GLI_DEBUG=true
 export EDITOR="/usr/bin/vim"
 alias b="bundle exec bin/plant"
+alias be="bundle exec"
 alias quit="exit"
 
 shopt -s nocaseglob
@@ -11,5 +12,5 @@ shopt -s histverify
 shopt -s cmdhist
 
 cd /planter
-bundle install
+bundle update
 gem install pkg/*.gem

data/lib/planter/array.rb

@@ -12,7 +12,7 @@ module Planter
     ## @param      default  [String] The color templated output string
     ##
     def abbr_choices(default: nil)
-      chars = join(' ').scan(/\((.)\)/).map { |c| c[0] }
+      chars = join(' ').scan(/\((?:(.)\.?)\)/).map { |c| c[0] }
       out = String.new
       out << '{xdw}['
       out << chars.map do |c|
@@ -25,6 +25,61 @@ module Planter
       out << '{dw}]{x}'
     end
 
+    ## Convert an array of choices to a string with optional numbering
+    ##
+    ## @param      numeric  [Boolean] Include numbering
+    ##
+    ## @return     [Array] Array of choices
+    ##
+    def to_options(numeric)
+      map.with_index do |c, i|
+        # v = c.to_s.match(/\(?([a-z]|\d+\.?)\)?/)[1].strip
+        if numeric
+          "(#{i + 1}). #{c.to_s.sub(/^\(?\d+\.?\)? +/, '')}"
+        else
+          c
+        end
+      end
+    end
+
+    ## Find the index of a choice in an array of choices
+    ##
+    ## @param      choice  [String] The choice to find
+    ##
+    ## @return     [Integer] Index of the choice
+    ##
+    def option_index(choice)
+      index = find_index { |c| c.to_s.match(/\((.+)\)/)[1].strip.sub(/\.$/, '') == choice }
+      index || false
+    end
+
+    ## Convert an array of choices to a hash
+    ##  - If the array contains hashes, they are converted to key/value pairs
+    ##  - If the array contains strings, they are used as both key and value
+    ##
+    ## @return     [Hash] Hash of choices
+    ##
+    def choices_to_hash
+      hash = {}
+      each do |c|
+        if c.is_a?(Hash)
+          hash[c.keys.first.to_s] = c.values.first.to_s
+        else
+          hash[c.to_s] = c.to_s
+        end
+      end
+
+      hash
+    end
+
+    ## Clean strings in an array by removing numbers and parentheses
+    ##
+    ## @return [Array] Array with cleaned strings
+    ##
+    def to_values
+      map(&:clean_value)
+    end
+
     ##
     ## Stringify keys in an array of hashes or arrays
     ##

data/lib/planter/hash.rb

@@ -3,6 +3,30 @@
 module Planter
   ## Hash helpers
   class ::Hash
+    ## Turn all keys and values into string
+    ##
+    ## @return     [Hash] copy of the hash where all its keys are strings
+    ##
+    def stringify
+      each_with_object({}) do |(k, v), hsh|
+        hsh[k.to_s] = if v.is_a?(Hash) || v.is_a?(Array)
+                        v.stringify
+                      else
+                        v.to_s
+                      end
+      end
+    end
+
+    ## Destructive version of #stringify
+    ##
+    ## @return [Hash] Hash with stringified keys and values
+    ##
+    ## @see #stringify
+    ##
+    def stringify!
+      replace stringify
+    end
+
     ## Turn all keys into string
     ##
     ## @return     [Hash] copy of the hash where all its keys are strings

data/lib/planter/plant.rb

@@ -45,7 +45,8 @@ module Planter
           default: var[:default],
           value: var[:value],
           min: var[:min],
-          max: var[:max]
+          max: var[:max],
+          choices: var[:choices] || nil
         )
         answer = q.ask
         if answer.nil?
@@ -158,8 +159,8 @@ module Planter
           s.run
         end
       end
-      Planter.spinner.update(title: '😄')
-      Planter.spinner.success(' Planting complete!')
+      Planter.spinner.update(title: 'Planting complete!')
+      Planter.spinner.success
     end
 
     ##
@@ -182,19 +183,20 @@ module Planter
         next if File.binary?(file)
 
         content = IO.read(file)
-        new_content = content.apply_variables.apply_regexes
+
+        new_content = content.apply_logic.apply_variables.apply_regexes
 
         new_content.gsub!(%r{^.{.4}/?merge *.{,4}\n}, '') if new_content =~ /^.{.4}merge *\n/
 
         unless content == new_content
-          Planter.notify("Applying variables to #{file}", :debug, above_spinner: true)
+          Planter.notify("Applying variables to #{file}", :debug)
           File.open(file, 'w') { |f| f.puts new_content }
         end
       end
 
       true
     rescue StandardError => e
-      Planter.notify("#{e}\n#{e.backtrace}", :debug, above_spinner: true)
+      Planter.notify("#{e}\n#{e.backtrace}", :debug)
       'Error updating files/directories'
     end
 
@@ -215,7 +217,7 @@ module Planter
 
       true
     rescue StandardError => e
-      Planter.notify("#{e}\n#{e.backtrace}", :debug, above_spinner: true)
+      Planter.notify("#{e}\n#{e.backtrace}", :debug)
       'Error initializing git'
     end
   end

data/lib/planter/prompt.rb

@@ -23,6 +23,7 @@ module Planter
         @prompt = question[:prompt] || nil
         @default = question[:default]
         @value = question[:value]
+        @choices = question[:choices] || []
         @gum = false # TTY::Which.exist?('gum')
       end
 
@@ -37,6 +38,8 @@ module Planter
         return @value.to_s.apply_variables.apply_regexes.coerce(@type) if @value && @type != :date
 
         res = case @type
+              when :choice
+                Prompt.choice(@choices, @prompt, default_response: @default)
               when :integer
                 read_number(integer: true)
               when :float
@@ -238,18 +241,36 @@ module Planter
     ## @param      default_response  [String] The character of the default
     ##                               response
     ##
-    ## @return     [String] character of selected response, lowercased
+    ## @return     [String] string of selected response with parenthesis removed
     ##
     def self.choice(choices, prompt = 'Make a selection', default_response: nil)
       $stdin.reopen('/dev/tty')
 
-      default = default_response.is_a?(String) ? default_response.downcase : nil
+      choices = choices.choices_to_hash if choices.is_a?(Array) && choices.first.is_a?(Hash)
 
-      # if this isn't an interactive shell, answer default
-      return default unless $stdout.isatty
+      if choices.is_a?(Hash)
+        choices.stringify!
+        numeric = choices.keys.first =~ /^\(?\d+\.?\)? /
+        keys = choices.keys.to_options(numeric)
+        values = choices.values.map(&:clean_value)
+        choices = choices.keys
+      else
+        numeric = choices.first =~ /^\(?\d+\.?\)? /
+        keys = choices.to_options(numeric)
+        values = choices.to_values.map(&:clean_value)
+      end
 
-      # If --defaults is set, return default
-      return default if Planter.accept_defaults || ENV['PLANTER_DEBUG']
+      default = case default_response.to_s
+                when /^\d+$/
+                  values[default.to_i]
+                when /^[a-z]$/i
+                  keys.include?(default_response) ? values[keys.index(default_response)] : nil
+                end
+
+      # If --defaults is set or not an interactive shell, return default
+      return default if Planter.accept_defaults || ENV['PLANTER_DEBUG'] || !$stdout.isatty
+
+      default = default_response.to_s if default_response
 
       # clear the buffer
       if ARGV&.length
@@ -259,9 +280,10 @@ module Planter
       end
       system 'stty cbreak'
 
-      vertical = choices.join(' ').length + 4 > TTY::Screen.cols
-      desc = choices.map { |c| c.highlight_character(default: default) }
-      abbr = choices.abbr_choices(default: default)
+      vertical = numeric || choices.join(', ').length + 4 > TTY::Screen.cols
+
+      desc = keys.map { |c| c.highlight_character(default: default) }
+      abbr = keys.abbr_choices(default: default)
 
       options = if vertical
                   "{x}#{desc.join("\n")}\n{by}#{prompt}{x} #{abbr}{bw}? "
@@ -270,16 +292,34 @@ module Planter
                 end
 
       $stdout.syswrite options.x
-      res = $stdin.sysread 1
+
+      res = if numeric && choices.length > 9
+              $stdin.sysread choices.length.to_s.length
+            else
+              $stdin.sysread 1
+            end
+
       puts
       system 'stty cooked'
 
       res.chomp!
       res.downcase!
 
-      res.empty? ? default : res
+      res = res.empty? ? default : res
+
+      if res.to_i.positive?
+        values[res.to_i - 1]
+      elsif res =~ /^[a-z]/ && keys&.option_index(res)
+        values[keys.option_index(res)]
+      end
     end
 
+    ## Determine what to do with a file
+    ##
+    ## @param entry [FileEntry] The file entry
+    ##
+    ## @return [Symbol] :merge, :overwrite, :copy, :ignore
+    ##
     def self.file_what?(entry)
       options = %w[(o)vewrite (m)erge]
       options << '(c)opy' unless File.exist?(entry.target)

data/lib/planter/string.rb

@@ -12,7 +12,20 @@ module Planter
     ## @return     [Symbol] string as variable key
     ##
     def to_var
-      snake_case.to_sym
+      strip_quotes.snake_case.to_sym
+    end
+
+    ## Strip quotes from a string
+    ##
+    ## @return [String] string with quotes stripped
+    ##
+    def strip_quotes
+      sub(/^(["'])(.*)\1$/, '\2')
+    end
+
+    ## Destructive version of #strip_quotes
+    def strip_quotes!
+      replace strip_quotes
     end
 
     #
@@ -184,6 +197,96 @@ module Planter
       replace apply_defaults(variables)
     end
 
+    ## Apply logic to a string
+    ##
+    ## @param variables [Hash] Hash of variables to apply
+    ##
+    def apply_logic(variables = nil)
+      variables = variables.nil? ? Planter.variables : variables
+
+      gsub(/%%if .*?%%.*?%%end(if)?%%/mi) do |construct|
+        res = false
+        # Get the condition and the content
+        output = construct.match(/%%else%%(.*?)%%end/m) ? Regexp.last_match(1) : ''
+
+        conditions = construct.to_enum(:scan,
+                                       /%%(?<statement>(?:els(?:e )?)?if) (?<condition>.*?)%%(?<content>.*?)(?=%%)/mi).map do
+          Regexp.last_match
+        end
+        conditions.each do |condition|
+          variable, operator, value = condition['condition'].split(/ +/, 3)
+          value.strip_quotes!
+          variable = variable.to_var
+          negate = false
+          if operator =~ /^!/
+            operator = operator[1..-1]
+            negate = true
+          end
+          operator = case operator
+                     when /^={1,2}/
+                       :equal
+                     when /^=~/
+                       :matches_regex
+                     when /\*=/
+                       :contains
+                     when /\^=/
+                       :starts_with
+                     when /\$=/
+                       :ends_with
+                     when />/
+                       :greater_than
+                     when /</
+                       :less_than
+                     when />=/
+                       :greater_than_or_equal
+                     when /<=/
+                       :less_than_or_equal
+                     else
+                       :equal
+                     end
+
+          comp = variables[variable.to_var].to_s
+
+          res = case operator
+                when :equal
+                  comp =~ /^#{value}$/i
+                when :matches_regex
+                  comp =~ Regexp.new(value.gsub(%r{^/|/$}, ''))
+                when :contains
+                  comp =~ /#{value}/i
+                when :starts_with
+                  comp =~ /^#{value}/i
+                when :ends_with
+                  comp =~ /#{value}$/i
+                when :greater_than
+                  comp > value.to_f
+                when :less_than
+                  comp < value.to_f
+                when :greater_than_or_equal
+                  comp >= value.to_f
+                when :less_than_or_equal
+                  comp <= value.to_f
+                else
+                  false
+                end
+          res = !res if negate
+
+          next unless res
+
+          Planter.notify("Condition matched: #{comp} #{negate ? 'not ' : ''}#{operator} #{value}", :debug)
+          output = condition['content']
+          break
+        end
+
+        output
+      end
+    end
+
+    ## Destructive version of #apply_logic
+    def apply_logic!(variables)
+      replace apply_logic(variables)
+    end
+
     ##
     ## Apply key/value substitutions to a string. Variables are represented as
     ## %%key%%, and the hash passed to the function is { key: value }
@@ -199,6 +302,8 @@ module Planter
 
       content = content.apply_defaults(variables)
 
+      content = content.apply_logic(variables)
+
       variables.each do |k, v|
         if last_only
           pattern = "%%#{k.to_var}"
@@ -437,15 +542,18 @@ module Planter
       # number or float
       when /^[nf]/
         :float
-      # multiline or paragraph
-      when /^(mu|p)/
+      # paragraph
+      when /^p/
         :multiline
       # class
-      when /^c/
+      when /^cl/
         :class
       # module
-      when /^m/
+      when /^mod/
         :module
+      # multiple choice
+      when /^(ch|mu)/
+        :choice
       # string
       else
         :string
@@ -493,6 +601,14 @@ module Planter
       replace clean_encode
     end
 
+    ## Clean up a string by removing leading numbers and parentheticalse
+    ##
+    ## @return [String] cleaned string
+    ##
+    def clean_value
+      sub(/^\(?\d+\.\)? +/, '').sub(/\((.*?)\)/, '\1')
+    end
+
     ##
     ## Highlight characters in parenthesis, with special color for default if
     ## provided. Output is color templated string, unprocessed.

data/lib/planter/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Planter
   # Current Planter version.
-  VERSION = '3.0.2'
+  VERSION = '3.0.4'
 end

data/lib/planter.rb

@@ -92,7 +92,7 @@ module Planter
                 '{bw}'
               end
       out = "#{color}#{string}{x}"
-      out.gsub!(/\[(.*?)\]/, "{by}\\1{x}#{color}")
+      out = out.gsub(/\[(.*?)\]/, "{by}\\1{x}#{color}")
       out = "\n#{out}" if newline
       above_spinner ? spinner.log(out.x) : warn(out.x)
 

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

@@ -29,7 +29,7 @@ require 'open3'
 require 'time'
 
 module PlanterHelpers
-  PLANTER_EXEC = File.join(File.dirname(__FILE__), '..', 'bin', 'plant')
+  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)

data/src/_README.md

@@ -13,10 +13,6 @@ Plant a directory structure and files using templates.
 
 If you run into errors, try `gem install --user-install planter-cli`, or as a last ditch effort, `sudo gem install planter-cli`.
 
-### Optional
-
-If [Gum](https://github.com/charmbracelet/gum) is available it will be used for command line input.
-
 ## Configuration
 
 Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
@@ -42,7 +38,7 @@ Scripts can be executable files in any language, and receive the template direct
 
 Templates are directories found in `~/.config/planter/templates/[TEMPLATE_NAME]`. All files and directories inside of these template directories are copied when that template is called. Filenames, directory names, and file contents can all use template placeholders.
 
-Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. %%KEY%% placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
+Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. `%%KEY%%` placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
 
 Each template contains a `_planter.yml` file that defines variables and other configuration options. The file format for all configuration files is [YAML](https://yaml.org/spec/1.2.2/).
 
@@ -52,22 +48,108 @@ 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
     max: 5
+```
+
+A configuration can include additional keys:
+
+```yaml
 script: # array of scripts, args passed as [script and args] TEMPLATE_DIR PWD
   - process.py
 git_init: false # if true, initialize a git repository in the newly-planted directory
 files: # Dictionary for file handling (see [File-specific handling](#file-specific-handling))
 replacements: # Dictionary of pattern/replacments for regex substitution, see [Regex replacements](#regex-replacements)
-repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
+repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying an existing file structure
 ```
 
 #### Default values in template strings
 
-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%%`.
+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 (or doesn't exist). 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/Dictionary 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"
+```
+
+When a choice is selected from a dictionary, the result string will be inserted instead of the choice title.
+
+If an array is defined, the string of the choice will also be its result (minus any parenthesis):
+
+```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 (in the `defaults:` key) 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
 
@@ -79,7 +161,7 @@ files:
   "%%title%%.md": overwrite
 ```
 
-Filenames can include wildcards (`*`, `?`), and Bash-style globbing (`[0-9]`, `[a-z]`, `{one,two,three}`).
+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:
 
@@ -122,7 +204,7 @@ If `preserve_tags` is set to `true` in the config (either base or template), the
 The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.
 
 ```
-Usage: planter [options] TEMPLATE
+Usage: plant [options] TEMPLATE
     --defaults                       Accept default values for all variables
     -i, --in TARGET                  Plant in TARGET instead of current directory
     -o, --overwrite                  Overwrite existing files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.4
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump