foraneus 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12e7ca9e67520a6b1241639c29cb3490d0143ffe
-  data.tar.gz: 20883eadd4038c4867375eac5f53fd59d39e83b7
+  metadata.gz: 5dd151153010e57f4108ce2e054238b10b2d0b46
+  data.tar.gz: b582478fbb77f95ef5f924b1e7ae2b5bb492c15b
 SHA512:
-  metadata.gz: 36edfb9dec61a50be5dec519f106b8043658c3da5a087e77b9daacccb205946edc4f6f8d14e79d976c7bb6e55d195a0d928967de115d03039566b0cbd38570c9
-  data.tar.gz: 252773ebedc620864d9aaa10181b734f58100bbc3190ea95ca78be7ff531b07edf7cc6582f793062f7577fe374c8e00ee7dbc080ba0e4d30534489c3fed39639
+  metadata.gz: 6a0c78292a5a51eb6d59dbb6000bed04e4669b95e0b3a78b09e84a9d4c302db1a426930a141166291cab1d2b34279a5837625932655f29270e25b7c82abef74f
+  data.tar.gz: c9385cc3522459024a4d68f148dbb08200411099b3d809e85f54d4c51d4ab99bc8a2965466f278b960d093d15e9d0fe929bd687dffd75e5c4e0f24d7a2a1135d

data/README.md

@@ -142,6 +142,73 @@ message is added to the error's `message` attribute.
 Data coming from the inside is assumed to be valid, so `.raw` won't return an instance having
 errors neither being invalid.
 
+## Required fields
+
+Fields can be declared as required.
+
+  ``` ruby
+  class MyForm < Foraneus
+    integer :delay, :required => true
+  end
+  ```
+
+If an external value is not fed into a required field, an error with key 'KeyError' will be assigned.
+
+  ``` ruby
+  form = MyForm.parse
+
+  form.valid?                       # => false
+
+  form[:errors][:delay].key         # => 'KeyError'
+  form[:errors][:delay].message     # => 'required parameter not found: "delay"'
+  ```
+
+## Blank values
+
+By default, any blank value is treated as nil.
+
+  ``` ruby
+  MyForm = Class.new(Foraneus) { string :name }
+
+  MyForm.parse(:name => '').name
+  # => nil
+  ```
+
+This behaviour can be modified by setting opt `blanks_as_nil` to false.
+
+  ``` ruby
+  MyForm = Class.new(Foraneus) { string :name, :blanks_as_nil => false }
+
+  MyForm.parse(:name => '').name
+  # => ''
+  ```
+
+## Default values
+
+Define fields with default values:
+
+  ``` ruby
+  MyForm = Class.new(Foraneus) { string :name, :default => 'Alice' }
+  ```
+
+Parse data from the ouside:
+
+  ``` ruby
+  form = MyForm.parse
+
+  form.name             # => 'Alice'
+  form[:name]           # => nil, data from the outside don't include any value
+  ```
+
+Convert values back from the inside:
+
+  ``` ruby
+  form = MyForm.raw
+
+  form[:name]           # => 'Alice'
+  form.name             # => nil, data from the inside don't include any value
+  ```
+
 ## Installation
 
  - Install `foraneus` as a gem.

data/lib/foraneus.rb

@@ -25,8 +25,8 @@ class Foraneus
   # Declares a boolean field.
   #
   # @param [Symbol] name The name of the field.
-  def self.boolean(name)
-    converter = Foraneus::Converters::Boolean.new
+  def self.boolean(name, *args)
+    converter = Foraneus::Converters::Boolean.new(*args)
     field(name, converter)
   end
 
@@ -69,16 +69,16 @@ class Foraneus
   # Declares a noop field.
   #
   # @param [Symbol] name The name of the field.
-  def self.noop(name)
-    converter = Foraneus::Converters::Noop.new
+  def self.noop(name, *args)
+    converter = Foraneus::Converters::Noop.new(*args)
     field(name, converter)
   end
 
   # Declares a string field.
   #
   # @param [Symbol] name The name of the field.
-  def self.string(name)
-    converter = Foraneus::Converters::String.new
+  def self.string(name, *args)
+    converter = Foraneus::Converters::String.new(*args)
     field(name, converter)
   end
 
@@ -104,28 +104,28 @@ class Foraneus
 
   # Parses data coming from an external source.
   #
-  # @param [Hash<Symbol, String>] raw_data
+  # @param [Hash<Symbol, String>] data External data.
   #
   # @return [Foraneus] An instance of a form.
-  def self.parse(raw_data = {})
+  def self.parse(data = {})
     instance = self.new
 
     parsed_keys = []
 
-    @fields.each do |k, _|
-      given_key = k
-      v = raw_data.fetch(given_key) do |k|
-        given_key = k.to_sym
-        raw_data.fetch(given_key, nil)
+    fields.each do |field, converter|
+      given_key = field
+      v = data.fetch(given_key) do
+        given_key = field.to_sym
+        data.fetch(given_key, nil)
       end
 
       parsed_keys << given_key
-      __parse_raw_datum(instance, given_key, v)
+      __parse_raw_datum(given_key, v, instance, converter)
     end
 
-    raw_data.each do |k, v|
+    data.each do |k, v|
       unless parsed_keys.include?(k)
-        __parse_raw_datum(instance, k, v)
+        instance[k] = v
       end
     end
 
@@ -140,10 +140,19 @@ class Foraneus
   def self.raw(data = {})
     instance = self.new
 
-    data.each do |k, v|
-      next unless fields.has_key?(k.to_s)
-      instance.send("#{k}=", v)
-      converter = fields[k.to_s]
+    fields.each do |field, converter|
+      given_key = field
+
+      v = data.fetch(given_key) do
+        given_key = field.to_sym
+        data.fetch(given_key, nil)
+      end
+
+      instance.send("#{field}=", v)
+
+      if v.nil?
+        v = converter.opts[:default]
+      end
 
       s = if v.nil?
         nil
@@ -151,8 +160,8 @@ class Foraneus
         converter.raw(v)
       end
 
-      instance[k] = s
-      instance.data[k] = v
+      instance[given_key] = s
+      instance.data[given_key] = v
     end
 
     instance
@@ -190,21 +199,19 @@ class Foraneus
 
   # @api private
   #
-  # Parses a raw value and assigns it to the corresponding field.
+  # Parses a value and assigns it to the corresponding field.
   #
   # It also registers errors if the conversion fails.
   #
-  # @param [Foraneus] foraneus
   # @param [String, Symbol] k
   # @param [String] v
-  def self.__parse_raw_datum(foraneus, k, v)
+  # @param [Foraneus] foraneus
+  # @param [Converter] converter
+  def self.__parse_raw_datum(k, v, foraneus, converter)
     field = k.to_s
-    converter = fields[field]
 
     foraneus[k] = v
 
-    return unless converter
-
     if v == '' && converter.opts.fetch(:blanks_as_nil, true)
       v = nil
     end
@@ -212,7 +219,7 @@ class Foraneus
     if v.nil? && converter.opts[:required]
       raise KeyError, "required parameter not found: #{field.inspect}"
     elsif v.nil?
-      v = nil
+      v = converter.opts[:default]
     else
       v = converter.parse(v)
     end

data/spec/lib/foraneus_spec.rb

@@ -101,7 +101,7 @@ describe Foraneus do
       it { should be_valid }
     end
 
-    context 'when a field is declared as allow blanks = true' do
+    context 'when a field is declared as blanks_as_nil = true' do
       let(:converter) { Foraneus::Converters::String.new(:blanks_as_nil => true) }
 
       subject(:form) { form_spec.parse(:delay => '') }
@@ -178,6 +178,38 @@ describe Foraneus do
         it { should_not be_valid }
 
         its(:delay) { should be_nil }
+
+        its([:delay]) { should be_nil }
+      end
+    end
+
+    context 'when default value' do
+      let(:converter) { Foraneus::Converters::Integer.new(:default => 1) }
+
+      subject(:form) { form_spec.parse }
+
+      it { should be_valid }
+
+      its(:delay) { should eq(1) }
+
+      its(:data) { should include(:delay => 1) }
+
+      its([:delay]) { should be_nil}
+
+      its([]) { should include(:delay => nil) }
+
+      its([:errors]) { should_not include(:delay) }
+
+      context 'when missing required field' do
+        let(:converter) { Foraneus::Converters::Integer.new(:default => 1, :required => true) }
+
+        subject(:form) { form_spec.parse }
+
+        it { should_not be_valid }
+
+        its(:delay) { should be_nil }
+
+        its([:delay]) { should be_nil }
       end
     end
   end
@@ -220,5 +252,17 @@ describe Foraneus do
 
       its([]) { should include('delay' => nil) }
     end
+
+    context 'when default value' do
+      let(:converter) { Foraneus::Converters::Integer.new(:default => 1) }
+
+      subject(:form) { form_spec.raw }
+
+      its(:delay) { should be_nil }
+
+      its([:delay]) { should eq('1') }
+
+      its([]) { should include(:delay => '1') }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foraneus
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Gianfranco Zas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-30 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec