123456789_123456789_123456789_123456789_123456789_

Class: PowerAssert::Context

Relationships & Source Files
Namespace Children
Classes:
Ident, Value
Inherits: Object
Defined in: lib/power_assert.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(assertion_proc_or_source, assertion_method, source_binding) ⇒ Context

[ GitHub ] 

  


# File 'lib/power_assert.rb', line 97



def initialize(assertion_proc_or_source, assertion_method, source_binding)
  if assertion_proc_or_source.kind_of?(Proc)
    @assertion_proc = assertion_proc_or_source
    @line = nil
  else
    @assertion_proc = source_binding.eval "Proc.new {#{assertion_proc_or_source}}"
    @line = assertion_proc_or_source
  end
  path = nil
  lineno = nil
  methods = nil
  refs = nil
  method_ids = nil
  return_values = []
  @base_caller_length = -1
  @assertion_method_name = assertion_method.to_s
  @message_proc = -> {
    return nil if @base_caller_length < 0
    @message ||= build_assertion_message(@line || '', methods || [], return_values, refs || [], @assertion_proc.binding).freeze
  }
  @proc_local_variables = @assertion_proc.binding.eval('local_variables').map(&:to_s)
  target_thread = Thread.current
  @trace = TracePoint.new(:return, :c_return) do |tp|
    next if method_ids and ! method_ids.include?(tp.method_id)
    next unless tp.binding # workaround for ruby 2.2
    locs = tp.binding.eval('::Kernel.caller_locations')
    current_diff = locs.length - @base_caller_length
    target_diff = TARGET_CALLER_DIFF[tp.event]
    is_target_bmethod = current_diff < target_diff
    if (is_target_bmethod or current_diff == target_diff) and Thread.current == target_thread
      idx = target_diff - TARGET_INDEX_OFFSET[is_target_bmethod ? :bmethod : :method]
      unless path
        path = locs[idx].path
        lineno = locs[idx].lineno
        @line ||= open(path).each_line.drop(lineno - 1).first
        idents = extract_idents(Ripper.sexp(@line))
        methods, refs = idents.partition {|i| i.type == :method }
        method_ids = methods.map(&:name).map(&:to_sym).uniq
      end
      if path == locs[idx].path and lineno == locs[idx].lineno
        val = PowerAssert.configuration.lazy_inspection ?
          tp.return_value :
          InspectedValue.new(SafeInspectable.new(tp.return_value).inspect)
        return_values << Value[tp.method_id.to_s, val, nil]
      end
    end
  end
end


  







Instance Attribute Details



  

    #message_proc   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 95



attr_reader :message_proc


  







Instance Method Details



  

    #build_assertion_message(line, methods, return_values, refs, proc_binding)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 163



def build_assertion_message(line, methods, return_values, refs, proc_binding)
  set_column(methods, return_values)
  ref_values = refs.map {|i| Value[i.name, proc_binding.eval(i.name), i.column] }
  vals = (return_values + ref_values).find_all(&:column).sort_by(&:column).reverse
  if vals.empty?
    return line
  end
  fmt = (0..vals[0].column).map {|i| vals.find {|v| v.column == i } ? "%<#{i}>s" : ' '  }.join
  lines = []
  lines << line.chomp
  lines << sprintf(fmt, vals.each_with_object({}) {|v, h| h[v.column.to_s.to_sym] = '|' }).chomp
  vals.each do |i|
    inspected_vals = vals.each_with_object({}) do |j, h|
      h[j.column.to_s.to_sym] = [SafeInspectable.new(i.value).inspect, '|', ' '][i.column <=> j.column]
    end
    lines << encoding_safe_rstrip(sprintf(fmt, inspected_vals))
  end
  lines.join("\n")
end


  








  

    #do_yield   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 156



def do_yield
  @trace.enable do
    @base_caller_length = caller_locations.length
    yield
  end
end


  








  

    #encoding_safe_rstrip(str)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 193



def encoding_safe_rstrip(str)
  str.rstrip
rescue ArgumentError, Encoding::CompatibilityError
  enc = str.encoding
  if enc.ascii_compatible?
    str.b.rstrip.force_encoding(enc)
  else
    str
  end
end


  








  

    #extract_idents(sexp)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 204



def extract_idents(sexp)
  tag, * = sexp
  case tag
  when :arg_paren, :assoc_splat, :fcall, :hash, :method_add_block, :string_literal
    extract_idents(sexp[1])
  when :assign, :massign
    extract_idents(sexp[2])
  when :assoclist_from_args, :bare_assoc_hash, :dyna_symbol, :paren, :string_embexpr,
    :regexp_literal, :xstring_literal
    sexp[1].flat_map {|s| extract_idents(s) }
  when :assoc_new, :command, :dot2, :dot3, :string_content
    sexp[1..-1].flat_map {|s| extract_idents(s) }
  when :unary
    handle_columnless_ident([], sexp[1], extract_idents(sexp[2]))
  when :binary
    handle_columnless_ident(extract_idents(sexp[1]), sexp[2], extract_idents(sexp[3]))
  when :call
    if sexp[3] == :call
      handle_columnless_ident(extract_idents(sexp[1]), :call, [])
    else
      [sexp[1], sexp[3]].flat_map {|s| extract_idents(s) }
    end
  when :array
    sexp[1] ? sexp[1].flat_map {|s| extract_idents(s) } : []
  when :command_call
    [sexp[1], sexp[4], sexp[3]].flat_map {|s| extract_idents(s) }
  when :aref
    handle_columnless_ident(extract_idents(sexp[1]), :[], extract_idents(sexp[2]))
  when :method_add_arg
    idents = extract_idents(sexp[1])
    if idents.empty?
      # idents may be empty(e.g. ->{}.())
      extract_idents(sexp[2])
    else
      idents[0..-2] + extract_idents(sexp[2]) + [idents[-1]]
    end
  when :args_add_block
    _, (tag, ss0, *ss1), _ = sexp
    if tag == :args_add_star
      (ss0 + ss1).flat_map {|s| extract_idents(s) }
    else
      sexp[1].flat_map {|s| extract_idents(s) }
    end
  when :vcall
    _, (tag, name, (_, column)) = sexp
    if tag == :@ident
      [Ident[@proc_local_variables.include?(name) ? :ref : :method, name, column]]
    else
      []
    end
  when :program
    _, ((tag0, (tag1, (tag2, (tag3, mname, _)), _), (tag4, _, ss))) = sexp
    if tag0 == :method_add_block and tag1 == :method_add_arg and tag2 == :fcall and
        (tag3 == :@ident or tag3 == :@const) and mname == @assertion_method_name and (tag4 == :brace_block or tag4 == :do_block)
      ss.flat_map {|s| extract_idents(s) }
    else
      _, (s, *) = sexp
      extract_idents(s)
    end
  when :var_ref
    _, (tag, ref_name, (_, column)) = sexp
    case tag
    when :@kw
      if ref_name == 'self'
        [Ident[:ref, 'self', column]]
      else
        []
      end
    when :@const, :@cvar, :@ivar, :@gvar
      [Ident[:ref, ref_name, column]]
    else
      []
    end
  when :@ident, :@const
    _, method_name, (_, column) = sexp
    [Ident[:method, method_name, column]]
  else
    []
  end
end


  








  

    #handle_columnless_ident(left_idents, mid, right_idents)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 301



def handle_columnless_ident(left_idents, mid, right_idents)
  left_max = left_idents.max_by(&:column)
  right_min = right_idents.min_by(&:column)
  bg = left_max ? left_max.column + left_max.name.length : 0
  ed = right_min ? right_min.column - 1 : @line.length - 1
  mname = mid.to_s
  srctxt = MID2SRCTXT[mid] || mname
  re = /
    #{'\b' if /\A\w/ =~ srctxt}
    #{Regexp.escape(srctxt)}
    #{'\b' if /\w\z/ =~ srctxt}
  /x
  indices = str_indices(@line, re, bg, ed)
  if left_idents.empty? and right_idents.empty?
    left_idents + right_idents
  elsif left_idents.empty?
    left_idents + right_idents + [Ident[:method, mname, indices.last]]
  else
    left_idents + right_idents + [Ident[:method, mname, indices.first]]
  end
end


  








  

    #message  
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 150



def message
  @message_proc.()
end


  








  

    #set_column(methods, return_values)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 183



def set_column(methods, return_values)
  methods = methods.dup
  return_values.each do |val|
    idx = methods.index {|method| method.name == val.name }
    if idx
      val.column = methods.delete_at(idx).column
    end
  end
end


  








  

    #str_indices(str, re, offset, limit)   (private)
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 285



def str_indices(str, re, offset, limit)
  idx = str.index(re, offset)
  if idx and idx <= limit
    [idx, *str_indices(str, re, idx + 1, limit)]
  else
    []
  end
end


  








  

    #yield  
  

  [ GitHub ]


  

  


# File 'lib/power_assert.rb', line 146



def yield
  do_yield(&@assertion_proc)
end