การสร้างและปรับแต่งเจเนอเรเตอร์และเทมเพลตใน Rails

1 ครั้งแรกที่พบ

เมื่อคุณสร้างแอปพลิเคชันโดยใช้คำสั่ง rails คุณก็กำลังใช้เจเนอเรเตอร์ของ Rails แล้ว หลังจากนั้นคุณสามารถรับรายการของเจเนอเรเตอร์ทั้งหมดที่มีได้โดยเรียกใช้ bin/rails generate:

$ rails new myapp
$ cd myapp
$ bin/rails generate

หมายเหตุ: เพื่อสร้างแอปพลิเคชัน Rails เราใช้คำสั่ง rails ที่เป็นคำสั่งทั่วไปซึ่งใช้เวอร์ชันของ Rails ที่ติดตั้งผ่าน gem install rails ในขณะที่อยู่ในไดเรกทอรีของแอปพลิเคชันของคุณ เราใช้คำสั่ง bin/rails ซึ่งใช้เวอร์ชันของ Rails ที่ถูกแพ็กเก็ตไว้กับแอปพลิเคชัน

คุณจะได้รายการของเจเนอเรเตอร์ทั้งหมดที่มากับ Rails ในรูปแบบรายละเอียด หากต้องการดูรายละเอียดของเจเนอเรเตอร์ใดๆ ให้เรียกใช้เจเนอเรเตอร์ด้วยตัวเลือก --help ตัวอย่างเช่น:

$ bin/rails generate scaffold --help

2 การสร้างเจเนอเรเตอร์แรกของคุณ

เจเนอเรเตอร์ถูกสร้างบน Thor ซึ่งให้ตัวเลือกที่มีประสิทธิภาพในการแยกวิเคราะห์และ API ที่ยอดเยี่ยมในการจัดการไฟล์

มาสร้างเจเนอเรเตอร์ที่สร้างไฟล์เริ่มต้นชื่อ initializer.rb ภายใน config/initializers กันก่อน ขั้นแรกคือการสร้างไฟล์ที่ lib/generators/initializer_generator.rb ด้วยเนื้อหาดังต่อไปนี้:

class InitializerGenerator < Rails::Generators::Base
  def create_initializer_file
    create_file "config/initializers/initializer.rb", <<~RUBY
      # Add initialization content here
    RUBY
  end
end

เจเนอเรเตอร์ใหม่ของเราค่อนข้างเรียบง่าย: มันสืบทอดจาก Rails::Generators::Base และมีการกำหนดเมธอดหนึ่ง เมื่อเรียกใช้เจเนอเรเตอร์ แต่ละเมธอดสาธารณะในเจเนอเรเตอร์จะถูกเรียกใช้ตามลำดับที่กำหนด ในกรณีของเรา เมธอดของเราเรียกใช้ create_file ซึ่งจะสร้างไฟล์ในตำแหน่งปลายทางที่กำหนดพร้อมเนื้อหาที่กำหนด

เพื่อเรียกใช้เจเนอเรเตอร์ใหม่ของเรา เราใช้คำสั่ง:

$ bin/rails generate initializer

ก่อนที่เราจะไปต่อ ลองดูคำอธิบายของเจเนอเรเตอร์ใหม่ของเรากันก่อน:

$ bin/rails generate initializer --help

Rails สามารถสร้างคำอธิบายที่ดีได้โดยอัตโนมัติหากเจเนอเรเตอร์มีการเป็นชื่อเนมสเปซ เช่น ActiveRecord::Generators::ModelGenerator แต่ไม่ในกรณีนี้ เราสามารถแก้ไขปัญหานี้ได้ด้วยวิธีสองวิธี วิธีแรกคือการเรียกใช้ desc ภายในเจเนอเรเตอร์ของเรา:

class InitializerGenerator < Rails::Generators::Base
  desc "This generator creates an initializer file at config/initializers"
  def create_initializer_file
    create_file "config/initializers/initializer.rb", <<~RUBY
      # Add initialization content here
    RUBY
  end
end

ตอนนี้เราสามารถดูคำอธิบายใหม่ได้โดยเรียกใช้ --help บนเจเนอเรเตอร์ใหม่

วิธีที่สองในการเพิ่มคำอธิบายคือการสร้างไฟล์ชื่อ USAGE ในไดเรกทอรีเดียวกับเจเนอเรเตอร์ของเรา เราจะทำในขั้นตอนถัดไป

3 สร้าง Generators ด้วย Generators

Generators เป็นตัวเองมี Generators อีกด้วย ลองลบ InitializerGenerator ของเราออกและใช้ bin/rails generate generator เพื่อสร้างใหม่:

$ rm lib/generators/initializer_generator.rb

$ bin/rails generate generator initializer
      create  lib/generators/initializer
      create  lib/generators/initializer/initializer_generator.rb
      create  lib/generators/initializer/USAGE
      create  lib/generators/initializer/templates
      invoke  test_unit
      create    test/lib/generators/initializer_generator_test.rb

นี่คือ Generator ที่สร้างใหม่:

class InitializerGenerator < Rails::Generators::NamedBase
  source_root File.expand_path("templates", __dir__)
end

เริ่มแรก สังเกตว่า Generator สืบทอดมาจาก Rails::Generators::NamedBase แทนที่จะเป็น Rails::Generators::Base นั่นหมายความว่า Generator ของเราคาดหวังอาร์กิวเมนต์อย่างน้อยหนึ่งตัว ซึ่งจะเป็นชื่อของ initializer และจะสามารถเข้าถึงได้ผ่าน name

เราสามารถเห็นได้จากคำอธิบายของ Generator ใหม่:

$ bin/rails generate initializer --help
Usage:
  bin/rails generate initializer NAME [options]

นอกจากนี้ Generator ยังมีเมธอดคลาสที่เรียกว่า source_root ซึ่งชี้ไปยังตำแหน่งของเทมเพลต ถ้ามีอยู่ โดยค่าเริ่มต้นจะชี้ไปที่ไดเรกทอรี lib/generators/initializer/templates ที่เพิ่งถูกสร้างขึ้น

เพื่อเข้าใจว่าเทมเพลตของ Generator ทำงานอย่างไร เราลองสร้างไฟล์ lib/generators/initializer/templates/initializer.rb ด้วยเนื้อหาต่อไปนี้:

# Add initialization content here

และเปลี่ยน Generator เพื่อคัดลอกเทมเพลตนี้เมื่อเรียกใช้:

class InitializerGenerator < Rails::Generators::NamedBase
  source_root File.expand_path("templates", __dir__)

  def copy_initializer_file
    copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
  end
end

ตอนนี้ลองรัน Generator ของเรา:

$ bin/rails generate initializer core_extensions
      create  config/initializers/core_extensions.rb

$ cat config/initializers/core_extensions.rb
# Add initialization content here

เราเห็นว่า copy_file สร้าง config/initializers/core_extensions.rb ด้วยเนื้อหาจากเทมเพลตของเรา (เมธอด file_name ที่ใช้ในเส้นทางปลายทางถูกสืบทอดมาจาก Rails::Generators::NamedBase)

4 ตัวเลือกบรรทัดคำสั่งของ Generator

Generator สามารถรองรับตัวเลือกบรรทัดคำสั่งได้โดยใช้ class_option เช่น:

class InitializerGenerator < Rails::Generators::NamedBase
  class_option :scope, type: :string, default: "app"
end

ตอนนี้ Generator ของเราสามารถเรียกใช้งานพร้อมกับตัวเลือก --scope ได้:

$ bin/rails generate initializer theme --scope dashboard

ค่าตัวเลือกสามารถเข้าถึงได้ในเมธอดของ Generator ผ่าน options:

def copy_initializer_file
  @scope = options["scope"]
end

5 การตัดสินใจ Generator

เมื่อต้องการตัดสินใจชื่อ Generator Rails จะค้นหา Generator โดยใช้ชื่อไฟล์หลายชื่อ ตัวอย่างเช่น เมื่อคุณรัน bin/rails generate initializer core_extensions Rails จะพยายามโหลดไฟล์ต่อไปนี้ทีละไฟล์ ตามลำดับ จนกว่าจะพบไฟล์หนึ่ง:

rails/generators/initializer/initializer_generator.rb
generators/initializer/initializer_generator.rb
rails/generators/initializer_generator.rb
generators/initializer_generator.rb

หากไม่พบไฟล์เหล่านี้ จะเกิดข้อผิดพลาด

เราวาง Generator ของเราในไดเรกทอรี lib/ ของแอปพลิเคชันเพราะไดเรกทอรีนี้อยู่ใน $LOAD_PATH ซึ่งทำให้ Rails สามารถค้นหาและโหลดไฟล์ได้

6 การแทนที่เทมเพลต Generator ของ Rails

Rails ยังค้นหาในสถานที่หลายแห่งเมื่อต้องการแทนที่ไฟล์เทมเพลตของ Generator หนึ่งในสถานที่นั้นคือไดเรกทอรี lib/templates/ ของแอปพลิเคชัน นี้ทำให้เราสามารถแทนที่เทมเพลตที่ใช้โดย Generator ที่มีอยู่ใน Rails ได้ เช่น เราสามารถแทนที่ scaffold controller template หรือ scaffold view templates

เพื่อดูตัวอย่างนี้ให้เราสร้างไฟล์ lib/templates/erb/scaffold/index.html.erb.tt ด้วยเนื้อหาต่อไปนี้:

<%% @<%= plural_table_name %>.count %> <%= human_name.pluralize %>

โปรดทราบว่าเทมเพลตเป็นเทมเพลต ERB ที่เรนเดอร์ อีก เทมเพลต ERB ดังนั้น ตัวอักษร <% ที่ควรปรากฏในเทมเพลต ผลลัพธ์ จะต้องถูกหนีเป็น <%% ในเทมเพลตของ generator ตอนนี้เรามาเรียกใช้ตัวสร้าง scaffold ที่มีอยู่ใน Rails:

$ bin/rails generate scaffold Post title:string
      ...
      create      app/views/posts/index.html.erb
      ...

เนื้อหาของ app/views/posts/index.html.erb คือ:

<% @posts.count %> โพสต์

7 การแทนที่ Generators ของ Rails

เราสามารถกำหนดค่า Generators ที่มีอยู่ใน Rails ได้ผ่าน config.generators, รวมถึงการแทนที่ Generators บางส่วนอย่างสมบูรณ์

ก่อนอื่นเรามาดูรายละเอียดของตัวสร้าง scaffold กันก่อน

$ bin/rails generate scaffold User name:string
      invoke  active_record
      create    db/migrate/20230518000000_create_users.rb
      create    app/models/user.rb
      invoke    test_unit
      create      test/models/user_test.rb
      create      test/fixtures/users.yml
      invoke  resource_route
       route    resources :users
      invoke  scaffold_controller
      create    app/controllers/users_controller.rb
      invoke    erb
      create      app/views/users
      create      app/views/users/index.html.erb
      create      app/views/users/edit.html.erb
      create      app/views/users/show.html.erb
      create      app/views/users/new.html.erb
      create      app/views/users/_form.html.erb
      create      app/views/users/_user.html.erb
      invoke    resource_route
      invoke    test_unit
      create      test/controllers/users_controller_test.rb
      create      test/system/users_test.rb
      invoke    helper
      create      app/helpers/users_helper.rb
      invoke      test_unit
      invoke    jbuilder
      create      app/views/users/index.json.jbuilder
      create      app/views/users/show.json.jbuilder

จากผลลัพธ์ เราสามารถเห็นได้ว่าตัวสร้าง scaffold เรียกใช้ตัวสร้างอื่น ๆ เช่นตัวสร้าง scaffold_controller และบางตัวสร้างก็เรียกใช้ตัวสร้างอื่น ๆ อีกด้วย โดยเฉพาะตัวสร้าง scaffold_controller ที่เรียกใช้ตัวสร้างอื่น ๆ หลายตัว เช่นตัวสร้าง helper

มาเราจะแทนที่ตัวสร้าง helper ที่มีอยู่ด้วยตัวสร้างใหม่ที่ชื่อว่า my_helper กัน:

$ bin/rails generate generator rails/my_helper
      create  lib/generators/rails/my_helper
      create  lib/generators/rails/my_helper/my_helper_generator.rb
      create  lib/generators/rails/my_helper/USAGE
      create  lib/generators/rails/my_helper/templates
      invoke  test_unit
      create    test/lib/generators/rails/my_helper_generator_test.rb

และใน lib/generators/rails/my_helper/my_helper_generator.rb เราจะกำหนดตัวสร้างเป็นดังนี้:

class Rails::MyHelperGenerator < Rails::Generators::NamedBase
  def create_helper_file
    create_file "app/helpers/#{file_name}_helper.rb", <<~RUBY
      module #{class_name}Helper
        # ฉันกำลังช่วยเหลือ!
      end
    RUBY
  end
end

สุดท้าย เราต้องบอกให้ Rails ใช้ตัวสร้าง my_helper แทนตัวสร้าง helper ที่มีอยู่ โดยใช้ config.generators ใน config/application.rb เราเพิ่ม:

config.generators do |g|
  g.helper :my_helper
end

ตอนนี้ถ้าเราเรียกใช้ตัวสร้าง scaffold อีกครั้ง เราจะเห็นตัวสร้าง my_helper ทำงาน:

$ bin/rails generate scaffold Article body:text
      ...
      invoke  scaffold_controller
      ...
      invoke    my_helper
      create      app/helpers/articles_helper.rb
      ...

หมายเหตุ: เราอาจสังเกตได้ว่าผลลัพธ์สำหรับตัวสร้าง helper ที่มีอยู่รวมถึง "invoke test_unit" ในขณะที่ผลลัพธ์สำหรับ my_helper ไม่ได้รวมอยู่ แม้ว่าตัวสร้าง helper จะไม่สร้างเทสโดยค่าเริ่มต้น แต่มันก็ยังมีการเรียกใช้ hook_for เพื่อทำเช่นเดียวกัน โดยการรวม hook_for :test_framework, as: :helper ในคลาส MyHelperGenerator ดูเอกสาร hook_for เพื่อข้อมูลเพิ่มเติม

7.1 Generators Fallbacks

วิธีการแทนที่ตัวสร้างเฉพาะอย่างอื่นคือการใช้ fallbacks การใช้ fallback ช่วยให้เนมสเปซตัวสร้างสามารถเลือกใช้ตัวสร้างเนมสเปซอื่นได้

ตัวอย่างเช่น เราต้องการแทนที่ตัวสร้าง test_unit:model ด้วยตัวสร้าง my_test_unit:model ของเราเอง แต่เราไม่ต้องการแทนที่ตัวสร้าง test_unit:* อื่น ๆ เช่น test_unit:controller

ก่อนอื่น เราสร้างตัวสร้าง my_test_unit:model ใน lib/generators/my_test_unit/model/model_generator.rb:

module MyTestUnit
  class ModelGenerator < Rails::Generators::NamedBase
    source_root File.expand_path("templates", __dir__)

    def do_different_stuff
      say "Doing different stuff..."
    end
  end
end

ต่อมา เราใช้ config.generators เพื่อกำหนดค่าตัวสร้าง test_framework เป็น my_test_unit แต่เราก็กำหนด fallback เพื่อให้ตัวสร้าง my_test_unit:* ที่หายไปสามารถแทนที่ด้วย test_unit:* ได้:

config.generators do |g|
  g.test_framework :my_test_unit, fixture: false
  g.fallbacks[:my_test_unit] = :test_unit
end

ตอนนี้เมื่อเราเรียกใช้ตัวสร้าง scaffold เราจะเห็นว่า my_test_unit ได้แทนที่ test_unit แต่มีผลต่อเทสของแค่ตัวจัดการโมเดลเท่านั้น: bash $ bin/rails generate scaffold Comment body:text invoke active_record create db/migrate/20230518000000_create_comments.rb create app/models/comment.rb invoke my_test_unit กำลังทำสิ่งที่แตกต่าง... invoke resource_route route resources :comments invoke scaffold_controller create app/controllers/comments_controller.rb invoke erb create app/views/comments create app/views/comments/index.html.erb create app/views/comments/edit.html.erb create app/views/comments/show.html.erb create app/views/comments/new.html.erb create app/views/comments/_form.html.erb create app/views/comments/_comment.html.erb invoke resource_route invoke my_test_unit create test/controllers/comments_controller_test.rb create test/system/comments_test.rb invoke helper create app/helpers/comments_helper.rb invoke my_test_unit invoke jbuilder create app/views/comments/index.json.jbuilder create app/views/comments/show.json.jbuilder

8 Application Templates

เทมเพลตแอปพลิเคชันเป็นชนิดพิเศษของเจเนอเรเตอร์ พวกเขาสามารถใช้เมธอดช่วยเจริญการสร้างเช่นเดียวกับ เมธอดช่วยเจริญเจเนอเรเตอร์ แต่เขียนเป็นสคริปต์รูบีแทนที่จะเป็นคลาสรูบี ตัวอย่างเช่น:

# template.rb

if yes?("คุณต้องการติดตั้ง Devise หรือไม่?")
  gem "devise"
  devise_model = ask("คุณต้องการตั้งชื่อโมเดลผู้ใช้ว่าอะไร?", default: "User")
end

after_bundle do
  if devise_model
    generate "devise:install"
    generate "devise", devise_model
    rails_command "db:migrate"
  end

  git add: ".", commit: %(-m 'Initial commit')
end

ก่อนอื่น เทมเพลตจะถามผู้ใช้ว่าต้องการติดตั้ง Devise หรือไม่ ถ้าผู้ใช้ตอบ "ใช่" (หรือ "y") เทมเพลตจะเพิ่ม Devise เข้าไปใน Gemfile และถามผู้ใช้ชื่อโมเดลผู้ใช้ของ Devise (เริ่มต้นที่ User) ภายหลังจากนั้น เมื่อทำการรัน bundle install เทมเพลตจะรันเจเนอเรเตอร์ Devise และ rails db:migrate หากมีการระบุโมเดล Devise ในท้ายที่สุด เทมเพลตจะ git add และ git commit ไดเรกทอรีแอปทั้งหมด

เราสามารถรันเทมเพลตของเราเมื่อสร้างแอปพลิเคชัน Rails ใหม่โดยใช้ตัวเลือก -m กับคำสั่ง rails new:

$ rails new my_cool_app -m path/to/template.rb

หรือเราสามารถรันเทมเพลตของเราภายในแอปพลิเคชันที่มีอยู่แล้วด้วย bin/rails app:template:

$ bin/rails app:template LOCATION=path/to/template.rb

เทมเพลตยังไม่จำเป็นต้องเก็บไว้ในเครื่องที่เก็บข้อมูลในเครือข่าย — เราสามารถระบุ URL แทนที่เส้นทาง:

$ rails new my_cool_app -m http://example.com/template.rb
$ bin/rails app:template LOCATION=http://example.com/template.rb

9 เมธอดช่วยเจริญเจเนอเรเตอร์

Thor ให้เมธอดช่วยเจริญหลายอย่างผ่าน Thor::Actions, เช่น:

นอกจากนี้ Rails ยังให้เมธอดช่วยเจริญหลายอย่างผ่าน Rails::Generators::Actions, เช่น:

ข้อเสนอแนะ

คุณสามารถช่วยปรับปรุงคุณภาพของคู่มือนี้ได้

กรุณาช่วยเพิ่มเติมหากพบข้อผิดพลาดหรือข้อผิดพลาดทางความจริง เพื่อเริ่มต้นคุณสามารถอ่านส่วน การสนับสนุนเอกสาร ของเราได้

คุณอาจพบเนื้อหาที่ไม่สมบูรณ์หรือเนื้อหาที่ไม่ได้อัปเดต กรุณาเพิ่มเอกสารที่ขาดหายไปสำหรับเนื้อหาหลัก โปรดตรวจสอบ Edge Guides ก่อนเพื่อตรวจสอบ ว่าปัญหาได้รับการแก้ไขหรือไม่ในสาขาหลัก ตรวจสอบ คู่มือแนวทาง Ruby on Rails เพื่อดูรูปแบบและกฎเกณฑ์

หากคุณพบข้อผิดพลาดแต่ไม่สามารถแก้ไขได้เอง กรุณา เปิดปัญหา.

และสุดท้าย การสนทนาใด ๆ เกี่ยวกับ Ruby on Rails เอกสารยินดีต้อนรับที่สุดใน เว็บบอร์ดอย่างเป็นทางการของ Ruby on Rails.

การสร้างและปรับแต่งเจเนอเรเตอร์และเทมเพลตใน Rails

Chapters

ข้อเสนอแนะ