メソッドをカウントする

Question

メソッドの呼び出し回数をカウントする

メソッドを呼び出した数を出力する関数を作りたいと思っていますが、思うようにかけません。
例えば、メソッドを3回実行すると、以下のように表示されるようにしたいです。

"1:Hello"
"2:Hello"
"3:Hello"

発生している問題・エラーメッセージ

"1:Hello"
"1:Hello"
"1:Hello"
で出力されます

該当のソースコード

def hello
  count = 1
  puts "#{@count}:Hello"
  count += 1
end

hello
hello
hello

試したこと

単にインスタンス変数を使うだけでは、ダメでした。
どのようにしたらいいでしょうか。

Answer 1

module Hello
  @@n = 0
  def hello
    n += 1
    puts 'hello %s' % @@n
  end
  module_function :hello
end

Hello.hello
Hello.hello
Hello.hello

Comments

[3730]

クラス変数で、値を保持するやり方もあるんですね。
ありがとうございます！

Answer 2

３つのプログラムを書いてみました。
実行結果

hellow_1.rb

$count = 0

def hello
  $count += 1
  puts "#{$count}:Hello"
end

hello
hello
hello

hellow_2.rb

class TraceX
  @@count = Hash.new(0)
  def self.count(name)
    @@count[name]
  end
  def self.count_up(name)
    @@count[name] += 1
  end
end

def hello
  TraceX.count_up(__method__)
  puts "#{TraceX.count(__method__)}:Hello"
end

hello
hello
hello

hellow_3.rb

$count = Hash.new(0)

TracePoint.trace(:call) do |tp|
  $count[tp.method_id] += 1
end

def hello
  puts "#{$count[__method__]}:Hello"
end

hello
hello
hello

hellow_2.rb はグローバル変数を使用しないようにしています。
hellow_3.rb は、カウンターのアップ忘れを防止しています。
hellow_2.rb, hellow_3.rb は method をつかうことで、複数のメソッドの呼び出し回数の管理がしやすいようにしています。

hello_3.rb が短くてよいのですが、グローバル変数をつかっているのが...
hellow_2.rb のようにクラスを作って、クラス変数でカウンター情報を持つようにして、TracePoint 機能でカウントアップさせるのが良いかもしれません。

参考情報

• Ruby の TracePoint について調べてみた

https://qiita.com/siman/items/9426ff6c113247088f7e

• [Ruby] caller を利用してメソッド呼び出しをログに記録させる

https://qiita.com/katoy/items/a4dac843383185019f9d

Answer 3

まぁ、なんとなくわかるけど、

思うようにかけません。

とか

単に変数を使うだけでは、ダメでした。

じゃなくて、「何がどのようにダメだったのか」を明記してください。

趣味でも他人に聞くのだから相手にわかるように説明すべきです。仕事ならなおさらです。

多分、コードから妄想するに、

本来なら

1: hello
2: hello
3: hello

となってほしいのに

1: hello
1: hello
1: hello

とカウントアップされないっていうことですよね?

それならそうです。

変数と定数 (Ruby 2.5.0) を読むと、

"$" をつけるとグローバル変数, つけない場合はローカル変数となるみたいです。

ローカル変数は その関数の開始に確保されて終了の 例えばendみたいなところ(もしくはそこから抜けたところ) で破棄される。( スタック領域の場合。 )

だから

[一回目]:
開始: count = 1
表示部
終了前: count + 1 = 1 + 1 = 2
ブロックから抜ける
破棄

[二回目]:
開始: count = 1
表示部
終了前: count + 1 =...

とこれを延々と繰り返している感じ。
だからいつまでたっても1,2,3,4...みたいな状態にはならない。

どうしてもやるなら

方法1:
グローバル変数を使う
( 危険!!!!!! 非推奨です。 )

方法2:
呼び出し元で管理し、hello関数を呼び出すときに引数として渡して
戻り値で取得

def hello(num)
  # ここで表示
  return num + 1
end

n = 1
n = hello( n )
n = hello( n )
n = hello( n )

みたいにして
引数 -> 戻り値 -> 引数 -> 戻り値... みたいにする。

方法3:
クラスのフィールドとして count に相当するものを保持してそこにアクセス
※ Ruby では クラス変数って呼ばれているみたいですが。

参考1, 参考2

Comments

[3730]

ご指摘および、回答ありがとうございます。
分かりやすく質問すること、どこまで理解しているかを明確にするようにします。
また、クラスのフィールドの方法を改めて勉強してみます。

[BeatStar]

mkgreiさんへの返信読みました。
ああ、そうそう。クラス変数です。
フィールド = クラス変数
ですね。(追記しておきました。)