planter-cli 0.0.4 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5318772de94f6948e72fcf61709d9b0cf42c3518a775e47eaa816e8d432cf0f0
-  data.tar.gz: fcc04239c8d4c74af78f7da138d862f3a01ee053740cda5ad28e8e1019c11a29
+  metadata.gz: 0b4906c83392316be6ac61380bd0d2401a847f4c08f6afc91bdfbd4858980568
+  data.tar.gz: 7253e2ec572be45e7543d82ad2b1dde685fc5b8ba7b256ec914b0575e44ad507
 SHA512:
-  metadata.gz: 55fd5cdd6bbede37bd171df3c6686fc4ca14c869895cf122f7a38997b46121516e32342ab7f8625b26762fba668cd73611c0edeac101fdf3d2d6ec325460dbfa
-  data.tar.gz: 865480b6ed5efda83cba2b0314bf1afd685eed88c2c930e6b705e4fb104da3fadc0afd85211ea2a4930370d0c786df342a6dbf7c4f0ab371b9122f6df895150b
+  metadata.gz: 98fd1c334e3d2efdcdc10171d7a5b5f81898e9a03890bc08cd65e2f3c8a10941cfe46e5e5b23584f28c87aad3b85471ab544c3665049c5abfd911006b40bfbe8
+  data.tar.gz: a7a86edaf7bf49cb65cde877ab4aec8bd92a6f27a90c09f526e50f9f1ddc84c27655e67bfea75b9463c8033601ae1961e4854bce76f4e268bfe87aa3171c7677

data/.gitignore

@@ -43,3 +43,5 @@ Gemfile.lock
 .rvmrc
 /test
 .history
+spec/test/
+spec/noop

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,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'
@@ -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
 

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

@@ -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

@@ -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
 
     ##

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)

data/lib/planter/tag.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Planter
+  module Tag
+    class << self
+      def set(target, tags)
+        tags = [tags] unless tags.is_a?(Array)
+
+        set_tags(target, tags)
+        $? == 0
+      end
+
+      # Add tags to a directory.
+      #
+      # @param dir [String] The directory to tag.
+      # @param tags [Array<String>] The tags to add.
+      def add(target, tags)
+        tags = [tags] unless tags.is_a?(Array)
+        existing_tags = get(target)
+        tags.concat(existing_tags).uniq!
+
+        set_tags(target, tags)
+        $? == 0
+      end
+
+      def get(target)
+        res = `xattr -p com.apple.metadata:_kMDItemUserTags "#{target}" 2>/dev/null`.clean_encode
+        return [] if res =~ /no such xattr/ || res.empty?
+
+        tags = Plist.parse_xml(res)
+
+        return false if tags.nil?
+
+        tags
+      end
+
+      def copy(source, target)
+        tags = `xattr -px com.apple.metadata:_kMDItemUserTags "#{source}" 2>/dev/null`
+        `xattr -wx com.apple.metadata:_kMDItemUserTags "#{tags}" "#{target}"`
+        $? == 0
+      end
+
+      private
+
+      def set_tags(target, tags)
+        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}"`
+      end
+    end
+  end
+end

data/lib/planter/version.rb

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

data/lib/planter.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'yaml'
 require 'fileutils'
 require 'open3'
+require 'plist'
 
 require 'chronic'
 require 'tty-reader'
@@ -18,6 +19,7 @@ require_relative 'planter/hash'
 require_relative 'planter/array'
 require_relative 'planter/symbol'
 require_relative 'planter/file'
+require_relative 'planter/tag'
 require_relative 'planter/color'
 require_relative 'planter/errors'
 require_relative 'planter/prompt'
@@ -127,7 +129,8 @@ module Planter
           defaults: false,
           git_init: false,
           files: { '_planter.yml' => 'ignore' },
-          color: true
+          color: true,
+          preserve_tags: true
         }
         begin
           File.open(base_config, 'w') { |f| f.puts(YAML.dump(default_base_config.stringify_keys)) }

data/planter-cli.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.5'
 
   spec.add_runtime_dependency 'chronic', '~> 0.10'
+  spec.add_runtime_dependency 'plist', '~> 3.7.1'
   spec.add_runtime_dependency 'tty-reader', '~> 0.9'
   spec.add_runtime_dependency 'tty-screen', '~> 0.8'
   spec.add_runtime_dependency 'tty-spinner', '~> 0.9'

data/spec/planter/hash_spec.rb

@@ -80,4 +80,31 @@ describe ::Hash do
       expect(hash[:b]).not_to be_frozen
     end
   end
+
+  describe '#stringify_keys!' do
+    let(:hash) { { key1: 'value1', key2: 'value2', key3: { key4: 'value4' } } }
+
+    it 'converts symbol keys to strings destructively' do
+      hash.stringify_keys!
+      expect(hash).to eq({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => { 'key4' => 'value4' } })
+    end
+
+    it 'does not modify the original hash if already string keys' do
+      string_hash = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => { 'key4' => 'value4' } }
+      string_hash.stringify_keys!
+      expect(string_hash).to eq({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => { 'key4' => 'value4' } })
+    end
+
+    it 'handles nested hashes' do
+      nested_hash = { key1: { key2: { key3: 'value3' } } }
+      nested_hash.stringify_keys!
+      expect(nested_hash).to eq({ 'key1' => { 'key2' => { 'key3' => 'value3' } } })
+    end
+
+    it 'handles empty hashes' do
+      empty_hash = {}
+      empty_hash.stringify_keys!
+      expect(empty_hash).to eq({})
+    end
+  end
 end

data/spec/planter_spec.rb

@@ -29,6 +29,21 @@ RSpec.describe "Planter" do
     end
   end
 
+  describe '.spinner' do
+    it 'initializes a new TTY::Spinner object if not already initialized' do
+      Planter.instance_variable_set(:@spinner, nil) # Ensure spinner is not initialized
+      spinner = Planter.spinner
+      expect(spinner).to be_a(TTY::Spinner)
+    end
+
+    it 'returns the existing TTY::Spinner object if already initialized' do
+      existing_spinner = TTY::Spinner.new
+      Planter.instance_variable_set(:@spinner, existing_spinner)
+      spinner = Planter.spinner
+      expect(spinner).to eq(existing_spinner)
+    end
+  end
+
   describe '.config=' do
     #   it 'sets the config' do
     #     path = File.expand_path('spec/noop')

data/spec/templates/test/%%project:snake%%.rtf

@@ -0,0 +1,10 @@
+{\rtf1\ansi\ansicpg1252\cocoartf2761
+\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
+{\colortbl;\red255\green255\blue255;}
+{\*\expandedcolortbl;;}
+\margl1440\margr1440\vieww11520\viewh8400\viewkind0
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
+
+\f0\fs24 \cf0 Planter\
+\
+%%project:title%%}

data/spec/templates/test/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/spec/templates/test/test.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def test
+  puts "test"
+end

data/src/_README.md

@@ -21,6 +21,17 @@ If [Gum](https://github.com/charmbracelet/gum) is available it will be used for
 
 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.
 
 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.
@@ -100,6 +111,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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 3.0.1
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -262,6 +262,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
 - !ruby/object:Gem::Dependency
   name: tty-reader
   requirement: !ruby/object:Gem::Requirement
@@ -361,6 +375,7 @@ files:
 - lib/planter/script.rb
 - lib/planter/string.rb
 - lib/planter/symbol.rb
+- lib/planter/tag.rb
 - lib/planter/version.rb
 - planter-cli.gemspec
 - scripts/deploy.rb
@@ -381,9 +396,12 @@ files:
 - spec/scripts/test.sh
 - spec/scripts/test_fail.sh
 - spec/spec_helper.rb
+- spec/templates/test/%%project:snake%%.rtf
+- spec/templates/test/Rakefile
 - spec/templates/test/_planter.yml
 - spec/templates/test/_scripts/test.sh
 - spec/templates/test/_scripts/test_fail.sh
+- spec/templates/test/test.rb
 - spec/test_out/image.png
 - spec/test_out/test2.rb
 - src/_README.md
@@ -406,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Plant files and directories using templates
@@ -427,8 +445,11 @@ test_files:
 - spec/scripts/test.sh
 - spec/scripts/test_fail.sh
 - spec/spec_helper.rb
+- spec/templates/test/%%project:snake%%.rtf
+- spec/templates/test/Rakefile
 - spec/templates/test/_planter.yml
 - spec/templates/test/_scripts/test.sh
 - spec/templates/test/_scripts/test_fail.sh
+- spec/templates/test/test.rb
 - spec/test_out/image.png
 - spec/test_out/test2.rb