Class: Solargraph::Rspec::Convention

Inherits:
Convention::Base
  • Object
show all
Defined in:
lib/solargraph/rspec/convention.rb

Overview

Provides completion for RSpec DSL and helper methods.

- `describe` and `context` blocks
- `let` and `let!` methods
- `subject` method
- `described_class` method
- `it` method with correct binding
- `RSpec::Matchers` module

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.config ⇒ Config

Returns:



62
63
64
 
# File 'lib/solargraph/rspec/convention.rb', line 62

def self.config
  @config ||= Config.new
end

.valid_filename?(filename) ⇒ Boolean

Parameters:

  • filename (String)

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/solargraph/rspec/convention.rb', line 68

def self.valid_filename?(filename)
  filename.include?('spec/')
end

Instance Method Details

#global(_yard_map) ⇒ Environ

Parameters:

  • yard_map (YardMap)

Returns:

  • (Environ) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/solargraph/rspec/convention.rb', line 74

def global(_yard_map)
  pins = []
  pins += include_helper_pins

  if pins.any?
    Solargraph.logger.debug(
      "[RSpec] added global pins #{pins.map(&:inspect)}"
    )
  end

  Environ.new(pins: pins)
rescue StandardError => e
  raise e if ENV['SOLARGRAPH_DEBUG']

  Solargraph.logger.warn(
    "[RSpec] Error processing global pins: #{e.message}\n#{e.backtrace.join("\n")}"
  )
  EMPTY_ENVIRON
end

#local(source_map) ⇒ Environ

Parameters:

  • source_map (SourceMap)

Returns:

  • (Environ) 


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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/solargraph/rspec/convention.rb', line 96

def local(source_map)
  Solargraph.logger.debug "[RSpec] processing #{source_map.filename}"

  return EMPTY_ENVIRON unless self.class.valid_filename?(source_map.filename)

  # @type [Array<Pin::Base>]
  pins = []
  # @type [Array<Pin::Namespace>]
  namespace_pins = []

  rspec_walker = SpecWalker.new(source_map: source_map, config: config)

  Correctors::ContextBlockNamespaceCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(source_map) do |pins_to_add|
    pins += pins_to_add
  end

  Correctors::ExampleAndHookBlocksBindingCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(source_map) do |pins_to_add|
    pins += pins_to_add
  end

  # @type [Pin::Method, nil]
  described_class_pin = nil
  Correctors::DescribedClassCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(
    source_map
  ) do |pins_to_add|
    described_class_pin = pins_to_add.first
    pins += pins_to_add
  end

  Correctors::LetMethodsCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(
    source_map
  ) do |pins_to_add|
    pins += pins_to_add
  end

  # @type [Pin::Method, nil]
  subject_pin = nil
  Correctors::SubjectMethodCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(
    source_map
  ) do |pins_to_add|
    subject_pin = pins_to_add.first
    pins += pins_to_add
  end

  Correctors::ContextBlockMethodsCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker
  ).correct(source_map) do |pins_to_add|
    pins += pins_to_add
  end

  Correctors::DslMethodsCorrector.new(
    namespace_pins: namespace_pins,
    rspec_walker: rspec_walker,
    config: config
  ).correct(
    source_map
  ) do |pins_to_add|
    pins += pins_to_add
  end

  rspec_walker.walk!
  pins += namespace_pins

  # Implicit subject
  if !subject_pin && described_class_pin
    Correctors::ImplicitSubjectMethodCorrector.new(
      namespace_pins: namespace_pins,
      described_class_pin: described_class_pin
    ).correct(
      source_map
    ) do |pins_to_add|
      subject_pin = pins_to_add.first
      pins += pins_to_add
    end
  end

  if pins.any?
    Solargraph.logger.debug(
      "[RSpec] added #{pins.map(&:inspect)} to #{source_map.filename}"
    )
  end

  Environ.new(requires: ['rspec'], pins: pins)
rescue StandardError => e
  raise e if ENV['SOLARGRAPH_DEBUG']

  Solargraph.logger.warn(
    "[RSpec] Error processing #{source_map.filename}: #{e.message}\n#{e.backtrace.join("\n")}"
  )
  EMPTY_ENVIRON
end