RailsにRSpecを導入する

まずはRailsにRSpecを導入します。

実際にローカル環境でRSpecによるテストができるところまでの手順をまとめています。

「rspec-rails」、「factory_bot_rails」、「rails-controller-testing」のインストール

Gemfileを以下の3つのGemを追加しbundle installします。

・Gemfile

group :development, :test do
  gem 'rspec-rails'
  gem 'factory_bot_rails'
  gem 'rails-controller-testing'
end

RSpecに必要なファイルを生成する

以下のコマンドでRSpecに必要なファイルを生成します。

$ bundle exec rails generate rspec:install

成功すると以下の3つのファイルが生成されていることが確認できます。

.rspec
spec/spec_helper.rb
spec/rails_helper.rb

RSpec実行に必要な設定をする

Factory Botの設定をrails_helper.rbに追加します。

・spec/rails_helper.rb

RSpec.configure do |config|

  ...

  config.include FactoryBot::Syntax::Methods
end

Rails.loggerのログを出力するには以下を追加します。

Rails.logger = Logger.new(STDOUT)

rspec用のテストファイルを作成するために、application.rbに以下を追加します。

・application.rb

config.generators do |g|

...

  g.test_framework :rspec,
                   fixtures: true,
                   view_specs: false,
                   helper_specs: false,
                   routing_specs: false,
                   controller_specs: true,
                   request_specs: false
  g.fixture_replacement :factory_bot, dir: "spec/factories"
end

.rspecに以下を追加するとテストの実行結果が見やすくなります。

・.rspec

--format documentation

テストを作成する

factoriesやcontrollerを用意し、テストを作成していきます。

今回はテスト作成の過程は省略します。詳しくは以下の記事などを参考にしてください。

【Rails】基本的なAPIテストの書き方 #RSpec - Qiita

概要 Railsで作成されたAPIのテストについてこちらを参考に必要最低限の情報…

qiita.com

例として本のデータを取得するAPIの本コントローラのshowメソッドに対してテストを行います。

・spec/factories/books.rb

FactoryBot.define do
  factory :book do
    name {'テスト本'}
  end
end

・spec/controllers/books_controller_spec.rb

describe Api::BooksController, type: :controller do
  context '/api/books' do
    describe 'GET #show' do
      render_views

      before do
        @book = create(:book)
        get :show, params: { id: @book.id }
        @json = JSON.parse(response.body)
      end

      it '200チェック' do
        expect(response).to be_success
        expect(response.status).to eq 200
      end

      it '本データチェック' do
        expect(@json[name]).to eq(@book.name)
      end

    end
  end
end

ローカルでテストが実行できるか確認します。

$ docker-compose exec web bundle exec rspec

正常にテストが成功すると以下のようなログが出力されます。

Finished in 0.58604 seconds (files took 4.32 seconds to load)
2 examples, 0 failures

Cloud BuildでRSpecを組み込む

ローカルでのRSpecによるテストが確認できたら、Cloud BuildにRSpecを組み込んでCI/CDパイプラインを構築していきます。

Dockerfileの作成

Rubyの公式イメージを元に作成しています。

テストする際のDBの接続先はMariaDBを使用します。

・Dockerfile

FROM ruby:2.5.8-alpine3.11

RUN set -ex \
  && apk update \
  && apk upgrade \
  && apk add --no-cache \
    build-base \
    bash \
    curl \
    nodejs \
    tzdata \
    mariadb \
    mariadb-client \
    mariadb-dev \
    openrc \
    libc6-compat \
    gcompat \
  && mkdir -p /run/openrc \
  && touch /run/openrc/softlevel \
  && rc-status \
  && /etc/init.d/mariadb setup \
  && gem install bundler

RUN mkdir /app_name
ENV APP_ROOT /app_name
WORKDIR $APP_ROOT

ADD ./Gemfile $APP_ROOT/Gemfile
ADD ./Gemfile.lock $APP_ROOT/Gemfile.lock

RUN bundle install
ADD . $APP_ROOT

テスト用のDB設定

database.ymlに以下のようにテスト用のDBを設定します。

・database.yml

test:
  adapter: mysql2
  encoding: utf8
  reconnect: false
  pool: 5
  username: root
  password: password
  database: test_db

テスト実行用のシェルスクリプト作成

Cloud Buildで実行するシェルスクリプトを作成します。

MariaDBを起動して、DBを作成しテストを実行できる環境を整えます。その後、テストを実行します。

・rspec.sh

#!/bin/bash

# MariaDBの起動
rc-service mariadb start

# テスト用DB作成・マイグレーション
RAILS_ENV=test rails db:create db:migrate

# RSpecテスト実行
RAILS_ENV=test bundle exec rspec

Dockerイメージを作成し、RSpecのテストを行いGAEにデプロイする

cloudbuild-staging.yamlのスクリプトでDockerイメージの作成、RSpecのテスト、GAEのステージング環境にデプロイを行います。いわゆるCI/CDパイプラインを構築して、実行しています。

Gitでプッシュするとcloudbuild.yamlのスクリプトが自動で実行されるようにしています。

Cloud BuildとGitの連携方法に関してはここでは省略しています。

・cloudbuild-staging.yaml

steps:
- name: 'alpine'
  args: ['echo', '${_ENVIRONMENT}']
- name: 'gcr.io/cloud-builders/docker'
  args: ['build', '-t', 'gcr.io/$PROJECT_ID/cloud-build-rspec', '.']
- name: 'gcr.io/$PROJECT_ID/cloud-build-rspec'
  args: ['/bin/bash', 'rspec.sh']
- name: 'gcr.io/cloud-builders/gcloud'
  args: ['app', 'deploy', 'app-staging.yaml']

Cloud BuildでRSpecによる自動テストの動作確認

テスト失敗時

テスト失敗した際の挙動を確認します。

テストが失敗するとCloud Buildのステップが停止し、デプロイされることはありません。

テスト成功時

テスト成功時の挙動を確認します。

テストが成功すると、そのままGAEへのデプロイが始まり、無事完了しました。

参考

Rails5へのRspec導入から実行確認まで #Ruby - Qiita

株式会社TECH LUCKという会社で代表兼エンジニアをしている齊藤です。 DX…

qiita.com

Google Cloud BuildでRSpecのテストを行う #Rails - Qiita

先日、Google Cloud BuildとGithubの連携が発表され、CIの…

qiita.com

Google Analytics Reporting APIの設定準備

Google Analytics Reporting APIの設定は以下の記事を参考にしました。

• プロジェクトの作成
• サービスアカウントの作成
• 秘密鍵のJSONファイルを生成 ← あとで使います
• Googleアナリティクスにユーザ追加
• ビューIDの確認 ← あとで使います

参考：Google Analytics API を叩いてデータを取得するまでの流れ（Ruby）

RailsでGoogleアナリティクスレポートデータ取得処理をクラス化

Googleアナリティクスレポートデータ取得処理を独自クラス化し、コントローラで使えるようにします。

先程生成した秘密鍵のJSONファイルは「analytics_auth.json」として配置し、authメソッドでGoogleアナリティクスAPIに認証を行ってからレポートデータを取得しにいきます。

report_pv_count_by_dateメソッドで、取得開始日と取得終了日を引数(デフォルトは当日)で指定してその期間のレポートデータを取得できるようにします。

・lib/analytics.rb

require 'google/apis/analyticsreporting_v4'

class Analytics

  # レポート対象を指定してオブジェクトを生成
  # @param [String] base_url レポート対象サイトのURL
  # @param [String] view_id ビューID
  def initialize(base_url, view_id)
    @base_url = base_url
    @view_id = view_id
    @analytics = Google::Apis::AnalyticsreportingV4
    auth
  end

  # 指定した期間のページごとのPVを集計
  # @param [String] date 日付を表す文字列
  # @return [Hash] 累計PV及びページごとのPV
  def report_pv_count_by_date(start_date = 'today', end_date = 'today')
    date_range = @analytics::DateRange.new(start_date: start_date, end_date: end_date)
    metric = @analytics::Metric.new(expression: 'ga:users', alias: 'users')
    dimension = @analytics::Dimension.new(name: 'ga:pagePath')
    order_by = @analytics::OrderBy.new(field_name: 'ga:users', sort_order: 'DESCENDING')
    request = @analytics::GetReportsRequest.new(
      report_requests: [@analytics::ReportRequest.new(
        view_id: @view_id,
        metrics: [metric],
        date_ranges: [date_range],
        dimensions: [dimension],
        order_bys: [order_by],
      )]
    )
    response = @client.batch_get_reports(request)
    data = response.reports.first.data
    return {
      total: data.totals.first.values.first,
      pages: data.rows.map do |row|
        {
          url: @base_url + row.dimensions.first,
          dir: row.dimensions.first,
          views: row.metrics.first.values.first
        }
      end
    }
  end

  private

  # GoogleアナリティクスAPIに認証
  # 同ディレクトリにanalytics_auth.jsonを配置
  def auth
    scope = ['https://www.googleapis.com/auth/analytics.readonly']
    @client = @analytics::AnalyticsReportingService.new
    @client.authorization = Google::Auth::ServiceAccountCredentials.make_creds(
      json_key_io: File.open('analytics_auth.json'),
      scope: scope
    )
  end

end

独自クラスを作成したら、呼び出せるようにapplication.rbに以下を追記します。

・config/application.rb

require_relative 'boot'

require 'rails/all'

# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

module AppName
  class Application < Rails::Application

    ...

    # 独自クラスパス指定
    config.autoload_paths += %W(#{config.root}/lib) ←追加

    ...

  end
end

uninitialized constantエラーで定義したクラスを読むことができない場合は、config/initializersディレクトリ配下にrequirements.rbファイルを作成し、以下を追記してください。

・config/initializers/requirements.rb

require Rails.root.join('lib/analytics.rb')

クラス化したGoogleアナリティクスレポートデータ取得メソッド呼び出し

実際にコントローラで呼び出してみます。初期化のBASE_URLとVIEW_IDは環境変数として.envに設定し呼び出して使うようにします。

フロントからパラメータ(取得開始日・取得終了日)をPOSTし、それらを引数にして実行しています。レスポンスはJSON形式で返すようにしています。

あとはroutes.rbにルーティングを設定して完了です。

・app/controllers/api/analytics_controller.rb

class Api::AnalyticsController < Api::ApplicationController

  def report
    analytics = ::Analytics.new(ENV['BASE_URL'], ENV['VIEW_ID'])

    render json: analytics.report_pv_count_by_date(params[:start_date], params[:end_date])
  end

end

以上、RailsでGoogle Analytics Reporting APIでレポートデータ取得する方法でした。

database.ymlの編集

database.ymlにステージング環境用と本番環境用のDB情報をそれぞれ追加します。

・database.yml

...

staging:
  adapter: mysql2
  encoding: utf8
  pool: 5
  timeout: 5000
  username: sample_stg
  password: sample_stg_pass
  database: sample_stg
  socket: /cloudsql/sample_stg:asia-northeast1:sample_stg

production:
  adapter: mysql2
  encoding: utf8
  pool: 5
  timeout: 5000
  username: sample_prod
  password: sample_prod_pass
  database: sample_prod
  socket: /cloudsql/sample_prod:asia-northeast1:sample_prod

...

app.yamlの編集

GAEにデプロイするステージング環境と本番環境のapp.yamlファイルを作成します。

今回はGAEのスタンダード環境で構築しています。「RAILS_ENV=」で環境を指定します。

また、env_variablesで環境変数を指定することもできます。

・app-staging.yaml

service: api--staging
runtime: ruby25
entrypoint: RAILS_ENV=staging bundle exec rails s -e staging
env_variables:
  SAMPLE_API_KEY: 'SAMPLE_STAGING_API_KEY'

・app-production.yaml

service: api--production
runtime: ruby25
entrypoint: RAILS_ENV=production bundle exec rails s -e production
env_variables:
  SAMPLE_API_KEY: 'SAMPLE_PRODUCTION_API_KEY'

dispatch.yamlの作成

dispatch.yamlを作成し、ドメインとサービスを紐づけます。これでGAEのサービスにデプロイした際に、指定したURLに割り当てることができます。

・dispatch.yaml

dispatch:
- url: "*stg.sample.com/*"
service: api--staging
- url: "*sample.com/*"
service: api--production

dispatch.yamlが作成できたら、以下のコマンドでデプロイします。

$ gcloud app deploy dispatch.yaml

Railsプロジェクトをステージング環境と本番環境にそれぞれデプロイ

ここまで準備が完了したら、実際にRailsプロジェクトをそれぞれの環境にデプロイします。

■ステージング環境

デプロイする前にRailsアセットをコンパイルします。

$ RAILS_ENV=staging bundle exec rails assets:precompile

app-staging.yamlを指定してデプロイします。

$ gcloud app deploy app-staging.yaml

■本番環境

ステージング環境と同様、デプロイする前にコンパイルします。

$ RAILS_ENV=production bundle exec rails assets:precompile

app-production.yamlを指定してデプロイします。

$ gcloud app deploy app-production.yaml

デプロイする際に、target serviceがそれぞれの環境が選択できているか確認しておきましょう。

target service: [api--staging]

マイグレーション・シードの実行

マイグレーションとシードもそれぞれの環境に合わせて行いますappengineを使ってマイグレーションを実行します。

シード処理は時間がかかることがあるので、デフォルトの10分を30分まで伸ばしています。

■ステージング環境

マイグレーション処理

$ bundle exec rake appengine:exec GAE_SERVICE=api--staging -- bundle exec rails db:migrate RAILS_ENV=staging

シード処理

$ bundle exec rake appengine:exec GAE_SERVICE=api--staging GAE_TIMEOUT=30m -- bundle exec rails db:seed RAILS_ENV=staging

■本番環境

マイグレーション処理

$ bundle exec rake appengine:exec GAE_SERVICE=api--production -- bundle exec rails db:migrate RAILS_ENV=production

シード処理

$ bundle exec rake appengine:exec GAE_SERVICE=api--production GAE_TIMEOUT=30m -- bundle exec rails db:seed RAILS_ENV=production

① ハマりポイント「Errno::EROFS: Read-only file system @ rb_sysopen – /srv/db/schema.rb」

追加のマイグレーションファイルを作成し、実行するときにエラー発生。schema.rbが読み取り専用のため(スタンダード環境だから？)、実行できずにハマる。。

$ bundle exec rake appengine:exec GAE_SERVICE=api--staging -- bundle exec rails db:migrate

[STDERR] rails aborted!
[STDERR] Errno::EROFS: Read-only file system @ rb_sysopen - /srv/db/schema.rb

解決策として、作成したマイグレーションファイルのバージョンを指定することで実行できました。

$ bundle exec rake appengine:exec GAE_SERVICE=api--staging -- bundle exec rails db:migrate:up VERSION=20200401000000

[STDOUT] == 20200401000000 AddColumnTests: migrating ===================
[STDOUT] -- add_column(:tests, :test_id, :string, {:null=>true, :after=>:sample_id})
[STDOUT] -> 0.0461s
[STDOUT] == 20200401000000 AddColumnTests: migrated (0.0462s) ==========
[STDOUT]

EXIT STATUS: 0

②ハマりポイント「Cannot run migrations because another migration process is currently running.」

マイグレーション対象のDBに接続した状態で、実行するとエラー発生。

[STDERR] rails aborted!
[STDERR] ActiveRecord::ConcurrentMigrationError:
[STDERR]
[STDERR] Cannot run migrations because another migration process is currently running.

DBにログインし、以下のコマンドで処理中のプロセスの一覧を表示し、該当のプロセスを終了させて再度実行すれば通ります。

$ SHOW PROCESSLIST

以上、GAEでRailsのステージング環境と本番環境を構築する方法を紹介しました。

CORS(Cross-Origin Resource Sharing)とは

CORSとは、クライアントが自分と違うオリジンをもつサーバーからのアクセスを許可する仕組みのことです。

WebクライアントとAPIを分ける場合などで、異なるオリジン間の通信を行うためにはCORSの設定をする必要があります。

以下のページに詳しく書かれています。

参考：CORSまとめ

※オリジン(ex. http://www.example.com:3000)はスキーム「http://」、ホスト「www.example.com」、ポート「3000」の組み合わせからなります

「rack-cors」gemの追加

「rack-cors」gemを追加します。

参考：rack-cors

・Gemfile

gem 'rack-cors'

CORSの設定

application.rbにCORSの設定をしていきます。

・config/application.rb

config.middleware.insert_before 0, Rack::Cors do
    allow do
        origins "*"
        resource "*",
        headers: :any,
        methods: [:get, :post, :options, :head]
    end
end

「*」の場合は全て許可することを意味し、以下の通りに設定していきます。

• origins (文字列 or 正規表現) : どのオリジンを許可するか(APIを叩く側)
• resource (文字列 or 正規表現) : 許可したいリソースファイル
• methods (文字列 or Array or :any) : 許可したいHTTPメソッド
• headers (文字列 or Array or :any) : 許可したいHTTPヘッダー

実際に設定していくとはのような感じになりました。

・config/application.rb

config.middleware.insert_before 0, Rack::Cors do
    allow do
        origins "http://localhost:8000", "https://example.jp"
        resource "*",
        headers: :any,
        methods: [:get, :post, :patch, :delete, :options, :head]
    end
end

CORSの設定が反映されているか確認

以下のコマンドで再起動し、CORSの設定が反映されているか確認します。

$ docker-compose restart

「http://localhost:5000」からAPI(http://localhost:7000)にアクセスした時のレスポンスを見てみます。実際にアクセスするとコンソールに以下のようなエラーメッセージが表示され、アクセスできないことが確認できました。

Access to XMLHttpRequest at 'http://localhost:7000/api/tests/' from origin 'http://localhost:5000' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

次にCORSで設定した「http://localhost:8000」でアクセスしてみます。NetworkのAPIのResponse Headersに以下のレスポンスが帰ってき、アクセスできることが確認できます。

Response Headers
    Access-Control-Allow-Methods: GET, POST, PATCH, DELETE, OPTIONS, HEAD
    Access-Control-Allow-Origin: http://localhost:8000
    Access-Control-Expose-Headers:

以上、RailsのAPIでCORSの設定をする方法を紹介しました。

基本的には以下の公式を参考に環境構築しています。

• Running Rails 5 on App Engine flexible environment | Ruby
• Using Cloud SQL for MySQL with Rails 5 | Ruby

前提条件

デプロイするRailsプロジェクトが以下に当てはまっていることが前提条件です。

• Ruby バージョン2.3.4以降をインストール
• Rails 5 gem をインストール
• Bundler gem をインストール

必要なAPIを有効化

データストア、Pub / Sub、Cloud Storage JSON、Stackdriver Logging、およびGoogle+必要なAPIを有効にします。

app.yamlの作成

GAEにデプロイするRailsアプリのディレクトリ直下にapp.yamlを作成します。

今回はスタンダード環境なので「env: flex」はコメントアウトしておきます。またapp.yamlに環境変数を書くことでGAEに環境変数を渡せます。

secret keyは以下のコマンドで確認できます。

$ bundle exec rails secret

・app.yaml

entrypoint: bundle exec rackup --port $PORT
runtime: ruby25
# env: flex
env_variables:
    SECRET_KEY_BASE: < Your secret key>

GAEにデプロイしたアプリはDocker上で動くためDockerfileがプロジェクト直下にあるとruntime rubyでデプロイができません。

runtime rubyでデプロイする場合は、DockerfileをDockerfile-devなどに置き換えておきましょう。

.gcloudignoreの作成

デプロイしないファイルを指定するために.gcloudignoreファイルを作成します。

・.gcloudignore

.gcloudignore
#!include:.gitignore
.git
.gitignore

!/public/assets

MySQL用Cloud SQLをセットアップ

RailsアプリでCloud SQLを使用するために、mysql2とappenginegemをGemfileファイルに追加します

$ bundle add mysql2
$ bundle add appengine

以下のコマンドでインスタンス接続名を取得できます。
gcloud sql instances describe < インスタンス名 >

・database.yml

production:
    adapter: mysql2
    encoding: utf8
    pool: 5
    timeout: 5000
    username: < username >
    password: < password >
    database: < database >
    socket: /cloudsql/< インスタンス接続名 >

GAEにデプロイ

以下のコマンドで、GAEアプリを作成します。

$ gcloud app create

デプロイする前に、Railsアセットをプリコンパイルします。

$ bundle exec bin/rails assets:precompile

アセットのコンパイルが完了したらGAEにデプロイします。

$ gcloud app deploy

マイグレーションでテーブル作成

以下のコマンドでプロジェクトを一覧表示できます。アプリのデプロイに使用するプロジェクトを見つけ、プロジェクト番号をコピーします。

$ gcloud projects list

roles/editorデータベース移行を実行するロールのプロジェクトIAMポリシーに新しいメンバーを追加します。

$ gcloud projects add-iam-policy-binding < YOUR-PROJECT-ID > --member=serviceAccount: < PROJECT_NUMBER > @cloudbuild.gserviceaccount.com --role=roles/editor

先ほど追加したappengineを使用して、Cloud SQL上でのマイグレーションを実行します。

$ bundle exec rake appengine:exec -- bundle exec rake db:migrate

Cloud SQL画面の「Cloud Shellを使用して接続」から以下のコマンドで接続し、実際にテーブルが作成されたか確認してみましょう。

$ gcloud sql connect < インスタンス名 > --user=< username > --quiet

以降のデプロイ

以降、ソースを更新して再度デプロイする場合は以下のコマンドで実行する流れになります。

$ bundle exec bin/rails assets:precompile
$ gcloud app deploy
$ bundle exec rake appengine:exec -- bundle exec rake db:migrate

ハマりポイント

① コンパイル時にエラー

コンパイル時に以下のエラーが発生。

Note: Google::Cloud::Logging is disabled because it failed to authorize with the service.
Note: Google::Cloud::Debugger is disabled because it failed to authorize with the service.
Note: Google::Cloud::ErrorReporting is disabled because it failed to authorize with the service.
Note: Google::Cloud::Trace is disabled because it failed to authorize with the service.

develop環境では使用しないようfalseにすることで解決しました。

・development.rb

config.google_cloud.use_logging = false
config.google_cloud.use_debugger = false
config.google_cloud.use_error_reporting = false
config.google_cloud.use_trace = false

② MySQLに接続できない

以下のエラーによりCloud SQLのMySQLに接続できずハマり。。

[STDERR] rake aborted!
[STDERR] Mysql2::Error::ConnectionError: Unknown MySQL server host '/cloudsql/< インスタンス接続名 >' (2)

公式ではdatabase.yamlの「/cloudsql/< インスタンス接続名 >」の箇所がhostとなっていたため、hostで書いていたのですが、socketに変更することで解決しました。。

参考：

ruby-docs-samples/appengine/rails-cloudsql-postgres/config/database.yml at 0a6e898a1acd140ca04c63c7b68da1468acb4082 · GoogleCloudPlatform/ruby-docs-samples · GitHub

Ruby samples for Google Cloud Platform p…

github.com

・修正前

production:
    adapter: mysql2
    encoding: utf8
    pool: 5
    timeout: 5000
    username: < username >
    password: < password >
    database: < database >
    host: /cloudsql/< インスタンス接続名 >

・修正後

production:
    adapter: mysql2
    encoding: utf8
    pool: 5
    timeout: 5000
    username: < username >
    password: < password >
    database: < database >
    socket: /cloudsql/< インスタンス接続名 >

③ GAEのデフォルトTime Outが10分なためSeedが完了しない

GAEのデフォルトタイムアウトが10mのため、Seedが完了せず途中で終了してしまう。。

TIMEOUT: 10m

GAE_TIMEOUTオプションでタイムアウトを伸ばすことができました。1h23m45sの形式で指定できます。

bundle exec rake appengine:exec GAE_TIMEOUT=30m -- bundle exec rake db:seed

参考：

How to set the value of timeout? · Issue #26 · GoogleCloudPlatform/appengine-ruby · GitHub

Could not find this documented anywhere …

github.com

以上、Google App EngineのRuby 2.5 StandardでRails環境構築する方法とCloud SQLのMySQLとの接続方法でした。

駅データ.jpで鉄道会社・路線・駅データをダウンロードし、Railsプロジェクトに格納

駅データ.jpで鉄道会社・路線・駅データをダウンロードします。ダウンロードするためには会員登録が必要です。

ダウンロードしたCSVファイルをdb/data配下に格納しておきます。

• db/data/companies.csv (鉄道会社データ)
• db/data/lines.csv (路線データ)
• db/data/stations.csv (駅データ)

駅関連データ提供元：駅データ 無料ダウンロード 『駅データ.jp』

鉄道会社・路線・駅のマイグレーション作成

まずは、鉄道会社・路線・駅のマイグレーションファイルを作成します。

・db/migrate/20200101000001_create_companies.rb

class CreateCompanies < ActiveRecord::Migration[5.2]
    def change
        create_table :companies, id: false, options: 'ENGINE=InnoDB COLLATE=utf8_general_ci' do |t|
            t.integer :company_id, null: false, unique: true
            t.string :name
            t.string :kana
            t.string :formal_name
            t.string :abbreviation_name

            t.datetime :created_at
            t.datetime :updated_at
            t.datetime :deleted_at
        end
    end
end

・db/migrate/20200101000002_create_lines.rb

class CreateLines < ActiveRecord::Migration[5.2]
    def change
        create_table :lines, id: false, options: 'ENGINE=InnoDB COLLATE=utf8_general_ci' do |t|
            t.integer :line_id, null: false, unique: true
            t.integer :company_id
            t.string :name
            t.string :kana
            t.decimal :lat, :precision => 9, :scale => 6, null: true
            t.decimal :lng, :precision => 9, :scale => 6, null: true

            t.datetime :created_at
            t.datetime :updated_at
            t.datetime :deleted_at
        end
    end
end

・db/migrate/20200101000003_create_stations.rb

class CreateStations < ActiveRecord::Migration[5.2]
    def change
        create_table :stations, id: false, options: 'ENGINE=InnoDB COLLATE=utf8_general_ci' do |t|
            t.integer :station_id, null: false, unique: true
            t.integer :line_id
            t.string :name
            t.string :address
            t.decimal :lat, :precision => 9, :scale => 6, null: true
            t.decimal :lng, :precision => 9, :scale => 6, null: true

            t.datetime :created_at
            t.datetime :updated_at
            t.datetime :deleted_at
        end
    end
end

鉄道会社・路線・駅のモデル作成

鉄道会社・路線・駅のモデル作成を作成します。各々のリレーションもはっておきます。

・app/models/company.rb

class Company < ApplicationRecord

    ##
    # リレーション
    ##
    has_many :lines

end

・app/models/line.rb

class Line < ApplicationRecord

    ##
    # リレーション
    ##
    belongs_to :company
    has_many :stations

end

・app/models/station.rb

class Station < ApplicationRecord

    ##
    # リレーション
    ##
    belongs_to :line

end

seed.rbで鉄道会社・路線・駅データを取得し、テーブルに保存

先ほど保存したCSVファイルから必要なカラムのデータを取得していきます。鉄道会社データから駅データを取得していき、完了です。

・db/seeds.rb

require 'csv'

# 鉄道会社CSVファイルパス
COMPANY_PATH = "db/data/companies.csv"

# 鉄道会社カラム指定定数
COMPANY_CSVROW_COMPANY_ID = 0
COMPANY_CSVROW_NAME = 2
COMPANY_CSVROW_KANA = 3
COMPANY_CSVROW_FORMAL_NAME = 4
COMPANY_CSVROW_ABBREVIATION_NAME = 5

# 鉄道会社CSVを読み込みテーブルに保存
CSV.foreach(COMPANY_PATH) do |row|
    company_id = row[COMPANY_CSVROW_COMPANY_ID]
    name = row[COMPANY_CSVROW_NAME]
    kana = row[COMPANY_CSVROW_KANA]
    formal_name = row[COMPANY_CSVROW_FORMAL_NAME]
    abbreviation_name = row[COMPANY_CSVROW_ABBREVIATION_NAME]
    Company.find_or_create_by(
        :company_id => company_id,
        :name => name, :kana => kana,
        :formal_name => formal_name,
        :abbreviation_name => abbreviation_name
    )
end

# 路線CSVファイルパス
LINE_PATH = "db/data/lines.csv"

# 路線カラム指定定数
LINE_CSVROW_LINE_ID = 0
LINE_CSVROW_COMPANY_ID = 1
LINE_CSVROW_NAME = 2
LINE_CSVROW_KANA = 3
LINE_CSVROW_LNG = 8
LINE_CSVROW_LAT = 9

# 路線CSVを読み込みテーブルに保存
CSV.foreach(LINE_PATH) do |row|
    line_id = row[LINE_CSVROW_LINE_ID]
    company_id = row[LINE_CSVROW_COMPANY_ID]
    name = row[LINE_CSVROW_NAME]
    kana = row[LINE_CSVROW_KANA]
    lng = row[LINE_CSVROW_LNG]
    lat = row[LINE_CSVROW_LAT]

    Line.find_or_create_by(
        :line_id => line_id,
        :company_id => company_id,
        :name => name,
        :kana => kana,
        :lat => lat,
        :lng => lng
    )
end

# 駅CSVファイルパス
STATION_PATH = "db/data/stations.csv"

# 駅カラム指定定数
STATION_CSVROW_STATION_ID = 0
STATION_CSVROW_NAME = 2
STATION_CSVROW_LINE_ID = 5
STATION_CSVROW_ADDRESS = 8
STATION_CSVROW_LNG = 9
STATION_CSVROW_LAT = 10

# 駅CSVを読み込みテーブルに保存
CSV.foreach(STATION_PATH) do |row|
    station_id = row[STATION_CSVROW_STATION_ID]
    name = row[STATION_CSVROW_NAME]
    line_id = row[STATION_CSVROW_LINE_ID]
    address = row[STATION_CSVROW_ADDRESS]
    lng = row[STATION_CSVROW_LNG]
    lat = row[STATION_CSVROW_LAT]

    Station.find_or_create_by(
        :station_id => station_id,
        :line_id => line_id,
        :name => name,
        :address => address,
        :lat => lat,
        :lng => lng
    )
end

以上、鉄道会社・路線・駅データをseedで取得・インポートする方法でした。

都道府県・市区町村のマイグレーション作成

まずは、都道府県・市区町村のマイグレーションファイルを作成します。

・db/migrate/20200101000001_create_prefectures.rb

class CreatePrefectures < ActiveRecord::Migration[5.2]
    def change
        create_table :prefectures, id: :int, unsigned: true, auto_increment: true, options: 'ENGINE=InnoDB COLLATE=utf8_general_ci' do |t|
            t.string :name, null: false, limit: 4

            t.datetime :created_at
            t.datetime :updated_at
            t.datetime :deleted_at
        end
    end
end

・db/migrate/20200101000002_create_cities.rb

class CreateCities < ActiveRecord::Migration[5.2]
    def change
        create_table :cities, id: :int, unsigned: true, auto_increment: true, options: 'ENGINE=InnoDB COLLATE=utf8_general_ci' do |t|
            t.integer :prefecture_id
            t.string :name, null: false, limit: 16

            t.datetime :created_at
            t.datetime :updated_at
            t.datetime :deleted_at
        end
    end
end

都道府県・市区町村のモデル作成

都道府県と市区町村のモデル作成します。1対多のリレーションもはっておきます。

・app/models/prefecture.rb

class Prefecture < ApplicationRecord

    ##
    # リレーション
    ##
    has_many :cities

end

・app/models/city.rb

class City < ApplicationRecord

    ##
    # リレーション
    ##
    belongs_to :prefecture

end

seed.rbで都道府県・市区町村データを取得し、テーブルに保存

seed.rbファイルに都道府県・市区町村データを取得し、テーブルに保存する処理を書いていきます。

今回は日本郵便の都道府県ZIPファイルのダウンロードURLから取得していきます。一度ファイルをダウンロードして、Railsプロジェクトに格納してから、そこを参照して取得しても良いかと思います。

ZIPファイルを一度CSVファイルに変換し、db/配下に保存します。

その後、保存したCSVファイルから都道府県名と市区町村名のカラムを取得し、先ほど作成した都道府県と市区町村のテーブルに挿入していきます。

全取得が完了したら、保存していたCSVファイルを削除して完了です。

・db/seeds.rb

require 'csv'
require 'zip'

PREF_CITY_URL = "http://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip"
SAVEDIR = "db/"
CSVROW_PREFNAME = 6
CSVROW_CITYNAME = 7
save_path = ""

# 都道府県・市区町村ZIPを解凍しCSVとして保存
open(URI.escape(PREF_CITY_URL)) do |file|
    ::Zip::File.open_buffer(file.read) do |zf|
        zf.each do |entry|
            savePath = SAVEDIR + entry.name
            zf.extract(entry, save_path) { true }
        end
    end
end

# 都道府県・市区町村CSVを読み込みテーブルに保存
CSV.foreach(save_path, encoding: "Shift_JIS:UTF-8") do |row|
    pref_name = row[CSVROW_PREFNAME]
    city_name = row[CSVROW_CITYNAME]
    pref = Prefecture.find_or_create_by(:name => pref_name)
    City.find_or_create_by(:name => city_name, prefecture_id: pref.id)
end

# 保存したCSVファイルを削除
File.unlink save_path

以上、都道府県・市区町村データをseedで取得・インポートする方法でした。

carriwaveを使ってPDFファイルカラムが存在するモデルと紐づけ

Gemのcarriwaveを使ってファイルをアップロードするため、インストールや設定をしておく必要があります(今回は省略)。

ファイルパスを保存するカラム(今回の場合はfile_name)を指定してモデルと紐づけます。

class Hoge < ApplicationRecord

...

    # pdfアップローダー
    mount_uploader :pdf, FileUploader, mount_on: :file_name

....

end

PDFファイルアップロード処理(フロントエンド)

ViewでPDFファイrを選択するHTMLを生成します。

PDFファイルが選択された場合、または変更された場合に「Application.hoges.pdf_upload($(this))」イベントが発火します。

<%= form_for @hoge, url: { action: action, id: @hoge.id }, html: { multipart: true }, remote: true, data: { method: :confirm } do |f| %>

...

    <div>
        <%= f.hidden_field :id %>
        <%= f.label :pdf do %>
            PDFファイル選択
            <%= f.file_field :pdf, accept: ".pdf", url: "#{upload_tempfile_hoges_path}", onchange: "Application.hoges.pdf_upload($(this))" %>
            <%= f.hidden_field :file_name, id: "file_name" %>
            <%= f.hidden_field :pdf_cache, id: "cache_name" %>
        <% end %>
        <a class="pdf_file_name_label"><%= f.object.file_name || "選択されていません" %></a>
    </div>

...

<% end %>

CoffeeScriptで非同期のアップロード処理を書いていきます。

読み込んだPDFファイルの情報をFormDataに格納し、urlのパスにデータを送ります。

PDFアップロードに成功した場合は、その情報をViewに書き換えます。失敗した場合は、エラーモーダル(処理は省略)を表示させます。

class HogessController

    index: ->

        @pdf_upload = (input) ->
            file_uploader(input)

        # PDFアップロード
        file_uploader = (input) ->
            file = input.prop('files')[0]
            formData = new FormData()
            formData.append("file", file)
            formData.append("filename", file.name)
            formData.append("name", input.parent().siblings('#file_link').find("label").attr("for"))

            $.ajax
                url: input.attr('url'),
                method: 'post',
                dataType: 'json',
                data: formData,
                processData: false,
                contentType: false
                
                .done (res) ->
                    input.siblings('#cache_name').val(res.cache)
                    input.siblings('#file_name').val(file.name)
                    input.parents('.image_file-selection').find('.pdf_file_name_label').text(file.name).attr('href', res.pdf_url).attr('target', '_blank')
                    return

                .fail (xhr, status, error) ->
                    Application.show_error_modal(xhr)
                    return

        return

this.Application.hoges = new HogesController

PDFファイルアップロード処理(サーバサイド)

発火したイベントによってPDFファイルデータが非同期でサーバに送られます。サーバに送るためにroutes.rbrbにルーティングを追加しておきます。

送られたデータを先ほど紐づけたモデルからアップロードします。アップロードしたデータの返り値を@fileに格納します。

post :upload_tempfile

class Hoge < ApplicationRecord

...

    # PDFファイルアップロード
    def upload_tempfile
       @file = ::Hoge.new(pdf: params[:file], file_name: params[:filename])
    end

...

end

@fileのデータをJSON形式で変数に格納し、アップロード結果をViewに表示します。

今回の場合は、画面でアップロードしたファイルを確認できるようにするためファイルパスを返しています。

また、DBに登録や更新処理をする際のパラメータとして、アップロードしたキャッシュデータをinputタグに埋め込んでいます。

・upload_tempfile.js.erb

upload_tempfile.js.erb
{
    "pdf_url": "<%= @file.pdf.url %>",
    "cache": "<%= @file.pdf.cache_name %>"
}

以上、Railsで非同期にPDFファイルをアップロードする方法でした。

1. 編集画面(View)

Viewで企業編集画面を用意します。formで編集したい項目を囲い、submitボタンが押下されたらサーバに送られ、フロントで受け取ります。

今回はAjaxを使った非同期通信の流れを紹介するため、それ以外の処理やモデル、routes.rbやja.ymlなどの定義は適宜読み替えてください。

...
    <div data-method="edit_error_message"></div>
    <%= form_for @company, url: edit_confirm_company_path(@company), remote: true, data: { method: :edit_confirm } do |f| %>

...

        <dl>
            <dt>企業名<span class="required">*</span></dt>
            <dd><%= f.text_field :company_name, class: "form_input", placeholder: "例：テスト企業" %></dd>
        </dl>

...

        <button type="submit"><%= t('view.buttons.edit') %></button>
    <% end %>

...

2. サーバサイドで編集確認処理(Controller)

Viewから送られてきたパラメータを受け取り、バリデーションします(バリデーションはモデルに書いてある前提)。

バリデーションに引っかかった場合は、エラーを返します。

成功した場合は、セッションにパラメータを格納します。非同期処理なため、JSON形式で返すformat.jsonを使用します。

class CompaniesController < ApplicationController
    before_action :set_company, only: [:edit, :edit_confirm]

    COMPANY_PARAM = :company_param

...

    def edit_confirm
        respond_to do |format|
            @company.assign_attributes(edit_company_params)
            @company.validate

            if @company.errors.blank?
                session[COMPANY_PARAM] = edit_company_params
                format.json { render json: @company, status: :ok }
            else
                format.json { fail AsyncRetryValidationError, @company.errors }
            end
        end
    end

...

    private

    def set_company
        @company = ::Company.find(params[:id])
    end

    def edit_company_paramss
        params.require(:company).permit(:company_name)
    end
end

3. サーバからの編集確認結果を受け取る(View・CoffeeScript)

サーバから帰ってきたデータはフロントで受け取ります。

バリデーションに成功した場合は、data-remodal-idがedit-modal-confirmの編集確認モーダルが呼び出されます。

バリデーションに失敗した場合は、Viewの<div data-method=”edit_error_message”></div>にエラーメッセージを表示させます。

...

$('[data-method="edit_confirm"]')
    .on 'ajax:success', (event, data, status, xhr)->
        $('[data-remodal-id="edit-modal-confirm"]').remodal().open()
        return
    .on 'ajax:error', (event, xhr, status, error)->
        data = $.parseJSON(xhr.responseText)
        element = $('[data-method="edit_error_message"]')
        show_error_message element, data.errors
        return

show_error_message = (element, error_messages) ->
    element.addClass 'error_block'
        element.find('p').remove()
        for error_message in error_messages
            element.append '<p>' + error_message.message + '</P>'
        return

...

バリデーションに成功した場合、以下の編集確認モーダルが表示されます。

モーダルに表示された編集ボタンが押下されたら、編集処理を行うアクションにデータを送ります。

...

<div id="remodal" class="remodal modal_common" data-remodal-id="edit-modal-confirm" data-remodal-options="hashTracking: false, closeOnOutsideClick: false">
    <div class="modal_text">
        <p>企業情報を編集します。よろしいですか？</p>
    </div>
    <%= form_for @company, url: edit_company_path(@company), remote: true, data: { method: :edit } do |f| %>
        <div class="modal_cancel">
            <button type="button" data-remodal-action="cancel"><%= t('view.messages.cancel') %></button>
            <button type="submit"><%= t('view.messages.do_edit') %></button>
        </div>
    <% end %>
</div>

...

4. サーバサイドで編集処理(Controller)

バリエーションに成功したパラメータを先ほど格納したセッションから取り出し、編集処理を行います(実際の編集処理は割愛します)。

先ほどのCompaniesControllerに以下の処理を追記するような形です。

...

def edit
    respond_to do |format|
        edit_company = session[COMPANY_PARAM]
        company = ::Company::editr.new(@company, edit_company).edit
        if company.errors.blank?
            format.json { render json: company, status: :ok }
        else
            format.json { fail AsyncRetryValidationError, company.errors }
        end
    end
end

...

5. サーバからの編集結果を受け取る(View・CoffeeScript)

編集処理の結果をフロントで受け取ります。

編集処理に成功した場合は、data-remodal-idがedit-modal-completionの編集完了モーダルが呼び出されます。

...

$('[data-method="edit"]')
    .on 'ajax:success', (event, data, status, xhr)->
        data = $.parseJSON(xhr.responseText)
        $('[data-remodal-id="edit-modal-completion"]').remodal().open()
        return
    .on 'ajax:error', (event, xhr, status, error)->
        Application.show_error_modal(xhr)
        return

...

編集処理に失敗した場合は、エラーモダールを表示させます。エラーモーダルは他でも使用するためApplication.js.coffeeに共通化しています。

...

this.Application.show_error_modal = (error, id = 'remodal-error') ->
    if $.isArray(error)
        error_messages = error
    else if error.responseJSON && error.responseJSON.errors
        error_messages = error.responseJSON.errors
    else
    error_messages = []

    $element = $('[data-remodal-id="' + id + '"]')

    if error_messages.length > 0
        $element.find('.modal_text').empty()
        for error_message in error_messages
            $element.find('.modal_text').append '<p>' + error_message.message + '</p>'

    $element.remodal().open()

    return

...

編集に完了した場合、以下の編集完了モーダルが表示されます。

閉じるボタンを押下すると、画面がリロードされ編集された新しい情報が更新されます。

...

<div id="remodal" class="remodal modal_common" data-remodal-id="edit-modal-completion" data-remodal-options="hashTracking: false, closeOnOutsideClick: false">
    <div class="modal_text">
        <p>編集が完了しました。</p>
    </div>
    <div class="modal_cancel">
        <button type="button" class="btn_white btn_big" data-remodal-action="cancel", onclick="location.reload();">閉じる</button>
    </div>
</div>

...

編集に失敗した場合、以下のシステムエラーモーダルが表示されます。

エラーメッセージが存在しない場合は、デフォルトのメッセージを表示するようにしています。

...

<%
    options ||= {}
    options[:messages] ||= []
    if options[:messages].blank?
        options[:messages] << 'システムエラーが発生しました。'
        options[:messages] << 'しばらく時間をおいてから再度お試しください。'
    end
    options[:remodal_id] ||= 'remodal-error'
    options[:remodal_options] ||= 'hashTracking: false, closeOnOutsideClick: false'
%>
<div data-remodal-id="<%= options[:remodal_id] %>" data-remodal-options="<%= options[:remodal_options] %>">
    <div class="modal_text">
        <% options[:messages].each do |message| %>
            <p><%= message %></p>
        <% end %>
    </div>
    <div class="modal_cancel">
        <button type="button" data-remodal-action="cancel">閉じる</button>
    </div>
</div>

...

以上、RailsでAjaxを使った非同期処理の流れを紹介しました。

【Rails】before_actionメソッドの使い方

before_actionメソッドを定義することで、アクションが実行される前に処理を行ってくれます。

複数のアクションで同じような処理をしている場合は、before_actionを活用することで、コードを簡素化することができます。

class TestsController < ApplicationController
    before_action :set_test

    def index
    end

    private

    def set_test
        @test = Test.find(params[:id])
    end
end

以下のようにactionを指定して、定義することもできます。

before_action :set_hoge, only: [:index]

ただbefore_actionを使いすぎると、actionごとの変数やメソッドが一見わかりづらくなってしまう場合があります。

認証など共通して事前に処理があるものは継承元のapplication_controller.rbなどに書いておくのが良いと思います。

参考：

Action Controller の概要 - Railsガイド

本ガイドでは、コントローラの動作と、アプリケーションのリクエストサイクルでコント…

railsguides.jp