simple_params 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTg5ZjU4NGE5ODRkMmYwMDNlY2E5OTM2ZjgwYTcyYjJlYzk2YTM1MQ==
+    ZWM1MGE4MTFhODA2YzgzZDFiNDFmNGIxZjFiNTIxMzI4ZDNjOTg5OQ==
   data.tar.gz: !binary |-
-    OWQ1ODFkYzljM2I5ZmNlOGYwZGU5Mzc3ZTY1Y2I5ZjRiNGMxMzJjMw==
+    MGJlNGI0MDM4MGFlZTA5NDUwZTBhYTdhNDRhMmI5YzYwYTRhMTBhNw==
 SHA512:
   metadata.gz: !binary |-
-    NjhjZTMzNmUwNzc5NTg5NmNhODQxYjhlYzBiZThjNGVkMWExZDc2NzM4NDI5
-    NzUwNjhhMzExNGFjYzg0NjVlOWE0MzRhNDEwNzAyNzZhZGYyY2ZlMDdmMDFm
-    M2NjZWI2OGM0NWU0ZmYxMWVlYTMzZmM5YTcxZDJkZjQ1YzhjMWU=
+    NGJmZDhjNDYxOWYxZjc0ODk5OGMwNjdmNDQwMGE4NDgyZjg4NGU3MDkwODdl
+    NmQ4YTFhNGNiNzUyYTMzODFmODVlYzgzYmU4MzdkYjY5MmIxNGMxMDJiMzZk
+    OWYyZDVmNDc5N2JjZjAwMzEwMWEzZjZkOTdlNjY4ZTA2NzNmNDY=
   data.tar.gz: !binary |-
-    MjhkZWI0OWVkYTQyMjIwYzk0OTRhNGNjNjM5NTMwMTFmYmYzZjA1ODdlZDRj
-    MmU4ZGZkZTAwN2IwZTcyNTgyMDQ1YTY2ODNhMjFiYTViZWFlMDA2NjAzOWFl
-    YTE3OWZkZmNhMGE4ZTIyMjk0Nzk2ZjNhY2JmYmYyMzIzYTc4MWQ=
+    MWY2OGU5NmUyM2Y5ZWY1YmExYWY5NTkxOTc2ZDk2ZjUwNTNjZGRlNTFlMGJm
+    NjVmN2ZkZTdhNDM1M2RjNDY1YjY2ZjYyMWJiY2M5MmVmY2YyYjk0YTA1YzI5
+    ODczNjgzMjhmNjIwNzBmNDY0ZmYwNDVlMmEyZmE5ZTY0NWY1ZDE=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_params (0.0.3)
+    simple_params (0.0.4)
       activemodel (>= 3.0, < 5.0)
       shoulda-matchers (~> 2.8)
       virtus (>= 1.0.0)

data/README.md

@@ -96,6 +96,20 @@ params.errors.as_json #=> {:name=>["can't be blank"], :address=>{:street=>["can'
 params.address.errors.as_json #=> {:street=>["can't be blank"]}
 ```
 
+Custom validate methods can also be added, just as with an ActiveModel object
+```ruby
+class MyParams < SimpleParams::Params
+  param :name
+  validate :name_has_letters
+
+  def name_has_letters
+    if name.present? && !(name =~ /^[a-zA-Z]*$/)
+      errors.add(:name, "must only contain letters")
+    end
+  end
+end
+```
+
 ## Defaults
 
 It is easy to set simple or complex defaults, with either a static value or a Proc
@@ -238,6 +252,153 @@ RSpec.configure do |config|
 end
 ```
 
+# Testing with Validation Matchers
+
+Simple Params includes the following validation matchers:
+CoercionMatcher, FormatMatcher, NestedParameterMatcher, OptionalParameterMatcher, and RequiredParameterMatcher
+
+#CoercionMatcher
+
+Example:
+
+Class to test
+
+```ruby
+  class YourClass < SimpleParams::Params
+    param :name, type: :string
+    param :expiration_date, type: :date
+    param :amount, type: :integer
+  end
+```
+Test using Coercion Matcher
+
+```ruby
+  describe YourClass do
+    it { should coerce_param(:name).into(:string) }
+    it { should_not coerce_param(:name).into(:integer) }
+    it { should coerce_param(:expiration_date).into(:date) }
+    it { should_not coerce_param(:expiration_date).into(:string) }
+    it { should coerce_param(:amount).into(:integer) }
+    it { should_not coerce_param(:amount).into(:float) }
+  end
+```
+
+#FormatMatcher
+
+Example:
+
+Class to test
+
+```ruby
+  class YourClass < SimpleParams::Params
+    param :amount, type: :float, formatter: lambda { |params, amt| sprintf('%.2f', amt) }
+    param :expiration_date, type: :date, formatter: lambda { |params, date| date.strftime("%Y-%m")}
+    param :cost, type: :float, formatter: lambda { |params, amt| sprintf('%.2f', amt) }
+  end
+```
+Test using FormatMatcher
+
+```ruby
+describe YourClass do
+  it { should format(:amount).with_value(10).into("10.00") }
+  it { should format(:expiration_date).with_value(Date.new(2014, 2, 4)).into("2014-02") }
+  it { should_not format(:cost).with_value(12).into("14.00") }
+end
+```
+
+#NestedParameterMatcher
+
+Example:
+
+Class to test
+
+```ruby
+  class YourClass < SimpleParams::Params
+    param :name
+    param :age, optional: true, default: 37
+    param :title, optional: true, default: "programmer"
+    param :account_type, default: "checking", validations: { inclusion: { in: ["checking", "savings"] }}
+    param :account_status, optional: true, validations: { inclusion: { in: ["active", "inactive"] }}
+    nested_param :billing_address do
+      param :first_name
+      param :last_name
+      param :company, optional: true
+      param :street
+      param :city
+      param :state
+      param :zip_code
+      param :country
+    end
+```
+
+Test using NestedParameterMatcher
+
+```ruby
+describe YourClass do 
+  it { should have_nested_parameter(:billing_address) }
+  it { should_not have_nested_parameter(:broken) } 
+end
+```
+
+Note that OptionalParameterMatcher and RequiredParameterMatcher have with_default and with_allowed_values options
+
+#OptionalParameterMatcher
+
+Example:
+
+Class to test
+
+```ruby
+class YourClass < SimpleParams::Params
+    param :name
+    param :age, optional: true, default: 37
+    param :title, optional: true, default: "programmer"
+    param :account_type, default: "checking", validations: { inclusion: { in: ["checking", "savings"] }}
+    param :account_status, optional: true, validations: { inclusion: { in: ["active", "inactive"] }}
+  end
+```
+
+Test using OptionalParameterMatcher
+
+```ruby
+describe YourClass do
+  it { should_not have_optional_parameter(:name) }
+  it { should have_optional_parameter(:age).with_default(37) }
+  it { should have_optional_parameter(:title).with_default("programmer") }
+  it { should have_optional_parameter(:account_status).with_allowed_values("active", "inactive") }
+  it { should have_optional_parameter(:account_type).with_default("checking").with_allowed_values("checking", "savings") }
+end
+```
+
+#RequiredParameterMatcher
+
+Example:
+
+Class to test
+
+```ruby
+class YourClass < SimpleParams::Params
+    param :name
+    param :age, optional: true
+    param :title, default: "programmer"
+    param :account_type, validations: { inclusion: { in: ["checking", "savings"] }}
+    param :account_status, default: "active", validations: { inclusion: { in: ["active", "inactive"] }}
+  end
+```
+
+Test using RequiredParameterMatcher
+
+```ruby
+describe YourClass do
+  it { should have_required_parameter(:name) }
+  it { should_not have_required_parameter(:age) }
+  it { should_not have_required_parameter(:name).with_default("Matthew") }
+  it { should have_required_parameter(:title).with_default("programmer") }
+  it { should have_required_parameter(:account_type).with_allowed_values("checking", "savings") }
+  it { should have_required_parameter(:account_status).with_default("active").with_allowed_values("active", "inactive") }
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/simple_params/version.rb

@@ -1,3 +1,3 @@
 module SimpleParams
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/acceptance_spec.rb

@@ -5,6 +5,7 @@ class AcceptanceParams < SimpleParams::Params
   param :name
   param :age, type: :integer, optional: true, validations: { inclusion: { in: 18..100 } }
   param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}
+  validate :name_has_letters
 
   nested_hash :address do
     param :street
@@ -12,6 +13,12 @@ class AcceptanceParams < SimpleParams::Params
     param :zip_code, optional: true
     param :state, default: "North Carolina"
   end
+
+  def name_has_letters
+    if name.present? && !(name =~ /^[a-zA-Z]*$/)
+      errors.add(:name, "must only contain letters")
+    end
+  end
 end
 
 describe SimpleParams::Params do
@@ -138,6 +145,12 @@ describe SimpleParams::Params do
       params.errors[:name].should eq(["can't be blank"])
     end
 
+    it "runs custom validate methods" do
+      params.name = "!!!"
+      params.should_not be_valid
+      params.errors[:name].should eq(["must only contain letters"])
+    end
+
     it "does not validate presence of optional param" do
       params.should_not be_valid
       params.errors[:age].should be_empty

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_params
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel