sinatra-formkeeper 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-formkeeper.gemspec
+gemspec
+
+gem "hpricot"
+gem "rack"
+gem "sinatra"
+gem "formkeeper", "~> 0.0.4"
+
+group :development, :test do
+  gem "rspec"
+  gem "rake"
+  gem "rack-test"
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 lyokato
+
+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,44 @@
+# Sinatra::FormKeeper
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-formkeeper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-formkeeper
+
+## Usage
+
+### Getting Started
+
+  require 'sinatra/formkeeper'
+
+  get '/login' do
+    form do
+      filters :strip, :my_filter
+      field :username, :present => true, :length => 4..8
+      field :password, :present => true, :length => 4..8
+    end
+    if form.failed?
+      "login failed"
+    else
+      "login success " + form[:username] + ":" + form[:password]
+    end
+  end
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "run spec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ["-c", "-fs"]
+end

data/lib/sinatra/formkeeper/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module FormKeeper
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/formkeeper.rb

@@ -0,0 +1,128 @@
+#--
+# Copyright (C) 2012 Lyo Kato, <lyo.kato _at_ gmail.com>.
+#
+# 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. 
+
+require "sinatra/formkeeper/version"
+require 'formkeeper'
+
+module Sinatra
+  # = Sinatra::FormKeeper
+  #
+  # Example:
+  #
+  #   require 'sinatra/base'
+  #   require 'sinatra/formkeeper'
+  #
+  #   module MyApp < Sinatra::Base
+  #
+  #     register Sinatra::FormKeeper
+  #
+  #     def post '/login' do
+  #
+  #       form do 
+  #         filters :strip
+  #         field :username, :present => true, :length => 4..8, :ascii => true
+  #         field :password, :present => true, :length => 4..8, :ascii => true
+  #       end
+  #
+  #       # check if validation has failed or not
+  #       if form.failed?
+  #         output = erb :login
+  #         fill_in_form(output)
+  #       else
+  #         # you can use filtered, valid parameters through form[key]
+  #         authenticate(form[:username], form[:password])
+  #         ...
+  #         redirect '/mypage'
+  #       end
+  #     end
+  #   end
+  #
+  #   @@ login
+  #   <html>
+  #   <head><title>Login</title></head>
+  #   <body>
+  #   <% if form.failed? %>
+  #     <p>Found invalid input, check it and try again.</p>
+  #   <% end %>
+  #   <form action="/login" method="post">
+  #     <label>name</label><input type="text" name="username" /><br />
+  #     <label>password</label><input type="password" name="password" /><br />
+  #     <input type="submit" value="login">
+  #   </form>
+  #   </body>
+  #   </html>
+  #
+  module FormKeeper
+
+    def form_filter(name, &block)
+      ::FormKeeper::Validator.register_filter name, 
+        ::FormKeeper::Filter::Custom.new(block)
+    end
+
+    def form_constraint(name, &block)
+      ::FormKeeper::Validator.register_constraint name, 
+        ::FormKeeper::Constraint::Custom.new(block)
+    end
+
+    def form_messages(arg)
+      case arg
+      when String
+        messages = ::FormKeeper::Messages.from_file(arg)
+      when Hash
+        messages = ::FormKeeper::Messages.new(arg)
+      else
+        raise ArgumentError.new
+      end
+      set :form_failure_messages, messages
+    end
+    module Helpers
+      def reset_form
+        @form_report = ::FormKeeper::Report.new
+      end
+      def form(&block)
+        if block
+          rule = ::FormKeeper::Rule.new
+          rule.instance_eval(&block)
+          messages = settings.form_failure_messages
+          @form_report = 
+            settings.form_validator.validate(params, rule, messages)
+        end
+        @form_report
+      end
+      def fill_in_form(output, others={})
+        filled = settings.form_respondent.fill_up(output, params.merge(others))
+        output.replace(filled)
+        output
+      end
+    end
+    def self.registered(app)
+      app.helpers Helpers
+      app.set :form_validator, ::FormKeeper::Validator.new
+      app.set :form_respondent, ::FormKeeper::Respondent.new
+      app.set :form_failure_messages, nil
+      app.before do
+        reset_form
+      end
+    end
+  end
+  register FormKeeper
+end

data/sinatra-formkeeper.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/formkeeper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-formkeeper"
+  gem.version       = Sinatra::FormKeeper::VERSION
+  gem.authors       = ["lyokato"]
+  gem.email         = ["lyo.kato@gmail.com"]
+  gem.description   = %q{Sinatra extension which handles stuff around HTML forms}
+  gem.summary       = %q{This module provides you a easy way for form-validation and fill-in-form}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/app.rb

@@ -0,0 +1,47 @@
+require 'sinatra'
+require 'sinatra/formkeeper'
+
+form_messages File.expand_path(File.join(File.dirname(__FILE__), 'messages.yaml'))
+
+form_filter :my_filter do |value|
+  value.capitalize
+end
+
+get '/login' do
+  erb :login
+end
+
+post '/login' do
+  form do
+    filters :strip, :my_filter
+    field :username, :present => true, :length => 4..8
+    field :password, :present => true, :length => 4..8
+  end
+  if form.failed?
+    output = erb :login
+    fill_in_form(output)
+  else
+    "login success " + form[:username] + ":" + form[:password]
+  end
+end
+
+__END__
+
+@@ login
+<html>
+<head>Login</head>
+<body>
+<% if form.failed? %>
+<p>found invalid params</p>
+  <ul>
+<% form.messages(:login).each do |message| %>    <li><%= message %></li> 
+<% end %>  </ul>
+<% end %>
+<form action="/login" method="post">
+<input type="text" name="username" />
+<input type="text" name="password" />
+<input type="submit" value="login" />
+</form>
+</body>
+</html>
+

data/spec/app_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Sinatra::FormKeeper do
+  include Rack::Test::Methods
+  def app
+    @app ||= Sinatra::Application
+  end
+
+  describe "form validation" do
+    before  { get '/login' }
+    subject { last_response }
+    it "responds" do
+      should be_ok
+    end
+    it "returns repsonse body" do
+      subject.body.should == <<-HTML
+<html>
+<head>Login</head>
+<body>
+<form action="/login" method="post">
+<input type="text" name="username" />
+<input type="text" name="password" />
+<input type="submit" value="login" />
+</form>
+</body>
+</html>
+
+      HTML
+    end
+  end
+
+  describe "form validation with valid params" do
+    before  { post '/login', :username => ' john', :password => 'foobar'  }
+    subject { last_response }
+    it "responds" do
+      should be_ok
+    end
+    it "returns repsonse body" do
+      subject.body.should == "login success John:Foobar"
+    end
+  end
+
+  describe "form validation with invalid params" do
+    before  { post '/login', :username => 'John', :password => 'Foo'  }
+    subject { last_response }
+    it "responds" do
+      should be_ok
+    end
+    it "returns repsonse body" do
+      subject.body.should == <<-HTML
+<html>
+<head>Login</head>
+<body>
+<p>found invalid params</p>
+  <ul>
+    <li>Password's length should be between 4 and 8</li> 
+  </ul>
+<form action="/login" method="post">
+<input type="text" name="username" value="John" />
+<input type="text" name="password" value="Foo" />
+<input type="submit" value="login" />
+</form>
+</body>
+</html>
+
+      HTML
+    end
+
+  end
+
+  describe "form validation with multiple invalid params" do
+    before  { post '/login', :username => 'Bar', :password => 'Foo'  }
+    subject { last_response }
+    it "responds" do
+      should be_ok
+    end
+    it "returns repsonse body" do
+      subject.body.should == <<-HTML
+<html>
+<head>Login</head>
+<body>
+<p>found invalid params</p>
+  <ul>
+    <li>Name's length should be between 4 and 8</li> 
+    <li>Password's length should be between 4 and 8</li> 
+  </ul>
+<form action="/login" method="post">
+<input type="text" name="username" value="Bar" />
+<input type="text" name="password" value="Foo" />
+<input type="submit" value="login" />
+</form>
+</body>
+</html>
+
+      HTML
+    end
+
+  end
+end

data/spec/messages.yaml

@@ -0,0 +1,19 @@
+---
+login:
+  username:
+    present: You must input name
+    ascii: Name should be ASCII 
+    length: Name's length should be between 4 and 8
+    DEFAULT: Input your name correctly!
+  password:
+    present: You must input password
+    ascii: Password should be ASCII 
+    length: Password's length should be between 4 and 8
+DEFAULT:
+  username:
+    ascii: Name should be ASCII 
+    length: Name's length should be between 4 and 8
+    DEFAULT: Input your name correctly!
+  password:
+    ascii: Password should be ASCII 
+    length: Password's length should be between 4 and 8

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rack/test'
+require 'rspec'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'app.rb'))
+
+set :environment, :test
+set :run, false
+set :raise_error, true
+set :logging, false
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-formkeeper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- lyokato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies: []
+description: Sinatra extension which handles stuff around HTML forms
+email:
+- lyo.kato@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/formkeeper.rb
+- lib/sinatra/formkeeper/version.rb
+- sinatra-formkeeper.gemspec
+- spec/app.rb
+- spec/app_spec.rb
+- spec/messages.yaml
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This module provides you a easy way for form-validation and fill-in-form
+test_files:
+- spec/app.rb
+- spec/app_spec.rb
+- spec/messages.yaml
+- spec/spec_helper.rb