bashly 0.7.1 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53a5744ae1746cdd47de191ea91539ab7336aca894f583384ef0b170c03a746e
-  data.tar.gz: 0e1e9bc417d3947bcce84c3c6f44df87521dfeeae2329cc736a53816cb66cba3
+  metadata.gz: 701ac68c31b0dc916b212886b694c8aef4994aabdd703cfffe5bd592a91d1989
+  data.tar.gz: c9968bd61faf7ffc1f52e9eefc65fa54a88ee09326238618809eb66e65a17fb0
 SHA512:
-  metadata.gz: 72154aafdc3c3787b4d23a2935192a92c21b94b830d7fb01c22057ed839d30120d8a31a8962b7b075110551d034b2c971b92010e55c88a17d4e9041ecb309ad7
-  data.tar.gz: a02638101b685d5e9de575fe4537991c558c462dc030355b5e8ab6ffe4f32b8018c510afb516f51c02d4412a20c21a3703b5dc5872a0f377baa343345f045605
+  metadata.gz: dd50a1a52f24a5a7989266090827f21fa4265856d9319ab1eff288bab8e3bd2b0256efec8462387fe992f2adba175bbb50b2dd9b59e580e5b4a97f2aba9849dd
+  data.tar.gz: f40b18e9876e6297a1bcb8e14d9b364a88cb05f8db1fbaff31e3746f96961db581dbda6bd33a5a9147767c62afaab7caf7541fdde02167403d17ef4ec48933ff

data/lib/bashly/commands/generate.rb

@@ -1,8 +1,6 @@
 module Bashly
   module Commands
     class Generate < Base
-      using ComposeRefinements
-
       help "Generate the bash script and required files"
 
       usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
@@ -82,7 +80,7 @@ module Bashly
       end
 
       def create_root_command_file
-        create_file "#{Settings.source_dir}/root_command.sh", command.render(:default_root_script)
+        create_file "#{Settings.source_dir}/#{command.filename}", command.render(:default_root_script)
       end
 
       def create_all_command_files
@@ -98,7 +96,7 @@ module Bashly
         if File.exist? file and !args['--force']
           quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
         else
-          File.write file, content
+          File.deep_write file, content
           quiet_say "!txtgrn!created!txtrst! #{file}"
         end
       end
@@ -118,7 +116,7 @@ module Bashly
       end
 
       def config
-        @config ||= Config.new("#{Settings.source_dir}/bashly.yml").compose
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
       end
 
       def command

data/lib/bashly/concerns/command_scopes.rb

@@ -0,0 +1,68 @@
+module Bashly
+  # This is a `Command` concern responsible for providing additional scopes.
+  module CommandScopes
+    # Returns only the names of the Commands
+    def command_names
+      commands.map &:name
+    end
+
+    # Returns a flat array containing all the commands in this tree.
+    # This includes self + children + grandchildres + ...
+    def deep_commands
+      result = []
+      commands.each do |command|
+        result << command
+        if command.commands.any?
+          result += command.deep_commands
+        end
+      end
+      result
+    end
+
+    # If any of this command's subcommands has the default option set to
+    # true, this default command will be returned, nil otherwise.
+    def default_command
+      commands.find { |c| c.default }
+    end
+
+    # Returns an array of all the default Args
+    def default_args
+      args.select &:default
+    end
+
+    # Returns an array of all the default Environment Variables
+    def default_environment_variables
+      environment_variables.select &:default
+    end
+
+    # Returns an array of all the default Flags
+    def default_flags
+      flags.select &:default
+    end
+
+    # Returns an array of all the required Arguments
+    def required_args
+      args.select &:required
+    end
+
+    # Returns an array of all the required EnvironmentVariables
+    def required_environment_variables
+      environment_variables.select &:required
+    end
+
+    # Returns an array of all the required Flags
+    def required_flags
+      flags.select &:required
+    end
+
+    # Returns an array of all the args with a whitelist
+    def whitelisted_args
+      args.select &:allowed
+    end
+
+    # Returns an array of all the flags with a whitelist arg
+    def whitelisted_flags
+      flags.select &:allowed
+    end
+  end
+end

data/lib/bashly/config.rb

@@ -4,11 +4,13 @@ module Bashly
   # A convenience class to use either a hash or a filename as a configuration
   # source
   class Config
+    using ComposeRefinements
+
     attr_reader :config
 
     def self.new(config)
       if config.is_a? String
-        YAML.load_file config
+        YAML.load_file(config).compose
       else
         config
       end

data/lib/bashly/config_validator.rb

@@ -81,6 +81,8 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       
       assert_array "#{key}.allowed", value['allowed'], of: :string
+
+      refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
     end
 
     def assert_flag(key, value)
@@ -96,6 +98,10 @@ module Bashly
       
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
+
+      assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
+      assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
+      refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
     end
 
     def assert_env_var(key, value)
@@ -117,6 +123,7 @@ module Bashly
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
+      assert_optional_string "#{key}.filename", value['filename']
 
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
@@ -128,6 +135,7 @@ module Bashly
       assert_array "#{key}.commands", value['commands'], of: :command
       assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.dependencies", value['dependencies'], of: :string
+      assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
     end

data/lib/bashly/libraries/completions.rb

@@ -7,7 +7,7 @@ module Bashly
       end
 
       def config
-        @config ||= Bashly::Config.new "#{Settings.source_dir}/bashly.yml"
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
       end
     end
   end

data/lib/bashly/script/base.rb

@@ -16,6 +16,7 @@ module Bashly
         environment_variables
         examples
         extensible
+        filters
         flags
         footer
         group
@@ -53,9 +54,9 @@ module Bashly
         respond_to?(method_name) ? options[key] : super
       end
 
-      def respond_to?(method_name, include_private = false)
+      def respond_to_missing?(method_name, include_private = false)
         OPTION_KEYS.include?(method_name) || super
       end
     end
   end
-end
+end

data/lib/bashly/script/catch_all.rb

@@ -0,0 +1,49 @@
+module Bashly
+  module Script
+    class CatchAll
+      class << self
+        def from_config(config)
+          options = case config
+          when nil
+            { enabled: false }
+          when String
+            { label: config }
+          when Hash
+            { label: config['label'], help: config['help'], required: config['required'] }
+          else
+            {}
+          end
+
+          new **options
+        end
+      end
+
+      def initialize(label: nil, help: nil, required: false, enabled: true)
+        @label, @help, @required, @enabled = label, help, required, enabled
+      end
+
+      def enabled?
+        @enabled
+      end
+
+      def label
+        enabled? ? "#{@label&.upcase}..." : nil
+      end
+
+      def help
+        enabled? ? @help : nil
+      end
+
+      def required?
+        @required
+      end
+
+      def usage_string
+        return nil unless enabled?
+        required? ? label : "[#{label}]"
+      end
+
+    end
+  end
+end
+

data/lib/bashly/script/command.rb

@@ -2,6 +2,7 @@ module Bashly
   module Script
     class Command < Base
       include Completions
+      include CommandScopes
 
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
@@ -30,41 +31,8 @@ module Bashly
         help ? "#{full_name} - #{summary}" : full_name
       end
 
-      # Returns a label for the catch_all directive
-      def catch_all_label
-        case catch_all
-        when nil then nil
-        when String then "#{catch_all.upcase}..."
-        when Hash then "#{catch_all['label'].upcase}..."
-        else "..."
-        end
-      end
-
-      # Returns a user defined help string for the catch_all directive
-      def catch_all_help
-        return nil unless catch_all
-
-        if catch_all.is_a?(Hash) and catch_all['help'].is_a?(String)
-          catch_all['help']
-        else
-          nil
-        end
-      end
-
-      # Returns true if catch_all is required
-      def catch_all_required?
-        catch_all.is_a?(Hash) and catch_all['required']
-      end
-
-      # Returns a string suitable for catch_all Usage pattern
-      def catch_all_usage
-        return nil unless catch_all
-        catch_all_required? ? catch_all_label : "[#{catch_all_label}]"
-      end
-
-      # Returns only the names of the Commands
-      def command_names
-        commands.map &:name
+      def catch_all
+        @catch_all ||= CatchAll.from_config options['catch_all']
       end
 
       # Returns an array of the Commands
@@ -76,40 +44,6 @@ module Bashly
         end
       end
 
-      # Returns a flat array containing all the commands in this tree.
-      # This includes self + children + grandchildres + ...
-      def deep_commands
-        result = []
-        commands.each do |command|
-          result << command
-          if command.commands.any?
-            result += command.deep_commands
-          end
-        end
-        result
-      end
-
-      # Returns an array of all the default Args
-      def default_args
-        args.select &:default
-      end
-
-      # If any of this command's subcommands has the default option set to
-      # true, this default command will be returned, nil otherwise.
-      def default_command
-        commands.find { |c| c.default }
-      end
-
-      # Returns an array of all the default Environment Variables
-      def default_environment_variables
-        environment_variables.select &:default
-      end
-
-      # Returns an array of all the default Flags
-      def default_flags
-        flags.select &:default
-      end
-
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]
@@ -121,7 +55,7 @@ module Bashly
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        "#{action_name.to_underscore}_command.sh"
+        options["filename"] || "#{action_name.to_underscore}_command.sh"
       end
 
       # Returns an array of Flags
@@ -165,21 +99,6 @@ module Bashly
         options['parents'] || []
       end
 
-      # Returns an array of all the required Arguments
-      def required_args
-        args.select &:required
-      end
-
-      # Returns an array of all the required EnvironmentVariables
-      def required_environment_variables
-        environment_variables.select &:required
-      end
-
-      # Returns an array of all the required Flags
-      def required_flags
-        flags.select &:required
-      end
-
       # Returns trus if this is the root command (no parents)
       def root_command?
         parents.empty?
@@ -198,7 +117,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
-        result << catch_all_usage if catch_all
+        result << catch_all.usage_string if catch_all.enabled?
         result.join " "
       end
 
@@ -215,16 +134,6 @@ module Bashly
         Bashly::ConfigValidator.new(options).validate
       end
 
-      # Returns an array of all the args with a whitelist
-      def whitelisted_args
-        args.select &:allowed
-      end
-
-      # Returns an array of all the flags with a whitelist arg
-      def whitelisted_flags
-        flags.select &:allowed
-      end
-
     end
   end
 end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.1"
+  VERSION = "0.7.5"
 end

data/lib/bashly/views/command/catch_all_filter.erb

@@ -1,7 +1,7 @@
 # :command.catch_all_filter
-% if catch_all_required?
+% if catch_all.required?
 if [[ ${#other_args[@]} -eq 0 ]]; then
-  printf "<%= strings[:missing_required_argument] % { arg: catch_all_label, usage: usage_string } %>\n"
+  printf "<%= strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } %>\n"
   exit 1
 fi
 % end

data/lib/bashly/views/command/default_root_script.erb

@@ -1,3 +1,3 @@
-echo "# this file is located in '<%= Settings.source_dir %>/root_command.sh'"
+echo "# this file is located in '<%= "#{Settings.source_dir}/#{filename}" %>'"
 echo "# you can edit it freely and regenerate (it will not be overwritten)"
 inspect_args

data/lib/bashly/views/command/parse_requirements.erb

@@ -7,6 +7,7 @@ parse_requirements() {
 <%= render(:fixed_flags_filter).indent 2 %>
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
+<%= render(:user_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>

data/lib/bashly/views/command/parse_requirements_case.erb

@@ -9,7 +9,7 @@
 % condition = "elif"
 % end
 else
-% if catch_all
+% if catch_all.enabled?
   other_args+=("$1")
   shift
 % else
@@ -17,7 +17,7 @@ else
   exit 1
 % end
 fi
-% elsif catch_all
+% elsif catch_all.enabled?
   other_args+=("$1")
   shift
 % else

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

@@ -7,8 +7,8 @@ while [[ $# -gt 0 ]]; do
 
 % end
 
-  -* )
-% if catch_all
+  -?* )
+% if catch_all.enabled?
     other_args+=("$1")
     shift
     ;;

data/lib/bashly/views/command/root_command.erb

@@ -1,4 +1,4 @@
 # :command.root_command
 root_command() {
-<%= load_user_file("root_command.sh").indent 2 %>
+<%= load_user_file(filename).indent 2 %>
 }

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

@@ -37,7 +37,7 @@
     printf "<%= strings[:options] %>\n"
 <%= render(:usage_fixed_flags).indent 4 %>
 <%= render(:usage_flags).indent 4 if flags.any? %>
-<%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
+<%= render(:usage_args).indent 4 if args.any? or catch_all.help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
 <%= render(:footer).indent 4 if footer %>

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

@@ -6,9 +6,9 @@ printf "<%= strings[:arguments] %>\n"
 <%= arg.render(:usage) %>
 % end
 % end
-% if catch_all_help
+% if catch_all.help
 
-echo "  <%= catch_all_label %>"
-printf "<%= catch_all_help.wrap(76).indent(4).sanitize_for_print %>\n"
+echo "  <%= catch_all.label %>"
+printf "<%= catch_all.help.wrap(76).indent(4).sanitize_for_print %>\n"
 echo
 % end

data/lib/bashly/views/command/user_filter.erb

@@ -0,0 +1,11 @@
+# :command.user_filter
+% if filters
+% filters.each do |filter|
+filter_error=$(filter_<%= filter %>)
+if [[ -n $filter_error ]]; then
+  echo "$filter_error"
+  exit 1
+fi
+
+% end
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - lib/bashly/commands/preview.rb
 - lib/bashly/commands/validate.rb
 - lib/bashly/concerns/asset_helper.rb
+- lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/config.rb
@@ -103,6 +104,7 @@ files:
 - lib/bashly/refinements/compose_refinements.rb
 - lib/bashly/script/argument.rb
 - lib/bashly/script/base.rb
+- lib/bashly/script/catch_all.rb
 - lib/bashly/script/command.rb
 - lib/bashly/script/environment_variable.rb
 - lib/bashly/script/flag.rb
@@ -153,6 +155,7 @@ files:
 - lib/bashly/views/command/usage_examples.erb
 - lib/bashly/views/command/usage_fixed_flags.erb
 - lib/bashly/views/command/usage_flags.erb
+- lib/bashly/views/command/user_filter.erb
 - lib/bashly/views/command/user_lib.erb
 - lib/bashly/views/command/version_command.erb
 - lib/bashly/views/command/whitelist_filter.erb
@@ -186,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator