optser 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+# Gemfile.lock because this is a library, not a deployable application.
+Gemfile.lock
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler config
+.bundle
+
+# bundler installs here if bundle path is set to "vendor"
+vendor
+
+# generated builds
+pkg

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in optser.gemspec
+gemspec
+
+# Development and Testing dependencies
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+
+  # Requirements to run our tests and metrics and docs generation
+  gem 'fuubar'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rspec'
+  gem 'yard'
+  gem 'simplecov', require: false
+
+  # Required to support testing
+  gem 'factory_girl'
+
+  # Required by Guard
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'rb-fchange', require: false
+end

data/Guardfile

@@ -0,0 +1,16 @@
+guard(
+    :rspec,
+    cli: '--format Fuubar --color',
+    all_on_start: true,
+    all_after_pass: false,
+    :version => 2) do
+
+  # Watch our specs
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # Watch our lib directory, and run the matching spec
+  watch(%r{^lib/(.+)\.rb$}) { |m|
+    "spec/#{m[1]}_spec.rb"
+  }
+
+end

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.txt

@@ -0,0 +1,4 @@
+Optser
+  Copyright 2012 Benjamin Yu
+  This software includes code written by Benjamin Yu <http://benjaminyu.org/>
+  covered under the Apache License <http://www.apache.org/licenses/LICENSE-2.0>.

data/README.md

@@ -0,0 +1,60 @@
+Optser
+======
+
+Handle options from a set of arguments.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+    gem 'optser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optser
+
+Usage
+=====
+
+    require 'optser'
+
+    class MyClass
+
+      def initialize(*args)
+        opts = Optser.extract_options! args
+
+        # Optional, with nil as default
+        @a = opts.get :option_a
+
+        # Optional, with default value
+        @b = opts.get :option_b, 'DEFAULT'
+
+        # Option's default value is the value returned by the block
+        @c = opts.get(:option_c) {
+          Hash.new
+        }
+
+        # Mandatory option, which will raise an error if not present.
+        @d = opts.get! :option_d
+      end
+    end
+
+    # Will be successful
+    my_object = MyClass.new option_d: 3
+    puts my_object
+    => #<MyClass:0x007fe09c322d80 @a=nil, @b="DEFAULT", @c={}, @d=3>
+
+
+Contributing
+============
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/optser/opt_set.rb

@@ -0,0 +1,70 @@
+require 'hashie'
+
+module Optser
+
+  class OptSet
+    attr_reader :options
+
+    def initialize(options)
+      @options = Hashie::Mash.new options
+    end
+
+    ##
+    # Lookup an option from our options set.
+    #
+    # Examples:
+    #
+    #   # Optional parameter whose default value is nil.
+    #   do_extra = opt_set.get :do_extra
+    #
+    #   # Optional params that defaults to [1,2,3]
+    #   start_array = opt_set.get :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 get(key, default=nil, &block)
+      value = options[key]
+      value = default if value.nil?
+      value = block.call if value.nil? && block
+      return value
+    end
+
+    ##
+    # Use this the option is mandatory.
+    #
+    # 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 = opt_set.get! :logger, ::Log4r['my_logger']
+    #
+    #   # Here we force the end user to pass in a Non-nil option as a
+    #   # mandatory parameter.
+    #   max_threads = opt_set.get! :max_threads
+    #
+    # Raises error when `get` returns a nil.
+    #
+    def get!(key, default=nil, &block)
+      value = get key, default, &block
+      raise "Nil value found for option: #{key}, #{default}" if value.nil?
+      return value
+    end
+
+  end
+
+end

data/lib/optser/version.rb

@@ -0,0 +1,11 @@
+module Optser
+
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join '.'
+  end
+
+end

data/lib/optser.rb

@@ -0,0 +1,32 @@
+require 'optser/opt_set'
+
+##
+# Module that provides helpers for dealing with options hash passed
+# to initializers.
+#
+#   require 'optser'
+#
+#   class Example
+#
+#     def initialize(*args, &block)
+#       opts = Optser.extract_options! args
+#       @a = opts.get! :mandatory_option
+#       @b = opts.get :my_option, 'Default Value'
+#       puts args # Rest of args w/o the options hash.
+#     end
+#
+#   end
+#
+#   Example.new(1, 2, 3, 4, mandatory_option: true)
+#
+module Optser
+
+  ##
+  # Extracts the options from the arguments list, and creates a
+  # brand new OptSet instance to lookup the options.
+  #
+  def self.extract_options!(args)
+    return Optser::OptSet.new(args.last.is_a?(::Hash) ? args.pop : nil)
+  end
+
+end

data/optser.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'optser/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'optser'
+  gem.version       = Optser::Version::STRING
+  gem.authors       = ['Benjamin Yu']
+  gem.email         = ['benjaminlyu@gmail.com']
+  gem.description   = 'Handle options from a set of arguments'
+  gem.summary       = 'Handle options from a set of arguments'
+  gem.homepage      = 'http://github.com/byu/optser'
+  gem.licenses    = ['Apache 2.0']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency('hashie', ['>= 1.2.0'])
+end

data/spec/optser/opt_set_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+shared_examples 'default getter method' do
+
+  it 'returns default data' do
+    subject.get(:nonexistent_option, 'DEFAULT').should == 'DEFAULT'
+  end
+
+  it 'returns nil data on no default' do
+    subject.get(:nonexistent_option).should be_nil
+  end
+
+  it 'returns block data' do
+    calculator = double('calculator')
+    calculator.should_receive(:calculate).and_return('DEFAULT')
+    subject.get(:nonexistent_option) {
+      calculator.calculate
+    }.should == 'DEFAULT'
+  end
+
+end
+
+describe Optser::OptSet do
+  let(:given_options) {
+    FactoryGirl.create :random_options
+  }
+  subject { described_class.new given_options }
+
+  describe '#get' do
+    it_behaves_like 'default getter method'
+  end
+
+  describe '#get!' do
+    it_behaves_like 'default getter method'
+
+    it 'returns given data' do
+      subject.get!(:option_a).should == given_options.option_a
+    end
+
+    it 'fails for missing option' do
+      expect {
+        subject.get! :nonexistent_option
+      }.to raise_error
+    end
+
+  end
+
+end

data/spec/optser_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Optser do
+
+  describe '.extract_options!' do
+    let(:given_options) {
+      FactoryGirl.create :random_options
+    }
+
+    it 'returns an OptSet' do
+      opt_set = described_class.extract_options! []
+      opt_set.should be_a_kind_of(Optser::OptSet)
+    end
+
+    it 'returns an OptSet with our option set' do
+      opt_set = described_class.extract_options! [
+        given_options
+      ]
+      opt_set.should be_a_kind_of(Optser::OptSet)
+      opt_set.get(:option_a).should == given_options.option_a
+      opt_set.get(:option_b).should == given_options.option_b
+      opt_set.get(:nonexist, 'DEFAULT').should == 'DEFAULT'
+    end
+
+    it 'pops off the options hash' do
+      arguments = [1, 2, 3, 4, given_options]
+      original_size = arguments.size
+      described_class.extract_options! arguments
+      arguments.size.should == (original_size - 1)
+    end
+
+    it 'does not modify arguments w/o a trailing hash' do
+      arguments = [1, 2, 3, 4].freeze
+      original_size = arguments.size
+      described_class.extract_options! arguments
+      arguments.size.should == original_size
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+#require 'simplecov'
+#SimpleCov.start
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'optser'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/factories.rb

@@ -0,0 +1,13 @@
+require 'factory_girl'
+require 'hashie'
+require 'securerandom'
+
+FactoryGirl.define do
+  sequence(:random_string) { SecureRandom.hex }
+
+  factory :random_options, class: Hashie::Mash do
+    option_a { generate(:random_string) }
+    option_b { generate(:random_string) }
+    option_c { generate(:random_string) }
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: optser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Handle options from a set of arguments
+email:
+- benjaminlyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- NOTICE.txt
+- README.md
+- Rakefile
+- lib/optser.rb
+- lib/optser/opt_set.rb
+- lib/optser/version.rb
+- optser.gemspec
+- spec/optser/opt_set_spec.rb
+- spec/optser_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+homepage: http://github.com/byu/optser
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2204639992307856645
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2204639992307856645
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Handle options from a set of arguments
+test_files:
+- spec/optser/opt_set_spec.rb
+- spec/optser_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+has_rdoc: