RuboCop の Lint/IneffectiveAccessModifier の警告に対応

[AudioStakes]

RuboCop のチェックが通らなくて CI が通らないようになっているため、対応しました。

やったこと

次のメソッド Notification.product_update が public なクラスメソッドとして扱われるようにメソッドの定義場所を移した

bootcamp/app/models/notification.rb

Lines 272 to 281 in 40b23bc

	def self.product_update(product, receiver)
	Notification.create!(
	kind: 17,
	user: receiver,
	sender: product.user,
	link: Rails.application.routes.url_helpers.polymorphic_path(product),
	message: "#{product.user.login_name}さんの提出物が更新されました",
	read: false
	)
	end

RuboCop を実行したときのログ

修正前

$ bundle exec rubocop -A app/models/notification.rb
Inspecting 1 file
W

Offenses:

app/models/notification.rb:272:3: W: Lint/IneffectiveAccessModifier: private (on line 265) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.
  def self.product_update(product, receiver)
  ^^^

1 file inspected, 1 offense detected

修正後

$ bundle exec rubocop -A app/models/notification.rb
Inspecting 1 file
.

1 file inspected, no offenses detected

考えたこと

RuboCop のチェックが通らなかった Lint/IneffectiveAccessModifier では private なクラスメソッドの定義の仕方について指摘されている。
しかしその対象のメソッド Notification.product_update は、次のコードのとおり外から呼び出されているため、 private として扱いたいという意図はないと考えた。

bootcamp/app/models/notification_facade.rb

Lines 23 to 26 in 40b23bc

	def self.product_update(product, receiver)
	Notification.product_update(product, receiver)
	return if receiver.retired?
	end

そのため Lint/IneffectiveAccessModifier の警告どおりには修正せず（つまり private としてではなく）public なクラスメソッドとして扱われるようにメソッドの定義場所を移した。

[AudioStakes]

@komagata
現在 Rubocop のチェックがパスしないため、CI が通らなくなっています。
早めに対応した方がよいと考え、こちらの PR で対応しました。
お時間のあるときに、見てもらえますと嬉しいですー🙏

[komagata]

修正ありがとうございます〜！！