窓際BLOG

プログラミングの学習メモや書籍の感想等を公開していきます。

ruby:Rubocopの使い方と警告について

最近Rubocopを使いはじめたので、使い方とか警告の意味とかをメモφ(..)

Rubocopとは

RubocopはOSSで開発されているソースコードの静的解析を行うgemです。
RubyStyleGuidソースコードが準拠しているかチェックすることが出来ます。
Githubリポジトリ:https://github.com/bbatsov/rubocop

実際の開発現場でも使われているので、普段の勉強から使っていき綺麗なコードを書く習慣を身に着けたい…!

Rubocopの使い方

インストー

$ gem install rubocop

使い方

ファイルの検証

$ rubocop hoge.rb

警告欄

文字 意味
. Clean(問題なし)
C Convention(慣習違反)
W Warning
E Error
F Fatal
Inspecting 1 file
C

Offenses:

hoge.rb:28:1: C: Missing top-level class documentation comment.
class Hoge
^^^^^

1 file inspected, 1 offenses detected

警告メッセージMemo

Extra empty line detected at class body end.

google翻訳

クラス本体の最後で余分な空行が検出されました。

class Hoge
  def fuga
    return piyo
  end
  # 不正な改行
end

Final newline missing.

google翻訳

最終改行がありません。

class Hoge
  def fuga
    return piyo
  end
end # ファイルの末尾に改行なし

1 trailing blank lines detected.

google翻訳

1つの末尾空白行が検出されました。

class Hoge
  def fuga
    return piyo
  end
end
# 空白行
# 空白行 : NG

Space missing after comma.

google翻訳

コンマの後にスペースがありません。

# カンマのあとにスペースが入っていない
Hoge.new(a,b,c) # NG
Hoge.new(a, b, c) # OK

Trailing whitespace detected.

google翻訳

末尾の空白が検出されました。

class hoge
  def fuga
    puts piyo
  end  # 行の末尾に空白文字
end

Missing top-level class documentation comment.

google翻訳

トップレベルのクラスのドキュメントコメントがありません。

# クラスの1行上にコメントを書く
class hoge
  def fuga
    puts piyo
  end
end

Use only ascii symbols in comments.

google翻訳

コメントにはASCII記号のみを使用してください。

# piyoを出力 : NG
# output piyo : OK
puts piyo

Space inside { missing. / Space inside } missing.

google翻訳

内側にスペースがありません。

# {}の内側には半角スペースを入れる。
{ hoge: "hoge", fuga: "fuga" }

Line is too long. [84/80]

google翻訳

ラインが長すぎます。 [84/80]

# 1行の文字数は80文字まで
# NG
puts HogeHoge.new(hogehoge: 52, fugafuga: 11, piyopiyo: piyo.new("hiyoco", "niwatori")).hogefugapiyo_method
# OK
hoge = HogeHoge.new(
  hogehoge: 52, 
  fugafuga: 11, 
  piyopiyo: piyo.new("hiyoco", "niwatori")
)
puts hoge.hogefugapiyo_method

Closing method call brace must be on the line after the last argument when opening brace is on a separate line from the first argument.

google翻訳

中括弧を最初の引数とは別の行に置いているときに、最後の引数の後の行には、メソッド呼び出し中括弧を閉じる必要があります。

# 1行の文字数は80文字まで
# NG
Hoge.new(
  hoge: "hoge",
  fuga: "fuga")
# OK:閉じ括弧の位置は開始の位置と合わせる。
Hoge.new(
  hoge: "hoge",
  fuga: "fuga"
)

おわりに

また新しいメモや警告があれば追記していきます!φ(..)

参考ページ

wonderwall.hatenablog.com

RubyonRails:deviseのエラーメッセージをカスタマイズする方法

deviseで発生するエラーメッセージのBootstapっぽくしたかったので、その方法をφ(..)メモメモ

事象

deviseでは、通常エラーメッセージをdevise内で定義されているdevise_error_messages!で表示させるため、class等を設定し、レイアウトを調整することは出来ない。

f:id:madogiwa0124:20170610103432p:plain

対処法

devise_error_messages!とは別にメソッドをHelperに定義し、エラーメッセージを返却すれば良い。

  # デバイスのエラーメッセージ出力メソッド
  def devise_error_messages
    return "" if resource.errors.empty?
    html = ""
    # エラーメッセージ用のHTMLを生成
    messages = resource.errors.full_messages.each do |msg|
      html += <<-EOF
        <div class="error_field alert alert-danger" role="alert">
          <p class="error_msg">#{msg}</p>
        </div>
      EOF
    end
    html.html_safe
  end

修正後 f:id:madogiwa0124:20170610103653p:plain

参考にしたページ

qiita.com

Bootstrap:ナビゲーションバーの丸みをなくす方法

Bootstrapのナビゲーションバーに微妙に丸みがあるのが気になったので、無くす方法をメモφ(..)

事象

Bootstrapのナビゲーションバーはデフォルトでは、微妙に丸みを帯びている。
いままで見てみぬふりをしてきたが、結構気になっていた。。。

f:id:madogiwa0124:20170607223836p:plain

bootstrap3.cyberlab.info

解決方法

下記CSSを記載すればOK

.navbar{
  border-radius: 0px;
}

Chrome等で検証すればわかるが、
デフォルトでは.navbar5pxradiusが設定されてる。
これを上書きしてあげればOK!

f:id:madogiwa0124:20170607224205p:plain

※画像はCSS反映後のため無効化されてます。

RubyonRails:SNSログインエラーの確認ポイント

SNSログイン周りのエラーで大分ハマったので、確認観点をメモ。

エラー

Facebook
f:id:madogiwa0124:20170606230855p:plain Twitter
f:id:madogiwa0124:20170606230915p:plain

API KEYとSECRET KEYは一致しているか?

API KEYとSECRET KEYが作成したAPIと一致しているか確認する。

API KEYとSECRET KEYは取得出来ているか?

下記コマンドを実行し、環境変数が取得出来ているかを確認する。

$ rails console
$ ENV["指定したAPI KEY"]
$ ENV["指定したSECRET KEY"]

取得出来ない場合は、環境変数の名称と取得側の名称が異なっている可能性がある。
例)環境変数:aaa=~~~ / 取得側:aaA=~~~

.envファイルの配置場所

dotenvを使用している場合は、.envファイルの配置場所に注意
rootフォルダ(アプリケーション名)直下に配置すること

RubyonRails:データベースをsqlite3からpostgresqlに変更する方法

間違えてsqlite3でRailsアプリケーションを作成してしまい、

途中からposgresqlに変更した手順をメモφ(..)

変更手順

Gemfileの修正

sqlite3コメントアウトし、postgresql用のgempgに変更

# gem 'sqlite3'
gem 'pg'

変更後、下記コマンドを実行

bundle install

database.ymlの修正

config/databese.ymlの内容をpostgresql用に修正

appnameにはrails newした際に指定したアプリケーション名を設定

 

default: &default
adapter: postgresql
encoding: unicode

pool: 5
template: template0


development:
<<: *default
database: appname_development

test:
<<: *default
database: appname_test

production:
<<: *default
database: Facebook_clone_production
username: Facebook_clone
password: <%= ENV['appname_DATABASE_PASSWORD'] %>

dbの再作成とmigrateの再実行

下記コマンドを実行し、dbの再作成とテーブル定義の反映を行う。

$ rake db:creat

$ rake db:migrate

参考資料

blog.bgbgbg.net

RubyonRails:登録時にRollbackされる原因がわからない時の対処法

model.saveの際になぜか TransactionがRollbackされ原因調査でハマったのでメモφ(..)

対処法

model.save!で登録を行ってみる。 model.saveの返り値は、true/falseのため、どのようなエラーが発生しROLLBACKされているかはわからない。 しかし、model.save!では、ActiveRecordの例外を返してくれるため、原因調査に役立つ。

実際の結果

[2] pry(#<MessagesController>)> @message.save
   (0.1ms)  begin transaction
  Message Exists (0.3ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."body" = 'ああああ' LIMIT 1
  Message Exists (0.2ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."conversation_id" = 1 LIMIT 1
  Message Exists (0.2ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."user_id" = 2 LIMIT 1
   (0.1ms)  rollback transaction
=> false
[3] pry(#<MessagesController>)> @message.save!
   (1.3ms)  begin transaction
  Message Exists (0.8ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."body" = 'ああああ' LIMIT 1
  Message Exists (0.3ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."conversation_id" = 1 LIMIT 1
  Message Exists (0.4ms)  SELECT  1 AS one FROM "messages" WHERE "messages"."user_id" = 2 LIMIT 1
   (0.1ms)  rollback transaction
ActiveRecord::RecordInvalid: Validation failed: Conversation has already been taken, User has already been taken

こんな感じでエラーの原因を確認出来る。

参考にしたページ

d.hatena.ne.jp

RubyonRails:検索フォームの作り方

Railsで検索フォームを作ったときに少しハマったので、メモ

やりたかったこと

トップページにユーザー検索を行うフォームを設置し、 検索ボタン押下後、検索結果を引き継いだユーザー一覧を表示。

解決方法

<form action="呼び出したいアクションに紐づくurl">を設定すれば良い。 ※呼び出したい

実際のコード

routes.rb

  # /users にusers_controllerのindexアクションが紐付いている。
  resources :users, only: [:index]

application.html.erb

        <!-- actionにcontrollerのアクションに紐づくURL"/users"を設定 -->
        <form class="navbar-form navbar-left" action="/users">
          <div class="input-group">
            <div class="form-group">
              <!-- nameで指定した値"user_name"でcontroller側で取得出来る -->
              <input type="text" name="user_name" class="form-control" placeholder="友達を探す">
            </div>
            <span class="input-group-btn">
              <button type="submit" class="btn btn-default">検索</button>
            </span>
          </div>
        </form>

users_controller.rb

  def index
    # ユーザーの取得処理
    @users = user_search(params['user_name'])
  end

参考にさせて頂いたページ

rails.densan-labs.net qiita.com