這種表示。
13 |
14 | ### 本章練習主題
15 |
16 | * 學會寫出 CRUD 七個 action 的 controller 與 view
17 | * 學會利用 migration 新增資料庫欄位
18 | * 學會撰寫「表單」
19 | * 學會設定 Route
20 | * 學會 resources 的設定 （單層 resources)
21 | * 對 Rails RESTful 有初步的理解
22 | * 知道 before_action 使用的場景，並如何應用
23 |
24 |
25 |
26 | {::pagebreak :/}
27 |
28 | ## Ch 1.0 CRUD
29 |
30 | CRUD 指的是 Create(新增)、Read(讀取)、Update(更新)、Destroy(刪除)四種操作資料的基本方式，這也是開發網站時幾乎大家最常寫到的四種功能。
31 |
32 | Rails 在開發上極具優勢的其中一個原因，就是使用了 RESTful 的機制以及 內建的 Convention，在實作 CRUD-like 功能時，隔外顯現開發速度上的優勢。
33 |
34 | ### 實作課題
35 |
36 | 本章將會實作以下課題
37 |
38 | * 產生 Group 與 Post 這兩個 Model
39 | * Group 需要有名稱 title, description
40 | * Post 需要有文章標題 文章內容 content
41 | * 寫出 Group 的 CRUD controller 與 View
42 | * 寫出 Posts 的 CRUD controller 與 View
43 | * 在 routing 中對 Group 和 Posts 分別宣告它們都是 resources
44 |
45 |
--------------------------------------------------------------------------------
/manuscript/chapter-01-1-0-extra-2.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## 補充章節：RESTful on Rails
4 |
5 | Representational State Transfer，簡稱 REST。是 Roy Fielding 博士在2000年他的博士論文中提出來的一種軟體架構風格。目前是一種相當風行的 Web Services 實現手法，因為 REST 風格的 Web Services 遠比傳統的 SOAP 與 XML-RPC 來的簡潔。在近年，幾乎所有各大主流網站的 API 都已採用此種風格進行設計。
6 |
7 | ### What is REST?
8 |
9 | REST 提出了一些設計概念和準則：
10 |
11 | 1. 網路上的所有事物都被將被抽象成資源 (resource)
12 | 2. 每個資源對應一個唯一的 resource identifier
13 | 3. 通過通用的介面 (generic connector interface) 對資源進行操作
14 | 4. 對資源的各種操作不會改變 resource idetifier
15 | 5. 所有的操作都是無態 (stateless) 的
16 |
17 | 對照到 web services 上來說：
18 |
19 | * resource indentifier 是 URI
20 | * generic connector interface 是 HTTP
21 |
22 | {::pagebreak :/}
23 |
24 | ### RESTful Web Services
25 |
26 | RESTful Web Services 是使用 HTTP 並遵循 REST 設計原則的 Web Services。它從以下三個方面資源進行定義：
27 |
28 | * URI，比如：http://example.com/resources/。
29 | * Web Services accept 與 return 的 media type，如：JSON，XML ，YAML 等。
30 | * Web Services 在該 resources 所支援的一系列 request methid : 如：POST，GET，PUT 或 DELETE。
31 |
32 | 以下列出在實現 RESTful Web 服務時HTTP請求方法的典型用途。
33 |
34 | #### GET
35 |
36 | |資源 | GET |
37 | |-------------------|-----------|
38 | |一組資源的URI，比如http://example.com/resources/ | 使用給定的一組資源替換當前整組資源。|
39 | |單個資源的URI，比如http://example.com/resources/142 | 獲取 指定的資源的詳細信息，格式可以自選一個合適的 media type（如：XML、JSON等）|
40 |
41 | #### PUT
42 |
43 | |資源 | PUT|
44 | |-------------------|-----------|
45 | |一組資源的URI，比如http://example.com/resources/ | 列出 URI，以及該資源組中每個資源的詳細信息（後者可選）。|
46 | |單個資源的URI，比如http://example.com/resources/142 | 替換/創建 指定的資源。並將其追加到相應的資源組中。|
47 |
48 | #### POST
49 |
50 | |資源 | POST|
51 | |-------------------|-----------|
52 | |一組資源的URI，比如http://example.com/resources/ | 在本組資源中創建/追加一個新的資源。 該操作往往返回新資源的URL。|
53 | |單個資源的URI，比如http://example.com/resources/142 | 把指定的資源當做一個資源組，並在其下創建/追加一個新的元素，使其隸屬於當前資源。|
54 |
55 | {::pagebreak :/}
56 |
57 | #### DELETE
58 |
59 | |資源 | DELETE|
60 | |-------------------|-----------|
61 | |一組資源的URI，比如http://example.com/resources/ | 刪除 整組資源。|
62 | |單個資源的URI，比如http://example.com/resources/142 | 刪除 指定的元素。|
63 |
64 | {::pagebreak :/}
65 |
66 | ### 制約即解放
67 |
68 | DHH 在 [Discovering a world of Resources on Rails](http://www.slideshare.net/vishnu/discovering-a-world-of-resources-on-rails) 提到一個核心概念：Constraints are liberating 。
69 |
70 | 很多剛踏入 Rails 這個生態圈的開發者，對於 REST 總有股強烈的反抗心態，認為 REST 是一個討厭的限制。但事實上，DHH 卻認為引入 REST 的制約卻反為 Rais 開發帶來了更大的解放，而這也是他引入這個設計的初衷。
71 |
72 | #### 維護性：解決了程式碼上的風格不一
73 |
74 | 在傳統的開發方式中，對於有效組織網頁應用中的程式碼，大家並沒有什麼共識。所以很可能在專案中會出現這種風格不一致的程式碼：
75 |
76 | ``` ruby
77 | def add_friend
78 | end
79 |
80 | def remove_friend
81 | end
82 |
83 | def create_post
84 | end
85 |
86 | def delete_post
87 | end
88 |
89 | ```
90 | 透過 REST 的包裝（對於 resource 的操作），可以變得更簡潔直觀，且具有統一的寫法。
91 |
92 | ``` ruby
93 | class FriendShipController
94 | def create
95 | end
96 |
97 | def destroy
98 | end
99 | end
100 |
101 | class PostController
102 | def create
103 | end
104 |
105 | def destroy
106 | end
107 | end
108 |
109 | ```
110 |
111 | ### 介面統一：Action as Resource
112 |
113 | 大眾最常對 REST 產生的一個誤解，就是以為 resource 只有指的是 data。其實 resource 指的是：data + representation (表現形式，如 html, xml, json 等)。
114 |
115 | 在網頁開發中，網站所需要的表現格式，不只有 HTML 而已，有時候也需要提供 json 或者 xml。Rails 透過 responder 實現了
116 |
117 | 在 Resource Oriented Architecture (ROA，一組 REST 架構實現 guideline) 中有一條： `A resource can use file extension in the URI, instead of Content-Type negotiation `。
118 |
119 | Rails 透過 responder 的設計，讓一個 action 可以以 file extension ( .json, .xml, .csv ...etc.) 的形式，提供不同類型的 representation。
120 |
121 | ``` ruby
122 | class PostsController < ApplicationController
123 | # GET /posts
124 | # GET /posts.xml
125 | def index
126 | @posts = Post.all
127 |
128 | respond_to do |format|
129 | format.html # index.html.erb
130 | format.xml { render :xml => @posts }
131 | end
132 | end
133 |
134 | ```
135 |
136 |
137 |
138 | ### 開發速度：透過 CRUD 七個 action + HTTP 四個 verb + 表單 Helper 與 URL Helper 達到高速開發
139 |
140 | REST 之所以能簡化開發，是因為其所引入的架構約束。Rails 中的 REST implementation 將 controller 的 method 限制在七個：
141 |
142 | * index
143 | * show
144 | * new
145 | * edit
146 | * create
147 | * update
148 | * destroy
149 |
150 | 實際上就是整個 CRUD。而在實務上，web services 的需要的操作行為，其實也不脫這七種。Rails 透過 HTTP 作為 generic connector interface，使用 HTTP 的四種 verb ： GET、POST、PUT、DELETE 對資源進行操作。
151 |
152 | {::pagebreak :/}
153 |
154 | #### GET
155 |
156 | ``` ruby
157 | <%= link_to("List", posts_path) %>
158 | <%= link_to("Show", post_path(post)) %>
159 | <%= link_to("New", new_post_path) %>
160 | <%= link_to("Edit", edit_post_path(post)) %>
161 | ```
162 |
163 | #### POST
164 | ``` ruby
165 | <%= form_for @post , :url => posts_path , :html => {:method => :post} do |f| %>
166 | ```
167 |
168 | #### PUT
169 | ``` ruby
170 | <%= form_for @post , :url => post_path(@post) , :html => {:method => :put} do |f| %>
171 | ```
172 |
173 | #### Destroy
174 | ``` ruby
175 | <%= link_to("Destroy", post_path(@post), :method => :delete )
176 | ```
177 |
178 | {::pagebreak :/}
179 |
180 | #### Form 綁定 Model Attribute 的設計
181 |
182 | Rails 的表單欄位，是對應 Model Attribute 的：
183 |
184 | ``` ruby
185 | New post
186 |
187 | <%= form_for @post , :url => posts_path do |f| %>
188 | <%= f.error_messages %>
189 | <%= f.text_field :subject %>
190 | <%= f.text_area :content %>
191 | <%= f.submit "Submit", :disable_with => 'Submiting...' %>
192 | <% end -%>
193 |
194 |
195 | <%= link_to 'Back', posts_path %>
196 | ```
197 |
198 | 透過 form_for 傳送出來的表單，會被壓縮包裝成一個 parameter: params[:post]，
199 |
200 | ``` ruby
201 | def create
202 | @post = Post.new(params[:post])
203 | if @post.save
204 | flash[:notice] = 'Post was successfully created.'
205 | redirect_to post_path(@post)
206 | else
207 | render :action => "new"
208 | end
209 | end
210 | ```
211 |
212 | 如此一來，原本創造新資源的一連串繁複動作就可以大幅的被簡化，開發速度達到令人驚艷的地步。
213 |
214 | ### 參考資料：
215 |
216 | * [百度百科：REST](http://baike.baidu.com/view/1077487.htm)
217 | * [Wikipedia: REST](http://zh.wikipedia.org/wiki/REST)
218 | * [Wikipedia: ROA](http://en.wikipedia.org/wiki/Resource-oriented_architecture)
219 | * [DHH: Discovering a world of Resource on Rails](http://en.wikipedia.org/wiki/Resource-oriented_architecture)
220 | * [ihower: Rails RESTful 制約即解放](http://ihower.tw/blog/archives/1566)
221 | * [ihower: 什麼是 REST 與 RESTful](http://ihower.tw/blog/archives/1542)
--------------------------------------------------------------------------------
/manuscript/chapter-01-1-0-extra-3.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## 補充章節：More about RESTful on Rails
4 |
5 |
6 | 有時候開發中也會出現超過這七種 action 之外的動作。那要如何整合進 RESTful 的 route 中呢？
7 |
8 | ### Collection & Member
9 |
10 | #### Member
11 |
12 | 宣告這個動作是屬於單個資源的 URI。可以透過 `/photos/1/preview` 進行 GET。有 `preview_photo_path(photo)` 或 `preview_photo_url(photo)` 這樣的 Url Helper 可以用。
13 |
14 | ``` ruby
15 | resources :photos do
16 | member do
17 | get 'preview'
18 | end
19 | end
20 | ```
21 |
22 | 也可以使用這種寫法：
23 |
24 | ``` ruby
25 | resources :photos do
26 | get 'preview', :on => :member
27 | end
28 | ```
29 |
30 | #### Collection
31 |
32 | 宣告這個動作是屬於一組資源的 URI。可以透過 `/photos/search` 進行 GET。有 `search_photos_path` 或 `search_photos_url` 這樣的 Url Helper 可以用。
33 |
34 |
35 | ``` ruby
36 | resources :photos do
37 | collection do
38 | get 'search'
39 | end
40 | end
41 | ```
42 |
43 | {::pagebreak :/}
44 |
45 | 也可以使用這種寫法：
46 |
47 | ``` ruby
48 | resources :photos do
49 | get 'search', :on => :collection
50 | end
51 | ```
52 |
53 | ### Nested Resources
54 |
55 | 有時候我們會需要使用雙重 resources 來表示一組資源。比如說 Post 與 Comment ：
56 |
57 | ``` ruby
58 | resources :posts do
59 | resources :comments
60 | end
61 | ```
62 |
63 | 可以透過 `/posts/123/comments` 進行 GET。有 `post_comments_path(post)` 或 `post_comments_url(post)` 這樣的 Url Helper 可以用。
64 |
65 | 而這樣的 URL 也很清楚的表明，這組資源就是用來存取 編號 123 的 post 下所有的 comments。
66 |
67 | 而要拿取 Post 的 id 可以透過這樣的方式取得：
68 |
69 | ``` ruby
70 | class CommentsController < ApplicationController
71 |
72 | before_filter :find_post
73 |
74 | def index
75 | @comments = @post.comments
76 | end
77 |
78 | protected
79 |
80 | def find_post
81 | @post = Post.find(params[:post_id])
82 | end
83 | end
84 | ```
85 |
86 | {::pagebreak :/}
87 |
88 | ### Namespace Resources
89 |
90 | 但是像 /admin/posts/1/edit 這種 URL，用 Nested Resources 應該造不出來吧？沒錯，這樣的 URL 應該要使用 Namespace 去建構：
91 |
92 | ``` ruby
93 | namespace :admin do
94 | # Directs /admin/products/* to Admin::PostsController
95 | # (app/controllers/admin/posts_controller.rb)
96 | resources :posts
97 | end
98 | ```
99 | 可以透過 `/admin/posts/123/edit` 進行 GET。有 `edit_admin_post_path(post)` 或 `edit_admin_post_url(post)` 這樣的 Url Helper 可以用。
100 |
101 | ### 延伸閱讀
102 |
103 | * [Rails Guide: Rails Routing from the Outside In](http://guides.rubyonrails.org/routing.html)
104 |
--------------------------------------------------------------------------------
/manuscript/chapter-01-1-0-extra.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 1.1 (補充) RESTful
4 |
5 |
6 | Rails 在 1.2 版本的時候引進了 RESTful 這一套設計風格。而在 2.0 版強迫正式成為開發預設值。
7 |
8 | 說到 RESTful，幾乎每個剛踏進 Rails 框架中的開發者都皺起眉頭。幾乎沒有人能夠在初學階段搞的懂這是什麼玩意。
9 |
10 | 偏偏初學者往往有一個「死扣細節」的習慣：沒「弄懂」就「不敢用」，結果在第一個關卡挫折感就堆的如山高，把玩 RESTful 後打退堂鼓，從此放棄 Rails。
11 |
12 | ### 想學 Rails 就先把 RESTful 背起來
13 |
14 | RESTful 是 Rails 裡面使用的最基礎最頻繁的一個設計手法，偏偏它也是最難一次講解清楚讓剛入門者理解的一個主題。因為在傳統 web 應用程式開發流程中，根本沒有這樣的概念。更別提在市面上這麼多網頁框架，只有 Rails 將之視為預設值。
15 |
16 | 別說是初學者，就連筆者和一些 Rails 界的前輩，在 Rails 剛納入 RESTful 為預設風格時，也沒能通透其中原理。
17 |
18 | 但是不熟練 RESTful 的開發架構，在開發 Rails 時幾乎會寸步難行。在訓練新 Developer 時如何讓他短時間就熟練便上手呢？
19 |
20 | 方法很簡單：強迫他背起來，然後重複寫十遍。
21 |
22 | 聽起來很唬爛，但其實真的紮紮實實寫過十遍以後。這時候再重新講解一次 RESTful 的概念，原本模糊的概念一下就變得豁然開朗了。
23 |
24 | {::pagebreak :/}
25 |
26 | ### 初步熟悉使用 Rails RESTful
27 |
28 | #### 在 config/routes.rb 內加入 resources
29 |
30 |
31 | 在 config/routes.rb 加入 `resources :groups`，就是具體在 rails 對一個 controller 實作 RESTful 的方式（對一個 controller 宣告成為 resources)。
32 |
33 | ~~~~~~~~
34 |
35 | Groupme::Application.routes.draw do
36 | resources :groups
37 | end
38 |
39 | ~~~~~~~~
40 |
41 | 
42 |
43 |
44 |
--------------------------------------------------------------------------------
/manuscript/chapter-01-1-0.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 1.1 建立 Group
4 |
5 | ### 建立 Group 這個 model
6 |
7 | 執行
8 |
9 | `rails g model group title:string description:text`
10 |
11 | ~~~~~~~~
12 | invoke active_record
13 | create db/migrate/20130529180541_create_groups.rb
14 | create app/models/group.rb
15 | invoke test_unit
16 | create test/models/group_test.rb
17 | create test/fixtures/groups.yml
18 | ~~~~~~~~
19 |
20 | 生成 Group 這個 model。
21 |
22 | 然後跑 `rake db:migrate`。
23 |
24 | ~~~~~~~~
25 | == CreateGroups: migrating ===================================================
26 | -- create_table(:groups)
27 | -> 0.1951s
28 | == CreateGroups: migrated (0.1952s) ==========================================
29 | ~~~~~~~~
30 |
31 |
32 | {::pagebreak :/}
33 |
34 | ### 建立 groups 這個 controller
35 |
36 | 執行 `rails g controller groups`
37 |
38 | ~~~~~~~~
39 |
40 | create app/controllers/groups_controller.rb
41 | invoke erb
42 | create app/views/groups
43 | invoke test_unit
44 | create test/controllers/groups_controller_test.rb
45 | invoke helper
46 | create app/helpers/groups_helper.rb
47 | invoke test_unit
48 | create test/helpers/groups_helper_test.rb
49 | invoke assets
50 | invoke coffee
51 | create app/assets/javascripts/groups.js.coffee
52 | invoke scss
53 | create app/assets/stylesheets/groups.css.scss
54 | ~~~~~~~~
55 |
56 |
57 | ### 把 groups 加入 routing
58 |
59 | 到 `config/routes.rb` 加入
60 |
61 | ~~~~~~~~~
62 | resources :groups
63 | ~~~~~~~~~
64 |
65 |
--------------------------------------------------------------------------------
/manuscript/chapter-01-1-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 1.1.1 建立 Groups Controller 裡的 index
4 |
5 | 到 `app/controllers/groups_controller.rb` 加入
6 |
7 | ~~~~~~~~~
8 | def index
9 | @groups = Group.all
10 | end
11 |
12 | ~~~~~~~~~
13 |
14 | {::pagebreak :/}
15 |
16 | #### 補上 view：
17 |
18 | `touch app/views/groups/index.html.erb`
19 |
20 | ~~~~~~~~
21 |
22 |
23 |
24 | <%= link_to("New group", new_group_path , :class => "btn btn-mini btn-primary pull-right" ) %>
25 |
26 |
27 |
28 |
29 | | # |
30 | Title |
31 | Description |
32 |
33 |
34 |
35 |
36 | <% @groups.each do |group| %>
37 |
38 | | # |
39 | <%= link_to(group.title, group_path(group)) %> |
40 | <%= group.description %> |
41 | <%= link_to("Edit", edit_group_path(group), :class => "btn btn-mini" ) %>
42 | <%= link_to("Delete", group_path(group), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %>
43 | |
44 |
45 | <% end %>
46 |
47 |
48 |
49 |
24 |
25 |
26 | <%= link_to("Edit", edit_group_path(@group) , :class => "btn btn-mini btn-primary pull-right" ) %>
27 |
28 |
29 |
<%= @group.title %>
30 |
31 |
<%= @group.description %>
32 |
33 |
25 |
26 | <%= simple_form_for @group do |f| %>
27 | <%= f.input :title, :input_html => { :class => "input-xxlarge"} %>
28 | <%= f.input :description, :input_html => { :class => "input-xxlarge"} %>
29 |
30 |
31 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
32 |
33 | <% end %>
34 |
35 |
75 |
76 | <%= simple_form_for @group do |f| %>
77 | <%= f.input :title, :input_html => { :class => "input-xxlarge"} %>
78 | <%= f.input :description, :input_html => { :class => "input-xxlarge"} %>
79 |
80 |
81 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
82 |
83 | <% end %>
84 |
85 |
25 |
26 | <%= simple_form_for @group do |f| %>
27 | <%= f.input :title, :input_html => { :class => "input-xxlarge"} %>
28 | <%= f.input :description, :input_html => { :class => "input-xxlarge"} %>
29 |
30 |
31 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
32 |
33 | <% end %>
34 |
35 |
28 |
29 | <%= simple_form_for @group do |f| %>
30 | <%= f.input :title, :input_html => { :class => "input-xxlarge"} %>
31 | <%= f.input :description, :input_html => { :class => "input-xxlarge"} %>
32 |
33 |
34 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
35 |
36 | <% end %>
37 |
38 |
37 | | # |
38 | <%= link_to(group.title, group_path(group)) %> |
39 | <%= group.description %> |
40 | <%= link_to("Edit", edit_group_path(group), :class => "btn btn-mini" ) %>
41 | <%= link_to("Delete", group_path(group), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %>
42 | |
43 |
44 | ~~~~~~~~
45 |
46 |
47 | 找到該筆資料並刪除之。在 RESTful Rails 的寫法中，對 `group_path` 丟一個 DELETE，就會對應到 destroy 的動作。可看一下 `link_to "Destroy"`那一行。
--------------------------------------------------------------------------------
/manuscript/chapter-02-1-0.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 2.1 建立 Post
4 |
5 | ### 建立 Post 這個 model
6 |
7 | 執行
8 |
9 | `rails g model post content:text group_id:integer`
10 |
11 | ~~~~~~~~
12 | invoke active_record
13 | create db/migrate/20130529200707_create_posts.rb
14 | create app/models/post.rb
15 | invoke test_unit
16 | create test/models/post_test.rb
17 | create test/fixtures/posts.yml
18 | ~~~~~~~~
19 |
20 | 生成 Post 這個 model。
21 |
22 | 然後跑 `rake db:migrate`。
23 |
24 | ~~~~~~~~
25 | == CreatePosts: migrating ====================================================
26 | -- create_table(:posts)
27 | -> 0.1297s
28 | == CreatePosts: migrated (0.1298s) ===========================================
29 | ~~~~~~~~
30 |
31 |
32 | {::pagebreak :/}
33 |
34 | ### 建立 posts 這個 controller
35 |
36 | 執行 `rails g controller posts`
37 |
38 | ~~~~~~~~
39 | create app/controllers/posts_controller.rb
40 | invoke erb
41 | create app/views/posts
42 | invoke test_unit
43 | create test/controllers/posts_controller_test.rb
44 | invoke helper
45 | create app/helpers/posts_helper.rb
46 | invoke test_unit
47 | create test/helpers/posts_helper_test.rb
48 | invoke assets
49 | invoke coffee
50 | create app/assets/javascripts/posts.js.coffee
51 | invoke scss
52 | create app/assets/stylesheets/posts.css.scss
53 | ~~~~~~~~
54 |
55 |
56 | ### 把 posts 加入 routing
57 |
58 | 到 `config/routes.rb` 修改原有的
59 |
60 | ~~~~~~~~~
61 | resources :groups
62 | ~~~~~~~~~
63 |
64 | 變成
65 |
66 |
67 | ~~~~~~~~~
68 | resources :groups do
69 | resources :posts
70 | end
71 | ~~~~~~~~~
72 |
73 | {::pagebreak :/}
74 |
75 |
76 | ### 加入 Group 與 Post 的關聯
77 |
78 | 修改 `app/models/group.rb` 加入 `has_many :posts`
79 |
80 | ~~~~~~~~~
81 | class Group < ActiveRecord::Base
82 |
83 | has_many :posts
84 | validates :title, :presence => true
85 |
86 | end
87 | ~~~~~~~~~
88 |
89 | 修改 `app/models/post.rb` 加入 `belongs_to :group`
90 |
91 | ~~~~~~~~~
92 | class Post < ActiveRecord::Base
93 | belongs_to :group
94 | end
95 |
96 | ~~~~~~~~~
97 |
98 |
99 |
--------------------------------------------------------------------------------
/manuscript/chapter-02-1-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 2.1.1 在 Groups controller 的 show 裡面撈出相關的 Post
4 |
5 | 到 `app/controllers/groups_controller.rb`，將 show 修改成以下內容
6 |
7 | ~~~~~~~~~
8 | def show
9 | @group = Group.find(params[:id])
10 | @posts = @group.posts
11 | end
12 |
13 | ~~~~~~~~~
14 |
15 | {::pagebreak :/}
16 |
17 | #### 補上 view：
18 |
19 | 修改 `app/views/groups/show.html.erb`
20 |
21 | ~~~~~~~~
22 |
23 |
24 |
25 | <%= link_to("Edit", edit_group_path(@group) , :class => "btn btn-mini ")%>
26 |
27 | <%= link_to("New Post", new_group_post_path(@group) , :class => "btn btn-mini btn-primary")%>
28 |
29 |
30 |
<%= @group.title %>
31 |
<%= @group.description %>
32 |
33 |
34 |
35 |
36 |
37 | <% @posts.each do |post| %>
38 |
39 | | <%= post.content %> |
40 | <%= link_to("Edit", edit_group_post_path(post.group, post), :class => "btn btn-mini")%>
41 | <%= link_to("Delete", group_post_path(post.group, post), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %> |
42 |
43 | <% end %>
44 |
45 |
46 |
24 |
25 | <%= simple_form_for [@group,@post] do |f| %>
26 | <%= f.input :content, :input_html => { :class => "input-xxlarge"} %>
27 |
28 |
29 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
30 |
31 | <% end %>
32 |
33 |
23 |
24 | <%= simple_form_for [@group,@post] do |f| %>
25 | <%= f.input :content, :input_html => { :class => "input-xxlarge"} %>
26 |
27 |
28 | <%= f.submit "Submit", :disable_with => 'Submiting...', :class => "btn btn-primary" %>
29 |
30 | <% end %>
31 |
32 |
Sign up
129 |
130 | <%= simple_form_for(resource, :as => resource_name, :url => registration_path(resource_name)) do |f| %>
131 | <%= f.error_notification %>
132 |
133 |
134 | <%= f.input :email, :required => true, :autofocus => true %>
135 | <%= f.input :name, :required => true %>
136 | <%= f.input :password, :required => true %>
137 | <%= f.input :password_confirmation, :required => true %>
138 |
139 |
140 |
141 | <%= f.button :submit, "Sign up" %>
142 |
143 | <% end %>
144 |
145 | <%= render "users/shared/links" %>
146 | ~~~~~~~~~
147 |
148 | ### 加入 strong_parameters 與 devise 整合的 hack
149 |
150 | 在 `app/controller/application_controller` 加上這些設定：
151 |
152 | ~~~~~~
153 |
154 | before_filter :configure_permitted_parameters, if: :devise_controller?
155 |
156 |
157 | protected
158 |
159 | def configure_permitted_parameters
160 | devise_parameter_sanitizer.for(:sign_up) { |u| u.permit(:name, :email, :password, :password_confirmation) }
161 | end
162 |
163 | ~~~~~~
164 |
165 | I>
166 |
167 |
--------------------------------------------------------------------------------
/manuscript/chapter-03-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 3.1 對需要登入才能使用的 Action 加入限制
4 |
5 | 根據需求：使用者必須能夠 註冊 / 登入，登入後才可以開設 Group，與發表 Post。
6 |
7 | 所以我們要在 Groups controller 加入：
8 |
9 | ~~~~~~~~~
10 | class GroupsController < ApplicationController
11 |
12 | before_action :login_required, :only => [:new, :create, :edit,:update,:destroy]
13 | ~~~~~~~~~
14 |
15 | 在 Posts controller 加入：
16 |
17 | ~~~~~~~~~
18 | class PostsController < ApplicationController
19 |
20 | before_action :login_required, :only => [:new, :create, :edit,:update,:destroy]
21 | ~~~~~~~~~
22 |
23 |
24 |
--------------------------------------------------------------------------------
/manuscript/chapter-03-2.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 3.2 讓 Group 與 User 產生關聯：
4 |
5 | 新增一條 migration： `rails g migration add_user_id_to_group`
6 |
7 | ~~~~~~~~~
8 | invoke active_record
9 | create db/migrate/20130531141923_add_user_id_to_group.rb
10 | ~~~~~~~~~
11 |
12 | 填入以下內容
13 |
14 | ~~~~~~~~~
15 | class AddUserIdToGroup < ActiveRecord::Migration
16 | def change
17 | add_column :groups, :user_id, :integer
18 | end
19 | end
20 | ~~~~~~~~~
21 |
22 | 執行 `rake db:migrate`
23 |
24 | ~~~~~~~~~
25 | == AddUserIdToGroup: migrating ===============================================
26 | -- add_column(:groups, :user_id, :integer)
27 | -> 0.0213s
28 | == AddUserIdToGroup: migrated (0.0214s) ======================================
29 | ~~~~~~~~~
30 |
31 |
32 | 修改 `app/models/user.rb` 加入 `has_many :groups`
33 |
34 | 內容如下
35 |
36 | ~~~~~~~~~
37 | class User < ActiveRecord::Base
38 | # Include default devise modules. Others available are:
39 | # :token_authenticatable, :confirmable,
40 | # :lockable, :timeoutable and :omniauthable
41 |
42 | has_many :groups
43 |
44 | extend OmniauthCallbacks
45 |
46 | devise :database_authenticatable, :registerable,
47 | :recoverable, :rememberable, :trackable, :validatable, :omniauthable
48 |
49 |
50 | end
51 | ~~~~~~~~~
52 |
53 | {::pagebreak :/}
54 |
55 | 修改 `app/models/group.rb` 加入
56 |
57 | ~~~~~~~~~
58 | belongs_to :owner, :class_name => "User", :foreign_key => :user_id
59 |
60 | def editable_by?(user)
61 | user && user == owner
62 | end
63 | ~~~~~~~~~
64 |
65 |
66 | 內容如下：
67 |
68 | ~~~~~~~~~
69 | class Group < ActiveRecord::Base
70 |
71 | belongs_to :owner, :class_name => "User", :foreign_key => :user_id
72 | has_many :posts
73 |
74 | validates :title, :presence => true
75 |
76 |
77 | def editable_by?(user)
78 | user && user == owner
79 | end
80 | end
81 |
82 |
83 | ~~~~~~~~~
84 |
85 | {::pagebreak :/}
86 |
87 | 接著我們要把 Groups 的幾個 action 內容替換掉：
88 |
89 | ### create
90 |
91 | ~~~~~~~~~
92 |
93 | def create
94 | @group = current_user.groups.build(group_params)
95 | if @group.save
96 | redirect_to groups_path
97 | else
98 | render :new
99 | end
100 | end
101 | ~~~~~~~~~
102 |
103 | ### edit
104 |
105 | ~~~~~~~~~
106 | def edit
107 | @group = current_user.groups.find(params[:id])
108 | end
109 | ~~~~~~~~~
110 |
111 |
112 | ### update
113 |
114 | ~~~~~~~~~
115 | def update
116 | @group = current_user.groups.find(params[:id])
117 |
118 | if @group.update(group_params)
119 | redirect_to group_path(@group)
120 | else
121 | render :edit
122 | end
123 | end
124 | ~~~~~~~~~
125 |
126 | {::pagebreak :/}
127 |
128 |
129 | ### destroy
130 |
131 | ~~~~~~~~~
132 | def destroy
133 | @group = current_user.groups.find(params[:id])
134 |
135 | @group.destroy
136 |
137 | redirect_to groups_path
138 | end
139 | ~~~~~~~~~
140 |
141 | {::pagebreak :/}
142 |
143 | 把 app/views/groups/index.html.erb 的內容換掉
144 |
145 | ~~~~~~~~~
146 |
147 |
148 |
149 | <%= link_to("New group", new_group_path , :class => "btn btn-mini btn-primary pull-right")%>
150 |
151 |
152 |
153 | | # |
154 | Title |
155 | Description |
156 | Owner |
157 |
158 |
159 |
160 | <% @groups.each do |group| %>
161 |
162 | | # |
163 | <%= link_to(group.title, group_path(group)) %> |
164 | <%= group.description %> |
165 | <%= group.owner.name %> |
166 |
167 | <% if current_user && group.editable_by?(current_user) %>
168 | <%= link_to("Edit", edit_group_path(group), :class => "btn btn-mini")%>
169 | <%= link_to("Delete", group_path(group), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %>
170 | <% end %>
171 | |
172 |
173 | <% end %>
174 |
175 |
176 |
154 |
155 |
156 |
157 | <% if current_user && @group.editable_by?(current_user) %>
158 | <%= link_to("Edit", edit_group_path(@group) , :class => "btn btn-mini ")%>
159 | <% end %>
160 |
161 | <%= link_to("New Post", new_group_post_path(@group) , :class => "btn btn-mini btn-primary") if current_user )%>
162 |
163 |
164 |
165 |
<%= @group.title %>
166 |
167 |
<%= @group.description %>
168 |
169 |
170 |
171 |
172 |
173 | <% @posts.each do |post| %>
174 |
175 | |
176 |
177 | Author : <%= post.author.name %>
178 |
179 | <%= post.content %>
180 |
181 | |
182 |
183 | <% if current_user && post.editable_by?(current_user) %>
184 | <%= link_to("Edit", edit_group_post_path(post.group, post), :class => "btn btn-mini")%>
185 | <%= link_to("Delete", group_post_path(post.group, post), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %> |
186 |
187 | <% end %>
188 | <% end %>
189 |
190 |
191 |
52 | <% if current_user.is_member_of?(@group) %>
53 | <%= link_to("Quit Group", quit_group_path(@group), :method => :post, :class => "btn btn-mini") %>
54 | <% else %>
55 | <%= link_to("Join Group", join_group_path(@group), :method => :post, :class => "btn btn-mini") %>
56 | <% end %>
57 |
58 | <% end %>
59 | ~~~~~~~~~~
60 |
61 |
62 | 修改 `app/views/groups/show.html.erb` 原先的
63 |
64 | ~~~~~~~~~~
65 | <%= link_to("New Post", new_group_post_path(@group) , :class => "btn btn-mini btn-primary") if current_user %>
66 | ~~~~~~~~~~
67 |
68 | 變成
69 |
70 | ~~~~~~~~~~
71 | <%= link_to("New Post", new_group_post_path(@group) , :class => "btn btn-mini btn-primary") if current_user.is_member_of?(@group) %>
72 |
73 | ~~~~~~~~~~
74 |
75 | ### 在 controller 裡加入 member_required
76 |
77 | 在 Post 這個 controller 裡面加入另一個 before_action
78 |
79 | ~~~~~~~~~~
80 | before_action :member_required, :only => [:new, :create ]
81 | ~~~~~~~~~~
82 |
83 | 在 `private` 下新增 `member_required` 這個 method
84 |
85 | ~~~~~~~~~~
86 | def member_required
87 | if !current_user.is_member_of?(@group)
88 | flash[:warning] = " You are not member of this group!"
89 | redirect_to group_path(@group)
90 | end
91 | end
92 | ~~~~~~~~~~
93 |
--------------------------------------------------------------------------------
/manuscript/chapter-04-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 4.1 使用者必須要是這個社團的成員才能發表文章
4 |
5 | 在第 2 章、第 3 章我們完成了 Group 與 Post 的新增與管理。在這一章我們要挑戰一點進階的課題。
6 |
7 | ### 4.1.1 has_many :through
8 |
9 | 新增 group_user 這個 model：`rails g model group_user group_id:integer user_id:integer`
10 |
11 | 執行 migration：`rake db:migrate`
12 |
13 |
14 | ~~~~~~~~~
15 |
16 | == CreateGroupUsers: migrating ===============================================
17 | -- create_table(:group_users)
18 | -> 0.0238s
19 | == CreateGroupUsers: migrated (0.0239s) ======================================
20 |
21 | ~~~~~~~~~
22 |
23 | 在 User model 加入
24 |
25 | ~~~~~~~~~
26 | has_many :group_users
27 | has_many :participated_groups, :through => :group_users, :source => :group
28 | ~~~~~~~~~
29 |
30 | 內容變成以下
31 |
32 | ~~~~~~~~~
33 | class User < ActiveRecord::Base
34 |
35 | has_many :groups
36 | has_many :posts
37 |
38 | has_many :group_users
39 | has_many :participated_groups, :through => :group_users, :source => :group
40 |
41 | extend OmniauthCallbacks
42 |
43 | devise :database_authenticatable, :registerable,
44 | :recoverable, :rememberable, :trackable, :validatable, :omniauthable
45 |
46 |
47 | def join!(group)
48 | participated_groups << group
49 | end
50 |
51 | def quit!(group)
52 | participated_groups.delete(group)
53 | end
54 |
55 | def is_member_of?(group)
56 | participated_groups.include?(group)
57 | end
58 |
59 | end
60 |
61 | ~~~~~~~~~
62 |
63 |
64 | {::pagebreak :/}
65 |
66 |
67 | 在 `app/models/group.rb` 加入
68 |
69 | ~~~~~~~~~
70 | has_many :group_users
71 | has_many :members, :through => :group_users, :source => :user
72 | ~~~~~~~~~
73 |
74 |
75 |
76 | 內容變成以下
77 |
78 | ~~~~~~~~~
79 | class Group < ActiveRecord::Base
80 |
81 | belongs_to :owner, :class_name => "User", :foreign_key => :user_id
82 | has_many :posts
83 | has_many :group_users
84 | has_many :members, :through => :group_users, :source => :user
85 |
86 | validates :title, :presence => true
87 |
88 |
89 | def editable_by?(user)
90 | user && user == owner
91 | end
92 | end
93 |
94 | ~~~~~~~~~
95 |
96 | 修改 `app/models/group_user.rb` 成
97 |
98 | ~~~~~~~~~
99 | class GroupUser < ActiveRecord::Base
100 | belongs_to :group
101 | belongs_to :user
102 | end
103 | ~~~~~~~~~
104 |
105 |
106 | ### 解說
107 |
108 | #### Many to Many 關係
109 |
110 | ~~~~~~~~~~
111 | has_many :group_users
112 | has_many :members, :through => :group_users, :source => :user
113 | ~~~~~~~~~~
114 |
115 | Rails 常見的關係有 `has_one`,`belongs_to` 與 `has_many`。`has_many :through` 是最後一種。
116 |
117 | 多數用在多對多（表間列表）的關係上。
118 |
--------------------------------------------------------------------------------
/manuscript/chapter-04.txt:
--------------------------------------------------------------------------------
1 | # 練習作業 4 - User 可以加入、退出社團
2 |
3 | ### 作業目標
4 |
5 | * user 可以在 group 頁面加入社團 / 退出社團
6 | * user 必須要是這個社團的成員才能發表文章
7 |
8 | ### 本章練習主題
9 |
10 | * has_many_belongs_to
11 | * custom routes
12 |
13 |
14 |
15 |
16 |
17 | ~~~~~~~~~
18 |
19 |
20 | class PostsController < ApplicationController
21 |
22 | before_action :find_group
23 | before_action :login_required, :only => [:new, :create, :edit,:update,:destroy]
24 | before_action :member_required, :only => [:new, :create ]
25 |
26 |
27 | def new
28 | @post = @group.posts.build
29 | end
30 |
31 | def create
32 | @post = @group.posts.new(post_params)
33 | @post.author = current_user
34 |
35 | if @post.save
36 | redirect_to group_path(@group)
37 | else
38 | render :new
39 | end
40 | end
41 |
42 | def edit
43 | @post = current_user.posts.find(params[:id])
44 | end
45 |
46 | def update
47 | @post = current_user.posts.find(params[:id])
48 |
49 | if @post.update(post_params)
50 | redirect_to group_path(@group)
51 | else
52 | render :edit
53 | end
54 | end
55 |
56 | def destroy
57 | @post = current_user.posts.find(params[:id])
58 |
59 | @post.destroy
60 |
61 | redirect_to group_path(@group)
62 | end
63 |
64 | private
65 |
66 | def post_params
67 | params.require(:post).permit(:content)
68 | end
69 |
70 | def find_group
71 | @group = Group.find(params[:group_id])
72 | end
73 |
74 | def member_required
75 | if !current_user.is_member_of?(@group)
76 | flash[:warning] = " You are not member of this group!"
77 | redirect_to group_path(@group)
78 | end
79 | end
80 | end
81 |
82 | ~~~~~~~~~
--------------------------------------------------------------------------------
/manuscript/chapter-05-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 5.1 User 必須要在使用者後台可以看到自己參加的 Group
4 |
5 |
6 | 新增 account/groups controller：`rails g controller account/groups`
7 |
8 | ~~~~~~~~
9 | identical app/controllers/account/groups_controller.rb
10 | invoke erb
11 | exist app/views/account/groups
12 | invoke test_unit
13 | identical test/controllers/account/groups_controller_test.rb
14 | invoke helper
15 | identical app/helpers/account/groups_helper.rb
16 | invoke test_unit
17 | identical test/helpers/account/groups_helper_test.rb
18 | invoke assets
19 | invoke coffee
20 | identical app/assets/javascripts/account/groups.js.coffee
21 | invoke scss
22 | identical app/assets/stylesheets/account/groups.css.scss
23 | ~~~~~~~~
24 |
25 |
26 | 新增 `app/controllers/account/groups_controller.rb` 裡的內容
27 |
28 | ~~~~~~~~
29 | class Account::GroupsController < ApplicationController
30 | before_action :login_required
31 |
32 | def index
33 | @groups = current_user.participated_groups
34 | end
35 | end
36 | ~~~~~~~~
37 |
38 |
39 | `touch app/views/account/groups/index.html.erb` 新增裡面的內容
40 |
41 | ~~~~~~~~
42 |
43 |
44 |
My Groups
45 |
46 |
47 |
48 | | # |
49 | Title |
50 | Description |
51 | Post Count |
52 | Last Update |
53 |
54 |
55 |
56 | <% @groups.each do |group| %>
57 |
58 | | # |
59 | <%= link_to(group.title, group_path(group)) %> |
60 | <%= group.description %> |
61 | <%= group.posts.count %> |
62 | <%= group.updated_at %> |
63 |
64 | <% end %>
65 |
66 |
67 |
46 |
47 |
48 |
49 |
50 |
51 |
52 | | Content |
53 | Group name |
54 | Last Update |
55 |
56 |
57 |
58 |
59 | <% @posts.each do |post| %>
60 |
61 | | <%= post.content %> |
62 |
63 | <%= post.group.title %> |
64 |
65 | <%= post.updated_at %> |
66 |
67 |
68 | <%= link_to("Edit", edit_group_post_path(post.group, post), :class => "btn btn-mini")%>
69 | <%= link_to("Delete", group_post_path(post.group, post), :class => "btn btn-mini", :method => :delete, :confirm => "Are you sure?" ) %> |
70 |
71 | <% end %>
72 |
73 |
74 |
9 |
10 |
11 | <% @groups.each do |group| %>
12 |
13 | | # |
14 | <%= link_to(group.title, group_path(group)) %> |
15 | <%= group.description %> |
16 | <%= group.posts.count %> |
17 | <%= group.updated_at %> |
18 |
19 | <% end %>
20 |
21 |
22 |
23 |
24 | ~~~~~~~~
25 |
26 |
27 | `group.posts.count` 這一段 code 是不太健康的，因為它產生了這樣的 SQL query。
28 |
29 | ~~~~~~~~
30 | (0.2ms) SELECT COUNT(*) FROM `posts` WHERE `posts`.`group_id` = 1
31 | ~~~~~~~~
32 |
33 | 如果你有開發過網頁程式 application 的經驗，就知道在迴圈裡面跑 count 對效能是相當傷的。實務上我們相當不建議這麼做。
34 |
35 | 那麼這一段程式碼要怎麼改善呢？比較直觀的想法，就是在 groups 這個 table 再開一欄叫作 `posts_count` 的欄位。然後在
36 | create action 裡面對 `posts_count` +1
37 |
38 | ~~~~~~~~
39 |
40 | def create
41 |
42 | @post = @group.posts.new(post_params)
43 | @post.author = current_user
44 |
45 | if @post.save
46 | Group.increment_counter(:posts_count, @group.id)
47 | redirect_to group_path(@group)
48 | else
49 | render :new
50 | end
51 | end
52 |
53 |
54 | ~~~~~~~~
55 |
56 | {::pagebreak :/}
57 |
58 | 在 `destroy action` 裡面對 `posts_count` - 1
59 |
60 | ~~~~~~~~
61 | def destroy
62 |
63 | @post = current_user.posts.find(params[:id])
64 | @post.destroy
65 |
66 | Group.decrement_counter(:posts_count, @group.id)
67 | redirect_to group_path(@group)
68 | end
69 |
70 | ~~~~~~~~
71 |
72 |
73 | 不過，其實倒也不用這麼麻煩。Rails 內建一個叫作 `counter_cache` 的機制，只要內建子關係的 count 欄位，如 `posts_count`。
74 |
75 | `rails g migration add_posts_count_to_group`
76 |
77 | ~~~~~~~~
78 | invoke active_record
79 | create db/migrate/20130531183331_add_posts_count_to_group.rb
80 | ~~~~~~~~
81 |
82 | 填入
83 |
84 | ~~~~~~~~
85 |
86 | class AddPostsCountToGroup < ActiveRecord::Migration
87 | def change
88 | add_column :groups, :posts_count, :integer, :default => 0
89 | end
90 | end
91 |
92 | ~~~~~~~~
93 |
94 | 執行 `rake db:migrate`
95 |
96 |
97 | ~~~~~~~~
98 |
99 | == AddPostsCountToGroup: migrating ===========================================
100 | -- add_column(:groups, :posts_count, :integer, {:default=>0})
101 | -> 0.0232s
102 | == AddPostsCountToGroup: migrated (0.0232s) ==================================
103 |
104 | ~~~~~~~~
105 |
106 | 然後在 `app/models/post.rb` 的欄位裡，這樣設定：
107 |
108 | ~~~~~~~~
109 | belongs_to :group, :counter_cache => true
110 | ~~~~~~~~
111 |
112 | 以後只要 post 遇到 create 或者是 destroy，就會自動對這個欄位 +1 / -1 。不需要在 controller 裡面另外動作。
113 |
114 |
115 | {::pagebreak :/}
116 |
117 | 而上了 counter_cache 之後，`<%= group.posts.size %>` 以後執行時，也會優先去找 `posts_count` 裡的值，而不是真的下 MySQL 的 COUNT 去實際算值。
118 |
119 | 而加了這個 posts_count 欄位之後，我們就可以修改 index 裡的排序規則變成以文章數量的熱門度 DESC 排序
120 |
121 |
122 | ~~~~~~~~
123 | def index
124 | @groups = current_user.participated_groups.order("posts_count DESC")
125 | end
126 | ~~~~~~~~
127 |
128 |
129 |
130 |
--------------------------------------------------------------------------------
/manuscript/chapter-05.txt:
--------------------------------------------------------------------------------
1 | # 練習作業 5 - 實作簡單的 Account 後台機制
2 |
3 | ### 作業目標
4 |
5 | * user 可以在 account 頁面找到自己曾經加入的社團
6 | * user 可以至 account 找到自己曾經發表過的文章
7 | * 每個 Group 要秀出現在有多少 post 數量
8 | * 文章列表的排序要以發表時間以 DESC 排序。
9 |
10 | ### 練習主題
11 |
12 | * 使用 [counter_cache](http://railscasts.com/episodes/23-counter-cache-column) 取代直接對資料庫的 count
13 | * 了解 ORM 的基本用法
14 |
15 |
16 |
--------------------------------------------------------------------------------
/manuscript/chapter-06-1.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 6.1 使用系統 helper 整理 code
4 |
5 | 我們已經初步完成了這個系統。但有一些設計看起來還是令人不太滿意的。比如說
6 |
7 |
8 | `post.updated_at` 與 `group.updated_at`。
9 |
10 | 顯示出來的會是 `2013-05-31 14:47:31 UTC` 這種格式。
11 |
12 |
13 | ### date.to_s
14 |
15 | 但其實我們想要顯示的好看一點，可以改成這樣的寫法：
16 |
17 |
18 | * `post.updated_at.to_s(:long)` => May 31, 2013 18:04
19 | * `group.updated_at.to_s(:short)` => 31 May 18:04
20 |
21 |
22 | ### simple_format
23 |
24 | 當我們在顯示 `post.content` 時，有個困擾。我們在輸入框輸入
25 |
26 | ~~~~~
27 | a
28 | b
29 | c
30 | ~~~~~
31 |
32 | 但在系統輸出的時候，HTML 並不會自動斷行，會顯示成
33 |
34 | ~~~~~
35 | a b c
36 | ~~~~~
37 |
38 | 用 Enter 斷行的 `\r` 或 `\n` 在 HTML 裡面並不起作用。若要在 HTML 裡面正確斷行必須要使用 `
`。
39 |
40 | 若在以往，要漂亮顯示文本，開發者必須自行寫一段 nl2br 的轉換 helper。不過 Rails 裡面內建 `simple_format` 這個 helper，可以自動幫我們處理這種雜事。
41 |
42 | `<%= simple_format(post.content) %>`
43 |
44 |
45 | ### truncate
46 |
47 |
48 | 在顯示 group.title 時，有時候我們也會遇到標題太長的問題，導致破版。所以要砍字，再加上 "..."
49 |
50 | Rails 內建了一個 `truncate` helper 可以快速辦到這個效果
51 |
52 | `<%= truncate(@group.title, :length => 17 ) %>`
53 |
--------------------------------------------------------------------------------
/manuscript/chapter-06-2.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 6.2 自己撰寫的 helper 包裝 html
4 |
5 | Helper 是一些使用在 Rails 的 View 當中，用 Ruby 產生/整理 HTML code 的一些小方法。通常被放在 `app/helpers` 下。預設的 Helper 名字是對應 Controller 的，產生一個 Controller 時，通常會產生一個同名的 Helper。如 `PostsController` 與 `PostsHelper`。
6 |
7 | ### 使用情境
8 |
9 | 使用 Helper 的情境多半是：
10 |
11 | * 產生的 HTML code 需要與原始程式碼進行一些邏輯混合，但不希望 View 裡面搞得太髒。
12 | * 需要與預設的 Rails 內建的一些方便 Helper 交叉使用。
13 |
14 | 使用 Helper 封裝程式碼可以帶給專案以下一些優點：
15 |
16 | * Don't repeat yourself（DRY）程式碼不重複
17 | * Good Encapsulation好的封裝性
18 | * 提供 view 模板良好的組織
19 | * 易於修改程式碼
20 |
21 | ### 範例
22 |
23 | 在剛剛的專案當中，顯示 Post 的程式碼如下：
24 |
25 | ~~~~~~~~~
26 | <%= @post.content %> %>
27 | ~~~~~~~~~
28 |
29 | 隨著專案變遷，這樣的程式碼，可能會依需求改成：（需要內容斷行）
30 |
31 | ~~~~~~~~~
32 | <%= simple_format(@post.content) %> %>
33 | ~~~~~~~~~
34 |
35 | 之後又改成 （只顯示頭一百字）
36 |
37 | ~~~~~~~~~
38 | <%= truncate(simple_format(@post.content), :lenth => 100) %>
39 | ~~~~~~~~~
40 |
41 |
42 | 而麻煩的是，這樣類似的內容，常常在專案出現。每當需求變更，開發者就需要去找出來，有十個地方，就需要改十遍，很是麻煩。
43 |
44 | {::pagebreak :/}
45 |
46 | Helper 就是用在這樣的地方。與其一開始寫下
47 |
48 | ~~~~~~~~~
49 | <%= @post.content %> %>
50 | ~~~~~~~~~
51 |
52 | 不如，一開始就設計一個 Helper ` <%= render_post_content(@post) %>`
53 |
54 | ~~~~~~~~~
55 | def render_post_content(post)
56 | truncate(simple_format(post.content), :lenth => 100)
57 | end
58 | ~~~~~~~~~
59 |
60 | 以後變更需求就只要修改一個地方即可。
61 |
62 | ### 更多的 Partial 用法
63 |
64 |
65 |
--------------------------------------------------------------------------------
/manuscript/chapter-06-3.txt:
--------------------------------------------------------------------------------
1 | {::pagebreak :/}
2 |
3 | ## Ch 6.3 使用 partial 整理 html
4 |
5 | Partial 也是 Rails 提供用來整理 View 的一種方式，開發者可以使用 Partial 技巧將太長的 View 整理切該成好維護的小片程式碼。
6 |
7 |
8 | Helper 是一些使用在 Rails 的 View 當中，用 Ruby 產生/整理 HTML code 的一些小方法。通常被放在 `app/helpers` 下。預設的 Helper 名字是對應 Controller 的，產生一個 Controller 時，通常會產生一個同名的 Helper。如 `PostsController` 與 `PostsHelper`。
9 |
10 | ### 使用情境
11 |
12 | 什麼時候應該將把程式碼搬到 Partial 呢？
13 |
14 | ＊long template | 如果當檔 HTML 超過兩頁
15 | ＊highly duplicated | HTML 內容高度重複
16 | ＊independent blocks | 可獨立作為功能區塊
17 |
18 | ### 常見範例
19 |
20 | * nav/user_info
21 | * nav/admin_menu
22 | * vendor_js/google_analytics
23 | * vendor_js/disqus_js
24 | * global/footer
25 |
26 |
27 |
28 | {::pagebreak :/}
29 |
30 | 本書範例 project 裡面的 layout/application.html.erb 就是很好的範例。
31 |
32 | ~~~~~~~~~
33 | <%= render :partial => "common/menu" %>
34 |
35 |
36 |
37 | <%= notice_message %>
38 |
39 |
40 |
41 | <%= yield %>
42 | <%= yield (:sidebar) %>
43 |
44 |
45 |
46 |
47 | <%= render :partial => "common/footer" %>
48 |