Làm thế nào để bạn khám phá các thuộc tính mô hình trong Rails

Question

Tôi đã bắt đầu ứng dụng Rails đầu tiên vào mùa thu năm ngoái và phải đặt trên kệ trong một vài tháng khi công việc trả hết tất cả thời gian của tôi. Bây giờ tôi quan tâm đến việc quay trở lại dự án và đọc qua mã để tìm ra nơi tôi rời đi. Thực tế là Rails tự động tạo các thuộc tính mô hình trong thời gian chạy tiết kiệm rất nhiều kiểu gõ lặp đi lặp lại, nhưng tôi thấy khó khăn để dễ dàng khám phá những thuộc tính/thuộc tính nào tồn tại trên tất cả các lớp mô hình của tôi. các tập tin. Để khám phá các thuộc tính mô hình, tôi giữ tệp schema.rb mở và lật giữa nó và bất kỳ mã nào tôi đang viết sử dụng các thuộc tính của mô hình. Điều này làm việc nhưng rất khó khăn vì tôi phải đọc tệp lược đồ để nhận các thuộc tính, tệp lớp mô hình để nhận các phương thức và bất kỳ mã mới nào mà tôi viết để gọi các thuộc tính &.

Vì vậy, câu hỏi của tôi là, làm cách nào để bạn khám phá các thuộc tính mô hình khi bạn phân tích một codebase Rails lần đầu tiên? Bạn có giữ cho tệp schema.rb luôn mở hoặc có cách nào tốt hơn không liên quan đến việc nhảy giữa tệp lược đồ & tệp mô hình liên tục không?

Answer 1

Đối Schema liên quan thứ

Model.column_names   
Model.columns_hash   
Model.columns 

Đối với các biến dụ/thuộc tính trong một đối tượng AR

object.attribute_names      
object.attribute_present?   
object.attributes 

Đối với phương pháp dụ mà không thừa kế từ siêu lớp

Model.instance_methods(false) 

Answer 2

some_instance.attributes 

Nguồn: blog

Answer 3

Có một đường ray cắm gọi là mô hình Chú thích, mà sẽ tạo ra mô hình của bạn thuộc tính trên đỉnh của các tập mô hình của bạn đây là liên kết:

https://github.com/ctran/annotate_models

để giữ chú thích đồng bộ, bạn có thể viết một nhiệm vụ để tạo lại các mô hình chú thích sau mỗi lần triển khai.

Answer 4

Nếu bạn chỉ quan tâm đến các thuộc tính và kiểu dữ liệu từ cơ sở dữ liệu, bạn có thể sử dụng Model.inspect.

irb(main):001:0> User.inspect 
=> "User(id: integer, email: string, encrypted_password: string, 
reset_password_token: string, reset_password_sent_at: datetime, 
remember_created_at: datetime, sign_in_count: integer, 
current_sign_in_at: datetime, last_sign_in_at: datetime, 
current_sign_in_ip: string, last_sign_in_ip: string, created_at: datetime, 
updated_at: datetime)" 

Ngoài ra, sau khi chạy rake db:create và rake db:migrate cho môi trường phát triển của bạn, các tập tin db/schema.rb sẽ chứa các nguồn có thẩm quyền đối với cấu trúc cơ sở dữ liệu của bạn:

ActiveRecord::Schema.define(version: 20130712162401) do 
    create_table "users", force: true do |t| 
    t.string "email",     default: "", null: false 
    t.string "encrypted_password",  default: "", null: false 
    t.string "reset_password_token" 
    t.datetime "reset_password_sent_at" 
    t.datetime "remember_created_at" 
    t.integer "sign_in_count",   default: 0 
    t.datetime "current_sign_in_at" 
    t.datetime "last_sign_in_at" 
    t.string "current_sign_in_ip" 
    t.string "last_sign_in_ip" 
    t.datetime "created_at" 
    t.datetime "updated_at" 
    end 
end 

Answer 5

Để mô tả mô hình tôi sử dụng sau đoạn

Model.columns.collect { |c| "#{c.name} (#{c.type})" } 

Một lần nữa đây là nếu bạn đang tìm kiếm bản in đẹp để mô tả bạn ActiveRecord mà không có bạn đi di chuyển máng hoặc nhảy mà phát triển trước khi bạn đã đủ tốt đẹp để bình luận trong các thuộc tính.