egalite 1.0.0 → 1.1.0

data/README.md

@@ -2,11 +2,19 @@
 
 Egaliteは、Ruby用のウェブアプリケーションフレームワークです。自社用に使っているフレームワークですが、使う人の利便性などを考えてオープンソースにしてgemで公開しています。
 
+添付ライブラリ等の説明:
+* [メール送信ライブラリ](sendmail.md)
+* [管理画面作成ツール](htmlbuilder.md)
+
 ## 概要
 
 いわゆるMVC構造のフレームワークです。O/RマッパーとしてはSequelを使うことを想定しています。モデルはSequelをそのまま使いますので、本ドキュメントでは言及しません。
 
-ビューは独自のテンプレートエンジンを使用しており、HTMLからコードをなるべく廃するという思想で作っています。
+ビューは、独自のテンプレートエンジンを使用しており、HTMLからコードをなるべく廃するという思想で作っています。
+
+コントローラは、メソッドの戻り値のみによって結果を返すようになっており、HTTPに対する処理の流れとして違和感がない作りになっています。
+
+自動でXSSやCSRFを防ぐための機構を持っています。
 
 ## コントローラーの基本
 
@@ -91,20 +99,28 @@ URL以外で引き渡されるパラメーター(クエリパラメータやPOST
 
 ## セキュリティ対応
 
+### 自動XSS対策機能
+
+テンプレートエンジンは、与えられた文字列を自動でエスケープします。もしエスケープして欲しくないときは、文字列をNonEscapeStringという型にキャストしてからテンプレートエンジンに渡します。
+
+コントローラ内では、このキャストはraw(string)というメソッドで行えます。
+
 ### 自動CSRF対策機能
 
 egaliteには自動でCSRF対策のチェック値を埋め込む機能が付いています。この機能を有効にすると自動でCSRF対策を行うことができます。
 
-【注意】外部のサイトにフォームを送信するときにセッション情報が送られてしまいますので、外部のサイトにフォームを送る必要があるシステムでは絶対に使わないでください。(そのうち改善します)
+テンプレートエンジンが勝手にformタグを見つけて、勝手にcsrf情報を埋め込むhiddenタグが付与されます。
 
-有効にする方法は以下の通りです。
+【注意】外部のサイトにフォームを送信するときにセッション情報が送られてしまいますので、外部のサイトにフォームを送るときは、<form>タグを<form :nocsrf action='hoge' method='POST'>のように記述してください。
 
-  egalite = Egalite::Handler.new(
-    :db => db,
-    :template_engine => Egalite::CSRFTemplate
-  )
+有効にする方法は以下の通りです。
 
-  class Pages < Egalite::CSRFController
-  end
+	egalite = Egalite::Handler.new(
+	  :db => db,
+	  :template_engine => Egalite::CSRFTemplate
+	)
+	
+	class Pages < Egalite::CSRFController
+	end
 
 

data/htmlbuilder.md

@@ -0,0 +1,62 @@
+
+# 管理画面作成ツール
+
+Egaliteでは、HTMLを書かずとも、簡単な管理画面のためのテーブルやフォームを作成するためのライブラリを備えています。
+
+この機能を使えば、いちいちページごとにHTMLを書かずとも、20行程度のコードで簡単な管理画面を作成することができますので、生産性・メンテナンス性が大きく改善されます。
+
+ただし、あまり複雑なページにこれを使うと、コードがぐちゃぐちゃになりますので、どっかのタイミングで諦めてHTMLに移行するほうが無難です。
+
+## テーブル作成ツール
+
+	recs = User.map { |rec| [rec.id, rec.name, rec.email] }
+	table_by_array(["番号","氏名","メールアドレス"],recs)
+
+とするだけで、ユーザ一覧のテーブルが生成できます。これをひな形となるテンプレートの一部分に投入すれば、それだけで一覧画面が完成します。
+
+## フォーム作成ツール
+
+	rec = User[id]
+	fm = form(rec) # FormHelperインスタンスを取得します
+	fm.text(:name) # => "<input type='text' name='name' value='#{rec.user}'/>"
+	fm.password(:password) # => "<input type='password' name='password'/>"
+	fm.hidden(:foo) # => "<input type='hidden' name='foo' value='#{rec.foo}'/>"
+	fm.checkbox(:cb) # => "<input type='checkbox' name='cb' value='true' #{rec.cb ? 'checked' : ''}/>"
+	fm.radio(:rd, "foo") # => "<input type='checkbox' name='rd' value='foo' #{rec.rd == 'foo' ? 'selected' : ''}/>"
+	fm.textarea(:ta) # => <textarea name='ta'>#{rec.ta}</textarea>
+	fm.file(:file) # => <input type='file' name='file'/>
+	fm.submit("登録") # => <input type='submit' value='登録'/>
+
+これで作成したフォームを以下のように組むことで、フォームのテーブルが作れます。
+
+	left = ["名前","メールアドレス"]
+	right = [fm.text(:name), fm.text(:email)]
+	table_by_array(nil, left.zip(right))
+
+## タグ作成ツール
+
+### 単独タグ作成
+
+	tags.br # => <br/>
+
+brとhrが使えます。
+
+### 囲みタグ作成
+
+	tags.p("ほげ") # => "<p>ほげ</p>"
+
+h1 h2 h3 h4 b i p html bodyなどがこのように作れます。
+
+### リンク
+
+	tags.a("http://example.com","ほげ") # => <a href="http://example.com">ほげ</a>
+
+### liタグ
+
+	tags.li(["foo","bar"]) # => <li>foo</li><li>bar</li>
+
+### リストタグ作成
+
+	tags.ul(["foo","bar"]) # => <ul><li>foo</li><li>bar</li></ul>
+
+ulとolが使えます。

data/lib/egalite/cache.rb

@@ -0,0 +1,85 @@
+
+=begin
+キャッシュテーブルのデータ定義:
+
+CREATE TABLE controller_cache (
+  id SERIAL PRIMARY KEY,
+  inner_path TEXT UNIQUE NOT NULL,
+  language TEXT,
+  updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  content TEXT NOT NULL
+);
+=end
+
+module Egalite
+  module ControllerCache
+    class <<self
+      attr_accessor :table
+      
+      def create_table(db, opts = {})
+        table = opts[:table_name] || :controller_cache
+        
+        db.create_table(table) {
+          primary_key :id, :integer, :auto_increment => true
+          column :inner_path, :varchar
+          column :language, :varchar
+          column :updated_at, :timestamp
+          column :content, :varchar
+        }
+      end
+    end
+    module ClassMethods
+      attr_reader :controller_cache_actions
+      def cache_action(action, options)
+        @controller_cache_actions ||= {}
+        @controller_cache_actions[action.to_s] = options
+      end
+    end
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    def __controller_cache__dataset
+      table = Egalite::ControllerCache.table
+      dataset = table.filter(:inner_path => req.inner_path)
+      if req.language
+        dataset = dataset.filter(:language => req.language)
+      end
+      dataset
+    end
+    def before_filter
+      cache = self.class.controller_cache_actions[req.action_method]
+      if cache
+        result = super
+        if result != true
+          return result
+        end
+        dataset = __controller_cache__dataset
+        record = dataset.first
+        return true unless record
+        return true if record[:updated_at] < (Time.now - cache[:expire])
+        record[:content]
+      else
+        super
+      end
+    end
+    def after_filter_html(html)
+      html = super(html)
+      if self.class.controller_cache_actions[req.action_method]
+        dataset = __controller_cache__dataset
+        data = {
+          :inner_path => req.inner_path,
+          :language => req.language,
+          :updated_at => Time.now,
+          :content => html,
+        }
+        if dataset.count > 0
+          dataset.update(data)
+        else
+          Egalite::ControllerCache.table.insert(data)
+        end
+      end
+      return html
+    end
+  end
+end
+

data/lib/egalite/m17n.rb

@@ -15,6 +15,7 @@ module Egalite
         end
         @lang ||= Translation.lang(Translation.user_default_lang)
         @lang ||= Translation.lang('ja')
+        req.language = @lang
         
         super
       end

data/lib/egalite/sendmail.rb

@@ -1,6 +1,7 @@
 
 require 'nkf'
 require 'time'
+require 'net/smtp'
 
 # mailheaders
 # {

data/lib/egalite/template.rb

@@ -264,7 +264,7 @@ class CSRFTemplate < HTMLTemplate
       csrf = nil
       if attrs[":nocsrf"]
         attrs.delete(":nocsrf")
-      elsif attrs["method"] =~ /\APOST\Z/i
+      elsif attrs["method"].upcase == "POST"
         csrf = params["csrf"]
         csrf = "<input type='hidden' name='csrf' value='#{escapeHTML(csrf)}'/>"
       end

data/lib/egalite/version.rb

@@ -1,3 +1,3 @@
 module Egalite
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/egalite.rb

@@ -519,6 +519,7 @@ class Handler
     before_filter_result = controller.before_filter
     if before_filter_result != true
       return before_filter_result if before_filter_result.is_a?(Array)
+      return [200,{'Content-Type' => "text/html"},[before_filter_result]] if before_filter_result.is_a?(String)
       return forbidden unless before_filter_result.respond_to?(:command)
       response = case before_filter_result.command
        when :delegate
@@ -561,7 +562,8 @@ class Handler
     elsif values.is_a?(Array)
       values
     elsif values.is_a?(String)
-      [200,{'Content-Type' => "text/html"},[values]]
+      html = controller.after_filter_html(values)
+      [200,{'Content-Type' => "text/html"},[html]]
     elsif values.is_a?(Rack::Response)
       values.to_a
     elsif values == nil
@@ -627,9 +629,6 @@ class Handler
     req.path_params = path_params
     req.path_info = path_params.join('/')
 
-    # todo: language handling (by pathinfo?)
-    # todo: session handling (by pathinfo?)
-    
     res = run_controller(controller, action, req)
     
     if first_call

data/sendmail.md

@@ -0,0 +1,54 @@
+
+# Egalite メール送信ライブラリ
+
+Egaliteにはシンプルなメール送信ライブラリが付属しています。
+
+	require 'rubygems'
+	require 'egalite'
+	require 'egalite/sendmail'
+
+多バイト文字によるメール送信に対応しており、簡単にメールを送ることができます。デフォルトではUTF8エンコーディングでメールを送信します。
+
+HTMLメールや添付ファイルには現在は対応しておりません。
+
+SMTPの凝った機能(認証や暗号化等)には対応しておりませんし、今後も対応するつもりはありません。必要であれば、ローカルのメールサーバー(Postfix等)の設定で対応してください。
+
+## メールを送信する
+
+	Sendmail.send(
+		body, # メール本文
+		{:from => "from@example.com",
+		 :reply_to => "replyto@example.com", # 省略可
+		 :to => { "James Dean" => "james@example.com", 
+		          "新井太郎" => "foo@example.com" },
+		 :cc => "",
+		 :bcc => "",
+		 :subject => "お打ち合わせについて"
+		}, # その他、メールヘッダに入れたいものは何でも入れられます
+		"localhost" # メールサーバのアドレス (省略可)
+	)
+
+メールの宛先や送信人などについては、メールアドレスだけを記載することもできますし、Hash形式で名前とメールアドレスの両方を指定することもできます。
+
+## テンプレートを使ってメールを送信する
+
+	Sendmail.send_with_template(
+		"mailtext.txt", # メールテンプレート (HTMLテンプレートとほぼ同様)
+		{
+		 :from => "from@example.com",
+		 :to => "to@example.com",
+		 :name => "新井 太郎",
+		 :price => "3,000円",
+		}, # メールヘッダと、テンプレートに埋め込む内容を入れます
+		"localhost"     # メールサーバのアドレス (省略可)
+	)
+
+## メール送信をテストする
+
+	Sendmail.mock = true
+
+とすると、メールを送信する代わりに内部に記録しておくようになります。影響はグローバルに及びます。
+
+	(text, envelope_from, to, host) = Sendmail.lastmail
+
+とすることで、送信したメールの取得ができます。これもグローバル変数です。

data/test/cache.html

@@ -0,0 +1,8 @@
+<html>
+<body>
+cache:<include :action='cache'/>
+<br/>
+nocache:<include :action='nocache'/>
+<br/>
+</body>
+</html>

data/test/cache_cache.html

@@ -0,0 +1 @@
+&=time;

data/test/cache_nocache.html

@@ -0,0 +1 @@
+&=time;

data/test/test_cache.rb

@@ -0,0 +1,130 @@
+$LOAD_PATH << File.dirname(__FILE__)
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..')
+
+require 'rubygems'
+require 'sequel'
+require 'test/unit'
+require 'egalite'
+require 'egalite/cache'
+
+require 'rack'
+require 'rack/test'
+
+require 'setup'
+
+class TestCacheController < Egalite::Controller
+  include Egalite::ControllerCache
+  
+  cache_action :get, :expire => 1
+  
+  def get
+    "#{Time.now.to_i}.#{Time.now.usec}"
+  end
+  def nocache
+    "#{Time.now.to_i}.#{Time.now.usec}"
+  end
+end
+
+class CacheController < Egalite::Controller
+  include Egalite::ControllerCache
+  
+  cache_action :cache, :expire => 1
+  
+  def get
+    {}
+  end
+  def cache
+    {:time => "#{Time.now.to_i}.#{Time.now.usec}"}
+  end
+  def nocache
+    {:time => "#{Time.now.to_i}.#{Time.now.usec}"}
+  end
+end
+
+class T_Cache < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def app
+    db = Sequel.sqlite
+    Egalite::ControllerCache.create_table(db)
+    Egalite::ControllerCache.table = db[:controller_cache]
+    Egalite::Handler.new
+  end
+  def test_cache
+    # test cache is not working
+    get "/test/cache/nocache"
+    a = last_response.body
+    sleep 0.1
+    get "/test/cache/nocache"
+    b = last_response.body
+    assert_not_equal a,b
+    
+    # test cache is working
+    get "/test/cache/"
+    a = last_response.body
+    sleep 0.1
+    get "/test/cache/"
+    b = last_response.body
+    assert_equal a,b
+    sleep 2
+    get "/test/cache/"
+    c = last_response.body
+    assert_not_equal a,c
+    
+    # test cache is not working for different url
+    get "/test/cache/1"
+    a = last_response.body
+    sleep 0.1
+    get "/test/cache/2"
+    b = last_response.body
+    assert_not_equal a,b
+  end
+end
+
+# テンプレートでのテスト
+class T_CacheTemplate < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    db = Sequel.sqlite
+    Egalite::ControllerCache.create_table(db)
+    Egalite::ControllerCache.table = db[:controller_cache]
+    Egalite::Handler.new(:template_path => File.dirname(__FILE__))
+  end
+  def test_cache
+    # test cache is not working
+    get "/cache/"
+    last_response.body =~ /nocache:(.+?)\n/
+    a = $1
+    sleep 0.1
+    get "/cache/"
+    last_response.body =~ /nocache:(.+?)\n/
+    b = $1
+    assert_not_equal a,b
+    
+    # test cache is working
+    get "/cache/"
+    last_response.body =~ /\ncache:(.+?)\n/
+    a = $1
+    sleep 0.1
+    get "/cache/"
+    last_response.body =~ /\ncache:(.+?)\n/
+    b = $1
+    assert_equal a,b
+    sleep 2
+    get "/cache/"
+    last_response.body =~ /\ncache:(.+?)\n/
+    c = $1
+    assert_not_equal a,c
+    
+    # test cache is not working for different url
+    get "/cache?1"
+    last_response.body =~ /\ncache:(.+?)\n/
+    a = $1
+    sleep 0.1
+    get "/cache?2"
+    last_response.body =~ /\ncache:(.+?)\n/
+    a = $1
+    assert_not_equal a,b
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: egalite
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Shunichi Arai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-07 00:00:00 Z
+date: 2014-04-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -82,9 +82,11 @@ files:
 - examples/simple/run_webrick.rb
 - examples/simple_db/example_db.rb
 - examples/simple_db/pages/edit.html
+- htmlbuilder.md
 - lib/egalite.rb
 - lib/egalite/auth/basic.rb
 - lib/egalite/blank.rb
+- lib/egalite/cache.rb
 - lib/egalite/errorconsole.rb
 - lib/egalite/helper.rb
 - lib/egalite/keitai/keitai.rb
@@ -110,7 +112,11 @@ files:
 - lib/egalite/support.rb
 - lib/egalite/template.rb
 - lib/egalite/version.rb
+- sendmail.md
 - test.bat
+- test/cache.html
+- test/cache_cache.html
+- test/cache_nocache.html
 - test/french.html
 - test/french_msg.html
 - test/m17n.txt
@@ -122,6 +128,7 @@ files:
 - test/template_innerparam.html
 - test/test_auth.rb
 - test/test_blank.rb
+- test/test_cache.rb
 - test/test_csrf.rb
 - test/test_errorconsole.rb
 - test/test_handler.rb
@@ -167,6 +174,9 @@ signing_key:
 specification_version: 3
 summary: Egalite - yet another web application framework.
 test_files: 
+- test/cache.html
+- test/cache_cache.html
+- test/cache_nocache.html
 - test/french.html
 - test/french_msg.html
 - test/m17n.txt
@@ -178,6 +188,7 @@ test_files:
 - test/template_innerparam.html
 - test/test_auth.rb
 - test/test_blank.rb
+- test/test_cache.rb
 - test/test_csrf.rb
 - test/test_errorconsole.rb
 - test/test_handler.rb