Class: Lawyer::Clause

Inherits:
Object
  • Object
show all
Defined in:
lib/lawyer/clause.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ Clause

Returns a new instance of Clause.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/lawyer/clause.rb', line 9

def initialize(params)
  @arity = nil
  @signature = nil

  if params.is_a?(Hash)
    (@name, details) = params.first
    case details
    when Fixnum
      @arity = details
    when Array
      @signature = details
    end
  else
    @name = params.to_sym
  end
end

Instance Attribute Details

#arity ⇒ Object (readonly)

Returns the value of attribute arity.



7
8
9
 
# File 'lib/lawyer/clause.rb', line 7

def arity
  @arity
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/lawyer/clause.rb', line 7

def name
  @name
end

#signature ⇒ Object (readonly)

Returns the value of attribute signature.



7
8
9
 
# File 'lib/lawyer/clause.rb', line 7

def signature
  @signature
end

Instance Method Details

#actual_arity(subject) ⇒ Object 



48
49
50
 
# File 'lib/lawyer/clause.rb', line 48

def actual_arity(subject)
  method_from(subject).arity
end

#actual_signature(subject) ⇒ Object 



64
65
66
 
# File 'lib/lawyer/clause.rb', line 64

def actual_signature(subject)
  method_from(subject).parameters.select { |p| p[0] == :keyreq }.map(&:last) || []
end

#check(subject) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/lawyer/clause.rb', line 26

def check(subject)
  if missing_method?(subject)
    Lawyer::MethodMissingViolation.new(@name)
  elsif wrong_arity?(subject)
    Lawyer::WrongArityViolation.new(@name, expected: @arity, actual: actual_arity(subject))
  elsif wrong_signature?(subject)
    Lawyer::WrongSignatureViolation.new(@name,
      missing: missing_parameters(subject),
      extra: extra_parameters(subject))
  else
    nil
  end
end

#extra_parameters(subject) ⇒ Object 



60
61
62
 
# File 'lib/lawyer/clause.rb', line 60

def extra_parameters(subject)
  actual_signature(subject) - @signature
end

#method_from(subject) ⇒ Object 



68
69
70
 
# File 'lib/lawyer/clause.rb', line 68

def method_from(subject)
  subject.instance_method(@name)
end

#missing_method?(subject) ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/lawyer/clause.rb', line 40

def missing_method?(subject)
  (@name != :initialize) && !subject.instance_methods.include?(@name)
end

#missing_parameters(subject) ⇒ Object 



56
57
58
 
# File 'lib/lawyer/clause.rb', line 56

def missing_parameters(subject)
  @signature - actual_signature(subject)
end

#wrong_arity?(subject) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/lawyer/clause.rb', line 44

def wrong_arity?(subject)
  @arity && @arity != actual_arity(subject)
end

#wrong_signature?(subject) ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/lawyer/clause.rb', line 52

def wrong_signature?(subject)
  @signature && (missing_parameters(subject).any? || extra_parameters(subject).any?)
end