formulary 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46c937b704dd06944ff4591bac2fd43d72a24ec2
+  data.tar.gz: 14d9eec2e9d6bd6e81250e6dfa9f8031ff294b24
+SHA512:
+  metadata.gz: 786f312821225f0c57ae34344d722fe93107a25f6b9d462eafd1f6da43191fd997e20c8b77aa5c25d8802e807b6c550cce566d6434feed68a8e3d835b47bcaa4
+  data.tar.gz: abcd346bebb4a05ef63e1fc5ad2616078f81bf2e1bfe9047efa61f010a2681d5bf1539bcc67c84b0398c2798dad62da5ee3fed58a195844899f49a812ea4ef8d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in formulary.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Bohme
+
+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/README.md

@@ -0,0 +1,75 @@
+# Formulary
+
+> <strong>Formularies</strong> (singular <strong>formulary</strong>; Latin <em>littera(e) formularis, -ares</em>) are medieval collections of models for the execution of documents (acta), public or private; a space being left for the insertion of names, dates, and circumstances peculiar to each case. Their modern equivalent are forms.
+>
+> -- <cite><a href="http://en.wikipedia.org/wiki/Formulary_%28model_documents%29">Wikipedia</a></cite> 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formulary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ 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}" />
+</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
+
+html_form.valid?({ email: "invalid", username: "person" })
+# => false
+
+html_form.errors
+# => {"email"=>"not a valid email"}
+```
+
+When an unexpected field is submitted that wasn't in the original markup, it will raise a `Formulary::UnexpectedParameter` exception:
+
+```ruby
+html_form.valid?({ unknown: "value" })
+# => Formulary::UnexpectedParameter: Got unexpected field 'unknown'
+```
+
+## Currently Supported
+
+- type="email"
+- required
+- pattern="REGEX"
+
+## TODO
+
+- select, 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)
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/formulary.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formulary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formulary"
+  spec.version       = Formulary::VERSION
+  spec.authors       = ["Matt Bohme", "Don Petersen"]
+  spec.email         = ["matt.bohme@g5searchmarketing.com", "don.petersen@g5searchmarketing.com"]
+  spec.description   = %q{Valid form submission based on the HTML5 validation on the form itself}
+  spec.summary       = %q{Valid form submission based on the HTML5 validation on the form itself}
+  spec.homepage      = "http://github.com/g5/formulary"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  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"
+  spec.add_development_dependency "rspec"
+end

data/lib/formulary.rb

@@ -0,0 +1,6 @@
+require 'nokogiri'
+require 'active_support/core_ext/object/blank'
+require 'email_veracity'
+
+require "formulary/version"
+require "formulary/html_form"

data/lib/formulary/html_form.rb

@@ -0,0 +1,101 @@
+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
+
+      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
+
+    def initialize(markup)
+      @markup = markup
+    end
+
+    def fields
+      @fields ||= build_fields
+    end
+
+    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)
+      end
+
+      fields.all?(&:valid?)
+    end
+
+    def errors
+      fields.each_with_object({}) do |field, hash|
+        hash[field.name] = field.error unless field.valid?
+      end
+    end
+
+  protected
+
+    def find_field(name)
+      fields.detect { |field| field.name == name.to_s }
+    end
+
+    def build_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
+
+
+        Field.new(
+          input.attributes["name"].value,
+          type,
+          input.attributes.include?("required"),
+          pattern
+        )
+      end
+    end
+  end
+
+  class UnexpectedParameter < StandardError
+
+  end
+end

data/lib/formulary/version.rb

@@ -0,0 +1,3 @@
+module Formulary
+  VERSION = "0.0.1"
+end

data/spec/html_form_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe Formulary::HtmlForm do
+  let(:markup) do
+    <<-EOS
+    <div class="lead widget">
+
+      <p class="heading">Apply</p>
+
+      <form id="lead_form" action="{{ widget.lead_form.submission_url.value }}" method="POST">
+
+        <div class="field">
+          <label for="first_name">First Name</label>
+          <input type="text" name="first_name" required />
+        </div>
+
+        <div class="field">
+          <label for="last_name">Last Name</label>
+          <input type="text" name="last_name" required />
+        </div>
+
+        <div class="field">
+          <label for="email">Email</label>
+          <input type="email" name="email" required />
+        </div>
+
+        <div class="field">
+          <label for="g5_email">G5 Email</label>
+          <input type="email" name="g5_email" pattern="@getg5\.com$" />
+        </div>
+
+        <div class="field">
+          <label for="phone">Phone</label>
+          <input type="tel" name="phone" />
+        </div>
+
+        <div class="field">
+          <label for="street_address">Street Address</label>
+          <input type="text" name="street_address" />
+        </div>
+
+        <div class="field">
+          <label for="city">City</label>
+          <input type="text" name="city" pattern="^[A-Za-z]*$" />
+        </div>
+
+        <div class="field">
+          <label for="state">State</label>
+          <input type="text" name="state" />
+        </div>
+
+        <div class="field">
+          <label for="zip">Zip</label>
+          <input type="text" name="zip" />
+        </div>
+
+        <div class="field">
+          <label for="message">Message</label>
+          <textarea name="message"></textarea>
+        </div>
+
+        <input type="submit" value="Apply" />
+
+      </form>
+    </div>
+    EOS
+  end
+
+  def valid_params(hash = {})
+    {
+      first_name: "First",
+      last_name: "Last",
+      email: "test@test.com",
+      g5_email: "test@getg5.com"
+    }.merge(hash)
+  end
+
+  let(:html_form) { Formulary::HtmlForm.new(markup) }
+
+  describe "#fields" do
+    let(:fields) { html_form.fields }
+    subject { fields }
+
+    its(:length) { should eq(10) }
+
+    describe "a required text input" do
+      subject { fields.first }
+
+      its(:name) { should eq("first_name") }
+      its(:type) { should eq("text") }
+      its(:required) { should be_true }
+    end
+
+    describe "a textarea that is not required" do
+      subject { fields[9] }
+
+      its(:name) { should eq("message") }
+      its(:type) { should eq("textarea") }
+      its(:required) { should be_false }
+    end
+
+    describe "an input with a pattern attribute" do
+      subject { fields[6] }
+
+      its(:pattern) { should eq("^[A-Za-z]*$") }
+    end
+  end
+
+  describe "#valid?" do
+    subject(:valid) { html_form.valid?(params) }
+    #before { subject }
+
+    context "with valid parameters" do
+      let(:params) { valid_params }
+      it { should be_true }
+    end
+
+    context "with valid parameters" do
+      context "phone number" do
+        let(:params) { valid_params(phone: "+1 456 123987") }
+        it { should be_true }
+      end
+    end
+
+    context "with invalid parameters" do
+      context "due to missing parameters" do
+        let(:params) { { last_name: "" } }
+
+        it { should be_false }
+
+        it "has an error for an omitted field" do
+          html_form.errors.keys.should include("first_name")
+          html_form.errors["first_name"].should include("required")
+        end
+
+        it "has an error for a blank field" do
+          html_form.errors.keys.should include("last_name")
+          html_form.errors["last_name"].should include("required")
+        end
+      end
+
+      context "due to failing regex check" do
+        let(:params) { valid_params(city: "New York") }
+
+        it { should be_false }
+
+        it "has an error for the field that doesn't match the pattern" do
+          valid
+          html_form.errors.keys.should include("city")
+          html_form.errors["city"].should include("format")
+        end
+      end
+
+      context "due to invalid email address" do
+        let(:params) { valid_params(email: "testing") }
+
+        it { should be_false }
+
+        it "has an error for the email field" do
+          valid
+          html_form.errors.keys.should include("email")
+          html_form.errors["email"].should include("not a valid email")
+        end
+      end
+
+      context "due to invalid g5 email address" do
+        let(:params) { valid_params(g5_email: "test@test.com") }
+
+        it { should be_false }
+
+        it "has an error for the g5 email field" do
+          valid
+          html_form.errors.keys.should include("g5_email")
+          html_form.errors["g5_email"].should include("format")
+        end
+      end
+
+      context "due to unexpected parameters" do
+        let(:params) { valid_params(extra: "test") }
+
+        it "raises a Formulary::UnexpectedParameter exception" do
+          expect { valid }.to raise_error(Formulary::UnexpectedParameter, /extra/)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'formulary'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: formulary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Bohme
+- Don Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: email_veracity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Valid form submission based on the HTML5 validation on the form itself
+email:
+- matt.bohme@g5searchmarketing.com
+- don.petersen@g5searchmarketing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formulary.gemspec
+- lib/formulary.rb
+- lib/formulary/html_form.rb
+- lib/formulary/version.rb
+- spec/html_form_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/g5/formulary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.8
+signing_key: 
+specification_version: 4
+summary: Valid form submission based on the HTML5 validation on the form itself
+test_files:
+- spec/html_form_spec.rb
+- spec/spec_helper.rb