serf 0.11.0 → 0.12.0

data/lib/serf/util/options_extraction.rb

@@ -1,117 +0,0 @@
-require 'hashie'
-
-module Serf
-module Util
-
-  ##
-  # Module that provides helpers for dealing with options hash passed
-  # to initializers.
-  #
-  #   class Example
-  #     include Serf::Util::OptionsExtraction
-  #
-  #     def initialize(*args, &block)
-  #       extract_options! args
-  #       puts args # Rest of args w/o the options hash.
-  #     end
-  #
-  #     def do_work
-  #       my_option = opts :my_option, 'Default Value'
-  #       puts my_option
-  #     end
-  #   end
-  #
-  #   example = Example.new my_option: 'Another Value'
-  #   example.do_work
-  #   # => 'Another Value'
-  #
-  module OptionsExtraction
-
-    ##
-    # Reader method for the options hash.
-    #
-    def options
-      return @options || Hashie::Mash.new
-    end
-
-    ##
-    # Helper method to lookup an option from our options hash.
-    #
-    # Examples:
-    #
-    #   # Optional parameter whose default value is nil.
-    #   do_extra = opts :do_extra
-    #
-    #   # Optional params that defaults to [1,2,3]
-    #   start_array = opts :start_array, [1,2,3]
-    #
-    # Returns default value when:
-    # * Key is non-existent in Options Hash.
-    # * OR when the value of the key in the Options Hash is nil.
-    #
-    # Returns nil when:
-    # * Default is nil and the Options Hash lookup returns a nil.
-    #   Options Hash returns a nil because of either a
-    #   non-existent key or a nil value in said hash for said key.
-    #
-    def opts(key, default=nil, &block)
-      value = options[key]
-      value = default if value.nil?
-      value = block.call if value.nil? && block
-      return value
-    end
-
-    ##
-    # Use this lookup helper if a nil value is unacceptable for processing.
-    #
-    # There are cases where an option may have a default value for a feature,
-    # but the caller may just want to disable said feature. To do so,
-    # users of this module should allow for the caller to pass in 'false'
-    # as an option value instead of nil to disable said feature. The
-    # implementer will have to do a boolean check of the returned option value
-    # and disable accordingly.
-    #
-    # Examples:
-    #
-    #   # Has a default logger, but we can disable logging by passing false.
-    #   # If caller had passed in nil for :logger, it would have
-    #   # defaulted to ::Log4r['my_logger'].
-    #   logger = opts! :logger, ::Log4r['my_logger']
-    #   logger = Serf::NullObject.new unless logger
-    #
-    #   # Here we force the end user to pass in a Non-nil option as a
-    #   # mandatory parameter.
-    #   max_threads = opts! :max_threads
-    #
-    # Raises error when `opts` returns a nil.
-    #
-    def opts!(key, default=nil, &block)
-      value = opts key, default, &block
-      raise "Nil value found for option: #{key}, #{default}" if value.nil?
-      return value
-    end
-
-    protected
-
-    ##
-    # Extracts the options from the arguments list, BUT does not save it to
-    # an instance variable for use by the opts helpr methods.
-    #
-    def pop_options!(args)
-      args.last.is_a?(::Hash) ?
-        [true, Hashie::Mash.new(args.pop)] :
-        [false, Hashie::Mash.new]
-    end
-
-    ##
-    # Extracts the options from the arguments list, and saves it to the
-    # an instance variable for use by the opts helpr methods.
-    #
-    def extract_options!(args)
-      _, @options = pop_options! args
-    end
-
-  end
-
-end
-end

data/spec/serf/util/options_extraction_spec.rb

@@ -1,62 +0,0 @@
-require 'spec_helper'
-
-shared_examples '#opts with nonexistent option' do
-  context 'with missing option' do
-
-    it 'returns default data' do
-      subject.opts(:nonexistent_option, 'DEFAULT').should == 'DEFAULT'
-    end
-
-    it 'returns nil data on no default' do
-      subject.opts(:nonexistent_option).should be_nil
-    end
-
-    it 'returns block data' do
-      calculator = double('calculator')
-      calculator.should_receive(:calculate).and_return('DEFAULT')
-      subject.opts(:nonexistent_option) {
-        calculator.calculate
-      }.should == 'DEFAULT'
-    end
-
-  end
-
-end
-
-describe Serf::Util::OptionsExtraction do
-  let(:given_options) {
-    FactoryGirl.create :random_options
-  }
-  subject { OptionsExtractionWrapper.new given_options }
-
-  describe '#opts!' do
-
-    it 'returns given data' do
-      subject.opts!(:option_a).should == given_options.option_a
-    end
-
-    it 'fails for missing option' do
-      expect {
-        subject.opts! :nonexistent_option
-      }.to raise_error
-    end
-
-  end
-
-  describe '#opts' do
-
-    it 'returns given data' do
-      subject.opts(:option_a).should == given_options.option_a
-    end
-
-  end
-
-  it_behaves_like '#opts with nonexistent option'
-
-  context 'with no options given' do
-    subject { OptionsExtractionWrapper.new }
-
-    it_behaves_like '#opts with nonexistent option'
-  end
-
-end

data/spec/support/options_extraction_wrapper.rb

@@ -1,10 +0,0 @@
-require 'serf/util/options_extraction'
-
-class OptionsExtractionWrapper
-  include Serf::Util::OptionsExtraction
-
-  def initialize(*args)
-    extract_options! args
-  end
-
-end