Rails 应用模版

优质

小牛编辑

129浏览

2023-12-01

Rails应用模版

应用模版是一个包括使用DSL添加gems/initializers等操作的普通Ruby文件.可以很方便的在你的应用中创建。

读完本章节，你将会学到：

如何使用模版生成/个性化一个应用。
如何使用Rails的模版API编写可复用的应用模版。

1 模版应用简介

为了使用一个模版，你需要为Rails应用生成器在生成新应用时提供一个'-m'选项来配置模版的路径。该路径可以是本地文件路径也可以是URL地址。

$ rails new blog -m ~/template.rb
$ rails new blog -m http://example.com/template.rb

你可以使用rake的任务命令rails:template为Rails应用配置模版。模版的文件路径需要通过名为'LOCATION'的环境变量设定。再次强调，这个路径可以是本地文件路径也可以是URL地址：

$ bin/rake rails:template LOCATION=~/template.rb
$ bin/rake rails:template LOCATION=http://example.com/template.rb

2 模版API

Rails模版API很容易理解，下面我们来看一个典型的模版例子：

# template.rb
generate(:scaffold, "person name:string")
route "root to: 'people#index'"
rake("db:migrate")

git :init
git add: "."
git commit: %Q{ -m 'Initial commit' }

下面的章节将详细介绍模版API的主要方法：

2.1 gem(*args)

向一个Rails应用的Gemfile配置文件添加一个'gem'实体。举个例子，如果你的应用的依赖项包含bj 和 nokogiri等gem ：

gem "bj"
gem "nokogiri"

需要注意的是上述代码不会安装gem文件到你的应用里，你需要运行bundle install 命令来安装它们。

bundle install

2.2 gem_group(*names, &block)

将gem实体嵌套在一个组里。

比如，如果你只希望在development和test组里面使用rspec-rails，可以这么做：

gem_group :development, :test do
  gem "rspec-rails"
end

2.3 add_source(source, options = {})

为Rails应用的Gemfile文件指定数据源。

举个例子。如果你需要从"http://code.whytheluckystiff.net"下载一个gem：

add_source "http://code.whytheluckystiff.net"

2.4 environment/application(data=nil, options={}, &block)

为Application在config/application.rb中添加一行内容。

如果声明了options[:env]参数，那么这一行会在config/environments添加。

environment 'config.action_mailer.default_url_options = {host: "http://yourwebsite.example.com"}', env: 'production'

可以使用一个 'block'标志代替data参数。

2.5 vendor/lib/file/initializer(filename, data = nil, &block)

为一个应用的config/initializers目录添加初始化器。

假如你喜欢使用Object#not_nil? 和 Object#not_blank?：

initializer 'bloatlol.rb', <<-CODE
  class Object
    def not_nil?
      !nil?
    end

    def not_blank?
      !blank?
    end
  end
CODE

一般来说，lib()方法会在 lib/ 目录下创建一个文件，而vendor()方法会在vendor/目录下创建一个文件。

甚至可以用Rails.root的file()方法创建所有Rails应用必须的文件和目录。

file 'app/components/foo.rb', <<-CODE
  class Foo
  end
CODE

上述操作会在app/components目录下创建一个 foo.rb 文件。

2.6 rakefile(filename, data = nil, &block)

在 lib/tasks目录下创建一个新的rake文件执行任务：

rakefile("bootstrap.rake") do
  <<-TASK
    namespace :boot do
      task :strap do
        puts "i like boots!"
      end
    end
  TASK
end

上述代码将在lib/tasks/bootstrap.rake中创建一个boot:strap任务。

2.7 generate(what, *args)

通过给定参数执行生成器操作：

generate(:scaffold, "person", "name:string", "address:text", "age:number")

2.8 run(command)

执行命令行命令，和你在命令行终端敲命令效果一样。比如你想删除README.rdoc文件：

run "rm README.rdoc"

2.9 rake(command, options = {})

执行Rails应用的rake任务，比如你想迁移数据库：

rake "db:migrate"

你也可以在不同的Rails应用环境中执行rake任务：

rake "db:migrate", env: 'production'

2.10 route(routing_code)

在config/routes.rb文件中添加一个路径实体。比如我们之前为某个人生成了一些简单的页面并且把 README.rdoc删除了。现在我们可以把应用的PeopleController#index设置为默认页面：

route "root to: 'person#index'"

2.11 inside(dir)

允许你在指定目录执行命令。举个例子，你如果希望将一个外部应用添加到你的新应用中，可以这么做：

inside('vendor') do
  run "ln -s ~/commit-rails/rails rails"
end

2.12 ask(question)

ask()方法为你提供了一个机会去获取用户反馈。比如你希望用户在你的新应用'shiny library'提交用户反馈意见：

lib_name = ask("What do you want to call the shiny library ?")
lib_name << ".rb" unless lib_name.index(".rb")

lib lib_name, <<-CODE
  class Shiny
  end
CODE

2.13 yes?(question) or no?(question)

这些方法是根据用户的选择之后做一些操作的。比如你的用户希望停止Rails应用，你可以这么做：

rake("rails:freeze:gems") if yes?("Freeze rails gems?")
# no?(question) acts just the opposite.

2.14 git(:command)

Rails模版允许你运行任何git命令：

git :init
git add: "."
git commit: "-a -m 'Initial commit'"

3 高级应用

应用模版是在Rails::Generators::AppGenerator实例的上下文环境中执行的，它使用apply 动作来执行操作Thor。这意味着你可以根据需要扩展它的功能。

比如重载source_paths方法实现把本地路径添加到你的模版应用中。那么类似copy_file方法会在你的模版路径中识别相对路径参数。

def source_paths
  [File.expand_path(File.dirname(__FILE__))]
end