planter-cli 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5445d6dfa3c8e0663006ce933f45f6e0717ccb4be51c67da0901c9606a5c70c
+  data.tar.gz: 0ee188813bbc0bb274837b130231dd937f403484d1a26adccee36b8126d2ee3f
+SHA512:
+  metadata.gz: 78a345ff2396c29c7beeadda989780003b5cc63174e4b9bcfcd0344350d8160fbb403231208ba1c3ca0d4bb66083711e675f5aad7dff5d14b226d59f31be6554
+  data.tar.gz: 1dc8ab448b3674319f6a469439d7b8dd6657a9c85061358fee7c7280a1fe9bb5910e4bf5d69e3223511bfccbd77c9e09c666b1441619ec0489e25d9c934fc048

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,44 @@
+# Parts of this file were adapted from
+# GitHub’s collection of .gitignore file templates
+# which are Copyright (c) 2016 GitHub, Inc.
+# and released under the MIT License.
+# For more details, visit the project page:
+# https://github.com/github/gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+test

data/.irbrc

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+IRB.conf[:AUTO_INDENT] = true
+
+require "irb/completion"
+require_relative "lib/planter"
+
+# rubocop:disable Style/MixinUsage
+include Planter # standard:disable all
+# rubocop:enable Style/MixinUsage
+
+require "awesome_print"
+AwesomePrint.irb!

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,78 @@
+Style/RegexpLiteral:
+  Exclude:
+    - Guardfile
+
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  Include:
+    - Gemfile
+    - Guardfile
+    - Rakefile
+    - bin/planter
+    - lib/**/*.rb
+  Exclude:
+    - pkg/**/*.rb
+    - test/*
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Security/YAMLLoad:
+  Exclude:
+    - 'lib/**/*.rb'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 45
+
+Metrics/BlockLength:
+  Max: 45
+  Exclude:
+    - Rakefile
+    - bin/howzit
+    - lib/*.rb
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/PerceivedComplexity:
+  Max: 30
+
+# Metrics/AbcSize:
+#   Max: 45
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 174
+
+Security/YAMLLoad:
+  Exclude:
+    - '**/*.rb'
+
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/planter/color.rb'
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+sudo: required
+dist: trusty
+cache: bundler
+rvm:
+  - 2

data/.yardopts

@@ -0,0 +1,8 @@
+--markup=markdown
+--private
+--protected
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+### 0.0.3
+
+2024-08-28 09:46
+
+#### CHANGED
+
+- Change template config from _config.yml to _planter.yml
+
+#### NEW
+
+- Replacements key in config for a dictionary of regex patterns and replacements
+- Add repo key to config, pull a git repo
+- Allow `value:` to be specified for any key. If the value contains %%vars%% or matches regexes, it will be updated and included without prompting.
+- Add multiline type allowing for paragraph(s)
+
+#### IMPROVED
+
+- Adding tests
+- Better error reporting
+- More custom error handling
+- Rubocop warnings
+- Better Docker config for testing
+
+#### FIXED
+
+- Merge wasn't populating template placeholders
+- Remove flags from hashbang for wider compatibility
+- Place main config in ~/.config/planter and not in planter/templates
+
+### 0.0.2
+
+2024-08-26 10:25
+
+#### NEW:
+
+- Add repo key to config, pull a git rep
+- replacements key in config for a dictionary of regex patterns and replacements
+
+#### IMPROVED
+
+- Better error reporting
+
+#### FIXED
+
+- Merge wasn't populating template placeholders

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in planter-cli.gemspec.
+gemspec

data/Guardfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+scope groups: %i[doc lint unit]
+
+group :doc do
+  guard :yard do
+    watch(%r{^lib/(.+)\.rb$})
+  end
+end
+
+group :lint do
+  guard :rubocop do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+group :unit do
+  guard :rspec, cmd: 'bundle exec rspec --color --format Fuubar' do
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^lib/planter/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^spec/.+_spec\.rb$})
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brett Terpstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,208 @@
+
+
+Plant a directory structure and files using templates.
+
+## Installation
+
+    gem install planter-cli
+
+If you run into errors, try `gem install --user-install planter-cli`, or as a last ditch effort, `sudo gem install planter-cli`.
+
+### Optional
+
+If [Gum](https://github.com/charmbracelet/gum) is available it will be used for command line input.
+
+## 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.
+
+### 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.
+
+Scripts can be executable files in any language, and receive the template directory and the planted directory as arguments $1 and $2.
+
+### Templates
+
+Templates are directories found in `~/.config/planter/templates/[TEMPLATE_NAME]`. All files and directories inside of these template directories are copied when that template is called. Filenames, directory names, and file contents can all use template placeholders.
+
+Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. %%KEY%% placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
+
+Each template contains a `_planter.yml` file that defines variables and other configuration options. The file format for all configuration files is [YAML](https://yaml.org/spec/1.2.2/).
+
+First, there's a `variables` section that defines variables used in the template. It's an array of dictionaries, each dictionary defining one variable. The required fields are `key` (the key used to insert the variable) and `prompt` (the text provided on the command line when asking for the variable). The rest are optional:
+
+```yaml
+variables:
+  - key: var_key
+    prompt: Prompt text
+    type: string # [string,multiline,float,integer,number,date] defaults to string
+    # value: (force value, string can include %%variables%% and regexes will be replaced. For date type can be today, time, now, etc.)
+    default: Untitled
+    min: 1
+    max: 5
+script: # array of scripts, args passed as [script and args] TEMPLATE_DIR PWD
+  - process.py
+git_init: false # if true, initialize a git repository in the newly-planted directory
+files: # Dictionary for file handling (see [File-specific handling](#file-specific-handling))
+replacements: # Dictionary of pattern/replacments for regex substitution, see [Regex replacements](#regex-replacements)
+repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
+```
+
+### 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):
+
+```yaml
+files:
+  "*.py": merge
+  "%%title%%.md": overwrite
+```
+
+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:
+
+```
+// 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.
+
+### Regex replacements
+
+In addition to manually-placed template variables, you can also specify regular expressions for replacement. The `replacements` dictionary is a set of key/value pairs with the regex pattern as the key, and the replacement as the value. Both should be quoted in almost all circumstances.
+
+```yaml
+replacements:
+  "Planter": "%%title:cap%%"
+  "(main|app)\.js": "%%script:lower%%.js"
+```
+
+Replacements are performed on both file/directory names and file contents.
+
+## 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.
+
+```
+Usage: planter [options] TEMPLATE
+    --defaults                       Accept default values for all variables
+    -i, --in TARGET                  Plant in TARGET instead of current directory
+    -o, --overwrite                  Overwrite existing files
+    -k, --var=KEY:VALUE,KEY:VALUE... Pass a variable on the command line as KEY:VALUE pairs. Can be used multiple times.
+    -d, --debug                      Display version number
+    -h, --help                       Display this screen, or list variables for template argument
+    -v, --version                    Display version number
+```
+
+Files will be copied, but existing files will not be overwritten unless otherwise noted in the `files` configuration for the template.
+
+Some directories like `.git` and files like `_planter.yml` are automatically ignored. If you want to create a git repository, include the `git_init: true` key in config.
+
+When `plant` is run, any defined variables will be requested on the command line using the defined prompt. If a `default` key is specified, hitting return at the prompt will accept the default value.
+
+Variables can be passed on the command line with `--var KEY:VALUE`. This flag can contain a comma-separated list, e.g. `--var KEY:VALUE,KEY:VALUE` or used multiple times in the same command. Variables passed on the command line will not be prompted for when processing variables.
+
+
+
+## Documentation
+
+- [YARD documentation][RubyDoc] is hosted by RubyDoc.info.
+- [Interactive documentation][Omniref] is hosted by Omniref.
+
+[RubyDoc]: http://www.rubydoc.info/gems/planter-cli
+
+## Development and Testing
+
+### Source Code
+
+The [planter-cli source] is hosted on GitHub.
+
+Clone the project with
+
+```
+$ git clone https://github.com/ttscoff/planter-cli.git
+```
+
+[planter-cli source]: https://github.com/ttscoff/planter-cli
+
+### Requirements
+
+You will need [Ruby] with [Bundler].
+
+Install the development dependencies with
+
+```
+$ bundle
+```
+
+[Bundler]: http://bundler.io/
+[Ruby]: https://www.ruby-lang.org/
+
+### Rake
+
+Run `$ rake -T` to see all Rake tasks.
+
+```
+rake build                              # Build planter-cli-0.0.3.gem into the...
+rake build:checksum                     # Generate SHA512 checksum of planter-...
+rake bump:current[no_args]              # Show current gem version
+rake bump:file[no_args]                 # Show version file path
+rake bump:major[no_args]                # Bump major part of gem version
+rake bump:minor[no_args]                # Bump minor part of gem version
+rake bump:patch[no_args]                # Bump patch part of gem version
+rake bump:pre[no_args]                  # Bump pre part of gem version
+rake bump:set                           # Sets the version number using the VE...
+rake bump:show-next[no_args]            # Show next major|minor|patch|pre version
+rake clean                              # Remove any temporary products
+rake clobber                            # Remove any generated files / Clobber...
+rake clobber_packages                   # Remove packages
+rake cver                               # Changelog version check
+rake dockertest[version,login,attempt]  # Run tests in Docker
+rake install                            # Build and install planter-cli-0.0.3....
+rake install:local                      # Build and install planter-cli-0.0.3....
+rake package                            # alias for build
+rake release[remote]                    # Create tag v0.0.3 and build and push...
+rake rubocop                            # Run RuboCop
+rake rubocop:autocorrect                # Autocorrect RuboCop offenses (only w...
+rake rubocop:autocorrect_all            # Autocorrect RuboCop offenses (safe a...
+rake spec                               # Run RSpec code examples
+rake test                               # Run test suite
+rake ver                                # Development version check
+rake yard                               # Generate YARD Documentation
+```
+
+### Guard
+
+Guard tasks have been separated into the following groups:
+`doc`, `lint`, and `unit`.
+By default, `$ guard` will generate documentation, lint, and run unit tests.
+
+## Contributing
+
+Please submit and comment on bug reports and feature requests.
+
+To submit a patch:
+
+1. Fork it (https://github.com/ttscoff/planter-cli/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Make changes. Write and run tests.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create a new Pull Request.
+
+## License
+
+This Ruby gem is licensed under the MIT license.
+
+## Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.
+
+

data/Rakefile

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'bump/tasks'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require 'tty-spinner'
+
+## Docker error class
+class DockerError < StandardError
+  def initialize(msg = nil)
+    msg = msg ? "Docker error: #{msg}" : 'Docker error'
+    super(msg)
+  end
+end
+
+task default: %i[test yard]
+
+desc 'Run test suite'
+task test: %i[rubocop spec]
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--format documentation'
+end
+
+RuboCop::RakeTask.new do |t|
+  t.formatters = ['progress']
+end
+
+YARD::Rake::YardocTask.new
+
+desc 'Remove packages'
+task :clobber_packages do
+  FileUtils.rm_f 'pkg/*'
+end
+# Make a prerequisite of the preexisting clobber task
+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`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  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)
+  `open -a Docker`
+
+  Rake::Task['clobber'].reenable
+  Rake::Task['clobber'].invoke
+  Rake::Task['build'].reenable
+  Rake::Task['build'].invoke
+
+  case args[:version]
+  when /^a/
+    %w[6 7 3].each do |v|
+      Rake::Task['dockertest'].reenable
+      Rake::Task['dockertest'].invoke(v, false)
+    end
+    Process.exit 0
+  when /^3/
+    version = '3.0'
+    img = 'plantertest3'
+    file = 'docker/Dockerfile-3.0'
+  when /6$/
+    version = '2.6'
+    img = 'plantertest26'
+    file = 'docker/Dockerfile-2.6'
+  when /(^2|7$)/
+    version = '2.7'
+    img = 'plantertest27'
+    file = 'docker/Dockerfile-2.7'
+  else
+    version = '3.0.1'
+    img = 'plantertest'
+    file = 'docker/Dockerfile'
+  end
+
+  puts `docker build . --file #{file} -t #{img}`
+
+  raise DockerError.new('Error building docker image') unless $?.success?
+
+  dirs = {
+    File.dirname(__FILE__) => '/planter',
+    File.expand_path('~/.config') => '/root/.config'
+  }
+  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.auto_spin
+  res = `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
+  $?.success? ? spinner.success : spinner.error
+  spinner.stop
+
+  # puts res
+  # puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
+rescue DockerError
+  raise StandardError.new('Docker not responding') if args[:attempt] > 3
+
+  `open -a Docker`
+  sleep 3
+  Rake::Task['dockertest'].reenable
+  Rake::Task['dockertest'].invoke(args[:version], args[:login], args[:attempt] + 1)
+end
+
+desc 'alias for build'
+task package: :build