bashly 0.9.4 → 1.0.0.rc1

data/lib/bashly/libraries/{help.rb → help/help.rb}

@@ -16,12 +16,12 @@ module Bashly
         <<~MESSAGE
           Add this as a command to your bashly.yml:
 
-            !txtgrn!commands:
-              !txtgrn!- name: !txtpur!help
-              !txtgrn!  help: !txtpur!Show help about a command
-              !txtgrn!  args:
-                !txtgrn!- name: !txtpur!command
-                !txtgrn!  help: !txtpur!Help subject
+            g`commands`:
+              g`- name`: m`help`
+              g`  help`: m`Show help about a command`
+              g`  args`:
+                g`- name`: m`command`
+                g`  help`: m`Help subject`
 
         MESSAGE
       end
@@ -29,7 +29,7 @@ module Bashly
     private
 
       def help_command
-        asset_content('templates/help/help_command.sh') % { name: command.name }
+        asset_content('libraries/help/help_command.sh') % { name: command.name }
       end
     end
   end

data/lib/bashly/libraries/libraries.yml

@@ -0,0 +1,85 @@
+colors:
+  help: Add standard functions for printing colorful and formatted text to the lib directory.
+  files:
+    - source: "colors/colors.sh"
+      target: "%{user_lib_dir}/colors.%{user_ext}"
+
+completions: 
+  help: Generate a bash completions function.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsFunction
+
+completions_script:
+  help: Generate a standalone bash completions script.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsScript
+
+completions_yaml:
+  help: Generate a completions YAML configuration for Completely.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsYAML
+
+config:
+  help: Add standard functions for handling INI files to the lib directory.
+  files:
+    - source: "config/config.sh"
+      target: "%{user_lib_dir}/config.%{user_ext}"
+
+help:
+  help: Add a help command, in addition to the standard --help flag.
+  handler: Bashly::Libraries::Help
+
+lib:
+  help: |-
+    Create the lib directory for any additional user scripts.
+    All *.sh scripts in this directory will be included in the final bash script.
+    Note that if you configured a different partials_extension, then the extensions of the files in this directory need to match.
+  files:
+    - source: "lib/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.%{user_ext}"
+
+settings:
+  help: Copy a sample settings.yml file to your project, allowing you to customize some bashly options.
+  skip_src_check: true
+  files:
+    - source: "settings/settings.yml"
+      target: "settings.yml"
+
+strings:
+  help: Copy an additional configuration file to your project, allowing you to customize all the tips and error strings.
+  files:
+    - source: "strings/strings.yml"
+      target: "%{user_source_dir}/bashly-strings.yml"
+
+test:
+  help: Add approval testing.
+  files:
+    - source: "test/approvals.bash"
+      target: "%{user_target_dir}/test/approvals.bash"
+    - source: "test/approve"
+      target: "%{user_target_dir}/test/approve"
+
+  post_install_message: |
+    Edit your tests in g`test/approve` and then run:
+
+      m`$ test/approve`
+
+    Docs: bu`https://github.com/DannyBen/approvals.bash`
+
+validations:
+  help: Add argument validation functions to the lib directory.
+  files:
+    - source: "validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
+    - source: "validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.%{user_ext}"
+    - source: "validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.%{user_ext}"
+    - source: "validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
+
+yaml:
+  help: Add standard functions for reading YAML files.
+  files:
+    - source: "yaml/yaml.sh"
+      target: "%{user_lib_dir}/yaml.%{user_ext}"

data/lib/bashly/{templates → libraries/settings}/settings.yml

@@ -5,10 +5,16 @@
 # When setting environment variables, you can use:
 # - "0", "false" or "no" to represent false
 # - "1", "true" or "yes" to represent true
+#
+# If you wish to change the path to this file, set the environment variable
+# BASHLY_SETTINGS_PATH.
 
-# The path containing the bashly configuration and source files
+# The path containing the bashly source files
 source_dir: src
 
+# Tha path to bashly.yml
+config_path: "%{source_dir}/bashly.yml"
+
 # The path to use for creating the bash script
 target_dir: .
 

data/lib/bashly/library.rb

@@ -1,25 +1,12 @@
 module Bashly
   class Library
-    class << self
-      def exist?(name)
-        config.has_key? name.to_s
-      end
-
-      def config
-        @config ||= YAML.properly_load_file config_path
-      end
-
-      def config_path
-        @config_path ||= File.expand_path 'libraries.yml', __dir__
-      end
-    end
-
-    include AssetHelper
-    attr_reader :name, :args
+    attr_reader :path, :config, :upgrade_string
+    attr_accessor :args
 
-    def initialize(name, *args)
-      @name = name.to_s
-      @args = args
+    def initialize(path, config, upgrade_string: nil)
+      @path = path.to_s
+      @config = config
+      @upgrade_string = upgrade_string
     end
 
     def files
@@ -28,8 +15,10 @@ module Bashly
 
       else
         config['files'].map do |file|
-          { path:    file['target'] % target_file_args,
-            content: asset_content(file['source']) }
+          {
+            path:    file['target'] % target_file_args,
+            content: file_contents("#{path}/#{file['source']}"),
+          }
         end
       end
     end
@@ -49,13 +38,13 @@ module Bashly
   private
 
     def custom_handler
-      return nil unless config.is_a? Symbol
+      return nil unless config['handler']
 
-      @custom_handler ||= Bashly::Libraries.const_get(config).new(*args)
+      @custom_handler ||= Module.const_get(config['handler']).new(*args)
     end
 
-    def config
-      @config ||= self.class.config[name]
+    def file_contents(path)
+      File.read(path).sub('[@bashly-upgrade]', "[@bashly-upgrade #{upgrade_string}]")
     end
 
     def target_file_args

data/lib/bashly/library_source.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+
+module Bashly
+  class LibrarySource
+    attr_reader :uri
+
+    def initialize(uri = nil)
+      @uri = uri || File.expand_path('libraries', __dir__)
+      transform_github_uri if /^github(:|-)/.match? @uri
+    end
+
+    def git?
+      /^(git|github|github-ssh):/.match? uri
+    end
+
+    def config
+      @config ||= YAML.properly_load_file config_path
+    end
+
+    def libraries
+      config.to_h do |name, spec|
+        upgrade_string = "#{uri};#{name}"
+        [name.to_sym, Library.new(path, spec, upgrade_string: upgrade_string)]
+      end
+    end
+
+    def config_path
+      @config_path ||= if File.exist?("#{path}/libraries.yml")
+        "#{path}/libraries.yml"
+      else
+        raise "Cannot find #{path}/libraries.yml"
+      end
+    end
+
+    def cleanup
+      FileUtils.rm_rf(File.join(Dir.tmpdir, 'bashly-libs-*'))
+    end
+
+  private
+
+    def path
+      @path ||= if uri.start_with? 'git:'
+        git_clone
+      else
+        uri
+      end
+    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]
+
+      "#{dir}#{git_specs[:path]}"
+    end
+
+    def git_specs
+      @git_specs ||= begin
+        parts = uri.match(%r{git:(?<url>.*\.git)(?:/)?(?<path>/[^@]+)?@?(?<ref>.*)})
+        raise 'Invalid source' unless parts
+
+        url = parts[:url]
+        raise 'Invalid git URL' unless url
+
+        path = parts[:path]
+        ref = parts[:ref].empty? ? nil : parts[:ref]
+
+        { url: url, path: path, ref: ref }
+      end
+    end
+
+    def safe_run(cmd)
+      raise "Failed running command:\nm`#{cmd}`" unless system cmd
+    end
+
+    def transform_github_uri
+      if (matches = uri.match(%r{github-ssh:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:git@github.com:#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      elsif (matches = uri.match(%r{github:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:https://github.com/#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      end
+    end
+  end
+end

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.properly_load_file asset('templates/strings.yml')
+      defaults = YAML.properly_load_file asset('libraries/strings/strings.yml')
       defaults.merge project_strings
     end
 

data/lib/bashly/refinements/compose_refinements.rb

@@ -25,9 +25,9 @@ module ComposeRefinements
       loaded = YAML.properly_load_file path
       return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
 
-      raise Bashly::ConfigurationError, "Cannot find a valid YAML in !txtgrn!#{path}"
+      raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"
     rescue Errno::ENOENT
-      raise Bashly::ConfigurationError, "Cannot find import file !txtgrn!#{path}"
+      raise Bashly::ConfigurationError, "Cannot find import file g`#{path}`"
     end
   end
 

data/lib/bashly/script/command.rb

@@ -11,9 +11,7 @@ module Bashly
             extensible expose filename filters flags
             footer function group help name
             private version
-            short
           ]
-          # DEPRECATION 0.8.0
         end
       end
 
@@ -36,8 +34,6 @@ module Bashly
 
       # Returns an array of alternative aliases if any
       def alt
-        # DEPRECATION 0.8.0
-        options['alias'] ||= options['short']
         return [] unless options['alias']
 
         options['alias'].is_a?(String) ? [options['alias']] : options['alias']
@@ -217,6 +213,16 @@ module Bashly
         commands.reject(&:private)
       end
 
+      # Returns only environment variables that are not private
+      def public_environment_variables
+        environment_variables.reject(&:private)
+      end
+
+      # Returns only flags that are not private
+      def public_flags
+        flags.reject(&:private)
+      end
+
       # Returns true if one of the args is repeatable
       def repeatable_arg_exist?
         args.select(&:repeatable).any?

data/lib/bashly/script/flag.rb

@@ -7,7 +7,7 @@ module Bashly
         def option_keys
           @option_keys ||= %i[
             allowed arg completions conflicts default help long repeatable
-            required short validate
+            required short validate private
           ]
         end
       end

data/lib/bashly/settings.rb

@@ -3,13 +3,26 @@ module Bashly
     class << self
       include AssetHelper
 
-      attr_writer :compact_short_flags, :lib_dir, :partials_extension,
-        :source_dir, :strict, :tab_indent, :target_dir, :usage_colors
+      attr_writer(
+        :compact_short_flags,
+        :config_path,
+        :lib_dir,
+        :partials_extension,
+        :source_dir,
+        :strict,
+        :tab_indent,
+        :target_dir,
+        :usage_colors
+      )
 
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
       end
 
+      def config_path
+        @config_path ||= get(:config_path) % { source_dir: source_dir }
+      end
+
       def env
         @env ||= get(:env)&.to_sym
       end
@@ -74,7 +87,11 @@ module Bashly
       end
 
       def user_settings
-        @user_settings ||= File.exist?('settings.yml') ? Config.new('settings.yml') : {}
+        @user_settings ||= File.exist?(user_settings_path) ? Config.new(user_settings_path) : {}
+      end
+
+      def user_settings_path
+        ENV['BASHLY_SETTINGS_PATH'] || 'settings.yml'
       end
 
       def defsult_settings
@@ -82,7 +99,7 @@ module Bashly
       end
 
       def default_settings_path
-        asset 'templates/settings.yml'
+        asset 'libraries/settings/settings.yml'
       end
     end
   end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '0.9.4'
+  VERSION = '1.0.0.rc1'
 end

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

@@ -3,10 +3,10 @@
 > if [[ -n $long_usage ]]; then
 >   printf "%s\n" "{{ strings[:options].color(:caption) }}"
 >
+= render(:usage_flags).indent 2 if public_flags.any?
 = render(:usage_fixed_flags).indent 2
-= render(:usage_flags).indent 2 if flags.any?
 = render(:usage_args).indent 2 if args.any? or catch_all.help
-= render(:usage_environment_variables).indent 2 if environment_variables.any?
+= render(:usage_environment_variables).indent 2 if public_environment_variables.any?
 = render(:usage_examples).indent 2 if examples
 = render(:footer).indent 2 if footer
 >

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

@@ -3,7 +3,7 @@
 > printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
 > 
 
-environment_variables.reject(&:private).each do |env_var|
+public_environment_variables.each do |env_var|
   = env_var.render :usage
 end
 

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

@@ -1,6 +1,6 @@
 = view_marker
 
-flags.each do |flag|
+public_flags.each do |flag|
   = flag.render :usage
 end
 

metadata

@@ -1,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: completely
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: gtx
+  name: completely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +138,6 @@ files:
 - lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
 - lib/bashly/config_validator.rb
-- lib/bashly/deprecation.rb
 - lib/bashly/docs/arg.yml
 - lib/bashly/docs/command.yml
 - lib/bashly/docs/env.yml
@@ -142,13 +147,27 @@ files:
 - lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
 - lib/bashly/extensions/yaml.rb
-- lib/bashly/libraries.yml
 - lib/bashly/libraries/base.rb
-- lib/bashly/libraries/completions_function.rb
-- lib/bashly/libraries/completions_script.rb
-- lib/bashly/libraries/completions_yaml.rb
-- lib/bashly/libraries/help.rb
+- lib/bashly/libraries/colors/colors.sh
+- lib/bashly/libraries/completions/completions_function.rb
+- lib/bashly/libraries/completions/completions_script.rb
+- lib/bashly/libraries/completions/completions_yaml.rb
+- lib/bashly/libraries/config/config.sh
+- lib/bashly/libraries/help/help.rb
+- lib/bashly/libraries/help/help_command.sh
+- lib/bashly/libraries/lib/sample_function.sh
+- lib/bashly/libraries/libraries.yml
+- lib/bashly/libraries/settings/settings.yml
+- lib/bashly/libraries/strings/strings.yml
+- lib/bashly/libraries/test/approvals.bash
+- lib/bashly/libraries/test/approve
+- lib/bashly/libraries/validations/validate_dir_exists.sh
+- lib/bashly/libraries/validations/validate_file_exists.sh
+- lib/bashly/libraries/validations/validate_integer.sh
+- lib/bashly/libraries/validations/validate_not_empty.sh
+- lib/bashly/libraries/yaml/yaml.sh
 - lib/bashly/library.rb
+- lib/bashly/library_source.rb
 - lib/bashly/message_strings.rb
 - lib/bashly/refinements/compose_refinements.rb
 - lib/bashly/script/argument.rb
@@ -160,20 +179,7 @@ files:
 - lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
-- lib/bashly/templates/help/help_command.sh
-- lib/bashly/templates/lib/colors.sh
-- lib/bashly/templates/lib/config.sh
-- lib/bashly/templates/lib/sample_function.sh
-- lib/bashly/templates/lib/validations/validate_dir_exists.sh
-- lib/bashly/templates/lib/validations/validate_file_exists.sh
-- lib/bashly/templates/lib/validations/validate_integer.sh
-- lib/bashly/templates/lib/validations/validate_not_empty.sh
-- lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
-- lib/bashly/templates/settings.yml
-- lib/bashly/templates/strings.yml
-- lib/bashly/templates/test/approvals.bash
-- lib/bashly/templates/test/approve
 - lib/bashly/version.rb
 - lib/bashly/views/README.md
 - lib/bashly/views/argument/usage.gtx
@@ -248,11 +254,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.0
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/deprecation.rb

@@ -1,27 +0,0 @@
-module Bashly
-  class Deprecation
-    attr_reader :old, :replacement, :reference
-
-    def initialize(old, replacement: nil, reference: nil)
-      @old = old
-      @replacement = replacement
-      @reference = reference
-    end
-
-    def message
-      result = ['Deprecation Warning:', "!txtred!#{old}!txtrst! is deprecated"]
-      result.push "use !txtgrn!#{replacement}!txtrst! instead" if replacement
-      result.push "see !undblu!#{reference}!txtrst!" if reference
-
-      result.map { |line| "!txtred!▐!txtrst! #{line}" }.join("\n")
-    end
-
-    def to_h
-      {
-        old:         old,
-        replacement: replacement,
-        reference:   reference,
-      }
-    end
-  end
-end