planter-cli 3.0.4 → 3.0.5

data/lib/planter/plant.rb

@@ -3,6 +3,8 @@
 module Planter
   # Primary class
   class Plant
+    attr_reader :config
+
     ##
     ## Initialize a new Plant object
     ##
@@ -11,20 +13,24 @@ module Planter
     ##
     def initialize(template = nil, variables = nil)
       Planter.variables = variables if variables.is_a?(Hash)
-      Planter.config = template if template
+      # Planter.config = template if template
+      template ||= Planter.template
+      die('No template specified', :config) unless template
+
+      @config = Planter::Config.new
 
-      @basedir = File.join(Planter.base_dir, 'templates', Planter.template)
+      @basedir = File.join(Planter.base_dir, 'templates', @config.template)
       @target = Planter.target || Dir.pwd
 
-      @git = Planter.config[:git_init] || false
+      @git = @config.git_init || false
       @debug = Planter.debug
-      @repo = Planter.config[:repo] || false
+      @repo = @config.repo || false
 
       # Coerce any existing variables (like from the command line) to the types
       # defined in configuration
       coerced = {}
       Planter.variables.each do |k, v|
-        cfg_var = Planter.config[:variables].select { |var| k = var[:key] }
+        cfg_var = @config.variables.select { |var| k = var[:key] }
         next unless cfg_var.count.positive?
 
         var = cfg_var.first
@@ -34,7 +40,7 @@ module Planter
       coerced.each { |k, v| Planter.variables[k] = v }
 
       # Ask user for any variables not already defined
-      Planter.config[:variables].each do |var|
+      @config.variables.each do |var|
         key = var[:key].to_var
         next if Planter.variables.keys.include?(key)
 
@@ -46,7 +52,8 @@ module Planter
           value: var[:value],
           min: var[:min],
           max: var[:max],
-          choices: var[:choices] || nil
+          choices: var[:choices] || nil,
+          date_format: var[:date_format] || nil
         )
         answer = q.ask
         if answer.nil?
@@ -55,7 +62,7 @@ module Planter
           answer = var[:default]
         end
 
-        Planter.variables[key] = answer
+        Planter.variables[key] = answer.apply_all
       end
 
       git_pull if @repo
@@ -94,26 +101,26 @@ module Planter
     def git_pull
       Planter.spinner.update(title: 'Pulling git repo')
 
-      raise Errors::GitError.new('`git` executable not found') unless TTY::Which.exist?('git')
+      die('`git` executable not found', :git) unless TTY::Which.exist?('git')
 
       pwd = Dir.pwd
       @repo = expand_repo(@repo)
 
       if File.exist?(repo_dir)
         Dir.chdir(repo_dir)
-        raise Errors::GitError.new("Directory #{repo_dir} exists but is not git repo") unless File.exist?('.git')
+        die("Directory #{repo_dir} exists but is not git repo", :git) unless File.exist?('.git')
 
         res = `git pull`
-        raise Errors::GitError.new("Error pulling #{@repo}:\n#{res}") unless $?.success?
+        die("Error pulling #{@repo}:\n#{res}", :git) unless $?.success?
       else
         Dir.chdir(@basedir)
         res = `git clone "#{@repo}" "#{repo_dir}"`
-        raise Errors::GitError.new("Error cloning #{@repo}:\n#{res}") unless $?.success?
+        die("Error cloning #{@repo}:\n#{res}", :git) unless $?.success?
       end
       Dir.chdir(pwd)
       @basedir = repo_dir
     rescue StandardError => e
-      raise Errors::GitError.new("Error pulling #{@repo}:\n#{e.message}")
+      die("Error pulling #{@repo}:\n#{e.message}", :git)
     end
 
     ##
@@ -139,7 +146,7 @@ module Planter
       end
 
       if @git
-        raise Errors::GitError.new('`git` executable not found') unless TTY::Which.exist?('git')
+        die('`git` executable not found', :git) unless TTY::Which.exist?('git')
 
         Planter.spinner.update(title: 'Initializing git repo')
         res = add_git
@@ -149,10 +156,10 @@ module Planter
         end
       end
 
-      if Planter.config[:script]
+      if @config.script
         Planter.spinner.update(title: 'Running script')
 
-        scripts = Planter.config[:script]
+        scripts = @config.script
         scripts = [scripts] if scripts.is_a?(String)
         scripts.each do |script|
           s = Planter::Script.new(@basedir, Dir.pwd, script)
@@ -184,7 +191,7 @@ module Planter
 
         content = IO.read(file)
 
-        new_content = content.apply_logic.apply_variables.apply_regexes
+        new_content = content.apply_all
 
         new_content.gsub!(%r{^.{.4}/?merge *.{,4}\n}, '') if new_content =~ /^.{.4}merge *\n/
 

data/lib/planter/prompt.rb

@@ -21,9 +21,10 @@ module Planter
         @min = question[:min]&.to_f || 1.0
         @max = question[:max]&.to_f || 10.0
         @prompt = question[:prompt] || nil
-        @default = question[:default]
+        @default = question[:default]&.to_s&.apply_all || nil
         @value = question[:value]
         @choices = question[:choices] || []
+        @date_format = question[:date_format] || nil
         @gum = false # TTY::Which.exist?('gum')
       end
 
@@ -35,7 +36,7 @@ module Planter
       def ask
         return nil if @prompt.nil?
 
-        return @value.to_s.apply_variables.apply_regexes.coerce(@type) if @value && @type != :date
+        return @value.to_s.apply_all.coerce(@type) if @value && @type != :date
 
         res = case @type
               when :choice
@@ -58,9 +59,9 @@ module Planter
                 read_line
               end
         Planter.notify("{dw}#{prompt} => {dy}#{res}{x}", :debug, newline: false)
-        res
+        res.to_s.apply_all
       rescue TTY::Reader::InputInterrupt
-        raise Errors::InputError.new('Canceled')
+        die('Canceled')
       end
 
       private
@@ -73,7 +74,7 @@ module Planter
       ## @return     [Number] numeric response
       ##
       def read_number(integer: false)
-        default = @default ? " {bw}[#{@default}]" : ''
+        default = @default ? " {xw}[{xbw}#{@default}{xw}]" : ''
         Planter.notify("{by}#{@prompt} {xc}({bw}#{@min}{xc}-{bw}#{@max}{xc})#{default}")
 
         res = @gum ? read_number_gum : read_line_tty
@@ -95,15 +96,20 @@ module Planter
         default = @value || @default
         return nil unless default
 
+        if default =~ /'.*?'/
+          @date_format = default.match(/'(.*?)'/)[1].strip
+          default = default.gsub(/'.*?'/, '').strip
+        end
+
         case default
         when /^(no|ti)/
-          Time.now.strftime('%Y-%m-%d %H:%M')
+          Time.now.strftime(@date_format || '%Y-%m-%d %H:%M')
         when /^(to|da)/
-          Time.now.strftime('%Y-%m-%d')
+          Time.now.strftime(@date_format || '%Y-%m-%d')
         when /^%/
-          Time.now.strftime(@default)
+          Time.now.strftime(default)
         else
-          Chronic.parse(default).strftime('%Y-%m-%d')
+          Chronic.parse(default).strftime(@date_format || '%Y-%m-%d')
         end
       end
 
@@ -123,7 +129,7 @@ module Planter
         line = @gum ? read_line_gum : read_line_tty
         return default unless line
 
-        Chronic.parse(line).strftime('%Y-%m-%d')
+        Chronic.parse(line).strftime(@date_format || '%Y-%m-%d')
       end
 
       ##
@@ -136,6 +142,8 @@ module Planter
       ## @return     [String] the single-line response
       ##
       def read_line(prompt: nil)
+        return @default if Planter.accept_defaults || ENV['PLANTER_DEBUG']
+
         prompt ||= @prompt
         default = @default ? " {bw}[#{@default}]" : ''
         Planter.notify("{by}#{prompt}#{default}", newline: false)
@@ -234,7 +242,7 @@ module Planter
     ##
     ## Choose from an array of multiple choices. Letter surrounded in
     ## parenthesis becomes character for response. Only one letter should be
-    ## specified and must be unique.
+    ## specified per choice and must be unique.
     ##
     ## @param      choices           [Array] The choices
     ## @param      prompt            [String] The prompt
@@ -260,6 +268,8 @@ module Planter
         values = choices.to_values.map(&:clean_value)
       end
 
+      die('Choice(s) without selector, please edit config') unless keys.all?(&:has_selector?)
+
       default = case default_response.to_s
                 when /^\d+$/
                   values[default.to_i]
@@ -307,6 +317,8 @@ module Planter
 
       res = res.empty? ? default : res
 
+      return choice(choices, prompt, default_response: default_response) if res.nil? || res.empty?
+
       if res.to_i.positive?
         values[res.to_i - 1]
       elsif res =~ /^[a-z]/ && keys&.option_index(res)

data/lib/planter/script.rb

@@ -14,12 +14,12 @@ module Planter
     ##
     def initialize(template_dir, output_dir, script)
       found = find_script(template_dir, script)
-      raise ScriptError.new("Script #{script} not found") unless found
+      die("Script #{script} not found", :script) unless found
 
       @script = found
       make_executable
 
-      raise ScriptError.new("Output directory #{output_dir} not found") unless File.directory?(output_dir)
+      die("Output directory #{output_dir} not found", :script) unless File.directory?(output_dir)
 
       @template_directory = template_dir
       @directory = output_dir
@@ -63,7 +63,7 @@ module Planter
       stdout, stderr, status = Open3.capture3(@script, @template_directory, @directory)
       Planter.notify("STDOUT:\n#{stdout}", :debug) unless stdout.empty?
       Planter.notify("STDERR:\n#{stderr}", :debug) unless stderr.empty?
-      raise ScriptError.new("Error running #{@script}") unless status.success?
+      die("Error running #{@script}", :script) unless status.success?
 
       true
     end

data/lib/planter/string.rb

@@ -138,11 +138,14 @@ module Planter
     MOD_RX = '(?<mod>
                   (?::
                     (
-                      l(?:ow(?:er)?)?)?|
-                      u(?:p(?:per)?)?|
+                      l(?:ow(?:er(case)?)?)?)?|
+                      d(?:own(?:case)?)?|
+                      u(?:p(?:per(case)?)?)?|upcase|
                       c(?:ap(?:ital(?:ize)?)?)?|
                       t(?:itle)?|
                       snake|camel|slug|
+                      fl|first_letter|
+                      fw|first_word|
                       f(?:ile(?:name)?
                     )?
                   )*
@@ -172,7 +175,7 @@ module Planter
           m['default'].apply_var_names
         else
           # Retrieve the default value for the variable from the configuration
-          vars = Planter.config[:variables].filter { |v| v[:key] == m['varname'] }
+          vars = Planter.config.variables.filter { |v| v[:key] == m['varname'] }
           default = vars.first[:default] if vars.count.positive?
           if default.nil?
             m[0]
@@ -204,8 +207,7 @@ module Planter
     def apply_logic(variables = nil)
       variables = variables.nil? ? Planter.variables : variables
 
-      gsub(/%%if .*?%%.*?%%end(if)?%%/mi) do |construct|
-        res = false
+      gsub(/%%if .*?%%.*?%%end( ?if)?%%/mi) do |construct|
         # Get the condition and the content
         output = construct.match(/%%else%%(.*?)%%end/m) ? Regexp.last_match(1) : ''
 
@@ -213,72 +215,8 @@ module Planter
                                        /%%(?<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
+        apply_conditions(conditions, variables, output)
       end
     end
 
@@ -287,6 +225,118 @@ module Planter
       replace apply_logic(variables)
     end
 
+    ##
+    ## Apply operator logic to a string. Operators are defined as
+    ## :copy, :overwrite, :ignore, or :merge. Logic can be if/else
+    ## constructs or inline operators.
+    ##
+    ## @example    "var = 1; if var == 1:copy; else: ignore" #=> :copy
+    ## @example    "var = 2; copy if var == 1 else ignore" #=> :ignore
+    ##
+    ## @param variables [Hash] Hash of variables (default: Planter.variables)
+    ##
+    def apply_operator_logic(variables = nil)
+      variables = variables.nil? ? Planter.variables : variables
+      op_rx = ' *(?<content>c(?:opy)?|o(?:ver(?:write)?)?|i(?:gnore)?|m(?:erge)?)? *'
+
+      strip.gsub(/^if .*?(?:end(?: ?if)?|$)/mi) do |construct|
+        # Get the condition and the content
+        output = construct.match(/else:#{op_rx}/m) ? Regexp.last_match(1) : ''
+
+        conditions = construct.to_enum(:scan,
+                                       /(?<statement>(?:els(?:e )?)?if) +(?<condition>.*?):#{op_rx}(?=;|$)/mi).map do
+          Regexp.last_match
+        end
+
+        apply_conditions(conditions, variables, output)
+      end.gsub(/^#{op_rx} +if .*?(end( ?if)?|$)/mi) do |construct|
+        # Get the condition and the content
+        output = construct.match(/else[; ]+(#{op_rx})/m) ? Regexp.last_match(1) : :ignore
+        condition = construct.match(/^#{op_rx}(?<statement>if) +(?<condition>.*?)(?=;|$)/mi)
+
+        apply_conditions([condition], variables, output)
+      end.normalize_operator
+    end
+
+    ##
+    ## Apply conditions
+    ##
+    ## @param conditions [Array<MatchData>] Array of conditions ['statement', 'condition', 'content']
+    ## @param variables [Hash] Hash of variables
+    ## @param output [String] Output string
+    ##
+    ## @return [String] Output string
+    ##
+    def apply_conditions(conditions, variables, output)
+      res = false
+      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 ? true : false
+        res = !res if negate
+
+        next unless res
+
+        Planter.notify("Condition matched: #{comp} #{negate ? 'not ' : ''}#{operator} #{value}", :debug)
+        output = condition['content']
+        break
+      end
+      output
+    end
+
     ##
     ## Apply key/value substitutions to a string. Variables are represented as
     ## %%key%%, and the hash passed to the function is { key: value }
@@ -326,6 +376,8 @@ module Planter
             if m['mod']
               mods = m['mod']&.split(/:/)
               mods&.each do |mod|
+                next if mod.nil? || mod.empty?
+
                 v = v.apply_mod(mod.normalize_mod)
               end
             end
@@ -369,13 +421,20 @@ module Planter
     end
 
     ##
-    ## Apply regex replacements from @config[:replacements]
+    ## Apply all logic, variables, and regexes to a string
+    ##
+    def apply_all
+      apply_logic.apply_variables.apply_regexes
+    end
+
+    ##
+    ## Apply regex replacements from Planter.config[:replacements]
     ##
     ## @return     [String] string with regexes applied
     ##
     def apply_regexes(regexes = nil)
       content = dup.clean_encode
-      regexes = regexes.nil? && Planter.config.key?(:replacements) ? Planter.config[:replacements] : regexes
+      regexes = regexes.nil? && Planter.config.key?(:replacements) ? Planter.config.replacements : regexes
 
       return self unless regexes
 
@@ -455,6 +514,10 @@ module Planter
         snake_case
       when :camel_case
         camel_case
+      when :first_letter
+        split('')[0]
+      when :first_word
+        split(/[ !,?;:]+/)[0]
       else
         self
       end
@@ -481,7 +544,7 @@ module Planter
     ##
     def normalize_mod
       case self
-      when /^(f|slug)/
+      when /^(file|slug)/
         :slug
       when /^cam/
         :camel_case
@@ -489,10 +552,14 @@ module Planter
         :snake_case
       when /^u/
         :uppercase
-      when /^l/
+      when /^[ld]/
         :lowercase
       when /^[ct]/
         :title_case
+      when /^(fl|first_letter)/
+        :first_letter
+      when /^(fw|first_word)/
+        :first_word
       end
     end
 
@@ -622,5 +689,14 @@ module Planter
         gsub(/\((.)\)/, '{dw}({xbw}\1{dw}){xw}')
       end
     end
+
+    #
+    # Test if a string has a parenthetical selector
+    #
+    # @return [Boolean] has selector
+    #
+    def has_selector?
+      self =~ /\(.\)/ ? true : false
+    end
   end
 end

data/lib/planter/tag.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
 module Planter
+  #
+  # File tagging module
+  #
+  # @author Brett Terpstra <me@brettterpstra.com>
+  #
   module Tag
+    # File tagging class
     class << self
+      #
+      # Set tags on target file.
+      #
+      # @param target [String] path to target file
+      # @param tags [Array] Array of tags to set
+      #
+      # @return [Boolean] success
+      #
       def set(target, tags)
         return false unless TTY::Which.exist?('xattr')
 
@@ -36,6 +50,13 @@ module Planter
         res
       end
 
+      #
+      # Get tags on target file.
+      #
+      # @param target [String] target file path
+      #
+      # @return [Array] Array of tags
+      #
       def get(target)
         return false unless TTY::Which.exist?('xattr')
 
@@ -49,6 +70,14 @@ module Planter
         tags
       end
 
+      #
+      # Copy tags from one file to another.
+      #
+      # @param source [String] path to source file
+      # @param target [String] path to target file
+      #
+      # @return [Boolean] success
+      #
       def copy(source, target)
         return false unless TTY::Which.exist?('xattr')
 
@@ -67,6 +96,15 @@ module Planter
 
       private
 
+      #
+      # Set tags on target file.
+      #
+      # @param target [String] file path
+      # @param tags   [Array] Array of tags
+      #
+      # @return [Boolean] success
+      #
+      # @api private
       def set_tags(target, tags)
         return false unless TTY::Which.exist?('xattr')
 

data/lib/planter/version.rb

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