bankai 0.1.0

data/lib/bankai/generators/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class Base < Rails::Generators::Base
+      def self.default_source_root
+        File.expand_path(File.join('..', '..', '..', 'templates'), __dir__)
+      end
+
+      private
+
+      def app_name
+        Rails.app_class.parent_name.demodulize.underscore.dasherize
+      end
+    end
+  end
+end

data/lib/bankai/generators/ci_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class CiGenerator < Base
+      def configure_ci
+        template 'gitlab-ci.yml.erb', '.gitlab-ci.yml'
+      end
+
+      protected
+
+      def pg?
+        gemfile.match?(/gem .pg./)
+      end
+
+      def mysql?
+        gemfile.match?(/gem .mysql2./)
+      end
+
+      private
+
+      def gemfile
+        @gemfile ||= File.read(destination_root + '/Gemfile')
+      end
+    end
+  end
+end

data/lib/bankai/generators/db_optimizations_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class DbOptimizationsGenerator < Base
+      def configure_bullet
+        inject_into_file(
+          'config/environments/development.rb',
+          configuration,
+          after: 'config.file_watcher = ' \
+                 "ActiveSupport::EventedFileUpdateChecker\n"
+        )
+      end
+
+      private
+
+      def configuration
+        <<-RUBY
+
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+    Bullet.add_footer = true
+  end
+        RUBY
+      end
+    end
+  end
+end

data/lib/bankai/generators/deploy_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class DeployGenerator < Base
+      def install_capistrano
+        Bundler.with_clean_env { run 'bundle exec cap install' }
+      end
+
+      def configure_capfile
+        inject_into_file(
+          'Capfile',
+          capistrano_plugins,
+          after: "# require \"capistrano/passenger\"\n"
+        )
+      end
+
+      def replace_deploy_config
+        template 'deploy.rb.erb', 'config/deploy.rb', force: true
+      end
+
+      protected
+
+      def repo_url
+        res = `git remote get-url origin`
+        return 'git@example.com:me/my_repo.git' if res.blank?
+
+        res
+      end
+
+      private
+
+      def capistrano_plugins
+        <<-RUBY
+  require "capistrano/bundler"
+  require "capistrano/rails/assets"
+  require "capistrano/rails/migrations"
+        RUBY
+      end
+    end
+  end
+end

data/lib/bankai/generators/json_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class JsonGenerator < Base
+      def add_oj
+        gem 'oj'
+        Bundler.with_clean_env { run 'bundle install' }
+      end
+    end
+  end
+end

data/lib/bankai/generators/lint_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class LintGenerator < Base
+      def configure_overcommit
+        template 'overcommit.yml.erb', '.overcommit.yml'
+      end
+
+      def configure_rubocop
+        template 'rubocop.yml.erb', '.rubocop.yml'
+      end
+
+      def install_overcommit
+        Bundler.with_clean_env { run 'bundle exec overcommit --install' }
+      end
+
+      def rubocop_autocorrect
+        Bundler.with_clean_env { run 'bundle exec rubocop --auto-correct' }
+      end
+    end
+  end
+end

data/lib/bankai/generators/mailer_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class MailerGenerator < Base
+      def configure_letter_opener
+        inject_into_file(
+          'config/environments/development.rb',
+          configuration,
+          after: 'config.file_watcher = ' \
+          "ActiveSupport::EventedFileUpdateChecker\n"
+        )
+      end
+
+      private
+
+      def configuration
+        <<-RUBY
+
+  config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.perform_deliveries = true
+        RUBY
+      end
+    end
+  end
+end

data/lib/bankai/generators/testing_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Bankai
+  module Generators
+    # :nodoc:
+    class TestingGenerator < Base
+      def generate_rspec
+        generate 'rspec:install'
+      end
+
+      def configure_rspec
+        remove_file 'spec/rails_helper.rb'
+        remove_file 'spec/spec_helper.rb'
+        copy_file 'rails_helper.rb', 'spec/rails_helper.rb'
+        copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+      end
+
+      def provide_shoulda_matchers_config
+        copy_file(
+          'spec/shoulda_matchers.rb',
+          'spec/support/shoulda_matchers.rb'
+        )
+      end
+
+      def provide_database_rewinder_config
+        copy_file(
+          'spec/database_rewinder.rb',
+          'spec/support/database_rewinder.rb'
+        )
+      end
+    end
+  end
+end

data/lib/bankai/version.rb

@@ -0,0 +1,7 @@
+module Bankai
+  VERSION = '0.1.0'.freeze
+  RUBY_VERSION = '2.5.0'.freeze
+  RAILS_VERSION = '5.2.2'.freeze
+  RUBOCOP_VERSION = '0.60.0'.freeze
+  CAPISTRANO_VERSION = '3.11.0'.freeze
+end

data/lib/bankai.rb

@@ -0,0 +1,10 @@
+require 'bankai/version'
+require 'bankai/generator'
+require 'bankai/generators/testing_generator'
+require 'bankai/generators/ci_generator'
+require 'bankai/generators/json_generator'
+require 'bankai/generators/db_optimizations_generator'
+require 'bankai/generators/mailer_generator'
+require 'bankai/generators/deploy_generator'
+require 'bankai/generators/lint_generator'
+require 'bankai/builder'

data/templates/Gemfile.erb

@@ -0,0 +1,110 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '<%= RUBY_VERSION -%>'
+<% gemfile_entries.each do |gem| -%>
+<% if gem.comment -%>
+
+# <%= gem.comment %>
+<% end -%>
+<%= gem.commented_out ? '# ' : '' %>gem '<%= gem.name %>'<%= %(, '#{gem.version}') if gem.version -%>
+<% if gem.options.any? -%>
+, <%= gem.options.map { |k,v|
+  "#{k}: #{v.inspect}" }.join(', ') %>
+<% end -%>
+<% end -%>
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+<% unless skip_active_storage? -%>
+
+# Use ActiveStorage variant
+# gem 'mini_magick', '~> 4.8'
+<% end -%>
+
+<% if depend_on_bootsnap? -%>
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.1.0', require: false
+
+<%- end -%>
+<%- if options.api? -%>
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+<%- end -%>
+<% if RUBY_ENGINE == 'ruby' -%>
+group :development, :test do
+  # Call 'byebug' anywhere in the code to
+  # stop execution and get a debugger console
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+
+  gem 'brakeman', require: false
+  gem 'bundler-audit', '~> 0.6.0', require: false
+  gem 'rubocop', '~> <%= Bankai::RUBOCOP_VERSION %>', require: false
+
+<%- unless options[:skip_rspec] -%>
+  gem 'database_rewinder'
+  gem 'factory_bot_rails'
+  gem 'faker'
+  gem 'rspec', require: false
+  gem 'rspec-rails', require: false
+  gem 'shoulda', require: false
+  gem 'shoulda-matchers', require: false
+  gem 'simplecov', require: false
+<%- end -%>
+
+  gem 'bankai'
+end
+
+group :development do
+<% if depend_on_listen? -%>
+  gem 'listen', '>= 3.0.5', '< 3.2'
+<% end -%>
+<%- unless options.api? -%>
+  # Access an interactive console on exception pages or
+  # by calling 'console' anywhere in the code.
+  <%- if options.dev? || options.edge? -%>
+  gem 'web-console', github: 'rails/web-console'
+  <%- else -%>
+  gem 'web-console', '>= 3.3.0'
+  <%- end -%>
+<%- end -%>
+<% if spring_install? -%>
+  # Spring speeds up development by keeping your application running in
+  # the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+<% if depend_on_listen? -%>
+  gem 'spring-watcher-listen', '~> 2.0.0'
+<% end -%>
+<% end -%>
+
+<% unless options[:skip_capistrano] -%>
+  gem 'capistrano', '<%= Bankai::CAPISTRANO_VERSION %>'
+  gem 'capistrano-bundler'
+  gem 'capistrano-rails'
+  # gem 'capistrano-sidekiq'
+  # gem 'capistrano-passenger'
+<% end -%>
+
+  gem 'annotate', require: false
+  gem 'bullet'
+  gem 'dotenv-rails'
+  gem 'letter_opener'
+  gem 'overcommit', require: false
+  gem 'pry-rails'
+  gem 'rack-mini-profiler', require: false
+end
+
+<%- if depends_on_system_test? -%>
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 2.15'
+  gem 'selenium-webdriver'
+  # Easy installation and use of chromedriver to run system tests with Chrome
+  gem 'chromedriver-helper'
+end
+<%- end -%>
+<% end -%>
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]

data/templates/README.md.erb

@@ -0,0 +1,233 @@
+<%= app_name.humanize %>
+===
+
+## 系統需求
+
+* Ruby <%= RUBY_VERSION %>
+<%- case options[:database] -%>
+<%- when 'postgresql' then -%>* PostgreSQL 9.6+
+<%- when 'mysql' then -%>* MySQL 5.7+
+<%- end -%>
+* Node.js 8.0 (以上)
+
+## 環境設定
+
+以下的設定皆以 macOS 為主。
+
+### Homebrew
+
+在 macOS 需要有 [Homebrew](https://brew.sh/index_zh-tw) 來輔助安裝環境。
+
+```bash
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+```
+
+執行完畢後可以透過 `brew doctor` 確認是否可用。
+
+### Ruby
+
+為了配合多個版本的環境，建議使用 `rbenv` 或者 `rvm` 來管理 Ruby 環境。
+
+```bash
+# 選用 rbenv
+brew install rbenv
+
+# 選用 rvm
+brew install rvm
+```
+
+完成後請參考終端機顯示的訊息設定 `.bashrc` 或者其他 Shell 設定檔。
+
+```bash
+# 選用 rbenv
+rbenv install <%= RUBY_VERSION %>
+
+# 選用 rvm
+rvm install <%= RUBY_VERSION %>
+```
+
+完成後需要先將 Bundler 安裝到新安裝的 Ruby 環境中（rvm 可能會先預裝完畢）
+
+```bash
+# 先確認是否在正確的 Ruby 版本執行
+ruby -v
+# => ruby 2.5.3p105 (2018-10-18 revision 65156) [x86_64-darwin17]
+
+gem install bundler
+```
+<%- case options[:database] -%>
+<%- when 'postgresql' -%>
+### PostgreSQL
+
+請注意不要直接輸入 `postgresql` 否則會安裝到最新版的 PostgreSQL
+
+```bash
+# 安裝
+brew install postgresql@9.6
+
+# 啟動伺服器
+brew services start postgresql@9.6
+```
+
+<%- when 'mysql' -%>
+### MySQL
+
+請注意不要直接輸入 `mysql` 否則會安裝到最新版的 MySQL
+
+```bash
+# 安裝
+brew install mysql@5.7
+
+# 啟動伺服器
+brew services start mysql@5.7
+```
+
+啟動之前請參考終端機顯示的安裝訊息來初始化 MySQL 資料庫
+
+<%- end -%>
+### Node.js
+
+Rails 需要 JavaScript Runtime 一般會使用 Node.js。
+
+```bash
+brew install node
+```
+
+<%- if options[:webpack] -%>
+Webpacker 使用 Yarn 管理安裝的 JavaScript 套件，我們還需要將 Yarn 安裝進來。
+
+```bash
+brew install yarn
+```
+
+<%- end -%>
+### Rails
+
+請先透過 git 將專案下載到本地端。
+
+```bash
+# 切換到專案目錄
+cd <%= app_name %>
+
+# 安裝 Rails 所需套件
+bundle install
+
+# 設定 git hook
+bundle exec overcommit --install
+```
+
+Overcommit 會做以下檢查：
+
+1. commit 前：使用 rubocop 檢查語法
+2. push 前：使用 brakeman 檢查安全性問題
+
+```bash
+# 設定資料庫
+bundle exec rake db:create
+
+# 更新資料庫到最新版
+bundle exec rake db:migrate
+```
+
+<%- if options[:database] == 'mysql' -%>
+#### 執行 bundle install 時 mysql2 gem 安裝失敗
+
+這可能是因為我們指定了 MySQL 版本，但是作業系統裡面並不知道有 MySQL 的存在，造成自動安裝失敗。
+我們可以透過以下指令手動安裝：
+
+```
+# 0.5.2 是目前的版本，之後有更新情參考錯誤訊息指示的版本
+gem install mysql2 -v 0.5.2 -- --with-mysql-config=/usr/local/opt/mysql@5.7/bin/mysql_config
+```
+
+<%- end -%>
+## 執行專案
+
+### Rails 伺服器
+
+```bash
+# 這是 rails server 的縮寫
+rails s
+```
+
+開啟後預設可以透過 `http://localhost:3000` 看到網站
+
+#### PendingMigration 錯誤
+
+這是因為最新版本的資料庫已經被更改，但是本機的資料庫還沒有被更新。
+
+```bash
+bundle exec rake db:migrate
+```
+
+執行 `db:migrate` 指令更新資料庫即可。
+
+<%- if options[:webpack] -%>
+### Webpack 伺服器
+
+因為專案使用了 Webpacker 所以需要開啟 Webpack 伺服器來轉換 JavaScript
+
+```bash
+./bin/webpack-dev-server
+```
+
+和 Rails 伺服器同時打開後，就可以看到正常的網站畫面
+
+<%- end -%>
+<%- unless options[:skip_rspec] -%>
+### 運行測試
+
+這個專案使用 RSpec 進行測試，可以透過執行以下指令運行
+
+```bash
+bundle exec rspec
+```
+
+<%- end -%>
+### Ruby 語法檢查
+
+這個功能會在 commit 前自動執行，必要時可以手動進行
+
+```bash
+bundle exec rubocop
+```
+
+### Ruby 安全性檢查
+
+這個功能會在 push 前自動執行，必要時可以手動進行
+
+```bash
+bundle exec brakeman
+```
+
+### 建立 .env 檔案
+
+建立 `.env` 檔案，並依據 local 開發環境需求修改設定內容。
+
+```bash
+cp .env.example .env
+```
+
+<%- unless options[:skip_capistrano] -%>
+## 部署
+
+這個專案使用 Capistrano 進行部署，請先確定有權限透過 `deployer` 帳號 SSH 到伺服器上。
+
+```bash
+cap [ENV] deploy
+```
+
+假設要部署到測試（Staging）環境，請使用以下指令
+
+```bash
+cap staging deploy
+```
+
+如果是正式環境，則使用以下指令
+
+```bash
+cap production deploy
+```
+
+過程中會詢問要使用的 Git Branch，預設為 master branch，如果需要測試某個 Git Branch 請先將他上傳到 GitHub 上，並且和團隊成員確認後手動輸入 branch 再進行部署跟測試。
+<%- end -%>