planter-cli 0.0.3 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5445d6dfa3c8e0663006ce933f45f6e0717ccb4be51c67da0901c9606a5c70c
-  data.tar.gz: 0ee188813bbc0bb274837b130231dd937f403484d1a26adccee36b8126d2ee3f
+  metadata.gz: 0b4906c83392316be6ac61380bd0d2401a847f4c08f6afc91bdfbd4858980568
+  data.tar.gz: 7253e2ec572be45e7543d82ad2b1dde685fc5b8ba7b256ec914b0575e44ad507
 SHA512:
-  metadata.gz: 78a345ff2396c29c7beeadda989780003b5cc63174e4b9bcfcd0344350d8160fbb403231208ba1c3ca0d4bb66083711e675f5aad7dff5d14b226d59f31be6554
-  data.tar.gz: 1dc8ab448b3674319f6a469439d7b8dd6657a9c85061358fee7c7280a1fe9bb5910e4bf5d69e3223511bfccbd77c9e09c666b1441619ec0489e25d9c934fc048
+  metadata.gz: 98fd1c334e3d2efdcdc10171d7a5b5f81898e9a03890bc08cd65e2f3c8a10941cfe46e5e5b23584f28c87aad3b85471ab544c3665049c5abfd911006b40bfbe8
+  data.tar.gz: a7a86edaf7bf49cb65cde877ab4aec8bd92a6f27a90c09f526e50f9f1ddc84c27655e67bfea75b9463c8033601ae1961e4854bce76f4e268bfe87aa3171c7677

data/.gitignore

@@ -41,4 +41,7 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
-test
+/test
+.history
+spec/test/
+spec/noop

data/.rubocop.yml

@@ -23,10 +23,6 @@ Style/MutableConstant:
 Style/SpecialGlobalVars:
   Enabled: false
 
-Security/YAMLLoad:
-  Exclude:
-    - 'lib/**/*.rb'
-
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes
@@ -45,7 +41,7 @@ Metrics/BlockLength:
   Max: 45
   Exclude:
     - Rakefile
-    - bin/howzit
+    - bin/untitled
     - lib/*.rb
 
 Metrics/ClassLength:
@@ -67,8 +63,7 @@ Metrics/ModuleLength:
   Max: 174
 
 Security/YAMLLoad:
-  Exclude:
-    - '**/*.rb'
+  Enabled: false
 
 Style/ModuleFunction:
   Exclude:
@@ -76,3 +71,6 @@ Style/ModuleFunction:
 
 Style/RaiseArgs:
   EnforcedStyle: compact
+
+Style/SlicingWithRange:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+### 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,7 +14,18 @@ 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.
+
+Example config (written on first run):
+
+```yaml
+files:
+  .DS_Store: ignore
+  "*.tmp": ignore
+  "*.bak": ignore
+git_init: false
+preserve_tags: true
+```
 
 ### Scripts.
 
@@ -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):
@@ -67,6 +82,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.
@@ -83,6 +106,10 @@ replacements:
 
 Replacements are performed on both file/directory names and file 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
 
 The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.

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'
@@ -107,10 +94,10 @@ task :dockertest, :version, :login, :attempt do |_, args|
   dir_args = dirs.map { |s, d| " -v '#{s}:#{d}'" }.join(' ')
   exec "docker run #{dir_args} -it #{img} /bin/bash -l" if args[:login]
 
-  spinner = TTY::Spinner.new("[:spinner] Running tests (#{args[:version]})...", hide_cursor: true)
+  spinner = TTY::Spinner.new("[:spinner] Running tests (#{version})...", hide_cursor: true)
 
   spinner.auto_spin
-  res = `docker run --rm #{dir_args} -it #{img}`
+  `docker run --rm #{dir_args} -it #{img}`
   # raise DockerError.new('Error running docker image') unless $?.success?
 
   # commit = puts `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
@@ -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

@@ -22,6 +22,7 @@ options = {
 #   min: 1
 #   max: 5
 Planter.variables = {}
+Planter.base_dir = ENV['PLANTER_DIR'] || File.expand_path('~/.config/planter')
 Planter::Color.coloring = $stdout.isatty
 
 opts = OptionParser.new
@@ -53,6 +54,10 @@ opts.on('-o', '--overwrite', 'Overwrite existing files') do
   Planter.overwrite = true
 end
 
+opts.on_tail('--base-dir DIRECTORY', 'Use an alternate base directory for config and templates') do |opt|
+  Planter.base_dir = opt
+end
+
 opts.on_tail('-d', '--debug', 'Display version number') do
   Planter.debug = true
 end
@@ -100,6 +105,7 @@ elsif ARGV.count.zero?
 end
 
 ARGV.each do |template|
+  Planter.spinner.update(title: 'Initializing configuration')
   Planter.config = template
   app = Planter::Plant.new
   app.plant

data/docker/Dockerfile-2.6

@@ -1,11 +1,11 @@
 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
+# COPY ./ /planter/
 RUN gem install bundler:2.2.29
-RUN apt-get update -y
-RUN apt-get install -y less vim
+# RUN apt-get update -y
+# 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

data/docker/Dockerfile-2.7

@@ -1,8 +1,8 @@
 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
+# COPY ./ /planter/
 RUN gem install bundler:2.2.29
 RUN apt-get update -y
 RUN apt-get install -y less vim

data/docker/Dockerfile-3.0

@@ -1,8 +1,8 @@
 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
+# COPY ./ /planter/
 RUN gem install bundler:2.2.29
 RUN apt-get update -y
 RUN apt-get install -y less vim

data/lib/planter/array.rb

@@ -24,5 +24,56 @@ module Planter
       end.join('{dw}/')
       out << '{dw}]{x}'
     end
+
+    ##
+    ## Stringify keys in an array of hashes or arrays
+    ##
+    ## @return [Array] Array with nested hash keys stringified
+    ##
+    def stringify_keys
+      each_with_object([]) do |v, arr|
+        arr << if v.is_a?(Hash)
+                 v.stringify_keys
+               elsif v.is_a?(Array)
+                 v.map { |x| x.is_a?(Hash) || x.is_a?(Array) ? x.stringify_keys : x }
+               else
+                 v
+               end
+      end
+    end
+
+    ##
+    ## Symbolize keys in an array of hashes or arrays
+    ##
+    ## @return [Array] Array with nested hash keys symbolized
+    ##
+    def symbolize_keys
+      each_with_object([]) do |v, arr|
+        arr << if v.is_a?(Hash)
+                 v.symbolize_keys
+               elsif v.is_a?(Array)
+                 v.map { |x| x.is_a?(Hash) || x.is_a?(Array) ? x.symbolize_keys : x }
+               else
+                 v
+               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/color.rb

@@ -81,7 +81,7 @@ module Planter
       [:default, '0;39']
     ].map(&:freeze).freeze
 
-    # Array of attribute keys only
+    # @return [Array<String>] all available color names
     ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
 
     # Returns true if Color supports the +feature+.

data/lib/planter/errors.rb

@@ -7,6 +7,7 @@ module Planter
     EXIT_CODES = {
       argument: 12,
       canceled: 1,
+      script: 10,
       config: 127,
       git: 129
     }.deep_freeze
@@ -55,5 +56,18 @@ module Planter
         super(msg)
       end
     end
+
+    #
+    # Script error
+    #
+    class ScriptError < StandardError
+      def initialize(msg = nil)
+        msg = msg ? "Script: #{msg}" : 'Script error'
+        Planter.spinner.error('(Error)')
+        Planter.notify(msg, :error, exit_code: EXIT_CODES[:script])
+
+        super(msg)
+      end
+    end
   end
 end

data/lib/planter/file.rb

@@ -2,10 +2,93 @@
 
 # Main module
 module Planter
-  def File.binary?(name)
-    IO.read(name) do |f|
-      f.each_byte { |x| x.nonzero? or return true }
+  # File helpers
+  class ::File
+    #
+    # Test if file is text
+    #
+    # @param name [String] file path
+    #
+    # @return [Boolean] File is text
+    #
+    def self.text?(name)
+      !binary?(name)
+    end
+
+    #
+    # Test if file is binary
+    #
+    # @param name [String] File path
+    #
+    # @return [Boolean] file is binary
+    #
+    def self.binary?(name)
+      return true if name.nil? || name.empty? || !File.exist?(name)
+
+      ascii = control = binary = 0
+
+      bytes = File.open(name, 'rb') { |io| io.read(1024) }
+      return true if bytes.nil? || bytes.empty?
+
+      bytes.each_byte do |bt|
+        case bt
+        when 0...32
+          control += 1
+        when 32...128
+          ascii += 1
+        else
+          binary += 1
+        end
+      end
+
+      first_test = binary.to_f / ascii > 0.05
+
+      first_test || second_test(name)
+    end
+
+    # Allowable text file types
+    TEXT_TYPES = %w[text ansi xml json yaml csv empty].freeze
+
+    #
+    # Secondary test with file command
+    #
+    # @param name [String] file path
+    #
+    # @return [Boolean] file is binary according to file command
+    #
+    def self.second_test(name)
+      if TTY::Which.exist?('file')
+        file_type, status = Open3.capture2e('file', name)
+        file_type = file_type.split(':')[1..-1].join(':').strip
+        if file_type =~ /Apple binary property list/ && TTY::Which.exist?('plutil')
+          `plutil -convert xml1 "#{name}"`
+          File.binary?(name)
+        else
+          status.success? && !text_type?(file_type)
+        end
+      else
+        false
+      end
+    end
+
+    #
+    # Tertiary test for binary file
+    #
+    # @param name [String] file path
+    #
+    # @return [Boolean] file is binary according to mdls
+    #
+    def self.third_test(name)
+      if TTY::Which.exist?('mdls')
+        file_type, status = Open3.capture2e('mdls', '-name', 'kMDItemContentTypeTree', name)
+        status.success? && !text_type?(file_type)
+      else
+        false
+      end
+    end
+
+    def self.text_type?(name)
+      TEXT_TYPES.any? { |type| name.downcase.include?(type) } || name.empty?
     end
-    false
   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

@@ -10,7 +10,7 @@ module Planter
     ##
     ## @param      path  [String] The base path for template
     ##
-    def initialize(path)
+    def initialize(path = Planter.base_dir)
       @basedir = File.realdirpath(path)
 
       search_path = File.join(@basedir, '**/*')
@@ -30,9 +30,9 @@ module Planter
     end
 
     ##
-    ## Public method for copying files based on their operator
+    ## Public method for copying @files to target based on their operator
     ##
-    ## @return     [Boolean] success
+    ## @return     [Boolean] success or failure
     ##
     def copy
       @files.each do |file|
@@ -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
 
     ##
@@ -89,36 +97,53 @@ module Planter
     end
 
     ##
-    ## Copy tagged merge sections from source to target
+    ## Copy tagged merge sections from source to target. If merge tags do not exist in the file,
+    ## append the entire file contents to the target.
     ##
     ## @param      entry  [FileEntry] The file entry
     ##
+    ## @return     [Boolean] success
+    ##
     def merge(entry)
       return copy_file(entry) if File.directory?(entry.file)
 
+      # Get the file type
       type = `file #{entry.file}`
       case type.sub(/^#{Regexp.escape(entry.file)}: /, '').split(/:/).first
       when /Apple binary property list/
+        # Convert to XML1 format
         `plutil -convert xml1 #{entry.file}`
         `plutil -convert xml1 #{entry.target}`
         content = IO.read(entry.file)
       when /data/
+        # Simply copy the file
         return copy_file(entry)
       else
+        # Copy the file if it is binary
         return copy_file(entry) if File.binary?(entry.file)
 
+        # Read the file content
         content = IO.read(entry.file)
       end
 
+      # Get the merge sections from the file, delimited by merge and /merge
       merges = content.scan(%r{(?<=\A|\n).{,4}merge *\n(.*?)\n.{,4}/merge}m)
                       &.map { |m| m[0].strip.apply_variables.apply_regexes }
+      # If no merge sections are found, use the entire file
       merges = [content] if !merges || merges.empty?
-      new_content = IO.read(entry.target)
-      merges.delete_if { |m| new_content =~ /#{Regexp.escape(m)}/ }
+
+      # Get the existing content of the target file
+      target_content = IO.read(entry.target)
+
+      # Remove any merges that already exist in the target file
+      merges.delete_if { |m| target_content =~ /#{Regexp.escape(m)}/ }
+
+      # 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 "#{new_content.chomp}\n\n#{merges.join("\n\n")}" }
+        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)
       else
+        # If there are no merge sections left, copy the file instead
         copy_file(entry)
       end
     end
@@ -129,14 +154,25 @@ module Planter
     ## @param      file       [FileEntry] The file entry
     ## @param      overwrite  [Boolean] Force overwrite
     ##
+    ## @return     [Boolean] success
+    ##
     def copy_file(file, overwrite: false)
+      # 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
       if !File.exist?(file.target) || overwrite || Planter.overwrite
+        # 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)
+        # Log a message to the console
         Planter.notify("Copied #{file.file} => #{file.target}", :debug)
+        # Return true to indicate success
         true
       else
+        # Log a message to the console
         Planter.notify("Skipped #{file.file} => #{file.target}", :debug)
+        # Return false to indicate that the copy was skipped
         false
       end
     end