simple_params 0.0.1pre2

data/spec/params_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+class DummyParams < SimpleParams::Params
+  string_param :name
+  integer_param :age, optional: true
+  string_param :first_initial, default: lambda { |params, param| params.name[0] if params.name.present? }
+  decimal_param :amount, optional: true, default: 0.10
+  param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}
+
+  nested_hash :address do
+    string_param :street
+    string_param :city, validations: { length: { in: 4..40 } }
+    string_param :zip_code, optional: true, validations: { length: { in: 5..9 } }
+    param :state, default: "North Carolina"
+  end
+
+  nested_hash :phone do
+    boolean_param :cell_phone, default: true
+    string_param :phone_number, validations: { length: { in: 7..10 } }
+    string_param :area_code, default: lambda { |params, param| 
+      if params.phone_number.present? 
+        params.phone_number[0..2] 
+      end
+    }
+  end
+end
+
+describe SimpleParams::Params do
+  describe "accessors", accessors: true do
+    let(:params) { DummyParams.new }
+
+    it "has getter and setter methods for required param" do
+      params.should respond_to(:name)
+      params.name.should be_nil
+      params.name = "Tom"
+      params.name.should eq("Tom")
+    end
+    
+    it "has getter and setter methods for optional param" do
+      params.should respond_to(:age)
+      params.name.should be_nil
+      params.age = 19
+      params.age.should eq(19)
+    end
+
+    describe "nested params", nested: true do
+      it "has getter and setter methods for required param" do
+        params.address.should respond_to(:street)
+        params.address.street.should be_nil
+        params.address.street = "1 Main St."
+        params.address.street.should eq("1 Main St.")
+      end
+      
+      it "has getter and setter methods for optional param" do
+        params.address.should respond_to(:zip_code)
+        params.address.zip_code.should be_nil
+        params.address.zip_code = "20165"
+        params.address.zip_code.should eq("20165")
+      end
+    end
+  end
+
+  describe "array syntax", array_syntax: true do
+    let(:params) do 
+      DummyParams.new(
+        name: "Bill", 
+        age: 30, 
+        address: { 
+          city: "Greenville" 
+        } 
+      )
+    end
+
+    it "can access 'name' through array syntax" do
+      params[:name].should eq("Bill")
+      params["name"].should eq("Bill")
+    end
+
+    it "can set 'name' through array syntax" do
+      params[:name] = "Tom"
+      params[:name].should eq("Tom")
+      params["name"].should eq("Tom")
+    end
+
+    it "can access 'age' through array syntax" do
+      params[:age].should eq(30)
+      params["age"].should eq(30)
+    end
+
+    it "can set 'age' through array syntax" do
+      params[:age] = 42
+      params[:age].should eq(42)
+      params["age"].should eq(42)
+    end
+
+    describe "nested params", nested: true do
+      it "can access 'city' through array syntax" do
+        params[:address][:city].should eq("Greenville")
+        params["address"]["city"].should eq("Greenville")
+      end
+
+      it "can set 'city' through array syntax" do
+        params[:address][:city] = "Asheville"
+        params[:address][:city].should eq("Asheville")
+        params["address"]["city"].should eq("Asheville")
+      end
+    end
+  end
+
+  describe "coercion", coercion: true do
+    it "coerces values on initialization" do
+      params = DummyParams.new(age: "42")
+      params.age.should eq(42)
+    end
+
+    it "coerces values from setters" do
+      params = DummyParams.new
+      params.age = "42"
+      params.age.should eq(42)
+    end
+
+    it "coerces nested attributes on initialization" do
+      params = DummyParams.new(address: { zip_code: 90210 })
+      params.address.zip_code.should eq("90210")
+    end      
+
+    it "coerces nested attributes from setters" do
+      params = DummyParams.new
+      params.address.zip_code = 90210
+      params.address.zip_code.should eq("90210")
+    end      
+  end
+
+  describe "defaults", defaults: true do
+    describe "simple defaults" do
+      it "sets default values on initialization without key" do
+        params = DummyParams.new
+        params.amount.should eq(0.10)
+      end
+
+      it "sets default values on initialization with nil value" do
+        params = DummyParams.new(amount: nil)
+        params.amount.should eq(0.10)
+      end
+
+      it "sets default values on initialization with blank value" do
+        params = DummyParams.new(amount: "")
+        params.amount.should eq(0.10)
+      end
+
+      describe "nested params" do
+        it "sets default values on initialization without key" do
+          params = DummyParams.new
+          params.phone.cell_phone.should be_truthy
+        end
+
+        it "sets default values on initialization with nil value" do
+          params = DummyParams.new(phone: { cell_phone: nil })
+          params.phone.cell_phone.should be_truthy
+        end
+
+        it "sets default values on initialization with blank value" do
+          params = DummyParams.new(phone: { cell_phone: "" })
+          params.phone.cell_phone.should be_truthy
+        end
+      end
+    end
+
+    describe "Proc defaults" do
+      it "sets default values on initialization without key" do
+        params = DummyParams.new
+        params.first_initial.should be_nil
+        params = DummyParams.new(name: "Tom")
+        params.first_initial.should eq("T")
+      end
+
+      it "sets default values on initialization with nil value" do
+        params = DummyParams.new
+        params.first_initial.should be_nil
+        params = DummyParams.new(name: "Tom", first_initial: nil)
+        params.first_initial.should eq("T")
+      end
+
+      it "sets default values on initialization with blank value" do
+        params = DummyParams.new
+        params.first_initial.should be_nil
+        params = DummyParams.new(name: "Tom", first_initial: "")
+        params.first_initial.should eq("T")
+      end
+
+      describe "nested params", failing: true do
+        it "sets default values on initialization without key" do
+          params = DummyParams.new
+          params.phone.area_code.should be_nil
+          params = DummyParams.new(phone: { phone_number: "8185559988" })
+          params.phone.area_code.should eq("818")
+        end
+
+        it "sets default values on initialization with nil value" do
+          params = DummyParams.new
+          params.phone.area_code.should be_nil
+          params = DummyParams.new(phone: { phone_number: "8185559988", area_code: nil })
+          params.phone.area_code.should eq("818")
+        end
+
+        it "sets default values on initialization with blank value" do
+          params = DummyParams.new
+          params.phone.area_code.should be_nil
+          params = DummyParams.new(phone: { phone_number: "8185559988", area_code: "" })
+          params.phone.area_code.should eq("818")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simple_params'
+
+spec = Gem::Specification.find_by_name("simple_params")
+gem_root = spec.gem_dir
+Dir[("#{gem_root}/spec/support/**/*.rb")].each {|f| require f}
+I18n.config.enforce_available_locales = true
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: simple_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1pre2
+platform: ruby
+authors:
+- brycesenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Simple way to specify API params
+email:
+- bryce.senz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/simple_params.rb
+- lib/simple_params/errors.rb
+- lib/simple_params/params.rb
+- lib/simple_params/validations.rb
+- lib/simple_params/version.rb
+- simple_params.gemspec
+- spec/acceptance_spec.rb
+- spec/errors_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brycesenz/simple_params
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A DSL for specifying params, including type coercion and validation
+test_files:
+- spec/acceptance_spec.rb
+- spec/errors_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb