planter-cli 0.0.4 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5318772de94f6948e72fcf61709d9b0cf42c3518a775e47eaa816e8d432cf0f0
-  data.tar.gz: fcc04239c8d4c74af78f7da138d862f3a01ee053740cda5ad28e8e1019c11a29
+  metadata.gz: a4b54e16d9836121fd1fa5831a1c7433056f45e9372b9985640a6052a2852aab
+  data.tar.gz: d2a57bd628c33f9dcccdc605577a11e4aaacbeef3a0c261f96835771f8fc0223
 SHA512:
-  metadata.gz: 55fd5cdd6bbede37bd171df3c6686fc4ca14c869895cf122f7a38997b46121516e32342ab7f8625b26762fba668cd73611c0edeac101fdf3d2d6ec325460dbfa
-  data.tar.gz: 865480b6ed5efda83cba2b0314bf1afd685eed88c2c930e6b705e4fb104da3fadc0afd85211ea2a4930370d0c786df342a6dbf7c4f0ab371b9122f6df895150b
+  metadata.gz: 0001cffb09df38704dbeadb6b68b42418a0b02741430fd3932fcdf845d53052945d1e51dd5bd6227c8f02cd70fbbd86f8d037bd1ef2da7547c5ae3f859320a93
+  data.tar.gz: b612aa38f0aaa7d1746b8715e032e93550735510b9e0e5f90cbdaef35d0cb0eea3f9afbc8c1f001f03eb40c0de41f7773e5ef7f4799e1792a4543be36ff4074b

data/.gitignore

@@ -43,3 +43,6 @@ Gemfile.lock
 .rvmrc
 /test
 .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/.rubocop.yml

@@ -41,7 +41,7 @@ Metrics/BlockLength:
   Max: 45
   Exclude:
     - Rakefile
-    - bin/howzit
+    - bin/untitled
     - lib/*.rb
 
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+### 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
+
+### 3.0.0-alpha
+
+2024-08-31 14:18
+
+#### NEW
+
+- Initial release
+- Preserve Finder tags when planting (config option `preserve_tags: true`)
+
+#### IMPROVED
+
+- More tests
+
+#### FIXED
+
+- Code refactoring
+
 ### 0.0.3
 
 2024-08-28 09:46

data/README.md

@@ -14,11 +14,22 @@ If [Gum](https://github.com/charmbracelet/gum) is available it will be used for
 
 ## Configuration
 
-Planter's base configuration is in `~/.config/planter/config.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
+Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
 
-### Scripts.
+Example config (written on first run):
 
-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.
+```yaml
+files:
+  .DS_Store: ignore
+  "*.tmp": ignore
+  "*.bak": ignore
+git_init: false
+preserve_tags: true
+```
+
+### 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 `_scripts` subfolder.
 
 Scripts can be executable files in any language, and receive the template directory and the planted directory as arguments $1 and $2.
 
@@ -49,6 +60,10 @@ replacements: # Dictionary of pattern/replacments for regex substitution, see [R
 repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
 ```
 
+#### Default values in template strings
+
+In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration. This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
+
 ### File-specific handling
 
 A `files` dictionary can specify how to handle specific files. Options are `copy`, `overwrite`, `merge`, or `ask`. The key for each entry is a filename or glob that matches the source filename (accounting for template variables if applicable):
@@ -59,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:
 
 ```
@@ -67,6 +84,14 @@ Merged content
 // /merge
 ```
 
+Or
+
+```
+# merge
+Merged content
+# /merge
+```
+
 By default files that already exist in the destination directory are not overwritten, and merging allows you to add missing parts to a Rakefile or Makefile, for example.
 
 If `ask` is specified, a memu will be provided on the command line asking how to handle a file. If the file doesn't already exist, you will be asked only whether to copy the file or not. If it does exist, `overwrite` and `merge` options will be added.
@@ -81,7 +106,11 @@ 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
+
+If `preserve_tags` is set to `true` in the config (either base or template), then existing Finder tags on the file or folder will be copied to the new file when a template is planted.
 
 ## Usage
 

data/Rakefile

@@ -38,17 +38,6 @@ end
 desc 'Clobber files'
 task clobber: :clobber_packages
 
-desc 'Development version check'
-task :ver do
-  gver = `git ver`
-  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
-  res = `grep VERSION lib/planter/version.rb`
-  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
-  puts "git tag: #{gver}"
-  puts "version.rb: #{version}"
-  puts "changelog: #{cver}"
-end
-
 desc 'Get Script Version'
 task :sver do
   res = `grep VERSION lib/planter/version.rb`
@@ -56,11 +45,6 @@ task :sver do
   print version
 end
 
-desc 'Changelog version check'
-task :cver do
-  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
-end
-
 desc 'Run tests in Docker'
 task :dockertest, :version, :login, :attempt do |_, args|
   args.with_defaults(version: 'all', login: false, attempt: 1)
@@ -78,6 +62,9 @@ task :dockertest, :version, :login, :attempt do |_, args|
       Rake::Task['dockertest'].invoke(v, false)
     end
     Process.exit 0
+  when /^3\.?3/
+    img = 'plantertest33'
+    file = 'docker/Dockerfile-3.3'
   when /^3/
     version = '3.0'
     img = 'plantertest3'
@@ -130,3 +117,52 @@ end
 
 desc 'alias for build'
 task package: :build
+
+desc 'Development version check'
+task :ver do
+  gver = `git ver`
+  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  res = `grep VERSION lib/untitled/version.rb`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts "git tag: #{gver}"
+  puts "version.rb: #{version}"
+  puts "changelog: #{cver}"
+end
+
+desc 'Changelog version check'
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end
+
+desc 'Alias for build'
+task package: :build
+
+desc 'Bump incremental version number'
+task :bump, :type do |_, args|
+  args.with_defaults(type: 'inc')
+  version_file = 'lib/untitled/version.rb'
+  content = IO.read(version_file)
+  content.sub!(/VERSION = '(?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?'/) do
+    m = Regexp.last_match
+    major = m['major'].to_i
+    minor = m['minor'].to_i
+    inc = m['inc'].to_i
+    pre = m['pre']
+
+    case args[:type]
+    when /^maj/
+      major += 1
+      minor = 0
+      inc = 0
+    when /^min/
+      minor += 1
+      inc = 0
+    else
+      inc += 1
+    end
+
+    $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
+    "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
+  end
+  File.open(version_file, 'w+') { |f| f.puts content }
+end

data/bin/plant

@@ -54,7 +54,7 @@ opts.on('-o', '--overwrite', 'Overwrite existing files') do
   Planter.overwrite = true
 end
 
-opts.on_tail('--base-dir', 'Use an alternate base directory for config and templates') do |opt|
+opts.on_tail('--base-dir DIRECTORY', 'Use an alternate base directory for config and templates') do |opt|
   Planter.base_dir = opt
 end
 
@@ -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 /howzit
-WORKDIR /howzit
-# COPY ./ /howzit/
+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.7

@@ -1,12 +1,10 @@
 FROM ruby:2.7
-# RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
-RUN mkdir /howzit
-WORKDIR /howzit
-# COPY ./ /howzit/
+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-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 /howzit
-WORKDIR /howzit
-# COPY ./ /howzit/
+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

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/array.rb

@@ -58,5 +58,22 @@ module Planter
                end
       end
     end
+
+    #
+    # Destructive version of #symbolize_keys
+    #
+    # @return [Array] Array with symbolized keys
+    #
+    def symbolize_keys!
+      replace deep_dup.symbolize_keys
+    end
+
+    ## Deep duplicate an array of hashes or arrays
+    ##
+    ## @return [Array] Deep duplicated array
+    ##
+    def deep_dup
+      map { |v| v.is_a?(Hash) || v.is_a?(Array) ? v.deep_dup : v.dup }
+    end
   end
 end

data/lib/planter/fileentry.rb

@@ -7,7 +7,7 @@ module Planter
     attr_accessor :operation
 
     # File path and target path
-    attr_reader :file, :target
+    attr_reader :file, :target, :tags
 
     ##
     ## Initialize a FileEntry object
@@ -19,10 +19,14 @@ module Planter
     ## @return [FileEntry] a Hash of parameters
     ##
     def initialize(file, target, operation)
+      return nil unless File.exist?(file)
+
       @file = file
       @target = target
       @operation = operation
 
+      @tags = Tag.get(file)
+
       super()
     end
 

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
 
@@ -61,6 +61,14 @@ module Planter
       else
         copy_file(entry)
       end
+
+      apply_tags(entry)
+    end
+
+    def apply_tags(entry)
+      return unless Planter.config[:preserve_tags]
+
+      Tag.copy(entry.file, entry.target) if File.exist?(entry.target)
     end
 
     ##
@@ -133,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)
@@ -158,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/hash.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Hash helpers
 module Planter
   ## Hash helpers
   class ::Hash
@@ -18,6 +17,14 @@ module Planter
       end
     end
 
+    ##  Destructive version of #stringify_keys
+    ##
+    ##  @return [Hash] Hash with stringified keys
+    ##
+    def stringify_keys!
+      replace stringify_keys
+    end
+
     ##
     ## Turn all keys into symbols
     ##
@@ -33,6 +40,15 @@ module Planter
       end
     end
 
+    ##
+    ## Destructive version of #symbolize_keys
+    ##
+    ## @return [Hash] Hash with symbolized keys
+    ##
+    def symbolize_keys!
+      replace symbolize_keys
+    end
+
     ##
     ## Deep merge a hash
     ##

data/lib/planter/plant.rb

@@ -68,6 +68,8 @@ module Planter
     ## @example Pass a GitHub-style repo path and get full url
     ##   expand_repo("ttscoff/planter-cli") #=> https://github.com/ttscoff/planter-cli.git
     ##
+    ## @param      repo  [String] The repo
+    ##
     ## @return     { description_of_the_return_value }
     ##
     def expand_repo(repo)
@@ -185,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
 
@@ -213,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
     ##