params_parser 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65ac4c5d0c8151362a66c68801d1403568dc4454
-  data.tar.gz: 845fb07403644501b4eda3ead29c93de9f4411ae
+  metadata.gz: 7dfd65dec2a7653b43626f176d0f0581035abc6c
+  data.tar.gz: f4dcb2b9dec41441888a012d4f15dc50a6c59351
 SHA512:
-  metadata.gz: 95c3a116219fabe8632d6b4c20b22977d8a421a2dd1b5201f2614d4f9b6a3b795a6407de6bad15de8e0c70e0e783d2c87b5cc562d75420ebfeae98cd4f10e3d5
-  data.tar.gz: a6180598c5705f28078f15a4cd360010f538f0edba0254b9d55e11be1b1a97756ad8175a784ac23628bb8531a49b11ad0f3f17ff289cdb223fe79f85dee6268f
+  metadata.gz: 364179505b2f416355f7c0d7b7c60d81c10069a5591bb5f156db510ddec3c9b14e321c0f4607188e91e033b6ff8030bd4a0a79e74558a4353c7075ddc5536b19
+  data.tar.gz: 3cf4d15b751a5ace2e1de99c063904bcc74a781e5d430e6092d8d62c1fc2cfa25258ddf18300f289c911627dd8c0e38a8c17e50a04166f228384904a14fbf89a

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/rails_integration.rb

@@ -0,0 +1,20 @@
+module ParamsParser
+  module RailsIntegration
+    def parse(params)
+      permit(super(permit(params)))
+    end
+
+    private
+
+    def permit(params)
+      case params
+      when ActionController::Parameters
+        params.permit(config.keys)
+      else
+        params
+      end
+    end
+  end
+
+  Parser.prepend RailsIntegration
+end

data/lib/params_parser/version.rb

@@ -1,3 +1,3 @@
 module ParamsParser
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 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"
@@ -21,4 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionpack", "~> 5.2.8.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
 end

data/spec/params_parser/rails_integration_spec.rb

@@ -0,0 +1,21 @@
+require "support/spec_helper"
+
+require "params_parser/rails_integration"
+require "active_support"
+require "action_controller/metal/strong_parameters"
+
+describe ParamsParser::Parser do
+  subject(:params_parser) { ParamsParser::Parser.new(config) }
+
+  describe "#parse" do
+    subject(:parsed) { params_parser.parse(parameters) }
+
+    let(:config) { { configured_key: { } } }
+    let(:parameters) { ActionController::Parameters.new(configured_key: double) }
+
+    it "returns an ActionController::Parameters with permitted keys" do
+      expect(parsed).to be_a ActionController::Parameters
+      expect(parsed).to be_permitted
+    end
+  end
+end

data/spec/support/spec_helper.rb

@@ -1,3 +1,5 @@
 require "rspec"
+require "pry"
 
 require "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.4
 platform: ruby
 authors:
 - Peter Swan
@@ -9,67 +9,113 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2023-03-30 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'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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
+- toddmohney@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/params_parser.rb
+- lib/params_parser/rails_integration.rb
 - lib/params_parser/version.rb
 - params_parser.gemspec
 - spec/params_parser/parser_spec.rb
+- spec/params_parser/rails_integration_spec.rb
 - spec/params_parser/use_cases/nested_parsers_spec.rb
 - spec/support/spec_helper.rb
 homepage: https://github.com/gustly/params_parser
@@ -82,21 +128,22 @@ 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
+rubygems_version: 2.5.1
 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/rails_integration_spec.rb
 - spec/params_parser/use_cases/nested_parsers_spec.rb
 - spec/support/spec_helper.rb