はじめに
検索機能の実装過程で新しい気づきがあったので記事に残しておきます。
よろしくお願いします。
自作のアクション
ここではRailsの7つのアクションとされるもの以外に、自分で作ったアクションのことを「自作のアクション」と呼んでいます。
今回検索機能を実装するにあたって、新たにコントローラーに「search」アクションというものを作成しました。
def search
@tweets = Tweet.search(params[:keyword])
end
コントローラーの中にこんな感じで記述しました。
モデルの方でこの中で使われているsearchメソッドは定義されていますが、今回は特に説明はしません。
memberとcollection
memberとcollectionはルーティングを設定するときに使用できる、URLや実行されるコントローラーを任意にカスタムできるものです。
例えばmemberを使ってルーティングを設定すると下記のようになります。
Rails.application.routes.draw do
resources :tweets do
member do
get 'search'
end
end
end
rails routesすると↓
Prefix Verb URI Pattern
search_tweet GET /tweets/:id/search(.:format) tweets#search
collectionを使用すると下記のようになります。
Rails.application.routes.draw do
resources :tweets do
collection do
get 'search'
end
end
end
rails routesでルーティング確認すると↓
Prefix Verb URI Pattern
search_tweets GET /tweets/search(.:format) tweets#search
この二つの違いは、URLの指定先に:idが含まれているか否かになります。
memberは:idあり。
collectionは:idなし。
終わりに
実装途中にこれ大事だ！と思い取り急ぎ記事にしました。
実際に実装した検索機能の手順は追って記事にしたいと思います。
Railsのroutesに以下のとおりnamespaceを追加設定した際に、それまで動いていたcontrollerが動かなくなってしまった。なお、コントローラのファイルはapp/controllers/api配下に移動済み。
routes.rb（変更前）
Rails.application.routes.draw do
resources :posts
end
routes.rb（変更後）
Rails.application.routes.draw do
namespace :api do
resources :posts
end
end
事象
namespace設定までは、例えば以下のURLへのGETに対し合致するデータをJSONで返していた。
$ curl localhost:5000/posts/1
namespace設定後はURLが変わるだけかと思っていたが、エラーを返すようになってしまった。
$ curl localhost:5000/api/posts/1
~
TypeError (superclass mismatch for class PostsController):
解決策
コントローラのクラス名も、ルーティングのnamespaceに合わせて「Api::」と階層を明示する必要があった。
posts_controller.rb（変更前）
class PostsController < ApplicationController
def show
@post = Post.find(params[:id])
render json: { data: @post }
end
end
posts_controller.rb（変更後）
class Api::PostsController < ApplicationController
def show
@post = Post.find(params[:id])
render json: { data: @post }
end
end
補足
API::の代わりにmoduleで囲っても動いた。
posts_controller.rb
module Api
class SavingDetailsController < ApplicationController
def show
@saving_detail = SavingDetail.find(params[:id])
render json: { data: @saving_detail }
end
end
end
routesのnamespaceを先に書いてからコントローラをgenerateしていたら、最初から適切なクラス名にしてくれていたんだろうか？
はじめに
本記事は、テストコードに関するもので、
FactoryBotにimageを記述する方法（factoriesディレクトリ）を記述します。
本日、何時間も悩んだものになるので、
短いですが、アウトプットしたいと思います。
単体テストコードに関する記事は、以下も参照してください。
内容的には、ターミナルにて以下を記述後のこととなっております。
% rails g rspec:model テーブル名
FactoryBotにActiveStorageの記述をする
例
早速ですが、例文です。
FactoryBot.define do
factory :tweet do
content {Faker::Lorem.sentence}
association :user
after(:build) do |tweet|
tweet.image.attach(io: File.open('ディレクトリ名/画像ファイル名'), filename: 'ファイル名')
end
end
end
afterメソッド
任意の処理の後（ここでは、（:build））の後に、
指定の処理(（:build）以降の処理)を実行することができます。
io: File.open
ここで設定したパスのファイル（'ディレクトリ名/画像ファイル名'）をfilenameを'ファイル名'として実行しています。
association
今回の趣旨とは、やや離れますが、
対象のテーブルとのアソシエーションも忘れずに記述しましょう。
association :user
実際にしてしまったミス
①テーブルのカラムに存在すると勘違いしてしまい、
今回の例文に沿って記述すると
// （注意）謝った記述です。
FactoryBot.define do
factory :tweet do
image {'ディレクトリ名/ファイル名'} ←間違い！！
content {Faker::Lorem.sentence}
association :user
end
end
と記述してしまった。
②カラムに存在しないことがわかり、アソシエーションするのかと勘違いした。
// （注意）謝った記述です。
FactoryBot.define do
factory :tweet do
content {Faker::Lorem.sentence}
association :user
association :image ←間違い！！
end
end
終わりに
学習したことでしたが、全く初見のように思えてしまいました。
このようなことは今後も増えてきてしまうかと思いました。
しかし、忘れているのなら、
次は、理解して覚えていたら良いことです。
後ろは、フィードバックする時以外は向かず、
新しく出てきたものや、再度登場してきたものをどんどん理解していきたいと思います。
それでは、
明日も頑張りましょう！！
