hammer_cli 0.15.1 → 0.16.0

data/lib/hammer_cli/options/sources/command_line.rb

@@ -1,7 +1,9 @@
+require_relative './base'
+
 module HammerCLI
   module Options
     module Sources
-      class CommandLine
+      class CommandLine < Base
         def initialize(command)
           @command = command
         end

data/lib/hammer_cli/options/sources/saved_defaults.rb

@@ -1,7 +1,9 @@
+require_relative './base'
+
 module HammerCLI
   module Options
     module Sources
-      class SavedDefaults
+      class SavedDefaults < Base
         def initialize(defaults, logger)
           @defaults = defaults
           @logger = logger

data/lib/hammer_cli/options/validators/base.rb

@@ -0,0 +1,20 @@
+require_relative '../option_processor'
+
+module HammerCLI
+  module Options
+    module Validators
+      class ValidationError < StandardError
+      end
+
+      class Base < HammerCLI::Options::OptionProcessor
+        def process(defined_options, result)
+          run(defined_options, result)
+          result
+        end
+
+        def run(defined_options, result)
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli/options/validators/dsl.rb

@@ -0,0 +1,160 @@
+module HammerCLI
+  module Options
+    module Validators
+      class DSL
+        class BaseConstraint
+          attr_reader :rejected_msg, :required_msg
+
+          def initialize(option_definitions, option_values, to_check)
+            @to_check = to_check
+            @rejected_msg = ""
+            @required_msg = ""
+
+            @option_values = option_values
+            @options = option_definitions.inject({}) do |hash, opt|
+              hash.update({opt.attribute_name => opt})
+            end
+          end
+
+          def rejected(args={})
+            msg = args[:msg] || rejected_msg % option_switches.join(", ")
+            raise HammerCLI::Options::Validators::ValidationError.new(msg) if exist?
+          end
+
+          def required(args={})
+            msg = args[:msg] || required_msg % option_switches.join(", ")
+            raise HammerCLI::Options::Validators::ValidationError.new(msg) unless exist?
+          end
+
+          def exist?
+            raise NotImplementedError
+          end
+
+          protected
+
+          def get_option(name)
+            name = name.to_s
+            raise _("Unknown option name '%s'.") % name unless @options.has_key? name
+            @options[name]
+          end
+
+          def get_option_value(name)
+            @option_values[name] || @option_values[name.to_s]
+          end
+
+          def option_passed?(option_name)
+            !get_option_value(option_name).nil?
+          end
+
+          def option_switches(opts=nil)
+            opts ||= @to_check
+            opts.collect do |option_name|
+              get_option(option_name).long_switch || get_option(option_name).switches.first
+            end
+          end
+        end
+
+        class AllConstraint < BaseConstraint
+          def initialize(options, option_values, to_check)
+            super
+            @rejected_msg = _("You can't set all options %s at one time.")
+            @required_msg = _("Options %s are required.")
+          end
+
+          def exist?
+            @to_check.each do |opt|
+              return false unless option_passed?(opt)
+            end
+            return true
+          end
+        end
+
+        class OneOptionConstraint < AllConstraint
+          def initialize(options, option_values, to_check)
+            super(options, option_values, [to_check])
+            @rejected_msg = _("You can't set option %s.")
+            @required_msg = _("Option %s is required.")
+          end
+
+          def value
+            get_option_value(@to_check[0])
+          end
+        end
+
+        class AnyConstraint < BaseConstraint
+          def initialize(options, option_values, to_check)
+            super
+            @rejected_msg = _("You can't set any of options %s.")
+            @required_msg = _("At least one of options %s is required.")
+          end
+
+          def exist?
+            @to_check.each do |opt|
+              return true if option_passed?(opt)
+            end
+            return @to_check.empty?
+          end
+        end
+
+
+        class OneOfConstraint < BaseConstraint
+          def initialize(options, option_values, to_check)
+            raise 'Set at least one expected option' if to_check.empty?
+            super
+          end
+
+          def rejected
+            raise NotImplementedError, '#rejected is unsupported for OneOfConstraint'
+          end
+
+          def required_msg
+            case count_present_options
+            when 0
+              _("One of options %s is required.")
+            when 1
+              ''
+            else
+              _("Only one of options %s can be set.")
+            end
+          end
+
+          def exist?
+            return count_present_options == 1
+          end
+
+          protected
+          def count_present_options
+            @to_check.count do |opt|
+              option_passed?(opt)
+            end
+          end
+        end
+
+        def initialize(options, option_values)
+          @options = options
+          @option_values = option_values
+        end
+
+        def all(*to_check)
+          AllConstraint.new(@options, @option_values, to_check.flatten(1))
+        end
+
+        def option(to_check)
+          OneOptionConstraint.new(@options, @option_values, to_check)
+        end
+
+        def any(*to_check)
+          AnyConstraint.new(@options, @option_values, to_check.flatten(1))
+        end
+
+        def one_of(*to_check)
+          OneOfConstraint.new(@options, @option_values, to_check.flatten(1))
+        end
+
+        def run(&block)
+          self.instance_eval &block
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli/options/validators/dsl_block_validator.rb

@@ -0,0 +1,19 @@
+require_relative './base'
+require_relative './dsl'
+
+module HammerCLI
+  module Options
+    module Validators
+      class DSLBlockValidator < Base
+        def initialize(&block)
+          @validation_block = block
+        end
+
+        def run(options, option_values)
+          dsl = DSL.new(options, option_values)
+          dsl.run(&@validation_block)
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli/output/adapter/csv.rb

@@ -165,20 +165,20 @@ module HammerCLI::Output::Adapter
 
     def print_message(msg, msg_params={})
       csv_string = generate do |csv|
-        id = msg_params["id"] || msg_params[:id]
-        name = msg_params["name"] || msg_params[:name]
-
         labels = [_("Message")]
         data = [msg.format(msg_params)]
 
-        if id
-          labels << _("Id")
-          data << id
-        end
-
-        if name
-          labels << _("Name")
-          data << name
+        unless msg_params.nil?
+          id = msg_params["id"] || msg_params[:id]
+          name = msg_params["name"] || msg_params[:name]
+          if id
+            labels << _("Id")
+            data << id
+          end
+          if name
+            labels << _("Name")
+            data << name
+          end
         end
 
         csv << labels

data/lib/hammer_cli/output/adapter/tree_structure.rb

@@ -19,12 +19,14 @@ module HammerCLI::Output::Adapter
     end
 
     def prepare_message(msg, msg_params = {})
-      id = msg_params['id'] || msg_params[:id]
-      name = msg_params['name'] || msg_params[:name]
-
       data = {
         capitalize(:message) => msg.format(msg_params)
       }
+      return data if msg_params.nil?
+
+      id = msg_params['id'] || msg_params[:id]
+      name = msg_params['name'] || msg_params[:name]
+
       data[capitalize(:id)] = id unless id.nil?
       data[capitalize(:name)] = name unless name.nil?
       data

data/lib/hammer_cli/output/definition.rb

@@ -1,21 +1,59 @@
 module HammerCLI::Output
-
   class Definition
-
     attr_accessor :fields
 
     def initialize
       @fields = []
     end
 
-    def append(fields)
+    def append(fields = nil, &block)
+      fields = [fields].compact unless fields.is_a?(Array)
       @fields += fields
+      return @fields unless block_given?
+      dsl = Dsl.new
+      dsl.build(&block)
+      @fields += dsl.fields
+    end
+
+    def find_field(field_id)
+      @fields[field_index(field_id)]
+    end
+
+    def insert(mode, field_id, fields = nil, &block)
+      definition = self.class.new
+      definition.append(fields, &block)
+      HammerCLI.insert_relative(@fields, mode, field_index(field_id), *definition.fields)
+    end
+
+    def at(path = [])
+      path = [path] unless path.is_a? Array
+      return self if path.empty?
+
+      field = find_field(path[0])
+
+      unless field.respond_to?(:output_definition)
+        raise ArgumentError, "Field #{path[0]} doesn't have nested output definition"
+      end
+
+      field.output_definition.at(path[1..-1])
+    end
+
+    def clear
+      @fields = []
     end
 
     def empty?
       @fields.empty?
     end
 
-  end
+    private
 
+    def field_index(field_id)
+      index = @fields.find_index do |f|
+        f.match_id?(field_id)
+      end
+      raise ArgumentError, "Field #{field_id} not found" if index.nil?
+      index
+    end
+  end
 end

data/lib/hammer_cli/output/dsl.rb

@@ -19,8 +19,10 @@ module HammerCLI::Output
 
     def field(key, label, type=nil, options={}, &block)
       options[:path] = current_path.clone
-      options[:path] << key if !key.nil?
-
+      unless key.nil?
+        options[:path] << key
+        options[:key] = key
+      end
       options[:label] = label
       type ||= Fields::Field
       custom_field type, options, &block

data/lib/hammer_cli/output/fields.rb

@@ -3,9 +3,8 @@ require 'hammer_cli/output/dsl'
 module Fields
 
   class Field
-
-    attr_reader :label
     attr_reader :path
+    attr_accessor :label
 
     def initialize(options={})
       @hide_blank = options[:hide_blank].nil? ? false : options[:hide_blank]
@@ -15,6 +14,14 @@ module Fields
       @options = options
     end
 
+    def id
+      @options[:id] || @options[:key] || @label
+    end
+
+    def match_id?(field_id)
+      @options[:id] == field_id || @options[:key] == field_id || @label == _(field_id)
+    end
+
     def hide_blank?
       @hide_blank
     end

data/lib/hammer_cli/testing/messages.rb

@@ -33,19 +33,19 @@ module HammerCLI
         refute opt.description.end_with?('.'), "Description for option #{opt.long_switch} in #{cmd} ends with '.'"
       end
 
-      def check_command_messages(cmd)
+      def check_command_messages(cmd, except: [])
         cmd.recognised_options.each do |opt|
           check_option_description(cmd, opt)
         end
-        refute_msg_period(cmd, :desc)
-        assert_msg_period(cmd, :success_message)
-        refute_msg_period(cmd, :failure_message)
+        refute_msg_period(cmd, :desc) unless except.include?(:desc)
+        assert_msg_period(cmd, :success_message) unless except.include?(:success_message)
+        refute_msg_period(cmd, :failure_message) unless except.include?(:failure_message)
       end
 
-      def check_all_command_messages(main_cmd, parent=HammerCLI::AbstractCommand)
+      def check_all_command_messages(main_cmd, parent=HammerCLI::AbstractCommand, except: {})
         all_subcommands(main_cmd, parent).each do |cmd|
           it "test messages of #{cmd}" do
-            check_command_messages(cmd)
+            check_command_messages(cmd, except: (except[cmd.to_s] || []))
           end
         end
       end

data/lib/hammer_cli/utils.rb

@@ -96,4 +96,19 @@ module HammerCLI
     end
     result
   end
+
+  def self.insert_relative(array, mode, idx, *new_items)
+    case mode
+    when :prepend
+      idx = 0
+    when :append
+      idx = -1
+    when :after
+      idx += 1
+    when :replace
+      array.delete_at(idx)
+    end
+
+    array.insert(idx, *new_items)
+  end
 end

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new '0.15.1'
+    @version ||= Gem::Version.new '0.16.0'
   end
 end