brigadier 0.1.1

data/lib/brigadier/helper.rb

@@ -0,0 +1,55 @@
+module Brigadier
+  module Helper
+    def display_help_for(item, label)
+      opts = item.values.uniq(&:name)
+      return if opts.empty?
+      $stderr.puts label
+      opts.each do |opt|
+        next if opt.hidden?
+        $stderr.puts '%s  %-28s %s' % [ indent, opt.display_name, opt.display_description ]
+      end
+      $stderr.puts
+    end
+
+    def help_requested?(args)
+      !(%w( --help -help -h ) & args).empty?
+    end
+
+    def display_help_if_requested(klasses, args)
+      return false unless help_requested?(args)
+      $stderr.puts
+      help(klasses)
+      true
+    end
+
+    def help(klasses)
+      klasses = [ *klasses ]
+      display_help_for(available_params_for(klasses, :toggles), 'Toggle(s)')
+      display_help_for(available_params_for(klasses, :options), 'Option(s)')
+      display_help_for(available_params_for(klasses, :arguments), 'Argument(s)')
+      display_help_for(available_params_for(klasses, :sub_commands), 'Subcommand(s)') unless sub_command?
+    end
+
+    def available_params_for(klasses, param)
+      klasses.each_with_object({}) { |k, a| a.merge!(k.public_send(param)) }
+    end
+
+    def inverse_toggle_arg?(arg)
+      arg =~ /^-{1,}no.+$/ ? true : false
+    end
+
+    def sub_command?
+      is_a?(Brigadier::Commands::SubCommand)
+    end
+
+    def option_or_toggle?(arg)
+      arg.match(/^-[-\w+]/)
+    end
+
+    private
+
+      def indent
+        @indent ||= (' ' * 2)
+      end
+  end
+end

data/lib/brigadier/parameters/argument.rb

@@ -0,0 +1,57 @@
+module Brigadier
+  module Parameters
+    class Argument
+      include Base
+
+      def initialize(name, description, args, block)
+        @name = name
+        @description = description
+        @args = args
+        @value = nil
+        @block = block
+        assign_value_from_env_variable
+      end
+
+      def display_name
+        name
+      end
+
+      def display_description
+        opts = []
+        opts << 'valid_values: %s' % [ valid_values.inspect ] if valid_values?
+        opts << 'current: %s' % [ value.inspect ]
+        '%s (%s)' % [ description, opts.join(', ') ]
+      end
+
+      def valid_values
+        args.fetch(:valid_values, [])
+      end
+
+      def validate!
+        validate_presence!    if required?
+        validate_valid_value! if valid_values?
+        validate_using_klass! if validator_klasses
+      end
+
+      def required?
+        true
+      end
+
+      def valid_values?
+        !valid_values.empty?
+      end
+
+      private
+
+        attr_reader :args
+
+        def validate_valid_value!
+          raise Exceptions::ValueInvalid.new(self), 'Value is invalid.  Valid values are %s' % [ valid_values] if valid_values? && !valid_values.include?(value)
+        end
+
+        def validate_presence!
+          raise Exceptions::ValueMissing.new(self), 'Value is empty' if [ nil, '' ].include?(value)
+        end
+    end
+  end
+end

data/lib/brigadier/parameters/base.rb

@@ -0,0 +1,75 @@
+module Brigadier
+  module Parameters
+    module Base
+      attr_reader :name, :description, :value
+
+      def forbidden_parameters
+        [ :name, :description, :value ]
+      end
+
+      def value=(value)
+        @value = block_defined? ? block.call(value) : value
+        ENV[env_variable_value_key_name] = @value.to_s
+      end
+
+      def normalised_attribute_name
+        attribute_name.gsub(/[ -]/, '_')
+      end
+
+      def attribute_name
+        @attribute_name ||= args.fetch(:attribute_name, name).to_s
+      end
+
+      def hidden?
+        args.fetch(:hidden, false)
+      end
+
+      def value?
+        !value.nil?
+      end
+
+      def valid?
+        validate! && true
+      rescue Exceptions::Base
+        false
+      end
+
+      def required?
+        args.fetch(:required, false)
+      end
+
+      def block_defined?
+        !block.nil?
+      end
+
+      private
+
+        attr_reader :block
+
+        def default_value
+          nil
+        end
+
+        def validate_using_klass!
+          validator_klasses.each { |klass| klass.new(self).validate! }
+        end
+
+        def validator_klasses
+          args.fetch(:validators, nil)
+        end
+
+        def assign_value_from_env_variable
+          value = ENV.fetch(env_variable_value_key_name, default_value)
+          self.value = value if value
+        end
+
+        def normalised_name
+          name.gsub(/[ -]/, '_')
+        end
+
+        def env_variable_value_key_name
+          normalised_name.upcase
+        end
+    end
+  end
+end

data/lib/brigadier/parameters/option.rb

@@ -0,0 +1,51 @@
+module Brigadier
+  module Parameters
+    class Option
+      include Base
+
+      def initialize(name, description, args, block)
+        @name = name
+        @description = description
+        @args = args
+        @value = default_value
+        @block = block
+        assign_value_from_env_variable
+      end
+
+      def display_name
+        str = [ "--#{name}" ]
+        str << (required? ? '<value>' : '[<value>]')
+        str.join(' ')
+      end
+
+      def display_description
+        opts = []
+        opts << 'default: %s' % [ default_value ] if default_value
+        opts << 'required: %s' % [ required? ]
+        opts << 'current: %s' % [ value.inspect ]
+        '%s (%s)' % [ description, opts.join(', ') ]
+      end
+
+      def validate!
+        validate_presence!    if required?
+        validate_using_klass! if validator_klasses
+      end
+
+      private
+
+        attr_reader :args
+
+        def aliases
+          args.fetch(:aliases, [])
+        end
+
+        def default_value
+          args.fetch(:default, nil)
+        end
+
+        def validate_presence!
+          raise Exceptions::ValueMissing.new(self), 'Value is empty' if [ nil, '' ].include?(value)
+        end
+    end
+  end
+end

data/lib/brigadier/parameters/toggle.rb

@@ -0,0 +1,63 @@
+module Brigadier
+  module Parameters
+    class Toggle
+      include Base
+
+      def initialize(name, description, args, block)
+        @name = name
+        @description = description
+        @args = args
+        @block = block
+        @value = default_value
+        assign_value_from_env_variable
+      end
+
+      def display_name
+        "--#{name}"
+      end
+
+      def display_description
+        '%s (%s)' % [ description, description_detail ]
+      end
+
+      def enable!
+        assign_value(true)
+      end
+
+      def disable!
+        assign_value(false)
+      end
+
+      private
+
+        attr_reader :args
+
+        def value_set?
+          value != default_value
+        end
+
+        def description_detail
+          detail = [ 'default: %s' % [ default_value ] ]
+          detail << 'current: %s' % [ value ] if value_set?
+          detail.join(', ')
+        end
+
+        def aliases
+          args.fetch(:aliases, [])
+        end
+
+        def klass_only
+          self.class.to_s.to_s.gsub(/^.*::/, '')
+        end
+
+        def default_value
+          args.fetch(:default, false)
+        end
+
+        def assign_value(value)
+          @value = value
+          ENV[env_variable_value_key_name] = value.to_s.downcase
+        end
+    end
+  end
+end

data/lib/brigadier/parameters.rb

@@ -0,0 +1,9 @@
+require 'brigadier/parameters/base'
+require 'brigadier/parameters/argument'
+require 'brigadier/parameters/option'
+require 'brigadier/parameters/toggle'
+
+module Brigadier
+  module Parameters
+  end
+end

data/lib/brigadier/runner.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module Brigadier
+  class Runner
+    include Helper
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run(*klasses)
+      remaining_args = []
+      args_to_process = []
+      sub_command_to_execute = false
+      full_args = args.dup
+
+      collect_execute_blocks(klasses)
+
+      klasses.each do |klass|
+        remaining_args = args.dup
+
+        until remaining_args.empty?
+          arg = remaining_args.shift
+
+          klass.sub_commands.each do |names, sub_command|
+            next unless names.include?(arg)
+            sub_command_to_execute = sub_command
+            break
+          end
+
+          break if sub_command_to_execute
+
+          args_to_process << arg
+        end
+
+        break if sub_command_to_execute
+      end
+
+      if sub_command_to_execute
+        args_to_process += remaining_args
+        sub_command_to_execute.execute(args_to_process, full_args)
+      elsif default_command
+        default_command.execute(args, full_args, klasses)
+      elsif help_requested?(args)
+        $stderr.puts
+        help(klasses)
+      else
+        raise Exceptions::ExecuteBlockMissing.new(self), 'There is no execute {} block defined'
+      end
+    rescue Exceptions::ExecuteBlockMissing, Exceptions::Base => e
+      $stderr.puts "ERROR: #{e.message}"
+      exit(Exceptions::ERROR_EXIT_CODE)
+    end
+
+    private
+
+      attr_reader :args
+
+      def default_command
+        Brigadier.default_command
+      end
+
+      def collect_execute_blocks(klasses)
+        klasses.each do |klass|
+          execute_proc = klass.instance_variable_get('@execute_proc')
+          next unless execute_proc
+          Brigadier.set_default_command(klass, execute_proc)
+        end
+      end
+  end
+end

data/lib/brigadier/validators/base.rb

@@ -0,0 +1,25 @@
+module Brigadier
+  module Validators
+    module Base
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def validate!
+        raise Brigadier::Exceptions::Base.new(obj), failure_message unless valid?
+      end
+
+      private
+
+        attr_reader :obj
+
+        def value
+          @value ||= obj.value
+        end
+
+        def valid?
+          !obj.value.match(/poop/i)
+        end
+    end
+  end
+end

data/lib/brigadier/validators/email.rb

@@ -0,0 +1,15 @@
+module Brigadier
+  module Validators
+    class Email
+      include Base
+
+      def failure_message
+        %('%s' is not a valid email address.) % [ value ]
+      end
+
+      def valid?
+        value.match(/\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i)
+      end
+    end
+  end
+end

data/lib/brigadier/validators.rb

@@ -0,0 +1,7 @@
+require 'brigadier/validators/base'
+require 'brigadier/validators/email'
+
+module Brigadier
+  module Validators
+  end
+end

data/lib/brigadier/version.rb

@@ -0,0 +1,3 @@
+module Brigadier
+  VERSION = '0.1.1'.freeze
+end

data/lib/brigadier.rb

@@ -0,0 +1,123 @@
+require 'brigadier/version'
+require 'brigadier/exceptions'
+require 'brigadier/validators'
+require 'brigadier/helper'
+require 'brigadier/parameters'
+require 'brigadier/commands'
+require 'brigadier/runner'
+
+module Brigadier
+  @@arguments = {}
+  @@options = {}
+  @@toggles = {}
+  @@sub_commands = {}
+  @@default_command = nil
+
+  class << self
+    def arguments
+      @@arguments
+    end
+
+    def options
+      @@options
+    end
+
+    def toggles
+      @@toggles
+    end
+
+    def sub_commands
+      @@sub_commands
+    end
+
+    def default_command
+      @@default_command
+    end
+
+    def set_default_command(klass, block)
+      @@default_command = Commands::Command.new(klass, block)
+    end
+  end
+
+  def options
+    @options ||= {}
+  end
+
+  def toggles
+    @toggles ||= {}
+  end
+
+  def arguments
+    @arguments ||= {}
+  end
+
+  def sub_commands
+    @sub_commands ||= {}
+  end
+
+  def execute(&block)
+    @execute_proc = block
+  end
+
+  def sub_command?
+    @sub_command || false
+  end
+
+  def sub_command(name, description, args = {}, &block)
+    @sub_command = true
+    instance = args.fetch(:instance, new)
+    aliases = args.fetch(:aliases, [])
+    all_aliases = ([ *name ] + aliases).uniq
+    args[:aliases] = all_aliases
+
+    sub_commands[all_aliases] = Commands::SubCommand.new(name, description, instance, args, block)
+  end
+
+  def argument(name, description, args = {}, &block)
+    arguments[name] = Parameters::Argument.new(name, description, args, block)
+  end
+
+  def option(name, description, args = {}, &block)
+    new_aliases = []
+    aliases = args.fetch(:aliases, [])
+
+    ([ *name ] + aliases).each do |n|
+      new_aliases << "--#{n}"
+      new_aliases << "-#{n}"
+    end
+
+    new_aliases.uniq!
+    args[:aliases] = new_aliases
+    options[new_aliases] = Parameters::Option.new(name, description, args, block)
+  end
+
+  def toggle(name, description, args = {}, &block)
+    new_aliases = []
+    new_inverse_aliases = []
+    aliases = args.fetch(:aliases, [])
+    modifiers = %w( -- - )
+    inverse_modifiers = %w( -no- --no- -not- --not- -no_ --no_ -not_ --not_ )
+
+    ([ *name ] + aliases).each do |n|
+      alt_name = n.gsub(/[ -]/, '_')
+
+      modifiers.each do |modifier|
+        new_aliases << '%s%s' % [ modifier, n]
+        new_aliases << '%s%s' % [ modifier, alt_name ]
+      end
+
+      inverse_modifiers.each do |modifier|
+        new_inverse_aliases << '%s%s' % [ modifier, n]
+        new_inverse_aliases << '%s%s' % [ modifier, alt_name ]
+      end
+    end
+
+    new_aliases.uniq!
+    new_inverse_aliases.uniq!
+    all_aliases = [ new_aliases + new_inverse_aliases ].uniq.flatten
+    args[:aliases] = new_aliases
+    args[:inverse_aliases] = new_inverse_aliases
+
+    toggles[all_aliases] = Parameters::Toggle.new(name, description, args, block)
+  end
+end