formulary 0.0.1 → 0.0.2

data/README.md

@@ -4,11 +4,16 @@
 >
 > -- <cite><a href="http://en.wikipedia.org/wiki/Formulary_%28model_documents%29">Wikipedia</a></cite> 
 
+A Ruby gem to parse HTML5 forms and decompose them into model validation using their field types (email, url, number, etc) and form attributes (required, pattern, etc).
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'formulary'
+```ruby
+gem 'formulary'
+```
 
 And then execute:
 
@@ -18,6 +23,7 @@ Or install it yourself as:
 
     $ gem install formulary
 
+
 ## Usage
 
 Create a new Formulary Form
@@ -55,21 +61,59 @@ html_form.valid?({ unknown: "value" })
 # => Formulary::UnexpectedParameter: Got unexpected field 'unknown'
 ```
 
+
 ## Currently Supported
 
 - type="email"
 - required
 - pattern="REGEX"
+- selects, selected value is one of the options
+
 
 ## TODO
 
-- select, checkbox, radio and multiselect tags have one of the valid options selected
+- 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)
 
+
+## Authors
+
+* Don Petersen / [@dpetersen](https://github.com/dpetersen)
+* Matt Bohme / [@quady](https://github.com/quady)
+
+
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Get it running (see Installation above)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Write your code and **specs**
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+
+## License
+
+Copyright (c) 2013 G5
+
+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:
+
+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.

data/formulary.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 end

data/lib/formulary.rb

@@ -1,6 +1,19 @@
 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
+    FIELD_TYPES = []
+    FIELD_GROUP_TYPES = []
+  end
+end
+
 require "formulary/version"
+require "formulary/html_form/fields"
 require "formulary/html_form"

data/lib/formulary/html_form.rb

@@ -1,58 +1,19 @@
 module Formulary
   class HtmlForm
-    class Field
-      attr_accessor :name, :type, :required, :pattern
-
-      def initialize(name, type, required, pattern=nil)
-        @name = name
-        @type = type
-        @required = required
-        @pattern = pattern
-      end
-
-      def set_value(value)
-        @value = value
-      end
-
-      def valid?
-        presence_correct && pattern_correct && correct_for_type
-      end
-
-      def error
-        return "required" unless presence_correct
-        return "format" unless pattern_correct
-        return "not a valid #{@type}" unless correct_for_type
-      end
-
-    protected
+    SINGULAR_FIELD_SELECTOR = <<-EOS
+      input[type!='submit'][type!='radio'][type!='checkbox'],
+      textarea,
+      select
+    EOS
 
-      def presence_correct
-        !required || @value.present?
-      end
-
-      def pattern_correct
-        return true if @pattern.blank? || @value.blank?
-        @value.match(Regexp.new(@pattern))
-      end
-
-      def correct_for_type
-        return true if @value.blank?
-
-        case @type
-        when "email"
-          EmailVeracity::Address.new(@value).valid?
-        else
-          true
-        end
-      end
-    end
+    GROUPED_FIELD_SELECTOR = <<-EOS
+      input[type='radio'],
+      input[type='checkbox']
+    EOS
 
     def initialize(markup)
       @markup = markup
-    end
-
-    def fields
-      @fields ||= build_fields
+      fields
     end
 
     def valid?(params)
@@ -73,29 +34,49 @@ module Formulary
 
   protected
 
+    def fields
+      @fields || build_fields
+    end
+
     def find_field(name)
       fields.detect { |field| field.name == name.to_s }
     end
 
     def build_fields
+      @fields = []
       doc = Nokogiri::HTML(@markup)
 
-      doc.css("input[type!='submit'], textarea").map do |input|
-        type = input.name == "textarea" ? "textarea" : input.attributes["type"].value
-        pattern = input.attributes.include?("pattern") ? input.attributes["pattern"].value : nil
+      build_singular_fields_from(doc)
+      build_grouped_fields_from(doc)
+    end
 
+    def build_singular_fields_from(doc)
+      doc.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)
+      end
+    end
 
-        Field.new(
-          input.attributes["name"].value,
-          type,
-          input.attributes.include?("required"),
-          pattern
-        )
+    def build_grouped_fields_from(doc)
+      grouped_elements = doc.css(GROUPED_FIELD_SELECTOR.strip).group_by do |element|
+        element.attributes["name"].value
+      end
+
+      grouped_elements.each do |element_group|
+        group_name, elements = *element_group
+
+        group_klass = FIELD_GROUP_TYPES.detect { |k| k.compatible_with?(elements) }
+        @fields << group_klass.new(group_name, elements)
       end
     end
   end
 
   class UnexpectedParameter < StandardError
+  end
 
+  class UnsupportedFieldType < StandardError
   end
 end

data/lib/formulary/html_form/fields.rb

@@ -0,0 +1,21 @@
+require 'formulary/html_form/fields/field'
+require 'formulary/html_form/fields/field_group'
+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/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/textarea'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::Textarea
+require 'formulary/html_form/fields/select'
+Formulary::HtmlForm::FIELD_TYPES << Formulary::HtmlForm::Fields::Select
+
+require 'formulary/html_form/fields/radio_button_group'
+Formulary::HtmlForm::FIELD_GROUP_TYPES << Formulary::HtmlForm::Fields::RadioButtonGroup
+require 'formulary/html_form/fields/checkbox_group'
+Formulary::HtmlForm::FIELD_GROUP_TYPES << Formulary::HtmlForm::Fields::CheckboxGroup

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

@@ -0,0 +1,43 @@
+module Formulary::HtmlForm::Fields
+  class CheckboxGroup < FieldGroup
+    def self.compatible_type
+      "checkbox"
+    end
+
+    def self.supports_required?
+      true
+    end
+
+    def initialize(group_name, elements)
+      super
+      @values = []
+    end
+
+    def set_value(value)
+      @values = [value].flatten
+    end
+
+  protected
+
+    def presence_correct?
+      @elements.each do |element|
+        if element.attributes.include?("required")
+          return false unless @values.include?(value_from_element(element))
+        end
+      end
+      return true
+    end
+
+    def value_in_list?
+      return true if @values.empty?
+      allowed_values = @elements.map { |e| value_from_element(e) }
+      (allowed_values & @values) == @values
+    end
+
+    # Our exhaustive testing concludes that browsers submit "on" when the
+    # checkbox has no value.
+    def value_from_element(element)
+      element.attributes["value"].try(:value) || "on"
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Formulary::HtmlForm::Fields
+  class EmailInput < Input
+    def self.compatible_type
+      "email"
+    end
+
+    def valid?
+      super && email_correct?
+    end
+
+    def error
+      return super if super.present?
+      return "email" unless email_correct?
+    end
+
+  protected
+
+    def email_correct?
+      return true if @value.blank?
+      EmailVeracity::Address.new(@value).valid?
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Formulary::HtmlForm::Fields
+  class Field
+    def self.supports_required?
+      false
+    end
+
+    def initialize(element)
+      @element = element
+    end
+
+    def name
+      @element.attributes["name"].value
+    end
+
+    def set_value(value)
+      @value = value
+    end
+
+    def valid?
+      supports_required? && presence_correct?
+    end
+
+    def error
+      return "required" if supports_required? && !presence_correct?
+    end
+
+  protected
+
+    def supports_required?
+      self.class.supports_required?
+    end
+
+    def presence_correct?
+      if required? && @value.blank?
+        return false
+      else
+        return true
+      end
+    end
+
+    def required?
+      @element.attributes.include?("required")
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Formulary::HtmlForm::Fields
+  class FieldGroup < Field
+    def self.compatible_with?(elements)
+      elements.all? do |e|
+        e.name == "input" && e.attributes["type"].value == compatible_type
+      end
+    end
+
+    def initialize(group_name, elements)
+      @group_name, @elements = group_name, elements
+    end
+
+    def name
+      @group_name
+    end
+
+    def valid?
+      super && value_in_list?
+    end
+
+    def error
+      return super if super.present?
+      return "choose" if !value_in_list?
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Formulary::HtmlForm::Fields
+  class HiddenInput < Input
+    def self.compatible_type
+      "hidden"
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Formulary::HtmlForm::Fields
+  class Input < Field
+    def self.compatible_with?(element)
+      element.name == "input" &&
+      element.attributes["type"].value == compatible_type
+    end
+
+    def self.supports_required?
+      true
+    end
+
+    def valid?
+      super && pattern_correct?
+    end
+
+    def error
+      return super if super.present?
+      return "format" unless pattern_correct?
+    end
+
+  protected
+
+    def pattern_correct?
+      return true if pattern.blank? || @value.blank?
+      @value.match(Regexp.new(pattern))
+    end
+
+    def pattern
+      @element.attributes["pattern"].try(:value)
+    end
+  end
+end