formeze 1.8.0 → 1.9.0

data/README.md

@@ -83,7 +83,7 @@ Field options
 -------------
 
 By default fields cannot be blank, they are limited to 64 characters,
-and they cannot contain newlines. These restrictions can be overrided
+and they cannot contain newlines. These restrictions can be overridden
 by setting various field options.
 
 Defining a field without any options works well for a simple text input.
@@ -94,6 +94,21 @@ it by setting the `char_limit` option. For example:
 field :title, char_limit: 200
 ```
 
+Specify the `required` option to make the field optional, i.e. the value
+of the field can be blank/empty. For example:
+
+```ruby
+field :title, required: false
+```
+
+To make it easy to integrate with your application you might want to return
+a different value for blank fields, such as nil, zero, or a "null" object.
+Use the `blank` option to specify this behaviour. For example:
+
+```ruby
+field :title, required: false, blank: nil
+```
+
 If you are dealing with textareas (i.e. multiple lines of text) then you can
 set the `multiline` option to allow newlines. For example:
 

data/formeze.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '1.8.0'
+  s.version = '1.9.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']

data/lib/formeze.rb

@@ -18,13 +18,13 @@ module Formeze
       @name, @options = name, options
     end
 
-    def scrub(value)
-      Formeze.scrub(value, @options[:scrub])
-    end
+    def validate(value, form)
+      value = Formeze.scrub(value, @options[:scrub])
 
-    def validate(value)
-      if blank?(value)
+      if value !~ /\S/
         yield error(:required, 'is required') if required?
+
+        form.send(:"#{name}=", blank_value? ? blank_value : value)
       else
         yield error(:not_multiline, 'cannot contain newlines') if !multiline? && value.lines.count > 1
 
@@ -33,6 +33,8 @@ module Formeze
         yield error(:no_match, 'is invalid') if no_match?(value)
 
         yield error(:bad_value, 'is invalid') if values? && !values.include?(value)
+
+        form.send(:"#{name}=", value)
       end
     end
 
@@ -80,8 +82,12 @@ module Formeze
       @options.has_key?(:pattern) && value !~ @options[:pattern]
     end
 
-    def blank?(value)
-      value !~ /\S/
+    def blank_value?
+      @options.has_key?(:blank)
+    end
+
+    def blank_value
+      @options.fetch(:blank)
     end
 
     def values?
@@ -214,13 +220,9 @@ module Formeze
         end
 
         values.each do |value|
-          scrubbed_value = field.scrub(value)
-
-          field.validate(scrubbed_value) do |error|
+          field.validate(value, self) do |error|
             error!("#{field.label} #{error}", field.name)
           end
-
-          send(:"#{field.name}=", scrubbed_value)
         end
       end
 

data/spec/formeze_spec.rb

@@ -66,6 +66,12 @@ describe 'FormWithField after parsing valid input' do
     @form.parse('title=Untitled')
   end
 
+  describe 'title method' do
+    it 'returns the value of the field' do
+      @form.title.must_equal('Untitled')
+    end
+  end
+
   describe 'valid query method' do
     it 'returns true' do
       @form.valid?.must_equal(true)
@@ -187,6 +193,23 @@ describe 'FormWithOptionalField after parsing blank input' do
   end
 end
 
+class FormWithOptionalFieldUsingBlankOption < Formeze::Form
+  field :title, :required => false, :blank => 42
+end
+
+describe 'FormWithOptionalFieldUsingBlankOption after parsing blank input' do
+  before do
+    @form = FormWithOptionalFieldUsingBlankOption.new
+    @form.parse('title=')
+  end
+
+  describe 'title method' do
+    it 'returns the value specified by the blank option' do
+      @form.title.must_equal(42)
+    end
+  end
+end
+
 class FormWithFieldThatCanHaveMultipleLines < Formeze::Form
   field :description, :multiline => true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake