planter-cli 0.0.4 → 3.0.2

data/lib/planter/tag.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Planter
+  module Tag
+    class << self
+      def set(target, tags)
+        return false unless TTY::Which.exist?('xattr')
+
+        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)
+        return false unless TTY::Which.exist?('xattr')
+
+        tags = [tags] unless tags.is_a?(Array)
+        existing_tags = get(target)
+        tags.concat(existing_tags).uniq!
+
+        set_tags(target, tags)
+
+        res = $? == 0
+
+        if res
+          Planter.notify("[Added tags] to #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to add tags to #{target}", :error)
+        end
+
+        res
+      end
+
+      def get(target)
+        return false unless TTY::Which.exist?('xattr')
+
+        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)
+        return false unless TTY::Which.exist?('xattr')
+
+        tags = `xattr -px com.apple.metadata:_kMDItemUserTags "#{source}" 2>/dev/null`
+        `xattr -wx com.apple.metadata:_kMDItemUserTags "#{tags}" "#{target}"`
+        res = $? == 0
+
+        if res
+          Planter.notify("[Copied tags] from #{source} to #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to copy tags from #{source} to #{target}", :error)
+        end
+
+        res
+      end
+
+      private
+
+      def set_tags(target, tags)
+        return false unless TTY::Which.exist?('xattr')
+
+        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}"`
+
+        res = $? == 0
+
+        if res
+          Planter.notify("[Set tags] on #{target}", :debug, above_spinner: true)
+        else
+          Planter.notify("Failed to set tags on #{target}", :error)
+        end
+
+        res
+      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.2'
 end

data/lib/planter.rb

@@ -6,18 +6,21 @@ require 'json'
 require 'yaml'
 require 'fileutils'
 require 'open3'
+require 'plist'
 
 require 'chronic'
 require 'tty-reader'
 require 'tty-screen'
-require 'tty-spinner'
+# require 'tty-spinner'
 require 'tty-which'
 
+require_relative 'tty-spinner/lib/tty-spinner'
 require_relative 'planter/version'
 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'
@@ -70,20 +73,28 @@ module Planter
     ## @param      string             [String] The message string
     ## @param      notification_type  [Symbol] The notification type (:debug, :error, :warn, :info)
     ## @param      exit_code          [Integer] If provided, exit with code after delivering message
+    ## @param      newline            [Boolean] If true, add a newline to the message
+    ## @param      above_spinner      [Boolean] If true, print above the spinner
     ##
-    def notify(string, notification_type = :info, exit_code: nil)
-      case notification_type
-      when :debug
-        return false unless @debug
-
-        warn "\n{dw}#{string}{x}".x
-      when :error
-        warn "{br}#{string}{x}".x
-      when :warn
-        warn "{by}#{string}{x}".x
-      else
-        warn "{bw}#{string}{x}".x
-      end
+    ## @return     [Boolean] true if message was printed
+    def notify(string, notification_type = :info, newline: true, above_spinner: false, exit_code: nil)
+      color = case notification_type
+              when :debug
+                return false unless @debug
+
+                '{dw}'
+              when :error
+                '{br}'
+
+              when :warn
+                '{by}'
+              else
+                '{bw}'
+              end
+      out = "#{color}#{string}{x}"
+      out.gsub!(/\[(.*?)\]/, "{by}\\1{x}#{color}")
+      out = "\n#{out}" if newline
+      above_spinner ? spinner.log(out.x) : warn(out.x)
 
       Process.exit exit_code unless exit_code.nil?
 
@@ -127,7 +138,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)) }
@@ -194,13 +206,17 @@ module Planter
             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)',
+            value: '(optional, force value, can include variables. Empty to prompt. For date type: today, now, etc.)',
             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' }
+          files: {
+            '*.tmp' => 'ignore',
+            '*.bak' => 'ignore',
+            '.DS_Store' => 'ignore'
+          }
         }
         FileUtils.mkdir_p(base_dir)
         File.open(config, 'w') { |f| f.puts(YAML.dump(default_config.stringify_keys)) }
@@ -235,7 +251,7 @@ module Planter
     def process_patterns
       patterns = {}
       @config[:files].each do |file, oper|
-        pattern = Regexp.new(".*?/#{file.to_s.sub(%r{^/}, '').gsub(/\./, '\.').gsub(/\*/, '.*?').gsub(/\?/, '.')}$")
+        pattern = Regexp.new(".*?/#{file.to_s.sub(%r{^/}, '').to_rx}$")
         operator = oper.normalize_operator
         patterns[pattern] = operator
       end

data/lib/tty-spinner/.editorconfig

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

data/lib/tty-spinner/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: piotrmurach

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Report something not working correctly or as expected
+title: ''
+labels: bug
+assignees: ''
+---
+
+### Describe the problem
+
+A brief description of the issue.
+
+### Steps to reproduce the problem
+
+```
+Your code here to reproduce the issue
+```
+
+### Actual behaviour
+
+What happened? This could be a description, log output, error raised etc.
+
+### Expected behaviour
+
+What did you expect to happen?
+
+### Describe your environment
+
+* OS version:
+* Ruby version:
+* TTY::Spinner version:

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest new functionality
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+### Describe the problem
+
+A brief description of the problem you're trying to solve.
+
+### How would the new feature work?
+
+A short explanation of the new feature.
+
+```
+Example code that shows possible usage
+```
+
+### Drawbacks
+
+Can you see any potential drawbacks?

data/lib/tty-spinner/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: TTY Community Discussions
+    url: https://github.com/piotrmurach/tty/discussions
+    about: Suggest ideas, ask and answer questions

data/lib/tty-spinner/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### Describe the change
+What does this Pull Request do?
+
+### Why are we doing this?
+Any related context as to why is this is a desirable change.
+
+### Benefits
+How will the library improve?
+
+### Drawbacks
+Possible drawbacks applying this change.
+
+### Requirements
+<!--- Put an X between brackets on each line if you have done the item: -->
+- [ ] Tests written & passing locally?
+- [ ] Code style checked?
+- [ ] Rebased with `master` branch?
+- [ ] Documentation updated?
+- [ ] Changelog updated?

data/lib/tty-spinner/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+---
+name: CI
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "bin/**"
+      - "examples/**"
+      - "*.md"
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - "bin/**"
+      - "examples/**"
+      - "*.md"
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.0"
+          - "2.1"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - ruby-head
+          - jruby-9.2
+          - jruby-9.3
+          - jruby-9.4
+          - jruby-head
+          - truffleruby-head
+        include:
+          - ruby: "2.2"
+            os: ubuntu-20.04
+          - ruby: "2.7"
+            coverage: true
+    env:
+      COVERAGE: ${{ matrix.coverage }}
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake ci

data/lib/tty-spinner/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/lib/tty-spinner/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/tty-spinner/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  NewCops: enable
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 82
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  CountComments: true
+  Max: 25
+  IgnoredMethods: []
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Naming/FileName:
+  Exclude:
+    - "lib/tty-spinner.rb"
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "spec/**/*"
+
+Style/LambdaCall:
+  SupportedStyles:
+  - call
+  - braces
+
+Style/Semicolon:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolProc:
+  Exclude:
+    - "spec/**/*"
+
+Style/TrivialAccessors:
+  Enabled: false

data/lib/tty-spinner/CHANGELOG.md

@@ -0,0 +1,151 @@
+# Change log
+
+## [v0.10.0] - unreleased
+
+### Added
+* Add Spinner#log method for logging messages above the spinner
+* Add new formats (:pulse_4, :toss, :lighthouse, :points, :points_2)
+* Add ability to specify a custom mark for error, pause, success and stop methods
+
+### Changed
+* Change gemspec to include rake and rspec as dev dependencies
+* Change all built-in formats to use consistent frames formatting
+
+## [v0.9.3] - 2020-01-28
+
+### Changed
+* Change gemspec to add metadata, remove test artefacts and load version directly
+
+## [v0.9.2] - 2019-12-08
+
+### Fixed
+* Fix multi spinner cursor hiding by @benklop
+
+## [v0.9.1] - 2019-05-29
+
+### Changed
+* Change bundler to remove version limit
+* Change to update tty-cursor dependency
+
+## [v0.9.0] - 2018-12-01
+
+### Changed
+* Change tty-cursor dependency
+* Change to Ruby >= 2.0
+* Change to freeze all string literals
+* Change #execute_job to stop evaluating in spinner context and just execute the job
+* Change #register to accept a spinner instance by Shane Cavanaugh(@shanecav84)
+
+### Fixed
+* Fix to remove a stray single quote in spin_4 by Kristofer Rye(@rye)
+* Fix Multi#line_inset to correctly assign styling in threaded environment
+* Fix #stop & #auto_spin to always restore hidden cursor if enabled
+* Fix deadlock when registering multi spinners
+
+## [v0.8.0] - 2018-01-11
+
+### Added
+* Add new formats :bounce, :burger, :dance, :dot_2, ..., dot_11, :shark, :pong
+
+### Changed
+* Change to only output to a console and stop output to a file, pipe etc...
+
+### Fixed
+* Fix spinner #stop to clear line before printing final message
+
+## [v0.7.0] - 2017-09-11
+
+### Added
+* Add :spin event type and emit from TTY::Spinner#spin
+
+### Changed
+* Change to automatically spin top level multi spinner when registered spinners spin
+* Remove unnecessary checks for top spinner in multi spinner #stop, #success, #error
+
+### Fixed
+* Fix multi spinner #observe to only listen for events from registered spinners
+
+## [v0.6.0] - 2017-09-07
+
+### Changed
+* Change TTY::Spinner::Multi to render registered spinners at row
+  position at point of rendering and not registration
+
+### Fixed
+* Fix handling of multi spinner events
+* Fix multi spinner display for unicode inset characters
+
+## [v0.5.0] - 2017-08-09
+
+### Added
+* Add TTY::Spinner::Multi to allow for parallel spinners executation by Austin Blatt[@austb]
+* Add formatting for multi spinner display by Austin Blatt[@austb]
+* Add ability to add and execute jobs for single and multi spinners
+* Add abilty to register multi spinners with async jobs
+* Add #pause and #resume for single and multispinner
+
+### Changed
+* Change to unify success category to mark spinner as succeded or errored
+* Change Spinner to be thread safe
+
+### Fixed
+* Stop firing events when a spinner is stopped
+
+## [v0.4.1] - 2016-08-07
+
+### Changed
+* Change #update to clear output when in spinning state
+
+## [v0.4.0] - 2016-08-07
+
+### Added
+* Add #auto_spin to automatically displaying spinning animation
+
+### Changed
+* Change #start to setup timer and reset done state
+
+## [v0.3.0] - 2016-07-14
+
+### Added
+* Add #run to automatically execute job with spinning animation by @Thermatix
+* Add #update to allow for dynamic label name replacement
+
+### Fixed
+* Fixed cursor hiding for success and error calls by @m-o-e
+* Fix #join call to define actual error
+* Fix #stop to print only once when finished
+
+## [v0.2.0] - 2016-03-13
+
+### Added
+* Add new spinner formats by @rlqualls
+* Add ability to specify custom frames through :frames option
+* Add :clear option for removing spinner output when done
+* Add #success and #error calls for stopping spinner
+* Add :done, :success, :error completion events
+* Add :success_mark & :error_mark to allow changing markers
+* Add :interval for automatic spinning duration
+* Add #start, #join and #kill for automatic spinner animation
+
+### Changed
+* Change message formatting, use :spinner token to customize message
+* Change format for defining spinner formats and intervals
+
+## [v0.1.0] - 2014-11-15
+
+* Initial implementation and release
+
+[v0.10.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.9.3...v0.10.0
+[v0.9.3]: https://github.com/piotrmurach/tty-spinner/compare/v0.9.2...v0.9.3
+[v0.9.2]: https://github.com/piotrmurach/tty-spinner/compare/v0.9.1...v0.9.2
+[v0.9.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.9.0...v0.9.1
+[v0.9.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.8.0...v0.9.0
+[v0.8.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.7.0...v0.8.0
+[v0.7.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.0...v0.7.0
+[v0.6.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.4.1...v0.5.0
+[v0.4.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.4.0...v0.4.1
+[v0.4.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0