planter-cli 0.0.3 → 3.0.1

data/spec/planter/string_spec.rb

@@ -9,12 +9,225 @@ describe ::String do
 
   describe '.to_slug' do
     it 'slugifies a string' do
-      expect('This is a test string'.to_slug).to match /this-is-a-test-string/
+      expect('This is a test string'.to_slug).to match(/this-is-a-test-string/)
     end
 
     it 'slugifies bad characters' do
-      expect('This: #is a test string!'.to_slug).to match /this-colon-hash-is-a-test-string-bang/
+      expect('This: #is a test string!'.to_slug).to match(/this-colon-hash-is-a-test-string-bang/)
     end
   end
 
+  describe '.to_class_name' do
+    it 'converts string to CamelCase' do
+      expect('this is a test string'.to_class_name).to eq 'ThisIsATestString'
+    end
+
+    it 'handles special characters' do
+      expect('this: #is a test string!'.to_class_name).to eq 'ThisIsATestString'
+    end
+  end
+
+  describe '.snake_case' do
+    it 'converts CamelCase to snake_case' do
+      expect('ThisIsATestString'.snake_case).to eq 'this_is_a_test_string'
+    end
+
+    it 'handles strings with spaces' do
+      expect('This is a test string'.snake_case).to eq 'this_is_a_test_string'
+    end
+
+    it 'handles strings with special characters' do
+      expect('This: #is a test string!'.snake_case).to eq 'this_is_a_test_string'
+    end
+  end
+
+  describe '.camel_case' do
+    it 'converts snake_case to CamelCase' do
+      expect('this_is_a_test_string'.camel_case).to eq 'thisIsATestString'
+    end
+
+    it 'handles strings with spaces' do
+      expect('this is a test string'.camel_case).to eq 'thisIsATestString'
+    end
+
+    it 'handles strings with special characters' do
+      expect('this: #is a test string!'.camel_case).to eq 'thisIsATestString'
+    end
+  end
+
+  describe '.title_case' do
+    it 'converts a string to Title Case' do
+      expect('this is a test string'.title_case).to eq 'This Is A Test String'
+    end
+
+    it 'handles strings with special characters' do
+      expect('this: #is a test string!'.title_case).to eq 'This: #Is A Test String!'
+    end
+
+    it 'handles mixed case strings' do
+      expect('ThIs Is A TeSt StRiNg'.title_case).to eq 'This Is A Test String'
+    end
+  end
+
+  describe '.apply_variables' do
+    it 'replaces placeholders with variable values' do
+      template = 'Hello, %%name%%!'
+      variables = { name: 'World' }
+      expect(template.apply_variables(variables: variables)).to eq 'Hello, World!'
+    end
+
+    it 'handles multiple variables' do
+      template = 'Hello, %%first_name%% %%last_name%%!'
+      variables = { first_name: 'John', last_name: 'Doe' }
+      expect(template.apply_variables(variables: variables)).to eq 'Hello, John Doe!'
+    end
+
+    it 'handles missing variables gracefully' do
+      template = 'Hello, %%name%%!'
+      variables = {}
+      expect(template.apply_variables(variables: variables)).to eq 'Hello, %%name%%!'
+    end
+
+    it 'handles variables with special characters' do
+      template = 'Hello, %%name%%!'
+      variables = { name: 'John #Doe' }
+      expect(template.apply_variables(variables: variables)).to eq 'Hello, John #Doe!'
+    end
+
+    it 'handles modifiers' do
+      template = 'Hello, %%title:upper%% %%name:title%%!'
+      variables = { title: 'Mr.', name: 'john do' }
+      expect(template.apply_variables(variables: variables)).to eq 'Hello, MR. John Do!'
+    end
+
+    it 'operates in place' do
+      template = 'Hello, %%title:upper%% %%name:title%%!'
+      variables = { title: 'Mr.', name: 'john do' }
+      template.apply_variables!(variables: variables)
+      expect(template).to eq 'Hello, MR. John Do!'
+    end
+
+    it 'handles last_only' do
+      template = 'Hello, %%title%% %%title:upper%%!'
+      variables = { title: 'project title' }
+      expect(template.apply_variables(variables: variables, last_only: true)).to eq 'Hello, %%title%% PROJECT TITLE!'
+    end
+  end
+
+  describe '.apply_regexes' do
+    it 'applies a single regex replacement' do
+      template = 'Hello, World!'
+      regexes = { /World/ => 'Universe' }
+      expect(template.apply_regexes(regexes)).to eq 'Hello, Universe!'
+    end
+
+    it 'applies multiple regex replacements' do
+      template = 'Hello, World! Welcome to the World!'
+      regexes = { /World/ => 'Universe', /Welcome/ => 'Greetings' }
+      expect(template.apply_regexes(regexes)).to eq 'Hello, Universe! Greetings to the Universe!'
+    end
+
+    it 'handles no regex replacements' do
+      template = 'Hello, World!'
+      regexes = {}
+      expect(template.apply_regexes(regexes)).to eq 'Hello, World!'
+    end
+
+    it 'handles special characters in regex' do
+      template = 'Hello, World! #Welcome to the World!'
+      regexes = { /#Welcome/ => 'Greetings' }
+      expect(template.apply_regexes(regexes)).to eq 'Hello, World! Greetings to the World!'
+    end
+
+    it 'Operates in place' do
+      template = 'Hello, World! #Welcome to the World!'
+      regexes = { /#Welcome/ => 'Greetings' }
+      template.apply_regexes!(regexes)
+      expect(template).to eq 'Hello, World! Greetings to the World!'
+    end
+  end
+
+  describe '.ext' do
+    it 'applies an extension' do
+      expect("filename.rb".ext('txt')).to eq 'filename.txt'
+    end
+
+    it 'ignores an existing extension' do
+      expect("filename.rb".ext('rb')).to eq 'filename.rb'
+    end
+  end
+
+  describe '.normalize_type' do
+    it 'normalizes a date type' do
+      expect("da".normalize_type.to_s).to eq "date"
+    end
+
+    it 'normalizes an integer type' do
+      expect("int".normalize_type.to_s).to eq "integer"
+    end
+
+    it 'normalizes a float type' do
+      expect("f".normalize_type.to_s).to eq "float"
+    end
+
+    it 'normalizes a multiline type' do
+      expect("multi".normalize_type.to_s).to eq "multiline"
+    end
+
+    it 'normalizes a class type' do
+      expect("c".normalize_type.to_s).to eq "class"
+    end
+
+    it 'normalizes a module type' do
+      expect("m".normalize_type.to_s).to eq "module"
+    end
+  end
+
+  describe '.normalize_operator' do
+    it 'normalizes a copy operator' do
+      expect("copy".normalize_operator.to_s).to eq "copy"
+    end
+  end
+
+  describe '.coerce' do
+    it 'coerces a date type' do
+      expect("now".coerce(:date)).to match(/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}/)
+    end
+
+    it 'coerces an integer type' do
+      expect("10".coerce(:integer)).to eq 10
+    end
+
+    it 'coerces a float type' do
+      expect("10.0".coerce(:float)).to eq 10.0
+    end
+
+    it 'coerces a multiline type' do
+      expect("multi\nline".coerce(:multiline)).to eq "multi\nline"
+    end
+
+    it 'coerces a class type' do
+      expect("Some class".coerce(:class)).to eq "SomeClass"
+    end
+  end
+
+  describe '.clean_encode!' do
+    it 'cleans an encoded string' do
+      s = "This is a test string"
+      s.clean_encode!
+      expect(s).to eq "This is a test string"
+    end
+  end
+
+  describe '.highlight_character' do
+    it 'highlights characters' do
+      s = "(o)ption 1 (s)econd option"
+      expect(s.highlight_character).to eq "{dw}({xbw}o{dw}){xw}ption 1 {dw}({xbw}s{dw}){xw}econd option"
+    end
+
+    it 'highlights characters with default option' do
+      s = "(o)ption 1 (s)econd option"
+      expect(s.highlight_character(default: 's')).to eq "{dw}({xbw}o{dw}){xw}ption 1 {dw}({xbc}s{dw}){xw}econd option"
+    end
+  end
 end

data/spec/planter/symbol_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ::Symbol do
+  describe '.to_var' do
+    it 'turns a symbol into a string with _ instead of :' do
+      expect(:var_name.to_var).to eq :var_name
+    end
+  end
+
+  describe '.normalize_type' do
+    it 'normalizes a type symbol' do
+      expect(:string.normalize_type).to eq :string
+    end
+  end
+
+  describe '.normalize_operator' do
+    it 'normalizes an operator symbol' do
+      expect(:copy.normalize_operator).to eq :copy
+    end
+  end
+end

data/spec/planter.yml

@@ -0,0 +1,6 @@
+---
+defaults: false
+git_init: false
+files:
+  _planter.yml: ignore
+color: true

data/spec/planter_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe "Planter" do
+  describe '.notify' do
+    it 'prints a warning message stderr' do
+      expect(Planter.notify('hello world', :warn)).to be true
+    end
+
+    it 'prints an info message stderr' do
+      expect(Planter.notify('hello world', :info)).to be true
+    end
+
+    it 'prints a debug message to stderr' do
+      Planter.debug = true
+      expect(Planter.notify('hello world', :debug)).to be true
+    end
+
+    it 'does not print a debug message to stderr' do
+      Planter.debug = false
+      expect(Planter.notify('hello world', :debug)).to be false
+    end
+
+    it 'prints an error message and exits' do
+      expect do
+        Planter.notify('Error', :error, exit_code: 10)
+      end.to raise_error(SystemExit)
+    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')
+    #     FileUtils.mkdir_p(path)
+    #     Planter.base_dir = File.expand_path('spec/noop')
+    #     allow(File).to receive(:open).with(File.join(Planter.base_dir, "config.yml"), 'w')
+    #     allow(File).to receive(:open).with(File.join(Planter.base_dir, 'templates', 'test', '_planter.yml'),
+    #                                        'w')
+    #     Planter.config = 'test'
+    #     expect(File.exist?('spec/noop/config.yml')).to be true
+    #     FileUtils.remove_entry_secure(path)
+    #   end
+    #
+    # it 'creates a new configuration file if it does not exist' do
+    #   path = File.expand_path('spec/noop')
+    #   FileUtils.mkdir_p(path)
+    #   Planter.base_dir = File.expand_path('spec/noop')
+    #   allow(File).to receive(:exist?).with(File.join(Planter.base_dir, 'config.yml')).and_return(false)
+    #   expect(File).to receive(:open).with(File.join(Planter.base_dir, 'config.yml'), 'w')
+    #   Planter.config = 'test'
+    #   FileUtils.remove_entry_secure(path)
+    # end
+
+    # it 'creates a new template directory if it does not exist' do
+    #   path = File.expand_path('spec/noop')
+    #   FileUtils.mkdir_p(path)
+    #   Planter.base_dir = File.expand_path('spec/noop')
+    #   allow(File).to receive(:exist?).with(File.join(Planter.base_dir, 'templates', 'test',
+    #                                                  '_planter.yml')).and_return(false)
+    #   allow(File).to receive(:directory?).with(File.join(Planter.base_dir, 'templates', 'test')).and_return(false)
+    #   expect(FileUtils).to receive(:mkdir_p).with(File.join(Planter.base_dir, 'templates', 'test'))
+    #   Planter.config = 'test'
+    #   FileUtils.remove_entry_secure(path)
+    # end
+  end
+end

data/spec/scripts/test.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "Oops"

data/spec/scripts/test_fail.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exit 128

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'simplecov'
+require 'cli-test'
+require 'fileutils'
 
 SimpleCov.start
 
@@ -13,8 +15,12 @@ require 'planter'
 
 RSpec.configure do |c|
   c.expect_with(:rspec) { |e| e.syntax = :expect }
-  c.before(:each) do
+  c.before do
+    ENV["RUBYOPT"] = '-W1'
+    ENV['PLANTER_DEBUG'] = 'true'
+    Planter.base_dir = File.expand_path('spec')
     allow(FileUtils).to receive(:remove_entry_secure).with(anything)
+    allow(FileUtils).to receive(:mkdir_p).with(anything)
   end
-  c.add_formatter 'Fuubar'
+  c.add_formatter 'd'
 end

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/_planter.yml

@@ -0,0 +1,12 @@
+---
+variables:
+- 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)"
+  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

data/spec/templates/test/_scripts/test.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "Oops"

data/spec/templates/test/_scripts/test_fail.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exit 128

data/spec/templates/test/test.rb

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

data/spec/test_out/test2.rb

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

data/src/_README.md

@@ -19,7 +19,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.
 
@@ -54,6 +65,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):
@@ -72,6 +87,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.
@@ -88,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.3
+  version: 3.0.1
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 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,14 +375,35 @@ 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
 - scripts/runtests.sh
 - spec/.rubocop.yml
+- spec/config.yml
+- spec/planter.yml
+- spec/planter/array_spec.rb
+- spec/planter/file_entry_spec.rb
+- spec/planter/file_spec.rb
+- spec/planter/filelist_spec.rb
+- spec/planter/hash_spec.rb
 - spec/planter/plant_spec.rb
+- spec/planter/script_spec.rb
 - spec/planter/string_spec.rb
+- spec/planter/symbol_spec.rb
+- spec/planter_spec.rb
+- 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
 homepage: https://github.com/ttscoff/planter-cli
 licenses:
@@ -395,6 +430,26 @@ specification_version: 4
 summary: Plant files and directories using templates
 test_files:
 - spec/.rubocop.yml
+- spec/config.yml
+- spec/planter.yml
+- spec/planter/array_spec.rb
+- spec/planter/file_entry_spec.rb
+- spec/planter/file_spec.rb
+- spec/planter/filelist_spec.rb
+- spec/planter/hash_spec.rb
 - spec/planter/plant_spec.rb
+- spec/planter/script_spec.rb
 - spec/planter/string_spec.rb
+- spec/planter/symbol_spec.rb
+- spec/planter_spec.rb
+- 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