formulary 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 393050691325dca94776e614a5de5f939fd595de
+  data.tar.gz: 825e144f8e5a11d88756318ba32e9e5248088ca1
+SHA512:
+  metadata.gz: 51ebdb9b78b2e3bb3be922650daebd152cf302c00074cee83d3e7f350b9eb80ba9dc38e2dad34d113444faf2a53d4c20f8400309bcaa49ba29b5c9f2e4217b7e
+  data.tar.gz: f164cece566135c3400ce59ba8042e24cee8736b6469268921f302a9027a02e83f0a0cc2f423a789e84bdad76614cfdc39dc6e7a0207c643c0b651d1e2e02eb8

data/README.md

@@ -17,32 +17,32 @@ gem 'formulary'
 
 And then execute:
 
-    $ bundle
+$ bundle
 
 Or install it yourself as:
 
-    $ gem install formulary
+$ gem install formulary
 
 
 ## Usage
 
 Create a new Formulary Form
-    
+
 ```ruby
 require 'formulary'
 
 form_html = <<EOF
 <form>
-  <input type="email" name="email" required />
-  <input type="username" name="username" pattern="[a-z0-9_-]{3,16}" />
+<input type="email" name="email" required />
+<input type="username" name="username" pattern="[a-z0-9_-]{3,16}" />
 </form>
 EOF
-  
+
 html_form = Formulary::HtmlForm.new(form_html)
 ```
 
 Validate the form based on HTML5 field types and/or patterns and view which fields are invalid and why.
-    
+
 ```ruby
 html_form.valid?({ email: "test@example.com", username: "person" })
 # => true
@@ -61,25 +61,55 @@ html_form.valid?({ unknown: "value" })
 # => Formulary::UnexpectedParameter: Got unexpected field 'unknown'
 ```
 
-
 ## Currently Supported
 
-- type="email"
+**Supported Input Types**
+- checkbox
+- color
+- date
+- email
+- hidden
+- month
+- number
+- password
+- radio
+- range
+- search
+- tel 
+- text
+- week
+
+**Ignored Field Types (not validated but does not make things explode)
+- button
+- image
+- reset
+- submit
+
+**Supported Input Attributes**
+- max (number, range, date)
+- min (number, range, date)
+- pattern
 - required
-- pattern="REGEX"
-- selects, selected value is one of the options
+- step (number, range)
 
+**Other Supported Tags**
+- select
+- textarea
 
-## TODO
 
-- checkbox, radio and multiselect tags have one of the valid options selected
-- validate [other html5 field types](http://www.w3schools.com/html/html5_form_input_types.asp)
+## TODO
 
+**Add Unsupported Input Types**
+- datetime
+- datetime-local
+- file
+- time
+- url 
 
 ## Authors
 
-* Don Petersen / [@dpetersen](https://github.com/dpetersen)
-* Matt Bohme / [@quady](https://github.com/quady)
+        * Matt Bohme / [@quady](https://github.com/quady)
+        * Don Petersen / [@dpetersen](https://github.com/dpetersen)
 
 
 ## Contributing
@@ -95,25 +125,26 @@ html_form.valid?({ unknown: "value" })
 
 ## License
 
-Copyright (c) 2013 G5
+        Copyright (c) 2013 G5
+
+        MIT License
 
-MIT License
+        Permission is hereby granted, free of charge, to any person obtaining
+        a copy of this software and associated documentation files (the
+                        "Software"), to deal in the Software without restriction, including
+        without limitation the rights to use, copy, modify, merge, publish,
+        distribute, sublicense, and/or sell copies of the Software, and to
+        permit persons to whom the Software is furnished to do so, subject to
+        the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+        The above copyright notice and this permission notice shall be
+        included in all copies or substantial portions of the Software.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/formulary.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "nokogiri"
   spec.add_dependency "activesupport"
-  spec.add_dependency "email_veracity"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/formulary.rb

@@ -1,11 +1,6 @@
 require 'nokogiri'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
-require 'email_veracity'
-
-# Don't try and determine if this email address is legitimate, just validate
-# the provided address.
-EmailVeracity::Config[:skip_lookup] = true
 
 module Formulary
   class HtmlForm
@@ -16,4 +11,5 @@ end
 
 require "formulary/version"
 require "formulary/html_form/fields"
+require "formulary/html_form/labels"
 require "formulary/html_form"

data/lib/formulary/html_form.rb

@@ -1,7 +1,9 @@
 module Formulary
   class HtmlForm
+    include Labels
+
     SINGULAR_FIELD_SELECTOR = <<-EOS
-      input[type!='submit'][type!='radio'][type!='checkbox'],
+      input[type!='submit'][type!='button'][type!='reset'][type!='image'][type!='radio'][type!='checkbox'],
       textarea,
       select
     EOS
@@ -18,9 +20,13 @@ module Formulary
 
     def valid?(params)
       params.each do |key, value|
-        raise UnexpectedParameter.new("Got unexpected field '#{key}'") unless find_field(key)
-
-        find_field(key).set_value(value)
+        if value.kind_of?(Hash)
+          value.each do |nested_key, nested_value|
+            set_field_value("#{key}[#{nested_key}]", nested_value)
+          end
+        else
+          set_field_value(key, value)
+        end
       end
 
       fields.all?(&:valid?)
@@ -34,6 +40,16 @@ module Formulary
 
   protected
 
+    def document
+      @document ||= Nokogiri::HTML(@markup)
+    end
+
+    def set_field_value(field_name, value)
+      field = find_field(field_name)
+      raise UnexpectedParameter.new("Got unexpected field '#{field_name}'") unless field
+      field.set_value(value)
+    end
+
     def fields
       @fields || build_fields
     end
@@ -44,24 +60,23 @@ module Formulary
 
     def build_fields
       @fields = []
-      doc = Nokogiri::HTML(@markup)
 
-      build_singular_fields_from(doc)
-      build_grouped_fields_from(doc)
+      build_singular_fields_from
+      build_grouped_fields_from
     end
 
-    def build_singular_fields_from(doc)
-      doc.css(SINGULAR_FIELD_SELECTOR.strip).map do |element|
+    def build_singular_fields_from
+      document.css(SINGULAR_FIELD_SELECTOR.strip).map do |element|
         field_klass = FIELD_TYPES.detect { |k| k.compatible_with?(element) }
         if field_klass.nil?
           raise UnsupportedFieldType.new("I can't handle this field: #{element.inspect}")
         end
-        @fields << field_klass.new(element)
+        @fields << field_klass.new(self, element)
       end
     end
 
-    def build_grouped_fields_from(doc)
-      grouped_elements = doc.css(GROUPED_FIELD_SELECTOR.strip).group_by do |element|
+    def build_grouped_fields_from
+      grouped_elements = document.css(GROUPED_FIELD_SELECTOR.strip).group_by do |element|
         element.attributes["name"].value
       end
 
@@ -69,7 +84,10 @@ module Formulary
         group_name, elements = *element_group
 
         group_klass = FIELD_GROUP_TYPES.detect { |k| k.compatible_with?(elements) }
-        @fields << group_klass.new(group_name, elements)
+        if group_klass.nil?
+          raise UnsupportedFieldType.new("I can't handle these fields: #{elements.inspect}")
+        end
+        @fields << group_klass.new(self, group_name, elements)
       end
     end
   end

data/lib/formulary/html_form/fields.rb

@@ -4,12 +4,28 @@ require 'formulary/html_form/fields/input'
 
 require 'formulary/html_form/fields/text_input'
 Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::TextInput
+require 'formulary/html_form/fields/search_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::SearchInput
+require 'formulary/html_form/fields/password_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::PasswordInput
+require 'formulary/html_form/fields/color_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::ColorInput
+require 'formulary/html_form/fields/number_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::NumberInput
+require 'formulary/html_form/fields/range_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::RangeInput
 require 'formulary/html_form/fields/email_input'
 Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::EmailInput
 require 'formulary/html_form/fields/tel_input'
 Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::TelInput
 require 'formulary/html_form/fields/hidden_input'
 Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::HiddenInput
+require 'formulary/html_form/fields/date_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::DateInput
+require 'formulary/html_form/fields/month_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::MonthInput
+require 'formulary/html_form/fields/week_input'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::WeekInput
 require 'formulary/html_form/fields/textarea'
 Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::Textarea
 require 'formulary/html_form/fields/select'

data/lib/formulary/html_form/fields/checkbox_group.rb

@@ -8,7 +8,7 @@ module Formulary::HtmlForm::Fields
       true
     end
 
-    def initialize(group_name, elements)
+    def initialize(html_form, group_name, elements)
       super
       @values = []
     end

data/lib/formulary/html_form/fields/color_input.rb

@@ -0,0 +1,24 @@
+module Formulary::HtmlForm::Fields
+  class ColorInput < Input
+    def self.compatible_type
+      "color"
+    end
+
+    def valid?
+      super && color_correct?
+    end
+
+    def error
+      return super if super.present?
+      return "'#{label}' is not a valid color hex value" unless color_correct?
+    end
+
+  protected
+
+    def color_correct?
+      return true if @value.blank?
+      return true if @value.match(/\A#[0-9A-F]{6}\z/)
+      false
+    end
+  end
+end

data/lib/formulary/html_form/fields/date_input.rb

@@ -0,0 +1,59 @@
+module Formulary::HtmlForm::Fields
+  class DateInput < Input
+    def self.compatible_type
+      "date"
+    end
+
+    def display_format
+      "YYYY-MM-DD"
+    end
+
+    def datetime_format
+      "%Y-%m-%d"
+    end
+
+    def initialize(html_form, element)
+      @html_form, @element = html_form, element
+      @min = @element.attributes['min'].try('value')
+      @max = @element.attributes['max'].try('value')
+    end
+
+    def valid?
+      super && date_correct? && min_correct? && max_correct?
+    end
+
+    def error
+      return super if super.present?
+      return "'#{label}' is not a properly formatted #{self.class.compatible_type}, please use #{display_format}" unless date_correct?
+      return "'#{label}' must be a #{self.class.compatible_type} after #{@min}" unless min_correct?
+      return "'#{label}' must be a #{self.class.compatible_type} before #{@max}" unless max_correct?
+    end
+
+  protected
+
+    def date_correct?
+      return true if @value.blank?
+      Date.strptime(@value, datetime_format)
+    rescue ArgumentError => e
+      if e.message.include?("invalid date")
+        return false
+      else
+        raise
+      end
+    end
+
+    def min_correct?
+      return true if @value.blank?
+      return true if @min.blank?
+      return true if @value >= @min
+      false
+    end
+
+    def max_correct?
+      return true if @value.blank?
+      return true if @max.blank?
+      return true if @value <= @max
+      false
+    end
+  end
+end

data/lib/formulary/html_form/fields/email_input.rb

@@ -1,5 +1,14 @@
 module Formulary::HtmlForm::Fields
   class EmailInput < Input
+    # The acceptable email pattern in the standard is defined in a language
+    # that might not be possible to use in Ruby.  Or if it is, we haven't spent
+    # the time to find out or not.  We did find this supposedly compatible
+    # regex on StackOverflow and it passes our tests so we're rolling with that
+    # for now.
+    #
+    # http://stackoverflow.com/questions/4940120/is-there-a-java-implementation-of-the-html5-input-email-validation
+    REGEX = /[A-Za-z0-9!#$%&'*+-\/=?^_`{|}~]+@[A-Za-z0-9-]+(.[A-Za-z0-9-]+)*/
+
     def self.compatible_type
       "email"
     end
@@ -10,14 +19,14 @@ module Formulary::HtmlForm::Fields
 
     def error
       return super if super.present?
-      return "email" unless email_correct?
+      return "'#{label}' is not a valid email address" unless email_correct?
     end
 
   protected
 
     def email_correct?
       return true if @value.blank?
-      EmailVeracity::Address.new(@value).valid?
+      return true if @value.match(REGEX)
     end
   end
 end

data/lib/formulary/html_form/fields/field.rb

@@ -4,8 +4,8 @@ module Formulary::HtmlForm::Fields
       false
     end
 
-    def initialize(element)
-      @element = element
+    def initialize(html_form, element)
+      @html_form, @element = html_form, element
     end
 
     def name
@@ -21,7 +21,19 @@ module Formulary::HtmlForm::Fields
     end
 
     def error
-      return "required" if supports_required? && !presence_correct?
+      return "'#{label}' is required" if supports_required? && !presence_correct?
+    end
+
+    def label
+      @label ||= \
+        begin
+          l = @html_form.label_for_field(name)
+
+          if l.nil? then nil
+          elsif l.is_a?(String) then l
+          else l["fieldset"]
+          end
+        end
     end
 
   protected