params_parser 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65ac4c5d0c8151362a66c68801d1403568dc4454
-  data.tar.gz: 845fb07403644501b4eda3ead29c93de9f4411ae
+  metadata.gz: 9eb4ae51a6a24883fc83cca6cc81483fb531bfbf
+  data.tar.gz: c05f3cc5c711990fb3f0d6ecce1461c2a51465e1
 SHA512:
-  metadata.gz: 95c3a116219fabe8632d6b4c20b22977d8a421a2dd1b5201f2614d4f9b6a3b795a6407de6bad15de8e0c70e0e783d2c87b5cc562d75420ebfeae98cd4f10e3d5
-  data.tar.gz: a6180598c5705f28078f15a4cd360010f538f0edba0254b9d55e11be1b1a97756ad8175a784ac23628bb8531a49b11ad0f3f17ff289cdb223fe79f85dee6268f
+  metadata.gz: f4d7d9f6369aff44e1491860240b03c8315bc580af12b08bce6c26f96a1302c2f37458b01c59fed7da94dcd975aa63e53174c2e9cd9611664e8362d8420b2384
+  data.tar.gz: 1f0d06dfd1a815a00fc5ae61feefd6730086e5e56cabe252f5b31860d15de8ea85f70ca51841cfe3be25adb0a978a1fc47efe00faabeb679e6945bfc8d8080f3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2
+  - ruby-head

data/README.md

@@ -1,6 +1,15 @@
+[![Build Status](https://travis-ci.org/gustly/params_parser.svg?branch=master)](https://travis-ci.org/gustly/params_parser)
+
 # ParamsParser
 
-TODO: Write a gem description
+`ParamsParser` is a simple gem to help - you guessed it - parse parameter hashes.
+
+`ParamsParser` currently supports:
+
+* defaults
+* transformations
+* mapping input keys to output keys
+
 
 ## Installation
 
@@ -18,7 +27,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a parser with a configuration hash:
+
+```ruby
+parser = ParamsParser::Parser.new({
+  id: { transform: Model.public_method(:find), map_to: :model }
+  page: { default: 1, transform: :to_i.to_proc }
+})
+```
+
+Parse parameters:
+
+```ruby
+parser.parse({        # {
+  id: "1",            #   model: Model(...),
+  page: "5"           #   page: 5
+})                    # }
+```
+
+```ruby
+parser.parse({        # {
+  id: "1",            #   model: Model(...),           
+})                    #   page: 1
+                      # }
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/params_parser/version.rb

@@ -1,3 +1,3 @@
 module ParamsParser
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/params_parser.gemspec

@@ -7,7 +7,7 @@ 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.email         = ["pdswan@gmail.com", "toddmohney@gmail.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      = "https://github.com/gustly/params_parser"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: params_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Swan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,12 +56,14 @@ dependencies:
 description: Parse Parameters with key mapping, transformation, and defaults.
 email:
 - pdswan@gmail.com
-- todd@gust.com
+- toddmohney@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md