Cách tiếp cận "batteries-included" (đầy đủ công cụ sẵn) của Rails là một trong những tài sản lớn nhất của nó. Không framework nào khác khiến việc khởi động ứng dụng trở nên dễ dàng và nhanh chóng như vậy, một phần nhờ vào các generators của Rails.
Nếu bạn đã sử dụng Rails trong một thời gian, chắc hẳn bạn đã gặp phải generators. Cần tạo ứng dụng mới? Chạy rails new. Cần scaffold một loạt model và view mới? Chạy rails generate scaffold. Có hàng chục generators khác giúp bạn bắt đầu nhanh chóng hoặc hợp lý hóa quy trình làm việc.
Nhưng đôi khi việc sử dụng generators có sẵn vẫn chưa đủ. Bạn có thể muốn tùy chỉnh hành vi của các lệnh này hoặc thậm chí tạo ra generators riêng. Trong bài viết này, chúng ta sẽ tìm hiểu kỹ hơn về generators — đặc biệt là cách tạo ứng dụng Rails tùy chỉnh bằng cách sử dụng templates.
Hãy bắt đầu ngay!
Rails Generators Là Gì?
Không nên nhầm lẫn với generator functions (hàm generator — có thể bạn quen thuộc từ Python hay JavaScript), Rails generators là các lệnh Thor tùy chỉnh tập trung vào việc sinh ra code.
Có rất nhiều ví dụ. Bạn có thể quen với model generator (rails generate model) để tạo ActiveRecord models mới, hoặc migration generator (rails generate migration) để sinh migration mới. Thậm chí còn có rails generate generator — đúng như tên gọi, nó tạo ra một generator mới!
Generators có thể gọi lẫn nhau — ví dụ rails scaffold sẽ gọi nhiều generators khác — và cung cấp các phương thức để tạo hoặc sửa file, cài đặt gem, chạy rake tasks cụ thể, và nhiều hơn nữa. Hãy cùng tạo một generator spec model đơn giản để hiểu cách thức hoạt động.
Tạo Generator Riêng Của Bạn Trong Ruby on Rails
Chạy lệnh sau:
rails generate generator model_spec
Lệnh này sẽ tạo một số file mới trong thư mục /lib/generators/model_spec. Chúng ta có thể chỉnh sửa file model_spec_generator.rb trong thư mục lib/generators/model_spec/ để tạo file spec model ở đúng thư mục:
class ModelSpecGenerator < Rails::Generators::NamedBase
source_root File.expand_path('templates', __dir__)
def create_model_spec
template 'model_spec.rb', "spec/models/#{file_name}_spec.rb"
end
end
Lệnh template sẽ tìm file template trong thư mục lib/generators/model_spec/templates và render nó đến vị trí chỉ định — thư mục spec/models. Lệnh này sẽ thay thế các biến kiểu ERB tìm thấy trong file template.
Bằng cách thiết lập source_root, chúng ta cho generator biết nơi tìm các file template tham chiếu. File template model_spec.rb trong thư mục lib/generators/model_spec/templates/ có thể trông như sau:
require 'rails_helper'
RSpec.describe <%= class_name %>, type: :model do
pending "add some examples to (or delete) #{__FILE__}"
end
Sau khi tạo file đó, bạn có thể chạy generator để tạo file spec mới:
rails generate model_spec User
Nhiều gem đều đi kèm với các generators như thế này. Thực tế, chúng ta vừa tạo một phiên bản đơn giản hóa của generator mà RSpec cung cấp sẵn. FactoryBot có generator cho factories. Còn nhiều ví dụ khác nữa.
Các generators trong các gem thường phức tạp hơn generator chúng ta vừa tạo. Chúng ta có thể làm cho generator nhận arguments (tham số) hoặc thậm chí gắn nó vào các generators có sẵn như rails scaffold. Tham khảo tài liệu Rails generators nếu muốn tìm hiểu thêm.
Vậy generators có tiềm năng đơn giản hóa quy trình làm việc trong ứng dụng hiện có. Nhưng liệu chúng ta có thể dùng generators để tùy chỉnh việc thiết lập ứng dụng mới không?
Đó chính là lúc templates xuất hiện!
Templates Trong Ruby on Rails
Theo tên gọi, templates là các file dùng để tùy chỉnh thiết lập ứng dụng. Đừng nhầm lẫn với các file template chúng ta vừa thảo luận! Bên trong, chúng thực chất là generators với mục đích cụ thể, như API template đã chứng minh. Mặc dù không hoàn toàn giống generators, nhưng chúng rất tương tự.
Nếu bạn đã có sẵn một file template, bạn có thể sử dụng nó như sau:
rails new myapp -m mytemplate.rb
Thay vì chỉ định file local, bạn cũng có thể chỉ định một URL. Điều này đặc biệt hữu ích vì cho phép chia sẻ application templates.
rails new myapp -m https://example.com/mytemplate.rb
Bạn không bị giới hạn chỉ dùng templates khi chạy rails new. Nếu đã thiết lập xong một app, bạn có thể áp dụng templates sau đó bằng cách thực thi:
rails app:template LOCATION=mytemplate.rb
Templates có thể cực kỳ hữu ích. Ai mà không muốn tự động hóa việc thêm cùng vài gem và thực hiện cùng những thay đổi cấu hình mỗi lần tạo app mới? Tự tạo application template của mình rất thú vị — ngay cả khi nó không tiết kiệm nhiều thời gian trong dài hạn.
Tạo Template Riêng Của Bạn Trong Rails
Chúng ta đã biết về generators và cách dùng templates. Hãy tạo một application template đơn giản để tự động hóa một số bước thiết lập.
Cách bạn thiết lập Rails app rất tùy thuộc vào sở thích cá nhân, nhưng đây là một ví dụ:
- Cài đặt gem dotenv.
- Tạo file
.env.developmentcho môi trường development. - Điều chỉnh file cấu hình database để dùng biến môi trường.
- Tùy chọn: cài đặt và cấu hình RSpec.
Hãy tạo một file local — mytemplate.rb — và thêm dotenv bằng lệnh gem.
gem 'dotenv-rails', groups: [:development, :test]
Vừa thêm gem dotenv, hãy tạo luôn file .env.development chứa cấu hình database.
Bạn có thể tạo file mới với nội dung cụ thể bằng create_file. Bạn sẽ không tìm thấy phương thức này trong tài liệu template hay generator, vì nó do Thor cung cấp. Bạn cũng có thể gặp alias file. Application templates được đánh giá trong ngữ cảnh của Rails::Generators::AppGenerator, và chính tại đó alias file được định nghĩa.
create_file '.env.development', "DATABASE_NAME=#{app_name}_development\nDATABASE_USER=postgres\nDATABASE_PASSWORD=postgres"
Biến app_name chứa tham số đầu tiên của rails new. Sử dụng biến này, chúng ta đảm bảo file config khớp với ứng dụng được tạo ra.
Tiếp theo, hãy dùng biến môi trường để kết nối database. Chúng ta có thể ghi đè toàn bộ config/database.yml bằng create_file, nhưng hãy sửa đổi nó thay vào đó bằng inject_into_file.
inject_into_file 'config/database.yml', after: "default: &default\n" do
<<-YAML
database: <%= ENV['DATABASE_NAME'] %>
username: <%= ENV['DATABASE_USER'] %>
password: <%= ENV['DATABASE_PASSWORD'] %>
YAML
end
Chúng ta có thể dùng cả chuỗi hay regex với tham số after để chỉ định vị trí chèn nội dung.
Tất nhiên, loại cấu hình này chỉ có ý nghĩa nếu người dùng không tạo ứng dụng với SQLite. Bạn có thể kiểm tra sự hiện diện của các arguments nhất định bằng biến options. Tốt nhất bạn nên đọc source code của Rails app generator để xem các options có sẵn.
if options[:database] != 'sqlite3'
# cấu hình database ở trên
end
Cuối cùng, hãy cho phép người dùng cài đặt RSpec nếu họ muốn. Có nhiều phương pháp để nhận input từ người dùng và tạo templates tương tác. Phương thức yes? hỏi xác nhận từ người dùng:
if yes?('Cài đặt RSpec? (y/n)')
gem 'rspec-rails', group: [:development, :test]
after_bundle do
generate 'rspec:install'
end
end
Chúng ta đã biết phương thức gem, nhưng generate và after_bundle là mới.
Như đã đề cập, RSpec thêm generators riêng, và bạn có thể gọi các generators này (hoặc bất kỳ generator nào khác) trực tiếp từ template. Nhưng có một vấn đề — các gem được chỉ định bằng phương thức gem chỉ được cài đặt ở cuối template. Việc gọi generate với generator do gem cung cấp sẽ thất bại — đó là lý do bạn nên đăng ký lệnh như một callback với after_bundle.
Lưu ý: Trước khi kết thúc, một lưu ý nhanh về tạo hoặc sửa file. Chúng ta đã dùng create_file và inject_into_file, nhưng còn nhiều tùy chọn khác. Bạn có thể gặp copy_file hoặc template khi đọc các templates khác. Tôi không nhắc đến chúng ở đây để giữ cho mọi thứ đơn giản. Nếu bạn muốn tạo templates nâng cao hơn, bạn nên biết rằng các phương thức khác để xử lý file cũng tồn tại.
Kết Quả: Template Hoàn Chỉnh Trong Rails
Template cuối cùng sẽ trông như sau:
# mytemplate.rb
gem 'dotenv-rails', groups: [:development, :test]
create_file '.env.development', "DATABASE_NAME=#{app_name}_development\nDATABASE_USER=postgres\nDATABASE_PASSWORD=postgres"
if options[:database] != 'sqlite3'
inject_into_file 'config/database.yml', after: "default: &default\n" do
<<-YAML
database: <%= ENV['DATABASE_NAME'] %>
username: <%= ENV['DATABASE_USER'] %>
password: <%= ENV['DATABASE_PASSWORD'] %>
YAML
end
end
if yes?('Cài đặt RSpec? (y/n)')
gem 'rspec-rails', group: [:development, :test]
after_bundle do
generate 'rspec:install'
end
end
Bạn có thể test template này bằng cách chạy:
rails new myapp -m mytemplate.rb
Hoặc:
rails new myapp -d postgresql -m mytemplate.rb
Để tận dụng cấu hình database tùy chỉnh.
Như đã đề cập, file này hoàn hảo để chia sẻ dưới dạng GitHub gist. Hãy điều chỉnh cho phù hợp nhu cầu, upload lên, và chia sẻ với đồng nghiệp, bạn bè, và bất kỳ ai quan tâm đến custom app template của bạn 😉.
Tìm Hiểu Thêm Về Rails Generators Và Templates
Không cần nói, chúng ta mới chỉ cào được bề mặt thôi.
Mỗi người có sở thích khác nhau khi viết và phát triển Rails apps, nên có rất nhiều generators và application templates ngoài kia. Bạn có thể học rất nhiều về các tùy chỉnh cụ thể bằng cách đọc về chúng. Tôi khuyến nghị Jumpstart của Chris Oliver và RailsBytes — bộ sưu tập templates do cộng đồng curate.
Cũng có Suspenders của Thoughtbot, chính nó đã truyền cảm hứng cho tôi đào sâu hơn vào Rails generators và templates. Tôi thậm chí đã viết application template riêng — Schienenzeppelin — dù chưa cập nhật, vẫn có thể cung cấp cảm hứng.
Tóm Lại: Bắt Đầu Với Ruby on Rails Generators Và Templates
Trong bài viết này, chúng ta đã tìm hiểu cơ bản về Rails generators và cách sử dụng chúng. Chúng ta đã tạo generators riêng để đơn giản hóa việc viết model specs mới.
Sau đó chúng ta đi sâu vào templates và học cách tạo template đơn giản để tùy chỉnh thiết lập ứng dụng. Công việc này có thể hơi tốn sức, nhưng cũng rất đáng giá. Nếu viết templates riêng không phù hợp với bạn, có rất nhiều templates có sẵn trực tuyến để lựa chọn!
Happy templating!
P.S. Nếu bạn muốn đọc các bài Ruby Magic ngay khi xuất bản, hãy đăng ký newsletter Ruby Magic để không bỏ lỡ bất kỳ bài viết nào!
Hans-Jörg Schnedlitz
Tác giả khách Hans là một Rails engineer đến từ Vienna, Áo. Anh dành phần lớn thời gian coding hoặc đọc về coding, và đôi khi viết về nó trên blog cá nhân! Khi không ngồi trước màn hình, bạn có thể tìm thấy anh ngoài trời, leo núi.
Tất cả bài viết của Hans-Jörg Schnedlitz