formeze 1.6.0 → 1.7.0

data/README.md

@@ -63,9 +63,9 @@ your own initialization logic).
 Detecting errors
 ----------------
 
-Formeze distinguishes between user errors (which are expected in the normal
-running of your application), and key/value errors (which most likely indicate
-either developer error, or form tampering).
+Formeze distinguishes between validation errors (which are expected in the
+normal running of your application), and key/value errors (which most likely
+indicate either developer error, or form tampering).
 
 For the latter case, the `parse` method that formeze provides will raise a
 Formeze::KeyError or a Formeze::ValueError exception if the structure of the
@@ -73,7 +73,10 @@ form data does not match the field definitions.
 
 After calling `parse` you can check that the form is valid by calling the
 `#valid?` method. If it isn't you can call the `errors` method which will
-return an array of error messages to display to the user.
+return an array of error messages to display to the end user.
+
+You can also use `errors_on?` and `errors_on` to check for and select error
+messages specific to a single field.
 
 
 Field options

data/formeze.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '1.6.0'
+  s.version = '1.7.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -8,6 +8,8 @@ Gem::Specification.new do |s|
   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.add_development_dependency('rake', ['>= 0.9.3'])
   s.add_development_dependency('i18n', ['~> 0.6.0'])
+  s.add_development_dependency('minitest', ['>= 4.2.0']) if RUBY_VERSION == '1.8.7'
   s.require_path = 'lib'
 end

data/lib/formeze.rb

@@ -37,7 +37,7 @@ module Formeze
     end
 
     def error(i18n_key, default)
-      translate(i18n_key, scope: [:formeze, :errors], default: default)
+      translate(i18n_key, :scope => [:formeze, :errors], :default => default)
     end
 
     def key
@@ -49,7 +49,7 @@ module Formeze
     end
 
     def label
-      @options.fetch(:label) { translate(name, scope: [:formeze, :labels], default: Label.new(name)) }
+      @options.fetch(:label) { translate(name, :scope => [:formeze, :labels], :default => Label.new(name)) }
     end
 
     def required?
@@ -182,7 +182,7 @@ module Formeze
 
   class ValueError < StandardError; end
 
-  class UserError < StandardError; end
+  class ValidationError < StandardError; end
 
   module InstanceMethods
     def parse(encoded_form_data)
@@ -241,6 +241,13 @@ module Formeze
       field_errors[field_name]
     end
 
+    def to_hash
+      self.class.fields.inject({}) do |hash, field|
+        hash[field.name] = send(field.name)
+        hash
+      end
+    end
+
     private
 
     def field_defined?(field)
@@ -258,7 +265,7 @@ module Formeze
     end
 
     def error!(message, field_name = nil)
-      error = UserError.new(message)
+      error = ValidationError.new(message)
 
       errors << error
 
@@ -288,9 +295,9 @@ module Formeze
     form.extend ClassMethods
 
     if on_rails?
-      form.field(:utf8, key_required: false)
+      form.field(:utf8, :key_required => false)
 
-      form.field(:authenticity_token, key_required: false)
+      form.field(:authenticity_token, :key_required => false)
     end
   end
 

data/spec/formeze_spec.rb

@@ -1,6 +1,5 @@
 require 'minitest/autorun'
-
-require_relative '../lib/formeze'
+require 'formeze'
 require 'i18n'
 
 class FormWithField < Formeze::Form
@@ -83,6 +82,12 @@ describe 'FormWithField after parsing valid input' do
       errors.must_be_empty
     end
   end
+
+  describe 'to_hash method' do
+    it 'should return a hash containing the field name and its value' do
+      @form.to_hash.must_equal({:title => 'Untitled'})
+    end
+  end
 end
 
 describe 'FormWithField after parsing blank input' do
@@ -150,7 +155,7 @@ describe 'FormWithField parse class method' do
 end
 
 class FormWithOptionalField < Formeze::Form
-  field :title, required: false
+  field :title, :required => false
 end
 
 describe 'FormWithOptionalField after parsing blank input' do
@@ -167,7 +172,7 @@ describe 'FormWithOptionalField after parsing blank input' do
 end
 
 class FormWithFieldThatCanHaveMultipleLines < Formeze::Form
-  field :description, multiline: true
+  field :description, :multiline => true
 end
 
 describe 'FormWithFieldThatCanHaveMultipleLines after parsing input containing newlines' do
@@ -184,7 +189,7 @@ describe 'FormWithFieldThatCanHaveMultipleLines after parsing input containing n
 end
 
 class FormWithCharacterLimitedField < Formeze::Form
-  field :title, char_limit: 16
+  field :title, :char_limit => 16
 end
 
 describe 'FormWithCharacterLimitedField after parsing input with too many characters' do
@@ -201,7 +206,7 @@ describe 'FormWithCharacterLimitedField after parsing input with too many charac
 end
 
 class FormWithWordLimitedField < Formeze::Form
-  field :title, word_limit: 2
+  field :title, :word_limit => 2
 end
 
 describe 'FormWithWordLimitedField after parsing input with too many words' do
@@ -218,7 +223,7 @@ describe 'FormWithWordLimitedField after parsing input with too many words' do
 end
 
 class FormWithFieldThatMustMatchPattern < Formeze::Form
-  field :number, pattern: /\A\d+\z/
+  field :number, :pattern => /\A\d+\z/
 end
 
 describe 'FormWithFieldThatMustMatchPattern after parsing input that matches the pattern' do
@@ -248,7 +253,7 @@ describe 'FormWithFieldThatMustMatchPattern after parsing input that does not ma
 end
 
 class FormWithFieldThatCanHaveMultipleValues < Formeze::Form
-  field :colour, multiple: true
+  field :colour, :multiple => true
 end
 
 describe 'FormWithFieldThatCanHaveMultipleValues' do
@@ -305,6 +310,12 @@ describe 'FormWithFieldThatCanHaveMultipleValues after parsing input with multip
       @form.valid?.must_equal(true)
     end
   end
+
+  describe 'to_hash method' do
+    it 'should return a hash containing the field name and its array value' do
+      @form.to_hash.must_equal({:colour => %w(black white)})
+    end
+  end
 end
 
 describe 'FormWithFieldThatCanHaveMultipleValues after parsing input with no values' do
@@ -328,7 +339,7 @@ describe 'FormWithFieldThatCanHaveMultipleValues after parsing input with no val
 end
 
 class FormWithFieldThatCanOnlyHaveSpecifiedValues < Formeze::Form
-  field :answer, values: %w(yes no)
+  field :answer, :values => %w(yes no)
 end
 
 describe 'FormWithFieldThatCanOnlyHaveSpecifiedValues after parsing input with an invalid value' do
@@ -346,7 +357,7 @@ end
 
 class FormWithGuardCondition < Formeze::Form
   field :account_name
-  field :account_vat_number, defined_if: proc { @business_account }
+  field :account_vat_number, :defined_if => proc { @business_account }
 
   def initialize(business_account)
     @business_account = business_account
@@ -392,8 +403,8 @@ end
 
 class FormWithHaltingCondition < Formeze::Form
   field :delivery_address
-  field :same_address, values: %w(yes no)
-  field :billing_address, defined_unless: :same_address?
+  field :same_address, :values => %w(yes no)
+  field :billing_address, :defined_unless => :same_address?
 
   def same_address?
     same_address == 'yes'
@@ -446,7 +457,7 @@ describe 'FormWithCustomValidation after parsing invalid input' do
 end
 
 class FormWithOptionalKey < Formeze::Form
-  field :accept_terms, values: %w(true), key_required: false
+  field :accept_terms, :values => %w(true), :key_required => false
 end
 
 describe 'FormWithOptionalKey after parsing input without the key' do
@@ -463,7 +474,7 @@ describe 'FormWithOptionalKey after parsing input without the key' do
 end
 
 class FormWithOptionalFieldThatCanOnlyHaveSpecifiedValues < Formeze::Form
-  field :size, required: false, values: %w(S M L XL)
+  field :size, :required => false, :values => %w(S M L XL)
 end
 
 describe 'FormWithOptionalFieldThatCanOnlyHaveSpecifiedValues after parsing blank input' do
@@ -514,7 +525,7 @@ describe 'I18n integration' do
   end
 
   it 'should be possible to override the default error messages' do
-    I18n.backend.store_translations :en, {formeze: {errors: {required: 'cannot be blank'}}}
+    I18n.backend.store_translations :en, {:formeze => {:errors => {:required => 'cannot be blank'}}}
 
     form = FormWithField.new
     form.parse('title=')
@@ -522,7 +533,7 @@ describe 'I18n integration' do
   end
 
   it 'should be possible to set labels globally' do
-    I18n.backend.store_translations :en, {formeze: {labels: {title: 'TITLE'}}}
+    I18n.backend.store_translations :en, {:formeze => {:labels => {:title => 'TITLE'}}}
 
     form = FormWithField.new
     form.parse('title=')
@@ -531,8 +542,8 @@ describe 'I18n integration' do
 end
 
 class FormWithScrubbedFields < Formeze::Form
-  field :postcode, scrub: [:strip, :squeeze, :upcase], pattern: /\A[A-Z0-9]{2,4} [A-Z0-9]{3}\z/
-  field :bio, scrub: [:strip, :squeeze_lines], multiline: true
+  field :postcode, :scrub => [:strip, :squeeze, :upcase], :pattern => /\A[A-Z0-9]{2,4} [A-Z0-9]{3}\z/
+  field :bio, :scrub => [:strip, :squeeze_lines], :multiline => true
 end
 
 describe 'FormWithScrubbedFields' do
@@ -541,7 +552,7 @@ describe 'FormWithScrubbedFields' do
       form = FormWithScrubbedFields.new
       form.parse('postcode=++sw1a+++1aa&bio=My+name+is+Cookie+Monster.%0A%0A%0A%0AI+LOVE+COOKIES!!!!%0A%0A%0A%0A')
       form.postcode.must_equal('SW1A 1AA')
-      form.bio.count(?\n).must_equal(2)
+      form.bio.count("\n").must_equal(2)
       form.valid?.must_equal(true)
     end
   end
@@ -560,8 +571,19 @@ class FormClassWithExplicitSetupCall
 end
 
 describe 'FormClassWithExplicitSetupCall' do
+  before do
+    @form_class = FormClassWithExplicitSetupCall
+  end
+
   it 'includes the formeze class methods and instance methods' do
-    FormClassWithExplicitSetupCall.singleton_class.must_include(Formeze::ClassMethods)
-    FormClassWithExplicitSetupCall.must_include(Formeze::InstanceMethods)
+    singleton_class = if @form.respond_to?(:singleton_class)
+      @form_class.singleton_class
+    else
+      (class << @form_class; self; end)
+    end
+
+    singleton_class.must_include(Formeze::ClassMethods)
+
+    @form_class.must_include(Formeze::InstanceMethods)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement