TechTips

rails 7.2で追加されたGitHubワークフローの設定ファイルci.ymlの内容について

@wakairo

20 Dec, 2024 02:59 +00:00

rails 7.2では、新規アプリに対してデフォルトでGitHubワークフローの設定ファイルであるci.ymlが生成されるようになりました。そこで、このci.ymlの内容について簡単に解説します。

なお、ci.ymlの最新のテンプレートはこちらでご覧になれます。

scan_ruby

bin/brakemanコマンドを実行するジョブです。 Railsの一般的なセキュリティ脆弱性がないかどうかチェックします。

scan_js

bin/importmap auditコマンドを実行するジョブです。利用しているJavaScriptパッケージにセキュリティ上の脆弱性がないかどうかチェックします。

lint

bin/rubocopコマンドを実行するジョブです。 Rubyの静的コード解析を行い設定されているルールに準拠しているかどうかチェックします。

test

bin/rails testコマンドを実行するジョブです。なお、skip_system_testオプションが無効であれば、システムテストも実行します。

既存のRailsアプリへのDev Containerの導入

@wakairo

19 Dec, 2024 12:08 +00:00

Rails 7.2においてDev Container設定を生成する機能が追加されました。例えば既存アプリでは、以下のコマンドで既存アプリ用のDev Container設定を生成できるようになりました。

rails devcontainer

生成した設定は、Visual Studio Codeで利用でき、Dev Containerを利用した既存アプリの開発が可能となります。必要となるソフトウェアのインストール等、Dev Containerでの開発を開始するための手順についてはDev Containerでの開発ガイドが参考になります。

なお、Visual Studio Code以外のエディタでもDev Containerで開発できるようにするべくDev Container CLIというツールの開発が進んでいますが、2024年12月現在では、ポートフォワーディングに対応していないなど、今のところはまだまだ開発途中のツールであり、実開発に投入するにはまだ早い段階である印象です。

Dev Container CLIはポートフォワーディングをサポートしていない

@wakairo

19 Dec, 2024 11:48 +00:00

Dev Container CLIはポートフォワーディングをサポートしていないので、Dev Containerの中で動かしたWebサーバへDev Containerの外で動いているブラウザからアクセスするようなことはDev Container CLI単体では出来ないそうです。ちなみに、ポートフォワーディングを可能にする手法やツールはいくつか提案されているようです。

Dev Container CLIは開発途中でコンテナの停止や削除は未実装

@wakairo

19 Dec, 2024 11:40 +00:00

公式GitHubレポジトリを見ると、2024年12月現在、以下の機能に完了のチェックマークがまだ入っていません。

devcontainer stop - Stops containers
devcontainer down - Stops and deletes containers

Windows Terminalのコマンドは「wt」

SatoKen @kenicode

18 Dec, 2024 00:01 +00:00

したがって、ウインドウズキーを押してから、「wt」と打って、エンターでWindows Terminalを起動可能。

その他、引数など、コマンドラインからWindows Terminalを叩く場合の詳細は以下から。

https://learn.microsoft.com/ja-jp/windows/terminal/command-line-arguments?tabs=windows

Raspberry Pi Picoシリーズの開発をVisual Studio Code拡張を使わずに行う方法

@wakairo

16 Dec, 2024 02:18 +00:00

Last edited

16 Dec, 2024 02:19 +00:00

Raspberry Pi Picoシリーズの開発は、Visual Studio Code（以下、VS Code）にPico用の拡張を入れて行えますが、 VS Code以外のエディタを使いたいときなど、VS Codeに頼らない開発の仕方が公式ドキュメントで紹介されています。

VS Codeを使用しないRaspberry Pi Picoシリーズの開発の方法は、具体的には、ラズパイの公式C/C++ SDKドキュメントページで紹介されている「Getting started with Raspberry Pi Pico-series」という名前のPDF の「Manually Configure your Environment」の項目で紹介されています。

同様に、VS Codeを使用しないでPicoシリーズ用の新規プロジェクトを作成する方法は、同PDFの「Manually Create your own Project」の項目で紹介されています。

BlueStacks 5でアプリがシャットダウンを繰り返す問題の解決策

バグ職人楓 @K0x080BADF00D

09 Dec, 2024 11:02 +00:00

BlueStacks 5を立ち上げてしばらく経つと動かしていたアプリが勝手にシャットダウンする現象に遭遇し困っていた。ネットで少し調べてみて、「Google Playストア」アプリの「ストレージを消去」したところ、この現象が起きなくなった。ちなみに、ストアアプリやシャットダウンしていた方のアプリでキャッシュ削除をしたりもしたので、このキャッシュ削除の方が有効打になった可能性もある。以上ご参考まで。

バージョン

BlueStacks App Player 5.21.600.1019 P64

参考

https://www.reddit.com/r/BlueStacks/comments/1h6lqje/bluestacks_app_interface_freezing_and_google/

Webページでのhreflangの設定に関するGoogleの情報

Takuma @takuma_tech

07 Dec, 2024 06:59 +00:00

Last edited

07 Dec, 2024 07:02 +00:00

以下のようなHTML等でのhreflangの設定は、SEO (Search Engine Optimization)と関係して、検索エンジンにページの関係性を正しく認識してもらうために行う場合が大半だと思います。

<html>
  <head>
    <link rel="alternate" hreflang="en" href="https://example.com/en/page.html">
    <link rel="alternate" hreflang="ja" href="https://example.com/ja/page.html">
    <link rel="alternate" hreflang="x-default" href="https://example.com/page.html">
  </head>
  <body>
  ...
  </body>
</html>

そして、日本では最も最適化をしたい検索エンジンはGoogleの場合が大半だと思います。

Googleが説明するhreflangの設定の仕方

Googleが公開している以下のWebページには、Googleが期待するhreflangの設定の仕方が説明されています。

ページのローカライズ版について Google に知らせる: https://developers.google.com/search/docs/specialty/international/localized-versions?hl=ja

以上、Google検索結果で良い感じに表示されることを目指してhreflangの設定するのであれば、まずはこちらのWebページを参考にすると良いのではないかと思いまして、ご紹介いたしました。

既存のRailsアプリへのRuboCopの導入

@wakairo

06 Dec, 2024 05:28 +00:00

Last edited

06 Dec, 2024 08:18 +00:00

Rails 7.2からRuboCopが新規アプリケーションでデフォルトで有効になりました。このTopicでは、7.1以前で作成した既存RailsアプリにRuboCopを後から導入して、RuboCopに関して7.2の新規アプリ相当の状態にセットアップする方法をご紹介します。

RuboCop (Omakase Ruby styling for Rails) のインストール

基本的にはrubocop-rails-omakaseの公式ドキュメントのインストール手順に従います。

まず以下のように、Gemfileのgroup :development, :testのところにrubocop-rails-omakaseを追加します。

group :development, :test do

  # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
  gem "rubocop-rails-omakase", require: false

end

次にbundle installを実行して、RuboCop等をインストールします。

bundle install

さらに、必須ではありませんが、bin/rubocopでRuboCopを実行できるように、以下のコマンドを実行します。

bundle binstubs rubocop

最後に.rubocop.ymlという名前でファイルを作成し、以下の内容を記述します。

# Omakase Ruby styling for Rails
inherit_gem:
  rubocop-rails-omakase: rubocop.yml

以上でRuboCop (Omakase Ruby styling for Rails) のセットアップが出来ました。

ローカル環境でのbin/rubocopの実行とその結果に対する対応の進め方

以下のコマンドでbin/rubocopを実行でき、omakaseのチェックを行えます。

bin/rubocop

このチェックでの指摘事項が多かった場合、以下のオプションを付けて実行することで、無視設定を記述した.rubocop_todo.ymlというファイルが作成され、 .rubocop.ymlにもこの無視ファイルを参照する設定が追加されますので、とりあえず全ての指摘事項を無視するように設定が出来ます。

bin/rubocop --auto-gen-config

設定が出来たら、bin/rubocopを実行して、とりあえず指摘事項の数が0となることを確認します。

1つずつ指摘事項へ対応

ここから先は、以下の手順を繰り返します。

.rubocop_todo.ymlから1項目を削除
bin/rubocopを実行して指摘内容を確認して対応
- bin/rubocop -aもしくはbin/rubocop -Aを実行して自動修正できるものは自動修正し、その修正内容で問題ないことを確認
  - -aは安全なもののみ、-Aは安全で無いものも含めて自動修正を行います。
- 自動修正できなかったものは手作業で修正・確認
- 特定のファイルのみチェックを回避する場合は、.rubocop.ymlにてExclude:を用いて設定
- ソースコードの特定の箇所（行）のみチェックを回避する場合は、ソースファイルのコメントに# rubocop:disable等を用いて設定
- 指摘内容に対応する規則を完全に採用しない場合には、.rubocop.ymlにてEnabled: falseの記述を用いて規則を無効にする

1項目ずつ対応を進め、.rubocop_todo.ymlの中身が無くなったら、.rubocop_todo.ymlを削除すると共に、.rubocop.yml内で.rubocop_todo.ymlを参照している設定を削除します。ここまで終わればRuboCopの諸規則への対応は完了となります。お疲れ様でした。

GitHubワークフロー（CI）でのrubocopの実行

.github/workflows/ci.ymlに相当するファイルがなければ作成します。この.ymlファイルを編集して、以下のようにjobsの下にlintジョブを追加します。

注意点

timeout-minutes:の設定は、実行時間に対して十分余裕を持たせて下さい。
ruby-version: .ruby-versionという設定は、プロジェクトルートにある.ruby-versionという名前のファイルで指定されているrubyのバージョンという意味になります。この設定について詳しくはこちらのTopicをご覧下さい。
-f githubオプションは、出力フォーマットをGitHub Actionsに適したものにするオプションです。

jobs:
  lint:
    runs-on: ubuntu-latest
    timeout-minutes: 10

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

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: .ruby-version
          bundler-cache: true

      - name: Lint code for consistent style
        run: bin/rubocop -f github

公式情報

RuboCopのその他の詳細についてはRuboCop公式ドキュメントをご覧ください。
Omakase Ruby styling for RailsのRuboCop設定の最新の内容はGitHubで確認出来ます。なお、最新ではなくインストールしたバージョンのRuboCop設定内容をご覧になりたい場合は、GitHubの操作でTagsから当該バージョンを選択するようにして下さい。

RubyのArrayやHashのリテラルをdeep freezeするshareable_constant_valueマジックコメント

@wakairo

04 Dec, 2024 02:44 +00:00

概要

Rubyでは、以下のようにshareable_constant_value: literalというマジックコメントを記入することで、以下の例のように、定数に代入したArrayやHashのリテラルを深く（deeply）freezeすることが出来ます。

# shareable_constant_value: literal

X = [{foo: []}]
X.frozen? # => true
X[0].frozen? # => true
X[0][:foo].frozen? # => true

少し詳しい話

shareable_constant_valueマジックコメントはRuby 3.0で導入されました。

注意点

このマジックコメントのliteralモードでfreezeされるのは定数が対象であるため、以下のように、代入先が変数である場合にはfreezeされません。

# shareable_constant_value: literal

z = []
z.frozen? # => false

また、このマジックコメントのliteralモードを指定したファイル内では、以下のように、「freezeされていないオブジェクト」や「freezeされていないものを含むオブジェクト」を定数に代入しようとするとエラーが発生します。

# shareable_constant_value: literal

Y = [{}, Object.new] # => エラー発生

裏を返せば、以下のように、freezeすればエラーが回避できます。また、freezeする定数とfreezeしない定数でファイルを分けるという自然なアプローチでもエラーを回避できます。

# shareable_constant_value: literal

Y = [{}, Object.new.freeze]

参考文献

Ruby公式のshareable_constant_valueのドキュメント

Categories

Latest comments

rails 7.2で追加されたGitHubワークフローの設定ファイルci.ymlの内容について

scan_ruby

scan_js

lint

test

既存のRailsアプリへのDev Containerの導入

Dev Container CLIはポートフォワーディングをサポートしていない

Dev Container CLIは開発途中でコンテナの停止や削除は未実装

Windows Terminalのコマンドは「wt」

Raspberry Pi Picoシリーズの開発をVisual Studio Code拡張を使わずに行う方法

BlueStacks 5でアプリがシャットダウンを繰り返す問題の解決策

バージョン

参考

Webページでのhreflangの設定に関するGoogleの情報

Googleが説明するhreflangの設定の仕方

既存のRailsアプリへのRuboCopの導入

RuboCop (Omakase Ruby styling for Rails) のインストール

ローカル環境でのbin/rubocopの実行とその結果に対する対応の進め方

1つずつ指摘事項へ対応

GitHubワークフロー（CI）でのrubocopの実行

注意点

公式情報

RubyのArrayやHashのリテラルをdeep freezeするshareable_constant_valueマジックコメント

概要

少し詳しい話

注意点

参考文献