sinatra-formkeeper 0.0.5 → 0.0.6

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 gem "hpricot"
 gem "rack"
 gem "sinatra"
-gem "formkeeper", "~> 0.0.8"
+gem "formkeeper", "~> 0.0.9"
 
 group :development, :test do
   gem "rspec"

data/README.md

@@ -42,13 +42,13 @@ end
 
 ### 0: Preparation
 
-At your application file's header, add 'require' line for this library.
+At your application file's header, add `require` line for this library.
 
 ```ruby
 require 'sinatra/formkeeper'
 ```
 
-And if your application is Sinatra::Base inheritance type, register Sinatra::FormKeeper
+And if your application is `Sinatra::Base` inheritance type, register `Sinatra::FormKeeper`
 
 ```ruby
 class MyApp < Sinatra::Base
@@ -73,13 +73,13 @@ post '/entry' do
 end
 ```
 
-Calling 'form' with block which includes rule-setting,
+Calling `form` with block which includes rule-setting,
 you can build a form-rule.
-There are some DSL-method to build rules. In this example, 'filters' and 'field' are written.
+There are some DSL-method to build rules. In this example, `filters` and `field` are written.
 
 #### filters
 
-You can set 'filters'. All input parameters are filtered by indicated filtering feature
+You can set `filters`. All input parameters are filtered by indicated filtering feature
 The filtering process is executed before validation.
 
 ```ruby
@@ -98,7 +98,7 @@ form do
 end
 ```
 
-All preset filters are described at [8: Preset Filters]
+All preset filters are described at [8: Preset Filters](#8-preset-filters)
 
 #### field
 
@@ -111,7 +111,7 @@ form do
 end
 ```
 
-This constraint works for an input form named as "field_name", for instance
+This constraint works for an input form named as `field_name`, for instance
 
 ```html
 <input type="text" name="field_name" />
@@ -121,11 +121,11 @@ And key-value pares are following the field name.
 They are constraints set for the field.
 You can add your favorite constraints here.
 
-All preset constraints are described at [9: Preset Constraints]
+All preset constraints are described at [9: Preset Constraints](#9-preset-constraints)
 Read the chapter for more detail.
 
-:present is a special constraint. if parameter not found for the field which
-set :present constraint, the field will be marked as 'not present',
+`:present` is a special constraint. if parameter not found for the field which
+set `:present` constraint, the field will be marked as *not present*,
 and other validation for rest constraints won't be executed.
 
 You also can set :default
@@ -140,11 +140,11 @@ end
 When it's set, if parameter not found, the indicated value will be set
 and other validation for rest constraints won't be executed.
 
-You aren't allowed to set both :present and :default at same time.
+You aren't allowed to set both *:present* and *:default* at same time.
 
 And you can set filters here,
 if you don't want to filter all the parameters included in the request.
-This filtering setting only affets on :field_name.
+This filtering setting only affets on `:field_name`.
 
 ```ruby
 form do
@@ -196,12 +196,12 @@ Or
 ```
 
 Rack request handle such type of name (exp: field_name[]) as Array.
-For this type of input, use 'selection' method.
-In this case, you must use :count constraints instead of :present.
+For this type of input, use `selection` method.
+In this case, you must use `:count` constraints instead of `:present`.
 
 #### combination
 
-There is another special rule, 'Combination'
+There is another special rule, *Combination*
 
 ```ruby
 form do
@@ -214,7 +214,7 @@ Set rule-name as a first argument.
 And you should set multiple target fields.
 And one constraint like (:same => true), or (:any => true).
 
-:same and :any are called as 'Combination Constraint'
+`:same` and `:any` are called as *Combination Constraint*
 For this purpose, formkeeper provides you a simple way to do same things.
 
 ```ruby
@@ -224,14 +224,14 @@ form do
 end
 ```
 
-You can call a name of 'Combination Constraints' as a method.
+You can call a name of *Combination Constraints* as a method.
 Followed by rule-name and target-fields.
 
-All preset constraints are described at [10: Preset Combination Constraints]
+All preset constraints are described at [10: Preset Combination Constraints](#10-preset-combination-constraints)
 
 ### 2: Check if user's input is valid or not
 
-'form.failed?' can be used to judge if user's input is valid for the rule you build.
+`form.failed?` can be used to judge if user's input is valid for the rule you build.
 
 ```ruby
 post '/entry' do 
@@ -251,9 +251,9 @@ end
 After validation is proccessed without any failure,
 you can implement your domain logic with valid parameters.
 
-'form[:field_name]' can be used to pick up a valid data.
+`form[:field_name]` can be used to pick up a valid data.
 This data you can obtain through this method is a filtered data
-according to the rule you build (if you set a 'filters' rule).
+according to the rule you build (if you set a `filters` rule).
 
 ```ruby
 post '/entry' do 
@@ -273,7 +273,7 @@ end
 
 When validation is failed, you might want to provide user
 same form again, with error message that describes what fields was invalid.
-For this purpose, use 'failed_on?' method.
+For this purpose, use `failed_on?` method.
 
 ```ruby
 post '/entry' do 
@@ -310,7 +310,7 @@ __END__
 
 ### 5: Check if what field and constraint has failed?
 
-You can pass constraint-type to 'failed_on?' as a second argument.
+You can pass constraint-type to `failed_on?` as a second argument.
 This provides you a way to show detailed error-messages.
 
 ```ruby
@@ -352,7 +352,7 @@ __END__
 ### 6: Fill in form
 
 In many case you might want to fill in form with user's last input.
-Do like following. 'fill_in_form' automatically fill the fields with 'params'
+Do like following. `fill_in_form` automatically fill the fields with `params`
 
 ```ruby
 post '/entry' do 
@@ -389,7 +389,7 @@ DEFAULT:
 -- ... 
 ```
 
-DEFAULT is a special type. If it can't find setting for indicated validation-type, it uses message set for DEFAULT.
+`DEFAULT` is a special type. If it can't find setting for indicated validation-type, it uses message set for `DEFAULT`.
 After you prepare a yaml file, load it.
 
 ```ruby
@@ -451,19 +451,202 @@ If you want to show messages for each field, separately, of course you can.
 
 ### 9: Preset Constraints
 
-#### present
 #### length
+
+calculate length. this constraint use String#length internally
+You can set integer.
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :length => 10
+  end
+  #...
+end
+```
+
+Or as range
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :length => 4..10
+  end
+  #...
+end
+```
+
 #### bytesize
+
+Calculate byte size. this constraint use String#bytesize internally
+You can set integer.
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :bytesize => 10
+  end
+  #...
+end
+```
+
+Or as range
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :bytesize => 4..10
+  end
+  #...
+end
+```
+
 #### ascii
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :ascii => true
+  end
+  #...
+end
+```
+
 #### regexp
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :regexp => %r{regexp}
+  end
+  #...
+end
+```
+
 #### int
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :int => true
+  end
+  #...
+end
+```
+
+Fore more detailed constraint,
+You can use following options as a hash.
+
+* gt: This means >
+* gte: This means >=
+* lt: This means <
+* lte: This means <=
+* between: Or you can set Range object
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :int => { :gt => 5, :lt => 10 }
+  end
+  #...
+end
+```
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :int => { :gte => 5, :lte => 10 }
+  end
+  #...
+end
+```
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :int => { :between => 5..10 }
+  end
+  #...
+end
+```
+
 #### uint
+
+Unsined integer. This doesn't allow lass than zero.
+Except for that, it behaves same as integer
+
+```ruby
+post '/entry' do 
+  form do
+    field :field01, :present => true, :uint => { :between => 5..10 }
+  end
+  #...
+end
+```
+
 #### alpha
+
+Alphabet
+
 #### alpha_space
+
+Alphabet and Space
+
 #### alnum
+
+Alphabet and Number
+
 #### alnum_space
+
+Alphabet, Number and Space
+
+#### email
+
+Email-Address
+
+```ruby
+post '/entry' do 
+  form do
+    field :your_address, :present => true, :email => true, :bytesize => 10..255
+  end
+  #...
+end
+```
+
 #### uri
 
+Limit a scheme as Array
+
+```ruby
+post '/entry' do 
+  form do
+    field :your_address, :present => true, :uri => [:http, :https], :bytesize => 10..255
+  end
+  #...
+end
+```
+
+```ruby
+post '/entry' do 
+  form do
+    field :your_address, :present => true, :uri => [:http], :bytesize => 10..255
+  end
+  #...
+end
+```
+
+If your scheme option is only one.
+You can set as a String.
+
+```ruby
+post '/entry' do 
+  form do
+    field :your_address, :present => true, :uri => :http, :bytesize => 10..255
+  end
+  #...
+end
+```
+
 ### 10: Preset Combination Constraints
 
 #### same

data/lib/sinatra/formkeeper/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module FormKeeper
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-formkeeper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Sinatra extension which handles stuff around HTML forms
 email: