Contents

# frozen_string_literal: true

class Sinclair
  # @api public
  #
  # @author darthjee
  #
  # Concern for easily adding options
  #
  # @example
  #   class Sinclair
  #     class OptionsParser::Dummy
  #       include OptionsParser
  #
  #       def initialize(options)
  #         @options = options.deep_dup
  #       end
  #     end
  #
  #     def the_method
  #       return 'missing option' if options_object.switch.nil?
  #
  #       if options_object.switch
  #         "The value is #{options_object.option_1}"
  #       else
  #         "The value is not #{options_object.option_1} but #{options_object.option_2}"
  #       end
  #     end
  #   end
  module OptionsParser
    private

    # @!visibility public
    #
    # Options hash
    #
    # @return [Hash]
    attr_reader :options

    # @!visibility public
    # @api public
    #
    # Builds an openstruct of the Hash
    #
    # @return [OpenStruct]
    def options_object
      @options_object ||= OpenStruct.new options
    end
  end
end

Version data entries

23 entries across 23 versions & 1 rubygems

Version	Path
sinclair-1.6.1	lib/sinclair/options_parser.rb
sinclair-1.6.0	lib/sinclair/options_parser.rb
sinclair-1.5.2	lib/sinclair/options_parser.rb