simple_params 0.0.1pre2 → 0.0.2.pre1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzljZWZmNDczMjI4ZDk5ZDg2NmYxNzRlNzQ5ZjhjNDU4YjJhMmVjNw==
+    MzEzZDlkYmYyYWJmZjI3NWI4OTg3ZTFhMjJiYmQzYjAwYjIwNmY1YQ==
   data.tar.gz: !binary |-
-    ZWQ0MGE5MjE4NmQ4MDUxYzMxNmUwMjM4ZWU4NDk0YWQyYTJkNWZmNw==
+    MzViNGIyYmIxY2EyMDU4MzY0MmU1NTA3N2FiYzY1MWIxODJhYzNmNA==
 SHA512:
   metadata.gz: !binary |-
-    ODJkOTE3YzRjNTUzOGQ3ZGE0MDFlYzg5Mzc3YzNjMmI4NDJlZTA4OGZlYzkw
-    MDkzZDlmMmNkZjY1YmZlNjc0OGJhZTk2MGJiNTEwMjc0NDcyZWFmNzJiMmZi
-    MjVlNzFjZTU0NWY0NGY5ODg5M2RmYmQ0MTQ0ZjNhMTgzMTQ3ZjU=
+    MTlhMzg1OTVlZTE2YjQ0YzcxOWY5YTYzZjg5NDQzYmJkZTU1YjY5Y2NlM2Vm
+    NjgwMzEyYjA2Mjg5ZTQ0MTJjYTgyN2JkOWNlMDI2MDgxMTc2ZjMzNzI5ZTMz
+    YTg5MzUyMmRmYzc2N2RmODk2MDZlOWM5NzcyZGViZTUzMGRmMmQ=
   data.tar.gz: !binary |-
-    NDhlYzBmNDhlOGYzYjIyNzY2NDQ2ZmViNmFmOTA2YzQ1NmViNGJlOTEwOTg1
-    OTc4ODg2NDlmYzRkZGRlY2M4NTdjYTBhZjE0NWMzMWRmNTgwZWRmNjI5ZGY5
-    ZjFkY2I1MzliODY4Y2Q2N2I5ODVmYWM5ZDBmNDc4MzRiOWY2OTQ=
+    NDZmZmUzMWI4NGRhZmFjM2IxZTczOTNhMWVkODBhZTFkM2Y3Y2ZkMjU3YThi
+    NWQxOWNkYzQwYjhhZGFhMDYwMjM3MWNmMTU1ZmIxNTJiOTUwM2FlM2I0NWJm
+    ZDVlMjIzMGYyN2UyYTc0Y2FkZjI3ZDcxZmJkMjYxYmU2NWM4MDQ=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_params (0.0.1pre)
+    simple_params (0.0.1pre2)
       activemodel (>= 3.0, < 5.0)
       virtus (>= 1.0.0)
 

data/lib/simple_params/formatters.rb

@@ -0,0 +1,41 @@
+require "active_model"
+
+module SimpleParams
+  module Formatters
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def _formatters
+        @_formatters || {}
+      end
+
+      def format(attribute, formatter)
+        @_formatters ||= {}
+        @_formatters[attribute.to_sym] = formatter
+      end
+    end
+
+    def run_formatters
+      _formatters.each do |attribute, method|
+        value = send(attribute.to_sym)
+        unless value.blank?
+          out = evaluate_proc_or_method(attribute, method, value)
+          send("#{attribute.to_sym}=", out)
+        end
+      end
+    end
+
+    private
+    def evaluate_proc_or_method(attribute, method, value)
+      if method.is_a?(Proc)
+        method.call(self, value)
+      else
+        self.send(method)
+      end
+    end
+
+    def _formatters
+      self.class._formatters || {}
+    end
+  end
+end

data/lib/simple_params/params.rb

@@ -6,6 +6,7 @@ module SimpleParams
     include Virtus.model
     include ActiveModel::Validations
     include SimpleParams::Validations
+    include SimpleParams::Formatters
 
     class << self
       TYPE_MAPPINGS = {
@@ -16,8 +17,7 @@ module SimpleParams
         date: Time,
         time: DateTime,
         float: Float,
-        # See note on Virtus
-        boolean: Axiom::Types::Boolean,
+        boolean: Axiom::Types::Boolean, # See note on Virtus
         array: Array,
         hash: Hash
       }
@@ -31,6 +31,7 @@ module SimpleParams
       def param(name, opts={})
         define_attribute(name, opts)
         add_validations(name, opts)
+        add_formatters(name, opts)
       end
 
       def nested_hash(name, opts={}, &block)
@@ -63,6 +64,13 @@ module SimpleParams
         validates name, validations unless validations.empty?
       end
 
+      def add_formatters(name, opts = {})
+        formatter = opts[:format]
+        unless formatter.nil?
+          format name, formatter
+        end
+      end
+
       def define_nested_class(&block)
         Class.new(Params).tap do |klass|
           name_function = Proc.new {
@@ -83,6 +91,7 @@ module SimpleParams
       @errors = SimpleParams::Errors.new(self, @nested_params)
       initialize_nested_classes
       set_accessors(params)
+      run_formatters
       # This method comes from Virtus
       # virtus/lib/virtus/instance_methods.rb
       set_default_attributes

data/lib/simple_params/version.rb

@@ -1,3 +1,3 @@
 module SimpleParams
-  VERSION = "0.0.1pre2"
+  VERSION = "0.0.2.pre1"
 end

data/lib/simple_params.rb

@@ -1,4 +1,5 @@
 require 'simple_params/version'
+require 'simple_params/formatters'
 require 'simple_params/errors'
 require 'simple_params/validations'
 require 'simple_params/params'

data/spec/formatters_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe SimpleParams::Formatters do
+  class Racecar
+    include SimpleParams::Formatters
+
+    def initialize(params={})
+      params.each { |k,v| send("#{k}=",v) }
+      run_formatters
+    end
+
+    attr_accessor :make, :model
+
+    format :make, :strip_make_whitespace
+    format :model, lambda { |car, model| model.upcase }
+
+    def strip_make_whitespace
+      self.make.strip
+    end
+  end
+
+  describe "formatting with Procs" do
+    it "does not break if initial attribute is nil" do
+      car = Racecar.new
+      car.model.should be_nil
+    end
+
+    it "formats attribute on initialize" do
+      car = Racecar.new(make: "porsche", model: "boxster")
+      car.model.should eq("BOXSTER")
+    end
+  end
+
+  describe "formatting with methods" do
+    it "does not break if initial attribute is nil" do
+      car = Racecar.new
+      car.make.should be_nil
+    end
+
+    it "formats attribute on initialize" do
+      car = Racecar.new(make: "  Porsche     ")
+      car.make.should eq("Porsche")
+    end
+  end
+end

data/spec/params_spec.rb

@@ -4,25 +4,33 @@ 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"] }}
+  decimal_param :amount, optional: true, default: 0.10, format: lambda { |params, param| param.round(2) }
+  param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}, format: :lower_case_colors
 
   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"
+    param :state, default: "North Carolina", format: :transform_state_code
+
+    def transform_state_code
+      state == "SC" ? "South Carolina" : state
+    end
   end
 
   nested_hash :phone do
     boolean_param :cell_phone, default: true
-    string_param :phone_number, validations: { length: { in: 7..10 } }
+    string_param :phone_number, validations: { length: { in: 7..10 } }, format: lambda { |params, attribute| attribute.gsub(/\D/, "") }
     string_param :area_code, default: lambda { |params, param| 
       if params.phone_number.present? 
         params.phone_number[0..2] 
       end
     }
   end
+
+  def lower_case_colors
+    color.downcase
+  end
 end
 
 describe SimpleParams::Params do
@@ -188,7 +196,7 @@ describe SimpleParams::Params do
         params.first_initial.should eq("T")
       end
 
-      describe "nested params", failing: true do
+      describe "nested params" do
         it "sets default values on initialization without key" do
           params = DummyParams.new
           params.phone.area_code.should be_nil
@@ -212,4 +220,34 @@ describe SimpleParams::Params do
       end
     end
   end
+
+  describe "formatters", formatters: true do
+    describe "Proc formatters" do
+      it "formats on initialization" do
+        params = DummyParams.new(amount: 0.1234)
+        params.amount.should eq(0.12)
+      end
+
+      describe "nested params" do
+        it "formats on initialization" do
+          params = DummyParams.new(phone: { phone_number: "818-555-9988" })
+          params.phone.phone_number.should eq("8185559988")
+        end
+      end
+    end
+
+    describe "method formatters" do
+      it "formats on initialization" do
+        params = DummyParams.new(color: "BLUE")
+        params.color.should eq("blue")
+      end
+
+      describe "nested params" do
+        it "formats on initialization" do
+          params = DummyParams.new(address: { state: "SC" })
+          params.address.state.should eq("South Carolina")
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_params
 version: !ruby/object:Gem::Version
-  version: 0.0.1pre2
+  version: 0.0.2.pre1
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -101,12 +101,14 @@ files:
 - README.md
 - lib/simple_params.rb
 - lib/simple_params/errors.rb
+- lib/simple_params/formatters.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/formatters_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/brycesenz/simple_params
@@ -136,5 +138,6 @@ summary: A DSL for specifying params, including type coercion and validation
 test_files:
 - spec/acceptance_spec.rb
 - spec/errors_spec.rb
+- spec/formatters_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb