Merge pull request #221 from DannyBen/refactor

Add deprecation warning for `command.short`

Author: DannyBen

lib/bashly/commands/base.rb

@@ -6,10 +6,28 @@ module Commands
     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

lib/bashly/commands/generate.rb

@@ -29,13 +29,12 @@ class Generate < Base
       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 @@ def quiet_say(message)
         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 @@ def master_script_path
         "#{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

lib/bashly/commands/preview.rb

@@ -9,10 +9,11 @@ class Preview < Base
       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

lib/bashly/commands/validate.rb

@@ -10,7 +10,13 @@ class Validate < Base
 
       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

lib/bashly/config_validator.rb

@@ -10,6 +10,10 @@ def validate
       assert_command "root", data
     end
 
+    def deprecations
+      @deprecations ||= []
+    end
+
   private
 
     def assert(valid, message)
@@ -20,6 +24,10 @@ 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
@@ -183,6 +191,11 @@ def assert_command(key, value)
         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

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

lib/bashly/script/command.rb

@@ -12,7 +12,9 @@ def option_keys
             extensible filename filters flags
             footer group help name
             private version
+            short
           ]
+          # DEPRECATION 0.8.0
         end
       end
 
@@ -32,6 +34,8 @@ def aliases
 
       # 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

spec/approvals/cli/deprecations/command-short-stderr

@@ -0,0 +1,11 @@
+
+▐ Deprecation Warning:
+▐ root.commands[0].short is deprecated
+▐ use alias instead
+▐ see https://github.com/DannyBen/bashly/pull/220
+
+▐ Deprecation Warning:
+▐ root.commands[1].short is deprecated
+▐ use alias instead
+▐ see https://github.com/DannyBen/bashly/pull/220
+

spec/approvals/cli/validate/deprecation-command-short

@@ -0,0 +1 @@
+WARNING Found 2 deprecations

spec/approvals/deprecation/message

@@ -0,0 +1,4 @@
+!txtred!▐!txtrst! Deprecation Warning:
+!txtred!▐!txtrst! !txtred!old!txtrst! is deprecated
+!txtred!▐!txtrst! use !txtgrn!new!txtrst! instead
+!txtred!▐!txtrst! see !undblu!https://somewhere!txtrst!