rockotseng/blog

Ruby Made Blog

Ruby Made Blog

A simple blog application from my first week with Ruby on Rails.

1. Demo

Note	Facebook login only works on Heroku due to SSL certificate.

1.1. Heroku

https://pure-eyrie-27035.herokuapp.com/

1.2. Docker

1.2.1. Testing

docker-compose -f docker-compose-test.yml run --rm test

1.2.2. Run

docker-compose up web

1.2.3. Database Init & Migration

docker-compose run --rm web bin/rails db:create db:migrate

1.2.4. Check

http://localhost:3000

1.2.5. Stop

docker-compose down

1.3. Google Cloud Platform

Kubernetes Engine + Cloud SQL

http://35.234.10.11/

or

http://blog.rockot.me/

2. Requirements

• 以 Ruby on Rails 開發簡單部落格, 詳細規格如下:

• 此部落格含 Author (作者)、Post (文章)、Comment (評論留言) 三基本元素

• 網站使用者可以分頁瀏覽文章列表

• 網站使用者可以檢視個別文章內容與其所屬評論

• 網站使用者可在檢視個別文章內容時留下評論留言

• 網站使用者可以註冊與登入成為 Author (可以 Devise 套件完成)

• Author 可以建立、編輯與刪除個別文章

• 前述功能完成後，最後調整 Auther 的登入授權改以 Facebook OAuth 完成

• 以上開發的專案程式請置於 Github，以讓我們了解你的開發過程。

• 以上開發的網站，請將結果部署至 Heroku，以讓我們看到你的開發成果。

• (加分項目) 將以上開發的網站，以 Docker 打包，部署至 GCP (Google cloud platform)， 讓系統運行在 Container Engine 或 Compute Engine 之上。

3. Technical Decisions

3.1. Versions

Ruby: 2.5.1 Rails: 5.2

3.2. Database

PostgreSQL 9

3.3. Testing Framework

Minitest

3.4. Authentication

Devise + Omniauth

3.5. Pagination

Plugin used: kaminari

Default page size: 5

3.6. Post

Maximum length of title: 50
Maximum length of text: 280

3.7. Comment

Maximum length of commenter: 70
Maximum length of body: 140

4. TODOs

• ✓ Domain: Post (New Post, Show Post, List Posts, Update Post, Delete Post) (http://guides.rubyonrails.org/getting_started.html)

• ✓ Domain: Comment (http://guides.rubyonrails.org/getting_started.html)

• ✓ Domain: Author (https://github.com/plataformatec/devise#getting-started)

• ✓ Registration (https://github.com/plataformatec/devise#getting-started)

• ✓ Authentication (https://github.com/plataformatec/devise#getting-started)

• ✓ Resource ownership checking

• ✓ Unit test & Integration test (http://guides.rubyonrails.org/testing.html) (http://guides.rubyonrails.org/active_record_validations.html) (http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html)

• ✓ Facebook login (https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview) (https://github.com/omniauth/omniauth/wiki/Integration-Testing) (https://medium.com/cedarcode/rails-5-2-credentials-9b3324851336)

• ✓ Post Pagination (https://github.com/kaminari/kaminari) (https://github.com/mislav/will_paginate)

• ✓ Postgres

• ✓ Heroku (https://devcenter.heroku.com/articles/getting-started-with-rails5)

• ✓ Dockerize

• ✓ Google Cloud Platform (https://cloud.google.com/kubernetes-engine/docs/tutorials/hello-app) (https://cloud.google.com/ruby/tutorials/bookshelf-on-kubernetes-engine) (https://cloud.google.com/sql/docs/postgres/connect-kubernetes-engine)

• ✓ Style

5. References

5.1. Ruby

• https://ruby.github.io/TryRuby/

• https://www.ruby-lang.org/en/documentation/quickstart/

• https://www.ruby-lang.org/en/documentation/ruby-from-other-languages/

• https://en.wikipedia.org/wiki/Ruby_(programming_language)

• https://rvm.io/

5.2. Rails

• http://guides.rubyonrails.org/working_with_javascript_in_rails.html

• http://guides.rubyonrails.org/routing.html

• http://guides.rubyonrails.org/layouts_and_rendering.html

• http://guides.rubyonrails.org/association_basics.html

• http://guides.rubyonrails.org/security.html

6. Memo

• The most productive professional web framework

• Practicing DDD and maybe TDD

• Super full stack ORM

• Built-in DB migration

• Bi-directional association in ORM (https://en.wikibooks.org/wiki/Java_Persistence/Relationships)

• Many to many association (https://en.wikibooks.org/wiki/Java_Persistence/Relationships)

• Error message stored in the model