在 Rails 3 中自定义 Rspec 生成器

Question

我正在编写一个 Rails 3.1 引擎并使用 RSpec 2 进行测试。当我使用

rails generate

时，我会自动为我生成规范文件，这非常方便：

$ rails g model Foo
  invoke  active_record
  create    db/migrate/20111102042931_create_myengine_foos.rb
  create    app/models/myengine/foo.rb
  invoke    rspec
  create      spec/models/myengine/foo_spec.rb

但是，为了使生成的规范能够与我的隔离命名空间很好地配合，我必须每次都手动将规范包装在模块中：

require 'spec_helper'

module MyEngine
  describe Foo do
    it "should be round"
    ...
  end
end

我很想知道是否有一种干净、简单的方法来修改自动生成的规范“模板”，这样我就不必每次生成新模型或控制器时都将规范包装在

Module MyEngine

中。

Answer 1

您可以使用 Rake 任务复制 RSpec 的模板，例如：

namespace :spec do
  namespace :templates do
    # desc "Copy all the templates from rspec to the application directory for customization. Already existing local copies will be overwritten"
    task :copy do
      generators_lib = File.join(Gem.loaded_specs["rspec-rails"].full_gem_path, "lib/generators")
      project_templates = "#{Rails.root}/lib/templates"

      default_templates = { "rspec" => %w{controller helper integration mailer model observer scaffold view} }

      default_templates.each do |type, names|
        local_template_type_dir = File.join(project_templates, type)
        FileUtils.mkdir_p local_template_type_dir

        names.each do |name|
          dst_name = File.join(local_template_type_dir, name)
          src_name = File.join(generators_lib, type, name, "templates")
          FileUtils.cp_r src_name, dst_name
        end
      end
    end
  end
end

然后您可以修改

#{Rails.root}/lib/templates/rspec/model/model_spec.rb

中的代码以包含模块名称。

Answer 2

将“/lib/generators/rspec/scaffold/templates/controller_spec.rb”文件从 rspec-rails gem 复制到“./lib/templates/rspec/scaffold”文件夹，然后自定义它。显然，如果您迁移到新版本的 rspec-rails，您将需要确保您的自定义模板没有过时。