planter-cli 0.0.4 → 3.0.2

data/lib/tty-spinner/tasks/spec.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = "spec/{unit,integration}{,/*/**}/*_spec.rb"
+  end
+
+  namespace :spec do
+    desc "Run unit specs"
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = "spec/unit{,/*/**}/*_spec.rb"
+    end
+
+    desc "Run integration specs"
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = "spec/integration{,/*/**}/*_spec.rb"
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/lib/tty-spinner/tty-spinner.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/tty/spinner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-spinner"
+  spec.version       = TTY::Spinner::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = ["piotr@piotrmurach.com"]
+  spec.summary       = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.description   = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.homepage      = "https://ttytoolkit.org"
+  spec.license       = "MIT"
+  if spec.respond_to?(:metadata=)
+    spec.metadata = {
+      "allowed_push_host" => "https://rubygems.org",
+      "bug_tracker_uri"   => "https://github.com/piotrmurach/tty-spinner/issues",
+      "changelog_uri"     => "https://github.com/piotrmurach/tty-spinner/blob/master/CHANGELOG.md",
+      "documentation_uri" => "https://www.rubydoc.info/gems/tty-spinner",
+      "funding_uri"       => "https://github.com/sponsors/piotrmurach",
+      "homepage_uri"      => spec.homepage,
+      "rubygems_mfa_required" => "true",
+      "source_code_uri"   => "https://github.com/piotrmurach/tty-spinner"
+    }
+  end
+  spec.files         = Dir["lib/**/*"]
+  spec.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "tty-cursor", "~> 0.7"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

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/scripts/runtests.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
 cd /planter
-bundle install
+bundle update
 rake test

data/spec/cli_spec.rb

@@ -0,0 +1,27 @@
+require 'open3'
+require 'spec_helper'
+
+include PlanterHelpers
+
+describe 'CLI' do
+  TEST_DIR = File.join(File.dirname(__FILE__), 'test')
+
+  before do
+    FileUtils.rm_rf(TEST_DIR)
+    FileUtils.mkdir_p(TEST_DIR)
+  end
+
+  after do
+    FileUtils.rm_rf(TEST_DIR)
+  end
+
+  it 'displays help message' do
+    output, stderr, status = planter('--help')
+    expect(output).not_to be_empty
+  end
+
+  it 'plants a new project' do
+    output, stderr, status = planter('--defaults', "--in=#{TEST_DIR}", 'test')
+    expect(File.exist?(File.join(TEST_DIR, 'bollocks_and_beans.rtf'))).to be true
+  end
+end

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

@@ -24,3 +24,29 @@ RSpec.configure do |c|
   end
   c.add_formatter 'd'
 end
+
+require 'open3'
+require 'time'
+
+module PlanterHelpers
+  PLANTER_EXEC = File.join(File.dirname(__FILE__), '..', 'bin', 'plant')
+
+  def planter_with_env(env, *args, stdin: nil)
+    pread(env, 'bundle', 'exec', PLANTER_EXEC, "--base-dir=#{File.dirname(__FILE__)}", *args, stdin: stdin)
+  end
+
+  def pread(env, *cmd, stdin: nil)
+    out, err, status = Open3.capture3(env, *cmd, stdin_data: stdin)
+    unless status.success?
+      raise [
+        "Error (#{status}): #{cmd.inspect} failed", "STDOUT:", out.inspect, "STDERR:", err.inspect
+      ].join("\n")
+    end
+
+    [out, err, status]
+  end
+
+  def planter(*args, stdin: nil)
+    planter_with_env({}, *args, stdin: stdin)
+  end
+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

@@ -1,12 +1,9 @@
 ---
 variables:
-- key: var_key
+- key: project
   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)"
+  type: string
+  default: "bollocks and beans"
 git_init: false
 files:
   "*.tmp": ignore

data/spec/templates/test/test.rb

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

data/src/_README.md

@@ -21,9 +21,20 @@ 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.
 
-### 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.
 
@@ -68,6 +79,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:
 
 ```
@@ -98,7 +111,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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 3.0.2
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-09-01 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
@@ -328,6 +342,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".gitmodules"
 - ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
@@ -345,8 +360,10 @@ files:
 - docker/Dockerfile-2.6
 - docker/Dockerfile-2.7
 - docker/Dockerfile-3.0
+- docker/Dockerfile-3.3
 - docker/bash_profile
 - docker/inputrc
+- docker/sources.list
 - lib/.rubocop.yml
 - lib/planter.rb
 - lib/planter/array.rb
@@ -361,11 +378,92 @@ files:
 - lib/planter/script.rb
 - lib/planter/string.rb
 - lib/planter/symbol.rb
+- lib/planter/tag.rb
 - lib/planter/version.rb
+- lib/tty-spinner/.editorconfig
+- lib/tty-spinner/.github/FUNDING.yml
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/BUG_REPORT.md
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
+- lib/tty-spinner/.github/ISSUE_TEMPLATE/config.yml
+- lib/tty-spinner/.github/PULL_REQUEST_TEMPLATE.md
+- lib/tty-spinner/.github/workflows/ci.yml
+- lib/tty-spinner/.gitignore
+- lib/tty-spinner/.rspec
+- lib/tty-spinner/.rubocop.yml
+- lib/tty-spinner/CHANGELOG.md
+- lib/tty-spinner/CODE_OF_CONDUCT.md
+- lib/tty-spinner/Gemfile
+- lib/tty-spinner/LICENSE.txt
+- lib/tty-spinner/README.md
+- lib/tty-spinner/Rakefile
+- lib/tty-spinner/appveyor.yml
+- lib/tty-spinner/bin/console
+- lib/tty-spinner/bin/setup
+- lib/tty-spinner/demo.gif
+- lib/tty-spinner/examples/auto_spin.rb
+- lib/tty-spinner/examples/basic.rb
+- lib/tty-spinner/examples/clear.rb
+- lib/tty-spinner/examples/color.rb
+- lib/tty-spinner/examples/error.rb
+- lib/tty-spinner/examples/formats.rb
+- lib/tty-spinner/examples/hide_cursor.rb
+- lib/tty-spinner/examples/log.rb
+- lib/tty-spinner/examples/multi/basic.rb
+- lib/tty-spinner/examples/multi/basic_top_level.rb
+- lib/tty-spinner/examples/multi/custom_style.rb
+- lib/tty-spinner/examples/multi/files.rb
+- lib/tty-spinner/examples/multi/jobs.rb
+- lib/tty-spinner/examples/multi/multi.rb
+- lib/tty-spinner/examples/multi/multi_top_level.rb
+- lib/tty-spinner/examples/multi/pause.rb
+- lib/tty-spinner/examples/multi/threaded.rb
+- lib/tty-spinner/examples/pause.rb
+- lib/tty-spinner/examples/run.rb
+- lib/tty-spinner/examples/success.rb
+- lib/tty-spinner/examples/threaded.rb
+- lib/tty-spinner/examples/update.rb
+- lib/tty-spinner/lib/tty-spinner.rb
+- lib/tty-spinner/lib/tty/spinner.rb
+- lib/tty-spinner/lib/tty/spinner/formats.rb
+- lib/tty-spinner/lib/tty/spinner/multi.rb
+- lib/tty-spinner/lib/tty/spinner/version.rb
+- lib/tty-spinner/spec/spec_helper.rb
+- lib/tty-spinner/spec/unit/auto_spin_spec.rb
+- lib/tty-spinner/spec/unit/clear_spec.rb
+- lib/tty-spinner/spec/unit/error_spec.rb
+- lib/tty-spinner/spec/unit/events_spec.rb
+- lib/tty-spinner/spec/unit/formats_spec.rb
+- lib/tty-spinner/spec/unit/frames_spec.rb
+- lib/tty-spinner/spec/unit/hide_cursor_spec.rb
+- lib/tty-spinner/spec/unit/job_spec.rb
+- lib/tty-spinner/spec/unit/join_spec.rb
+- lib/tty-spinner/spec/unit/log_spec.rb
+- lib/tty-spinner/spec/unit/multi/auto_spin_spec.rb
+- lib/tty-spinner/spec/unit/multi/error_spec.rb
+- lib/tty-spinner/spec/unit/multi/line_inset_spec.rb
+- lib/tty-spinner/spec/unit/multi/on_spec.rb
+- lib/tty-spinner/spec/unit/multi/register_spec.rb
+- lib/tty-spinner/spec/unit/multi/spin_spec.rb
+- lib/tty-spinner/spec/unit/multi/stop_spec.rb
+- lib/tty-spinner/spec/unit/multi/success_spec.rb
+- lib/tty-spinner/spec/unit/new_spec.rb
+- lib/tty-spinner/spec/unit/pause_spec.rb
+- lib/tty-spinner/spec/unit/reset_spec.rb
+- lib/tty-spinner/spec/unit/run_spec.rb
+- lib/tty-spinner/spec/unit/spin_spec.rb
+- lib/tty-spinner/spec/unit/stop_spec.rb
+- lib/tty-spinner/spec/unit/success_spec.rb
+- lib/tty-spinner/spec/unit/tty_spec.rb
+- lib/tty-spinner/spec/unit/update_spec.rb
+- lib/tty-spinner/tasks/console.rake
+- lib/tty-spinner/tasks/coverage.rake
+- lib/tty-spinner/tasks/spec.rake
+- lib/tty-spinner/tty-spinner.gemspec
 - planter-cli.gemspec
 - scripts/deploy.rb
 - scripts/runtests.sh
 - spec/.rubocop.yml
+- spec/cli_spec.rb
 - spec/config.yml
 - spec/planter.yml
 - spec/planter/array_spec.rb
@@ -381,9 +479,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,12 +507,13 @@ 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
 test_files:
 - spec/.rubocop.yml
+- spec/cli_spec.rb
 - spec/config.yml
 - spec/planter.yml
 - spec/planter/array_spec.rb
@@ -427,8 +529,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