formeze 1.1.3 → 1.2.0

data/README.md

@@ -122,6 +122,34 @@ 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.
 
+Sometimes you'll only want the field to be defined if some condition is true.
+The condition may depend on the state of other form fields, or some external
+state accessible from the form object. You can do this by specifying either
+the `defined_if` or `defined_unless` options with a proc. Here's an example
+of using the defined_if option:
+
+```ruby
+field :business_name, defined_if: proc { @account.business? }
+```
+
+In this example the `business_name` field will only be defined and validated
+for business accounts. The proc is evaluated in the context of the form object,
+so has full access to instance variables and methods defined on the object.
+Here's an example of using the defined_unless option:
+
+```ruby
+field :same_address, values: %w(true), key_required: false
+
+field :billing_address_line_one, defined_unless: proc { same_address? }
+
+def same_address?
+  same_address == 'true'
+end
+```
+
+In this example, the `billing_address_line_one` field will only be defined
+and validated if the `same_address` checkbox is checked.
+
 
 Rails usage
 -----------

data/formeze.gemspec

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

data/lib/formeze.rb

@@ -85,21 +85,21 @@ module Formeze
     def values
       @options.fetch(:values)
     end
-  end
 
-  class GuardCondition
-    attr_reader :block
+    def defined_if?
+      @options.has_key?(:defined_if)
+    end
 
-    def initialize(block)
-      @block = block
+    def defined_if
+      @options.fetch(:defined_if)
     end
-  end
 
-  class HaltingCondition
-    attr_reader :block
+    def defined_unless?
+      @options.has_key?(:defined_unless)
+    end
 
-    def initialize(block)
-      @block = block
+    def defined_unless
+      @options.fetch(:defined_unless)
     end
   end
 
@@ -159,14 +159,6 @@ module Formeze
       end
     end
 
-    def guard(&block)
-      fields << GuardCondition.new(block)
-    end
-
-    def halts(&block)
-      fields << HaltingCondition.new(block)
-    end
-
     def checks
       @checks ||= []
     end
@@ -195,11 +187,7 @@ module Formeze
       form_data = CGI.parse(encoded_form_data)
 
       self.class.fields.each do |field|
-        if field.is_a?(GuardCondition)
-          instance_eval(&field.block) ? next : break
-        elsif field.is_a?(HaltingCondition)
-          instance_eval(&field.block) ? break : next
-        end
+        next unless field_defined?(field)
 
         unless form_data.has_key?(field.key)
           next if field.multiple? || !field.key_required?
@@ -229,6 +217,16 @@ module Formeze
       end
     end
 
+    def field_defined?(field)
+      if field.defined_if?
+        instance_eval(&field.defined_if)
+      elsif field.defined_unless?
+        !instance_eval(&field.defined_unless)
+      else
+        true
+      end
+    end
+
     def errors
       @errors ||= []
     end

data/spec/formeze_spec.rb

@@ -313,24 +313,21 @@ class FormWithGuardCondition
   Formeze.setup(self)
 
   field :account_name
-
-  guard { @business_account }
-
-  field :account_vat_number
+  field :account_vat_number, defined_if: proc { @business_account }
 
   def initialize(business_account)
     @business_account = business_account
   end
 end
 
-describe 'FormWithGuardCondition' do
+describe 'FormWithGuardCondition with business_account set to false' do
   before do
     @form = FormWithGuardCondition.new(false)
   end
 
   describe 'parse method' do
-    it 'should raise an exception when there is an unexpected key' do
-      proc { @form.parse('account_name=Something&foo=bar') }.must_raise(Formeze::KeyError)
+    it 'should raise an exception when the account_vat_number is present' do
+      proc { @form.parse('account_name=Something&account_vat_number=123456789') }.must_raise(Formeze::KeyError)
     end
   end
 end
@@ -364,12 +361,8 @@ class FormWithHaltingCondition
   Formeze.setup(self)
 
   field :delivery_address
-
   field :same_address, values: %w(yes no)
-
-  halts { same_address? }
-
-  field :billing_address
+  field :billing_address, defined_unless: :same_address?
 
   def same_address?
     same_address == 'yes'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies: []
 description: A little library for handling form data/input
 email:
@@ -43,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: See description