1. RailRoady là gì?

• Trong bài viết này, tôi sẽ chia sẽ cho mọi người những gì mà mình đã tìm hiểu về RailRoady.
• Có thể nói đây là một gem khá đơn giản và dễ dùng, các bạn sẽ không mất quá nhiều thời gian cho việc học cách dùng nó.
• Chức năng chính của RailRoady là giúp người lập trình viên có thể show quan hệ của các đối tượng tạo ra trong controller và model theo một cách có cấu trúc, thể hiện theo các bảng và mũi tên thể hiện quan hệ.
• Ví dụ các trường hợp có thể cần sử dụng:
  • Muốn có biểu đồ thể hiện cấu trúc của ứng dụng trong việc trình bày, thuyết trình, giải thích cho người khác hiểu
  • Khi mới tham gia vào một dự án mới, nhưng chưa hiểu rõ cấu trúc và tài liệu thì chưa đầy đủ, chúng ta sẽ sử dụng để vẽ ra chính xác cấu trúc ứng dụng sau đó tìm hiểu sẽ dễ dàng hơn.

2. Nguồn tham khảo:

• Trên github: https://github.com/preston/railroady
• Trên trang chủ: http://railroady.prestonlee.com/
• My viblo

3. Cài đặt và sử dụng

• Cài đặt:
  • Để railroady có thể hoạt động trên máy của chúng ta, trước tiên cần cài đặt dot và neato trên máy tính. Rất đơn giản với ubuntu các bạn có thể chạy bằng lệnh: sudo apt-get install graphviz Với mac : brew install graphviz
  • Sau khi cài đặt xong, trong rails app cần bổ sung thêm gem 'railroady' trong Gemfile. group :development, :test do gem 'railroady' end
  • Nhớ chạy bundle install
  • Bây giờ chúng ta có thể sử dụng RailRoady command
  • RailRoady command
    • Một cách dễ dàng:
      • Hãy cd tới project của chúng ta, sau đó chạy: rake diagram:all , chương trình sẽ tự động gen ra một folder mới trong project là doc/*.svg , có 2 file chính là về controllers và models
      • Chúng ta có thể chạy các file này bằng lệnh xdg-open doc/.svg . Ví dụ xdg-open doc/models_brief.svg
    • Chi tiết hơn một chút:
      • railroady -C | neato -Tpng > controllers.png sẽ sinh một file có ảnh png có tên controllers.png ở root folder.
      • railroady -M | neato -Tpng > models.png sẽ sinh một file ảnh png có tên models.png ở root folder.
      • Mọi người có thể thấy -C và -M là 2 option cho việc sinh model hoặc controller, controllers.png là tên do chúng ta quy định, tùy mọi người.
      • Ngoài ra còn nhiều option khác, mình cũng chưa tìm hiểu hết. Thật thiếu sót mong mọi người thông cảm
      • Để chi tiết thì các bạn có thể tìm trong railroady -h

Tổng kết

Mình xin chia sẽ, mình học railroady này trong chưa đầy một giờ để có thể cài đặt và sử dụng. Tuy nhiên mình thấy nó khá hay, và biết đâu nó sẽ hữu dụng với các bạn trong một trường hợp nào đó vì vậy mình viết bài viblo này. Bài này là do mình viết bằng ý hiểu cá nhân cũng không theo một tutorial nào cả, và mình nghĩ nếu các bài trong viblo cũng được viết theo cách này thì sẽ ý nghĩa hơn cho cả người viết và người đọc. Mình đọc viblo, một số bài là sự cố gắng truyển từ tiếng anh sang tiếng việt của một tutorial trên mạng, nói thật mọi người đều có khả năng đọc hiểu tiếng Anh. Tất nhiên đó chỉ là quan điểm cá nhân của mình, không có ý phán xét hay gì cả. Đây là lần đầu mình viết viblo, cũng không có gì nhiều để chia sẽ, vậy mong mọi người có thể thấy khía cạnh khác của bài viết này.