bashly 0.7.10 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471a0ae8e462a056c196ebf128f02f3f30ff3a100c10aff2d2c010757d6d942e
-  data.tar.gz: d78cf8473f40b241ee412a00d819be124a244acda1f487f20e105dee1cba9842
+  metadata.gz: d3d0126229189987753e653a635054113961b1e9e0244d4cdb956beb1d5aff94
+  data.tar.gz: 886987a65edc65d16d2134589cbb4ee9f3fcb9e0b1819c8a87211bcd2d164d0c
 SHA512:
-  metadata.gz: 77617bc6668796730c67d33621d497a8a454a6208d7f42d7c28ecb26e940da2e4edee6b3aefd8fc98b301d8480a13f14c1f6b292ff7f4d29b6030e601cdc1b08
-  data.tar.gz: d7b851826c9dde19201f2fb48b5f4b5ff0cd9a2421f4770ed3fdbc1c340943b9d0c3b3703b26646e46dfb012dca0c2a10728c568786ac4c381ab1431dc191695
+  metadata.gz: 880579e8bb650c8835cc7992054f3f4dd3e765ddc1b7072f83ed6fc9049d4b56b38c4a64220c3dd154f8fdbf199462cca1ef955d36d465a0d57ecc00715bd85e
+  data.tar.gz: efa2f73f9eed6d5ba1ebb432e37ef639e618bc1556ba83059ccad4804b6568b407d86f91fe11faa3335b69103e368fdb9bf1339f90af1fd15cb742b91163b911

data/lib/bashly/commands/base.rb

@@ -6,10 +6,28 @@ module Bashly
     class Base < MisterBin::Command
       include AssetHelper
 
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def config_validator
+        @config_validator ||= ConfigValidator.new config
+      end
+
       def validate_config
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        config_validator.validate
+      end
+
+      def with_valid_config
+        validate_config
+        yield
+        show_deprecations
+      end
+
+      def show_deprecations
+        return if config_validator.deprecations.empty? or ENV['BASHLY_HIDE_DEPRECATIONS']
+        messages = "\n" + config_validator.deprecations.map(&:message).join("\n\n") + "\n\n"
+        say! messages
       end
     end
   end

data/lib/bashly/commands/generate.rb

@@ -29,13 +29,12 @@ module Bashly
       example "bashly generate --wrap my_function"
 
       def run
-        validate_config
-        Settings.env = args['--env'] if args['--env']
-        quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
-        create_user_files
-        upgrade_libs if args['--upgrade']
-        create_master_script
-        quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        with_valid_config do
+          Settings.env = args['--env'] if args['--env']
+          quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
+          generate_all_files
+          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        end
       end
 
     private
@@ -44,6 +43,12 @@ module Bashly
         say message unless args['--quiet']
       end
 
+      def generate_all_files
+        create_user_files
+        upgrade_libs if args['--upgrade']
+        create_master_script
+      end
+
       def upgrade_libs
         generated_files.each do |file|
           content = File.read file
@@ -128,10 +133,6 @@ module Bashly
         "#{Settings.target_dir}/#{command.name}"
       end
 
-      def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
-      end
-
       def command
         @command ||= Script::Command.new config
       end

data/lib/bashly/commands/preview.rb

@@ -9,10 +9,11 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        command = Script::Command.new(config)
-        script = Script::Wrapper.new command
-        puts script.code
+        with_valid_config do
+          command = Script::Command.new config
+          script = Script::Wrapper.new command
+          puts script.code
+        end
       end
     end
   end

data/lib/bashly/commands/validate.rb

@@ -10,7 +10,13 @@ module Bashly
 
       def run
         validate_config
-        say "!txtgrn!OK"
+        show_deprecations
+        deprecations = config_validator.deprecations
+        if deprecations.empty?
+          say "!txtgrn!OK"
+        else
+          say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
+        end
       end
     end
   end

data/lib/bashly/concerns/validation_helpers.rb

@@ -0,0 +1,69 @@
+module Bashly
+  # This is a `ConfigValidator` concern responsible for providing basic
+  # assertion methods.
+  module ValidationHelpers
+
+    def deprecations
+      @deprecations ||= []
+    end
+
+  protected
+
+    def assert(valid, message)
+      raise ConfigurationError, message unless valid
+    end
+
+    def refute(invalid, message)
+      assert !invalid, message
+    end
+
+    def deprecate(key, **options)
+      deprecations.push Deprecation.new(key, **options)
+    end
+
+    def assert_string(key, value)
+      assert value.is_a?(String), "#{key} must be a string"
+    end
+
+    def assert_optional_string(key, value)
+      assert_string key, value if value
+    end
+
+    def assert_boolean(key, value)
+      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
+    end
+
+    def assert_array(key, value, of: nil)
+      return unless value
+      assert value.is_a?(Array), "#{key} must be an array"
+      if of
+        value.each_with_index do |val, i|
+          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
+        end
+      end
+    end
+
+    def assert_hash(key, value, whitelist = nil)
+      assert value.is_a?(Hash), "#{key} must be a hash"
+      
+      if whitelist
+        invalid_keys = value.keys.map(&:to_sym) - whitelist
+        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
+      end
+    end
+
+    def assert_uniq(key, value, array_key)
+      return unless value
+      list = value.map { |c| c[array_key] }.compact.flatten
+      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+    end
+
+    def assert_string_or_array(key, value)
+      return unless value
+      assert [Array, String].include?(value.class),
+        "#{key} must be a string or an array"
+
+      assert_array key, value, of: :string if value.is_a? Array
+    end
+  end
+end

data/lib/bashly/config_validator.rb

@@ -1,5 +1,7 @@
 module Bashly
   class ConfigValidator
+    include ValidationHelpers
+
     attr_reader :data
 
     def initialize(data)
@@ -12,45 +14,6 @@ module Bashly
 
   private
 
-    def assert(valid, message)
-      raise ConfigurationError, message unless valid
-    end
-
-    def refute(invalid, message)
-      assert !invalid, message
-    end
-
-    def assert_string(key, value)
-      assert value.is_a?(String), "#{key} must be a string"
-    end
-
-    def assert_optional_string(key, value)
-      assert_string key, value if value
-    end
-
-    def assert_boolean(key, value)
-      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
-    end
-
-    def assert_array(key, value, of: nil)
-      return unless value
-      assert value.is_a?(Array), "#{key} must be an array"
-      if of
-        value.each_with_index do |val, i|
-          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
-        end
-      end
-    end
-
-    def assert_hash(key, value, whitelist = nil)
-      assert value.is_a?(Hash), "#{key} must be a hash"
-      
-      if whitelist
-        invalid_keys = value.keys.map(&:to_sym) - whitelist
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
-      end
-    end
-
     def assert_version(key, value)
       return unless value
       assert [String, Integer, Float].include?(value.class),
@@ -140,7 +103,6 @@ module Bashly
       refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
 
       assert_string "#{key}.name", value['name']
-      assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
@@ -150,6 +112,7 @@ module Bashly
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
+      assert_string_or_array "#{key}.alias", value['alias']
       assert_extensible "#{key}.extensible", value['extensible']
       
       assert_array "#{key}.args", value['args'], of: :arg
@@ -161,13 +124,19 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      assert_uniq "#{key}.commands", value['commands'], 'name'
+      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.flags", value['flags'], 'long'
+      assert_uniq "#{key}.flags", value['flags'], 'short'
+      assert_uniq "#{key}.args", value['args'], 'name'
+
       if value['catch_all'] and value['args']
         repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"
       end
 
       if key == "root"
-        refute value['short'], "#{key}.short makes no sense"
+        refute value['alias'], "#{key}.alias makes no sense"
         refute value['group'], "#{key}.group makes no sense"
         refute value['default'], "#{key}.default makes no sense"
         refute value['private'], "#{key}.private makes no sense"
@@ -175,6 +144,11 @@ module Bashly
         refute value['version'], "#{key}.version makes no sense"
         refute value['extensible'], "#{key}.extensible makes no sense"
       end
+
+      # DEPRECATION 0.8.0
+      if value['short']
+        deprecate "#{key}.short", replacement: "alias", reference: "https://github.com/DannyBen/bashly/pull/220"
+      end
     end
   end
 end

data/lib/bashly/deprecation.rb

@@ -0,0 +1,25 @@
+module Bashly
+  class Deprecation
+    attr_reader :old, :replacement, :reference
+
+    def initialize(old, replacement: nil, reference: nil)
+      @old, @replacement, @reference = old, replacement, 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

data/lib/bashly/extensions/array.rb

@@ -4,4 +4,9 @@ class Array
     indentation = " " * offset
     map { |line| "#{indentation}#{line}" }
   end
+
+  def uniq?
+    self == uniq
+  end
+
 end

data/lib/bashly/script/command.rb

@@ -7,12 +7,14 @@ module Bashly
       class << self
         def option_keys
           @option_keys ||= %i[
-            args catch_all commands completions
+            alias args catch_all commands completions
             default dependencies environment_variables examples
             extensible filename filters flags
             footer group help name
-            private short version
+            private version
+            short
           ]
+          # DEPRECATION 0.8.0
         end
       end
 
@@ -27,7 +29,15 @@ module Bashly
 
       # Returns all the possible aliases for this command
       def aliases
-        short ? [name, short] : [name]
+        [name] + alt
+      end
+
+      # 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']
       end
 
       # Returns an array of Arguments

data/lib/bashly/templates/bashly.yml

@@ -8,7 +8,7 @@ environment_variables:
 
 commands:
 - name: download
-  short: d
+  alias: d
   help: Download a file
 
   args:
@@ -32,7 +32,7 @@ commands:
     help: Set the default location to download to
 
 - name: upload
-  short: u
+  alias: u
   help: Upload a file
   args:
   - name: source

data/lib/bashly/templates/strings.yml

@@ -11,7 +11,7 @@ environment_variables: "Environment Variables:"
 group: "%{group} Commands:"
 
 # Usage helpers
-command_shortcut: "Shortcut: %{short}"
+command_alias: "Alias: %{alias}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 repeatable: "(repeatable)"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.10"
+  VERSION = "0.8.0"
 end

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

@@ -15,8 +15,8 @@
     echo 
   fi
 
-  <%- if short -%>
-  printf "<%= strings[:command_shortcut] % { short: short } %>\n"
+  <%- if alt&.any? -%>
+  printf "<%= strings[:command_alias] % { alias: alt.join(', ') } %>\n"
   echo
   <%- end -%>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.8.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -87,8 +87,10 @@ files:
 - lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
+- lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
 - lib/bashly/config_validator.rb
+- lib/bashly/deprecation.rb
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb