taxidermy

Clojure web forms inspired by WTForms

Usage

using Lein

[taxidermy "0.1.0"]

Import the code!

(use 'taxidermy.forms)
(require '[taxidermy.fields :as fields])
(require '[taxidermy.validation :as validation])

Defining a form

(defform contact
  :fields [
            (fields/text-field :label "First Name"
                        :field-name "first_name"
                        :validators [(validation/field-validator (validation/min-length? 2) "Must be at least two characters.")])
            (fields/text-field :label "Last Name"
                        :field-name "last_name")
            (fields/text-field :label "Email"
                        :field-name "email")
            (fields/boolean-field :label "Contact Me"
                           :field-name "contact_me")
            (fields/select-field :label "Newsletter"
                          :field-name "newsletter"
                          :choices [["Yes", 1]
                                    ["No", 0]])
            (fields/radio-field :field-name "question1"
                          :choices [["Yes", 1]
                                    ["No", 0]])
            (fields/select-field :label "Multi"
                                 :field-name "multi"
                                 :multiple true
                                 :choices [["A" 0]
                                           ["B" 1]
                                           ["C" 2]
                                           ["D" 3]])
          ])

Validate and process a form

;;Simulate some values from a web request
(def form-values {:first_name "Ryan" :last_name "Roemmich" :newsletter "1"})

;; Create an instance of the form with our values
(def contact-form (contact form-values))

;; validate the form
(def errors (validation/validate contact-form))
;; => {:first_name (), :last_name (), :email (), :contact_me (), :newsletter ()}

;; check for errors
(has-errors? errors)
;; => false

;; Get the processed values (note how contact_me gives a Boolean)
(processed-values form)
;; => {:first_name "Ryan", :last_name "Roemmich", :email "", :contact_me false, :newsletter 1 :question1 nil}

Get specific fields. Kept in the form as map keywords coresponding to the original :field-name used. Fields respond to toString so they can be used in templates

(def firstname (:first_name (:fields contact-form)))
(def newsletter-dropdown (:newsletter (:fields contact-form)))

;; see our text input
(str firstname)
;; => <input id="first_name" name="first_name" value="Ryan" />

;; working with a select box
;; direct render
(str newsletter-dropdown)
;; => <select id="newsletter" name="newsletter">
;; => <option selected="selected" value="1">Yes</option>
;; =>   <option value="0">No</option>
;; => </select>

;; iterate options (returns a seq of Records that can be used as maps
(.options newsletter-dropdown)
;; => [#taxidermy.widgets.Option{:config {:text "Yes", :value "1", :selected nil}} #taxidermy.widgets.Option{:config {:text "No", :value "0", :selected nil}}]
(:value (first (.options newsletter-dropdown)))
;; => 1
(:text (first (.options newsletter-dropdown)))
;; => "Yes"

;; radio widgets work in a similar manner
(.options question1)
;; => [{:label #taxidermy.widgets.Label{:for-name "question1-0", :text "Yes"}, :input #taxidermy.widgets.RadioInput{:field-name "question1", :id "question1-0", :value 1, :checked false}} {:label #taxidermy.widgets.Label{:for-name "question1-1", :text "No"}, :input #taxidermy.widgets.RadioInput{:field-name "question1", :id "question1-1", :value 0, :checked false}}]
(:label (first (.options question1)))
;; => #taxidermy.widgets.Label{:for-name "question1-0", :text "Yes"}
(:value (:input (first (.options question1))))
;; => 1

Todo

• Button

License

Copyright © 2012 Ryan Roemmich

Distributed under the MIT License