planter-cli 3.0.1 → 3.0.3

data/lib/planter/string.rb

@@ -12,7 +12,42 @@ 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
+
+    #
+    # Convert {a,b,c} to (?:a|b|c)
+    #
+    # @return [String] Converted string
+    #
+    def glob_to_rx
+      gsub(/\\?\{(.*?)\\?\}/) do
+        m = Regexp.last_match
+        "(?:#{m[1].split(/,/).map { |c| Regexp.escape(c) }.join('|')})"
+      end
+    end
+
+    #
+    # Convert a string to a regular expression by escaping special
+    # characters and converting wildcards (*,?) to regex wildcards
+    #
+    # @return [String] String with wildcards converted (not Regexp)
+    #
+    def to_rx
+      gsub(/([.()])/, '\\\\\1').gsub(/\?/, '.').gsub(/\*/, '.*?').glob_to_rx
     end
 
     ##
@@ -162,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 }
@@ -177,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}"
@@ -415,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
@@ -471,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/tag.rb

@@ -4,6 +4,8 @@ module Planter
   module Tag
     class << self
       def set(target, tags)
+        return false unless TTY::Which.exist?('xattr')
+
         tags = [tags] unless tags.is_a?(Array)
 
         set_tags(target, tags)
@@ -15,15 +17,28 @@ module Planter
       # @param dir [String] The directory to tag.
       # @param tags [Array<String>] The tags to add.
       def add(target, tags)
+        return false unless TTY::Which.exist?('xattr')
+
         tags = [tags] unless tags.is_a?(Array)
         existing_tags = get(target)
         tags.concat(existing_tags).uniq!
 
         set_tags(target, tags)
-        $? == 0
+
+        res = $? == 0
+
+        if res
+          Planter.notify("[Added tags] to #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to add tags to #{target}", :error)
+        end
+
+        res
       end
 
       def get(target)
+        return false unless TTY::Which.exist?('xattr')
+
         res = `xattr -p com.apple.metadata:_kMDItemUserTags "#{target}" 2>/dev/null`.clean_encode
         return [] if res =~ /no such xattr/ || res.empty?
 
@@ -35,19 +50,41 @@ module Planter
       end
 
       def copy(source, target)
+        return false unless TTY::Which.exist?('xattr')
+
         tags = `xattr -px com.apple.metadata:_kMDItemUserTags "#{source}" 2>/dev/null`
         `xattr -wx com.apple.metadata:_kMDItemUserTags "#{tags}" "#{target}"`
-        $? == 0
+        res = $? == 0
+
+        if res
+          Planter.notify("[Copied tags] from #{source} to #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to copy tags from #{source} to #{target}", :error)
+        end
+
+        res
       end
 
       private
 
       def set_tags(target, tags)
+        return false unless TTY::Which.exist?('xattr')
+
         tags.map! { |tag| "<string>#{tag}</string>" }
         `xattr -w com.apple.metadata:_kMDItemUserTags '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
         <plist version="1.0">
           <array>#{tags.join}</array>
         </plist>' "#{target}"`
+
+        res = $? == 0
+
+        if res
+          Planter.notify("[Set tags] on #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to set tags on #{target}", :error)
+        end
+
+        res
       end
     end
   end

data/lib/planter/version.rb

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

data/lib/planter.rb

@@ -11,9 +11,10 @@ require 'plist'
 require 'chronic'
 require 'tty-reader'
 require 'tty-screen'
-require 'tty-spinner'
+# require 'tty-spinner'
 require 'tty-which'
 
+require_relative 'tty-spinner/lib/tty-spinner'
 require_relative 'planter/version'
 require_relative 'planter/hash'
 require_relative 'planter/array'
@@ -72,20 +73,28 @@ module Planter
     ## @param      string             [String] The message string
     ## @param      notification_type  [Symbol] The notification type (:debug, :error, :warn, :info)
     ## @param      exit_code          [Integer] If provided, exit with code after delivering message
+    ## @param      newline            [Boolean] If true, add a newline to the message
+    ## @param      above_spinner      [Boolean] If true, print above the spinner
     ##
-    def notify(string, notification_type = :info, exit_code: nil)
-      case notification_type
-      when :debug
-        return false unless @debug
-
-        warn "\n{dw}#{string}{x}".x
-      when :error
-        warn "{br}#{string}{x}".x
-      when :warn
-        warn "{by}#{string}{x}".x
-      else
-        warn "{bw}#{string}{x}".x
-      end
+    ## @return     [Boolean] true if message was printed
+    def notify(string, notification_type = :info, newline: true, above_spinner: false, exit_code: nil)
+      color = case notification_type
+              when :debug
+                return false unless @debug
+
+                '{dw}'
+              when :error
+                '{br}'
+
+              when :warn
+                '{by}'
+              else
+                '{bw}'
+              end
+      out = "#{color}#{string}{x}"
+      out = out.gsub(/\[(.*?)\]/, "{by}\\1{x}#{color}")
+      out = "\n#{out}" if newline
+      above_spinner ? spinner.log(out.x) : warn(out.x)
 
       Process.exit exit_code unless exit_code.nil?
 
@@ -197,13 +206,17 @@ module Planter
             key: 'var_key',
             prompt: 'CLI Prompt',
             type: '[string, float, integer, number, date]',
-            value: '(optional, for date type can be today, time, now, etc., empty to prompt)',
+            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' }
+          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)) }
@@ -238,7 +251,7 @@ module Planter
     def process_patterns
       patterns = {}
       @config[:files].each do |file, oper|
-        pattern = Regexp.new(".*?/#{file.to_s.sub(%r{^/}, '').gsub(/\./, '\.').gsub(/\*/, '.*?').gsub(/\?/, '.')}$")
+        pattern = Regexp.new(".*?/#{file.to_s.sub(%r{^/}, '').to_rx}$")
         operator = oper.normalize_operator
         patterns[pattern] = operator
       end

data/lib/tty-spinner/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.rb]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/lib/tty-spinner/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: piotrmurach

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Report something not working correctly or as expected
+title: ''
+labels: bug
+assignees: ''
+---
+
+### Describe the problem
+
+A brief description of the issue.
+
+### Steps to reproduce the problem
+
+```
+Your code here to reproduce the issue
+```
+
+### Actual behaviour
+
+What happened? This could be a description, log output, error raised etc.
+
+### Expected behaviour
+
+What did you expect to happen?
+
+### Describe your environment
+
+* OS version:
+* Ruby version:
+* TTY::Spinner version:

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest new functionality
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+### Describe the problem
+
+A brief description of the problem you're trying to solve.
+
+### How would the new feature work?
+
+A short explanation of the new feature.
+
+```
+Example code that shows possible usage
+```
+
+### Drawbacks
+
+Can you see any potential drawbacks?

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: TTY Community Discussions
+    url: https://github.com/piotrmurach/tty/discussions
+    about: Suggest ideas, ask and answer questions

data/lib/tty-spinner/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### Describe the change
+What does this Pull Request do?
+
+### Why are we doing this?
+Any related context as to why is this is a desirable change.
+
+### Benefits
+How will the library improve?
+
+### Drawbacks
+Possible drawbacks applying this change.
+
+### Requirements
+<!--- Put an X between brackets on each line if you have done the item: -->
+- [ ] Tests written & passing locally?
+- [ ] Code style checked?
+- [ ] Rebased with `master` branch?
+- [ ] Documentation updated?
+- [ ] Changelog updated?

data/lib/tty-spinner/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+---
+name: CI
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "bin/**"
+      - "examples/**"
+      - "*.md"
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - "bin/**"
+      - "examples/**"
+      - "*.md"
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.0"
+          - "2.1"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - ruby-head
+          - jruby-9.2
+          - jruby-9.3
+          - jruby-9.4
+          - jruby-head
+          - truffleruby-head
+        include:
+          - ruby: "2.2"
+            os: ubuntu-20.04
+          - ruby: "2.7"
+            coverage: true
+    env:
+      COVERAGE: ${{ matrix.coverage }}
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake ci

data/lib/tty-spinner/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/lib/tty-spinner/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/tty-spinner/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  NewCops: enable
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 82
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  CountComments: true
+  Max: 25
+  IgnoredMethods: []
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Naming/FileName:
+  Exclude:
+    - "lib/tty-spinner.rb"
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "spec/**/*"
+
+Style/LambdaCall:
+  SupportedStyles:
+  - call
+  - braces
+
+Style/Semicolon:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolProc:
+  Exclude:
+    - "spec/**/*"
+
+Style/TrivialAccessors:
+  Enabled: false