Module: PP::PPMethods

Included in:
PP, SingleLine
Defined in:
lib/pp.rb

Constant Summary collapse

InspectKey = 
:__inspect_key__

Instance Method Summary collapse

Instance Method Details

#comma_breakable ⇒ Object

A convenience method which is same as follows:

text ','
breakable



163
164
165
166
 
# File 'lib/pp.rb', line 163

def comma_breakable
  text ','
  breakable
end

#guard_inspect_key ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/pp.rb', line 110

def guard_inspect_key
  if Thread.current[InspectKey] == nil
    Thread.current[InspectKey] = []
  end

  save = Thread.current[InspectKey]

  begin
    Thread.current[InspectKey] = []
    yield
  ensure
    Thread.current[InspectKey] = save
  end
end

#object_address_group(obj, &block) ⇒ Object 



153
154
155
156
157
 
# File 'lib/pp.rb', line 153

def object_address_group(obj, &block)
  id = "%x" % (obj.__id__ * 2)
  id.sub!(/\Af(?=[[:xdigit:]]{2}+\z)/, '') if id.sub!(/\A\.\./, '')
  group(1, "\#<#{obj.class}:0x#{id}", '>', &block)
end

#object_group(obj, &block) ⇒ Object

A convenience method which is same as follows:

group(1, '#<' + obj.class.name, '>') { ... }



149
150
151
 
# File 'lib/pp.rb', line 149

def object_group(obj, &block) # :yield:
  group(1, '#<' + obj.class.name, '>', &block)
end

#pp(obj) ⇒ Object

Adds obj to the pretty printing buffer using Object#pretty_print or Object#pretty_print_cycle.

Object#pretty_print_cycle is used when obj is already printed, a.k.a the object reference chain has a cycle.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/pp.rb', line 130

def pp(obj)
  id = obj.__id__

  if Thread.current[InspectKey].include? id
    group {obj.pretty_print_cycle self}
    return
  end

  begin
    Thread.current[InspectKey] << id
    group {obj.pretty_print self}
  ensure
    Thread.current[InspectKey].pop unless PP.sharing_detection
  end
end

#pp_hash(obj) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/pp.rb', line 220

def pp_hash(obj)
  group(1, '{', '}') {
    seplist(obj, nil, :each_pair) {|k, v|
      group {
        pp k
        text '=>'
        group(1) {
          breakable ''
          pp v
        }
      }
    }
  }
end

#pp_object(obj) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/pp.rb', line 205

def pp_object(obj)
  object_address_group(obj) {
    seplist(obj.pretty_print_instance_variables, lambda { text ',' }) {|v|
      breakable
      v = v.to_s if Symbol === v
      text v
      text '='
      group(1) {
        breakable ''
        pp(obj.instance_eval(v))
      }
    }
  }
end

#seplist(list, sep = nil, iter_method = :each) ⇒ Object

Adds a separated list. The list is separated by comma with breakable space, by default.

#seplist iterates the list using iter_method. It yields each object to the block given for #seplist. The procedure separator_proc is called between each yields.

If the iteration is zero times, separator_proc is not called at all.

If separator_proc is nil or not given, lambda { comma_breakable } is used. If iter_method is not given, :each is used.

For example, following 3 code fragments has similar effect.

q.seplist([1,2,3]) {|v| xxx v }

q.seplist([1,2,3], lambda { comma_breakable }, :each) {|v| xxx v }

xxx 1
q.comma_breakable
xxx 2
q.comma_breakable
xxx 3



192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/pp.rb', line 192

def seplist(list, sep=nil, iter_method=:each) # :yield: element
  sep ||= lambda { comma_breakable }
  first = true
  list.__send__(iter_method) {|*v|
    if first
      first = false
    else
      sep.call
    end
    yield(*v)
  }
end