破壊的メソッドと非破壊的メソッドの話

破壊的メソッドと非破壊的メソッドの違いと「!」についての要点をざっくりまとめました。

破壊的メソッドとは

レシーバであるオブジェクトそのものに変更を加えるメソッドのことです。
非破壊的メソッドは、その場の実行結果のみに影響しますが、破壊的メソッドは自分自身に変更を加えてしまいます。

破壊的メソッドの例

popは、配列の末尾の要素を削除してそれ自身を返し、そしてレシーバ自体を変更する破壊的メソッドです。
下記のような場合、レシーバ自体に変更がかかっていることがわかります。

# 変数aに配列を代入する
a =  ["hedge", "rabbit", "tiger"]

# 変数aの末尾の要素("tiger")を削除してそれを返す
a.pop
=> ["tiger"]

# レシーバである変数a自体にも変更が加わっていることがわかる
p a
=> ["hedge", "rabbit"]

非破壊的メソッドの例

sliceは、引数に応じて文字列の中から部分文字列を取り出すsliceは非破壊的メソッドです。
下記のような場合、レシーバ自体には変更がかかっていないことがわかります。

# 変数aに配列を代入する
a =  ["hedge", "rabbit", "tiger"]

# 指定した要素を自身から取り除き、取り除いた要素を返す
a.slice(0..1)
=> ["hedge", "rabbit"]

# レシーバである変数aそのものには変更が加わっていないことがわかる
p a
=> ["hedge", "rabbit", "tiger"]

破壊的メソッドと!

上記に登場したsliceは破壊的メソッドですが、同じ機能をもつslice!は破壊的メソッドです。
破壊的メソッドには、!がついていることが多いですが、popやshiftなど、!のつかない破壊的メソッドもあります。 sliceとslice!のように、同じ機能をもつメソッドに、破壊的メソッドと非破壊的メソッドのパターンがある場合などは、破壊的メソッドの方に!がついてるようです。

参照記事

”!”についての見解を詳しく書いてくださっていて大変参考になりましたmm qiita.com

例外クラス StandardError

例外クラスのStandardErrorとそのサブクラスという階層のことをまとめました。

例外クラスについて

Rubyの例外処理において、例外クラスを指定しない場合StandardErrorとそのサブクラスが補足されます。
StandardErrorとそのサブクラスとは？

StandardError

StandardErrorとは、

通常のプログラムで発生する可能性の高い 例外クラスを束ねるためのクラスです。

引用元: class StandardError (Ruby 2.5.0)

そのサブクラス

サブクラスとは親子関係のあるクラスの子の方のことで、親のメソッドを継承しています。
こういった階層構造と考えるとわかりやすそうです。

Exception(全ての例外の祖先)  
　∟StandardError
　　　∟サブクラス達

で、StandardErrorのサブクラスは、つまるところ通常のプログラムで発生する可能性の高い 例外クラスです。
具体的にはこちらです。

ArgumentError
EOFError
EncodingError
FiberError
FloatDomainError
IOError
IndexError
KeyError
LocalJumpError
NameError
NoMethodError
RangeError
RegexpError
RuntimeError
StandardError
StopIteration
SystemCallError
ThreadError
TypeError
ZeroDivisionError

Ruby 2.5.0 リファレンスマニュアル > 組み込みライブラリ > 例外クラスが、構造と内容を確認するには最適です。
ただ、上記のように一覧だけを確認したい場合については、ancestorsを利用するのが便利です。上記のStandardErrorのサブクラス一覧を表示するにあたっては、こちらの記事を参照させていただきました。さらに祖先のExceptionクラスにも触れていてとても参考になりましたmm

randd.kwappa.net

ControllerとViewの共通処理をConcernに書いた話

はじめに

Concernという存在を知ったので、まとめました。

Concernとは

どういうものなのか

Ruby on RailsのActiveSupport( Active Support Core Extensions )の一つです。

モジュールを利用してMix-inする時に、複雑なコードを書かなくていいようにしてくれて、モジュールの依存関係もいい感じに処理してくれる機能です。

Active Supportについて

Active Supportは、Ruby言語の拡張、ユーティリティ、その他横断的な機能を提供するRialsのコンポーネントです。

Ruby on Railsアプリケーションでは、（config で読み込まない設定をしていない限り）基本的にすべてのActive Supportを読み込みます。

どんな時に使われるのか

主には、MVCをまたいで共通した処理を利用したい場合に用いられます。 例えば、Viewでも使いたいけど、Controllerでも使いたいメソッドがある場合、
Viewだけならhelperに書けば良いし、ControllerだけならApplicationControllerに書けば良いのですが、
どちらでも使いたい場合、共通のモジュールとしてConcernに定義することが考えられます。

具体例

ViewでもControllerでも使いたいhugaというメソッドがある時の一例です。
helper methodとして使えるようにしています。

Concern

app/controllers/concerns/hoge.rb

# Hogeというmoduleを定義
module Hoge
  # ActiveSupportのConcernを取り込む
  extend ActiveSupport::Concern
  
  # includedに渡したブロックがmoduleのinclude先で利用出来るようにする
  included do
    # helper_methodにhugaを渡す
    helper_method :huga
  end
  
  # hugaメソッドを定義
  def huga
    @huga_huga = xxxxxxxxxxxx
  end
end

Controller

app/controllers/xxxx_controller.rb

class ApplicationController < ActionController::Base
  # Hogeモジュールを取り込む
  include Hoge
end

View

app/views/xxxx/index_html.haml

%p "#{@huga_huga}さん"

最後に

色々な歴史があってActive Supportに追加されたので、調べてみると古いコード例などもあり、どう書けば良いものか悩みました。
Ruby on Rails 5.2.0にも、こういう風に書かないといけないのをこう出来るんだよ、という風に書いてあったのが後々なるほど、となったので、リンクを載せておきます。

api.rubyonrails.org