planter-cli 3.0.4 → 3.0.7

data/lib/planter/config.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module Planter
+  ## Configuration class
+  class Config < Hash
+    attr_reader :template
+
+    ##
+    ## Initialize a new Config object for a template
+    ##
+    def initialize
+      super()
+
+      @config = initial_config
+      @template = Planter.template
+
+      load_template
+
+      die('No configuration found', :config) unless @config
+
+      generate_accessors
+    end
+
+    ## String representation of the configuration
+    def to_s
+      @config.to_s
+    end
+
+    ## Get a config key
+    ##
+    ## @param key [String,Symbol] key
+    ##
+    ## @return [String] value
+    ##
+    def [](key)
+      @config[key]
+    end
+
+    ##
+    ## Set a config option
+    ##
+    ## @param key [String,Symbol] key
+    ## @param value [String] value
+    ##
+    def []=(key, value)
+      @config[key.to_sym] = value
+      generate_accessors
+    end
+
+    private
+
+    ## Default configuration
+    ##
+    ## @return [Hash] default configuration
+    ##
+    ## @api private
+    ##
+    def initial_config
+      {
+        defaults: false,
+        git_init: false,
+        files: { '_planter.yml' => 'ignore' },
+        color: true,
+        preserve_tags: nil,
+        variables: nil,
+        replacements: nil,
+        repo: false,
+        patterns: nil,
+        debug: false,
+        script: nil
+      }
+    end
+
+    ##  Generate accessors for configuration
+    ##
+    ## @api private
+    ##
+    def generate_accessors
+      @config.each do |k, v|
+        define_singleton_method(k) { v } unless respond_to?(k)
+      end
+    end
+
+    ##
+    ## Build a configuration from template name
+    ##
+    ## @return     [Hash] Configuration object
+    ##
+    ## @api private
+    ##
+    def load_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 = @config.deep_merge(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 = @config.deep_merge(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)
+
+        die('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
+      die("Parse error in configuration file:\n#{e.message}", :config)
+    end
+
+    ##
+    ## 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)) }
+        Planter.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|
+        files[k.keys.first] = k.values.first
+      end
+      @config[key] = files
+    end
+  end
+end

data/lib/planter/fileentry.rb

@@ -6,8 +6,14 @@ module Planter
     # Operation to execute on the file
     attr_accessor :operation
 
-    # File path and target path
-    attr_reader :file, :target, :tags
+    # File path
+    attr_reader :file
+
+    # Target path
+    attr_reader :target
+
+    # Tags
+    attr_reader :tags
 
     ##
     ## Initialize a FileEntry object
@@ -19,7 +25,7 @@ module Planter
     ## @return [FileEntry] a Hash of parameters
     ##
     def initialize(file, target, operation)
-      return nil unless File.exist?(file)
+      return unless File.exist?(file)
 
       @file = file
       @target = target

data/lib/planter/filelist.rb

@@ -50,6 +50,10 @@ module Planter
     ##
     ## @param      entry  [FileEntry] The file entry
     ##
+    ## @return     [Boolean] success
+    ##
+    ## @api private
+    ##
     def handle_operator(entry)
       case entry.operation
       when :ignore
@@ -65,8 +69,17 @@ module Planter
       apply_tags(entry)
     end
 
+    #
+    # Apply tags to the target file from the source file
+    #
+    # @param [FileEntry] entry
+    #
+    # @return [Boolean] success
+    #
+    # @api private
+    #
     def apply_tags(entry)
-      return unless Planter.config[:preserve_tags]
+      return unless Planter.config.preserve_tags
 
       Tag.copy(entry.file, entry.target) if File.exist?(entry.target)
     end
@@ -76,6 +89,8 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def prepare_copy
       @files.each do |entry|
         if entry.matches_pattern?
@@ -90,6 +105,10 @@ module Planter
     ##
     ## @param      entry  [FileEntry] The file entry
     ##
+    ## @return     [Boolean] success
+    ##
+    ## @api private
+    ##
     def propogate_operation(entry)
       @files.each do |file|
         file.operation = entry.operation if file.file =~ /^#{entry.file}/
@@ -104,6 +123,8 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def merge(entry)
       return copy_file(entry) if File.directory?(entry.file)
 
@@ -157,7 +178,12 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def copy_file(file, overwrite: false)
+      # If the target file already exists and overwrite is true,
+      # or Planter.overwrite is true, then delete the target file
+      FileUtils.rm_rf(file.target) if (overwrite || Planter.overwrite) && File.exist?(file.target)
       # Check if the target file already exists
       # If it does and overwrite is true, or Planter.overwrite is true,
       # or if the file doesn't exist, then copy the file
@@ -165,7 +191,7 @@ module Planter
         # Make sure the target directory exists
         FileUtils.mkdir_p(File.dirname(file.target))
         # Copy the file if it isn't a directory
-        FileUtils.cp(file.file, file.target) unless File.directory?(file.file)
+        FileUtils.cp_r(file.file, file.target) unless File.directory?(file.file)
         # Log a message to the console
         Planter.notify("[Copied] #{file.file} => #{file.target}", :debug, above_spinner: true)
         # Return true to indicate success

data/lib/planter/numeric.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Planter
+  # Integer extensions
+  class ::Integer
+    # Clean value (dummy method)
+    def clean_value
+      self
+    end
+
+    # Has selector (dummy method)
+    def selector?
+      true
+    end
+
+    # Highlight character
+    def highlight_character(default: nil)
+      "(#{self})".highlight_character(default: default)
+    end
+  end
+
+  # Float extensions
+  class ::Float
+    # Clean value (dummy method)
+    def clean_value
+      self
+    end
+
+    # Has selector (dummy method)
+    def selector?
+      true
+    end
+
+    # Highlight character
+    def highlight_character(default: nil)
+      "(#{self})".highlight_character(default: default)
+    end
+  end
+end

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
@@ -72,8 +73,10 @@ module Planter
       ##
       ## @return     [Number] numeric response
       ##
+      ## @api private
+      ##
       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
@@ -91,19 +94,26 @@ module Planter
       ##
       ## @return     [String] date string
       ##
+      ## @api private
+      ##
       def date_default
         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
 
@@ -114,6 +124,8 @@ module Planter
       ##
       ## @return     [Date] Parsed Date object
       ##
+      ## @api private
+      ##
       def read_date(prompt: nil)
         prompt ||= @prompt
         default = date_default
@@ -123,7 +135,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
 
       ##
@@ -135,7 +147,11 @@ module Planter
       ##
       ## @return     [String] the single-line response
       ##
+      ## @api private
+      ##
       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)
@@ -156,6 +172,8 @@ module Planter
       ##
       ## @return     [String] the multi-line response
       ##
+      ## @api private
+      ##
       def read_lines(prompt: nil)
         prompt ||= @prompt
         save = @gum ? 'Ctrl-J for newline, Enter' : 'Ctrl-D'
@@ -172,6 +190,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_number_gum
         trap('SIGINT') { exit! }
         res = `gum input --placeholder "#{@min}-#{@max}"`.strip
@@ -185,6 +205,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_line_tty
         trap('SIGINT') { exit! }
         reader = TTY::Reader.new
@@ -199,6 +221,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_line_gum
         trap('SIGINT') { exit! }
         res = `gum input --placeholder "(blank to use default)"`.strip
@@ -212,6 +236,8 @@ module Planter
       ##
       ## @return     [string] multiline input
       ##
+      ## @api private
+      ##
       def read_mutliline_tty
         trap('SIGINT') { exit! }
         reader = TTY::Reader.new
@@ -224,6 +250,8 @@ module Planter
       ##
       ## @return     [string] multiline input
       ##
+      ## @api private
+      ##
       def read_multiline_gum(prompt)
         trap('SIGINT') { exit! }
         width = TTY::Screen.cols > 80 ? 80 : TTY::Screen.cols
@@ -234,7 +262,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 +288,8 @@ module Planter
         values = choices.to_values.map(&:clean_value)
       end
 
+      die('Choice(s) without selector, please edit config') unless keys.all?(&:selector?)
+
       default = case default_response.to_s
                 when /^\d+$/
                   values[default.to_i]
@@ -307,6 +337,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