bashly 0.6.9 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76c3000789b54fa2d9be8f7a61d93556e6a8665f4ea7769588797a25fa78f49
-  data.tar.gz: a5a0eae36b00cf879082836211f2aa21b38b280993e2dccfc907f3e6fcb99104
+  metadata.gz: a68036595993a9c9661c283bcb30d0b89941d15930cba9b821e2500d53087178
+  data.tar.gz: d8d50d5c8f91f95a46a94116d3f7ffe5a66f7c2a994e87524036f91292b707f5
 SHA512:
-  metadata.gz: ae77cd9b8fa000d9e12f2948fb5c41bd02e34bd6bdcdd91f3a3a627778f66c9472e956e92fb65b502fa78fe2e77ba6c4dfb12c1f35abed36f1012ce502b7cab9
-  data.tar.gz: 5e14659441abf6b11ca53a5d0d656e5097519acc7a2e842f3cdfb6374fd52a0403c6ddeacf4f193da1ab18687de909b074e4d581ce4700c9fc28e2b589ef961d
+  metadata.gz: d7ad12eef82213a5ed61673d205dafb5626028516efe0768986dc64cf527ae346e0fa868019cb7c23b8366a277edc7f9414149ece6f2ab8178f5f0b20beedb77
+  data.tar.gz: 3db2a86f70fb882bc63f615f25dc2e70aa818f1c5b9af9c13ce1d4d1d2c681dd1e7c5919c93422ccf1d0d440f018efefc3e8901e4af2b43a092fd652d503fee8

data/lib/bashly/cli.rb

@@ -10,6 +10,7 @@ module Bashly
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview
+      runner.route 'validate',  to: Commands::Validate
       runner.route 'generate',  to: Commands::Generate
       runner.route 'add',       to: Commands::Add
 

data/lib/bashly/commands/add.rb

@@ -9,7 +9,7 @@ module Bashly
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
       usage "bashly add validations [--force]"
-      usage "bashly add comp FORMAT [OUTPUT]"
+      usage "bashly add comp FORMAT [OUTPUT --force]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
@@ -32,129 +32,70 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def strings_command
-        safe_copy asset("templates/strings.yml"), "#{Settings.source_dir}/bashly-strings.yml"
+        add_lib 'strings'
       end
 
       def lib_command
-        safe_copy_file "sample_function.sh"
+        add_lib 'lib'
       end
 
       def config_command
-        safe_copy_file "config.sh"
+        add_lib 'config'
       end
 
       def colors_command
-        safe_copy_file "colors.sh"
+        add_lib 'colors'
       end
 
       def yaml_command
-        safe_copy_file "yaml.sh"
+        add_lib 'yaml'
       end
 
       def validations_command
-        safe_copy_dir "validations"
+        add_lib 'validations'
       end
 
       def comp_command
         format = args['FORMAT']
         output = args['OUTPUT']
-        
+
         case format
-        when "function"
-          save_comp_function output
-        when "yaml"
-          save_comp_yaml output
-        when "script"
-          save_comp_script output
-        else
-          raise Error, "Unrecognized format: #{format}"
+        when "script"   then add_lib 'completions_script', output
+        when "function" then add_lib 'completions', output
+        when "yaml"     then add_lib 'completions_yaml', output
+        else            raise Error, "Unrecognized format: #{format}"
         end
 
       end
 
     private
 
-      def safe_copy_dir(dir)
-        Dir[asset("templates/lib/#{dir}/*.sh")].sort.each do |file|
-          safe_copy_file "#{dir}/#{File.basename file}"
+      def add_lib(name, *args)
+        library = Bashly::Library.new name, *args
+        files_created = 0
+        library.files.each do |file|
+          created = safe_write file[:path], file[:content]
+          files_created += 1 if created
         end
+        message = library.post_install_message
+        say "\n#{message}" if message and files_created > 0
       end
 
-      def safe_copy_file(file)
-        safe_copy asset("templates/lib/#{file}"), "#{Settings.source_dir}/lib/#{file}"
-      end
-
-      def safe_copy(source, target)
+      def safe_write(path, content)
         if !Dir.exist? Settings.source_dir
           raise InitError, "Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist\nRun !txtpur!bashly init!txtrst! first"
         end
 
-        if File.exist? target and !args['--force']
-          say "skipped !txtgrn!#{target}!txtrst! (exists)"
+        if File.exist? path and !args['--force']
+          say "!txtblu!skipped!txtrst! #{path} (exists)"
+          false
+        
         else
-          deep_copy source, target
-          say "created !txtgrn!#{target}"
-        end
-      end
-
-      def deep_copy(source, target)
-        target_dir = File.dirname target
-        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
-        FileUtils.cp source, target
-      end
-
-      def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
-      end
-
-      def command
-        @command ||= Models::Command.new config
-      end
-
-      def completions
-        @completions ||= command.completion_data
-      end
-
-      def completions_script
-        @completions_script ||= command.completion_script
-      end
-
-      def completions_function
-        @completions_function ||= command.completion_function
-      end
-
-      def save_comp_yaml(filename = nil)
-        filename ||= "#{Settings.target_dir}/completions.yml"
-        File.write filename, completions.to_yaml
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem."
-      end
-
-      def save_comp_script(filename = nil)
-        filename ||= "#{Settings.target_dir}/completions.bash"
-        File.write filename, completions_script
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "In order to enable completions, run:"
-        say ""
-        say "  !txtpur!$ source #{filename}"
-      end
-
-      def save_comp_function(name = nil)
-        name ||= "send_completions"
-        target_dir = "#{Settings.source_dir}/lib"
-        filename = "#{target_dir}/#{name}.sh"
+          File.deep_write path, content
+          say "!txtgrn!created!txtrst! #{path}"
+          true
         
-        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
-        File.write filename, completions_function
-
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "In order to use it in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{name}!txtrst! function."
-        say "Your users can then run something like this to enable completions:"
-        say ""
-        say "  !txtpur!$ eval \"$(#{command.name} completions)\""
+        end
       end
 
     end

data/lib/bashly/commands/generate.rb

@@ -1,23 +1,28 @@
 module Bashly
   module Commands
     class Generate < Base
+      using ComposeRefinements
+
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --quiet --wrap FUNCTION]"
+      usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
       usage "bashly generate (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
-      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
       option "-q --quiet", "Disable on-screen progress report"
+      option "-u --upgrade", "Upgrade all added library functions"
+      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
+      environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
         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"
       end
@@ -28,6 +33,42 @@ module Bashly
         say message unless args['--quiet']
       end
 
+      def upgrade_libs
+        generated_files.each do |file|
+          content = File.read file
+          
+          if content =~ /\[@bashly-upgrade (.+)\]/
+            args = $1.split ' '
+            library_name = args.shift
+            upgrade file, library_name, *args
+          end
+        end
+      end
+
+      def generated_files
+        Dir["#{Settings.source_dir}/**/*.*"].sort
+      end
+
+      def upgrade(existing_file, library_name, *args)
+        if Library.exist? library_name
+          upgrade! existing_file, library_name, *args
+        else
+          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, unknown library '#{library_name}'"
+        end
+      end
+
+      def upgrade!(existing_file, library_name, *args)
+        library = Bashly::Library.new library_name, *args
+        file = library.find_file existing_file
+
+        if file
+          File.deep_write file[:path], file[:content]
+          quiet_say "!txtcyn!updated!txtrst! #{file[:path]}"
+        else
+          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, path mismatch"
+        end
+      end
+
       def create_user_files
         quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
 
@@ -41,7 +82,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
@@ -55,21 +96,21 @@ module Bashly
 
       def create_file(file, content)
         if File.exist? file and !args['--force']
-          quiet_say "skipped !txtgrn!#{file}!txtrst! (exists)"
+          quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
         else
-          File.write file, content
-          quiet_say "created !txtgrn!#{file}"
+          File.deep_write file, content
+          quiet_say "!txtgrn!created!txtrst! #{file}"
         end
       end
 
       def create_master_script
         File.write master_script_path, script.code
         FileUtils.chmod "+x", master_script_path
-        quiet_say "created !txtgrn!#{master_script_path}"
+        quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
       end
 
       def script
-        @script ||= Models::Script.new(command, args['--wrap'])
+        @script ||= Script::Wrapper.new(command, args['--wrap'])
       end
 
       def master_script_path
@@ -77,11 +118,11 @@ module Bashly
       end
 
       def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+        @config ||= Config.new("#{Settings.source_dir}/bashly.yml").compose
       end
 
       def command
-        @command ||= Models::Command.new config
+        @command ||= Script::Command.new config
       end
 
     end

data/lib/bashly/commands/init.rb

@@ -17,7 +17,7 @@ module Bashly
         end
         Dir.mkdir target_dir unless Dir.exist? target_dir
         File.write "#{target_dir}/bashly.yml", yaml_content
-        say "created !txtgrn!#{target_dir}/bashly.yml"
+        say "!txtgrn!created!txtrst! #{target_dir}/bashly.yml"
         say "run !txtpur!bashly generate!txtrst! to create the bash script"
       end
 

data/lib/bashly/commands/preview.rb

@@ -10,8 +10,8 @@ module Bashly
 
       def run
         config = Config.new "#{Settings.source_dir}/bashly.yml"
-        command = Models::Command.new(config)
-        script = Models::Script.new command
+        command = Script::Command.new(config)
+        script = Script::Wrapper.new command
         puts script.code
       end
     end

data/lib/bashly/commands/validate.rb

@@ -0,0 +1,19 @@
+module Bashly
+  module Commands
+    class Validate < Base
+      help "Scan the configuration file for errors"
+
+      usage "bashly validate"
+      usage "bashly validate (-h|--help)"
+
+      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"
+        validator = ConfigValidator.new config
+        validator.validate
+        say "!txtgrn!OK"
+      end
+    end
+  end
+end

data/lib/bashly/concerns/asset_helper.rb

@@ -3,5 +3,9 @@ module Bashly
     def asset(path)
       File.expand_path "../#{path}", __dir__
     end
+
+    def asset_content(path)
+      File.read asset(path)
+    end
   end
 end

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_validator.rb

@@ -0,0 +1,142 @@
+module Bashly
+  class ConfigValidator
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def validate
+      assert_command "root", data
+    end
+
+  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)
+      assert value.is_a?(Hash), "#{key} must be a hash"
+    end
+
+    def assert_version(key, value)
+      return unless value
+      assert [String, Integer, Float].include?(value.class),
+        "#{key} must be a string or a number" 
+    end
+
+    def assert_catch_all(key, value)
+      return unless value
+      assert [TrueClass, String, Hash].include?(value.class),
+        "#{key} must be a boolean, a string or a hash" 
+
+      assert_catch_all_hash key, value if value.is_a? Hash
+    end
+
+    def assert_catch_all_hash(key, value)
+      assert_string "#{key}.label", value['label']
+      assert_optional_string "#{key}.help", value['help']
+      assert_boolean "#{key}.required", value['required']
+    end
+
+    def assert_extensible(key, value)
+      return unless value
+      assert [TrueClass, String].include?(value.class),
+        "#{key} must be a boolean or a string" 
+    end
+
+    def assert_arg(key, value)
+      assert_hash key, value
+      assert_string "#{key}.name", value['name']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.default", value['default']
+      assert_optional_string "#{key}.validate", value['validate']
+      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)
+      assert_hash key, value
+      assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
+
+      assert_optional_string "#{key}.long", value['long']
+      assert_optional_string "#{key}.short", value['short']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.arg", value['arg']
+      assert_optional_string "#{key}.default", value['default']
+      assert_optional_string "#{key}.validate", value['validate']
+      
+      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)
+      assert_hash key, value
+      assert_string "#{key}.name", value['name']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.default", value['default']
+      assert_boolean "#{key}.required", value['required']
+    end
+
+    def assert_command(key, value)
+      assert_hash key, value
+
+      refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
+      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']
+      assert_optional_string "#{key}.filename", value['filename']
+
+      assert_boolean "#{key}.default", value['default']
+      assert_version "#{key}.version", value['version']
+      assert_catch_all "#{key}.catch_all", value['catch_all']
+      assert_extensible "#{key}.extensible", value['extensible']
+      
+      assert_array "#{key}.args", value['args'], of: :arg
+      assert_array "#{key}.flags", value['flags'] , of: :flag
+      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}.environment_variables", value['environment_variables'], of: :env_var
+      assert_array "#{key}.examples", value['examples'], of: :string
+    end
+  end
+end

data/lib/bashly/extensions/file.rb

@@ -0,0 +1,13 @@
+require "fileutils"
+
+class File
+  def self.deep_write(file, content)
+    dir = File.dirname file
+    FileUtils.mkdir_p dir unless Dir.exist? dir
+    File.write file, content
+  end
+
+  def self.append(path, content)
+    File.open(path, "a") { |f| f << content }
+  end
+end

data/lib/bashly/extensions/string.rb

@@ -24,7 +24,11 @@ class String
   end
 
   def lint
-    gsub(/\s+\n/m, "\n\n")
+    gsub(/\s+\n/m, "\n\n").lines.reject { |l| l =~ /^\s*##/ }.join ""
+  end
+
+  def remove_front_matter
+    split(/^---\s*/).last
   end
 
 end

data/lib/bashly/libraries/base.rb

@@ -0,0 +1,19 @@
+module Bashly
+  module Libraries
+    class Base
+      attr_reader :args
+
+      def initialize(*args)
+        @args = args
+      end
+
+      def files
+        raise NotImplementedError, "Please implement #files"
+      end
+
+      def post_install_message
+        nil
+      end
+    end
+  end
+end

data/lib/bashly/libraries/completions.rb

@@ -0,0 +1,14 @@
+module Bashly
+  module Libraries
+    class Completions < Base
+    protected
+      def command
+        @command ||= Script::Command.new config
+      end
+
+      def config
+        @config ||= Bashly::Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+    end
+  end
+end

data/lib/bashly/libraries/completions_function.rb

@@ -0,0 +1,38 @@
+module Bashly
+  module Libraries
+    class CompletionsFunction < Completions
+      def files
+        [
+          {
+            path: "#{Settings.source_dir}/lib/#{function_name}.sh",
+            content: completions_function_code(function_name)
+          }
+        ]
+      end
+
+      def post_install_message
+        <<~EOF
+          In order to enable completions in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{function_name}!txtrst! function.
+
+          Your users can then run something like this to enable completions:
+
+            !txtpur!$ eval \"$(#{command.name} completions)\"
+        EOF
+      end
+
+    private
+
+      def function_name
+        @function_name ||= args[0] || 'send_completions'
+      end
+
+      def completions_function_code(function_name)
+        [
+          "## [@bashly-upgrade completions #{function_name}]",
+          command.completion_function(function_name)
+        ].join "\n"
+      end
+
+    end
+  end
+end