planter-cli 3.0.5 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff00e3dd5814379c26e559c2183c04907d1082a64d4545af978192e59cb3139e
-  data.tar.gz: 97de83aec4990751e0e1ec91213f5ff18a87e98f073726cec84834599ebaf66a
+  metadata.gz: 9d14e865eb5a5c296dc5b5672ffbacece33956b90e87c796b4d773f8c8ad1fa3
+  data.tar.gz: 8b1a869c83c2c0a31692cd41a24044d3b90e9558da5911de6e7549c60204bbc5
 SHA512:
-  metadata.gz: 0ececba941990543bca716162fc14ab187e72a8b330100763448e4170b4229848c7d9dae967a9ac0e75d88d6197e141f6db8bd89e528dc6beab561e83dafc64e
-  data.tar.gz: 0030f70d32826d28478f880ed7b17e51d8bb1312830815e27cfd050475bd720a759393e1ed3c17de618f41b7b7e14cfe47e2ad8a863eb52bdab1732636a37b49
+  metadata.gz: ade318397e46f22c542775777285f967848dd4d4271452dad8b15f6224ef99923cffb8558de4efb8ce1161d7c1398d260d1864d4923be3f8a17f70a46835160c
+  data.tar.gz: 2ce7038f68dad0af81a595ceb7bd7efc7487a87d9c2d4df86bade005c109efdfa00ef139298dce03aa1e3d074ee45155d5c756f1f264dfe08d134c62e4d957a8

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 Style/RegexpLiteral:
   Exclude:
     - Guardfile
@@ -16,6 +18,7 @@ AllCops:
   Exclude:
     - pkg/**/*.rb
     - test/*
+    - 'lib/tty-spinner/**/*'
 
 Style/MutableConstant:
   Enabled: false
@@ -31,9 +34,6 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: single_quotes
 
-Layout/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 45
 
@@ -42,6 +42,7 @@ Metrics/BlockLength:
   Exclude:
     - Rakefile
     - lib/*.rb
+    - lib/planter/string.rb
 
 Metrics/ClassLength:
   Max: 300

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-09-04 13:26:32 UTC using RuboCop version 1.66.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 125
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/planter/string.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/planter/string.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/planter/prompt.rb'
+    - 'lib/planter/string.rb'
+
+# Offense count: 2
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/planter/prompt.rb'
+    - 'lib/planter/string.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/planter/prompt.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'Rakefile.rb'
+    - 'spec/templates/test/Rakefile'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 125

data/.yardopts

@@ -1,7 +1,7 @@
 --markup=markdown
---private
---protected
+--no-private
 --list-undoc
+--exclude lib/tty-spinner/
 lib/**/*.rb
 -
 README.md

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 3.0.6
+
+2024-09-05 05:53
+
+#### IMPROVED
+
+- Code cleanup and documentation
+
 ### 3.0.5
 
 2024-09-04 07:49

data/Guardfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-scope groups: %i[doc lint unit]
+# scope groups: %i[doc lint unit]
 
 group :doc do
   guard :yard do

data/README.md

@@ -302,7 +302,7 @@ Some directories like `.git` and files like `_planter.yml` are automatically ign
 
 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.
+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 be used multiple times in the same command. Variables passed on the command line will not be prompted for when processing variables.
 
 
 

data/Rakefile

@@ -134,9 +134,6 @@ 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')

data/lib/planter/color.rb

@@ -128,9 +128,7 @@ module Planter
         compiled = ''
         normalize_color.chars.each do |char|
           compiled += char
-          if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
-            valid_color = compiled
-          end
+          valid_color = compiled if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
         end
 
         valid_color

data/lib/planter/config.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
 module Planter
+  ## Configuration class
   class Config < Hash
     attr_reader :template
 
     ##
     ## Initialize a new Config object for a template
     ##
-    ## @param template [String] template name
-    ##
     def initialize
-      # super()
+      super()
 
       @config = initial_config
       @template = Planter.template
@@ -22,26 +21,17 @@ module Planter
       generate_accessors
     end
 
-    def initial_config
-      {
-        defaults: false,
-        git_init: false,
-        files: { '_planter.yml' => 'ignore' },
-        color: true,
-        preserve_tags: nil,
-        variables: nil,
-        replacements: nil,
-        repo: false,
-        patterns: nil,
-        debug: false,
-        script: nil
-      }
-    end
-
+    ## String representation of the configuration
     def to_s
       @config.to_s
     end
 
+    ## Get a config key
+    ##
+    ## @param key [String,Symbol] key
+    ##
+    ## @return [String] value
+    ##
     def [](key)
       @config[key]
     end
@@ -59,7 +49,32 @@ module Planter
 
     private
 
+    ## Default configuration
+    ##
+    ## @return [Hash] default configuration
+    ##
+    ## @api private
+    ##
+    def initial_config
+      {
+        defaults: false,
+        git_init: false,
+        files: { '_planter.yml' => 'ignore' },
+        color: true,
+        preserve_tags: nil,
+        variables: nil,
+        replacements: nil,
+        repo: false,
+        patterns: nil,
+        debug: false,
+        script: nil
+      }
+    end
+
     ##  Generate accessors for configuration
+    ##
+    ## @api private
+    ##
     def generate_accessors
       @config.each do |k, v|
         define_singleton_method(k) { v } unless respond_to?(k)
@@ -69,8 +84,6 @@ module Planter
     ##
     ## Build a configuration from template name
     ##
-    ## @param      template  [String] The template name
-    ##
     ## @return     [Hash] Configuration object
     ##
     ## @api private

data/lib/planter/fileentry.rb

@@ -6,8 +6,14 @@ module Planter
     # Operation to execute on the file
     attr_accessor :operation
 
-    # File path and target path
-    attr_reader :file, :target, :tags
+    # File path
+    attr_reader :file
+
+    # Target path
+    attr_reader :target
+
+    # Tags
+    attr_reader :tags
 
     ##
     ## Initialize a FileEntry object
@@ -19,7 +25,7 @@ module Planter
     ## @return [FileEntry] a Hash of parameters
     ##
     def initialize(file, target, operation)
-      return nil unless File.exist?(file)
+      return unless File.exist?(file)
 
       @file = file
       @target = target

data/lib/planter/filelist.rb

@@ -50,6 +50,10 @@ module Planter
     ##
     ## @param      entry  [FileEntry] The file entry
     ##
+    ## @return     [Boolean] success
+    ##
+    ## @api private
+    ##
     def handle_operator(entry)
       case entry.operation
       when :ignore
@@ -72,6 +76,8 @@ module Planter
     #
     # @return [Boolean] success
     #
+    # @api private
+    #
     def apply_tags(entry)
       return unless Planter.config.preserve_tags
 
@@ -83,6 +89,8 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def prepare_copy
       @files.each do |entry|
         if entry.matches_pattern?
@@ -97,6 +105,10 @@ module Planter
     ##
     ## @param      entry  [FileEntry] The file entry
     ##
+    ## @return     [Boolean] success
+    ##
+    ## @api private
+    ##
     def propogate_operation(entry)
       @files.each do |file|
         file.operation = entry.operation if file.file =~ /^#{entry.file}/
@@ -111,6 +123,8 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def merge(entry)
       return copy_file(entry) if File.directory?(entry.file)
 
@@ -164,6 +178,8 @@ module Planter
     ##
     ## @return     [Boolean] success
     ##
+    ## @api private
+    ##
     def copy_file(file, overwrite: false)
       # If the target file already exists and overwrite is true,
       # or Planter.overwrite is true, then delete the target file

data/lib/planter/numeric.rb

@@ -1,29 +1,37 @@
 # frozen_string_literal: true
 
 module Planter
+  # Integer extensions
   class ::Integer
+    # Clean value (dummy method)
     def clean_value
       self
     end
 
-    def has_selector?
+    # Has selector (dummy method)
+    def selector?
       true
     end
 
+    # Highlight character
     def highlight_character(default: nil)
       "(#{self})".highlight_character(default: default)
     end
   end
 
+  # Float extensions
   class ::Float
+    # Clean value (dummy method)
     def clean_value
       self
     end
 
-    def has_selector?
+    # Has selector (dummy method)
+    def selector?
       true
     end
 
+    # Highlight character
     def highlight_character(default: nil)
       "(#{self})".highlight_character(default: default)
     end

data/lib/planter/prompt.rb

@@ -73,6 +73,8 @@ module Planter
       ##
       ## @return     [Number] numeric response
       ##
+      ## @api private
+      ##
       def read_number(integer: false)
         default = @default ? " {xw}[{xbw}#{@default}{xw}]" : ''
         Planter.notify("{by}#{@prompt} {xc}({bw}#{@min}{xc}-{bw}#{@max}{xc})#{default}")
@@ -92,6 +94,8 @@ module Planter
       ##
       ## @return     [String] date string
       ##
+      ## @api private
+      ##
       def date_default
         default = @value || @default
         return nil unless default
@@ -120,6 +124,8 @@ module Planter
       ##
       ## @return     [Date] Parsed Date object
       ##
+      ## @api private
+      ##
       def read_date(prompt: nil)
         prompt ||= @prompt
         default = date_default
@@ -141,6 +147,8 @@ module Planter
       ##
       ## @return     [String] the single-line response
       ##
+      ## @api private
+      ##
       def read_line(prompt: nil)
         return @default if Planter.accept_defaults || ENV['PLANTER_DEBUG']
 
@@ -164,6 +172,8 @@ module Planter
       ##
       ## @return     [String] the multi-line response
       ##
+      ## @api private
+      ##
       def read_lines(prompt: nil)
         prompt ||= @prompt
         save = @gum ? 'Ctrl-J for newline, Enter' : 'Ctrl-D'
@@ -180,6 +190,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_number_gum
         trap('SIGINT') { exit! }
         res = `gum input --placeholder "#{@min}-#{@max}"`.strip
@@ -193,6 +205,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_line_tty
         trap('SIGINT') { exit! }
         reader = TTY::Reader.new
@@ -207,6 +221,8 @@ module Planter
       ##
       ## @return     [String] String response
       ##
+      ## @api private
+      ##
       def read_line_gum
         trap('SIGINT') { exit! }
         res = `gum input --placeholder "(blank to use default)"`.strip
@@ -220,6 +236,8 @@ module Planter
       ##
       ## @return     [string] multiline input
       ##
+      ## @api private
+      ##
       def read_mutliline_tty
         trap('SIGINT') { exit! }
         reader = TTY::Reader.new
@@ -232,6 +250,8 @@ module Planter
       ##
       ## @return     [string] multiline input
       ##
+      ## @api private
+      ##
       def read_multiline_gum(prompt)
         trap('SIGINT') { exit! }
         width = TTY::Screen.cols > 80 ? 80 : TTY::Screen.cols
@@ -268,7 +288,7 @@ module Planter
         values = choices.to_values.map(&:clean_value)
       end
 
-      die('Choice(s) without selector, please edit config') unless keys.all?(&:has_selector?)
+      die('Choice(s) without selector, please edit config') unless keys.all?(&:selector?)
 
       default = case default_response.to_s
                 when /^\d+$/

data/lib/planter/string.rb

@@ -239,7 +239,7 @@ module Planter
       variables = variables.nil? ? Planter.variables : variables
       op_rx = ' *(?<content>c(?:opy)?|o(?:ver(?:write)?)?|i(?:gnore)?|m(?:erge)?)? *'
 
-      strip.gsub(/^if .*?(?:end(?: ?if)?|$)/mi) do |construct|
+      output = strip.gsub(/^if .*?(?:end(?: ?if)?|$)/mi) do |construct|
         # Get the condition and the content
         output = construct.match(/else:#{op_rx}/m) ? Regexp.last_match(1) : ''
 
@@ -249,13 +249,16 @@ module Planter
         end
 
         apply_conditions(conditions, variables, output)
-      end.gsub(/^#{op_rx} +if .*?(end( ?if)?|$)/mi) do |construct|
+      end
+      output = output.gsub(/^#{op_rx} +if .*?(end( ?if)?|$)/mi) do |construct|
         # Get the condition and the content
         output = construct.match(/else[; ]+(#{op_rx})/m) ? Regexp.last_match(1) : :ignore
         condition = construct.match(/^#{op_rx}(?<statement>if) +(?<condition>.*?)(?=;|$)/mi)
 
         apply_conditions([condition], variables, output)
-      end.normalize_operator
+      end
+
+      output.normalize_operator
     end
 
     ##
@@ -695,7 +698,7 @@ module Planter
     #
     # @return [Boolean] has selector
     #
-    def has_selector?
+    def selector?
       self =~ /\(.\)/ ? true : false
     end
   end

data/lib/planter/tag.rb

@@ -28,8 +28,11 @@ module Planter
 
       # Add tags to a directory.
       #
-      # @param dir [String] The directory to tag.
+      # @param target [String] The directory to tag.
       # @param tags [Array<String>] The tags to add.
+      #
+      # @return [Boolean] Success.
+      #
       def add(target, tags)
         return false unless TTY::Which.exist?('xattr')
 
@@ -105,6 +108,7 @@ module Planter
       # @return [Boolean] success
       #
       # @api private
+      #
       def set_tags(target, tags)
         return false unless TTY::Which.exist?('xattr')
 

data/lib/planter/version.rb

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

data/lib/planter.rb

@@ -45,7 +45,6 @@ EXIT_CODES = {
 # Exit the program with a message
 #
 # @param msg [String] error message
-# @param level [Symbol] notification level
 # @param code [Integer] Exit code
 #
 def die(msg = 'Exited', code = :canceled)
@@ -90,6 +89,9 @@ module Planter
     ## Accept all defaults
     attr_accessor :accept_defaults
 
+    ## Reader for the configuration object
+    ##
+    ## @return [Planter::Config] Configuration object
     def config
       @config ||= Config.new
     end
@@ -127,9 +129,7 @@ module Planter
 
       above_spinner ? spinner.log(out.x) : warn(out.x)
 
-      if exit_code && $stdout.isatty && (ENV['PLANTER_RSPEC'] == 'true' || ENV['PLANTER_DEBUG'] != 'true')
-        exit(exit_code)
-      end
+      exit(exit_code) if exit_code && $stdout.isatty && (ENV['PLANTER_RSPEC'] == 'true' || ENV['PLANTER_DEBUG'] != 'true')
 
       true
     end

data/planter-cli.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'
 
-  spec.add_development_dependency 'guard', '~> 2.11'
+  spec.add_development_dependency 'guard', '~> 2.16'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'guard-yard', '~> 2.1'

data/src/_README.md

@@ -307,7 +307,7 @@ Some directories like `.git` and files like `_planter.yml` are automatically ign
 
 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.
+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 be used multiple times in the same command. Variables passed on the command line will not be prompted for when processing variables.
 
 <!--GITHUB-->
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.7
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -346,6 +346,7 @@ files:
 - ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md