Gemを初公開しました

ask_year_monthという、

レシーバが何月なのか、

スマートにチェックするメソッドを生やしただけのGemを公開しました。

例えば、

Time.current.month == 12
#=> true

よりも、

Time.current.december?
#=> true

のが見やすいよなーという所から。

ご興味がある方は良かったら使ってみてください。

RubyGems

https://rubygems.org/gems/ask_year_month

GitHub

https://github.com/mah666hhh/ask_year_month

参考記事

RailsプラグインGemの作成方法、RSpecテストまで含めたrails pluginの作り方

【Ruby】gemの作り方から公開まで

gem install に失敗するので https://rubygems.org/ を source に追加した

activesupport/lib/active_support/core_ext

Gemを初公開しました

ask_year_monthという、

レシーバが何月なのか、

月名でスマートにチェックできるメソッドを生やすGemを公開しました。

月名で確認できなくて地味にモヤッとしたんですよね。

例えば、

Time.current.month == 12
#=> true

よりも、

Time.current.december?
#=> true

のが見やすいよなーという。

ご興味がある方は良かったら使ってみてください。

RubyGems

https://rubygems.org/gems/ask_year_month

GitHub

https://github.com/mah666hhh/ask_year_month

参考記事

RailsプラグインGemの作成方法、RSpecテストまで含めたrails pluginの作り方

【Ruby】gemの作り方から公開まで

gem install に失敗するので https://rubygems.org/ を source に追加した

activesupport/lib/active_support/core_ext

Docker練習第二弾。Rails5は結構やっていたのでRails6を動かしてみようと思います。

環境

• Docker 19.03.13
• docker-compose 1.27.4
• Windows10 Pro

ディレクトリ構成

rails_test/
    ┝ Dockerfile
    ┝ docker-compose.yml
    ┝ Gemfile
    ┝ Gemfile.lock
    ┝ environments/
              └ db.env

Dockerfile

Dockerfile

FROM ruby:2.6

RUN apt-get update -qq && \
    apt-get install -y build-essential \
                       nodejs

RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
    echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
    apt-get update && apt-get install yarn

RUN mkdir /rails_test
WORKDIR /rails_test

ADD Gemfile /rails_test/Gemfile
ADD Gemfile.lock /rails_test/Gemfile.lock

RUN bundle install

ADD . /rails_test

• FROM Ruby2.6をプルします。
• RUN Railsに必要なNode.jsとyarnをインストール。 作業ディレクトリの作成。
• WORKDIR 作業ディレクトリの指定をします。
• ADD ローカルのGemfileとGemfile.lockをコンテナにコピーします。
• RUN バンドルインストールをします。
• ADD Gemfileをローカルに反映します。

今回webpackerを使うためにyarnをインストールするのポイントでした。

docker-compose.yml

今回のメインのdocker-compose.ymlの設定です。

docker-compose.yml

version: '3'
services: 
  app:
    build: .
    volumes: 
      - .:/rails_test
    command: bash -c "rm -f tmp/pids/server.pid && rails s -b 0.0.0.0"
    ports:
      - 3000:3000
    environment:
      WEBPACKER_DEV_SERVER_HOST: webpacker
    env_file: 
      - ./environments/db.env
    depends_on: 
      - db
  webpacker:
    build: .
    environment:
      NODE_ENV: development
      RAILS_ENV: development
      WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
    volumes: 
      - .:/rails_test
    command: ./bin/webpack-dev-server
    ports:
      - 3035:3035
  db:
    image: mysql:5.7
    volumes: 
      - rails-db:/var/lib/mysql
    env_file: 
      - ./environments/db.env
volumes: 
  rails-db:

各コンテナの設定を説明します。

app

app:
  build: .
  volumes: 
    - .:/rails_test
  command: bash -c "rm -f tmp/pids/server.pid && rails s -b 0.0.0.0"
  ports:
    - 3000:3000
  environment:
    WEBPACKER_DEV_SERVER_HOST: webpacker
  env_file: 
    - ./environments/db.env
  depends_on: 
    - db

Railsの設定です。

• volumes ローカルのディレクトリとマウントします。これによりコンテナ作成時にローカルでの変更点が反映されます。
• command サーバーを立ち上げています。ポイントとしてdocker-compose downでコンテナを削除した際にserver.pidがローカルに残るため再度コンテナを作成した際にサーバーが立ち上げられなくなるため最初にserver.pidを削除します。
• depends_on MySQLのコンテナとの起動順序を定義します。Railsが先に立ち上がるとDBと接続できないと怒られます。
• env_file ここではDBのユーザーネームなど定義します。今回はrootユーザーで行うためルートユーザーのパスワードだけ設定しておきます。
• environment webpackerの設定です。

webpacker

webpacker:
  build: .
  environment:
    NODE_ENV: development
    RAILS_ENV: development
    WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
  volumes: 
    - .:/rails_test
  command: ./bin/webpack-dev-server
  ports:
    - 3035:3035

Webpackerの設定です。ほとんど公式に書いてある通り(Github)にしただけなので、特に言うこともありませんがここでもvolumesをRailsと合わせておかないとwebpack-dev-serverが見つけられなくなります。

db

db:
  image: mysql:5.7
  volumes: 
    - rails-db:/var/lib/mysql
  env_file: 
    - ./environments/db.env
volumes: 
  rails-db:

MySQLの設定です。rails-dbという名前付きボリュームにてDBのデータを永続化しています。また設定は別に用意(db.env)しています。もしrootユーザーでなく新しいユーザーを作りたい場合にはdb.envに書き加えます。

/environments/db.env

MYSQL_ROOT_PASSWORD=password

とりあえずこれだけ書いておきます。

Gemfile

この二行だけ書き加えます。Gemfile.lockは何も書きません。

Gemfile

source 'https://rubygems.org'
gem 'rails', '6.0'

アプリ作成

まずはrails newをしてアプリを作ります。

$ docker-compose run --rm app rails new . --force -d mysql

ディレクトリを新たに作らずにDBはMySQLを使い、Gemfileのオーバーライドをするコマンドを入力しています。ここで自分はyarnを入れていなかったためにwebpackerが途中でインストールが止まりました。

database.ymlの設定

ローカルにできたdatabase.ymlファイルにdocker-compose.ymlで設定したものに書き換えます。

database.yml

default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <%= ENV.fetch('MYSQL_USER') { 'root' } %>
  password: <%= ENV.fetch('MYSQL_PASSWORD') { 'password' } %>
  host: db

development:
  <<: *default
  database: rails_test_development

test:
  <<: *default
  database: rails_test_test

production:
  <<: *default
  database: rails_test_production
  username: rails_test
  password: <%= ENV['RAILS_TEST_DATABASE_PASSWORD'] %>

defaultのところを書き換えています。今回MYSQL_USERとMYSQL_PASSWORDは設定していないのでrootとpasswordになりますが、db.envにて設定できるようにしています。

コンテナ起動

これでRailsがMySQLに接続できるようになりました。コンテナを全て起動しましょう。

$ docker-compose up -d

コンテナが3つ(app, db, webpacker)停止していなければ成功かと思われます。

$ docker ps
CONTAINER ID        IMAGE                  COMMAND                  CREATED             STATUS              PORTS                    NAMES
ab56f7caf110        rails_test_app         "bash -c 'rm -f tmp/…"   2 minutes ago       Up 2 minutes        0.0.0.0:3000->3000/tcp   rails_test_app_1
eb345957801c        mysql:5.7              "docker-entrypoint.s…"   3 minutes ago       Up 2 minutes        3306/tcp, 33060/tcp      rails_test_db_1
a64c29f979c1        rails_test_webpacker   "./bin/webpack-dev-s…"   13 minutes ago      Up 2 minutes        0.0.0.0:3035->3035/tcp   rails_test_webpacker_1

DB作成

最後にdb:createして http://localhost:3000 にてデフォルト画面が見れたら成功です。

$ docker-compose exec app rails db:create

所感

Qiitaの記事を見ながらコピペでやってできた気になっていましたが、改めて自分で書いてみるとMySQLに接続できなかったりWebpackerが起動できなかったりとトラブル続出でした。
また、node_modulesをコンテナの中に置いておくのってセンスが無い気もしました。何かいいアイデアがありそう。

とはいえひと月前までコピペでなんとなくやっていたところも大分自分の言葉で説明できるようになりました。
次は本番環境想定してnginxとの連携とかですかね...。

どうも。とある六本木一丁目にある会社のエンジニアです。
というわけで SmartHR Advent Calendar 2020 の5日目だぜ。

目的

弊社プロダクトのPDF出力に Thinreports を使用しているのでお友達になりたかった。

使うもの

Thinreports + Rails でやっていきます

ゴール

タイトルと本文がある書類をPDFで出力できるようにする！
簡単！

やっていこう

とりあえず rails new

rails new thinreports_demo --skip-test

gem 追加

gem 'thinreports'

bundle install

サンプルPDF出力する準備

ThinreportsでのPDF出力には tlf というフォーマットのデータが必要なので後々用意する必要があるので先にrails側の準備を整える

コントローラーを用意

rails g controller pdfs index sample_doc

sample_doc用にroutesを修正

routes.rb

Rails.application.routes.draw do
  root 'pdfs#index'
  resources :pdfs, only: :index do
    get :sample_doc, on: :collection
  end
end

views を修正

views/pdfs/index.html.erb

<h1>PDFにしてくれる君</h1>
<p>
  <%= link_to 'サンプル書類がみたい', sample_doc_pdfs_path %>
</p>

リンクにアクセスするとPDFを見れるようにしていく

Thinreports Editor で TLFファイル 作る

公式を見て Thinreports Editorのインストール（必要なら Generatorの方も）
Thinreports インストールガイド（公式）

何はともあれ Thinreports Editor を起動

新規作成から新しくA4の書類を作ります

後々のことを考えて

• タイトル
• 本文
• 著者

の３つを テキストブロックツール を使って作り出します

app/pdfs 以下に保存（ファイル名は任意で）

PDFとして出力する設定をしていく

pdfsコントローラーにPDFを出力するための設定をする
詳しくはここら辺のクイックスタート を参考にする

pdfs_controller.rb

class PdfsController < ApplicationController
:
:
  def sample_doc
    report = Thinreports::Report.new(layout: "#{Rails.root}/app/pdfs/sample_doc.tlf")

    report.start_new_page
    # さっき作った title に value つっこんでる
    report.page.item(:title).value('PDFやで')
    # title 以外はあとでやるのでここではスルーします

    file = report.generate
    send_data(
      file,
      filename: 'filename_sample.pdf',
      type: 'application/pdf',
      disposition: 'inline'
    )
  end
end

先ほどのリンクからアクセスすると PDF出てくる

やったね✌️

書類らしきものを作る

ここら辺は scaffold しましょう

• Doc
  • title
  • content
  • author

rails g scaffold doc title content:text author

rails db:migrate

新しく TLFファイル を複製

内容は sample_doc.tlf と同じでよいので もう一つ TLF作る（特に意味はないのでsample_doc.tlfを使い回しでいいと思います）

書類らしきものごとにPDF出力できるようにする

routes の修正

routes.rb

Rails.application.routes.draw do
  :
  :
  resources :docs do
    get :show_pdf
  end
  :
  :
end

コントローラー

docs_controller.rb

class DocsController < ApplicationController
  :
  :
  def show_pdf
    @doc = Doc.find(params[:doc_id])
    report = Thinreports::Report.new(layout: "#{Rails.root}/app/pdfs/doc.tlf")

    report.start_new_page
    # 以下で各カラムごとのデータを入れる
    report.page.item(:title).value(@doc.title)
    report.page.item(:content).value(@doc.content)
    report.page.item(:author).value(@doc.author)

    file = report.generate
    send_data(
      file,
      filename: "doc_#{@doc.id}.pdf",
      type: 'application/pdf',
      disposition: 'inline'
    )
  end
  :
  :
end

リンクも忘れず

views/docs/index.html.erb

<p id="notice"><%= notice %></p>

<h1>Docs</h1>

<table>
  :
  <tbody>
    <% @docs.each do |doc| %>
      <tr>
        :
        <td><%= link_to 'ShowPDF', doc_show_pdf_path(doc) %></td>
        # ☝️追加
        :
      </tr>
    <% end %>
  </tbody>
</table>

<br>

<%= link_to 'New Doc', new_doc_path %>

データを入れる

ダミーテキストジェネレータ とかを使ってデータ入れる

http://localhost:3000/docs/new から適当に

http://localhost:3000/docs はこんな感じ

完成！！（見た目は整える時間なかった！）
やったね✌️

まとめ

お友達になれました

　はじめに

この記事では、Stripeを用いた定期決済機能を実装します。
決済には、Ruby on RailsとCheckout Sessionを利用します。

　Stripeとは

決済サービスです。

WebサイトやWebアプリケーション、ネイティブアプリに決済システムを導入できます。似たようなサービスには、PayPal, Pay.JP, Omiseなどがあります。

Stripeは機能がとにかく豊富で、多彩な決済システムを構築できるのが特徴です。

　用語整理

Checkout
Stripeの決済ページには、Checkout と Elements の2つのタイプが用意されています。

Checkout：Stipeが用意した決済専用ページ。
Elements：決済フォームとシステムだけ用意され、決済ページはカスタマイズできる。

サクッと決済ページを作成したいときはCheckoutを利用するといいですね。定期決済、都度決済どちらにも対応しています。

Session ID
今回はセッションを用いた決済システムを構築します。こちらの決済システムでは、レスポンスにSession_idが返ってきます。
このSession_idにはcusntomer_id(顧客ID)やsubscription_id（定期決済ID）など、さまざまな決済情報が入っています。

　注意点

Stripeドキュメントに書かれているRubyコードの例は、主にSinatraで書かれているのでRailsではありません。

Sinatraとは、Rubyのフレームワークです。RubyのフレームワークはRailsだけではなくて、Sinatraもあります。以前StripeはRailsを使って例を出していましたが、、、現在ではSinatraに鞍替えしています。

RailsにSinatraを導入することはできないので、今回の実装では一部JavaScriptを利用しています。

　この記事でできること

• チェックアウトを用いた決済ページの作成
• 決済システムの構築
• session_idを活用

　準備

商品を作成するためにStripe Dashboardに入る必要があります。Stripeアカウントを持っていない方は、ここで作成しましょう。

本番環境ではなく、テスト環境で行うだけでしたらアカウントを有効にさせる必要はありません。今回作成する商品や、APIキーはテスト用のものですので、今回の実装も本番環境を使用することはありません。

すでに本番環境を有効にしている方
もしすでに有効にしている場合は、注意点があります。

ダッシュボードの左側に　View test data　もしくは　Viewing test data　と表示されている切り替えボタンがあると思います。View test dataとなっている時は本番モード、Viewing test dataとなっている時はテストモードです。

テストモードで実装を行いたい場合は、商品の作成からテストモードで行わなければなりません。本番モードの時に作成した商品は本番環境でしか、テストモードの時に作成した商品はテスト環境でしか使用できません。こちらはご注意ください。

商品の作成

商品の作成にはダッシュボード左側のProductsを選択します。

Add productを選択します。

最低限、名前と金額さえ選択できていれば、商品は作成できます。

One timeは一回限りの都度決済、Recurringは定期決済となります。

今回は毎月の定期決済を実装するので、Recurringを選択し、Billing perio（期間）はMonthlyと設定します。

設定が完了したら、右上のSave productをクリックします。

そうすると、PricingのところにAPI IDという蘭があり、そちらにはprice_idが発行されています。こちらが発行されていれば準備は完了です。

※補足

2020年8月27日以前のStripe APIのバージョンでは、定期決済の実装にはplan_idを用いていました。現在のバージョンではprice_idを用いるので、ご注意ください。

　実装

Gemをインストール

Gemfile

gem 'stripe'

APIのシークレットキーを設定

StripeダッシュボードのHomeに行くと、Get your test API keysという欄があります。そちらにあるSecret keyをRailsのディレクトリに記述します。

シークレットキーを記述するのにはcredentials.ymlを利用してもいいですが、今回はenvファイルを使って行います。

.env

STRIPE_TEST_SECRET_KEY = sk_test_xxxxxx

また、config/initializersの中にstripr.rbというファイルを作成し、その中にシークレットキーを設定します。

stripe.rb

Stripe.api_key = ENV['STRIPE_TEST_SECRET_KEY']

Paymentsコントローラーを作成する

名前はなんでもいいですが、今回はPaymentsと命名します。
メソッドはnew_subscriptionとcreate_subscriptionの2つを作成することにします。

payments_controller.rb

def new_subscription

    @session = Stripe::Checkout::Session.create({
      payment_method_types: ['card'],
      line_items: [{
        price: 'price_XXXX',
        quantity: 1,
      }],
      mode: 'subscription',
      success_url: request.base_url + '/payments/create_subscription?session_id={CHECKOUT_SESSION_ID}',
      cancel_url: request.base_url + '/payments/subscription1',
    })

  end

def create_subscription
end

ドキュメントにはsessionに@はついていませんが、viewにsession_idを渡す必要があるので、@を付けます。
priceの欄に、先ほどダッシュボード上で商品を作成したときに発行されたprice_idを入力します。

今はcreate_subscriptionメソッドに何も書かなくていいです。ただ、今の設定ですと決済完了した時にはこのメソッドに遷移するようになっているので、viewファイルにcreate_subscription.html.erbを作成し、決済完了したことがわかるように何か書くといいかなと思います。

create_subscription.html.erb

<p>できたよ</p>

決済画面を実装

new_subscription.html.erb

<script src="https://js.stripe.com/v3"></script>

<script>
var stripe = Stripe('pk_test_XXXX');
stripe.redirectToCheckout({
sessionId: '<%= @session.id %>'
}).then(function (result) {
});
</script>

Stripe('pk_test_XXXX')のカッコ内には、公開可能APIキーを入れてください。シークレットキーとは別のものなので、注意してください。先ほどシークレットキーを取得したStripeダッシュボードからPublishable keyをコピーし、貼り付けましょう。

ドキュメントでは決済画面に遷移する前にボタンが実装されていますが、ボタンが不要だと思ったので今回は省いています。ボタンが必要な方はドキュメントを参考にしてください。

試しに決済

これで決済画面ができたので、遷移してみましょう。

こちらの画面に、テストカードを利用して決済してみましょう。
テストカードには、カード番号に4242 4242 4242 4242と入力すれば、後の記入欄はなんでもいいです。

決済完了し、この画面になるとおそらく決済できたと思います。Stripeダッシュボードでも確認できます。

create.subscription.html.erbの画面↓

session_id

レスポンスにはsession_idが返ってきています。これは、決済ごとに発行されるIDです。

こちらのsession_idを取り出すと、色々な情報が出てきます。取り出し方は以下です。

session_idを取り出す

Stripe::Checkout::Session.retrieve(
  'cs_test_XXXX',
)

レスポンス

{
  "id": "cs_test_XXXX",
  "object": "checkout.session",
  "allow_promotion_codes": null,
  "amount_subtotal": null,
  "amount_total": null,
  "billing_address_collection": null,
  "cancel_url": "https://example.com/cancel",
  "client_reference_id": null,
  "currency": null,
  "customer": null,
  "customer_email": null,
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": "pi_XXXX",
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "setup_intent": null,
  "shipping": null,
  "shipping_address_collection": null,
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": null
}

この情報のどれかをDBに保存したい場合は、こちらから保存するといいかなと思います。例えば、customer_idを保存したい場合は以下のようになると思います。

payments_controller.rb

def create_subscription
  session = Stripe::Checkout::Session.retrieve(params[:session_id])
  Payment.create(customer_id: session.customer)
end

まとめ

StripeのAPIバージョンは2020年8月末で更新されています（おそらく）。このバージョンから仕組みが大きく変わっているところがあり、この日以前のQiitaの記事があまり参考にならない場合があります。例えば、price_idの登場だとか、ですね。

このバージョンの日本語記事が少なく、Stripeのドキュメントも英語で、かつドキュメントにあるRubyコードのサンプルはSinatra用となっているので、、Railsで実装をしようとすると難しい部分がありますね。

これからStripe系の記事もいくつか投稿していこうと思います。

参考資料

Stripeドキュメント: (Dynamic subscriptions の After 部分)
Stripe APIリファレンス: セッションを取得する
Qiita: Rails5.2でStripeを使う(v3)

はじめに

この記事は Rails Girls Japan Advent Calendar 2020 の4日目の記事です。

企画・運営に携わられている皆様お疲れ様です。
こういう企画があったら楽しいのではということで投稿いたしました。

もしも・・・SPA な Rails Girls があったら

元ネタは、去年のAdvent Calendarの Rails Girlsのカリキュラムをこうしていきたいみたいな提案 - Qiita です。
CRUDが基礎となるのはそうですし、日本的な基礎から入って応用へ行くメリットも分かりますが、最先端も面白い。
まあ、SPAって認識があれば初心者ではないと思いますが。

もしも・・・COBOL な Rails Girls があったら

女性IT技術者の大先輩と言えば、グレース・ホッパー - Wikipedia さん。
グレースさんが開発したCOBOLはいまだ現役で稼働しています。
勿論Railsも凄いのですが、COBOLも凄いので、イタコさんに憑依していただきグレースさんの開発苦労話など伺いたいものです。
イタコさんだったら日本語で語ってくれますよね？

もしも・・・パパ活 な Rails Girls があったら

Rubyのパパと言えば、まつもとゆきひろ - Wikipedia さん。
そのパパからプログラミングについて、直々カツ！をいただける、大変ありがたい話ではないですか。
勿論、いいプログラミングについては、ヨシ！を頂けます。

まとめ

いずれも、個人的に喜び勇んで参加したくなる企画ですね。

記事のきっかけ

初学者ながら自身のRailsアプリにCI/CDを入れるぞ❗️と考えました。
最近話題になっているGitHub Actionsってなんだろう❓
GitHubでCI/CDも管理できるらしい。凄い❗️
その気持ちから、他のCI/CDサービスと自分なりに比較選択をし、
GitHub Actionsを選択。実装に突き進みました。
本記事はその時のコード記録と実施内容の忘備録を兼ねて記事にしました。

アプリ開発環境

• Rails v6.0.3.4
• Ruby v2.6.6
• PostgreSQL v12.4
• Docker-compose v1.26.2
• Docker v19.03.12

GitHub Actionsとは

言わずも知れた開発管理必須ツールであるGitHub。
そのGitHubが提供するCI/CDサービス。
GitHubと高度に連携されており、設定によりGitHub上のコードを
自動でビルド・テスト・デプロイが可能。

なぜGitHub Actionsなのか？

私なりにCIを選ぶにあたって他のサービスと検討しました。
他のサービスもありますが、私が比較したのは下記の２つのサービスです。

• Circle CI
  SaaS型のCI/CDサービス。FacebookやCyberAgentでの活用事例がありCI/CDサービス大手
  QiitaでもCI/CDの記事が豊富にあり、アプリ作成事例での活用も多いイメージがあります。

• Code Pipeline
  AWSのCI/CDサービス。各種AWSとの連携ができるのが強み

私が選択した理由

①：GitHub Actionsの圧倒的なメリット点

GitHubのリポジトリの場所でCI/CDが実行・確認できる事です。
アプリ開発はGitHubは開発では必然的に使うのでこれは非常に便利です。
またAWSのリソースを触る場合においてアクセスキーを登録する必要がありますが
リポジトリ管理環境とAWSのアクセスキーを一度に管理できるのは、
AWSを使用したデプロイを想定している中で
リポジトリと外部SaaSでCI/CDの管理を分けるより、
進捗及び危機管理しやすい点があると考えました。

②：他のCI/CDとのサービス比較

• 上記でも触れましたが、Circle CIは外部SaaSへの権限移譲の問題などの下記資料も検証し
  ＊GitHub Actions の self-hosted runner と Amazon EKS を使った Docker の Build Pipeline
  (freee株式会社)
  今後の実務の中でもこの事は問題になる可能性があるなら、CI/CDとして最初に使うのは
  GitHub Actionsでもいいのではないか？と考えました。

• Codepipelineとの比較では今回はAPI側の変更作業が多くなる事が予想されたので
  GitHub上でCI/CDを随時実行し確認できた方が作業効率がいいと思われました。

以上を総合判断し、最終的にGitHub Actionsを使用する事としました。

ただこれは初心者が考えた事ですので、間違いやそれぞれのCI/CD側の言い分があるかもしれません。
Circle CIはGithub Actionsより優れていると宣伝してますし(そんな堂々と・・。）
CodepipelineもAWSとの連携をする中では大きなメリットを享受出来る事と思います。

GitHub Actions 作成手順・コード

前置きが長くなりました。早速GitHubActionsでのCI/CDを作成して行きます。
公式サイトは下記のリンク先となります。
GitHub Actionsのドキュメント

1. 作成リスト

今回RailsでのアプリでCI/CDを組み立てます。

• .github/workflows ディレクトリ配下（新規作成）
  • linter.yml
  • rspec_security.yml
  • main.yml
• database.yml （修正）

2.CIセッティング

今回のCIは2種類でセッティングしました。
1. Linter　（トリガー：GitHubにpushした時）
2. RSpec, security (トリガー：GitHubにpushした時　及び　pull_request時）

linter.yml

name: Linter
on: [push]

jobs:
  linters:
    name: Linters
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 2.6

      - name: Ruby Bundler
        uses: actions/cache@v2
        with:
          path: vendor/bundle
          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-gems-
      - name: Bundle install
        run: |
          bundle config path vendor/bundle
          bundle install --jobs 4 --retry 3
      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - name: yarn install
        run: yarn install

      - uses: actions/cache@v2
        id: yarn-cache 
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-
      - name: Run linters
        run: |
          bundle exec rubocop --parallel

rspec_security.yml

name: Rails RSpec and security
on: [push, pull_request]
env:
  RAILS_ENV: test
  CI_HOST: localhost

jobs:
  build:
    runs-on: ubuntu-latest

    services:
      postgres:
        image: postgres:12
        ports:
          - 5432:5432
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

      chrome:
        image: selenium/standalone-chrome
        ports:
          - "4444:4444"
        volumes:
          - /dev/shm:/dev/shm

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 2.6

      - name: Ruby Bundler
        uses: actions/cache@v2
        with:
          path: vendor/bundle
          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-gems-
      - name: Bundle install
        run: |
          bundle config path vendor/bundle
          bundle install --jobs 4 --retry 3

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - name: yarn install
        run: yarn install

      - uses: actions/cache@v2
        id: yarn-cache 
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Setup test database
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
        run: |
          bundle exec rake db:create db:schema:load --trace

      - name: run rspec
        run: bundle exec rspec
        env:
          SELENIUM_REMOTE_URL: http://localhost:4444/wd/hub

      - name: Archive rspec result screenshots
        if: failure()
        uses: actions/upload-artifact@v2
        with:
          name: rspec result screenshots
          path: tmp/screenshots/

      - name: security check
        run: |
          bundle exec bundle-audit check --update
          bundle exec brakeman -q -w2

CD (ECR自動デプロイ）

CDはECRへのコンテナbuild＆pushを行うセッティングです。
今回の設定でのトリガーはtag pushのversion(v)で実行しております。

main.yml

name: Build and Push

on:
  push:
    tags:
      - v*

jobs:
  build-and-push:
    runs-on: ubuntu-18.04
    timeout-minutes: 300

    steps:
      - uses: actions/checkout@v1

      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ap-northeast-1

      - name: Login to Amazon ECR
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v1

      - name: Build, tag, and push image to Amazon ECR
        env:
          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          ECR_REPOSITORY: ${{ secrets.AWS_ECR_REPO_NAME }}
        run: |
          IMAGE_TAG=$(echo ${{ github.ref }} | sed -e "s#refs/tags/##g")
          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG

database.yml

環境変数のセッティングが必要となります。
テスト部にENV.fetchで第一引数で指定した環境変数を確認し、
なければブロックで定義したデフォルト値が帰るようにしています。

database.yml

default: &default
  adapter: postgresql
  encoding: utf8
  min_messages: WARNING
  host: db
  port: 5432
  username: postgres
  password: postgres
  pool: 5
  timeout: 5000
  stats_execution_limit: 10

development:
  <<: *default
  database: development

test:
  <<: *default
  database: test
  host: <%= ENV.fetch('CI_HOST') { 'db' } %>

production:
  <<: *default
  database: myworkdb
  host: <%= ENV['DB_URL'] %>
  username: <%= ENV['DB_USERNAME'] %>
  password: <%= ENV['DB_PASSWORD'] %>

CI/CD内容

CI

• Linter.yml
  コード内容としては rubocop でのLinterチェックとしました。
  ローカル開発環境ではrubocop prettier beautify の３種を併用しておりますが、
  push前のLinter整形忘れチェックとしてpush時にチェックする対応で対応しました。
  
  ＊ローカル環境下でのLinterセッティングについては下記記事にまとめております。
  よろしければご参照下さい。
  "Rails"でのフォーマット環境を整える（VScode）
  

• RSpec, security

  • テストはRailsの定番RSpecを走らせました。
  • セキュリティは Gemの脆弱性診断bundle-auditと総合セキュリティbrakemanを活用しました。
    
    ＊Railsのセキュリティに関しては別記事でまとめております。
    よろしければご参照下さい。
    Rails6のセキュリティチェック環境を整える

CD

セッティングコードはClassmethodさんの下記の記事を参考にしました。
この記事のおかげで以後の開発が凄く捗りました。ありがとうございます。

• 参考元リンク：GitHub ActionでDockerコンテナをビルドしてAmazon ECRに保存する
  （Developers.io Classmethod株式会社）

最後に

最後まで読了頂きありがとうございます。
少しでも資料がどなたかの役に立てれば幸いです。
また今回GitHub Actionsの詳細な設定内容（コード）については触れておりませんので
別記事でGitHub Actionsの設定について個人的にまとめたいと思っております。

Mysql2::Error: Field 'tag_name' doesn't have a default value
とは、NOT NULL制約をかけているにも関わらず値が入っていないよーといった感じのエラーです

class CreateTags < ActiveRecord::Migration[6.0]
  def change
    create_table :tags do |t|
      t.string :name,null:false
      t.timestamps
    end
  end
end

とかでカラムに,null: falseで必ず値が入るように設定していたと思います

なので、rails側でも

validates :name,presence: true

と、バリデーションをかけていたと思います。

というわけで、まず考えられる原因が

マイグレーションファイルでnull: falseとNOT NULL制約を設けていたにも関わらず、Rails側でバリデーション をかけていなくて、form_withとか何とかで、値を保存しようとした！！

といったことが考えられます。

しかし自分は違いました、バリデーション もかけている

[しくじった原因１： ストロングパラメーターの記述が間違ってる]

{"authenticity_token"=>"T8/aOv7fmGDk6UO/GHiYkODYvpMTH/3tFP6sCW0QPVVaAVh6ZHcAd2xaTQzcuioVXdOOWYAFNHO8u3S0OmnG6Q==",
 "drink_tag"=>
  {"tag_name"=>"酸味",
   "image"=>
    #<ActionDispatch::Http::UploadedFile:0x00007f8a24b3d318
     @content_type="image/jpeg",
     @headers="Content-Disposition: form-data; name=\"drink_tag[image]\"; filename=\"ethiopia.jpg\"\r\n" + "Content-Type: image/jpeg\r\n",
     @original_filename="ethiopia.jpg",
     @tempfile=#<File:/var/folders/34/pbcy_n7j1q79hnpm7sbcgl0m0000gn/T/RackMultipart20201204-1452-13ocgpk.jpg>>,
   "name"=>"エチオピア",
   "explain"=>"酸味があってアイスもおすすめ！！",
   "price"=>"1000"},
 "commit"=>"投稿する"}

と、パラメーターがとんでいて

  private
  def drink_params
    params.require(:drink_tag).permit(:name,:price,:explain,:image,:tag_name).merge(user_id: current_user.id)
  end

とストロングパラメーターを書くのが正しいですが

自分の場合、ストロングパラメータくらい分かったつもりになって教材をコピペしたせいで,

  private
  def drink_params
    params.require(:tweet_tag).permit(:name,:price,:explain,:image,:tag_name).merge(user_id: current_user.id)
  end

と、

params.require(:drink_tag)

を

params.require(:tweet_tag)

にしていました、、、。

ストロングパラメーターが間違っていたら
正しい値を許容できていないので

  def create
    @drink = DrinkTag.new(drink_params)

    if @drink.save
      redirect_to drinks_path
    else
      render 'new'
    end
  end

の@drinkは空,nilなので、
nilな物を保存すんな！って怒られてしまいます、、、。
form_withの使い方はあってたので、しっかりとしたパラメーターが作られて
railsのバリデーションの網はかいくぐったようですが、MySQLちゃんがしっかりと値の保存を防いでくれました、、、。

[しくじった原因2: Formオブジェクトを用いた値の保存で、一度に保存するためのmodelの記述が間違ってる！]

Formオブジェクトとは、一つのビューで複数の値を保存したいときに用いられるテクニック?的なものです。
( 詳しくは検索、検索♪)

class UserDonation

  include ActiveModel::Model
  attr_accessor :name, :name_reading, :nickname, :postal_code, :prefecture, :city, :house_number, :building_name, :price

   with_options presence: true do
    validates :name, format: { with: /\A[ぁ-んァ-ン一-龥]/, message: "は全角で入力してください。"}
    validates :name_reading, format: { with: /\A[ァ-ヶー－]+\z/, message: "は全角カタカナで入力して下さい。"}
    validates :nickname, format: { with: /\A[a-z0-9]+\z/i, message: "は半角英数で入力してください。"}
  end

  def save


    user = User.create(name: name, name_reading: name_reading, nickname: nickname)


    Address.create(postal_code: postal_code, prefecture: prefecture, city: city, house_number: house_number, 
    building_name: building_name, user_id: user.id)

    Donation.create(price: price, user_id: user.id)
  end

end

と、一つのビューで複数のテーブルに値を保存したい時に、こういったモデルをよく作りますが

saveメソッドでのキー、バリューの書き忘れ！！！

で自分はつまずきました、、、。

この定義したsaveメソッドはあとでコントローラーで

 def create
   @donation = UserDonation.new(donation_params)

   if @donation.valid?
     @donation.save  # バリデーションをクリアした時
     return redirect_to root_path
   else
     render "new"    # バリデーションに弾かれ時
   end
 end

とsaveメソッドを用いますが、

例えば、

  def save


    user = User.create(name: name, name_reading: name_reading, nickname: nickname)


    Address.create(postal_code: postal_code, prefecture: prefecture, city: city, house_number: house_number, 
    building_name: building_name, user_id: user.id)

    Donation.create(price: price, user_id: user.id)
  end

で、

Address.create(postal_code: postal_code, prefecture: prefecture, city: city, house_number: house_number,
building_name: building_name, user_id: user.id)


の

postal_code: postal_code


が抜け落ちてたら、このエラーが起きます、、、。
なので、しっかりsaveメソッドが定義できてるかみましょう！！

これもフォームで入力して、しっかりパラメーターが作られるので、railsのバリデーション の
網を抜けたのでしょうが、データベース側でも「nilはだめ！！」としていたので、助かりました、。

　まとめ

バリデーション をかけているにもかかわらず、このエラーが起きるということは、モデルかコントローラーに
何かしらの問題がある。

もっというと、コントローラーは、createで値を保存するので、
ストロングパラメーターに問題があったり、

formオブジェクトはmodelにsaveメソッドを定義してるので、saveメソッドに問題が
ないか確かめましょう、、、！！！

他にもこのエラーに対する考えられる原因と、それの対処法があればコメントお願いします！！

はじめに

CBcloud Advent Calendar 2020 の2日目の記事です。

本記事では、メール送信の単体テストの際、ActionMailer が依存している Mail に含まれている Mail::Matchers を RSpec のマッチャとして利用する方法を紹介します。

また、比較対象として、以下の2つも同時に記載します。

1. Rails Guides に記載されているテスト方法
2. RSpec のドキュメントに記載されているテスト方法

最後に、Mail::Matchers を使った例の紹介と、実際に動くサンプルコードを添付します。

動作確認環境

• ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
• actionmailer (6.0.3.4)
• rspec (3.10.0)

テストコード

Rails Guides に記載されているテスト方法

https://guides.rubyonrails.org/testing.html#testing-your-mailers

require 'test_helper'

class UserMailerTest < ActionMailer::TestCase
  test "invite" do
    # Create the email and store it for further assertions
    email = UserMailer.create_invite('me@example.com',
                                     'friend@example.com', Time.now)

    # Send the email, then test that it got queued
    assert_emails 1 do
      email.deliver_now
    end

    # Test the body of the sent email contains what we expect it to
    assert_equal ['me@example.com'], email.from
    assert_equal ['friend@example.com'], email.to
    assert_equal 'You have been invited by me@example.com', email.subject
    assert_equal read_fixture('invite').join, email.body.to_s
  end
end

RSpec のドキュメントに記載されているテスト方法

https://relishapp.com/rspec/rspec-rails/v/3-9/docs/mailer-specs/mailer-spec

require "rails_helper"

RSpec.describe NotificationsMailer, :type => :mailer do
  describe "notify" do
    let(:mail) { NotificationsMailer.signup }

    it "renders the headers" do
      expect(mail.subject).to eq("Signup")
      expect(mail.to).to eq(["to@example.org"])
      expect(mail.from).to eq(["from@example.com"])
    end

    it "renders the body" do
      expect(mail.body.encoded).to match("Hi")
    end
  end
end

Mail::Matchers を使ったテスト方法

ActionMailer の依存で Mail gem は既にインストール済みなので、導入手順は簡単です。

• RSpec の設定で、 Mail::Matchers を include する
• ActionMailer のテストで Mail::Matchers が提供するマッチャを使う

以下が実際に Mail::Matchers を使って書いたコードです。
比較のため、最初のコンテキストでは先述した RSpec のドキュメントに記載されたサンプルを踏襲したコードを実装しています。

RSpec.configure do |config|
  config.include Mail::Matchers, type: :mailer
end

RSpec.describe NotificationsMailer, type: :mailer do
  before do
    ActionMailer::Base.deliveries.clear
  end

  describe '#signup' do
    # @see: https://relishapp.com/rspec/rspec-rails/v/3-9/docs/mailer-specs/mailer-spec
    context 'when using RSpec mailer examples' do
      subject(:mail) { described_class.signup }

      it 'renders the headers' do
        expect(mail.subject).to eq('Signup')
        expect(mail.to).to eq(['to@example.org'])
        expect(mail.from).to eq(['from@example.com'])
      end

      it 'renders the body' do
        expect(mail.body.encoded).to match('Hi')
      end

      it 'sends the mail' do
        expect { mail.deliver_now }.to change { ActionMailer::Base.deliveries.count }
      end
    end

    # @see: https://github.com/mikel/mail#using-mail-with-testing-or-specing-libraries
    context 'when using Mail::Matchers' do
      subject(:mail) { described_class.signup.deliver_now }

      it { is_expected.to have_sent_email }
      it { is_expected.to have_sent_email.from('from@example.com') }
      it { is_expected.to have_sent_email.to('to@example.org') }
      it { is_expected.to have_sent_email.with_subject('Signup') }
      it { is_expected.to have_sent_email.with_body('Hi') }
    end
  end
end

メール送信後のマッチャが全て have_sent_email に集約されているのがわかりますね。
ここで紹介したもの以外にも、添付ファイルに対するマッチャなど、メールのテストに必要なものが一通り揃っているので、ぜひドキュメントを確認して使ってみてください。
https://github.com/mikel/mail#using-mail-with-testing-or-specing-libraries

最後に

ここまで読んで、実際に自分で試してみたいと思われた方のために、動くサンプルコードを Gist で公開しています。
https://gist.github.com/tomohiro/dfa7362cd066dd87f25f40bdd6856513

実行例:

余談

個人的には --format documentation で出力したときの表現が冗長に感じています。

　参考資料

• Testing Rails Applications — Ruby on Rails Guides
• mailer spec - Mailer specs - RSpec Rails - RSpec - Relish
• mikel/mail: A Really Ruby Mail Library

初心者です。備忘録のため。残します。
超基本的な内容です。

エラー内容

Sprockets::DoubleLinkError

Rails にて erb ファイルを作成して、表示しようとしたら上記発生。ターミナル確認すると以下記述あり。

ActionView::Template::Error (Multiple files with the same output path cannot be linked ("style.css")
In "/Users/○○/git/photo_submission/app/assets/config/manifest.js" these files were linked:
  - /Users/○○/git/photo_submission/app/assets/stylesheets/style.css
  - /Users/○○/git/photo_submission/app/assets/stylesheets/style.scss
):

原因

調べてみたら、Rails は rails new したときに自動で作成される views/layauts/application.html.erb を参照して HTML ファイルを作るようです。

Sprocketsの仕組み - Qiita

Rails初学者がつまずきやすい「アセットパイプライン」

assets ファイル以下のデータ群を一つに圧縮する（アセットパイプライン）。

views/layauts/application.html.erb

<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>

　あとで erb ファイルに変更しようと思って、先に普通の HTML ファイルで作成しており、深く考えずに style.scss を作成していた。VSCode の拡張機能の Live Sass Compiler でstyle.css も自動で作成されており、これがエラーの原因。

assets/stylesheets/application.css に style.scss の記述を写し、stylesheets 直下には application.css だけ残すようにファイルの構造を調整して、再度出力すると問題なく表示できた。

やったこと

• bundler
• if, case, Array.each

if, case, Array.each

条件分岐を取り扱おうということだ

お題

入力された年数がleap year(うるう年)かどうかを判定する
プログラミングの実習でよくある課題だが、条件分岐が複雑

まず4の倍数かどうかを判定する

入力部は

p year = ARGV[0].to_i

to_iとはIntegerであるということを示すものらしい

if year%4==0 then
  p true
else
  p false
end

最初の条件分岐文がこちら。yearを入力として、それを4で割った余りが0ならtrue、そうじゃなければfalseだぞ、と出力するこれを実行すると

> ruby check_leap.rb 2004
2004
true

1997の場合は

> ruby check_leap.rb 1997
1997
false

となる

特殊な年数の場合をはじいていく

100で割り切れる年はうるう年でなく、400で割り切れる年はうるう年であるという二点を判定できるようにする
こういう例外処理は先に済ませておこうと思う。また、長くなってきたのでmethodにしておく

p year = ARGV[0].to_i
def leap?(year)
  if year % 400 ==0
    p true
  elsif year % 100 ==0
    p false
  elsif year % 4 == 0
    p true
  else
    p false
  end 
end
leap?(year)

これを実行すると

> ruby check_leap.rb 1900
1900
false

2000の場合は

> ruby check_leap.rb 2000
2000
true

となった。100の倍数だが400の倍数でない1900と、100の倍数かつ400の倍数である2000を区別できている

array, eachを使う

大量の値を一気にテストしたいときにはarray(配列)が便利。

def leap?(year)
  if year % 400 ==0
    p true
  elsif year % 100 ==0
    p false
  elsif year % 4 == 0
    p true
  else
    p false
  end
end
[1900,1997,2000,2004].each do |year|
　p year
  leap?(year)
end

実行すると

> ruby check_leap.rb
1900
false
1997
false
2000
true
2004
true

正しく判定されてますね

case

授業中では扱ってなかった気がするけどcaseを使うとさらにコードのrefactoringが可能
caseを使って先ほどのコードを書きなおして

def leap?(year)
  case
  when year % 400 ==0 ; return true
  when year % 100 ==0 ; return false
  when year % 4 ==0 ;   return true
  else                  return false
  end
end
[1900, 1997, 2000, 2004].each do |year|
  p year
  leap?(year)
end

で動くかと思ったら

> 1900
> 1997
> 2000
> 2004

となり、判定が行われていない？？？(red)
と思ったけどleap?(year)の結果が出力がされてないじゃん、ということで

p leap?(year)

として動かすと

> 1900
> false
> 1997
> false
> 2000
> true
> 2004
> true

よかった、プログラムは短くなったしgreen状態にできた

参考記事

• チャート式ruby-III(if, case, Array.each by leap year)

---

• source ~/MasahiroOba/grad_members_20f/members/MasahiroOba/chapter7.org

やったこと

• bundler
• if, case, Array.each

if, case, Array.each

条件分岐を取り扱おうということだ

お題

入力された年数がleap year(うるう年)かどうかを判定する
プログラミングの実習でよくある課題だが、条件分岐が複雑

まず4の倍数かどうかを判定する

入力部は

p year = ARGV[0].to_i

to_iとはIntegerであるということを示すものらしい

if year%4==0 then
  p true
else
  p false
end

最初の条件分岐文がこちら。yearを入力として、それを4で割った余りが0ならtrue、そうじゃなければfalseだぞ、と出力するこれを実行すると

> ruby check_leap.rb 2004
2004
true

1997の場合は

> ruby check_leap.rb 1997
1997
false

となる

特殊な年数の場合をはじいていく

100で割り切れる年はうるう年でなく、400で割り切れる年はうるう年であるという二点を判定できるようにする
こういう例外処理は先に済ませておこうと思う。また、長くなってきたのでmethodにしておく

p year = ARGV[0].to_i
def leap?(year)
  if year % 400 ==0
    p true
  elsif year % 100 ==0
    p false
  elsif year % 4 == 0
    p true
  else
    p false
  end 
end
leap?(year)

これを実行すると

> ruby check_leap.rb 1900
1900
false

2000の場合は

> ruby check_leap.rb 2000
2000
true

となった。100の倍数だが400の倍数でない1900と、100の倍数かつ400の倍数である2000を区別できている

array, eachを使う

大量の値を一気にテストしたいときにはarray(配列)が便利。

def leap?(year)
  if year % 400 ==0
    p true
  elsif year % 100 ==0
    p false
  elsif year % 4 == 0
    p true
  else
    p false
  end
end
[1900,1997,2000,2004].each do |year|
　p year
  leap?(year)
end

実行すると

> ruby check_leap.rb
1900
false
1997
false
2000
true
2004
true

正しく判定されてますね

case

授業中では扱ってなかった気がするけどcaseを使うとさらにコードのrefactoringが可能
caseを使って先ほどのコードを書きなおして

def leap?(year)
  case
  when year % 400 ==0 ; return true
  when year % 100 ==0 ; return false
  when year % 4 ==0 ;   return true
  else                  return false
  end
end
[1900, 1997, 2000, 2004].each do |year|
  p year
  leap?(year)
end

で動くかと思ったら

> 1900
> 1997
> 2000
> 2004

となり、判定が行われていない？？？(red)
と思ったけどleap?(year)の結果が出力がされてないじゃん、ということで

p leap?(year)

として動かすと

> 1900
> false
> 1997
> false
> 2000
> true
> 2004
> true

よかった、プログラムは短くなったしgreen状態にできた

参考文献

• チャート式ruby-III(if, case, Array.each by leap year)

---

• source ~/MasahiroOba/grad_members_20f/members/MasahiroOba/chapter7.org

結論

シェルの確認
↓
.zshrcファイルの作成
↓
eval "$(rbenv init -)"
export PATH="~/.rbenv/bin:$PATH"
export PATH="~/.rbenv/bin:~/.rbenv/shims:$PATH"
の三行を追加
↓
source ~/.zshrc

環境

• Mac

問題点

$ curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash

を実行すると、

Checking for `rbenv' in PATH: /usr/local/bin/rbenv
Checking for rbenv shims in PATH: not found
  The directory `/Users/ユーザー名/.rbenv/shims' must be present in PATH for rbenv to work.
  Please run `rbenv init' and follow the instructions.

Checking `rbenv install' support: /usr/local/bin/rbenv-install (ruby-build 20201118)
Counting installed Ruby versions: none
  There aren't any Ruby versions installed under `/Users/ユーザー名/.rbenv/versions'.
  You can install Ruby versions like so: rbenv install 2.2.4
Checking RubyGems settings: OK
Auditing installed plugins: OK

となり、

Checking for rbenv shims in PATH: not found

この部分のパスが通っていないこと。

解決法

rbenv shimsの環境パスの設定が正しくできていない、とのことなので
.bash_profile内で、

export RBENV_ROOT="$HOME/.rbenv"
if [ -d "${RBENV_ROOT}" ]; then
  export PATH="$HOME/.rbenv/bin:$PATH"
  eval "$(rbenv init -)"
fi

を記述する。これで再度確認するとOK！になるのだが、ターミナルを再起動するとまた

Checking for rbenv shims in PATH: not found

のエラーになる。

ここからが具体的な解決法。
今現在シェルがzshになっている。その上で、bash_profileファイル内に記述したのだがそれではターミナルを起動するごとにsource ~/.bash_profileをする必要がある。
結論として新たにzshrcファイル（zsh_profileファイルでもいい）を作成し、同じような記述をするとターミナルを再起動してもパスが通っている状態になっている。

はじめに

PORT Advent Calendar 2020 の4日目の記事です！

はじめまして！　PORT新卒エンジニアのしゅんいち(shxun6934) です！

業務でのとあるタスクにて、Railsを使用してWebAPIを実装することになりました。
今までは、WebAPI（QiitaとかTwitterとかお世話になりました。）を使用する側でしたが、WebAPIを作成する側になったので、いろいろわからないところが多かったです。

簡単にですが、そのタスクに臨むにあたって学んだこと、意識していたことを皆さんに共有しておきたいと思います。

そもそも、APIって何？

API(Application Programming Interface) は、アプリケーションとアプリケーション、人、組織をつなげてくれるものです。

APIと言っても種類はいくつかあります。
（例：Twitterから「いいね」の情報を取得するためのもの、iOSアプリでカメラの機能を使用するためのもの、画像の色を反転させるためのもの、などなど。。。）

一般的に言われている「API」は、WebAPIを指すことが多いです。

WebAPIは、ネットワークを使用して他のアプリケーションと通信する APIのことです。

RESTful API

RESTの原則に従ったAPI。

ここで思うことは、「RESTって何???」

簡単に言うと、RESTは複数のソフトウェアを連携させるための設計原則の考え方のことです。
RESTの原則は以下の4つ。

URIを通して提供できる情報が表現できていること = アドレス可能性
インターフェースが統一されていること = 統一インターフェース
やり取りする情報で全てを完結させること = ステートレス性
情報の内部に別の情報や状態へのリンクを含めることができること = 接続性

これらに従って設計すれば、使いやすくAPIになります。

では、実際にWebAPIで意識することを見ていきます。

URI

WebAPIなので、URIは必須になります。

ここでは、REST原則のアドレス可能性が鍵になります。
URIはユーザーが実際に入力するものなので、わかりやすく、どんな機能を持つURIがひと目でわかるようにしたほうがベストです。

例として、犬の種別の一覧を取得するAPIを設計します。

GET https://example.com/api/get-dogs-type-all-list

これでは、読みにくく、直感的ではありません。（何の機能なのかはなんとなくわかる気がする。。。）

dogsとtypeが同列に並んでいるので、階層的にわかりづらいですし、listとallでは意味がほぼ同じなので、重複してます。
また、WebAPIを使用するユーザーが想定なので、URIにわざわざgetという単語を入れなくてもいいです。（後述のHTTPメソッドより）

なので、階層的にわかりやすく、シンプルにしたほうが使いやすそうですね。
以下のように修正します。

GET https://example.com/api/dogs/type/list

dogsのtypeのlistを取得できると直感的にわかるようになったと思います。（多分）

HTTPメソッド

REST原則の統一インターフェースに一番密な要素です。
標準化されたHTTPメソッドの個々の役割を理解して、それらをどのAPIでも適用するものです。

基本的なHTTPメソッドは、以下。

HTTPメソッド	役割
GET	リソースを取得する、検索する
POST	リソースを作成する、追加する
PUT	リソースのデータを更新する
DELET	リソースを削除する

もし、POSTで「リソースのデータを更新する」役割をも持たせたとして、
記事を投稿するAPIと記事の内容を更新するAPIがあったとします。

2つのAPIを以下のように設計します。

POST /api/articles
POST /api/articles/:article_id

上記の設計だと、同じアプリケーションに「リソースを作成する」POSTと「リソースのデータを更新する」POSTが存在してしまいます。

これでは、POSTに関して同じ意味をなさなくなるので、インターフェースが統一されていないことになり、使いづらいAPIになってしまいます。

この例では、HTTPメソッドの役割に沿って、記事の内容を更新するAPIはPUTで行うようにしたほうがいいと思います。

HTTPレスポンス

APIを使用して返ってくるものにもしっかりと制約をつけ、インターフェースを統一しましょう。
(HEADは割愛させていただきます。すいません。)

ステータスコード

200とか、404とか、500とかのあれです。
ステータスコード単体でも意味を成しているので、HTTPメソッド同様、理解する必要があります。

よく目にするステータスコードは以下。

ステータスコード	意味
200	リクエストが成功した
201	リクエストが成功し、リソースが新規作成された
400	リクエストパラメータに不足・不備があった
401	アクセストークンが無効、認証されていない
404	リクエストされたリソースが存在しなかった
500	何らかのエラーがサーバー側で発生している

WebAPIの設計において、基本的には想像しうる状態を全て網羅しなくてはいけません。
網羅した上で、必要なステータスコードはなんなのかを考えていきましょう。

ボディ

ユーザーが実際に扱うデータのフォーマットや構造を考えて置く必要があります。

最近のWebAPIは、JSONで返すことが多いです。JSONのフォーマットにしたがっていけば問題なさそうですね。

レスポンスのボディは2種類あると思います。
リクエストが成功した場合とリクエストが失敗した場合です。

リクエストが成功した場合

ユーザーが欲しい情報をJSONのフォーマットに沿って構造化していきます。

今回、個人的に意識したことは、階層構造です。

例として、ユーザー一覧を取得するAPIのJSONを考えます。
ユーザーを取得する際に、住所の情報も欲しいとします。

もし、住所の情報に、prefectureとcityが欲しいとき、
以下のように階層ごとにグループ化することで、わかりやすく、データもまとまります。

users.json

{
  {
    "id": 1
    "first_name": "AAAA",
    "middle_name": null,
    "last_name": "BBBB",
    "sex": "man",
    // 住所として一つのグループにする。
    "address": {
      "prefecture": "東京都",
      "city": "新宿区"
    },
    "favorite_tags": ["Ruby", "Rails", "WebAPI"]
    "url": "https://example.com/users/1"
  },
  {
    "id": 2
    "first_name": "CCCC",
    "middle_name": "1111",
    "last_name": "DDDD",
    "sex": "woman",
    // 同列だとわかりづらい
    "prefecture": "東京都"
    "city": "渋谷区"
    "favorite_tags": []
    "url": "https://example.com/users/2"
  },
}

リクエストが失敗した場合

ユーザーに何のエラーなのか、どうして起きたのかを正しく提供しなくてはいけません。

ユーザー一覧を取得するAPIのパラメーターに、ソートをかけるとします。（例：favorites_tagsで"Ruby"を持っているユーザーの一覧)

ここで間違えて、"Ruby"ではなく、数字を入れてしまったときのレスポンスは、
以下のようにする必要があると思います。

https://example.com/api/users?favorites_tags=65847

{
  "message": "Invalid Request",
  "errors": [
    {
      "type": "bad_type",
      "message": "favorites_tags is String, is not Integer"
    }
  ]
}

エラーが複数存在する場合は、グループ化して、わかりやすくするのも一つの手ですね。

Railsでは、、、

Webアプリを作成するために最適なRailsでも当然、WebAPIの実装はできます。

RailsでのAPI実装

Railsには、APIモードなるものが存在していて、プロジェクトを新規作成する場合は、

$ rails new my_api --api

でAPIモードになります。

また、既存のアプリをAPI専用にしたい場合は、config/application.rbにて

config/application.rb

config.api_only = true

を設定するとできるみたいです。（超便利！！）

ただ、今回は既存のプロジェクトの一部でAPIが実装されているので、上二つのやり方はできませんでした。

RailsのAPI実装の特徴は、APIモードではない、いつも通りのRailsとあまり変わらずに実装することができることです。

MVCのView層が使用されないくらいで、あとは同じ感じでコードを書けるので、楽にかけます。
ただ、APIではいつもよりも制限がかかっているので、仕様については理解しないといけないところがあります。

今回の実装で詰まった、ActionController::APIを簡単に説明します。

ActionController::API

APIモードにする際に、app/application.rbを以下のように変更する必要があります。

app/application.rb

# ActionController::Base → ActionController::APIに変更する。
class ApplicationController < ActionController::API
end

これでAPI専用になるのですが、、、
このActionController::APIは、ActionController::BaseをAPI専用にしたものであることを認識しないといけませんでした。

上記でいつも通りに開発できると言いましたが、厳密には少し違います。

このActionController::APIのリファレンスのこの部分。

Keep in mind that templates are not going to be rendered

APIモードでも、renderメソッドでhtmlやxmlのフォーマットを指定すれば、読み出せます。しかし、templateの読み出しはできないため、jsonをviewとして扱うことが結構難しくなっています。

まとめ

APIを実装する上では、ユーザー目線に立つことが何よりも大事だと思いました。
実際に使う人の目線に立って、使いづらくないか、わかりやす構造になっているかを気にしてAPIを組み立てていく必要があると思います。

RailsでWebAPIを実装するときは、ドキュメントを読んで仕様を理解する必要があります。
便利な機能が揃っていて、ブラウザ向けアプリケーションの開発とあまり大差ないので楽にかける分、ブラウザ向けアプリケーションでできていたことができないことみたいな制約もあるので、注意が必要です。

参考

以下、参考にしたもの。

書籍

Web APIの設計

サイト

Rails API

Rails による API 専用アプリケーション

Rails における JSON のシリアライズと向き合う

Rails での JSON API 実装まとめ

API設計

翻訳: WebAPI 設計のベストプラクティス

RESTful APIとは何なのか

リソース指向アーキテクチャ(ROA)とは何なのか

RESTful APIのURI設計(エンドポイント設計)

RESTful APIのリソース設計

PORTについて

「世界中に、アタリマエとシアワセを。」 を目的に、就活や金融領域などの各産業領域に特化したメディアを展開しています。

PORT-INC. 公式ホームページ

開発環境

Ruby 2.5.0
Ruby on Rails 6.0.3.4
rbenv 1.1.2
macOS Big Sur v11.0.1

エラー内容

rails sとコマンドを打つと

[WARNING] Could not load command "rails/commands/server/server_command". Error: uninitialized constant URI::Generic
/Users/user/.rbenv/versions/2.5.0/lib/ruby/gems/2.5.0/gems/bootsnap-1.5.1/lib/bootsnap/load_path_cache/core_ext/active_support.rb:00in 'block in load_missing_constant'
(同様の文が何行も出るため中略)
/User/user/Desktop/rails_testbin/spring:15:in `<top (required)>'
bin/rails:3:in `load'
bin/rails:3:in `<main>'
(See full trace by running task with --trace)

上記のようなメッセージが出て、http://localhost:3000 が起動できない

解決方法

結論から言うと、Rubyのバージョンを2.5.0から2.7.0に変更したら動きました。
※コメントでご指摘をいただいたのですが、変更するバージョンは、バグが少なくなっているという点から、基本的になるべく最新版をインストールしたほうが良いです。（2020/12/05時点では2.7.2が最新）

参考記事：
https://info-wcn.com/ruby-changeversion-mac/
https://qiita.com/kamillle/items/5a7befd0ebad47378832
https://qiita.com/chihiro/items/efdf8b88865b7a93971f

1.Rubyのバージョン変更

rbenvを最新バージョンへとアップデート

$ brew upgrade rbenv

現在のRubyのバージョンを確認

$ ruby -v
ruby 2.5.0 

インストール済みのRubyのバージョンを確認

$ rbenv versions
  system
* 2.5.0 (set by /Users/user/.rbenv/version)

これで、現在自分が使っているRubyのバージョンは2.5.0であることが分かりました。
これを2.7.0へとアップデートしていきます。

インストールできるRubyのバージョンを確認

$ rbenv install -l
バージョンがずらっと表示される

Rubyのインストール

$ rbenv install 2.7.0 
# インストールするバージョンを2.7.0に指定
$ rbenv rehash
$ rbenv versions 
  system
  2.5.0
* 2.7.0 (set by /Users/user/.rbenv/version)

2.7.0が追加されたことを確認。

Rubyのバージョン切り替え（ローカル）

$ rbenv local 2.7.0 
 バージョンを指定
$ ls -a 
 .ruby-versionが作成されているか確認
$ less .ruby-version
 2.7.0と表示される

バージョンの確認から戻るときは、qを押して戻る

Rubyのバージョン切り替え（グローバル）

$ rbenv global 2.7.0 # バージョンを指定
  2.7.0と表示される

確認から戻るときは、ローカル同様qを押す

これで、使用するRubyのバージョン切り替えが完了しました。

2.Railsのバージョン変更

1の終了後、

$rails s

と打つと（真似しなくてよい）、

rbenv: rails: command not found

The `rails' command exists in these Ruby versions:
  2.5.0

このようになり、上手く動きません。

そこで、https://qiita.com/kamillle/items/5a7befd0ebad47378832 の「対処」を参考にして、新しくインストールしたruby環境にrailsをインストールする

$ gem update --system
$ gem install bundler
$ gem install rails
# 各コマンド間、色々なものがインストールされるため時間がかかるかも
$ rails --version
# Rails 6.0.3.4と表示された（2020-12-04時点）

これでRailsのバージョン変更が完了しました。

3.サーバーが動くか確認

試しに、デスクトップへrails_appという名前のアプリケーションを作成してみます。

$ cd Desktop
$ rails new rails_app

インストールが完了したら、

$ cd rails_app

で移動し、

$ bundle install

を実行。

最後に

$ rails s

を実行すると

=> Booting Puma
=> Rails 6.0.3.4 application starting in development 
=> Run `rails server --help` for more startup options
Puma starting in single mode...
* Version 4.3.7 (ruby 2.7.0-p0), codename: Mysterious Traveller
* Min threads: 5, max threads: 5
* Environment: development
* Listening on tcp://127.0.0.1:3000
* Listening on tcp://[::1]:3000
Use Ctrl-C to stop

となり、無事http://localhost:3000 にアクセスすることが出来ました！！

お遊び記事です．【追記】お遊びのつもりが，とても秀逸な別解がコメント欄に集まりましたので，そちらもぜひ御参照下さい．とりあえず，J言語すげえ．

アルゴリズムと実装

主に関数型リスト処理を用いて，$x$を$2〜x-1$の各整数で割った余りのリストに0が含まれていなければ$x$を素数と判定しています．このため，任意範囲の整数リスト生成（range等），リスト各要素への関数適用（map等），リストに特定の値が含まれているかの判定（include等），条件を満たした要素のみをリストから取り出す処理（filter等）を行う関数があると，より短いワンライナーとなります．

各言語での記述例

$1<n<100$の$n$について素数判定を行った結果を表示しています．どうしても長くなりがちなので，字句解析が可能な程度に空白等を詰めています．

Ruby

>> ->n{(2...n).reject{|x|(2...x).map{|z|x%z}.include?(0)}}[100]
=> [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97]

Haskell

> (\n->filter(\x->not$elem 0$(\x->map(\z->rem x z)[2..x-1])x)[2..n])100
[2,3,5,7,11,13,17,19,23,29,31,37,41,43,47,53,59,61,67,71,73,79,83,89,97]

Python

>>> (lambda n:[x for x in range(2,n)if not 0 in map(lambda z:x%z,range(2,x))])(100)
[2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97]

JavaScript

> (n=>(r=>r(n).filter(x=>!(i=>r(i).map(z=>i%z).includes(0))(x)))(n=>[...Array(n-2)].map((v,k)=>k+2)))(100)
[ 2,
  3,
//（途中結果は省略）
  97 ]

Scheme

> ((lambda(n)(filter(lambda(x)(not(member 0(map(lambda(z)(modulo x z))(cddr(iota x))))))(cddr(iota n))))100)
(2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 97)

備考

記事に関する補足

• JavaScriptに範囲生成関数が標準で用意されていないのがちょっと意外．最近のJavaScriptでは[...Array(n).keys()].slice(s)あたりが定番の模様（コメントより）．

更新履歴

• 2020-12-04：冒頭にコメント欄参照の旨追記
• 2020-12-04：初版公開（Ruby，Haskell，Python，JavaScript，Scheme）

本記事はiCARE Advent Calender 2020 の5日目です。

はじめに

本記事ではprawnを用いた請求書っぽいPDFの作成方法を解説します。

RailsでPDF作成する場合だとwicked_pdfも使えますが、wicked_pdfがhtmlライクにPDF作成ができるのに対して、prawnはゴリゴリのDSLなので、学習コストがかかりますが、wicked_pdfよりも柔軟にPDFを作ることができるので、個人的にはprawnの方が好きだったりします。

セットアップ

今回の請求書PDFではテーブル表示を行いたいので、prawn-tableを使います。

# Gemfile

gem 'prawn'
gem 'prawn-table'

でbundle install。

your_app $ bundle install

主要なメソッドの紹介

請求書の作成の前に、今回用いる主要なメソッドを紹介したいと思います。

Prawn::Document#generate

https://prawnpdf.org/docs/0.11.1/Prawn/Document.html#method-c-generate

公式の説明文を引用します。

Creates and renders a PDF document.

When using the implicit block form, Prawn will evaluate the block within an instance of Prawn::Document, simplifying your syntax. However, please note that you will not be able to reference variables from the enclosing scope within this block.

PDFドキュメントを作成してレンダリングします。

暗黙的なブロックフォームを使用する場合、PrawnはPrawn :: Documentのインスタンス内のブロックを評価し、構文を簡素化します。 ただし、このブロック内の囲んでいるスコープから変数を参照することはできないことに注意してください。

PDFドキュメントの雛形を作成するメソッドですね。

オプションとして、ページサイズ(A4, B5等)や余白(上下左右)を指定することが出来ます。

# 例

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  # 処理
end

Gem内の実装箇所はこちら

Prawn::Document#bounding_box

https://prawnpdf.org/docs/0.11.1/Prawn/Document.html#method-i-bounding_box

こちらも公式を引用

A bounding box serves two important purposes:
・ Provide bounds for flowing text, starting at a given point
・ Translate the origin (0,0) for graphics primitives
A point and :width must be provided. :height is optional. (See stretchyness below)

bounding_box には、次の2つの重要な目的があります。
・ 特定のポイントから開始して、流れるテキストの境界を指定します
・ グラフィックスプリミティブの原点（0,0）を変換します
ポイントと：widthを指定する必要があります。 ：heightはオプションです。

PDF内にボックス要素を作成するのに用いるメソッドですね。

# 例

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  pdf.bounding_box([50, 75], width: 200, height: 300) do
    # 処理
  end
end

後ほど紹介しますが、テキストを書き込んだり、tableを作成して表示したりできます。

Gem内の実装箇所はこちら

Prawn::Text#text

https://prawnpdf.org/docs/0.11.1/Prawn/Text.html#method-i-text

公式引用

If you want text to flow onto a new page or between columns, this is the method
to use. If, instead, if you want to place bounded text outside of the flow of a ?document (for captions, labels, charts, etc.), use Text::Box or its convenience method text_box.

Draws text on the page. Prawn attempts to wrap the text to fit within your current bounding box (or margin_box if no bounding box is being used). Text will flow onto the next page when it reaches the bottom of the bounding box. Text wrap in Prawn does not re-flow linebreaks, so if you want fully automated text wrapping, be sure to remove newlines before attempting to draw your string.

テキストを新しいページまたは列間で流したい場合は、これが使用する方法です。 代わりに、ドキュメントのフローの外側に境界付きテキストを配置する場合（キャプション、ラベル、グラフなど）、Text :: Boxまたはその便利なメソッドtext_boxを使用します。

ページにテキストを描画します。 Prawnは、現在のバウンディングボックス（またはバウンディングボックスが使用されていない場合はmargin_box）内に収まるようにテキストを折り返そうとします。 テキストは、バウンディングボックスの下部に到達すると、次のページに流れます。 Prawnでのテキストの折り返しは改行をリフローしないため、完全に自動化されたテキストの折り返しが必要な場合は、文字列を描画する前に必ず改行を削除してください。

小難しいことが書いてありますが、要は文字をPDF内に記述したい時に使うメソッドになります。

# 例

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  pdf.bounding_box([50, 75], width: 200, height: 300) do
    pdf.text 'サンプルだよ'
    pdf.text 'サンプル 左寄りだよ', align: :left
    pdf.text 'サンプル 右寄りだよ', align: :right
    pdf.text 'サンプル 文字大きいよ', size: 30
  end
end

例のように、文字の開始位置を決められたり、文字サイズを変更したりすることができます。

Prawn::Document#move_down

引用

https://prawnpdf.org/docs/0.11.1/Prawn/Document.html#method-i-move_down

Moves down the document by n points relative to the current position inside the current bounding box.

現在のbounding_box内の現在の位置を基準にして、ドキュメントをnポイント下に移動します。

ドキュメントを下に移動したい時に用いるメソッドです。

# 例

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  pdf.bounding_box([50, 75], width: 200, height: 300) do
    pdf.text 'サンプルだよ'
    pdf.move_down(5)
    pdf.text 'サンプル 左寄りだよ', align: :left
    pdf.move_down(10)
    pdf.text 'サンプル 右寄りだよ', align: :right
    pdf.move_down(20)
    pdf.text 'サンプル 文字大きいよ', size: 30
  end
end

テキストとテキストの間を空けたいときなんかに使います。

Gem内の実装箇所はこちら

Prawn::Table#table

Quote from the official Doc

If a block is passed to methods that initialize a table (Prawn::Table.new, Prawn::Document#table, Prawn::Document#make_table), it will be called after cell setup but before layout. This is a very flexible way to specify styling and layout constraints. This code sets up a table where the second through the fourth rows (1-3, indexed from 0) are each one inch (72 pt) wide:

pdf.table(data) do |table|
  table.rows(1..3).width = 72
end

表形式でデータを表示したい場合に使えるメソッドになります。

# 例

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  pdf.table(
    [['小計', "11000円"], ['消費税', "1000円"], ['合計金額', "11000円"]], 
    column_widths: [50, 100],
    position: :right
  ) do |table|
    table.cells.size = 10
  end
end

Gem内の実装箇所はこちら

請求書を作成する

お待たせしました。今まで紹介したメソッドを用いて、
簡単な請求書めいたPDFを作成したいと思います。

invoice_pdf_exporter.rbの作成

app/services下にinvoice_pdf_exporter.rbを作成し、
以下のコードを記述します。

require 'prawn'

class InvoicePdfExporter
  FONT_PATH = Rails.root + 'public/fonts/任意のフォントファイル.ttf'

  def initialize
    # Prawnドキュメントを生成
    # ページサイズやマージンを指定
    Prawn::Document.generate(
      Rails.root + 'invoice.pdf',
      page_size: 'A4',
      top_margin: 35,
      bottom_margin: 35,
      left_margin: 35,
      right_margin: 35
    ) do |pdf|

      # フォントを指定しないと Prawn::Errors::IncompatibleStringEncoding 例外が発生する
      pdf.font FONT_PATH

      # 本文の生成
      self.create_contents pdf
    end
  end
end

fontメソッドは初出なので公式Docから引用します。

Prawn::Document#font

https://prawnpdf.org/docs/0.11.1/Prawn/Document.html#method-i-font

Without arguments, this returns the currently selected font. Otherwise, it sets the current font. When a block is used, the font is applied transactionally and is rolled back when the block exits.

引数がない場合、これは現在選択されているフォントを返します。 それ以外の場合は、現在のフォントを設定します。 ブロックが使用されると、フォントはトランザクションで適用され、ブロックが終了するとロールバックされます。

Gem内の実装箇所はこちら

ドキュメントに記載がありませんが、fontの指定をしないで実行すると、
Prawn::Errors::IncompatibleStringEncoding
の例外が発生します。

サンプルコードではpublicディレクトリに配置していますが、app/assets/fontsでもいいと思います。

フォントファイルは、
https://fontfree.me/
に無料フォントがありますので、お好きなものをお使いください。

今回はほのか明朝を使います。

create_contentsメソッドを実装する

では具体的な処理を記述します。

コード全晒しです。

  def create_contents(doc)
    # bunding_boxメソッドでボックスを生成
    # 引数にはボックス生成位置、横、縦のサイズを指定
    doc.bounding_box([50, 750], width: 300, height: 150) do

      # textメソッドでテキストを挿入。引数には文字サイズとalignを指定できる。:left, :right, :center
      doc.text "〒123-4567", size: 10, align: :left

      # move_downメソッドで次のテキストの書き出し位置を下げている
      doc.move_down 10
      doc.text "東京都新宿区新宿1-1-1", size: 10, align: :left

      doc.move_down 10
      doc.text "ご担当者 様", size: 12, align: :left
    end

    doc.bounding_box([300, 750], width: 300, height: 150) do
      doc.text 'HogeHoge株式会社', size: 12, align: :left
      doc.move_down 5
      doc.text '〒103-0021', size: 10, align: :left
      doc.move_down 5
      doc.text '大阪府大阪市中央区中央1-1-1', size: 10, align: :left
      doc.move_down 5
      doc.text '大阪中央ビル4F 経理部経理課', size: 10, align: :left
      doc.move_down 5
      doc.text 'TEL: 03-1234-5678', size: 10, align: :left
    end

    doc.text '請求書', size: 20, align: :center

    doc.bounding_box([0, 550], width: 300, height: 60) do
      doc.text '下記の通りご請求申し上げます。', size: 10, align: :left
      doc.move_down 10
      doc.text "合計金額 11,000円", size: 16, align: :left
    end

    doc.bounding_box([320, 550], width: 300, height: 60) do
      doc.text "日付： 2020年10月01日", size: 10, align: :left
    end

    rows = [['詳細', '数量', '単価', '金額'], ['雑費', '1', '10000', '10000']]

    # tableメソッドでテーブルを生成する
    # rowsは多重配列
    # 多重配列でない場合 Prawn::Errors::InvalidTableData 例外が発生する
    doc.table(rows, column_widths: [370, 30, 60, 60], position: :center) do |table|
      # セルのサイズの指定
      table.cells.size = 10

      # 1行目のalignを真ん中寄せにしている
      table.row(0).align = :center
    end

    doc.bounding_box([0, 300], width: 300, height: 100) do
      doc.text "振込期限　　　202X年10月31日", size: 10, align: :left
      doc.move_down 10
      doc.text '振込先　　　　日本銀行 本店 0000', size: 10, align: :left
      doc.move_down 10
      doc.text '　　　　　　　普通：　1234567', size: 10, align: :left
    end

    doc.bounding_box([373, 300], width: 150, height: 100) do
      doc.table [['小計', "11000円"], ['消費税', "1000円"], ['合計金額', "11000円"]], column_widths: [50, 100], position: :right do |table|
        table.cells.size = 10
      end
    end
  end

サンプルコードなので金額や配列の中身をベタ書きにしていますが、
initializeメソッドの引数にデータを渡してやれば、動的なPDFを作成することができます。

あとはコンソール上で実行してやりましょう。

your_app $ rails c

$ InvoicePdfExporter.new

実際に出来上がったPDFはこちら

紹介していないけど便利なメソッド

Prawn::Document#start_new_page

Creates and advances to a new page in the document.

Page size, margins, and layout can also be set when generating a
new page. These values will become the new defaults for page creation

ドキュメント内の新しいページを作成して進みます。

ページサイズ、余白、およびレイアウトは、生成時に設定することもできます。
新しいページ。 これらの値は、ページ作成の新しいデフォルトになります

次のページを作成するメソッドです。

Prawn::Document.generate(
  'sample.pdf',
  page_size: 'A4',
  top_margin: 35,
  bottom_margin: 35,
  left_margin: 35,
  right_margin: 35
) do |pdf|
  pdf.table(
    [['小計', "11000円"], ['消費税', "1000円"], ['合計金額', "11000円"]], 
    column_widths: [50, 100],
    position: :right
  ) do |table|
    table.cells.size = 10
  end

  pdf.start_new_page

  pdf.text '次のページですよ'
end

Prawn::Image#image

Add the image at filename to the current page. Currently only
JPG and PNG files are supported. (Note that processing PNG
images with alpha channels can be processor and memory intensive.)

ファイル名の画像を現在のページに追加します。
JPGおよびPNGファイルがサポートされています。 （PNGの処理に注意してください
アルファチャネルを備えた画像は、プロセッサとメモリを大量に消費する可能性があります。）

PDF内に写真を貼るメソッドです。横縦の幅や寄せる位置などを指定できます。

 Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do     
    pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
    image pigs, :at => [50,450], :width => 450                                      

    dice = "#{Prawn::BASEDIR}/data/images/dice.png"
    image dice, :at => [50, 450], :scale => 0.75 
  end   

まとめ

今回紹介したメソッドの他にも様々な機能がありますので、
詳しく知りたい方はドキュメントをご覧ください！

https://prawnpdf.org/manual.pdf

iCAREテックブログもよろしくね！！

https://www.icare.jpn.com/dev_cat/

Web開発エンジニアを目指すためにいまから頑張ります。

まずは、Ruby、Railsを用いたポートフォリオの作成に挑みます。

事前知識がないので少しアウトプット
ブラウザにプログラムを反映するために

ルーティング→コントローラ→ビューの順を踏む

▼ルーティング
コントローラー、ビューがどういった定義で順で実行されていくか
定める役割

▼コントローラー
ルーティングを参照しどのビューを実行するか決める役割

▼ビュー
具体的なHTMLファイルなど実行されるプログラムを格納する場所

はじめに

こんにちは。昨年のアドベントカレンダーでは、GR.rbというRubyでグラフを描出するツールを紹介いたしました。

• Rubyでグラフを描画するツール GR.rb の紹介

今年はYouPlotというツールを作ったので紹介します。

Github: https://github.com/kojix2/youplot

YouPlotは、ターミナルにグラフを描出するソフトです

　ターミナルの画面にアスキーアートでグラフを表示したいと思ったことはありませんか？YouPlotはそのためのツールです。グラフを描出するエンジンの部分は、mrknさんの作ったUnicodePlotを利用しています。エンジンの部分を作る記事ではありません。

　この記事では、前半でYouPlotの使い方を簡単に紹介し、後半でコマンドラインツールをRubyで作る上で感じたことを書きます。

Uplotのつかい方

インストール

gem install youplot

コマンド名はuplotです！¹

youplot でも動きます。

uplot

ヒストグラム

echo -e "from numpy import random;" \
        "n = random.randn(10000);"  \
        "print('\\\n'.join(str(i) for i in n))" \
| python \
| uplot hist --nbins 20

散布図

curl -s https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv \
| cut -f1-4 -d, \
| uplot scatter -H -d, -t IRIS

curl -s https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv \
| cut -f1-4 -d, \
| uplot density -H -d, -t IRIS

折れ線グラフ

curl -s https://www.mhlw.go.jp/content/pcr_positive_daily.csv \
| cut -f2 -d, \
| uplot line -w 50 -h 15 -t 'PCR positive tests' --xlabel Date --ylabel number

箱ひげ図

curl -s https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv \
| cut -f1-4 -d, \
| uplot box -H -d, -t IRIS

棒グラフ

echo -ne "A:200\nB:300\n" | uplot bar -d: -s ?

そのほかの機能

• Kernel.gets が ARGF も取ってきてくれるので、uplot lines -H -d, hoge.csv みたいにファイルを指定することもできます。
• --pass または -O オプションをつけると、受け取った標準入力をそのまま標準出力に流し込むことができます。（グラフは標準エラー出力に描出されます）これは、hoge | uplot | fuga のようにコマンドをパイプラインのチェーンの間に挟んで使用する場合に便利です。このあたりのオプションの仕様は固まっていないのでまた変更になる可能性があります。
• uplot color で指定可能な色一覧が表示されます。
• uplot count で要素の数を数えて棒グラフにすることができます。

より詳しい使い方は uplot --help をご覧ください。uplot bar --help などとするとより詳しいオプションが表示されます。
UnicodePlotの大半のオプションは指定できるようになっているはずです。²

YouPlotを作って感じたこと

バックグラウンド

Rubyではコマンドラインツールが簡単に作れてしまう…

　Rubyはコマンドラインツールを作るのが得意です。Macで広く使われているパッケージマネージャーの homebrew はRubyで書かれています。

　YouPlotはUnicodePlotに、optparseを使ってコマンドラインインターフェースをつけたツールです。言い換えると、グラフ描画エンジンUnicodePlotに、データをパイプから読み込む仕組みや、オプションで操作を切り替えられるスイッチを付けて、一つのツールにまとめたものです。技術的に難しいことは何もやっていません。グラフの描出はすべてUnicodePlotにお任せしているのです。でも、便利です。

　Rubyでお気に入りのツールをラップすれば、簡単にコマンドラインツールを作成することができます。

でもYouPlotと同じようなツールは多くない…

　YouPlotを作る前に、私は同じようなツールがないかGoogle検索やGithubで探しました。デファクト・スタンダードになっているような便利なツールがすぐに見つかると思ったのです。けれども、私が探した範囲では、デファクト・スタンダードと呼べるようなツールはありませんでした。（強いて言うならばgnuplotがそれに近いかも知れません）それならば、ということで自分で作ることにしました。

　なぜYouPlotのようなツールはあまり多くないのでしょうか？

　その理由はいくつか考えられます。一つは、Unixのコマンドラインツールで作業をしている人の絶対数がそれほど多くないことです。

　もう一つの理由は、アスキーアートでグラフを表示するためのライブラリの不足です。自分で描画エンジンを作るのは結構大変です。YouPlotのようなツールを思いついても、作ることができなかった人もたくさんいると思います。

　例えば、GOやRustのような言語では、コマンドラインツールが盛んに開発されています。しかし、必ずしもこれらの言語でターミナル上にアスキーアートでグラフを描出するライブラリが特別に豊富というわけではなさそうです。だからそれなりに手間がかかる気がします。

アスキーアートでグラフを描出するライブラリ UnicodePlot

　幸いにしてRubyには、ターミナル上にアスキーアートでグラフを表示する便利なライブラリがありました。YouPlotが使っているグラフ描画エンジンはUnicodePlotです。これは、Rubyのコミッタで、Julia言語が好きなmrknさんが、JuliaのUnicodePlotをRuby向けに実装し直したものです。

• https://github.com/red-data-tools/unicode_plot.rb

　Julia言語のUnicodePlotは、おそらくターミナル上にグラフを描出する最も有名なライブラリです。しかし、Julia言語は、REPLやJupyterを通して利用する場合が多く、コマンドラインツールの作成はそれほど活発ではありません。

　こんな感じで、いろいろな偶然が重なって、YouPlotもちょっとだけユニークなツールになっているのです。

ツールはみんなユニーク

　ツールは、二度と重ならない条件のもとで生まれます。作者、目的、環境、マシン、ユーザー、仲間、同僚、家族、時代…　そういったものが交差した座標はどれもユニークです。だから、どのツールも自然とユニークになります。

　YouPlotは、もともと生命情報のタブ区切りテキストをすばやく観察したい目的で作られました。なのでリアルタイムに時系列データを表示する機能がありません。一方やはりRubyで実装されているtermplotというツールは、YouPlotより少しあとに開発されましたが、リアルタイムでグラフを描く機能に特化しています。このように作者の目的によってツールは少しずつ異なったものになります。）

　さらに、全てのツールは作者に求められて生み出されています。だから、あなたが作っているツールも、おそらくユニークかつ誰かに求められているはずです。私が言いたいことは一つです。みんな、Rubyでツールを作ったら公開しよう。

…

…（さて、今日は十分ポエムを書いたので、もう帰っていいですか）

OptionParserを使ってコマンドラインオプションをつける

コマンドラインツールを作るのにはRuby標準ライブラリのoptparseを使いました。optparseは下記のような構文でコマンドラインオプションを用意してくれます。

require 'optparse'
opt = OptionParser.new

params = {}

opt.on('-a') {|v| params[:a] = v }
opt.on('-b') {|v| params[:b] = v }

opt.parse!(ARGV)

公式リファレンスがまとまっているのでしっかりと目を通します。

optparseの応用は、sonotsさんの下記の記事がとても参考になりました。

• Ruby の OptionParser チートシート

（今回YouPlotでは利用していませんが、すこし複雑なツールを作りたい時はPiotr Murachさんが開発しているTTYツールキットが便利です。たとえば、ターミナルにボックスやツリーを表示したり、コマンドを実行して結果を表示する機能などがあります。）

オブジェクト指向のRubyでデータ分析用のツールを作るときに気になること

　この項は、主観が強く入っています。私はプログラミングも数学もよくわかりません。コンピュータやプログラミング、数学に造形の深い方らみると間違っている記述もあるかもしれません。一つの意見として聞いてください。

　Rubyはデータ処理用の言語としてはそれほど広く使われていません。その理由はいろいろ言われています。ライブラリが足りない、とか。しかし、私の個人的な意見としては、オブジェクト指向とデータ分析相性があまりよくないからだと思います。普及しているデータ処理用の言語、例えばR, Juliaは、どちらもオブジェクト指向らしくはありません。（このような話題では、どうしてもPythonに注目が集まる傾向がありますが、Pythonよりも、RやJuliaとの比較に意味があると思います）

「データ」と「手続き」

オブジェクト指向はむずかしく、私は理解できまている自信はありません。しかし、言いたいことを自分なりに表現するために続けますね。オブジェクト指向とは「データ」と「手続き」を一つのまとまりとして扱うことだと理解しています。しかし、「データ」と「手続き」を一つのカタマリとして扱うこと、これは、データを分析する際には不便な面があると思います。

　私たちはデータを分析するとき、「データ」に、さまざまな「手続き」を適応して、うまくいく手続きを探そうとします。あたらしい「手続き」を開発しようとしている人がいます。「データ」にどの「手続き」を適応すると良い結果が出るかを試して、それを仕事にしている人もいます。結果だけほしくて、「手続き」には興味がない人もいます。いずれにせよ、この目的のためには「データ」はデータだけ、「手続き」は手続きだけで管理して、互いに依存しないようにバラバラにしておいた方が安全できれいに見えるでしょう。

　一方で、Rubyでは、全てはオブジェクトで構成されており、原則として「手続き」はメソッドとしてすべて作者の意図通りにオブジェクトに所属しています。（単体の手続きはlambdaやproc,blockなど存在はします）ここでは、オブジェクトにどの「手続き」を適応すればよいのかは、オブジェクト自身が知っています。私たちはオブジェクトがどんなメソッドを持っているのか、オブジェクト自身に問い合わせることができ、自分で「手続き」を管理する必要はありません。そう考えるとRubyでは「データ」と「手続き」の関係性がよく整備された環境で、成果物そのものに注力できる良い環境が整っているとも言えるかもしれません。

　Rubyのオブジェクトは、インスタンス変数を持っています。なので、メソッドを呼び出すとしばしばオブジェクトの状態が変わってしまいます。これもデータを分析する上では望ましくない性質です。

　たとえば、Jupyter Notebookでセルを一つづつ実行していいくことを考えます。セルを実行する順番を変えたり、あとからもう一回実行すると結果が変わってしまうようなワークフローは、データ分析の観点からはあまり望ましくないと思います。そしてJupyter Notebookを使っているような場合には、そのような試行錯誤が頻繁に発生します。このようなケースでは内部の状態が変化してしまうオブジェクトとメソッドは活躍しにくくなります。

　このように、オブジェクト指向の持つ「データ」と「手続き」をまとめて管理する傾向は、データ分析ではしばしば不利になるケースがあると私は考えます。

モジュール関数(module function)

　そうはいっても、Rubyでも、どうしても「手続き」そのものを扱いたいこともあります。例えば、数学の関数がそれに当たります。RubyではMathモジュールというものが存在し、これらはモジュール関数(module function)として作成されています。モジュール関数は、特異メソッドでありかつ、プライベートメソッドでもあるような関数のことです。

Math.sin(x)   # 特異メソッドなので呼べる

include Math
sin(x)        # プライベートメソッドでもあるので呼べる

Object.sin(x) # 呼べない

　Mathモジュールは、クラスではなくてモジュールなので、インスタンス変数を持ちません。だから、何回実行しても内部の状態が変わって結果が変わることはありません。

# 馬の耳に念仏モジュール
module Horse
  module_function
  def hear(sound)
    "..."
  end
end

# Horseはモジュールなので中味は変化しない

Horse.hear("念仏")
Horse.hear("東風") # 馬耳東風

　なんだ、Rubyでも関数が作れるんだ、よかった。という話になるでしょうか…。

　長々と書きました。YouPlotのような小さなツールを作るためには、こんなことをくどくど考える必要はないかもしれません。けれども、ライブラリを作る前に、一つのオブジェクトをモジュールにしようか、クラスにしようか、Mixinをどうしようかと悩んだりすることは、パッケージを作った方はきっと経験があると思います。

　YouPlotでも上記のようなことをあれこれ考えて、部分的にモジュール関数(module function)を使っています。モジュール関数を作るのは簡単で、module_function と書くだけです。

構造体(struct)

YouPlotでは、パラメータの保持に構造体を使っています。

Qiitan = Struct.new(:name, :age)

qiitan = Qiitan.new("キータン", 6)
qiitan.age # 6

　StructはHashと比較して、デフォルトでkeyが固定されています。そのため何かのタイミングで新しくキーが追加されてしまうことを防ぐことができて少し安心です。また、値を取り出す記述がメソッドのように見えるのですこしすっきりします。

　モジュール関数や構造体を使うRubyのコードは、どちらかというとあまりRubyらしくない記述法だと思います。けれども、Juliaや他の言語のデータ解析関連のライブラリーはオブジェクトとメソッドという組み合わせよりは、構造体と関数という発想で作られている場合があるのではないかと思います。そういったライブラリをRubyに移植することを考えると、module function や struct　のようなものを適材適所で使っていけば、頭を切り替えなくてもすむというメリットがあります。とくにデータ分析のツールを作る上では、活躍する場面があるのではないかと思います。

（一方で、「データ」と、それに適応する「手続き」が一度確立された分野では、Rubyのオブジェクト指向の強みがいかんなく発揮されていくのではないかと思います。）

YouPlotの課題とこれから

リアルタイムにグラフを表示したい

　YouPlotはデータをリアルタイムに表示できません。いずれそういったことができるようになるといいなと思っています。

テストとエラーメッセージの整備

勉強して少しずつテストを追加したり、エラーメッセージを整備していきたいと思っています。

前処理・統計処理など

　YouPlotのようなツールに簡単な前処理や統計の機能をつけようとするのは自然だと思います。しかし、Rubyのスクリプトでありますのでスピードがでないと思っています。datamash などの専用のコマンドと組み合わせる方がUnixらしくて現実的かも知れません。
　もしも、YouPlotと同様のツールをGolangやRustで開発したらとても便利なツールになるかも知れません。興味のある方は挑戦してみてください。

おわりに

みなさんもRubyのツールを作っていたらぜひ公開してください。

この記事は以上です。

---

1. （本当はgem名もuplotにしたかったのですが、uPlotという有名なJavaScriptのツールがあって、そちらに関するライブラリにネームスペースを取られてしまいました。ググラビリティ改善の目的もありYouPlotとしました。） ↩

2. オプションやサブコマンドは今後も変更する可能性があります。 ↩

Railsでログイン機能をつくってみました

今回作るログイン機能はタスク管理アプリで
初回利用時にユーザー登録を行い、その後利用するときは「私は先日に登録したユーザーです」と言う認証を行うやり方。

セッションとCookie

ログイン機能を実装する前に前提知識となるセッションとCookieについてはこちらの記事に書きました。
https://qiita.com/ombossk0720/items/5345b8ef267749e550fe

Userモデルを作る

認証機能を作るにはアプリに新しい概念を加える必要がある。
それはアプリケーションを利用する概念。
そこでユーザーを表すUserモデルを作る。
タスク管理アプリのUserモデルに最低限必要なのはメールアドレスとパスワード。
ただそれだけでは、ユーザーを表すのに常に長ったらしいメールアドレスか、暗号のような数字を
表示しなければいけなくなるので、扱いやすいようにユーザー名を別途保持することにする。

generateコマンドを使ってUserモデルをつくってみる

% bin/rails g model user name:string email:string password_digest:string

generateコマンドによって、データベースにuserテーブルを作るためにマイグレーションファイルとUserモデルが作られた。
早速migrationしたいところだがまずマイグレーションファイルを編集。
名前やメールアドレスやパスワードには何かしらの文字列が必ず入るのでこれらの属性にNULLが入ることはない。
また、同じメールアドレスをもつユーザーが複数人いることはない。ありえない値が入ることを防ぐために生成した
マイグレーションファイルを開いて以下のように書き換える。

db/migrate/xxxxxxxxxxxxx_create_users.rb

class CreateUsers < ActiveRecord::Migration[6.0]
  def change
    create_table :users do |t|
      t.string :name, null: false
      t.string :email, null: false
      t.string :password_digest, null: false

      t.timestamps
      t.index :email, unique: true
    end
  end
end

書き換えたらマイグレーションを実行して、データベースにusersテーブルを作成する。

% bin/rails db:migrate

usersテーブルが作られ、generateコマンドでUserモデルも作られている。

ユーザー管理機能一式を追加する

次にアプリケーションの利用者をどうやってUserとしてデータベースに登録するか検討します。よくある形は

1,未登録のユーザーが自らサインアップを行う。
2,管理者がユーザーを登録することで、ユーザーがアプリケーションを利用できるようにする。

１は全世界の個人に向けて提供する場合に、2は特定のグループに属する提供する場合に適している。
そしてユーザー管理機能は管理者だけ触れるようにする必要がある。

Userモデルにadminフラグを追加する

まず、ユーザーが管理者かどうかを表すフラグを追加する。
以下のコマンドでマイグレーションファイルの雛形を作成する。

% bin/rails g migration add_admin_to_users

ファイルを開き以下のように編集。

db/migrate/xxxxxxxxxxxxx_add_admin_to_users.rb

class AddAdminToUsers < ActiveRecord::Migration[6.0]
  def change
    add_column :users, :admin, :boolean, default: false, null: false
  end
end

このマイグレーションはusersテーブルにadminと言うフラグのカラムを追加する。早速適用。
% bin/rails db:migrate

ユーザー管理のためのコントローラを実装する

次にユーザー管理のためのコントローラを作成。
ここでは「管理系」の機能として「ユーザー管理」を行うのでAdmin::UsersControllerと言う名前をつける。
この名前は、Adminと言うモジュールの名前空間の中にUsersControllerと言うクラスを定義するという意味になる。
Railsではモジュール階層を、コードを保存するためのディレクトリ階層に対応させている。app/controllers/admin/users_controller.rbと言うファイルが対応するようになる。
これから「管理系」の機能を足したいとき、Admin::のついたコントローラを追加していけばコードがAdminディレクトリの下にまとまって
わかりやすくなる。

まず、Admin::UsersControllerを画面を伴うGETアクションのビューとともに以下のコマンドで作ります。

% bin/rails g controller Admin::Users new edit show index

generateの機能によってnew,edit,show,indexのからのアクションとデフォルトのビューができた。
合わせてroutes.rbにも自動で定義が追加されるがこれは決めている仕様と合わないので、エディタで編集。
admin/users/で始まるURLの書かれた記述を全て削除して次のように内容を編集する。

config/routes.rb

Rails.application.routes.draw do
  namespace :admin do
    resorces :users
  end
  root to: 'tasks#index'
  resources :tasks
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
end

これで想定したURLで適切なアクションにリクエストが飛ぶようになる。各機能のURLを得るには、admin_users_pathやadmin_user_pathなど
adminがついたヘルパーメソッドを使う。

ここからは各機能を作り込んでいく。

登録の機能

コントローラ(app/controllers/admin/users_controller.rb)とビュー(app/controllers/admin/users/new.html.slim)を以下のように変更。

app/controllers/admin/users_controller.rb

class Admin::UsersController < ApplicationController
  def index
    @users = User.all
  end

  def show
    @user = User.find(params[:id])
  end
  def new
    @user = User.new
  end

  def edit
    @user = User.find(params[:id])
  end

  def create
    @user = User.new(user_params)

    if @user.save
      redirect_to admin_user_url(@user), notice: "ユーザー「#{@user.name}」を登録しました。"
    else
      render :new
    end
  end

  def update
    @user = User.find(params[:id])
    if @user.update(user_params)
      redirect_to admin_user_url, notice: "ユーザー「#{@user.name}」を更新しました。"
    else
      render :edit
    end
  end

  def destroy
    @user = User.find(params[:id])
    @user.destroy
    redirect_to admin_users_url, notice: "ユーザー「#{@user.name}」を削除しました。"
  end
  private

  def user_params
    params.require(:user).permit(:name, :email, :admin, :password, :password_confirmation)
  end
end

ここからnew,edit,show,indexと次のようにコードを書いてもいいのですが、面倒なのでパーシャルを使います。
```ruby:app/controllers/admin/users/new.html.slim
h1 ユーザー登録

= form_with model: [:admin, @user], local: true do |f|
.form-group
= f.label :name, '名前'
= f.text_field :name, class: 'form-control'
.form-group
= f.label :email, 'メールアドレス'
= f.text_field :email, class: 'form-control'
.form-check
= f.label :admin, class: 'form-check-label' do
= f.check_box :admin, class: 'form-check-input'
| 管理者権限
.form-group
= f.label :password, 'パスワード'
= f.password_field :password, class: 'form-control'
= f.submit '登録する', class: 'btn btn-primary'
```
これを各それぞれのファイルに書き込むのはしんどそうですよね。
ここから先の手順でやれば書き込んだことと同じことになります。パーションファイルはファイル名をから始めます。
今回はform系のことなのでviews/admin/users/index.html.slimと同じ階層に新規でform.html.slimファイルを作成して
以下のようにコードを入力していきます。

views/admin/users/_form.html.slim

- if user.errors.present?
  ul#error_explanation
    - user.errors.full_messages.each do |message|
      li= message

= form_with model: [:admin, user], local: true do |f|
  .form-group
    = f.label :name, '名前'
    = f.text_field :name, class: 'form-control'
  .form-group
    = f.label :email, 'メールアドレス'
    = f.text_field :email, class: 'form-control'
  .form-check
    = f.label :admin, class: 'form-check-label' do
      = f.check_box :admin, class: 'form-check-input'
      | 管理者権限
  .form-group
    = f.label :password, 'パスワード'
    = f.password_field :password, class: 'form-control'
  .form-group
    = f.label :password_confirmation, 'パスワード(確認)'
    = f.password_field :password_confirmation, class: 'form-control'
  = f.submit '登録する', class: 'btn btn-primary'

！インデントエラーがよく発生するので注意！

_form.html.slimが作成できたら
index,edit,show,newファイルを以下のように編集していきます。

views/admin/users/index.html.slim

h1 ユーザー一覧

= link_to '新規登録', new_admin_user_path, class: 'btn btn-primary'

.mb-3
table.table.table-hover
  thed.thed-default
    tr
      th= User.human_attribute_name(:name)
      th= User.human_attribute_name(:email)
      th= User.human_attribute_name(:admin)
      th= User.human_attribute_name(:created_at)
      th= User.human_attribute_name(:updated_at)
      th
  tbody
    - @users.each do |user|
      tr
        td= link_to user.name,[:admin, user]
        td= user.email
        td= user.admin? ? 'あり' : 'なし'
        td= user.created_at
        td= user.updated_at
        td
          = link_to '編集', edit_admin_user_path(user), class: 'btn btn-primary mr-3'
          = link_to '削除', [:admin, user], method: :delete,data: { confirm: "ユーザー「#{user.name}」を削除します。よろしいですか？"}, class: 'btn btn-danger'

views/admin/users/new.html.slim

h1 ユーザー登録

.nav.justify-content-end
  = link_to '一覧', admin_users_path, class: 'nav-link'

= render partial: 'form', locals: { user: @user }

views/admin/users/edit.html.slim

h1 ユーザーの編集

.nav.justify-content-end
  = link_to '一覧', admin_users_path, class: 'nav-link'

= render partial: 'form', locals: { user: @user }

views/admin/users/show.html.slim

h1 ユーザーの詳細

.nav.justify-content-end
  = link_to '一覧', admin_users_path, class: 'nav-link'
table.table.table-hover
  tbody
    tr
      th= User.human_attribute_name(:id)
      td= @user.id  
    tr
      th= User.human_attribute_name(:name)
      td= @user.name
    tr
      th= User.human_attribute_name(:email)
      td= @user.email
    tr
      th= User.human_attribute_name(:admin)
      td= @user.admin? ? 'あり' : 'なし'
    tr
      th= User.human_attribute_name(:created_at)
      td= @user.created_at
    tr
      th= User.human_attribute_name(:updated_at)
      td= @user.updated_at

= link_to '編集', edit_admin_user_path, class: 'btn btn-primary mr-3'
= link_to '削除', [:admin, @user], method: :delete, data: { confirm: "ユーザー「#{@user.name}」を削除します。よろしいですか？" }, class: 'btn btn-danger'

configも追加します

config/locales/ja.yml

 models:
      task: タスク
    attributes:
      task:
        id: ID
        name: 名称
        description: 詳しい説明
        created_at: 登録日時
        updated_at: 更新日時

      user:
        name: 名前
        email: メールアドレス
        admin: 管理者権限
        password: パスワード
        password_confirmation: パスワード(確認)
        created_at: 登録日時
        updated_at: 更新日時

以上で、ユーザー管理機能の基礎となる部分は出来上がりで/admin/usersにアクセスすれば利用することができます。

長い道のりでした。

"参考書籍：現場で使える Ruby on Rails5速習実践ガイド"

今日は5日目。Bootstrapの使い方と複数条件指定の機能のキャッチアップをしました。

Bootstrapについて

stratbootstrapからデザインを落としてきて、VScodeで編集するのはできるようになりました。
rubyでいじれるようにするためには、下記の4つのgemのインストールを行うなどが分かりました。
少し、時間がなくてまとめられないので、こちらもまとめていきたいと思います。

gem "sass-rails", "~>5.0"
gem "bootstrap-sass", "~>3.3.6"
gem "jquery-rails"
gem "jquery-ui-rails"

ただ、BtoBに近い感じなのでBootstrapはバージョンアップが早くてrubyで実装には向かないかもと思い始めました。
そのため、CSSデザインをこだわりすぎるといつまで経っても実装できないので、プログラミングスクールのデザインを流用しつつ、自分で作ろうと思います。

複数条件指定の機能

rubyのGemで「ransack」というGemがあり、検索のためのフォームを作成したりコントローラーでの検索メソッドを簡潔にできるようになります。
具体的にはこんなメソッドを組み込むことで検索ができるそうです。

eq ：条件に合った検索を行う
_lteq ：「〜以下」という検索条件
search_form_for　：「ransack特有の検索フォームを生成するヘルパーメソッド」、
collectionselectメソッド　：　DBにある情報をプルダウン形式で表示できるヘルパーメソッド

そのほか学べたこととしてはseeds.rbのfiあるには元からあるDBにデータを入れておくことができること、distinctで重複する結果を省くことができることです。検索結果を盛り込み次第、コードも開示できればと思います。

まとめ

こんな感じで毎日書くとなると結構しんどいですが、継続が最大の近道だと思うのでこれからも頑張ります！！

ruby3以降でrb_check_safe_objが削除されるらしくsqlite3が大量の警告を吐いて邪魔だったので対処した話

> rails test
Running via Spring preloader in process *
**/sqlite3/database.rb:89: warning: rb_check_safe_obj will be removed in Ruby 3.0

対応

sqlite3のバージョンを1.4.2以降に更新

# Gemfile
gem 'sqlite3', '1.4.2'
bundle update

対応後

> rails test
Running via Spring preloader in process *
Started with run options --seed *

  5/5: [======] 100% Time: 00:00:01, Time: 00:00:01

いろいろなフレームワークを、centOS7で接続するときに便利なローカルサーバ接続用のコマンド集です。ローカルホスト接続はよく見るのですが、この条件を毎回調べるのが面倒なので、テスト起動した上で備忘録としてまとめたものです。

※随時修正

PHP編

Laravel

デフォルトポートは8000

#php artisan serve -host 0.0.0.0

192.68.11.xx:8000/プロジェクト名

cakePHP

サーバ起動不要

192.168.11.xx/プロジェクト名

CodeIgniter3

サーバ起動不要

192.168.11.xx/プロジェクト名

Symfony

デフォルトポートは8000

#php bin/console server.run 0.0.0.0

192.168.11.xx:8000/

Yii2

デフォルトポートは8000

#php yii serve-port=8000

192.168.11.xx/yii2/web/

Zend Framework

サーバ起動不要

192.168.11.xx/プロジェクト名/public/

Javascript編

React

記述中

Vue.js

記述中

Ruby編

デフォルトポートは3000

Rails

#bundle exec rails s -b 0.0.0.0

※bundle execを省略する方法もあるので、その場合はbundle execは不要。

192.168.11.xx:3000/

Sinatra

デフォルトポートは4567

#bundle exec ruby touch app.rb -o 0.0.0.0

192.168.11.xx:4567

Python編

Django

デフォルトポートは8000

①起動設定

#vi /プロジェクト名/setting.py

以下のように書き換えて保存

②起動

setting.py

ALLOWED_HOSTS = ["*"]

#python manage.py runserver 0.0.0.0:8000

192.168.11.xx:8000/プロジェクト名

Flask

デフォルトポートは5000

各種pyファイルのサーバ設定に以下のように書き込む。

#サーバ接続設定
if __name__ == "__main__":
 app.run(host='0.0.0.0')

#python pyファイル名

192.168.11.xx:5000/