planter-cli 3.0.4 → 3.0.7

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,121 @@ 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)?)? *'
+
+      output = 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
+      output = output.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
+
+      output.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 +379,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 +424,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 +517,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 +547,7 @@ module Planter
     ##
     def normalize_mod
       case self
-      when /^(f|slug)/
+      when /^(file|slug)/
         :slug
       when /^cam/
         :camel_case
@@ -489,10 +555,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 +692,14 @@ module Planter
         gsub(/\((.)\)/, '{dw}({xbw}\1{dw}){xw}')
       end
     end
+
+    #
+    # Test if a string has a parenthetical selector
+    #
+    # @return [Boolean] has selector
+    #
+    def 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')
 
@@ -14,8 +28,11 @@ module Planter
 
       # Add tags to a directory.
       #
-      # @param dir [String] The directory to tag.
+      # @param target [String] The directory to tag.
       # @param tags [Array<String>] The tags to add.
+      #
+      # @return [Boolean] Success.
+      #
       def add(target, tags)
         return false unless TTY::Which.exist?('xattr')
 
@@ -36,6 +53,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 +73,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 +99,16 @@ 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.7'
 end

data/lib/planter.rb

@@ -15,14 +15,15 @@ require 'tty-screen'
 require 'tty-which'
 
 require_relative 'tty-spinner/lib/tty-spinner'
+require_relative 'planter/config'
 require_relative 'planter/version'
 require_relative 'planter/hash'
 require_relative 'planter/array'
 require_relative 'planter/symbol'
+require_relative 'planter/numeric'
 require_relative 'planter/file'
 require_relative 'planter/tag'
 require_relative 'planter/color'
-require_relative 'planter/errors'
 require_relative 'planter/prompt'
 require_relative 'planter/string'
 require_relative 'planter/filelist'
@@ -30,6 +31,27 @@ require_relative 'planter/fileentry'
 require_relative 'planter/script'
 require_relative 'planter/plant'
 
+# @return [Integer] Exit codes
+EXIT_CODES = {
+  argument: 12,
+  input: 13,
+  canceled: 1,
+  script: 10,
+  config: 127,
+  git: 129
+}.deep_freeze
+
+#
+# Exit the program with a message
+#
+# @param msg [String] error message
+# @param code [Integer] Exit code
+#
+def die(msg = 'Exited', code = :canceled)
+  code = EXIT_CODES.key?(code) ? code : :canceled
+  Planter.notify(msg, :error, above_spinner: false, exit_code: EXIT_CODES[code])
+end
+
 # Main Journal module
 module Planter
   # Base directory for templates
@@ -56,7 +78,7 @@ module Planter
     attr_accessor :template
 
     ## Config Hash
-    attr_reader :config
+    # attr_reader :config
 
     ## Variable key/values
     attr_accessor :variables
@@ -67,6 +89,13 @@ module Planter
     ## Accept all defaults
     attr_accessor :accept_defaults
 
+    ## Reader for the configuration object
+    ##
+    ## @return [Planter::Config] Configuration object
+    def config
+      @config ||= Config.new
+    end
+
     ##
     ## Print a message on the command line
     ##
@@ -92,11 +121,15 @@ module Planter
                 '{bw}'
               end
       out = "#{color}#{string}{x}"
-      out = out.gsub(/\[(.*?)\]/, "{by}\\1{x}#{color}")
+      # out = out.gsub(/\[(.*?)\]/, "{by}\\1{x}#{color}")
       out = "\n#{out}" if newline
+
+      spinner.update(title: 'ERROR') if exit_code
+      spinner.error if notification_type == :error
+
       above_spinner ? spinner.log(out.x) : warn(out.x)
 
-      Process.exit exit_code unless exit_code.nil?
+      exit(exit_code) if exit_code && $stdout.isatty && (ENV['PLANTER_RSPEC'] == 'true' || ENV['PLANTER_DEBUG'] != 'true')
 
       true
     end
@@ -118,56 +151,6 @@ module Planter
       @base_dir ||= ENV['PLANTER_BASE_DIR'] || File.join(Dir.home, '.config', 'planter')
     end
 
-    ##
-    ## Build a configuration from template name
-    ##
-    ## @param      template  [String] The template name
-    ##
-    ## @return     [Hash] Configuration object
-    ##
-    def config=(template)
-      @template = template
-      Planter.variables ||= {}
-      FileUtils.mkdir_p(Planter.base_dir) unless File.directory?(Planter.base_dir)
-      base_config = File.join(Planter.base_dir, 'planter.yml')
-
-      if File.exist?(base_config)
-        @config = YAML.load(IO.read(base_config)).symbolize_keys
-      else
-        default_base_config = {
-          defaults: false,
-          git_init: false,
-          files: { '_planter.yml' => 'ignore' },
-          color: true,
-          preserve_tags: true
-        }
-        begin
-          File.open(base_config, 'w') { |f| f.puts(YAML.dump(default_base_config.stringify_keys)) }
-        rescue Errno::ENOENT
-          Planter.notify("Unable to create #{base_config}", :error)
-        end
-        @config = default_base_config.symbolize_keys
-        Planter.notify("New configuration written to #{base_config}, edit as needed.", :warn)
-      end
-
-      base_dir = File.join(Planter.base_dir, 'templates', @template)
-      unless File.directory?(base_dir)
-        notify("Template #{@template} does not exist", :error)
-        res = Prompt.yn('Create template directory', default_response: false)
-
-        raise Errors::InputError.new('Canceled') unless res
-
-        FileUtils.mkdir_p(base_dir)
-      end
-
-      load_template_config
-
-      config_array_to_hash(:files) if @config[:files].is_a?(Array)
-      config_array_to_hash(:replacements) if @config[:replacements].is_a?(Array)
-    rescue Psych::SyntaxError => e
-      raise Errors::ConfigError.new "Parse error in configuration file:\n#{e.message}"
-    end
-
     ##
     ## Execute a shell command and return a Boolean success response
     ##
@@ -189,58 +172,6 @@ module Planter
 
     private
 
-    ##
-    ## Load a template-specific configuration
-    ##
-    ## @return     [Hash] updated config object
-    ##
-    ## @api private
-    ##
-    def load_template_config
-      base_dir = File.join(Planter.base_dir, 'templates', @template)
-      config = File.join(base_dir, '_planter.yml')
-
-      unless File.exist?(config)
-        default_config = {
-          variables: [
-            key: 'var_key',
-            prompt: 'CLI Prompt',
-            type: '[string, float, integer, number, date]',
-            value: '(optional, force value, can include variables. Empty to prompt. For date type: today, now, etc.)',
-            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)'
-          ],
-          git_init: false,
-          files: {
-            '*.tmp' => 'ignore',
-            '*.bak' => 'ignore',
-            '.DS_Store' => 'ignore'
-          }
-        }
-        FileUtils.mkdir_p(base_dir)
-        File.open(config, 'w') { |f| f.puts(YAML.dump(default_config.stringify_keys)) }
-        notify("New configuration written to #{config}, please edit.", :warn)
-        Process.exit 0
-      end
-      @config = @config.deep_merge(YAML.load(IO.read(config)).symbolize_keys)
-    end
-
-    ##
-    ## Convert an errant array to a hash
-    ##
-    ## @param      key   [Symbol] The key in @config to convert
-    ##
-    ## @api private
-    ##
-    def config_array_to_hash(key)
-      files = {}
-      @config[key].each do |k, v|
-        files[k] = v
-      end
-      @config[key] = files
-    end
-
     ##
     ## Process :files in config into regex pattern/operator pairs
     ##
@@ -250,9 +181,9 @@ module Planter
     ##
     def process_patterns
       patterns = {}
-      @config[:files].each do |file, oper|
+      @config.files.each do |file, oper|
         pattern = Regexp.new(".*?/#{file.to_s.sub(%r{^/}, '').to_rx}$")
-        operator = oper.normalize_operator
+        operator = oper.apply_operator_logic(Planter.variables)
         patterns[pattern] = operator
       end
       patterns

data/lib/tty-spinner/lib/tty/spinner/multi.rb

@@ -112,7 +112,7 @@ module TTY
           pattern_or_spinner
         else
           raise ArgumentError, "Expected a pattern or spinner, " \
-            "got: #{pattern_or_spinner.class}"
+                               "got: #{pattern_or_spinner.class}"
         end
       end
 
@@ -259,8 +259,8 @@ module TTY
       # @api public
       def on(key, &callback)
         unless @callbacks.key?(key)
-          raise ArgumentError, "The event #{key} does not exist. " \
-                               " Use :spin, :success, :error, or :done instead"
+          raise ArgumentError, "The event #{key} does not exist.  " \
+                               "Use :spin, :success, :error, or :done instead"
         end
         @callbacks[key] << callback
         self

data/planter-cli.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path(File.join('..', 'lib'), __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'planter/version'
@@ -23,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'
 
-  spec.add_development_dependency 'guard', '~> 2.11'
+  spec.add_development_dependency 'guard', '~> 2.16'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'guard-yard', '~> 2.1'

data/spec/cli_spec.rb

@@ -17,11 +17,21 @@ describe 'CLI' do
 
   it 'displays help message' do
     output, stderr, status = planter('--help')
-    expect(output).not_to be_empty
+    expect(output).to match(/Usage: plant \[options\] TEMPLATE/)
+  end
+
+  it 'displays variables for a template' do
+    output, stderr, status = planter('--help', 'test')
+    expect(output).to match(/CLI Prompt/)
   end
 
   it 'plants a new project' do
-    output, stderr, status = planter('--defaults', "--in=#{TEST_DIR}", 'test')
+    output, stderr, status = planter("--in=#{TEST_DIR}", 'test')
     expect(File.exist?(File.join(TEST_DIR, 'bollocks_and_beans.rtf'))).to be true
   end
+
+  it 'plants a new file with a script' do
+    output, stderr, status = planter("--in=#{TEST_DIR}", 'test')
+    expect(File.exist?(File.join(TEST_DIR, 'planted_by_script.txt'))).to be true
+  end
 end

data/spec/planter/filelist_spec.rb

@@ -7,8 +7,8 @@ describe Planter::FileList do
     it 'initializes with an empty list' do
       Planter.base_dir = File.expand_path('spec')
       Planter.variables = { project: 'Untitled', script: 'Script', title: 'Title' }
-      Planter.config = 'test'
-      filelist = Planter::FileList.new
+      Planter.template = 'test'
+      filelist = described_class.new
       expect(filelist.files).not_to eq([])
     end
   end