formeze 1.0.0 → 1.1.0

data/README.md

@@ -1,5 +1,5 @@
-Formeze: A little library for defining classes to handle form data/input
-========================================================================
+Formeze: A little library for handling form data/input
+======================================================
 
 
 Motivation
@@ -22,21 +22,23 @@ some class methods and instance methods, but will otherwise leave the object
 untouched (i.e. you can define your own initialization). Here is a minimal
 example, which defines a form with a single "title" field:
 
-    class ExampleForm
-      Formeze.setup(self)
-
-      field :title
-    end
+```ruby
+class ExampleForm
+  Formeze.setup(self)
 
+  field :title
+end
+```
 
 This form can then be used to parse and validate form/input data as follows:
 
-    form = ExampleForm.new
-
-    form.parse('title=Title')
+```ruby
+form = ExampleForm.new
 
-    form.title  # => "Title"
+form.parse('title=Title')
 
+form.title  # => "Title"
+```
 
 Detecting errors
 ----------------
@@ -65,50 +67,57 @@ Defining a field without any options works well for a simple text input.
 If the default character limit is too big or too small you can override
 it by setting the `char_limit` option. For example:
 
-    field :title, char_limit: 200
-
+```ruby
+field :title, char_limit: 200
+```
 
 If you are dealing with textareas (i.e. multiple lines of text) then you can
 set the `multiline` option to allow newlines. For example:
 
-    field :description, char_limit: 500, multiline: true
-
+```ruby
+field :description, char_limit: 500, multiline: true
+```
 
 Error messages will include the field label, which by default is set to the
 field name, capitalized, and with underscores replace by spaces. If you want
 to override this, set the `label` option. For example:
 
-    field :twitter, label: 'Twitter Username'
-
+```ruby
+field :twitter, label: 'Twitter Username'
+```
 
 If you want to validate that the field value matches a specific pattern you
 can specify the `pattern` option. This is useful for validating things with
 well defined formats, like numbers. For example:
 
-    field :number, pattern: /\A[1-9]\d*\z/
-
-    field :card_security_code, char_limit: 5, value: /\A\d+\z/
+```ruby
+field :number, pattern: /\A[1-9]\d*\z/
 
+field :card_security_code, char_limit: 5, value: /\A\d+\z/
+```
 
 If you want to validate that the field value belongs to a set of predefined
 values then you can specify the `values` option. This is useful for dealing
 with input from select boxes, where the values are known upfront. For example:
 
-    field :card_expiry_month, values: (1..12).map(&:to_s)
-
+```ruby
+field :card_expiry_month, values: (1..12).map(&:to_s)
+```
 
 The `values` option is also useful for checkboxes. Specify the `key_required`
 option to handle the case where the checkbox is unchecked. For example:
 
-    field :accept_terms, values: %w(true), key_required: false
-
+```ruby
+field :accept_terms, values: %w(true), key_required: false
+```
 
 Sometimes you'll have a field with multiple values. A multiple select input,
 a set of checkboxes. For this case you can specify the `multiple` option to
 allow multiple values. For example:
 
-    field :colour, multiple: true, values: Colour.keys
-
+```ruby
+field :colour, multiple: true, values: Colour.keys
+```
 
 Unlike all the other examples so far, reading the attribute that corresponds
 to this field will return an array of strings instead of a single string.
@@ -119,15 +128,16 @@ Rails usage
 
 This is the basic pattern for using a formeze form in a rails controller:
 
-    form = SomeForm.new
-    form.parse(request.raw_post)
-
-    if form.valid?
-      # do something with form data
-    else
-      # display form.errors to user
-    end
+```ruby
+form = SomeForm.new
+form.parse(request.raw_post)
 
+if form.valid?
+  # do something with form data
+else
+  # display form.errors to user
+end
+```
 
 Formeze will automatically define optional "utf8" and "authenticity_token"
 fields on every form so that you don't have to specify those manually.

data/formeze.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '1.0.0'
+  s.version = '1.1.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
   s.homepage = 'http://github.com/timcraft/formeze'
-  s.description = 'A little library for defining classes to handle form data/input'
+  s.description = 'A little library for handling form data/input'
   s.summary = 'See description'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md Rakefile.rb formeze.gemspec)
   s.require_path = 'lib'

data/lib/formeze.rb

@@ -85,6 +85,22 @@ module Formeze
     end
   end
 
+  class GuardCondition
+    attr_reader :block
+
+    def initialize(block)
+      @block = block
+    end
+  end
+
+  class HaltingCondition
+    attr_reader :block
+
+    def initialize(block)
+      @block = block
+    end
+  end
+
   module ArrayAttrAccessor
     def array_attr_reader(name)
       define_method(name) do
@@ -142,7 +158,11 @@ module Formeze
     end
 
     def guard(&block)
-      fields << block
+      fields << GuardCondition.new(block)
+    end
+
+    def halts(&block)
+      fields << HaltingCondition.new(block)
     end
 
     def checks
@@ -173,8 +193,10 @@ module Formeze
       form_data = CGI.parse(encoded_form_data)
 
       self.class.fields.each do |field|
-        unless field.respond_to?(:key)
-          instance_eval(&field) ? return : next
+        if field.is_a?(GuardCondition)
+          instance_eval(&field.block) ? next : return
+        elsif field.is_a?(HaltingCondition)
+          instance_eval(&field.block) ? return : next
         end
 
         unless form_data.has_key?(field.key)

data/spec/formeze_spec.rb

@@ -301,14 +301,53 @@ describe 'FormWithFieldThatCanOnlyHaveSpecifiedValues after parsing input with a
   end
 end
 
-class FormWithGuard
+class FormWithGuardCondition
+  Formeze.setup(self)
+
+  field :account_name
+
+  guard { @business_account }
+
+  field :account_vat_number
+
+  def initialize(business_account)
+    @business_account = business_account
+  end
+end
+
+describe 'FormWithGuardCondition with business_account set to true' do
+  before do
+    @form = FormWithGuardCondition.new(true)
+  end
+
+  describe 'parse method' do
+    it 'should raise an exception when the account_vat_number key is missing' do
+      proc { @form.parse('account_name=Something') }.must_raise(Formeze::KeyError)
+    end
+  end
+end
+
+describe 'FormWithGuardCondition with business_account set to false after parsing valid input' do
+  before do
+    @form = FormWithGuardCondition.new(false)
+    @form.parse('account_name=Something')
+  end
+
+  describe 'valid query method' do
+    it 'should return true' do
+      @form.valid?.must_equal(true)
+    end
+  end
+end
+
+class FormWithHaltingCondition
   Formeze.setup(self)
 
   field :delivery_address
 
   field :same_address, values: %w(yes no)
 
-  guard { same_address? }
+  halts { same_address? }
 
   field :billing_address
 
@@ -317,9 +356,9 @@ class FormWithGuard
   end
 end
 
-describe 'FormWithGuard after parsing input with same_address set and no billing address' do
+describe 'FormWithHaltingCondition after parsing input with same_address set and no billing address' do
   before do
-    @form = FormWithGuard.new
+    @form = FormWithHaltingCondition.new
     @form.parse('delivery_address=123+Main+St&same_address=yes')
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ bindir: bin
 cert_chain: []
 date: 2012-04-09 00:00:00.000000000Z
 dependencies: []
-description: A little library for defining classes to handle form data/input
+description: A little library for handling form data/input
 email:
 - mail@timcraft.com
 executables: []