bashly 2.0.0.rc1 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e96439b1894f3097d9c8ea8d49b42254075a41bf02b233aa7d57674030e2d7f
-  data.tar.gz: 14963288238d456e105ce739fdc076d0bb950f497a234851725ba3f887a4a982
+  metadata.gz: b1b1d33984cddf5a4c3853a1189e82633fe43d9f1d9c5b8dcbde05204571bcb0
+  data.tar.gz: 4d898b9019f4d9fde7c0b3ff0857fbf580a50db5eebb4f7fbb196ae48ac27e71
 SHA512:
-  metadata.gz: 474e72b43adcba1b0860f123be0584dbf8d7d7d14797f44018603f6f805e6a792b92282201d7930383e40ff48d771094e339e0c279c12940558a17d07dc09f06
-  data.tar.gz: 343351f0dbcb3d182ef2050e99a22f2ff39a1839ba11b208712c3cb85178f44678628f05ac1d2b2a4370e2dc77055f66972d16e94f5a4122dff409b937d9e956
+  metadata.gz: 5ed3e82b235dc599e3698a98ddb8c135084ba4c76995693e9440e5f26e977d5cce29c23fc56a070c4ce5e600da7a9ca141ff17f0aea75a3028505da75bc4fc79
+  data.tar.gz: 3804b6705fad255c15e23327b2f4a02f9ecb9ec63762dbee790d3d5c6a7f33ddb03e51090d4dc0e2a6326a9c63ecb5deb06bcfe03d971f02fb4f8843b2a87cc1

data/lib/bashly/commands/add.rb

@@ -29,7 +29,7 @@ module Bashly
         else
           add_lib args['LIBRARY']
         end
-
+      ensure
         lib_source.cleanup if lib_source.git?
       end
 

data/lib/bashly/commands/generate.rb

@@ -107,6 +107,8 @@ module Bashly
           quiet_say "r`warning` not upgrading c`#{existing_file}`, " \
             "unknown library '#{library_name}'"
         end
+      ensure
+        source.cleanup if source&.git?
       end
 
       def upgrade!(existing_file, library)

data/lib/bashly/commands/validate.rb

@@ -1,5 +1,3 @@
-require 'lp'
-
 module Bashly
   module Commands
     class Validate < Base
@@ -13,7 +11,7 @@ module Bashly
 
       def run
         if args['--verbose']
-          lp config
+          puts config.to_yaml
           puts '---'
         end
         validate_config

data/lib/bashly/concerns/settings_completions.rb

@@ -0,0 +1,37 @@
+module Bashly
+  module SettingsCompletions
+    COMPLETION_SHELLS = %w[bash zsh].freeze
+
+    def completions
+      @completions ||= get :completions
+    end
+
+    def completions?
+      completions == 'minimal' || completion_shells.any?
+    end
+
+    def completion_shells
+      case completions
+      when nil, false, 'minimal' then []
+      when 'full' then COMPLETION_SHELLS
+      when String then validate_completion_shells completions
+      else invalid_completions
+      end
+    end
+
+  private
+
+    def validate_completion_shells(value)
+      shells = value.split(',', -1).map(&:strip)
+      valid = shells.any? && (shells - COMPLETION_SHELLS).empty?
+      return shells if valid && shells.uniq == shells
+
+      invalid_completions
+    end
+
+    def invalid_completions
+      raise ConfigurationError,
+        "completions must be false, minimal, full, or a comma-separated list of: #{COMPLETION_SHELLS.join ', '}"
+    end
+  end
+end

data/lib/bashly/config_validator.rb

@@ -2,6 +2,8 @@ module Bashly
   class ConfigValidator
     include ValidationHelpers
 
+    COMPLETION_OPTIONS = %w[files directories no-space].freeze
+
     attr_reader :data
 
     def initialize(data)
@@ -97,7 +99,7 @@ module Bashly
       assert_array "#{key}.options", value['options'], of: :string
 
       Array(value['options']).each do |option|
-        assert %w[files directories no-space].include?(option),
+        assert COMPLETION_OPTIONS.include?(option),
           "#{key}.options contains an unknown option: #{option}"
       end
     end

data/lib/bashly/libraries/render/mandoc/render.rb

@@ -1,5 +1,6 @@
 # render script - mandoc
 require 'gtx'
+require 'shellwords'
 
 # Load the GTX template
 template = "#{source}/mandoc.gtx"
@@ -12,9 +13,12 @@ save_manpage = lambda { |command|
   save mdfile, gtx.parse(command)
 
   # The pandoc command that creates a manpage from markdown
-  cmd = %[pandoc -f markdown-smart -s --to man "#{mdfile}" > "#{manfile}"]
-  success = system cmd
-  raise "Failed running pandoc\nMake sure the following command succeeds and try again:\n\n  #{cmd}" unless success
+  command = ['pandoc', '-f', 'markdown-smart', '-s', '--to', 'man', mdfile, '-o', manfile]
+  success = system(*command)
+  unless success
+    command_string = Shellwords.join command
+    raise "Failed running pandoc\nMake sure the following command succeeds and try again:\n\n  #{command_string}"
+  end
 
   say "g`saved` #{manfile}"
 }
@@ -30,5 +34,5 @@ end
 # Show one of the files if requested
 if show
   file = "#{target}/#{show}"
-  system "man #{file}" if File.exist?(file)
+  system 'man', file if File.exist?(file)
 end

data/lib/bashly/libraries/settings/settings.yml

@@ -177,11 +177,8 @@ completions: ~
 # DEVELOPER OPTIONS
 #-------------------------------------------------------------------------------
 
-# When true, use filesystem evented watching instead of polling
-watch_evented: false
-
-# File change detection latency (seconds)
-watch_latency: 1.0
+# File change detection polling interval (seconds)
+watch_latency: 2.0
 
 
 #-------------------------------------------------------------------------------
@@ -200,5 +197,6 @@ var_aliases:
 
 # Choose different names for some of the internal functions.
 function_names:
+  start: ~
   run: ~
   initialize: ~

data/lib/bashly/library_source.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'shellwords'
 require 'tmpdir'
 
 module Bashly
@@ -34,7 +35,8 @@ module Bashly
     end
 
     def cleanup
-      FileUtils.rm_rf(File.join(Dir.tmpdir, 'bashly-libs-*'))
+      FileUtils.rm_rf @tmpdir if @tmpdir
+      @tmpdir = nil
     end
 
   private
@@ -48,11 +50,11 @@ module Bashly
     end
 
     def git_clone
-      dir = Dir.mktmpdir 'bashly-libs-'
-      safe_run "git clone --quiet #{git_specs[:url]} #{dir}"
-      safe_run %[git -C "#{dir}" checkout --quiet #{git_specs[:ref]}] if git_specs[:ref]
+      @tmpdir = Dir.mktmpdir 'bashly-libs-'
+      safe_run 'git', 'clone', '--quiet', git_specs[:url], @tmpdir
+      safe_run 'git', '-C', @tmpdir, 'checkout', '--quiet', git_specs[:ref] if git_specs[:ref]
 
-      "#{dir}#{git_specs[:path]}"
+      "#{@tmpdir}#{git_specs[:path]}"
     end
 
     def git_specs
@@ -70,8 +72,8 @@ module Bashly
       end
     end
 
-    def safe_run(cmd)
-      raise "Failed running command:\nm`#{cmd}`" unless system cmd
+    def safe_run(*command)
+      raise "Failed running command:\nm`#{Shellwords.join command}`" unless system(*command)
     end
 
     def transform_github_uri

data/lib/bashly/script/argument.rb

@@ -35,6 +35,11 @@ module Bashly
         completions&.fetch('options', []) || []
       end
 
+      def completion?
+        allowed&.any? || completion_static.any? ||
+          completion_dynamic.any? || completion_options.any?
+      end
+
       def label
         repeatable ? "#{name.upcase}..." : name.upcase
       end

data/lib/bashly/settings.rb

@@ -1,9 +1,10 @@
 module Bashly
   class Settings
-    COMPLETION_SHELLS = %w[bash zsh].freeze
+    COMPLETION_SHELLS = SettingsCompletions::COMPLETION_SHELLS
 
     class << self
       include AssetHelper
+      include SettingsCompletions
 
       attr_writer(
         :argfile_var,
@@ -32,7 +33,6 @@ module Bashly
         :target_dir,
         :usage_colors,
         :var_aliases,
-        :watch_evented,
         :watch_latency,
         :word_wrap
       )
@@ -53,28 +53,6 @@ module Bashly
         @compact_short_flags ||= get :compact_short_flags
       end
 
-      def completions
-        @completions ||= get :completions
-      end
-
-      def completions?
-        completions == 'minimal' || completion_shells.any?
-      end
-
-      def completion_shells
-        value = completions
-        return [] if value.nil? || value == false || value == 'minimal'
-        return COMPLETION_SHELLS if value == 'full'
-
-        shells = value.split(',', -1).map(&:strip) if value.is_a? String
-        valid = shells&.any? && shells.all? { |shell| COMPLETION_SHELLS.include? shell }
-        unique = shells&.uniq == shells
-        return shells if valid && unique
-
-        raise ConfigurationError,
-          "completions must be false, minimal, full, or a comma-separated list of: #{COMPLETION_SHELLS.join ', '}"
-      end
-
       def conjoined_flag_args
         @conjoined_flag_args ||= get :conjoined_flag_args
       end
@@ -206,10 +184,6 @@ module Bashly
         @var_aliases ||= get :var_aliases
       end
 
-      def watch_evented
-        @watch_evented ||= get :watch_evented
-      end
-
       def watch_latency
         @watch_latency ||= get :watch_latency
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0.rc3'
 end

data/lib/bashly/views/command/completion_argument_candidates.gtx

@@ -1,9 +1,10 @@
-if args.any?
+completion_args = args.each_with_index.select { |arg, _index| arg.completion? }
+if completion_args.any?
   > if [[ $completion_current != -* ]]; then
   >   case "$completion_arg_index" in
-  args.each_with_index do |arg, index|
+  completion_args.each do |arg, index|
     >     {{ index }})
-    = arg.render(:completion).indent 6
+    = arg.render(:completion).strip.indent 6
     >       ;;
   end
   >   esac

data/lib/bashly/views/command/master_script.gtx

@@ -13,12 +13,14 @@
 = render :initialize
 = render :run
 
-> 
+>
+= render :start
+>
 if Settings.enabled? :sourcing
   > if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
-  = render(:start).indent 2
+  >   {{ Settings.function_name :start }} "$@"
   > fi
 else
-  = render :start
+  > {{ Settings.function_name :start }} "$@"
 end
-> 
+>

data/lib/bashly/views/command/parse_requirements_while.gtx

@@ -18,6 +18,16 @@ if catch_all.enabled?
 >       break
 >       ;;
 >
+else
+>     --)
+>       shift
+>       while [[ $# -gt 0 ]]; do
+>         key="$1"
+= render(:parse_requirements_case).indent(8)
+>       done
+>       break
+>       ;;
+>
 end
 
 >     -?*)

data/lib/bashly/views/command/start.gtx

@@ -1,14 +1,14 @@
 = view_marker
 
-> command_line_args=("$@")
+> {{ Settings.function_name :start }}() {
 if Settings.completions?
-> if [[ "${command_line_args[0]:-}" == "__complete" ]]; then
->   completion_run "${command_line_args[@]:1}"
-> else
+>   if [[ ${1:-} == "__complete" ]]; then
+>     completion_run "${@:2}"
+>     return
+>   fi
+>
+end
+>   command_line_args=("$@")
 >   {{ Settings.function_name :initialize }}
 >   {{ Settings.function_name :run }} "${command_line_args[@]}"
-> fi
-else
-> {{ Settings.function_name :initialize }}
-> {{ Settings.function_name :run }} "${command_line_args[@]}"
-end
+> }

data/lib/bashly/watch.rb

@@ -1,68 +1,40 @@
-require 'listen'
+require 'watchly'
 
 module Bashly
-  # File system watcher - an ergonomic wrapper around the Listen gem
+  # File system watcher - an ergonomic wrapper around the Watchly gem
   class Watch
-    attr_reader :dirs, :options
+    attr_reader :interval, :targets
 
-    def initialize(*dirs, **options)
-      @options = default_options.merge(options).freeze
-      @dirs = dirs.empty? ? ['.'] : dirs
+    def initialize(*targets, interval: nil)
+      @targets = targets.empty? ? ['.'] : targets
+      @interval = interval || default_interval
     end
 
-    def on_change(&)
-      start(&)
-      wait
-    ensure
-      stop
-    end
-
-  private
+    def on_change
+      raise ArgumentError, 'block required' unless block_given?
 
-    def default_options
-      {
-        force_polling: force_polling?,
-        latency:       latency,
-      }
+      watcher.on_change do |changes|
+        yield normalize(changes)
+      end
+    rescue ::Interrupt => e
+      raise Bashly::Interrupt, cause: e
     end
 
-    def force_polling?
-      !Settings.watch_evented
-    end
+  private
 
-    def latency
+    def default_interval
       value = Settings.watch_latency.to_f
       value.positive? ? value : 0.1
     end
 
-    def start(&block)
-      raise ArgumentError, 'block required' unless block
-
-      @listener = build_listener(&block)
-      @listener.start
-    end
-
-    def stop
-      @listener&.stop
-      @listener = nil
-    end
-
-    def wait
-      sleep
-    rescue ::Interrupt => e
-      raise Bashly::Interrupt, cause: e
-    end
-
-    def build_listener
-      listen.to(*dirs, **options) do |modified, added, removed|
-        yield changes(modified, added, removed)
-      end
-    end
-
-    def changes(modified, added, removed)
-      { modified:, added:, removed: }
+    def normalize(changes)
+      {
+        modified: changes.modified,
+        added:    changes.added,
+        removed:  changes.removed,
+      }
     end
 
-    def listen = Listen
+    def watcher = @watcher ||= Watchly::Watcher.new(*targets, interval:)
   end
 end

data/lib/bashly.rb

@@ -12,7 +12,7 @@ module Bashly
   ]
 
   autoloads 'bashly/concerns', %i[
-    AssetHelper Renderable ValidationHelpers
+    AssetHelper Renderable SettingsCompletions ValidationHelpers
   ]
 
   module Script

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0.rc3
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,75 +38,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: lp
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: requires
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: requires
+  name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
-  name: tty-markdown
+  name: watchly
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.2.0
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -135,6 +121,7 @@ files:
 - lib/bashly/concerns/asset_helper.rb
 - lib/bashly/concerns/indentation_helper.rb
 - lib/bashly/concerns/renderable.rb
+- lib/bashly/concerns/settings_completions.rb
 - lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
 - lib/bashly/config_validator.rb
@@ -299,7 +286,7 @@ files:
 - lib/bashly/views/wrapper/header.gtx
 - lib/bashly/views/wrapper/wrapper.gtx
 - lib/bashly/watch.rb
-homepage: https://github.com/bashly-framework/bashly
+homepage: https://bashly.dev
 licenses:
 - MIT
 metadata:
@@ -322,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.19
 specification_version: 4
-summary: Bash Command Line Tool Generator
+summary: Bash command-line framework and CLI generator
 test_files: []