piotrmurach/tty-option

View on GitHub
lib/tty/option/params.rb

Summary

Maintainability
A
1 hr
Test Coverage
# frozen_string_literal: true

require "forwardable"

require_relative "aggregate_errors"

module TTY
  module Option
    class Params
      extend Forwardable

      def self.create(parameters = {}, remaining = [], errors = [])
        new(parameters, remaining: remaining, errors: errors)
      end

      def_delegators :@parameters,
                     :keys, :key?, :has_key?, :member?, :value?, :has_value?,
                     :empty?, :include?, :each_key, :each_value

      # The remaining unparsed arguments
      #
      # @api public
      attr_reader :remaining

      # The parameter parsing errors
      #
      # @api public
      attr_reader :errors

      # Create Params
      #
      # @api private
      def initialize(parameters, remaining: [], errors: [])
        @parameters = parameters
        @parameters.default_proc = ->(hash, key) do
          return hash[key] if hash.key?(key)

          case key
          when Symbol
            hash[key.to_s] if hash.key?(key.to_s)
          when String
            hash[key.to_sym] if hash.key?(key.to_sym)
          end
        end
        @remaining = remaining
        @errors = AggregateErrors.new(errors)
      end

      # Access a given value for a key
      #
      # @api public
      def [](key)
        @parameters[key]
      end

      # Assign value to a key
      #
      # @api public
      def []=(key, value)
        @parameters[key] = value
      end

      # Access a given value for a key
      #
      # @api public
      def fetch(key, *args, &block)
        value = self[key]
        return value unless value.nil?

        @parameters.fetch(key, *args, &block)
      end

      def merge(other_params)
        @parameters.merge(other_params)
      end

      def merge!(other_params)
        @parameters.merge!(other_params)
      end

      # Check if params have any errors
      #
      # @api public
      def valid?
        @errors.empty?
      end

      def ==(other)
        return false unless other.kind_of?(TTY::Option::Params)

        @parameters == other.to_h
      end
      alias eql? ==

      def hash
        @parameters.hash
      end

      def to_h
        @parameters.to_h
      end

      # String representation of this params
      #
      # @return [String]
      #
      # @api public
      def inspect
        "#<#{self.class}#{to_h.inspect}>"
      end

      # String representation of the parameters
      #
      # @return [String]
      #
      # @api public
      def to_s
        to_h.to_s
      end
    end # Params
  end # Option
end # TTY