bashly 0.7.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13bbac52a39c2f6afb768d043911861a31f8e6abc8ff1472340a13c2834d5944
-  data.tar.gz: 54c4fea2c664dcd0c6aace3360004d715d87b5d4ed98ffd7d3ccdc6c0a120406
+  metadata.gz: 111e5735cbcae769cf990a20aabd6d2868181251bf366b180d1e0325316a29b0
+  data.tar.gz: 017c1fc803802af3c186b356e9720ed3fd362990ed30b455e12aa2b34b4be6a3
 SHA512:
-  metadata.gz: f1c273771d9048c074fb9551ba4521e9cb38c98a819f53647186822155898f767b7dd95093642e01464788378833d4dd9e408efecf304a9feb1ba09ebf2edef3
-  data.tar.gz: efbdad6c22cfe1b7fbb46533db42f4c14b828259efeb5ede1099e20980ad505773af36897e27f8c6c7b25538a523427e63c1a5dac7ff958d753ae3810caf5eb9
+  metadata.gz: 743c31be7ec2553940700cda415dcbf377dcf6362b18edc4b3e292130024ddf6b3230e26d48603ca4e90ce17464dc71c07e685741614e5047b6f9570d369b8da
+  data.tar.gz: 88ce26cb94af15fb3813b387d93723a60aea6487038eaeb467ee22e23ea3823cf5bfc06ed8cccab0e8a7d1f5a89a198a117a468516734bce8a92033462f6741a

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

@@ -32,27 +32,27 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def strings_command
-        add_lib Library::Strings.new
+        add_lib 'strings'
       end
 
       def lib_command
-        add_lib Library::Sample.new
+        add_lib 'lib'
       end
 
       def config_command
-        add_lib Library::Config.new
+        add_lib 'config'
       end
 
       def colors_command
-        add_lib Library::Colors.new
+        add_lib 'colors'
       end
 
       def yaml_command
-        add_lib Library::YAML.new
+        add_lib 'yaml'
       end
 
       def validations_command
-        add_lib Library::Validations.new
+        add_lib 'validations'
       end
 
       def comp_command
@@ -60,35 +60,24 @@ module Bashly
         output = args['OUTPUT']
 
         case format
-        when "script"
-          path = output || "#{Settings.target_dir}/completions.bash"
-          add_lib Library::CompletionsScript.new(path)
-        
-        when "function"
-          function = output || "send_completions"
-          path = "#{Settings.source_dir}/lib/#{function}.sh"
-          add_lib Library::CompletionsFunction.new(path, function: function)
-
-        when "yaml"
-          path = output || "#{Settings.target_dir}/completions.yml"
-          add_lib Library::CompletionsYAML.new(path)
-        
-        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 add_lib(handler)
+      def add_lib(name, *args)
+        library = Bashly::Library.new name, *args
         files_created = 0
-        handler.files.each do |file|
+        library.files.each do |file|
           created = safe_write file[:path], file[:content]
           files_created += 1 if created
         end
-        message = handler.post_install_message
+        message = library.post_install_message
         say "\n#{message}" if message and files_created > 0
       end
 

data/lib/bashly/commands/generate.rb

@@ -1,6 +1,8 @@
 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]"
@@ -13,6 +15,7 @@ module Bashly
 
       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"
@@ -35,20 +38,9 @@ module Bashly
           content = File.read file
           
           if content =~ /\[@bashly-upgrade (.+)\]/
-            lib = $1
-            
-            case lib
-            when "colors"
-              upgrade file, Library::Colors.new
-            when "config"
-              upgrade file, Library::Config.new
-            when "yaml"
-              upgrade file, Library::YAML.new
-            when "validations"
-              upgrade file, Library::Validations.new
-            when /completions (.+)/
-              upgrade file, Library::CompletionsFunction.new(file, function: $1)
-            end
+            args = $1.split ' '
+            library_name = args.shift
+            upgrade file, library_name, *args
           end
         end
       end
@@ -57,8 +49,17 @@ module Bashly
         Dir["#{Settings.source_dir}/**/*.*"].sort
       end
 
-      def upgrade(existing_file, handler)
-        file = handler.files.select { |f| f[:path] == existing_file }.first
+      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]
@@ -81,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
@@ -97,7 +98,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
@@ -117,7 +118,7 @@ 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

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/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,143 @@
+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}.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
+  end
+end

data/lib/bashly/extensions/string.rb

@@ -27,4 +27,8 @@ class String
     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/{library → libraries}/completions_function.rb

@@ -1,11 +1,13 @@
 module Bashly
-  module Library
+  module Libraries
     class CompletionsFunction < Completions
-      def file_content
+      def files
         [
-          "# [@bashly-upgrade completions #{function_name}]",
-          command.completion_function(function_name)
-        ].join "\n"
+          {
+            path: "#{Settings.source_dir}/lib/#{function_name}.sh",
+            content: completions_function_code(function_name)
+          }
+        ]
       end
 
       def post_install_message
@@ -18,9 +20,19 @@ module Bashly
         EOF
       end
 
+    private
+
       def function_name
-        options[:function]
+        @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

data/lib/bashly/libraries/completions_script.rb

@@ -0,0 +1,29 @@
+module Bashly
+  module Libraries
+    class CompletionsScript < Completions
+      def files
+        [
+          {
+            path: target_path,
+            content: command.completion_script
+          }
+        ]
+      end
+
+      def post_install_message
+        <<~EOF
+          In order to enable completions, run:
+
+            !txtpur!$ source #{target_path}
+        EOF
+      end
+
+    private
+
+      def target_path
+        @target_path ||= args[0] || "#{Settings.target_dir}/completions.bash"
+      end
+
+    end
+  end
+end

data/lib/bashly/libraries/completions_yaml.rb

@@ -0,0 +1,27 @@
+module Bashly
+  module Libraries
+    class CompletionsYAML < Completions
+      def files
+        [
+          {
+            path: target_path,
+            content: command.completion_data.to_yaml
+          }
+        ]
+      end
+
+      def post_install_message
+        <<~EOF
+          This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem.
+        EOF
+      end
+
+    private
+
+      def target_path
+        @target_path ||= args[0] || "#{Settings.target_dir}/completions.yml"
+      end
+
+    end
+  end
+end

data/lib/bashly/libraries.yml

@@ -0,0 +1,39 @@
+colors:
+  files:
+    - source: "templates/lib/colors.sh"
+      target: "%{user_source_dir}/lib/colors.sh"
+
+config:
+  files:
+    - source: "templates/lib/config.sh"
+      target: "%{user_source_dir}/lib/config.sh"
+
+yaml:
+  files:
+    - source: "templates/lib/yaml.sh"
+      target: "%{user_source_dir}/lib/yaml.sh"
+
+lib:
+  files:
+    - source: "templates/lib/sample_function.sh"
+      target: "%{user_source_dir}/lib/sample_function.sh"
+
+strings:
+  files:
+    - source: "templates/strings.yml"
+      target: "%{user_source_dir}/bashly-strings.yml"
+
+validations:
+  files:
+    - source: "templates/lib/validations/validate_dir_exists.sh"
+      target: "%{user_source_dir}/lib/validations/validate_dir_exists.sh"
+    - source: "templates/lib/validations/validate_file_exists.sh"
+      target: "%{user_source_dir}/lib/validations/validate_file_exists.sh"
+    - source: "templates/lib/validations/validate_integer.sh"
+      target: "%{user_source_dir}/lib/validations/validate_integer.sh"
+    - source: "templates/lib/validations/validate_not_empty.sh"
+      target: "%{user_source_dir}/lib/validations/validate_not_empty.sh"
+
+completions: :CompletionsFunction
+completions_script: :CompletionsScript
+completions_yaml: :CompletionsYAML

data/lib/bashly/library.rb

@@ -0,0 +1,63 @@
+module Bashly
+  class Library
+    class << self
+      def exist?(name)
+        config.has_key? name.to_s
+      end
+
+      def config
+        @config ||= YAML.load_file(config_path)
+      end
+
+      def config_path
+        @config_path ||= File.expand_path 'libraries.yml', __dir__
+      end
+    end
+
+    include AssetHelper
+    attr_reader :name, :args
+
+    def initialize(name, *args)
+      @name, @args = name.to_s, args
+    end
+
+    def files
+      if custom_handler
+        custom_handler.files
+
+      else
+        config['files'].map do |file|
+          { path: file['target'] % target_file_args,
+            content: asset_content(file['source']) }
+        end
+      end
+    end
+
+    def post_install_message
+      if custom_handler
+        custom_handler.post_install_message
+      else
+        config['post_install_message']
+      end
+    end
+
+    def find_file(path)
+      files.select { |f| f[:path] == path }.first
+    end
+
+  private
+
+    def custom_handler
+      return nil unless config.is_a? Symbol
+      @custom_handler ||= Bashly::Libraries.const_get(config).new(*args)
+    end
+
+    def config
+      @config ||= self.class.config[name]
+    end
+
+    def target_file_args
+      { user_source_dir: Settings.source_dir }
+    end
+  end
+end