Module: RubyVarDump

Defined in:
lib/ruby_var_dump.rb,
lib/ruby_var_dump/version.rb,
sig/ruby_var_dump.rbs

Defined Under Namespace

Classes: Error

Constant Summary collapse

RED_COLOR =

カラーコードの定義

"\e[38;5;196m"
LIGHT_RED_COLOR =

赤色

"\e[38;5;203m"
BLUE_COLOR =

サーモンピンク

"\e[38;5;27m"
GREEN_COLOR =

青色

"\e[38;5;2m"
LIGHT_GREEN_COLOR =

緑色

"\e[38;5;10m"
ORANGE_COLOR =

LIGHT_BLUE = "\e[38;5;45m" # 水色

"\e[38;5;214m"
YELLOW_COLOR =

オレンジ色

"\e[33m"
BRIGHT_GREEN_COLOR =

黄色（デバッグ出力開始用）

"\e[32m"
RESET_COLOR =

明るい緑色（デバッグ出力終了用）

"\e[0m"
VERSION =

Returns:

  • (String) 
"0.4.0"

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.assoc ⇒ Object 



13
14
15
 
# File 'lib/ruby_var_dump.rb', line 13

def assoc
  @assoc.nil? ? 1 : @assoc
end

Class Method Details

.show_associations? ⇒ Boolean

0 / false / nil のときだけ非表示。それ以外（1 など）は表示。

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/ruby_var_dump.rb', line 18

def show_associations?
  !(assoc == 0 || assoc == false || assoc.nil?)
end

Instance Method Details

#vdump(obj, level = 0, is_value = false, dumped_objects = [], is_first = true) ⇒ Object Also known as: vpp

色リセット



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ruby_var_dump.rb', line 35

def vdump(obj, level = 0, is_value = false, dumped_objects = [], is_first=true)
  # デバッグ出力の開始（最初の呼び出し時のみ）
  if level == 0 && is_first
    title = "Start Output (ruby_var_dump)"
    timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S") # 現在時刻をフォーマット
    full_title = " #{title} | #{timestamp} " # タイトルと時刻を結合
    width = 80
    padding = (width - full_title.length) # 全体の幅からタイトルと時刻の長さを引く
    left = padding / 2
    right = padding - left
    puts "#{YELLOW_COLOR}#{'=' * width}#{RESET_COLOR}"
    puts "#{YELLOW_COLOR}#{'=' * left}#{full_title}#{'=' * right}#{RESET_COLOR}"
  end

  indent = ' ' * level * 2

  if (defined?(ActiveRecord::Base) && obj.is_a?(ActiveRecord::Base)) || (defined?(ActiveRecord::Relation) && obj.is_a?(ActiveRecord::Relation))
    if dumped_objects.any? { |dumped_obj| dumped_obj.object_id == obj.object_id && dumped_obj.class == obj.class }
      puts "#{indent}<Recursive reference: #{obj.class}:#{obj.object_id}>"
      return
    else
      dumped_objects << obj
    end
  end

  if obj.is_a?(Array)
    print "#{is_value ? '' : indent}" + "["
    if obj.empty?
      print "]"
      print "\n" if level == 0 # メソッドの出力の最後に改行を追加
    else
      print "\n"
      obj.each_with_index do |item, index|
        vdump(item, level + 1, false, dumped_objects, false)
        print "," unless index == obj.size - 1
        print "\n"
      end
      print "#{indent}]"
      print "\n" if level == 0 # メソッドの出力の最後に改行を追加
    end
  elsif obj.is_a?(Hash)
    print "#{is_value ? '' : indent}" + "{"
    if obj.empty?
      print "}"
      print "\n" if level == 0 # メソッドの出力の最後に改行を追加
    else
      print "\n"
      obj.each_with_index do |(key, value), index|
        # キーにインデントを適用し、値にはインデントを適用しない
        print "#{indent}  #{key.inspect.chomp} => "
        if value.is_a?(Hash) || value.is_a?(Array)
          vdump(value, level + 1, true, dumped_objects, false)  # ハッシュのバリューの場合には is_value を true に設定
        else
          # プリミティブな値の場合は現在のレベルで出力
          print colorize_by_type(value)
        end
        print "," unless index == obj.size - 1
        print "\n"
      end
      print "#{indent}}"
      print "\n" if level == 0 # メソッドの出力の最後に改行を追加
    end
  elsif defined?(ActiveRecord::Base) && obj.is_a?(ActiveRecord::Base)
    # ActiveRecordオブジェクトの場合
    print "\n" unless is_first  # 最初のレコード以外の場合に改行を入れる
    print "#{indent}#{GREEN_COLOR}#{obj.class}:#{obj.object_id}#{RESET_COLOR}\n"
    print "#{indent}{\n"
    # もし obj が attributes メソッドを持っている場合、その属性をダンプ
    if obj.respond_to?(:attributes)
      obj.attributes.each do |attr_name, attr_value|
        print "#{indent}  #{attr_name}: #{colorize_by_type(attr_value)},\n"
      end
    end
    # リレーションも再帰的にダンプ（assoc 設定が ON のときのみ）
    obj.class.reflect_on_all_associations.each do |association|
      break unless RubyVarDump.show_associations?

      next if association.macro.nil? # アソシエーションが存在しない場合はスキップ

      associated_value = obj.send(association.name)

      # has_many や has_and_belongs_to_many など、コレクションを返すアソシエーション
      if association.macro == :has_many || association.macro == :has_and_belongs_to_many
        next if associated_value.nil? || (associated_value.respond_to?(:empty?) && associated_value.empty?)

        associated_value.each do |item|
          next if dumped_objects.any? { |dumped_obj| dumped_obj.object_id == item.object_id && dumped_obj.class == item.class }

          # CollectionProxy の内容（アソシエーション）をダンプ
          print("#{indent}  #{RED_COLOR}#{association.name} #{ORANGE_COLOR}(#{association.macro})#{RESET_COLOR}: #{GREEN_COLOR}<< #{item.class}:#{item.object_id} >>#{RESET_COLOR}\n")
          print("#{indent}  {\n")
          # もし item が attributes メソッドを持っていれば、その属性もダンプ
          if item.respond_to?(:attributes)
            item.attributes.each do |attr_name, attr_value|
              print("#{indent}    #{attr_name}: #{colorize_by_type(attr_value)}\n")
            end
          end
  
          print("#{indent}  }\n") #ここまでアソシエーションの描画
        end
      # belongs_to や has_one など、単一オブジェクトを返すアソシエーション
      elsif association.macro == :belongs_to || association.macro == :has_one
        next if associated_value.nil?
        next if dumped_objects.any? { |dumped_obj| dumped_obj.object_id == associated_value.object_id && dumped_obj.class == associated_value.class }

        # 単一オブジェクトのアソシエーションをダンプ
        print("#{indent}  #{RED_COLOR}#{association.name} #{ORANGE_COLOR}(#{association.macro})#{RESET_COLOR}: #{GREEN_COLOR}<< #{associated_value.class}:#{associated_value.object_id} >>#{RESET_COLOR}\n")
        print("#{indent}  {\n")
        # もし associated_value が attributes メソッドを持っていれば、その属性もダンプ
        if associated_value.respond_to?(:attributes)
          associated_value.attributes.each do |attr_name, attr_value|
            print("#{indent}    #{attr_name}: #{colorize_by_type(attr_value)}\n")
          end
        end
        
        print("#{indent}  }\n") #ここまでアソシエーションの描画
      end
    end
    print "#{indent}}\n"
  elsif defined?(ActiveRecord::Relation) && obj.is_a?(ActiveRecord::Relation)
    print "#{indent}#{obj.class}:#{obj.object_id}\n"
    print "#{indent}[\n"
    obj.each_with_index do |item, index|
      vdump(item, level + 1, false, dumped_objects, index == 0)
    end
    print "#{indent}]"
    print "\n" if level == 0 # メソッドの出力の最後に改行を追加
  elsif obj.respond_to?(:attributes)
    vdump(obj.attributes, level, false, dumped_objects, false)
  else
    print indent + colorize_by_type(obj) # プリミティブな値の場合を出力
    print "\n"  if level == 0 # メソッドの出力の最後に改行を追加
  end

  # デバッグ出力の終了
  if level == 0 && is_first
    # デバッグ出力の終了
    title = "End Output (ruby_var_dump)"
    timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S") # 現在時刻をフォーマット
    full_title = " #{title} | #{timestamp} " # タイトルと時刻を結合
    width = 80
    padding = (width - full_title.length) # 全体の幅からタイトルと時刻の長さを引く
    left = padding / 2
    right = padding - left
    puts "#{BRIGHT_GREEN_COLOR}#{'=' * left}#{full_title}#{'=' * right}#{RESET_COLOR}"
    puts "#{BRIGHT_GREEN_COLOR}#{'=' * width}#{RESET_COLOR}"
  end
end