planter-cli 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4906c83392316be6ac61380bd0d2401a847f4c08f6afc91bdfbd4858980568
-  data.tar.gz: 7253e2ec572be45e7543d82ad2b1dde685fc5b8ba7b256ec914b0575e44ad507
+  metadata.gz: a4b54e16d9836121fd1fa5831a1c7433056f45e9372b9985640a6052a2852aab
+  data.tar.gz: d2a57bd628c33f9dcccdc605577a11e4aaacbeef3a0c261f96835771f8fc0223
 SHA512:
-  metadata.gz: 98fd1c334e3d2efdcdc10171d7a5b5f81898e9a03890bc08cd65e2f3c8a10941cfe46e5e5b23584f28c87aad3b85471ab544c3665049c5abfd911006b40bfbe8
-  data.tar.gz: a7a86edaf7bf49cb65cde877ab4aec8bd92a6f27a90c09f526e50f9f1ddc84c27655e67bfea75b9463c8033601ae1961e4854bce76f4e268bfe87aa3171c7677
+  metadata.gz: 0001cffb09df38704dbeadb6b68b42418a0b02741430fd3932fcdf845d53052945d1e51dd5bd6227c8f02cd70fbbd86f8d037bd1ef2da7547c5ae3f859320a93
+  data.tar.gz: b612aa38f0aaa7d1746b8715e032e93550735510b9e0e5f90cbdaef35d0cb0eea3f9afbc8c1f001f03eb40c0de41f7773e5ef7f4799e1792a4543be36ff4074b

data/.gitignore

@@ -45,3 +45,4 @@ Gemfile.lock
 .history
 spec/test/
 spec/noop
+bundle

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/planter/tty-spinner"]
+	path = lib/planter/tty-spinner
+	url = git@github.com:piotrmurach/tty-spinner.git

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 3.0.2
+
+2024-09-01 09:46
+
+#### IMPROVED
+
+- Add basic CLI tests
+- Better debug output and output of info messages above spinner
+- Handle Bash-style globs in file: filenames
+
 ### 3.0.1
 
 2024-08-31 14:19

data/README.md

@@ -27,9 +27,9 @@ git_init: false
 preserve_tags: true
 ```
 
-### Scripts.
+### Scripts
 
-Scripts for execution after planting can be stored in `~/.config/planter/scripts` and referenced by filename only. Alternatively, scripts may be stored within a template in a `_scritps` subfolder.
+Scripts for execution after planting can be stored in `~/.config/planter/scripts` and referenced by filename only. Alternatively, scripts may be stored within a template in a `_scripts` subfolder.
 
 Scripts can be executable files in any language, and receive the template directory and the planted directory as arguments $1 and $2.
 
@@ -74,6 +74,8 @@ files:
   "%%title%%.md": overwrite
 ```
 
+Filenames can include wildcards (`*`, `?`), and Bash-style globbing (`[0-9]`, `[a-z]`, `{one,two,three}`).
+
 If `merge` is specified, then the source file is scanned for merge comments and those are merged if they don't exist in the copied/existing file. If no merge comments are defined, then the entire contents of the source file are appended to the destination file (unless the file already matches the source). Merge comments start with `merge` and end with `/merge` and can have any comment syntax preceding them, for example:
 
 ```
@@ -104,7 +106,7 @@ replacements:
   "(main|app)\.js": "%%script:lower%%.js"
 ```
 
-Replacements are performed on both file/directory names and file contents.
+Replacements are performed on both file/directory names and file contents. This is especially handy when the source of the plant is a Git repo, allowing the replacement of elements without having to create %%templated%% filenames and contents.
 
 ### Finder Tags
 

data/bin/plant

@@ -105,7 +105,7 @@ elsif ARGV.count.zero?
 end
 
 ARGV.each do |template|
-  Planter.spinner.update(title: 'Initializing configuration')
+  # Planter.spinner.update(title: 'Initializing configuration')
   Planter.config = template
   app = Planter::Plant.new
   app.plant

data/docker/Dockerfile

@@ -1,12 +1,10 @@
 FROM ruby:3.0.1
-# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
 RUN mkdir /planter
 WORKDIR /planter
-
 RUN gem install bundler:2.2.29
-RUN apt-get update -y
+COPY ./docker/sources.list /etc/apt/sources.list
+RUN apt-get update -y --allow-insecure-repositories || true
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
-RUN mkdir -p /root/.config/planter/templates/test
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-2.6

@@ -1,12 +1,10 @@
 FROM ruby:2.6
-# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
 RUN mkdir /planter
 WORKDIR /planter
-# COPY ./ /planter/
 RUN gem install bundler:2.2.29
-# RUN apt-get update -y
-# RUN apt-get install -y less vim
+COPY ./docker/sources.list /etc/apt/sources.list
+RUN apt-get update -y --allow-insecure-repositories || true
+RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
-RUN mkdir -p /root/.config/planter/templates/test
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-2.7

@@ -1,12 +1,10 @@
 FROM ruby:2.7
-# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
 RUN mkdir /planter
 WORKDIR /planter
-# COPY ./ /planter/
 RUN gem install bundler:2.2.29
-RUN apt-get update -y
+COPY ./docker/sources.list /etc/apt/sources.list
+RUN apt-get update -y --allow-insecure-repositories || true
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile
-RUN mkdir -p /root/.config/planter/templates/test
 CMD ["/planter/scripts/runtests.sh"]

data/docker/Dockerfile-3.0

@@ -1,10 +1,9 @@
 FROM ruby:3.0.0
-# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
 RUN mkdir /planter
 WORKDIR /planter
-# COPY ./ /planter/
 RUN gem install bundler:2.2.29
-RUN apt-get update -y
+COPY ./docker/sources.list /etc/apt/sources.list
+RUN apt-get update -y --allow-insecure-repositories || true
 RUN apt-get install -y less vim
 COPY ./docker/inputrc /root/.inputrc
 COPY ./docker/bash_profile /root/.bash_profile

data/docker/Dockerfile-3.3

@@ -0,0 +1,11 @@
+FROM ruby:3.3.0
+# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+RUN mkdir /planter
+WORKDIR /planter
+RUN gem install bundler:2.2.29
+COPY ./docker/sources.list /etc/apt/sources.list
+RUN apt-get update -y --allow-insecure-repositories || true
+RUN apt-get install -y less vim
+COPY ./docker/inputrc /root/.inputrc
+COPY ./docker/bash_profile /root/.bash_profile
+CMD ["/planter/scripts/runtests.sh"]

data/docker/sources.list

@@ -0,0 +1,11 @@
+deb http://archive.ubuntu.com/ubuntu/ focal main restricted
+deb http://archive.ubuntu.com/ubuntu/ focal-updates main restricted
+deb http://archive.ubuntu.com/ubuntu/ focal universe
+deb http://archive.ubuntu.com/ubuntu/ focal-updates universe
+deb http://archive.ubuntu.com/ubuntu/ focal multiverse
+deb http://archive.ubuntu.com/ubuntu/ focal-updates multiverse
+deb http://archive.ubuntu.com/ubuntu/ focal-backports main restricted universe multiverse
+
+deb http://security.ubuntu.com/ubuntu focal-security main restricted
+deb http://security.ubuntu.com/ubuntu focal-security universe
+deb http://security.ubuntu.com/ubuntu focal-security multiversesudo apt update

data/lib/planter/filelist.rb

@@ -39,7 +39,7 @@ module Planter
         handle_operator(file)
       end
     rescue StandardError => e
-      Planter.notify("#{e}\n#{e.backtrace}", :debug)
+      Planter.notify("#{e}\n#{e.backtrace}", :debug, above_spinner: true)
       Planter.notify('Error copying files/directories', :error, exit_code: 128)
     end
 
@@ -141,7 +141,8 @@ module Planter
       # If there are any merge sections left, merge them with the target file
       if merges.count.positive?
         File.open(entry.target, 'w') { |f| f.puts "#{target_content.chomp}\n\n#{merges.join("\n\n")}" }
-        Planter.notify("Merged #{entry.file} => #{entry.target} (#{merges.count} merges)", :debug)
+        Planter.notify("[Merged] #{entry.file} => #{entry.target} (#{merges.count} merges)", :debug,
+                       above_spinner: true)
       else
         # If there are no merge sections left, copy the file instead
         copy_file(entry)
@@ -166,12 +167,12 @@ module Planter
         # Copy the file if it isn't a directory
         FileUtils.cp(file.file, file.target) unless File.directory?(file.file)
         # Log a message to the console
-        Planter.notify("Copied #{file.file} => #{file.target}", :debug)
+        Planter.notify("[Copied] #{file.file} => #{file.target}", :debug, above_spinner: true)
         # Return true to indicate success
         true
       else
         # Log a message to the console
-        Planter.notify("Skipped #{file.file} => #{file.target}", :debug)
+        Planter.notify("[Skipped] #{file.file} => #{file.target}", :debug, above_spinner: true)
         # Return false to indicate that the copy was skipped
         false
       end

data/lib/planter/plant.rb

@@ -187,14 +187,14 @@ module Planter
         new_content.gsub!(%r{^.{.4}/?merge *.{,4}\n}, '') if new_content =~ /^.{.4}merge *\n/
 
         unless content == new_content
-          Planter.notify("Applying variables to #{file}", :debug)
+          Planter.notify("Applying variables to #{file}", :debug, above_spinner: true)
           File.open(file, 'w') { |f| f.puts new_content }
         end
       end
 
       true
     rescue StandardError => e
-      Planter.notify("#{e}\n#{e.backtrace}", :debug)
+      Planter.notify("#{e}\n#{e.backtrace}", :debug, above_spinner: true)
       'Error updating files/directories'
     end
 
@@ -215,7 +215,7 @@ module Planter
 
       true
     rescue StandardError => e
-      Planter.notify("#{e}\n#{e.backtrace}", :debug)
+      Planter.notify("#{e}\n#{e.backtrace}", :debug, above_spinner: true)
       'Error initializing git'
     end
   end

data/lib/planter/prompt.rb

@@ -54,10 +54,10 @@ module Planter
               else
                 read_line
               end
-        Planter.notify("{dw}#{prompt}: {dy}#{res}{x}", :debug)
+        Planter.notify("{dw}#{prompt} => {dy}#{res}{x}", :debug, newline: false)
         res
       rescue TTY::Reader::InputInterrupt
-        raise Errors::InputError('Canceled')
+        raise Errors::InputError.new('Canceled')
       end
 
       private
@@ -116,7 +116,7 @@ module Planter
         default = date_default
 
         default = default ? " {bw}[#{default}]" : ''
-        Planter.notify("{by}#{prompt} (natural language)#{default}")
+        Planter.notify("{by}#{prompt} (natural language)#{default}", newline: false)
         line = @gum ? read_line_gum : read_line_tty
         return default unless line
 
@@ -135,7 +135,7 @@ module Planter
       def read_line(prompt: nil)
         prompt ||= @prompt
         default = @default ? " {bw}[#{@default}]" : ''
-        Planter.notify("{by}#{prompt}#{default}")
+        Planter.notify("{by}#{prompt}#{default}", newline: false)
 
         res = @gum ? read_line_gum : read_line_tty
 
@@ -156,7 +156,7 @@ module Planter
       def read_lines(prompt: nil)
         prompt ||= @prompt
         save = @gum ? 'Ctrl-J for newline, Enter' : 'Ctrl-D'
-        Planter.notify("{by}#{prompt} {xc}({bw}#{save}{xc} to save)'")
+        Planter.notify("{by}#{prompt} {xc}({bw}#{save}{xc} to save)'", newline: false)
         res = @gum ? read_multiline_gum(prompt) : read_mutliline_tty
 
         return @default unless res

data/lib/planter/string.rb

@@ -15,6 +15,28 @@ module Planter
       snake_case.to_sym
     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
+
     ##
     ## Convert a slug into a class name
     ##

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.2'
 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.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