params_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d24234708daa8a03a4abed4d0a508f6a8e0ab848
+  data.tar.gz: 80ab678e77efac3da06f05ab08db29dad02d8460
+SHA512:
+  metadata.gz: 821ea85578fcd59e18bc68e50f013e49c9583455fdd1b65ec594284ec2ffb0979a219401b223949b9d1464d45d995d72b70b3bd5a9f8e6d8c01a823c461016ba
+  data.tar.gz: 4195539451e165ada152bf02df604633c68022dda2d1c29426c5f2db71d4d8c3c286920492e815acae3f856648672497cfea6681ac915701ff77b525ece77b7f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Swan
+
+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,29 @@
+# ParamsParser
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'params_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install params_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/gustly/params_parser/fork )
+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/params_parser.rb

@@ -0,0 +1,54 @@
+module ParamsParser
+  module Transforms
+    ID = lambda { |x| x }.freeze
+  end
+
+  class Parser
+    def initialize(config)
+      @config = Hash[config.map do |(key, param_config)|
+        [key, ParamConfig.new(key, param_config)]
+      end]
+    end
+
+    def parse(params)
+      params.class.new.tap do |parsed_params|
+        config.each do |(key, param_config)|
+          if params[key]
+            parsed_params[param_config.key] = param_config.transform.call(params[key])
+          end
+
+          parsed_params[param_config.key] ||= param_config.default if param_config.has_default?
+        end
+      end
+    end
+
+    def to_proc
+      public_method(:parse)
+    end
+
+    private
+
+    attr_reader :config
+  end
+
+  class ParamConfig
+    def initialize(key, config)
+      @config = config
+      @transform = config.fetch(:transform, Transforms::ID)
+      @key = config.fetch(:map_to, key)
+      @default = config[:default]
+    end
+
+    attr_reader :transform
+    attr_reader :key
+    attr_reader :default
+
+    def has_default?
+      config.has_key?(:default)
+    end
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/params_parser/version.rb

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

data/params_parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'params_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "params_parser"
+  spec.version       = ParamsParser::VERSION
+  spec.authors       = ["Peter Swan", "Todd Mohney"]
+  spec.email         = ["pdswan@gmail.com", "todd@gust.com"]
+  spec.summary       = %q{Parse Parameters with key mapping, transformation, and defaults.}
+  spec.description   = %q{Parse Parameters with key mapping, transformation, and defaults.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+end

data/spec/params_parser/parser_spec.rb

@@ -0,0 +1,88 @@
+require "support/spec_helper"
+
+describe ParamsParser::Parser do
+  subject(:params_parser) { ParamsParser::Parser.new(config) }
+
+  describe "#to_proc" do
+    let(:config) { { } }
+    specify { expect(params_parser.to_proc).to eq(params_parser.public_method(:parse)) }
+  end
+
+  describe "#parse" do
+    subject(:parsed) { params_parser.parse(parameters) }
+
+    describe "limiting keys in the parameters" do
+      let(:config) { { configured_key: { } } }
+      let(:parameters) { { not_configured_key: double } }
+
+      it "discards unconfigured keys" do
+        expect(parsed.keys).to_not include(:not_configured_key)
+      end
+    end
+
+    describe "mapping keys" do
+      let(:config) { { a: { map_to: :b } } }
+      let(:parameters) { { a: double(:value_at_a) } }
+
+      specify do
+        expect(parsed).to_not have_key(:a)
+        expect(parsed[:b]).to eq(parameters[:a])
+      end
+    end
+
+    describe "transforms" do
+      context "the key has a transform" do
+        let(:config) { { int: { transform: :to_i.to_proc } } }
+        let(:parameters) { { int: "10" } }
+
+        it "transforms the value using the transform callable" do
+          expect(parsed[:int]).to eq(10)
+        end
+      end
+    end
+
+    describe "defaults" do
+      context "a default is not specified" do
+        let(:config) { { key_without_default: { } } }
+
+        context "the key is not in the parameters" do
+          let(:parameters) { { } }
+
+          it "does not add the key to the parameters" do
+            expect(parsed).to_not include(:key_without_default)
+          end
+        end
+      end
+
+      context "a default is specified" do
+        let(:default) { double(:default) }
+        let(:config) { { key_with_default: { default: default } } }
+
+        context "the key is not in the parameters" do
+          let(:parameters) { { } }
+
+          it "sets the parameter to the default" do
+            expect(parsed[:key_with_default]).to eq(default)
+          end
+        end
+
+        context "the key is in the parameters, but falsey" do
+          let(:parameters) { { key_with_default: nil } }
+
+          it "sets the parameter to the default" do
+            expect(parsed[:key_with_default]).to eq(default)
+          end
+        end
+
+        context "the key is in the parameters, but the transform returns a falsey value" do
+          let(:config) { { key_with_default: { default: default, transform: proc { nil } } } }
+          let(:parameters) { { key_with_default: double(:anything) } }
+
+          it "sets the parameter to the default" do
+            expect(parsed[:key_with_default]).to eq(default)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/params_parser/use_cases/nested_parsers_spec.rb

@@ -0,0 +1,36 @@
+require "support/spec_helper"
+
+describe "Nested Parsers" do
+  subject(:parser) { ParamsParser::Parser.new(config) }
+
+  let(:config) do
+    {
+      a: { transform: :upcase.to_proc },
+      b: {
+        transform: ParamsParser::Parser.new(
+            c: { default: "c" },
+            d: { transform: :upcase.to_proc }
+          ).to_proc
+      }
+    }
+  end
+
+  let(:params) do
+    {
+      a: "a",
+      b: {
+        d: "d"
+      }
+    }
+  end
+
+  specify do
+    expect(parser.parse(params)).to eq({
+      a: "A",
+      b: {
+        c: "c",
+        d: "D"
+      }
+    })
+  end
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rspec"
+
+require "params_parser"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: params_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Swan
+- Todd Mohney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+description: Parse Parameters with key mapping, transformation, and defaults.
+email:
+- pdswan@gmail.com
+- todd@gust.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/params_parser.rb
+- lib/params_parser/version.rb
+- params_parser.gemspec
+- spec/params_parser/parser_spec.rb
+- spec/params_parser/use_cases/nested_parsers_spec.rb
+- spec/support/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Parse Parameters with key mapping, transformation, and defaults.
+test_files:
+- spec/params_parser/parser_spec.rb
+- spec/params_parser/use_cases/nested_parsers_spec.rb
+- spec/support/spec_helper.rb