RubyMineでminitestを実行する

今、『プロを目指す人のためのRuby入門』(伊藤淳一[著])を読んでるんですが、使用するテストフレームワークminitestなのですよね。

RubyMineでminitestを追加しようとしたら、”New”の一覧にもないし、とりあえず手動でファイル作って

require 'minitest/autorun'

と書いてみたら”そんなファイルないよ”とのエラーが出ました。

公式ドキュメント見たら、minitestの実行要件が載っていたのでその通りにします。

Minitest - Help | RubyMine

と言っても、詳細な手順はさすがに載っていなくて、久々にrubyをさわったらBundlerの使い方を忘れていたので、詳細な手順を残しておきます。

Bundle Init

Tools > Bundler > Init でBundlerを初期化します。

GemFileの書き換え

GemFileが作成されたので、下記を追加します。

group :test do
    gem "minitest"
    gem 'minitest-reporters', '>= 0.5.0'
end

minitest-reportersは、minitest のバージョンが 5.0.0ならばインストールは必須ではないのですが、入れておくとテスト結果をツリー状に表示してくれるので、追加するのがおすすめです。(Important noteに書いてある)

公式ドキュメントには、'cucumber-rails'も書かれていますが、今回は必要ないので外しています。

Bundle Install

Tools > Bundler > Install を選択して、gemをインストールします。

これでminitestを使用する準備が整いました。

テストファイル作成

“New”メニューにminitestのテンプレートが追加されるかと思いましたが、されませんでした。 テストファイルは、New > Ruby Class Template らへんから作ります。

minitestのテストファイルは、(拡張子を除いた部分が)_testで終わるか、test_で始まり、拡張子が.rbである必要があります。

また、テストクラス名はTestで終わる必要があります。

テストメソッドはtest_で始める必要があります。

ヘッダーはこんな感じ

require 'minitest/autorun'
require 'minitest/reporters'
MiniTest::Reporters.use!

テストクラスはMinitest::Testを継承します。

テスト実行

テストの実行はソースコードの実行と同じようにファイル右クリック > Runでできます。testフォルダ右クリック > Run All Tests ..で全てのテストを実行可能です

テスト実行結果です。テストを再実行したい場合は、左上の緑の三角ボタンを押します。

環境

• Mac : Sierra 10.12.2
• Ruby : 2.4.0
• RubyMine : 2018.1.3

プロを目指す人のためのRuby入門 言語仕様からテスト駆動開発・デバッグ技法まで （Software　Design　plusシリーズ） [ 伊藤淳一（プログラミング） ] 価格：3218円（税込、送料無料) (2018/6/9時点)

番外編

minitest-reportsをbundle installした直後に、以下のエラーが出ましたが、Rubymineを再起動したらエラーは出なくなりました。

`rescue in specs': Your bundle is locked to ansi (1.5.0), but that version could not be found in any of the sources listed in your Gemfile. If you haven't changed sources, that means the author of ansi (1.5.0) has removed it. You'll need to update your bundle to a different version of ansi (1.5.0) that hasn't been removed in order to install. (Bundler::GemNotFound)

yucatio.hatenablog.com

リソースにfirstとかlastとかtodayでアクセスしたい場合のリンクパスの生成方法 (Ruby on Rails)

railsでリンクパスを作成するときに、

events/123/tickets/1

のようにIDを指定するのではなく、

events/123/tickets/last

のlastように、

リソースパスに文字列を指定する方法。

うまくいく方法

シンボルを渡せばよいだけでした。

event_ticket_path(@event, :last)
#=> /events/123/tickets/last

# routes.rb

Rails.application.routes.draw do
  resources :events  do
    resources :tickets
  end
end

うまくいかない方法

モデルのIDに文字列を渡したところ、0に変換されてしまいました。

ticket = @event.tickets.build(id: 'last')
event_ticket_path(@event, ticket)
#=> /events/123/tickets/0

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6
• RubyMine : 2016.3.1

RubyでArrayをHashに変換する

前回の記事で、ArrayをHashに変換するのにArray#mapとArray#to_hを使用して、ArrayをHashに変換しました。

yucatio.hatenablog.com

オブジェクトの配列を、オブジェクトのIDをハッシュのキー、オブジェクト自身をハッシュのバリューとして登録したい場合があります。

例として、配列のデータをハッシュに変換します。idをキーとして、データ自体を値としたHashを作成するには下記で実現できます。

arr = [
  {id: 1, name: "Alice", age: 20}, 
  {id: 2, name: "Bob", age: 30}
]

arr.map {|data| [data[:id], data]}.to_h
# => 
# {
#   1=>{:id=>1, :name=>"Alice", :age=>20}, 
#   2=>{:id=>2, :name=>"Bob", :age=>30}
# }

順を追って見ていきます。まずmapオブジェクトで、配列の各要素を、[data[id], data]に変換します。

arr.map {|data| [data[:id], data]}
# => 
# [
#   [1, {:id=>1, :name=>"Alice", :age=>20}], 
#   [2, {:id=>2, :name=>"Bob", :age=>30}]
# ]

これを、to_hを使用してハッシュに変換します。

[[1, {:id=>1, :name=>"Alice", :age=>20}], [2, {:id=>2, :name=>"Bob", :age=>30}]].to_h
# => 
# {
#   1=>{:id=>1, :name=>"Alice", :age=>20}, 
#   2=>{:id=>2, :name=>"Bob", :age=>30}
# }

to_hの方法を知る前は以下のように書いていましたが、to_hの方がすっきり書けるように思います。

obj_hash = {}
arr.each { |data|
  obj_hash[data[:id]] = data
}

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6

Railsでajax通信時にattribute名とfull_messageの組み合わせでレスポンスを返す

ajaxでの非同期通信時に、attributeごとのメッセージを表示するのに手間取ったので記録しておきます。

ajax通信でない時は、errors.full_messages_for(:attribute_name)で各attributeのエラーメッセージは取得できます。

やりたいこと

ajax通信時に、入力エラーがある場合に、入力項目ごとに表示したい。

こうなればよい。

errorsを使用する場合(うまくいかなかった例)

コード

class TicketsController < ApplicationController
  def create
    ticket = Ticket.create(ticket_params)

    if ticket.save
      render json: {message: 'success'}, status: :created
    else
      error_messages = ticket.errors
      render json: {message: error_messages}, status: :unprocessable_entity
    end
  end
end

レスポンス

{"message":
  {"password":["を入力してください"],
    "email":["を入力してください","は有効でない形式です"]}
}

画面表示

メッセージボディしか表示されません。これじゃない。

errors.full_messages を使用する場合(うまくいかなかった例)

コード

class TicketsController < ApplicationController
  def create
    ticket = Ticket.create(ticket_params)

    if ticket.save
      render json: {message: 'success'}, status: :created
    else
      error_messages = ticket.errors.full_messages
      render json: {message: error_messages}, status: :unprocessable_entity
    end
  end
end

レスポンスはこのようになります。

{"message":["パスワードを入力してください","メールアドレスを入力してください","メールアドレスは有効でない形式です"]}

画面に表示するとしたらこうなります。

1ヶ所に全てのエラーを表示する場合はこれでもよいですが、項目ごとに表示するといった目的は達成できません。

ticket.errors.keys と errors.full_messages_for 組み合わせる(うまくいった例)

コード

class TicketsController < ApplicationController
  def create
    ticket = Ticket.create(ticket_params)

    if ticket.save
      render json: {message: 'success'}, status: :created
    else
      error_messages = ticket.errors.keys.map { |key| [key, ticket.errors.full_messages_for(key)]}.to_h
      render json: {message: error_messages}, status: :unprocessable_entity
    end
  end
end

レスポンス

{"message":
  {"password":["パスワードを入力してください"],
   "email":["メールアドレスを入力してください","メールアドレスは有効でない形式です"]}
}

画面表示

できました！

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6

RubyMineでRuby on railsの開発をする その8: おすすめ設定3つ

ナビゲーションバーの表示

現在開いているファイルの階層をウィンドウ上部に表示させます。

View > Nabigation Bar を選択

画面上部に awesome_events > app >views > events > new.html.slim と、現在開いているファイルの階層が表示されるようになりました。

階層をクリックすると、同階層の他のファイルが表示され、ここからファイルを開くことができます。同一コントローラの他のファイルを参考のため開くときに便利です。

空白文字の表示

半角空白や全角空白はデフォルトでは単なる空白ですが、空白文字の表示を設定すると、それぞれ別の記号で表示してくれるようになります。

RubyMine メニュー > Preferences..　を選択

Editor > General > Appearence をい開いて、Show whitespaces のチェックを入れます。

半角スペースは.(ドット)、全角スペースは□（四角）、タブは→|で表示されるようになりました。

チームで開発している場合は、チームメンバーにもこの設定を入れてもらいましょう。 新人が全角空白や、タブを仕込んでくるのをちょっとは防げるはず。

ツールバーの表示

各種操作を行うためのツールバーを表示します。

View > Toolbar を選択します。

ツールバーが表示されました。各種タスクを実行するのに便利です。

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6
• RubyMine : 2016.3.1

RubyMineでRuby on railsの開発をする その7: ER図の出力

RubyMineでのERDの出力方法です。引き続き、"パーフェクト Ruby on Rails" に掲載されているサンプルアプリ (awesome_events)を使用していきます。 DBの設定が事前に必要です。

yucatio.hatenablog.com

DBを右クック > Diagrams > Show Visualization... を選択します。

Rails Model Dependency Diagram を選択します。

ER図が出力されました。

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6
• RubyMine : 2016.3.1

RubyMineでRuby on railsの開発をする その6: DB (Sqlite) の設定

RubyMineでのSqliteの設定方法です。引き続き、"パーフェクト Ruby on Rails" に掲載されているサンプルアプリ (awesome_events)を使用していきます。

yucatio.hatenablog.com

Sqliteの設定

View > Tool Windows > Database を開く。

Databaseウィンドウが開きます。

プラス記号 > Import from sources を選択します。

developmentを選択します。

初回はJDBCドライバのエラーが出るので、'Download missing driver files' をクリックして、ドライバファイルをダウンロードします。

Error: Driver class 'org.sqlite.JDBC' not found の対処をします。

リンク先に飛ぶと、Sqliteの設定タブに飛ぶので、ここでApplyを押します。

元の、コネクション作成の画面に戻ります。

Test Connection でコネクションのテストをします。

成功しました。OKを押して、DBの設定を完了します。

DBに接続され、テーブル一覧、カラム一覧が表示されました。 これで開発効率が上がりそうです。

SQLの実行

SQLを実行します。テーブル名やカラム名、SQLキーワードは補完してくれます。便利。

緑の三角矢印を押して、実行します。 表形式で見れます。見やすい。

ちなみに、SQLを入力するウィンドウは、データベースパネル > プラス記号 > Console File で追加することができます。

環境

• Mac : Sierra 10.12.2
• Ruby : 2.3.3
• Rails : 4.2.6
• RubyMine : 2016.3.1