2024年9月29日日曜日

Rails の Devise で認証を実現する

プロジェクト作成

rails new app --javascript importmap --css tailwind --asset-pipeline sprockets -d postgresql --no-api

データベース設定

config/database.yml

今回はただの学習目的なので、全定義を default に書いてしまう。

# PostgreSQL. Versions 9.3 and up are supported.
#
# Install the pg driver:
#   gem install pg
# On macOS with Homebrew:
#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
# On Windows:
#   gem install pg
#       Choose the win32 build.
#       Install PostgreSQL and put its /bin directory on your path.
#
# Configure Using Gemfile
# gem "pg"
#
default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # https://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  database: public
  host: postgres
  username: admin
  password: password

development:
  <<: *default

  # The specified database role being used to connect to PostgreSQL.
  # To create additional roles in PostgreSQL see `$ createuser --help`.
  # When left blank, PostgreSQL will use the default role. This is
  # the same name as the operating system user running Rails.
  #username: app

  # The password associated with the PostgreSQL role (username).
  #password:

  # Connect on a TCP socket. Omitted by default since the client uses a
  # domain socket that doesn't need configuration. Windows does not have
  # domain sockets, so uncomment these lines.
  #host: localhost

  # The TCP port the server listens on. Defaults to 5432.
  # If your server runs on a different port number, change accordingly.
  #port: 5432

  # Schema search path. The server defaults to $user,public
  #schema_search_path: myapp,sharedapp,public

  # Minimum log levels, in increasing order:
  #   debug5, debug4, debug3, debug2, debug1,
  #   log, notice, warning, error, fatal, and panic
  # Defaults to warning.
  #min_messages: notice

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
  <<: *default
  database: test

# As with config/credentials.yml, you never want to store sensitive information,
# like your database password, in your source code. If your source code is
# ever seen by anyone, they now have access to your database.
#
# Instead, provide the password or a full connection URL as an environment
# variable when you boot the app. For example:
#
#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
#
# If the connection URL is provided in the special DATABASE_URL environment
# variable, Rails will automatically merge its configuration values on top of
# the values provided in this file. Alternatively, you can specify a connection
# URL environment variable explicitly:
#
#   production:
#     url: <%= ENV["MY_APP_DATABASE_URL"] %>
#
# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
# for a full overview on how database connection configuration can be specified.
#
production:
  <<: *default
  database: production

トップページの作成

controller 作成

rails generate controller top

view 作成

view ファイル作成

app/view/top/index.html.erb

<h1>Welcome top page</h1>

ルーティング変更

config/routes.rb

...(snip)
  # Defines the root path route ("/")
  # root "posts#index"
  root "top#index"
...(snip)

動作確認

BINDING=0.0.0.0 ./bin/dev

ホスト PC のブラウザで、 http://localhost:3000 にアクセスすると、 Welcome top paga とだけ記載されたページが表示される。

OK.

devise で認証をする

devise gem のインストール

Gemfile に gem "devise" を追加し、 bundle install する。

プロジェクトに devise をインストール

実行後、ガイドが表示されるので、基本的にガイドに従えば OK。

$ rails generate devise:install
      create  config/initializers/devise.rb
      create  config/locales/devise.en.yml
===============================================================================

Depending on your application's configuration some manual setup may be required:

  1. Ensure you have defined default url options in your environments files. Here
     is an example of default_url_options appropriate for a development environment
     in config/environments/development.rb:

       config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }

     In production, :host should be set to the actual host of your application.

     * Required for all applications. *

  2. Ensure you have defined root_url to *something* in your config/routes.rb.
     For example:

       root to: "home#index"
     
     * Not required for API-only Applications *

  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
     For example:

       <p class="notice"><%= notice %></p>
       <p class="alert"><%= alert %></p>

     * Not required for API-only Applications *

  4. You can copy Devise views (for customization) to your app by running:

       rails g devise:views
       
     * Not required *

===============================================================================

「1.」は定義済み。「2.」も定義済み。

「3.」の実施

app/views/layouts/application.html.erb

<!DOCTYPE html>
<html>
  <head>
    <title><%= content_for(:title) || "App" %></title>
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <%= csrf_meta_tags %>
    <%= csp_meta_tag %>

    <%= yield :head %>

    <link rel="manifest" href="/manifest.json">
    <link rel="icon" href="/icon.png" type="image/png">
    <link rel="icon" href="/icon.svg" type="image/svg+xml">
    <link rel="apple-touch-icon" href="/icon.png">
    <%= stylesheet_link_tag "tailwind", "inter-font", "data-turbo-track": "reload" %>
    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
    <%= javascript_importmap_tags %>
  </head>

  <body>
    <main class="container mx-auto mt-28 px-5 flex">
    <div>
      <p class="notice"><%= notice %></p> <!-- この行を追加 -->
      <p class="alert"><%= alert %></p> <!-- この行を追加 -->
    </div>
      <%= yield %>
    </main>
  </body>
</html>

「4.」はログインの View を改造したい場合に行う。 今回は firststep という事で、デフォルトのままやってみる。

devise 用モデルの作成

firststep とは関係のない諸々のわけがあって、今回は accounts テーブルにログイン情報を保存するように設定していく。

rails generate devise Accounts
rails db:migrate

devise 用コントローラーの作成

firststep とは関係のない諸々のわけがあって、今回は accounts テーブルにログイン情報を保存するように設定していく。

rails generate devise:controllers account

ページ表示時に強制的にログインを促す

app/controllers/application_controller.rb

class ApplicationController < ActionController::Base
  before_action  # この行を追加
  # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
  allow_browser 
end

この場合、ApplicationController に記載したので、全ページにログインが必要という事になる。 特定ページのみであれば、そのページの controller に仕込むことになるっぽい?

動作確認

ホスト PC のブラウザで、 http://localhost:3000 にアクセスすると、ログイン画面が表示される。

右上の Sign up を押下し、ユーザー登録を済ませると、 Welcome! You have signed up successfully. という言葉とともに、トップページが表示される。

(スタイルを何も定義していないので一行に表示されてしまうが、今回は無視する)

2024年9月25日水曜日

私がよく使う Vim のコマンド・マッピングの紹介

この記事は Vim 駅伝 の 2024/09/25 の記事です。 前回の記事は staticWagomU さんによる、 2024/09/23 の「winbarを自作したよ」という記事でした。

次回は 2024/09/27 に投稿される予定です。

これの記事はなに?

普段ファイル編集時に使っているマッピングやコマンドを、 vimrc から抜き出してみました。 何かしら、マッピングやコマンドの参考になりましたら幸いです。

前提

開発はいつも dev container 内で vim/vim-appimage: AppImage for gVim を使用しているが、 ブログなど、書き物を書くときは vim/vim-win32-installer: Vim Win32 Installer を使用している。

また、Vim デフォルトのものは書いていません。

目的別ファイルを開く

コマンド or マッピング 内容
:Vimrc vimrc を開く
:Gvimrc gvimrc を開く
:Tmp ~/worklog/<strftime('%Y%m%d')_<N>>.md を作成し、開く。ブログとか作業記録とかなんでも書いていくやつ
:Teirei 定例用ファイル (~/worklog/<strftime('%Y%m%d')_定例_<N>>.md) を開く
:M2h pandoc を利用して html へ変換・表示。この HTML をブログにコピペしている
<Leader>e file_explorer.vim を起動(file_explorer.vim 用のマッピングは省略)

バッファー操作

コマンド or マッピング 内容
noremap <Leader>l バッファーリストを表示(buffer_selector.vim を利用。スパルタンな場合には、 :buffers を実行)
noremap <Leader>bb 直前のバッファに戻る
noremap <Leader>sp :split
noremap <Leader>vs :vsplit

ファイル編集中

コマンド or マッピング 内容
inoremap <C-@> <C-[> を押そうとして <C-@> を誤爆しまくったので <ESC> 扱いしてしまう
noremap <C-@> 同上
nnoremap <Esc><Esc> <ESC> 連打でハイライト削除
noremap <Leader>cn :cnext
noremap <Leader>cp :cprev
<C-x><C-o> vim-lsp の補完を呼び出す
<C-x><C-u> ユーザー定義補完でスニペットを呼び出す
:Template vim-sonictemplate の呼び出し

VSCode 互換マッピング

コマンド or マッピング 内容
inoremap <C-.> vim-lsp コードアクション
nnoremap <C-.> 同上
inoremap <F2> vim-lsp リネーム
nnoremap <F2> 同上
inoremap <A-S-f> vim-lsp フォーマット
nnoremap <A-S-f> 同上
vnoremap <A-S-f> 同上
inoremap <F12> vim-lsp 宣言へジャンプ
nnoremap <F12> 同上
inoremap <C-k><C-i> vim-lsp ホバー表示
nnoremap <C-k><C-i> 同上

改めてみると凝ったマッピングをしていない感ありますね。(凝ったのはプラグインに逃がしたという話かもしれない)

(ここに出てこないという事は普段使いしていないという事で、この機会が消すチャンスな気がする。盆栽するかぁ???)

以上です。

変更履歴

日付 内容
2024/9/25-1 新規作成
2024/9/25-2 前回記事の日付を間違えていたので修正

2024年9月4日水曜日

Vim のマクロを有効活用するためにいろいろ試してみたら、最終的に exec normal に行き着いた

この記事は Vim 駅伝 の 2024/09/04 の記事です。 前回の記事は mikoto2000 さんによる、 2024/08/30 の「Vim を pager にしたら filetype の決め方に少し詳しくなった」という記事でした。

次回は 2024/09/06 に投稿される予定です。

前提

  • OS: Windows 11 Pro 23H2 ビルド 22631.4037
  • Vim: 9.1.598

実験

記録と再生

Hello, World! と入力するマクロを作る。

記録

qqaHello, World!<ESC>q

q<レジスタ><キーストローク>q<レジスタ> にマクロが記録できる。

再生

@q

@<レジスタ><レジスタ> に記録したマクロを再生する。

マクロのシリアライズ

マクロも、「レジスタに記録されたデータ」でしかないので、ペーストできる。

レジスタ q に記録したマクロのシリアライズ

普通にペーストするだけ

"qp

先ほどの「Hello, World! と入力するマクロ」の場合、以下データがペーストされる。

aHello, World!^[

^[ は、 2 文字の文字列ではなく、 ESC の制御文字

記録したマクロを変数に格納

バッファに出力してもつまらないので、レジスタを変数に格納する。

let hello_macro = @q

これで、レジスタの値が変数 hello_macro に格納される。

なので、次のように echo するとペーストしたときと同じデータが表示される。

:echo hello_macro
-> aHello, World!^[

^[ は、 2 文字の文字列ではなく、 ESC の制御文字

Vim script 内での利用

executenormal を併用することで、シリアライズしたマクロを実行できる。

execute "normal <ここにマクロを記録したレジスタをペーストする>"

例えば、先ほどの Hello, World! を出力するマクロを実行したい場合、以下コードで実行できる。

execute "normal aHello, World!^["
-> バッファに `Hello, World!` が入力される

^[ は、 2 文字の文字列ではなく、 ESC の制御文字

コマンドにしてしまう

Vim script で使えるという事は、コマンドにもできるという事で、以下のようにコマンドにできる。

command! CommandName exec ':normal <ここにマクロを記録したレジスタをペーストする>'

そらで書くには辛いけど、たまにあると便利なマクロをコマンドとして登録しておくと幸せになるかも。

自分は今回、ケース変換処理をコマンドにした。

""" {{{ for convert case
command! ConvertToLowerCamel exec ':normal viwuve:s/\v_(.)/\u\1/g^M'
command! ConvertToUpperCamel exec ':normal viwuvUe:s/\v_(.)/\u\1/g^M'
command! ConvertToLowerSnake exec ':normal viw:s/\C\v(.)([A-Z])/\1_\l\2/g^Mvu'
command! ConvertToUpperSnake exec ':normal viw:s/\C\v(.)([A-Z])/\1_\l\2/g^MviwU'
""" }}} for convert case

^M は、 2 文字の文字列ではなく、 Enter の制御文字

結局最終成果物はコマンドになってしまったが、コマンドにマクロをペーストすることで、 「たまにある面倒な作業がコマンド一発」となるので、まぁいい感じにはなるのではないでしょうか?

以上。

2024年9月2日月曜日

Vim を pager にしたら filetype の決め方に少し詳しくなった

この記事について

この記事は Vim 駅伝 の 2024/09/02 の記事です。 前回の記事は eetann さんによる、 2024/08/30 の「NeovimでLLMを動かすcodecompanion.nvimの使い方」という記事でした。

次回は 2024/09/04 に投稿される予定です。

背景

「Vim はあるが less はない」という特殊なコンテナ環境で、 「毎回 less インストールするの面倒だな」と思った私は、 Vim をページャーにしようとした。

結論

環境変数 PAGER"sed -r 's/\x1B\[[0-9;]*[mGKH]//g' | vim -R -" を指定する。

export PAGER="sed -r 's/\x1B\[[0-9;]*[mGKH]//g' | vim -R -"

調べた・検討した内容(大体時系列)

ページャーにするための基本的な条件

標準入力を受け取り、 Vim をリードオンリーで開く

これもまた特殊なことなのですが、 vim コマンドはあるが view コマンドがないのである。

vim をリードオンリーモードで開くには -R オプションを付ける。

標準入力を受け取って Vim のバッファを開くには、引数に - を指定する。

echo "Hello, World!" | vim -R -

vim -R - をページャーにした結果

制御コードが表示されてぐちゃぐちゃに…

Vim 側で制御コード消せないですかね?

有用な情報が色々集まる

monaqa(@monaqa.bsky.social)さん、響(@4513echo.dev)さん、猫さん(@h_east)、情報ありがとうございました。

プラグインもないことはないものの、だいたいターミナルバッファ使うほうが早くて確実なので自分はそっちを使っちゃいますね

[image or embed]

— monaqa (@monaqa.bsky.social) Aug 25, 2024 at 23:54
tter-tweet”>

export PAGER=&#39;vim -R -&#39; して git diff HEAD^ HEAD した結果…。かなしい…… pic.twitter.com/FZS9GyvOWo

— 大雪 命 (@mikoto2000) August 25, 2024

このプラグインはどうでしょうか? github.com/powerman/vim…

[image or embed]

— 響 (@4513echo.dev) Aug 26, 2024 at 0:02

それと並行して迷走する私

Vim をページャーにできた!

が、色がつかないのが不満

猫さん(@h_east)の方法で表示はぐちゃぐちゃにならなくなったが、画面に色がつかない。

git diff HEAD^ HEAD:

しかし、あらかじめ色情報を消しておくと色がつく…

git diff --no-color HEAD^ HEAD:

sed で制御コードを削除し、パイプで Vim に渡す」までを PAGER に指定する

ということで、色がつかないと不満をこぼしたら、猫さん(@h_east)が解決策を考案してくださいました。

これで前述の結論である PAGER に指定するコマンド "sed -r 's/\x1B\[[0-9;]*[mGKH]//g' | vim -R -" が生まれました。

色がついたりつかなかったりする原因の考察と調査

「制御コードアリで色がつかない、制御コードなしで色がつくという事は、 Vim はバッファの内容を見て filetype を判定する機能も持ってるんだなぁ」と思ったので、 どこでどうやっているのかを確認してみた。

Vim ヘルプを見る

「使いたいファイル形式がVimに検出されない(存在しない)場合」の話が記載されており、 その中のパターン D に「ファイル形式がファイルの内容を調べる事によってのみ検出可能な場合」 の記述があった。

より多くの例については$VIMRUNTIME/scripts.vimを参照

new-filetype-scripts - filetype - Vim日本語ドキュメント より

scripts.vim

とあったので、実際に見てみる。

" Vim support file to detect file types in scripts
"
" Maintainer:   The Vim Project <https://github.com/vim/vim>
" Last Change:  2023 Aug 27
" Former Maintainer:    Bram Moolenaar <Bram@vim.org>

" This file is called by an autocommand for every file that has just been
" loaded into a buffer.  It checks if the type of file can be recognized by
" the file contents.  The autocommand is in $VIMRUNTIME/filetype.vim.


" Bail out when a FileType autocommand has already set the filetype.
if did_filetype()
  finish
endif

" Load the user defined scripts file first
" Only do this when the FileType autocommand has not been triggered yet
if exists("myscriptsfile") && filereadable(expand(myscriptsfile))
  execute "source " . myscriptsfile
  if did_filetype()
    finish
  endif
endif

" The main code is in a compiled function for speed.
call dist#script#DetectFiletype()

短い。

  1. 処理の流れとしては、 did_filetype()true が帰ってきたら、もうファイルタイプ決定済みなので何もしない。
  2. その後、 myscriptfile を読み込めれば読み込み、ファイルタイプ決定したかをまたチェックする。
  3. 最後に、ここまで来てもファイルタイプが決まっていなければ dist#script#DetectFiletype() を実行する。

という感じ。 dist#script#DetectFiletype() に判定の本体がありそうなのでこれを探す。

見つけた場所は autoload/dist/script.vim

autoload/dist/script.vimDetectFileType

DetectFileType 関数:

export def DetectFiletype()
  var line1 = getline(1)
  if line1[0] == '#' && line1[1] == '!'
    # File that starts with "#!".
    DetectFromHashBang(line1)
  else
    # File does not start with "#!".
    DetectFromText(line1)
  endif
enddef
  1. シェバングで決まればそれで
  2. それでも決まらなければバッファの内容から判定する

という感じ。

autoload/dist/script.vimDetectFromText

DetectFromText の方も見ていく。

def DetectFromText(line1: string)
  var line2 = getline(2)
  var line3 = getline(3)
  var line4 = getline(4)
  var line5 = getline(5)
...(snip)

先頭 5 行目までを読み込み、この後にファイルタイプ判定処理が続いている。

例えば diff の判定処理は以下。

    # Diff file:
    # - "diff" in first line (context diff)
    # - "Only in " in first line
    # - "--- " in first line and "+++ " in second line (unified diff).
    # - "*** " in first line and "--- " in second line (context diff).
    # - "# It was generated by makepatch " in the second line (makepatch diff).
    # - "Index: <filename>" in the first line (CVS file)
    # - "=== ", line of "=", "---", "+++ " (SVK diff)
    # - "=== ", "--- ", "+++ " (bzr diff, common case)
    # - "=== (removed|added|renamed|modified)" (bzr diff, alternative)
    # - "# HG changeset patch" in first line (Mercurial export format)
  elseif line1 =~ '^\(diff\>\|Only in \|\d\+\(,\d\+\)\=[cda]\d\+\>\|# It was generated by makepatch \|Index:\s\+\f\+\r\=$\|===== \f\+ \d\+\.\d\+ vs edited\|==== //\f\+#\d\+\|# HG changeset patch\)'
     || (line1 =~ '^--- ' && line2 =~ '^+++ ')
     || (line1 =~ '^\* looking for ' && line2 =~ '^\* comparing to ')
     || (line1 =~ '^\*\*\* ' && line2 =~ '^--- ')
     || (line1 =~ '^=== ' && ((line2 =~ '^=\{66\}' && line3 =~ '^--- ' && line4 =~ '^+++') || (line2 =~ '^--- ' && line3 =~ '^+++ ')))
     || (line1 =~ '^=== \(removed\|added\|renamed\|modified\)')
    setl ft=diff

読み解くところまではしないが、 line1 を基に判定し、ヒットしたら ft=diff していることがわかる。

ついでに git は以下。

    # Git output
  elseif line1 =~ '^\(commit\|tree\|object\) \x\{40,\}\>\|^tag \S\+$'
    setl ft=git

こちらも line1 の内容で判定している。

このような仕組みで、拡張子やシェバングでも判定できないファイルタイプを、バッファの内容を使って判定する処理が行われていた。

じゃぁ script.vim はどこからどのタイミングで呼ばれるの?

Vim のソースを grep したところ、 runtime/filetype.vim から、 autocmdBufNewFile,BufRead で呼び出されているようだ。

" Check for "*" after loading myfiletypefile, so that scripts.vim is only used
" when there are no matching file name extensions.
" Don't do this for compressed files.
augroup filetypedetect
au BufNewFile,BufRead *
    \ if !did_filetype() && expand("<amatch>") !~ g:ft_ignore_pat
    \ | runtime! scripts.vim | endif
au StdinReadPost * if !did_filetype() | runtime! scripts.vim | endif

なので、「制御コード入りの入力を受け取ってから制御コードを削除」では色がつかず、 「あらかじめ制御コードを削除してから受け取る」では色がつく。という事らしい。

以上。

参考資料