Ruby on Rails 教程

Ruby on Rails Tutorial 原书第 2 版(涵盖 Rails 4)

第 10 章 用户的微博

  1. 10.1 Microposts 模型
  2. 10.1.1 基本模型
  3. 10.1.2 第一个数据验证
  4. 10.1.3 用户和微博之间的关联
  5. 10.1.4 改进 Micropost 模型
  6. 10.1.5 验证微博内容
  7. 10.2 显示微博
  8. 10.2.1 充实用户资料页面
  9. 10.2.2 示例微博
  10. 10.3 微博相关的操作
  11. 10.3.1 访问限制
  12. 10.3.2 创建微博
  13. 10.3.3 临时的动态列表
  14. 10.3.4 删除微博
  15. 10.4 小结
  16. 10.5 练习

我们在第 9 章中已经实现了一个完整且符合 REST 架构的资源:用户,本章我们要再实现一个资源:用户微博(micropost)。1微博是由用户发布的一种简短消息,我们在第 2 章中实现了微博的雏形。 本章我们会在 2.3 节的基础上,实现一个功能完善的 Microposts 资源。首先,我们要创建微博所需的数据模型,通过 has_manybelongs_to 方法把微博和用户关联起来,再建立处理和显示微博所需的表单及局部视图。在 第 11 章,还要加入关注其他用户的功能,其时,我们这个山寨版 Twitter 才算完成。

如果你使用 Git 做版本控制的话,和之前一样,我建议你新建一个分支:

$ git checkout -b user-microposts

10.1 Microposts 模型

实现 Microposts 资源的第一步是创建微博所需的数据模型,在模型中设定微博的基本属性。和 2.3 节 创建的模型类似,我们要实现的 Micropost 模型要包含数据验证,以及和 User 模型的关联。除此之外,我们还会做充分的测试,指定默认的排序方式,自动删除已注销用户的微博。

10.1.1 基本模型

Micropost 模型只需要两个属性:一个是 content,用来保存微博的内容;2另一个是 user_id,把微博和用户关联起来。我们要使用 generate model 命令生成所需的模型,这一点和创建用户模型时是一样的(参见代码 6.1):

$ rails generate model Micropost content:string user_id:integer

这个命令有可能会生成一个微博预构件,你应该把它删掉,因为后面我们会自己编写所需的预构件(参见10.1.4 节):

$ rm -f spec/factories/microposts.rb

上述命令会生成一个迁移文件,在数据库中生成一个名为 microposts 的表(参见代码 10.1)。读者朋友可以和生成 users 表的迁移文件对照一下(参见代码 6.2)。

代码 10.1:创建微博模型的迁移文件(注意:为 user_idcreated_at 列加入了索引)

db/migrate/[timestamp]_create_microposts.rb

class CreateMicroposts < ActiveRecord::Migration
  def change
    create_table :microposts do |t|
      t.string :content
      t.integer :user_id

      t.timestamps
    end
    add_index :microposts, [:user_id, :created_at]
  end
end

注意,因为我们设想要按照发布时间的倒序查询某个用户所有的微博,所以在上述代码中为 user_idcreated_at 列加入了索引:

add_index :microposts, [:user_id, :created_at]

我们把 user_idcreated_at 放在一个数组中,告诉 Rails 我们要创建的是“多键索引(multiple key index)”,Active Record 便会同时使用这两个键。还要注意 t.timestamps 这行,我们在 6.1.1 节中介绍过,它会自动创建 created_atupdated_at 两个属性。在 10.1.4 节10.2.1 节 中才会用到 created_at

我们先参照 User 模型的测试(参照代码 6.5),为 Micropost 模型编写一些基本的测试。我们要测试微博对象是否可以响应 contentuser_id 方法,如代码 10.2 所示。

代码 10.2:Micropost 模型测试(初始版)

spec/models/micropost_spec.rb

require 'spec_helper'

describe Micropost do

  let(:user) { FactoryGirl.create(:user) }
  before do
    # This code is not idiomatically correct.
    @micropost = Micropost.new(content: "Lorem ipsum", user_id: user.id)
  end

  subject { @micropost }

  it { should respond_to(:content) }
  it { should respond_to(:user_id) }
end

若要这个测试通过,我们先要执行数据库迁移,再准备好“测试数据库”:

$ bundle exec rake db:migrate
$ bundle exec rake test:prepare

执行上面两个命令之后,会生成 Micropost 模型,结构如图 10.1 所示。

micropost_model

图 10.1:Micropost 数据模型

然后确认测试是否可以通过:

$ bundle exec rspec spec/models/micropost_spec.rb

测试虽然可以通过,不过你可能注意到代码 10.2 中的这几行代码了:

let(:user) { FactoryGirl.create(:user) }
before do
  # This code is not idiomatically correct.
  @micropost = Micropost.new(content: "Lorem ipsum", user_id: user.id)
end

就像其中的注释所说,before 块中的代码并不完全正确。你可以想一下为什么,我们会在 10.1.3 节中告诉你答案。

10.1.2 第一个数据验证

Micropost 模型必须要有一个属性表明用户的 ID,这样才能知道是哪个用户发布的微博。要加入这个属性,最好的方法是使用 Active Record 关联,会在 10.1.3 节实现。实现的过程需要一点重构,本节我们就编写一个测试捕获可能出现的错误。

测试如代码 10.3 所示,我们先把用户 ID 设为 nil,然后检测对应的微博是否不合法。(可以和代码 6.8 中针对 User 模型的测试对比一下。)

代码 10.3:测试微博能否通过验证

spec/models/micropost_spec.rb

require 'spec_helper'

describe Micropost do

  let(:user) { FactoryGirl.create(:user) }
  before do
    # This code is not idiomatically correct.
    @micropost = Micropost.new(content: "Lorem ipsum", user_id: user.id)
  end

  subject { @micropost }

  it { should respond_to(:content) }
  it { should respond_to(:user_id) }

  it { should be_valid }

  describe "when user_id is not present" do
    before { @micropost.user_id = nil }
    it { should_not be_valid }
  end
end

这段代码测试了微博是否能够通过验证,以及是否指定了 user_id 的值。要想让上述测试通过,我们要按照代码 10.4 所示,加入一个简单的存在性验证。

代码 10.4:对微博 user_id 属性的验证

app/models/micropost.rb

class Micropost < ActiveRecord::Base
  validates :user_id, presence: true
end

10.1.3 用户和微博之间的关联

在为 Web 程序构建数据模型时,最基本的考虑要素是要能够在不同的模型之间建立关联。在我们这个程序中,每篇微博都关联着一个用户,而每个用户一般都会关联多篇微博。用户和微博之间的关系在 2.3.3 节中简单的介绍过,二者之间的关系如图 10.2 和图 10.3 所示。在实现这种关联的时候,我们会编写针对 Micropost 模型的测试,还会编写针对 User 模型的测试。

micropost_belongs_to_user

图 10.2:微博和用户之间的“属于(belongs_to)”关系

user_has_many_microposts

图 10.3:用户和微博之间的“拥有多个(has_many)”关系

使用本小节介绍的 belongs_tohas_many 之后,Rails 会自动创建如表格 10.1 所示的方法。

表格 10.1:用户和微博关联后所得方法的简介

方法 作用
micropost.user 返回该微博对应的用户对象
user.microposts 返回该用户的所有微博数组
user.microposts.create(arg) 创建一篇微博(user_id = user.id
user.microposts.create!(arg) 创建一篇微博(失败时抛出异常)
user.microposts.build(arg) 生成一个新的微博对象(user_id = user.id)

注意,从表格 10.1 可知,相较于以下的方法

Micropost.create
Micropost.create!
Micropost.new

我们得到了

user.microposts.create
user.microposts.create!
user.microposts.build

后者才是创建微博的正确方式,即通过相关联的用户对象创建。通过这种方式创建的微博,其 user_id 属性会自动设为正确的值。所以,我们可以把代码 10.3 中的下述代码

let(:user) { FactoryGirl.create(:user) }
before do
  # This code is not idiomatically correct.
  @micropost = Micropost.new(content: "Lorem ipsum", user_id: user.id)
end

修改为

let(:user) { FactoryGirl.create(:user) }
before { @micropost = user.microposts.build(content: "Lorem ipsum") }

只要正确定义了用户和微博之间的关联关系,@micropost 变量的 user_id 属性就会自动设为相对应用户的 id。

表格 10.1 所示,用户和微博建立关联之后,还会生成 micropost.user 方法,返回该微博的用户对象。对此,我们可以使用 itits 做个测试:

it { should respond_to(:user) }
its(:user) { should eq user }

以上对 Micropost 模型的测试结合在一起后如代码 10.5 所示。

代码 10.5:测试微博和用户之间的关联

spec/models/micropost_spec.rb

require 'spec_helper'

describe Micropost do

  let(:user) { FactoryGirl.create(:user) }
  before { @micropost = user.microposts.build(content: "Lorem ipsum") }

  subject { @micropost }

  it { should respond_to(:content) }
  it { should respond_to(:user_id) }
  it { should respond_to(:user) }
  its(:user) { should eq user }

  it { should be_valid }

  describe "when user_id is not present" do
    before { @micropost.user_id = nil }
    it { should_not be_valid }
  end
end

在用户和微博关联关系的 User 模型一边,我们会在 10.1.4 节做详细的测试,现在我们只是简单的测试下是否可以响应 microposts 方法,如代码 10.6 所示。

代码 10.6:测试用户对象是否可以响应 microposts 方法

spec/models/user_spec.rb

require 'spec_helper'

describe User do

  before do
    @user = User.new(name: "Example User", email: "[email protected]",
                     password: "foobar", password_confirmation: "foobar")
  end

  subject { @user }
  .
  .
  .
  it { should respond_to(:admin) }
  it { should respond_to(:microposts) }
  .
  .
  .
end

写好了上面的测试,实现用户和微博之间关联就简单了:只需分别加入下面这两行代码,代码 10.5 和代码 10.6 中的测试就可以通过了:belongs_to :user(如代码 10.7 所示)和 has_many :microposts(如代码 10.8 所示)。

代码 10.7:微博“属于(belongs_to)”用户

app/models/micropost.rb

class Micropost < ActiveRecord::Base
  belongs_to :user
  validates :user_id, presence: true
end

代码 10.8:用户“拥有多篇(has_many)”微博

app/models/user.rb

class User < ActiveRecord::Base
  has_many :microposts
  .
  .
  .
end

现在,你应该结合表格 10.1和代码 10.5、代码 10.6,确保你理解了关联的基本知识点。你还应该检查一下测试是否可以通过:

$ bundle exec rspec spec/models

10.1.4 改进 Micropost 模型

代码 10.6 中的代码并没有深入测试通过 has_many 实现的关联,仅仅检测了是否可以响应 microposts 方法。本小节,我们会为 Micropost 模型加入排序方法和依属关系,还会测试 user.microposts 方法的返回结果是否为数组。

我们需要在 User 模型的测试中生成一些微博,所以现在我们先要创建一个生成微博的预构件。在所创建的预构件中我们要找到一种方法把微博和用户关联起来,幸运的是,在 FactoryGirl 中实现关联是很容易的,如代码 10.9 所示。

代码 10.9:完整的预构件文件,包含了创建微博的新预构件

spec/factories.rb

FactoryGirl.define do
  factory :user do
    sequence(:name)  { |n| "Person #{n}" }
    sequence(:email) { |n| "person_#{n}@example.com"}
    password "foobar"
    password_confirmation "foobar"

    factory :admin do
      admin true
    end
  end

  factory :micropost do
    content "Lorem ipsum"
    user
  end
end

在 FactoryGirl 中我们只需要在创建微博的预构件中包含一个用户对象就可以实现所需的关联了:

factory :micropost do
  content "Lorem ipsum"
  user
end

在下一节中会介绍,我们可以使用下面的方法生成一篇微博:

FactoryGirl.create(:micropost, user: @user, created_at: 1.day.ago)

默认作用域

默认情况下,使用 user.microposts 从数据库中读取用户的微博不能保证微博的次序,但是按照博客和 Twitter 的习惯,我们希望微博按照创建时间倒序排列,也就是最新创建的微博在最前面。要测试微博的次序,我们要先创建两篇微博:

FactoryGirl.create(:micropost, user: @user, created_at: 1.day.ago)
FactoryGirl.create(:micropost, user: @user, created_at: 1.hour.ago)

我们把第二篇微博的创建时间设的晚一些,即 1.hour.ago(利用了旁注 8.1中介绍的帮助函数),第一篇微博的创建时间要早一些,是 1.day.ago。请注意一下使用 FactoryGirl 创建微博是多么方便:我们不仅可以直接指定微博所属的用户(FactoryGirl 会逃过 attr_accessible 限制),还可以设定通常情况下不能自由设定的 created_at 属性(因为在 Active Record 做了限制)。(再次说明一下,created_atupdated_at 两个属性是“魔法”列,会被自动设为相应的创建时间戳和更新时间戳,即使手动指定了值也会被覆盖。)

大多数数据库适配器(包括 SQLite 的适配器)读取的微博都是按照 ID 来排序的,因此代码 10.10 中的测试肯定不会通过。在这段测试代码中没有使用 let,而用了 let!(读作“let bang”),因为 let 方法指定的变量是“惰性”的,只有当后续有引用时才会被创建。而我们希望这两个微博变量立即被创建,这样才能保证两篇微博时间戳的顺序是正确的,也保证了 @user.microposts 数组不是空的。所以我们才用了 let! 方法,强制相应的变量立即被创建。

代码 10.10:测试用户微博的次序

spec/models/user_spec.rb

require 'spec_helper'

describe User do
  .
  .
  .
  describe "micropost associations" do

    before { @user.save }
    let!(:older_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.day.ago)
    end
    let!(:newer_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.hour.ago)
    end

    it "should have the right microposts in the right order" do
      expect(@user.microposts.to_a).to eq [newer_micropost, older_micropost]
    end
  end
end

这个测试中最关键的一行是:

expect(@user.microposts.to_a).to eq [newer_micropost, older_micropost]

这行代码表明所创建的微博应该按照创建时间倒序排列,即最新创建的微博排在最前面。这个测试注定是无法通过的,因为微博默认是按照 ID 排序的,即 [older_micropost, newer_micropost]。这个测试同时也验证了 has_many 关联最基本的效果是否正确,即检测 user.microposts 返回的结果是否是数组。其中用到的 to_a 方法,在 4.3.1 节中介绍过,会把 @user.microposts 从初始状态(Active Record 的“集合代理(collection proxy)”)转换成一个数组,以便和我们手动编写的数组比较。

要让这个测试通过,我们要使用 Rails 中的 default_scope 方法,还要设定它的 :order 参数,如代码 10.11 所示。(这是我们第一次接触作用域的概念,在第 11 章中会介绍作用域更一般的用法。)

代码 10.11:通过 default_scope 设定微博的排序

app/models/micropost.rb

class Micropost < ActiveRecord::Base
  belongs_to :user
  default_scope -> { order('created_at DESC') }
  validates :user_id, presence: true
end

我们通过 microposts.created_at DESC 设定了所需的排序,其中 DESC 在 SQL 中是“倒序”的意思,即按照由新到旧这种顺序排序。

从 Rails 4.0 开始,所有的作用域都需要通过匿名函数的方式定义,函数的返回值为所需的条件。这么做主要的好处是,作用域的条件不用立即计算,只在需要时才执行(所以叫做“惰性计算”)。本例所用的匿名函数是

-> { order('created_at DESC') }

这种对象叫 Proc 或 lambda,以 -> 开头,后面跟着一个代码块,调用 call 方法时才执行块中的代码。我们可以在控制台中看一下:

>> -> { puts "foo" }
=> #<Proc:[email protected](irb):1 (lambda)>
>> -> { puts "foo" }.call
foo
=> nil

(Proc 属于 Ruby 语言的高级功能,所以如果没有立刻理解也不用担心。)

依属关系:destroy

除了设定恰当的排序外,我们还要对微博模型做另一项改进。我们在 9.4 节中介绍过,管理员是有权限删除用户的。那么,在删除用户的同时,就有必要把该用户发布的微博也删除。对此我们可以编写一个测试,检测当用户被删除后,其发布的微博是否还在数据库中。

为了能够正确的测试微博是否被删除了,我们先要把用户的一篇微博赋值给一个局部变量,然后再删除这个用户。对此,一种比较直观的实现方式如下所示:

microposts = @user.microposts.to_a
@user.destroy
expect(microposts).not_to be_empty
microposts.each do |micropost|
  # Make sure the micropost doesn't appear in the database.
end

我们调用了 to_a 方法,高效地复制了一份微薄列表。我们还加入了下面这行

expect(microposts).not_to be_empty

这是一份双保险,避免不小心漏掉了 to_a。如果没有 to_a 的话,一旦删除了用户就会删掉 microposts 变量中的该用户的微博,那么

microposts.each do |micropost|
  # Make sure the micropost doesn't appear in the database.
end

就什么也测试不了,因为 microposts 是空的。

我们可以通过下面的代码确认微博不在数据库中:

microposts.each do |micropost|
  expect(Micropost.where(id: micropost.id)).to be_empty
end

这里我们用的是 Micropost.where,而不是 Micropost.find,因为如果没有查询到记录 where 会返回一个空值对象,而 find 会抛出异常。测试空值对象要更容易。如果你好奇想知道如何测试异常,可以使用下面的代码:

expect do
  Micropost.find(micropost)
end.to raise_error(ActiveRecord::RecordNotFound)

完整的测试代码如代码 10.12 所示。

代码 10.12:测试用户删除后,所发布的微博是否也被删除了

spec/models/user_spec.rb

require 'spec_helper'

describe User do
  .
  .
  .
  describe "micropost associations" do

    before { @user.save }
    let!(:older_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.day.ago)
    end
    let!(:newer_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.hour.ago)
    end
    .
    .
    .
    it "should destroy associated microposts" do
      microposts = @user.microposts.to_a
      @user.destroy
      expect(microposts).not_to be_empty
      microposts.each do |micropost|
        expect(Micropost.where(id: micropost.id)).to be_empty
      end
    end
  end
end

要让代码 10.12 中的测试通过,我们甚至不需要加入一行完整的代码,只需在 has_many 方法中设定一个参数即可,如代码 10.13 所示。

代码 10.13:保证用户的微博在删除用户的同时也会被删除

app/models/user.rb

class User < ActiveRecord::Base
  has_many :microposts, dependent: :destroy
  .
  .
  .
end

上面代码中有这么一行:

has_many :microposts, dependent: :destroy

其中的 dependent: :destroy 设定程序在用户被删除的时候,其所属的微博也要被删除。这么一来,如果管理员删除了用户,数据库中就不会出现无主的微博了。

至此,用户和微博之间的关联就设置好了,所有的测试应该都可以通过了:

$ bundle exec rspec spec/

10.1.5 验证微博内容

在结束讨论 Micropost 模型之前,我们还要为微博的内容加上数据验证(参照 2.3.2 节)。和 user_id 一样,content 属性不能为空,而且还要限制内容的长度不能多于 140 个字符,这才是真正的“微”博。我们要编写的测试和 6.2 节中对用户模型的验证测试类似,如代码 10.14 所示。

代码 10.14:测试 Micropost 模型的数据验证

spec/models/micropost_spec.rb

require 'spec_helper'

describe Micropost do

  let(:user) { FactoryGirl.create(:user) }
  before { @micropost = user.microposts.build(content: "Lorem ipsum") }
  .
  .
  .
  describe "when user_id is not present" do
    before { @micropost.user_id = nil }
    it { should_not be_valid }
  end

  describe "with blank content" do
    before { @micropost.content = " " }
    it { should_not be_valid }
  end

  describe "with content that is too long" do
    before { @micropost.content = "a" * 141 }
    it { should_not be_valid }
  end
end

6.2 节一样,在代码 10.14 中我们用到了字符串乘积来测试微博内容长度的验证:

$ rails console
>> "a" * 10
=> "aaaaaaaaaa"
>> "a" * 141
=> "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

我们需要在程序中加入下面这行代码:

validates :content, presence: true, length: { maximum: 140 }

Micropost 模型的最终代码如代码 10.15 所示。

代码 10.15:Micropost 模型的数据验证

app/models/micropost.rb

class Micropost < ActiveRecord::Base
  belongs_to :user
  default_scope -> { order('created_at DESC') }
  validates :content, presence: true, length: { maximum: 140 }
  validates :user_id, presence: true
end

10.2 显示微博

尽管我们还没实现直接在网页中发布微博的功能(将在 10.3.2 节实现),不过我们还是有办法显示微博,并对显示的内容进行测试。我们将按照 Twitter 的方式,用户的微博不在 index 页面中显示,而在 show 页面中,构思图如图 10.4 所示。我们会先创建一些很简单的 ERb 代码,在用户的资料页面显示微博,然后要在 9.3.2 节中实现的数据生成器中加入生成微博的代码,这样我们才有内容可以显示。

8.2.1 节中对登录机制的介绍类似,10.2.1 节也会经常将一些元素推送到堆栈里,然后再一个一个的从栈尾取出来。如果理解起来有点困难,多点耐心,你的付出会在 10.2.2 节得到回报。

10.2.1 充实用户资料页面

我们先在用户的 request spec 中加入对显示微博的测试。我们采用的方法是,先通过预构件创建几篇微博,然后检查用户资料页面是否显示了这几篇微博,同时我们还要验证是否显示了如图 10.4 中所示的总的微博数量。

我们可以使用 let 方法创建微博,不过如代码 10.10 所示,我们希望用户和微博的关联立即生效,这样微博才能显示在用户的资料页面中。所以,我们要使用 let! 方法:

let(:user) { FactoryGirl.create(:user) }
let!(:m1) { FactoryGirl.create(:micropost, user: user, content: "Foo") }
let!(:m2) { FactoryGirl.create(:micropost, user: user, content: "Bar") }

before { visit user_path(user) }
user microposts mockup bootstrap

图 10.4:显示了微博的资料页面构思图

按照上面这种方式定义了微博后,我们就可以使用代码 10.16 中的代码测试用户资料页面中是否显示了这些微博。

代码 10.16:检测用户资料页面是否显示了微博的测试

spec/requests/user_pages_spec.rb

require 'spec_helper'

describe "User pages" do
  .
  .
  .
  describe "profile page" do
    let(:user) { FactoryGirl.create(:user) }
    let!(:m1) { FactoryGirl.create(:micropost, user: user, content: "Foo") }
    let!(:m2) { FactoryGirl.create(:micropost, user: user, content: "Bar") }

    before { visit user_path(user) }

    it { should have_content(user.name) }
    it { should have_title(user.name) }

    describe "microposts" do
      it { should have_content(m1.content) }
      it { should have_content(m2.content) }
      it { should have_content(user.microposts.count) }
    end
  end
  .
  .
  .
end

注意,我们可以在关联关系的方法上调用 count 方法:

user.microposts.count

这个 count 方法是很聪明的,可以直接在数据库层统计数量。也就是说,count 的计数过程不是把微博从数据库中取出来,然后再在所得的数组上调用 length 方法,如果这样做的话,微博数量一旦很多的话,效率就会很低。其实,count 方法会直接在数据库层中统计用户的微博数量。如果统计数量仍然是程序的性能瓶颈的话,你可以使用“计数缓存”进一步提速。

在加入代码 10.18 之前,代码 10.16 中的测试是无法通过的,不过现在我们可以先在用户的资料页面中加入一些微博,如代码 10.17 所示。

代码 10.17:在用户资料页面中加入微博

app/views/users/show.html.erb

<% provide(:title, @user.name) %>
<div class="row">
  .
  .
  .
  <aside>
    .
    .
    .
  </aside>
  <div class="span8">
    <% if @user.microposts.any? %>
      <h3>Microposts (<%= @user.microposts.count %>)</h3>
      <ol class="microposts">
        <%= render @microposts %>
      </ol>
      <%= will_paginate @microposts %>
    <% end %>
  </div>
</div>

微博列表稍后分析,现在先看看其他部分。在这段代码中,if @user.microposts.any?(在代码 7.24 中见过类似的用法)的作用是,如果用户没有发布微博的话,就不会显示后面的列表。

还要注意一下,在代码 10.17 中我们也加入了微博的分页显示功能:

<%= will_paginate @microposts %>

如果和用户索引页面中对应的代码(参见代码 9.33)比较的话,会发现,之前所用的代码是:

<%= will_paginate %>

之前之所以可以直接调用,是因为在 Users 控制器中,will_paginate 默认程序中存在一个名为 @users 的变量(在 9.3.3 节中介绍过,该变量的值必须是 AvtiveRecord::Relation 的实例)。现在,虽然我们还在 Users 控制器中,但是我们要对微博分页,所以 will_paginate 方法要指定 @microposts 变量作为参数。当然了,我们还要在 show 动作中定义 @microposts 变量(参见代码 10.19)。

接着,还显示了当前微博的数量:

<h3>Microposts (<%= @user.microposts.count %>)</h3>

前面介绍过,@user.microposts.count 的作用和 User.count 类似,不过统计的微博数量却是建立在用户和微博的关联关系上的。

最后,我们来看一下显示微博的列表:

<ol class="microposts">
  <%= render @microposts %>
</ol>

这段代码使用了一个有序列表标签 ol,显示一个微博列表,不过关键的部分是通过一个微博局部视图实现的。在 9.3.4 节中介绍过,如下的代码

<%= render @users %>

会使用名为 _user.html.erb 的局部视图渲染 @users 变量中的每一个用户。因此,如下的代码

<%= render @microposts %>

会对微博做同样的渲染操作。所以,我们要创建名为 _micropost.html.erb 的局部视图(存放在微博对应的视图文件夹中),如代码 10.18 所示。

代码 10.18:显示单篇微博的局部视图

app/views/microposts/_micropost.html.erb

<li>
  <span class="content"><%= micropost.content %></span>
  <span class="timestamp">
    Posted <%= time_ago_in_words(micropost.created_at) %> ago.
  </span>
</li>

这段代码使用了 time_ago_in_words 帮助方法,会在 10.2.2 节中介绍。

user profile no microposts bootstrap

图 10.5:添加了显示微博代码后的用户资料页面,不过还没有微博可显示

至此,尽管定义了所需的全部视图,但是代码 10.16 中的测试仍旧无法通过,提示未定义 @microposts 变量。加入代码 10.19 中的代码后,测试就可以通过了。

代码 10.19:在 Users 控制器的 show 动作中加入 @microposts 实例变量

app/controllers/users_controller.rb

class UsersController < ApplicationController
  .
  .
  .
  def show
    @user = User.find(params[:id])
    @microposts = @user.microposts.paginate(page: params[:page])
  end
  .
  .
  .
end

请注意一下 paginate 方法是多么的智能,它甚至可以通过关联关系,在 microposts 数据表中取出每个分页中要显示的微博。

现在,我们可以查看一下刚编好的用户资料页面了,如图 10.5 所示,可能会出乎你的意料,这也是理所当然的,因为我们还没有发布微博呢。下面我们就来发布微博。

10.2.2 示例微博

10.2.1 节中为了显示微博,创建了几个视图,但是结果有点不给力。为了改变这个悲剧,我们要在 9.3.2 节中用到的示例数据生成器中加入生成微博数据的代码。如果给所有的用户都生成一些微博的话要用很长的时间,所以我们暂且只给前六个用户3生成微博数据,这要用到 User.all 方法的 :limit 选项:4

users = User.all(limit: 6)

我们要为每个用户生成 50 篇微博(这个数量大于单页显示的 30 篇限制),使用 Faker gem 中简便的 Lorem.sentence 方法生成每篇微博的内容。(Faker::Lorem.sentence 生成的是 lorem ipsum 示例文字,我们在第 6 章中介绍过,lorem ipsum 背后有一段有趣的故事。)代码 10.20 中显示的是修改后的示例数据生成器。

代码 10.20:在示例数据生成器中加入生成微博的代码

lib/tasks/sample_data.rake

namespace :db do
  desc "Fill database with sample data"
  task populate: :environment do
    .
    .
    .
    users = User.all(limit: 6)
    50.times do
      content = Faker::Lorem.sentence(5)
      users.each { |user| user.microposts.create!(content: content) }
    end
  end
end

当然,如果要生成示例数据,我们要执行 db:populate 命令:

$ bundle exec rake db:reset
$ bundle exec rake db:populate
$ bundle exec rake test:prepare

然后,我们就能看到 10.2.1 节中劳动的果实了,在用户资料页面显示了生成的微博。5初步结果如图 10.6 所示。

user profile microposts no styling bootstrap

图 10.6:用户资料页面(/users/1)中显示的尚未样式化的微博列表

图 10.6 中显示的微博列表还没有加入样式,那我们就加入一些样式(参见代码 10.21)6,再看一下页面显示的效果。图 10.7 显示的是第一个用户(当前登录用户)的资料页面,图 10.8 显示的是另一个用户的资料页面,图 10.9 显示的是第一个用户资料页面的第 2 页,页面底部还显示了分页链接。注意观察这三幅图,我们可以看到微博后面显示了距离发布的时间(例如,“Posted 1 minute ago.”),这个效果是通过代码 10.18 中的 time_ago_in_words 方法实现的。过一会再刷新页面,你会发现这些文字依据当前时间自动更新了。

user profile with microposts bootstrap

图 10.7:显示了微博的用户资料页面(/users/1

代码 10.21:微博列表的样式(包含了本章用到的所有样式)

app/assets/stylesheets/custom.css.scss

.
.
.

/* microposts */

.microposts {
  list-style: none;
  margin: 10px 0 0 0;

  li {
    padding: 10px 0;
    border-top: 1px solid #e8e8e8;
  }
}
.content {
  display: block;
}
.timestamp {
  color: $grayLight;
}
.gravatar {
  float: left;
  margin-right: 10px;
}
aside {
  textarea {
    height: 100px;
    margin-bottom: 5px;
  }
}
other profile with microposts bootstrap

图 10.8:另一个用户的资料页面,也显示了微博列表(/users/5

user profile microposts page 2 rails3 bootstrap

图 10.9:微博分页链接(/users/1?page=2

10.3 微博相关的操作

微博的数据模型构建好了,也编写了相关的视图文件,接下来我们的开发重点是,通过网页发布微博。在实现的过程中,我们会第三次用到表单来创建资源,这一次创建的是 Microposts 资源7。本节,我们还会初步实现动态列表(status feed),在第 11 章再完善。最后,和 Users 资源类似,我们还要实现在网页中删除微博的功能。

上述功能的实现和之前的惯例有一点是不一样的地方,需要特别注意,那就是,Microposts 资源相关的页面不是通过 Microposts 控制器实现的,而是依赖于 Users 和 StaticPages 控制器。这也就意味着,Microposts 资源的路由设置是很简单的,如代码 10.22 所示。代码 10.22 中的代码所代表的符合 REST 结构的路由如表格 10.2 所示,表中的路由只是表格 2.3 的一部分。不过,路由虽然简化了,但预示着实现的过程需要更高级的技术,而不会减小代码的复杂度。从第 2 章起我们就十分依赖脚手架,不过现在我们将舍弃脚手架的大部分功能。

代码 10.22:Microposts 资源的路由设置

config/routes.rb

SampleApp::Application.routes.draw do
  resources :users
  resources :sessions,   only: [:new, :create, :destroy]
  resources :microposts, only: [:create, :destroy]
  .
  .
  .
end

表格 10.2:代码 10.25 设置的 Microposts 资源路由

HTTP 请求 URL 动作 作用
POST /microposts create 创建新微博
DELETE /microposts/1 destroy 删除 id 为 1 的微博

10.3.1 访问限制

开发 Microposts 资源的第一步,我们要在 Microposts 控制器中实现访问限制。我们要实现的效果很简单:若要访问 createdestroy 动作就要先登录。针对访问限制的 RSpec 测试如代码 10.23 所示。(在 10.3.4 节中,我们还会测试并加入第三层保护措施,确保只有微博的发布者才能删除该微博。)

代码 10.23:限制访问 Microposts 资源的测试

spec/requests/authentication_pages_spec.rb

require 'spec_helper'

describe "Authentication" do
  .
  .
  .
  describe "authorization" do

    describe "for non-signed-in users" do
      let(:user) { FactoryGirl.create(:user) }
      .
      .
      .
      describe "in the Microposts controller" do

        describe "submitting to the create action" do
          before { post microposts_path }
          specify { expect(response).to redirect_to(signin_path) }
        end

        describe "submitting to the destroy action" do
          before { delete micropost_path(FactoryGirl.create(:micropost)) }
          specify { expect(response).to redirect_to(signin_path) }
        end
      end
      .
      .
      .
    end
  end
end

上述代码没有使用即将实现的网页界面,而是直接在 Microposts 控制器层面操作:如果向 /microposts 发送 POST 请求(POST microposts_path 访问的是 create 动作),或者向 /microposts/1 发送 DELETE 请求(delete micropost_path(micropost) 访问的是 destroy 动作),则会转向登录页面——我们在代码 9.13 中就用过这种方法。

我们要先对程序的代码做点重构,然后再加入程序中,让代码 10.23 中的测试通过。在 9.2.1 节中,我们定义了一个名为 signed_in_user 的事前过滤器(参见代码 9.12),确保访问相关的动作之前用户要先登录。那时,我们只需要在 Users 控制器中使用这个事前过滤器,但是现在我们在 Microposts 控制器中也要用到,那么我们就把它移到 Sessions 的帮助方法中,如代码 10.24 所示。8

代码 10.24:signed_in_user 方法移到 Sessions 帮助方法中

app/helpers/sessions_helper.rb

module SessionsHelper
  .
  .
  .
  def current_user?(user)
    user == current_user
  end

  def signed_in_user
    unless signed_in?
      store_location
      redirect_to signin_url, notice: "Please sign in."
    end
  end
  .
  .
  .
end

为了避免代码重复,同时还要把 signed_in_user 从 Users 控制器中删掉。

加入了代码 10.24 之后,我们就可以在 Microposts 控制器中使用 signed_in_user 方法了,因此我们就可以使用代码 10.25 中的事前过滤器来限制访问 createdestroy 动作了。(因为我们没有使用命令行生成 Microposts 控制器文件,因此需要手动创建。)

代码 10.25:在 Microposts 控制器中加入访问限制功能

app/controllers/microposts_controller.rb

class MicropostsController < ApplicationController
  before_action :signed_in_user

  def create
  end

  def destroy
  end
end

注意,我们没有明确指定事前过滤器要限制的动作有哪几个,因为默认情况下仅有的两个动作都会被限制。如果我们要加入第三个动作,例如 index 动作,未登录的用户可以访问,那么我们就要明确的指定要限制的动作了:

class MicropostsController < ApplicationController
  before_action :signed_in_user, only: [:create, :destroy]

  def index
  end

  def create
  end

  def destroy
  end
end

现在,测试应该可以通过了:

$ bundle exec rspec spec/requests/authentication_pages_spec.rb

10.3.2 创建微博

第 7 章中,我们实现了用户注册功能,方法是使用 HTML 表单向 Users 控制器的 create 动作发送 POST 请求。创建微博的功能实现起来是类似的,最大的不同点在于,表单不是放在单独的页面 /microposts/new 中,而是在网站的首页(模仿 Twitter,在根地址 /),构思图如图 10.10 所示。

上一次接触首页时,是图 5.6 那个样子,在页面中部有个“Sign up now!”链接按钮。因为创建微博的表单只对登录后的用户有用,所以本节的目标之一就是根据用户的登录状态显示不同的首页内容,如代码 10.28 所示,不过在此之前,我们可以先编写测试。和用户资源一样,我们要使用集成测试:

$ rails generate integration_test micropost_page
home page with micropost form mockup bootstrap

图 10.10:包含创建微博表单的首页构思图

对创建微博功能的测试和对创建用户功能的测试(参见代码 7.16)类似,如代码 10.26 所示:

代码 10.26:对创建微博功能的测试

spec/requests/micropost_pages_spec.rb

require 'spec_helper'

describe "Micropost pages" do

  subject { page }

  let(:user) { FactoryGirl.create(:user) }
  before { sign_in user }

  describe "micropost creation" do
    before { visit root_path }

    describe "with invalid information" do

      it "should not create a micropost" do
        expect { click_button "Post" }.not_to change(Micropost, :count)
      end

      describe "error messages" do
        before { click_button "Post" }
        it { should have_content('error') }
      end
    end

    describe "with valid information" do

      before { fill_in 'micropost_content', with: "Lorem ipsum" }
      it "should create a micropost" do
        expect { click_button "Post" }.to change(Micropost, :count).by(1)
      end
    end
  end
end

下面我们来编写 Microposts 控制器 create 动作的代码,和 Users 控制器的有点类似(参见代码 7.26),主要的区别是,创建微博时,要使用用户和微博的关联关系来构建微博对象,如代码 10.27 所示。

代码 10.27:Microposts 控制器的 create 动作

app/controllers/microposts_controller.rb

class MicropostsController < ApplicationController
  before_action :signed_in_user

  def create
    @micropost = current_user.microposts.build(micropost_params)
    if @micropost.save
      flash[:success] = "Micropost created!"
      redirect_to root_url
    else
      render 'static_pages/home'
    end
  end

  def destroy
  end

  private

    def micropost_params
      params.require(:micropost).permit(:content)
    end
end

我们使用代码 10.28 来构建创建微博所需的表单,这个视图会根据用户的登录状态显示不同的 HTML 内容。

代码 10.28:在首页中加入创建微博所需的表单

app/views/static_pages/home.html.erb

<% if signed_in? %>
  <div class="row">
    <aside class="span4">
      <section>
        <%= render 'shared/user_info' %>
      </section>
      <section>
        <%= render 'shared/micropost_form' %>
      </section>
    </aside>
  </div>
<% else %>
  <div class="center hero-unit">
    <h1>Welcome to the Sample App</h1>

    <h2>
      This is the home page for the
      <a href="http://railstutorial.org/">Ruby on Rails Tutorial</a>
      sample application.
    </h2>

    <%= link_to "Sign up now!", signup_path,
                                class: "btn btn-large btn-primary" %>
  </div>

  <%= link_to image_tag("rails.png", alt: "Rails"), 'http://rubyonrails.org/' %>
<% end %>

上述代码中 if-else 条件语句的各分支包含的代码太多,有点乱,在练习中(10.5 节)我们会进行优化,把分支中的代码放入局部视图中。不过代码 10.28 中用到的局部视图不会留作练习,现在就来创建:用户信息侧边栏局部视图如代码 10.29 所示,创建微博的表单局部视图如代码 10.30 所示。

代码 10.29:用户信息侧边栏局部视图

app/views/shared/_user_info.html.erb

<a href="<%= user_path(current_user) %>">
  <%= gravatar_for current_user, size: 52 %>
</a>
<h1>
  <%= current_user.name %>
</h1>
<span>
  <%= link_to "view my profile", current_user %>
</span>
<span>
  <%= pluralize(current_user.microposts.count, "micropost") %>
</span>

和代码 9.24 一样,代码 10.29 使用了代码 7.30 中定义的 gravatar_for 帮助方法。

注意,和用户资料页面的侧边栏类似(参见代码 10.20),代码 10.29 中的用户信息也显示了用户发布的微博数量。不过显示上有细微的差别,在用户资料页面的侧边栏中,“Microposts” 是作为标签使用的,所以“Microposts (1)”这样的用法是合理的。而在本例中,如果说“1 microposts”的话就有点不合语法了,所以我们调用了 pluralize 方法,显示成“1 micropost”,“2 microposts”等。

下面我们来编写创建微博表单的局部视图,如代码 10.30 所示,和代码 7.17 中的注册表单是类似的。

代码 10.30:创建微博表单局部视图

app/views/shared/_micropost_form.html.erb

<%= form_for(@micropost) do |f| %>
  <%= render 'shared/error_messages', object: f.object %>
  <div class="field">
    <%= f.text_area :content, placeholder: "Compose new micropost..." %>
  </div>
  <%= f.submit "Post", class: "btn btn-large btn-primary" %>
<% end %>

如果要代码 10.30 中的表单可用,我们还要做两件事。第一,(和之前一样)我们要通过关联关系定义 @micropost 变量:

@micropost = current_user.microposts.build

写入控制器后如代码 10.31 所示。

代码 10.31:home 动作中定义 @micropost 实例变量

app/controllers/static_pages_controller.rb

class StaticPagesController < ApplicationController

  def home
    @micropost = current_user.microposts.build if signed_in?
  end
  .
  .
  .
end

代码 10.31 中的代码有一个好处,如果我们忘记加入要求用户登录的限制,相应的测试会失败。

我们要做的第二件事是,重写错误提示信息局部视图,让 <%= render 'shared/error_messages', object: f.object %> 这行代码能正确运行。你可能还记得,在代码 7.23 中,错误提示信息的局部视图代码直接引用了 @user 变量,但现在我们提供的变量却是 @micropost。因此,我们要编写一个新的错误提示信息局部视图,不管传入的是什么变量,都能正常使用。幸好,表单的块变量 f 可以通过 f.object 获取当前的对象,因此,在 form_for(@user) do |f| 中,f.object 的返回值是 @user;在 form_for(@micropost) do |f| 中,f.object 的返回值是 @micropost

我们要通过一个 Hash 把对象传入局部视图,其值是该对象,键是局部视图中所需的变量名称,如下面的代码所示:

<%= render 'shared/error_messages', object: f.object %>

换句话说,object: f.object 会创建一个名为 object 的变量,供 error_messages 局部视图使用。利用这个对象,我们就可以编写不同的错误提示信息,如代码 10.32 所示。

代码 10.32:修改代码 7.23 中的错误提示信息局部视图,如果传入其他对象也可以使用

app/views/shared/_error_messages.html.erb

<% if object.errors.any? %>
  <div id="error_explanation">
    <div class="alert alert-error">
      The form contains <%= pluralize(object.errors.count, "error") %>.
    </div>
    <ul>
    <% object.errors.full_messages.each do |msg| %>
      <li>* <%= msg %></li>
    <% end %>
    </ul>
  </div>
<% end %>

现在,代码 10.26 中的测试应该可以通过了:

$ bundle exec rspec spec/requests/micropost_pages_spec.rb

不过,Users 资源相关视图的 request spec 测试却失败了,因为注册和编辑用户的表单使用的仍是旧的错误提示信息局部视图。要想修正这个错误,就要换用新的局部视图,如代码 10.33 和代码 10.34 所示。(注意:如果你加入了 9.6 节练习中的代码 9.49 和代码 9.50,那么要修改的代码有点不一样,需要做适当的修改。)

代码 10.33:修改用户注册表单的错误提示信息局部视图

app/views/users/new.html.erb

<% provide(:title, 'Sign up') %>
<h1>Sign up</h1>

<div class="row">
  <div class="span6 offset3">
    <%= form_for(@user) do |f| %>
      <%= render 'shared/error_messages', object: f.object %>
      .
      .
      .
    <% end %>
  </div>
</div>
home with form bootstrap

图 10.11:显示有创建微博表单的首页(/

代码 10.34:修改编辑用户表单的错误提示信息局部视图

app/views/users/edit.html.erb

<% provide(:title, "Edit user") %>
<h1>Update your profile</h1>

<div class="row">
  <div class="span6 offset3">
    <%= form_for(@user) do |f| %>
      <%= render 'shared/error_messages', object: f.object %>
      .
      .
      .
    <% end %>

    <%= gravatar_for(@user) %>
    <a href="http://gravatar.com/emails">change</a>
  </div>
</div>

现在,所有的测试应该都可以通过了:

$ bundle exec rspec spec/

而且,本节添加的所有 HTML 代码也都能正确渲染:图 10.11 中显示了创建微博的表单,图 10.12 中显示了有一个错误提示信息的表单。现在你可以自己发布一篇微博试一下一切是否都可以正常运行,不过最好还是在 10.3.3 节之后再试吧。

home form errors bootstrap

图 10.12:显示有错误提示信息的首页

10.3.3 临时的动态列表

10.3.2 节遗留了一个功能没有实现:首页没有显示动态。如果你愿意的话,可以在图 10.11 所示的表单中发表一篇合法的微博,然后转到用户资料页面,验证一下这个表单是否可以正常使用。这样在页面之间来来回回是有点麻烦的,如果能在首页显示一个含有当前登入用户的微博列表就好了,构思图如图 10.13 所示。(在第 11 章中,我们会在这个微博列表中加入当前登入用户所关注用户的微博。)

proto feed mockup bootstrap

图 10.13:显示有临时动态列表的首页构思图

因为每个用户都应该有一个动态列表,因此我们可以在 User 模型中定义一个名为 feed 的方法。等功能全部实现后,我们会测试微博列表中是否包含了所关注用户的微博,不过现在我们只需要测试 feed 方法的返回值是否只有当前登入用户的微博,而没有其他用户的微博。测试所需的代码如代码 10.35 所示。

代码 10.35:对临时动态列表的测试

spec/models/user_spec.rb

require 'spec_helper'

describe User do
  .
  .
  .
  it { should respond_to(:microposts) }
  it { should respond_to(:feed) }
  .
  .
  .
  describe "micropost associations" do

    before { @user.save }
    let!(:older_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.day.ago)
    end
    let!(:newer_micropost) do
      FactoryGirl.create(:micropost, user: @user, created_at: 1.hour.ago)
    end
    .
    .
    .
    describe "status" do
      let(:unfollowed_post) do
        FactoryGirl.create(:micropost, user: FactoryGirl.create(:user))
      end

      its(:feed) { should include(newer_micropost) }
      its(:feed) { should include(older_micropost) }
      its(:feed) { should_not include(unfollowed_post) }
    end
  end
end

上述代码,在数组上调用了 include? 方法(基于 RSpec 对布尔值方法的约定),该方法的作用是检查数组中是否包含指定的元素:9

$ rails console
>> a = [1, "foo", :bar]
>> a.include?("foo")
=> true
>> a.include?(:bar)
=> true
>> a.include?("baz")
=> false

这段代码说明了 RSpec 对布尔值方法的约定是多么的灵活,虽然 include 是 Ruby 语言的关键字(用来引入模块,在代码 8.14 中有用到),但在当前语境中,RSpec 依然能正确的识别我们的意图是要测试数组是否包含了指定的元素。

在编写 feed 方法时,我们需要从数据库中取出所有 user_id 等于当前用户 id 的微博,要在 Micropost 对象上调用 where 方法,如代码 10.36 所示。10

代码 10.36:动态列表的初步实现

app/models/user.rb

class User < ActiveRecord::Base
  .
  .
  .
  def feed
    # This is preliminary. See "Following users" for the full implementation.
    Micropost.where("user_id = ?", id)
  end
  .
  .
  .
end

Micropost.where("user_id = ?", id) 中的问号可以确保 id 的值在传入底层的 SQL 查询语句之前做了适当的转义,避免“SQL 注入”这种严重的安全隐患。这里用到的 id 属性是个整数,没什么危险,不过在 SQL 语句中引入变量之前做转义是个好习惯。

细心的读者可能已经注意到了,现阶段代码 10.36 中的代码和下面的定义作用是一样的:

def feed
  microposts
end

我们之所以使用了代码 10.39 的版本,是因为它能更好的服务于第 11 章中实现的完整的动态列表。

要测试动态列表的显示,我们首先要创建一些微博,然后检测各微博在页面中是否均包含在列表元素 li 中,如代码 10.37 所示。

代码 10.37:测试首页显示的微博列表

spec/requests/static_pages_spec.rb

require 'spec_helper'

describe "Static pages" do

  subject { page }

  describe "Home page" do
    .
    .
    .
    describe "for signed-in users" do
      let(:user) { FactoryGirl.create(:user) }
      before do
        FactoryGirl.create(:micropost, user: user, content: "Lorem ipsum")
        FactoryGirl.create(:micropost, user: user, content: "Dolor sit amet")
        sign_in user
        visit root_path
      end

      it "should render the user's feed" do
        user.feed.each do |item|
          expect(page).to have_selector("li##{item.id}", text: item.content)
        end
      end
    end
  end
  .
  .
  .
end

代码 10.37 假设所显示的每篇微博都有唯一的 CSS id,所以如下代码

expect(page).to have_selector("li##{item.id}", text: item.content)

会为每个微博生成一个匹配器。(注意,li##{item.id} 中的第一个 # 是 Capybara 中的对应 CSS id 的句法,而第二个 # 则代表 Ruby 字符串插值操作 #{} 的开始。)

要在示例程序中使用动态列表,我们可以在 home 动作中定义一个 @feed_items 实例变量,如代码 10.38 所示。然后再在首页(参见代码 10.41)中加入一个动态列表局部视图(参见代码 10.39)。(对分页的测试会留作练习,参见 10.5 节。)

代码 10.38:home 动作中加入一个实例变量

app/controllers/static_pages_controller.rb

class StaticPagesController < ApplicationController

  def home
    if signed_in?
      @micropost  = current_user.microposts.build
      @feed_items = current_user.feed.paginate(page: params[:page])
    end
  end
  .
  .
  .
end

代码 10.39:动态列表局部视图

app/views/shared/_feed.html.erb

<% if @feed_items.any? %>
  <ol class="microposts">
    <%= render partial: 'shared/feed_item', collection: @feed_items %>
  </ol>
  <%= will_paginate @feed_items %>
<% end %>

动态列表局部视图使用如下代码,把列表项目的渲染支配给了 feed_item 局部视图:

<%= render partial: 'shared/feed_item', collection: @feed_items %>

我们传入了一个名为 :collection 的参数,其值为 @feed_items,这样 render 方法就会在指定的局部视图中(本例中的 feed_item)使用这个集合中的数据渲染各项目。(之前,在渲染局部视图时,我们都省略了 :partial 参数,例如 render 'shared/micropost',不过如果指定了 :collection 参数,这种省略的用法就是错误的。)列表项目局部视图的代码如代码 10.40 所示。

代码 10.40:渲染单个动态列表项目的局部视图

app/views/shared/_feed_item.html.erb

<li id="<%= feed_item.id %>">
  <%= link_to gravatar_for(feed_item.user), feed_item.user %>
  <span class="user">
    <%= link_to feed_item.user.name, feed_item.user %>
  </span>
  <span class="content"><%= feed_item.content %></span>
  <span class="timestamp">
    Posted <%= time_ago_in_words(feed_item.created_at) %> ago.
  </span>
</li>

代码 10.40 还使用如下的代码为每个动态项目指定了 CSS id:

<li id="<%= feed_item.id %>">

这正是代码 10.37 中的测试所要检测的。

和之前一样,我们可以把动态列表局部视图加入首页来显示动态,如代码 10.41 所示。加入后的效果就是在首页显示了动态列表,和预期一样,如图 10.14 所示。

代码 10.41:在首页中加入动态列表

app/views/static_pages/home.html.erb

<% if signed_in? %>
  <div class="row">
    .
    .
    .
    <div class="span8">
      <h3>Micropost Feed</h3>
      <%= render 'shared/feed' %>
    </div>
  </div>
<% else %>
  .
  .
  .
<% end %>
home with proto feed bootstrap

图 10.14:显示了临时动态列表的首页(/

现在,发布新微博的功能可以按照预期正常工作了,如图 10.15 所示。不过还有个小小不足:如果发布微博失败,首页还会需要一个名为 @feed_items 的实例变量,所以提交失败时网站就无法正常运行了(你也可以运行测试来验证一下)。最简单的解决方法是,如果提交失败就把 @feed_items 设为空数组,如代码 10.42 所示。11

micropost created bootstrap

图 10.15:发布新微博后的首页

代码 10.42:create 动作加入一个空的 @feed_items 实例变量

app/controllers/microposts_controller.rb

class MicropostsController < ApplicationController
  .
  .
  .
  def create
    @micropost = current_user.microposts.build(micropost_params)
    if @micropost.save
      flash[:success] = "Micropost created!"
      redirect_to root_url
    else
      @feed_items = []
      render 'static_pages/home'
    end
  end
  .
  .
  .
end

至此,临时的动态列表可以正常工作了,测试组件也可以通过了:

$ bundle exec rspec spec/

10.3.4 删除微博

我们要为 Microposts 资源实现的最后一个功能是删除微博。和删除用户类似(参见 9.4.2 节),删除微博也是通过“delete”链接实现的,构思图如图 10.16 所示。删除用户要限制只有管理员才能进行,而删除微博的链接只对微博的发布者可用。

micropost delete links mockup bootstrap

图 10.16:显示有删除链接的临时动态列表构思图

第一步,我们要在微博局部视图(代码 10.21)中加入删除链接,同时还要在动态列表项目的局部视图(代码 10.40)中加入类似的链接,结果如代码 10.43 和代码 10.44 所示。(这两个局部视图基本上是一样的,消除代码重复会留作练习,参见 10.5 节。)

代码 10.43:在微博局部视图中加入删除链接

app/views/microposts/_micropost.html.erb

<li>
  <span class="content"><%= micropost.content %></span>
  <span class="timestamp">
    Posted <%= time_ago_in_words(micropost.created_at) %> ago.
  </span>
  <% if current_user?(micropost.user) %>
    <%= link_to "delete", micropost, method: :delete,
                                     data: { confirm: "You sure?" },
                                     title: micropost.content %>
  <% end %>
</li>

代码 10.44:在动态列表项目局部视图中加入删除链接

app/views/shared/_feed_item.html.erb

<li id="<%= feed_item.id %>">
  <%= link_to gravatar_for(feed_item.user), feed_item.user %>
    <span class="user">
      <%= link_to feed_item.user.name, feed_item.user %>
    </span>
    <span class="content"><%= feed_item.content %></span>
    <span class="timestamp">
      Posted <%= time_ago_in_words(feed_item.created_at) %> ago.
    </span>
  <% if current_user?(feed_item.user) %>
    <%= link_to "delete", feed_item, method: :delete,
                                     data: { confirm: "You sure?" },
                                     title: feed_item.content %>
  <% end %>
</li>

对删除微博的测试要用 Capybara 来点击“delete”链接,然后检测微博的数量是否减少了一个,如代码 10.45 所示。

代码 10.45:针对 Microposts 控制器 destroy 动作的测试

spec/requests/micropost_pages_spec.rb

require 'spec_helper'

describe "Micropost pages" do
  .
  .
  .
  describe "micropost destruction" do
    before { FactoryGirl.create(:micropost, user: user) }

    describe "as correct user" do
      before { visit root_path }

      it "should delete a micropost" do
        expect { click_link "delete" }.to change(Micropost, :count).by(-1)
      end
    end
  end
end

程序所需的代码还是和代码 9.46 中删除用户时类似,两种情况的主要不同之处是,删除微博不使用 admin_user 事前过滤器了,而是用 correct_user 事前过滤器,检查当前用户是否发布了指定 id 的微博,如代码 10.46 所示。图 10.17 显示的是删除了倒数第二个微博后的页面。

代码 10.46:Microposts 控制器的 destroy 动作

app/controllers/microposts_controller.rb

class MicropostsController < ApplicationController
  before_action :signed_in_user, only: [:create, :destroy]
  before_action :correct_user,   only: :destroy
  .
  .
  .
  def destroy
    @micropost.destroy
    redirect_to root_url
  end

  private

    def micropost_params
      params.require(:micropost).permit(:content)
    end

    def correct_user
      @micropost = current_user.microposts.find_by(id: params[:id])
      redirect_to root_url if @micropost.nil?
    end
end

注意,在 correct_user 事前过滤器中,我们是通过关联关系查寻微博的:

current_user.microposts.find_by_id(params[:id])

这行代码可以自行确保只在当前用户发布的微博中查询。这里,我们使用的是 find_by,而没用 find,因为如果没有找到微博 find 会抛出异常,而不会返回 nil。顺便说一下,如果你习惯处理 Ruby 异常,也可以按照下面的方式定义 correct_user 过滤器:

def correct_user
  @micropost = current_user.microposts.find(params[:id])
rescue
  redirect_to root_url
end

你可能会说,我们也可以直接使用 Micropost 对象来实现 correct_user 过滤器,就像下面这样:

@micropost = Micropost.find_by(id: params[:id])
redirect_to root_url unless current_user?(@micropost.user)

这种实现方式基本上和代码 10.46 是一样的,不过,Wolfram Arnold 在《Access Control 101 in Rails and the Citibank Hack》一文中解释过,安全起见,最好还是通过关联来查找。

home post delete bootstrap

图 10.17:删除了倒数第二篇微博后的首页

加入了本节的代码后,我们的 Micropost 模型以及用户界面就都完成了,测试组件也可以通过了:

$ bundle exec rspec spec/

10.4 小结

加入了 Microposts 资源后,我们的示例程序基本上完成了。还没实现的部分是社交功能,让用户之间可以相互关注。在第 11 章中我们会学习如何实现这种关联关系,还要实现一个真正的动态列表。

如果你使用 Git 做版本控制的话,在继续之前,先提交改动,然后再合并到主分支:

$ git add .
$ git commit -m "Add user microposts"
$ git checkout master
$ git merge user-microposts
$ git push

现在你也可以把程序推送到 Heroku 上。因为加入 microposts 表改动了数据模型,因此你需要在“生产数据库”中执行迁移操作:

$ git push heroku
$ heroku pg:reset DATABASE
$ heroku run rake db:migrate
$ heroku run rake db:populate

10.5 练习

到目前为止,我们已经实现了很多功能,在现有功能的基础上我们还可以实现更多的功能,下面就是一些例子。

  1. 添加测试,检测侧边栏中微博的数量是否正确显示了,要包含对单复数的检查。

  2. 添加测试,检测微博的分页功能。

  3. 重构首页的视图文件,把 if-else 语句的两个分支分别放到单独的局部视图中。

  4. 编写一个测试,确保不是当前用户发布的微博下方不会显示删除链接。

  5. 使用局部视图去掉代码 10.43 和代码 10.44 中的重复。

  6. 现在,特别长的单词会撑破布局,如图 10.18 所示。使用代码 10.47 中定义的 wrap 帮助方法修正这个错误。注意,其中用到的 raw 方法是为了避免 Rails 转义 HTML 代码,sanitize 方法是为了防止跨站脚本攻击。这段代码还用到了看起来很奇怪但是很实用的三元操作符(ternary operator,参见旁注 10.1 的说明)。

  7. 附加题)在首页中添加一段 JavaScript 代码,当在发布微博的表单中输入文字时,显示输入的内容与 140 个字符的差值。

旁注 10.1:三种人

世界上有三种人:一种喜欢用三元操作符,一种不喜欢,还有一种甚至不知道三元操作符是什么。(如果你不幸是第三种人的话,看过下面的说明就不再归属其中了。)

在编写很多代码之后,你会发现最常用到的流程控制是类似下面这种:

if boolean?
  do_one_thing
else
  do_something_else
end

Ruby 和其他很多语言一样(包括 C/C++,Perl,PHP 和 Java),提供了一种更为简单的表达式来替换这种流程控制结构——三元操作符(之所以起了这个名字,是因为三元操作符涉及三个部分):

boolean? ? do_one_thing : do_something_else

三元操作符甚至可以用来替代赋值操作:

if boolean?
  var = foo
else
  var = bar
end

可以改写成

var = boolean? ? foo : bar

另外一个经常使用地方是在函数的返回值中:

def foo
  do_stuff
  boolean? ? "bar" : "baz"
end

因为 Ruby 函数的默认返回值是定义体中的最后一个表达式,所以 foo 方法的返回值会根据 boolean? 的结果而不同,不是 "bar" 就是 "baz"。代码 10.47 中就用到了这种结构。

代码 10.47:换行显示长单词的帮助方法

app/helpers/microposts_helper.rb

module MicropostsHelper

  def wrap(content)
    sanitize(raw(content.split.map{ |s| wrap_long_string(s) }.join(' ')))
  end

  private

    def wrap_long_string(text, max_width = 30)
      zero_width_space = "&#8203;"
      regex = /.{1,#{max_width}}/
      (text.length < max_width) ? text :
                                  text.scan(regex).join(zero_width_space)
    end
end
long word micropost bootstrap

图 10.18:特别长的单词撑破了网站的布局

  1. 严格来说,我们在第 8 章中是把 session 当做资源来处理的,不过 session 不会像 Users 和 Microposts 资源那样被存入数据库。

  2. content 属性是字符串(string)类型,不过我们曾在 2.1.2 节中简要介绍过,较长的文本应该使用 text 类型。

  3. 例如自定义了头像的 5 个用户和 使用 Gravatar 默认头像的 1 个用户。

  4. 如果你对这个方法生成的 SQL 感兴趣,可以查看 log/development.log 文件。

  5. Faker 中的 lorem ipsum 文本是被设计为随机生成的,所以你的示例微博可能和我的不一样。

  6. 为了行文方便,代码 10.21 实际上包含了本章用到的所有 CSS。

  7. 另外两个资源分别是 7.2 节 中的 Users 资源和 8.1 节中的 Sessions 资源。

  8. 我们在 8.2.1 节中介绍过,默认情况下帮助方法只能在视图中使用,因此要在控制器中使用 Sessions 帮助方法就要在 Application 控制器中加入代码 include SessionHelper

  9. 我之所以在 1.1.1 节中推荐读者在读完本书后阅读一本纯介绍 Ruby 的书,就是为了学习使用类似 include? 这样的方法。

  10. 阅读 Rails 指南中的《Active Record Query Interface》一文,更深入的学习 where 等方法的用法。

  11. 很不幸,这样的话分页就不可用了。你可以加入分页,点击分页链接看一下是为什么。