option_picker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58424d3796eca05fc1997df504cdc250b3dede55
+  data.tar.gz: 30dcae4e941fdf9042fd90cb60ac0f344315739b
+SHA512:
+  metadata.gz: dbaad0c770fe0397c5e499254268ca6ed581f5d1d348d1e5b3117f7d3ab84de8db94364ded7b81925a63b09cfc23bc8be315f4106bbd345e20e5b8a71b01e7b0
+  data.tar.gz: 1effd154f06578b58f827f766576525b0dcc764fc0f56a03160584396ffe834ac1e078078bc80c0fb4623a3307f4b257658828c520c8d08dacf9a880dbb225ea

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in option_picker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Marklove
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# OptionPicker
+
+When building query strings to pass on to an API it is nice to be able to manage the allowed options for each parameter in a nice way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'option_picker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install option_picker
+
+## Usage
+
+Define your default option and an array of allowed options:
+
+  SORT_DIR_OPTIONS = OptionPicker::Options.new('asc', ['asc', 'desc'])
+
+Then pass in the value you want to test. The value will be returned if it is allowed, otherwise the default value will be returned.
+
+  SORT_DIR_OPTIONS['asc']  # => 'asc'
+  SORT_DIR_OPTIONS['desc'] # => 'desc'
+  SORT_DIR_OPTIONS['foo']  # => 'asc'
+
+You can always index by `String` or `Symbol`. So the following are identical:
+
+  SORT_DIR_OPTIONS['desc']  # => 'desc'
+  SORT_DIR_OPTIONS[:desc]   # => 'desc'
+
+### Option Translation
+
+Sometimes the option values you accept locally are not the same as those that you need to pass on. To a 3rd party API, for example. To aid in this, instead of a simple array of allowed values, you can use a `Hash` as the second argument to perform a translation:
+
+  SORT_BY_OPTIONS = OptionPicker::Options.new('creationTimestamp', {
+    created_on: 'creationTimestamp',
+    published_on: 'publishedTimestamp',
+    title: 'title'
+  })
+
+  SORT_BY_OPTIONS['created_on'] # => 'creationTimestamp'
+  SORT_BY_OPTIONS['title']      # => 'title'
+  SORT_BY_OPTIONS['foo']        # => 'creationTimestamp'
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/option_picker.rb

@@ -0,0 +1,22 @@
+require "option_picker/version"
+
+module OptionPicker
+  
+  class Options
+
+    def initialize(default_value, options={})
+      options_hash = options.is_a?(Array) ? Hash[options.map {|o| [o,o] }] : options
+
+      @options = options_hash.each_with_object(Hash.new(default_value)) do |(key, value), memo|
+        memo[key.to_sym] = value
+      end
+    end
+
+    def [](index)
+      index = index.to_sym if index.respond_to?(:to_sym)
+      @options[index]
+    end
+
+  end
+
+end

data/lib/option_picker/version.rb

@@ -0,0 +1,3 @@
+module OptionPicker
+  VERSION = "0.0.1"
+end

data/option_picker.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'option_picker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "option_picker"
+  spec.version       = OptionPicker::VERSION
+  spec.authors       = ["Tony Marklove"]
+  spec.email         = ["tony@new-bamboo.co.uk"]
+  spec.description   = %q{OptionPicker allows you to create a list of allowed options, and specify a fallback. When given a value the picker will then return the value if it is in the allowed list, otherwise it will return the default value.}
+  spec.summary       = %q{Pick from a list of allowed options, otherwise fallback to a default value.}
+  spec.homepage      = "https://github.com/jjbananas/option_picker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/option_picker_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe OptionPicker::Options do
+  
+  let(:options) { OptionPicker::Options.new('foo') }
+  
+  it "returns the default option for any missing keys" do
+    expect(options[:something]).to eql('foo')
+  end
+
+  context "with a hash of mappings" do
+    let(:options) { OptionPicker::Options.new('two', foo: 'one', bar: 'two') }
+
+    it "maps the input key to the expected output" do
+      expect(options[:foo]).to eql('one')
+    end
+  end
+
+  context "with an array of options" do
+    let(:options) { OptionPicker::Options.new('two', ['one', 'two']) }
+
+    it "returns the key if it exists in the list of options" do
+      expect(options['one']).to eql('one')
+    end
+  end
+
+  context "mixed key types" do
+    let(:options) { OptionPicker::Options.new('two', foo: 'one', bar: 'two') }
+
+    it "finds the matching key" do
+      expect(options['foo']).to eql('one')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'dotenv'
+require 'vcr'
+require 'factory_girl'
+require 'webmock/rspec'
+require 'rspec_structure_matcher'
+
+require File.dirname(__FILE__) + '/../lib/option_picker.rb'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: option_picker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tony Marklove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OptionPicker allows you to create a list of allowed options, and specify
+  a fallback. When given a value the picker will then return the value if it is in
+  the allowed list, otherwise it will return the default value.
+email:
+- tony@new-bamboo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/option_picker.rb
+- lib/option_picker/version.rb
+- option_picker.gemspec
+- spec/lib/option_picker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jjbananas/option_picker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Pick from a list of allowed options, otherwise fallback to a default value.
+test_files:
+- spec/lib/option_picker_spec.rb
+- spec/spec_helper.rb