Ruby

オブジェクト指向スクリプト言語 Ruby

Create a Topic

Topics

Ruby 4.0でrdocを追加インストールするとwarningが出るようになる

145 views Post
wakairo @wakairo

Ruby 4.0では、rdoc gemについて最新バージョンなどを追加インストールすると、gemコマンドの実行で大量のwarningが表示される状態に陥いります。

なお、開発サイドもこの状態を把握しているようですので、個人的には解決されるまで様子を見ようと思っています。

0
Raw
https://www.techtips.page/en/comments/1172
wakairo @wakairo

Ruby 4.0の場合

Rubyの4.0系列では、bundled gemの1つとして、rdocが標準添付されています。 ここにrdocの最新バージョンをインストールするようなシチュエーションで、rdocを追加インストールするとwarningが出るようになります。

この現象は、dockerを使うと、以下のように簡単に再現できます。 ruby:4.0.3において、始めはgem -vコマンドの実行でwarningは出ませんが、 rdocをインストールすると、同じgem -vコマンドでwarningが出ていることが確認できます。

$ docker run --rm -it ruby:4.0.3 bash
root@601c809deee7:/# gem -v
4.0.6
root@601c809deee7:/# gem install rdoc -v 7.2.0
Fetching rdoc-7.2.0.gem
Successfully installed rdoc-7.2.0
1 gem installed

A new release of RubyGems is available: 4.0.6 → 4.0.11!
Run `gem update --system 4.0.11` to update your installation.

root@601c809deee7:/# gem -v
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/version.rb:8: warning: already initialized constant RDoc::VERSION
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/version.rb:8: warning: previous definition of VERSION was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:68: warning: already initialized constant RDoc::VISIBILITIES
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:68: warning: previous definition of VISIBILITIES was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:74: warning: already initialized constant RDoc::DOT_DOC_FILENAME
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:74: warning: previous definition of DOT_DOC_FILENAME was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:79: warning: already initialized constant RDoc::GENERAL_MODIFIERS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:79: warning: previous definition of GENERAL_MODIFIERS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:84: warning: already initialized constant RDoc::CLASS_MODIFIERS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:84: warning: previous definition of CLASS_MODIFIERS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:89: warning: already initialized constant RDoc::ATTR_MODIFIERS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:89: warning: previous definition of ATTR_MODIFIERS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:94: warning: already initialized constant RDoc::CONSTANT_MODIFIERS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:94: warning: previous definition of CONSTANT_MODIFIERS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc.rb:99: warning: already initialized constant RDoc::METHOD_MODIFIERS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc.rb:99: warning: previous definition of METHOD_MODIFIERS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown.rb:257: warning: already initialized constant RDoc::Markdown::KpegPosInfo
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown.rb:257: warning: previous definition of KpegPosInfo was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown/entities.rb:5: warning: already initialized constant RDoc::Markdown::HTML_ENTITIES
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown/entities.rb:5: warning: previous definition of HTML_ENTITIES was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown/literals.rb:86: warning: already initialized constant RDoc::Markdown::Literals::KpegPosInfo
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown/literals.rb:86: warning: previous definition of KpegPosInfo was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown/literals.rb:446: warning: already initialized constant RDoc::Markdown::Literals::Rules
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown/literals.rb:446: warning: previous definition of Rules was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown.rb:584: warning: already initialized constant RDoc::Markdown::EXTENSIONS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown.rb:584: warning: previous definition of EXTENSIONS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown.rb:589: warning: already initialized constant RDoc::Markdown::DEFAULT_EXTENSIONS
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown.rb:589: warning: previous definition of DEFAULT_EXTENSIONS was here
/usr/local/bundle/gems/rdoc-7.2.0/lib/rdoc/markdown.rb:16430: warning: already initialized constant RDoc::Markdown::Rules
/usr/local/lib/ruby/gems/4.0.0/gems/rdoc-7.0.3/lib/rdoc/markdown.rb:16420: warning: previous definition of Rules was here
4.0.6
root@601c809deee7:/# gem list --exact rdoc
(同様のwarningなので省略)
*** LOCAL GEMS ***

rdoc (7.2.0, 7.0.3)
root@601c809deee7:/#
0
Raw
https://www.techtips.page/en/comments/1173
wakairo @wakairo

Ruby 3.4の場合

Rubyの3.4系列では、default gemの1つとして、rdocが標準添付されています。 ここにrdocを追加インストールしてもwarningが出るようにはなりません。

以下はdockerを使ってこのことを確認した様子です。

$ docker run --rm -it ruby:3.4.9 bash
root@90a5523af58f:/# gem -v
3.6.9
root@90a5523af58f:/# gem install rdoc -v 7.2.0
Fetching rdoc-7.2.0.gem
Successfully installed rdoc-7.2.0
1 gem installed

A new release of RubyGems is available: 3.6.9 → 4.0.11!
Run `gem update --system 4.0.11` to update your installation.

root@90a5523af58f:/# gem -v
3.6.9
root@90a5523af58f:/# gem list --exact rdoc

*** LOCAL GEMS ***

rdoc (7.2.0, default: 6.14.0)
root@90a5523af58f:/#
0
Raw
https://www.techtips.page/en/comments/1174

【小ネタ】Hash#mergeはキーワード引数でも動作する

525 views Post
kenicode SatoKen @kenicode
Last edited

RubyのHash#mergeのマニュアルでは、 その引数はハッシュとしか書かれていません。 例えば、以下のような形です。

irb(main):001> {f1: 1, f2: 2}.merge({b3: 3})
=> {:f1=>1, :f2=>2, :b3=>3}

では、キーワード引数を渡すとどうなるのかと言うと、以下のように動きはしますよ、という小ネタです。

irb(main):002> {f1: 1, f2: 2}.merge(b3: 3)
=> {:f1=>1, :f2=>2, :b3=>3}

Rubyの言語仕様上OKなのかは不明ですので、自分から積極的に使うというよりは、 他人のコードを読むときに役立つかもしれない小ネタ知識でした。

0
Raw
https://www.techtips.page/en/comments/1086
❤️1

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

2120 views Post
wakairo @wakairo

概要

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]

参考文献

0
Raw
https://www.techtips.page/en/comments/512
🔧3
💡1
💯1
❤️1

Emailアドレスとして適切かどうかのチェックに使えるURI::MailTo::EMAIL_REGEXP

3517 views Post
wakairo @wakairo
Last edited

rubyの標準添付ライブラリであるuriに存在しているURI::MailTo::EMAIL_REGEXPは、 ある文字列が規格上Emailアドレスとして適切かどうかのチェックに以下のように利用できます。

irb(main):001> require 'uri'
=> true
irb(main):002> URI::MailTo::EMAIL_REGEXP
=> /\A[a-zA-Z0-9.!\#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/
irb(main):003> URI::MailTo::EMAIL_REGEXP.match?('[email protected]')
=> true
irb(main):004> URI::MailTo::EMAIL_REGEXP.match?('[email protected]')
=> false
irb(main):005> URI::MailTo::EMAIL_REGEXP.match?('[email protected]')
=> false

Railsガイドでも、 このEMAIL_REGEXPを用いてemailのバリデーションを行う方法を以下のように紹介しています。

validates :email, format: { with: URI::MailTo::EMAIL_REGEXP }

URI::MailTo::EMAIL_REGEXPを使うメリット

TechRachoの記事によると、URI::MailTo::EMAIL_REGEXPの正規表現はHTML規格書から持ってきているため、 URI::MailTo::EMAIL_REGEXPを使ったバリデーションはブラウザがinput type="email"で行うバリデーションと一致するというメリットがあります。

余談

URI::MailTo::EMAIL_REGEXPは、 Rubyリファレンスマニュアルにも Ruby標準ライブラリリファレンスにも、実は記載されていません。 ですので、URI::MailTo::EMAIL_REGEXPを利用するのは少々裏技的な側面があるのかもしれません。 ただ、上述の通り、Railsガイドや記事で取り上げられるぐらいに認知されていますので、利用しても大丈夫なのではないかと思います。

0
Raw
https://www.techtips.page/en/comments/331
😄2
🔧1
💡1