planter-cli 3.0.4 → 3.0.5

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,28 @@ 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 level [Symbol] notification level
+# @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 +79,7 @@ module Planter
     attr_accessor :template
 
     ## Config Hash
-    attr_reader :config
+    # attr_reader :config
 
     ## Variable key/values
     attr_accessor :variables
@@ -67,6 +90,10 @@ module Planter
     ## Accept all defaults
     attr_accessor :accept_defaults
 
+    def config
+      @config ||= Config.new
+    end
+
     ##
     ## Print a message on the command line
     ##
@@ -92,11 +119,17 @@ 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?
+      if exit_code && $stdout.isatty && (ENV['PLANTER_RSPEC'] == 'true' || ENV['PLANTER_DEBUG'] != 'true')
+        exit(exit_code)
+      end
 
       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'

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

data/spec/planter/prompt_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Planter::Prompt::Question do
+  let(:question) do
+    question = {
+      key: 'test',
+      prompt: 'CLI Prompt',
+      type: :string,
+      default: 'default',
+      value: nil
+    }
+  end
+
+  before do
+    Planter.accept_defaults = true
+  end
+
+  describe '#initialize' do
+    it 'initializes a new question object' do
+      q = described_class.new(question)
+      expect(q).to be_a described_class
+    end
+  end
+
+  describe '#ask' do
+    it 'asks a question' do
+      q = described_class.new(question)
+      expect(q.ask).to eq('default')
+    end
+  end
+
+  describe "#ask with date type" do
+    it 'asks a date question' do
+      question[:type] = :date
+      question[:value] = 'today'
+      q = described_class.new(question)
+      expect(q.ask).to eq(Date.today.strftime('%Y-%m-%d'))
+    end
+  end
+
+  describe "#ask with date type and inline date format" do
+    it 'asks a date question' do
+      question[:type] = :date
+      question[:value] = "today '%Y'"
+      q = described_class.new(question)
+      expect(q.ask).to eq(Date.today.strftime('%Y'))
+    end
+  end
+
+  describe "#ask with date type and date format config" do
+    it 'asks a date question' do
+      question[:type] = :date
+      question[:date_format] = '%Y'
+      question[:value] = "today"
+      q = described_class.new(question)
+      expect(q.ask).to eq(Date.today.strftime('%Y'))
+    end
+  end
+
+  describe "#ask with choices" do
+    it 'asks a question with choices' do
+      question[:type] = :string
+      question[:choices] = %w[(o)ne (t)wo t(h)ree]
+      question[:default] = 'one'
+      q = described_class.new(question)
+      expect(q.ask).to eq('one')
+    end
+  end
+end

data/spec/planter/script_spec.rb

@@ -12,6 +12,7 @@ describe Planter::Script do
   let(:base_script_path) { File.join(Planter.base_dir, 'scripts', script_name) }
 
   before do
+    ENV['PLANTER_RSPEC'] = 'true'
     Planter.base_dir = File.expand_path('spec')
     allow(File).to receive(:exist?).and_call_original
     allow(File).to receive(:directory?).and_call_original
@@ -30,14 +31,14 @@ describe Planter::Script do
       allow(File).to receive(:exist?).with(script_path).and_return(false)
       expect do
         Planter::Script.new(template_dir, output_dir, script_name)
-      end.to raise_error(ScriptError)
+      end.to raise_error(SystemExit)
     end
 
     it 'raises an error if output directory is not found' do
       allow(File).to receive(:directory?).with(output_dir).and_return(false)
       expect do
         Planter::Script.new(template_dir, output_dir, script_name)
-      end.to raise_error(ScriptError)
+      end.to raise_error(SystemExit)
     end
   end
 
@@ -60,7 +61,7 @@ describe Planter::Script do
       expect do
         script = Planter::Script.new(template_dir, output_dir, script_name)
         script.find_script(template_dir, script_name)
-      end.to raise_error(ScriptError)
+      end.to raise_error(SystemExit)
     end
   end
 
@@ -74,7 +75,7 @@ describe Planter::Script do
       script = Planter::Script.new(template_dir, output_dir, script_name_fail)
       expect do
         script.run
-      end.to raise_error(ScriptError)
+      end.to raise_error(SystemExit)
     end
   end
 end

data/spec/planter/string_spec.rb

@@ -141,6 +141,32 @@ describe ::String do
     end
   end
 
+  describe '.apply_operator_logic' do
+    it 'applies logic' do
+      template = 'copy if language == ruby'
+      operators = { language: 'ruby' }
+      expect(template.apply_operator_logic(operators)).to eq :copy
+    end
+
+    it 'applies default' do
+      template = 'copy if language == perl'
+      operators = { language: 'ruby' }
+      expect(template.apply_operator_logic(operators)).to eq :ignore
+    end
+
+    it 'handles no logic' do
+      template = 'copy'
+      operators = {}
+      expect(template.apply_operator_logic(operators)).to eq :copy
+    end
+
+    it 'handles if then' do
+      template = 'if language == ruby: copy; else: ignore'
+      operators = { language: 'perl' }
+      expect(template.apply_operator_logic(operators)).to eq :ignore
+    end
+  end
+
   describe '.apply_regexes' do
     it 'applies a single regex replacement' do
       template = 'Hello, World!'

data/spec/spec_helper.rb

@@ -29,10 +29,11 @@ require 'open3'
 require 'time'
 
 module PlanterHelpers
-  PLANTER_EXEC = File.join(File.dirname(__FILE__), '..', 'exe', 'plant')
+  PLANTER_EXEC = File.join(File.dirname(__FILE__), '..', 'bin', 'plant')
 
   def planter_with_env(env, *args, stdin: nil)
-    pread(env, 'bundle', 'exec', PLANTER_EXEC, "--base-dir=#{File.dirname(__FILE__)}", *args, stdin: stdin)
+    pread(env, 'bundle', 'exec', PLANTER_EXEC, "--base-dir=#{File.dirname(__FILE__)}", "--defaults", *args,
+          stdin: stdin)
   end
 
   def pread(env, *cmd, stdin: nil)

data/spec/templates/test/_planter.yml

@@ -5,5 +5,7 @@ variables:
   type: string
   default: "bollocks and beans"
 git_init: false
+script:
+  - plant.sh
 files:
   "*.tmp": ignore

data/spec/templates/test/_scripts/plant.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Testing" > planted_by_script.txt