bashly 1.3.4 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc29835d6181be972a508c311ad9554e9f57a8ad705804690ed4cb6aa98c6ab7
-  data.tar.gz: 7f052f8027e16e8b3fcc684349aa784342c734e7e6381d0ff0032ec0b2a3da2c
+  metadata.gz: c216518e1752d66966dfa1b8efad9a24afb5d55119a350ac9ad460abea748be0
+  data.tar.gz: 8626f99cfc41d424363969bbe46474fc86f8998f44c17d8196c03044281fbf6e
 SHA512:
-  metadata.gz: c019868212b40635d602a9e9c2f5bee24bb6cc5b6b78e748a37cb912cff799f932bbb365178f6b74354e8012d54e4e61bb86e47b01793fd340a5fe8a35f17eb2
-  data.tar.gz: 7b4fd782e6e1e3a180a10c947581d9252db38da47a652afc3687d651ebf0eb0aa4a35d6ec0827ff6083d0f6cb935cd9aab9deb90bd2c1bbe411bc11493fd2cf0
+  metadata.gz: 7b49310fec1d05dcf12504a8be34493d4e6d8af7ef9b2e35ea57da6424ca0820ee6abb7145ea54835ac31778db0ff89e6c6999050133f5851545ac67dc7f5b6c
+  data.tar.gz: 0b443ed8497671ff9faf2c720961d3344a5bbfb670096c9a74388cb54541f782b4316a198e4b2dfc7ed17b45a83991df2894ce05f3d76f943f694a63aa090bb2

data/lib/bashly/commands/generate.rb

@@ -1,5 +1,3 @@
-require 'filewatcher'
-
 module Bashly
   module Commands
     class Generate < Base
@@ -41,7 +39,7 @@ module Bashly
       def watch
         quiet_say "g`watching` #{Settings.source_dir}\n"
 
-        Filewatcher.new([Settings.source_dir]).watch do
+        Watch.new(Settings.source_dir).on_change do
           reset
           generate
         rescue Bashly::ConfigurationError => e

data/lib/bashly/commands/render.rb

@@ -1,4 +1,3 @@
-require 'filewatcher'
 require 'tty-markdown'
 
 module Bashly
@@ -75,7 +74,7 @@ module Bashly
       def watch
         say "g`watching`\n"
 
-        Filewatcher.new(watchables).watch do
+        Watch.new(*watchables).on_change do
           render
           say "g`waiting`\n"
         end

data/lib/bashly/concerns/renderable.rb

@@ -51,6 +51,13 @@ module Bashly
       File.exist? user_file_path(file)
     end
 
+    # Returns a wrapped, indented and sanitized string
+    # Designed to place help and example messages inside bash's 'printf'
+    def user_string(text, indent: 0)
+      wrap = Settings.word_wrap - indent
+      text.wrap(wrap).indent(indent).sanitize_for_print
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/extensions/string.rb

@@ -33,7 +33,7 @@ class String
     tr(' ', '/').downcase
   end
 
-  def wrap(length = 80)
+  def wrap(length)
     strip!
     split("\n").collect! do |line|
       if line.length > length

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

@@ -84,6 +84,9 @@ strict: false
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+# Set the character width used to wrap help and example messages
+word_wrap: 80
+
 # Choose a post-processor for the generated script:
 # formatter: internal     # Use Bashly’s built-in formatter (removes extra newlines)
 # formatter: external     # Run the external command `shfmt --case-indent --indent 2`

data/lib/bashly/settings.rb

@@ -27,7 +27,8 @@ module Bashly
         :tab_indent,
         :target_dir,
         :usage_colors,
-        :var_aliases
+        :var_aliases,
+        :word_wrap
       )
 
       def commands_dir
@@ -173,6 +174,10 @@ module Bashly
         @var_aliases ||= get :var_aliases
       end
 
+      def word_wrap
+        @word_wrap ||= get :word_wrap
+      end
+
     private
 
       def get(key)

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.3.4'
+  VERSION = '1.3.6'
 end

data/lib/bashly/views/argument/usage.gtx

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ label.color(:arg) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

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

@@ -3,6 +3,6 @@ if Settings.show_examples_on_error && examples
 
   > printf "{{ strings[:examples_caption_on_error] }}\n" >&2
   examples.each do |example|
-    > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n" >&2
+    > printf "{{ user_string example, indent: 2 }}\n" >&2
   end
 end

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

@@ -6,8 +6,8 @@
 
 if root_command?
   > 
-  = render(:variables).indent(2)
   = render(:environment_variables_default).indent 2
+  = render(:variables).indent(2)
 end
 
 if user_file_exist?('initialize')

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

@@ -9,7 +9,7 @@ else
     = help_header_override.indent 4
   else
     >     printf "{{ full_name }}\n\n"
-    >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n\n"
+    >     printf "{{ user_string help, indent: 2 }}\n\n"
   end
   >   else
   >     printf "{{ caption_string.sanitize_for_print }}\n\n"

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

@@ -12,7 +12,7 @@ end
 if catch_all.help
   >
   > echo "  {{ catch_all.label }}"
-  > printf "{{ catch_all.help.wrap(76).indent(4).sanitize_for_print }}\n"
+  > printf "{{ user_string catch_all.help, indent: 4 }}\n"
   > echo
 end
 

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

@@ -3,7 +3,7 @@
 > printf "%s\n" "{{ strings[:examples].color(:caption) }}"
 
 examples.each do |example|
-  > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n"
+  > printf "{{ user_string example, indent: 2 }}\n"
 end
 
 > echo

data/lib/bashly/views/environment_variable/usage.gtx

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ usage_string(extended: true).color(:environment_variable) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

data/lib/bashly/views/flag/usage.gtx

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ usage_string(extended: true).color(:flag) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

data/lib/bashly/watch.rb

@@ -0,0 +1,57 @@
+require 'listen'
+
+module Bashly
+  # File system watcher - an ergonomic wrapper around the Listen gem
+  class Watch
+    attr_reader :dirs, :options
+
+    DEFAULT_OPTIONS = {
+      force_polling: true,
+      latency:       1.0,
+    }.freeze
+
+    def initialize(*dirs, **options)
+      @options = DEFAULT_OPTIONS.merge(options).freeze
+      @dirs = dirs.empty? ? ['.'] : dirs
+    end
+
+    def on_change(&)
+      start(&)
+      wait
+    ensure
+      stop
+    end
+
+  private
+
+    def build_listener
+      listen.to(*dirs, **options) do |modified, added, removed|
+        yield changes(modified, added, removed)
+      end
+    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 changes(modified, added, removed)
+      { modified:, added:, removed: }
+    end
+
+    def wait
+      sleep
+    rescue ::Interrupt => e
+      raise Bashly::Interrupt, cause: e
+    end
+
+    def listen = Listen
+  end
+end

data/lib/bashly.rb

@@ -12,7 +12,7 @@ module Bashly
 
   autoloads 'bashly', %i[
     CLI Config ConfigValidator Library LibrarySource LibrarySourceConfig
-    MessageStrings RenderContext RenderSource Settings VERSION
+    MessageStrings RenderContext RenderSource Settings VERSION Watch
   ]
 
   autoloads 'bashly/concerns', %i[

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,33 +38,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: filewatcher
+  name: gtx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: gtx
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
@@ -125,42 +125,16 @@ dependencies:
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.7'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -336,6 +310,7 @@ files:
 - lib/bashly/views/wrapper/bash3_bouncer.gtx
 - lib/bashly/views/wrapper/header.gtx
 - lib/bashly/views/wrapper/wrapper.gtx
+- lib/bashly/watch.rb
 homepage: https://github.com/bashly-framework/bashly
 licenses:
 - MIT
@@ -359,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Bash Command Line Tool Generator
 test_files: []