Ruby - Công ước đặt tên - chữ cái viết tắt của các từ viết tắt trong tên lớp/mô-đun?

Question

Tôi cần phải tạo một lớp đại diện cho "SVN" bên trong một mô-đun được gọi là "SCM". Nhưng tôi không biết quy ước khi giao dịch với từ viết tắt trong Ruby là gì và không thể tìm thấy bất kỳ thứ gì có liên quan trong Google, ngoại trừ "trường hợp Camel được ưu tiên".

Tôi có nên gọi nó là SCM::SVN hoặc Scm::Svn? Có một quy ước cho điều này?

Answer 1

SCM::SVN trông tốt nhất đối với tôi. Đường ray có đầy đủ các lớp như ERB, ORM và OMFGIMATEAPOT. Và đó không phải đề cập đến những thứ như JSONSerializer. Nguồn của Ruby cũng có a bunch of acronyms. Ví dụ rõ ràng nhất đối với tôi là YAML. Các tiêu chuẩn như tôi đã nhìn thấy nó là để upcase chữ cho CamelCase nhưng thường không để downcase chúng (mặc dù Rails có ý kiến ​​về tên mô hình).

Nếu bạn có grep và mã nguồn bạn có thể thấy rất nhiều ví dụ với một cái gì đó giống như

grep -r 'class [A-Z]\{3,\}' <path/to/source> 
# or, if you only want acronyms and nothing like YAMLColumn: 
grep -rw 'class [A-Z]\{3,\}' <path/to/source> 

Answer 2

Tôi nghĩ rằng SCM::SVN trông đẹp hơn (về mặt thẩm mỹ) và tôi đã thấy các thư viện sử dụng cùng một quy ước. Nó thực sự chỉ là một vấn đề của những gì bạn nghĩ đọc tốt hơn.

(Tuy nhiên, lưu ý rằng nếu bạn đang xây dựng một dự án Rails, và muốn mô-đun này để được tự động nạp từ thư mục/lib, bạn có thể phải sử dụng Scm::Svn.)

Answer 3

Thêm dòng sau vào config/initializers/inflections.rb.

ActiveSupport::Inflector.inflections(:en) do |inflect| 
    inflect.acronym 'SVN' 
end 

Bây giờ chạy $ rails g model SVN… sẽ tạo ra một lớp có tên SVN trong một file có tên svn.rb và một bảng liên svns.