Class: Spoom::Deadcode::Index

Inherits:
Object
  • Object
show all
Defined in:
lib/spoom/deadcode/index.rb

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model) ⇒ Index

Returns a new instance of Index.

Signature:

  • (Model model) -> void



25
26
27
28
29
30
 
# File 'lib/spoom/deadcode/index.rb', line 25

def initialize(model)
  @model = model
  @definitions = {} #: Hash[String, Array[Definition]]
  @references = {} #: Hash[String, Array[Model::Reference]]
  @ignored = Set.new #: Set[Model::SymbolDef]
end

Instance Attribute Details

#definitions ⇒ Object (readonly)

Signature:

  • Hash[String, Array[Definition]]



19
20
21
 
# File 'lib/spoom/deadcode/index.rb', line 19

def definitions
  @definitions
end

#model ⇒ Object (readonly)

Signature:

  • Model



16
17
18
 
# File 'lib/spoom/deadcode/index.rb', line 16

def model
  @model
end

#references ⇒ Object (readonly)

Signature:

  • Hash[String, Array[Model::Reference]]



22
23
24
 
# File 'lib/spoom/deadcode/index.rb', line 22

def references
  @references
end

Instance Method Details

#all_definitions ⇒ Object

Signature:

  • -> Array[Definition]



220
221
222
 
# File 'lib/spoom/deadcode/index.rb', line 220

def all_definitions
  @definitions.values.flatten
end

#all_references ⇒ Object

Signature:

  • -> Array[Model::Reference]



225
226
227
 
# File 'lib/spoom/deadcode/index.rb', line 225

def all_references
  @references.values.flatten
end

#apply_plugins!(plugins) ⇒ Object

Signature:

  • (Array[Plugins::Base] plugins) -> void



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/spoom/deadcode/index.rb', line 100

def apply_plugins!(plugins)
  @model.symbols.each do |_full_name, symbol|
    symbol.definitions.each do |symbol_def|
      case symbol_def
      when Model::Class
        plugins.each { |plugin| plugin.internal_on_define_class(symbol_def) }
      when Model::Module
        plugins.each { |plugin| plugin.internal_on_define_module(symbol_def) }
      when Model::Constant
        plugins.each { |plugin| plugin.internal_on_define_constant(symbol_def) }
      when Model::Method
        plugins.each { |plugin| plugin.internal_on_define_method(symbol_def) }
      when Model::Attr
        plugins.each { |plugin| plugin.internal_on_define_accessor(symbol_def) }
      end
    end
  end
end

#define(definition) ⇒ Object

Signature:

  • (Definition definition) -> void



80
81
82
 
# File 'lib/spoom/deadcode/index.rb', line 80

def define(definition)
  (@definitions[definition.name] ||= []) << definition
end

#definitions_for_name(name) ⇒ Object

Signature:

  • (String name) -> Array[Definition]



215
216
217
 
# File 'lib/spoom/deadcode/index.rb', line 215

def definitions_for_name(name)
  @definitions[name] || []
end

#finalize! ⇒ Object

Mark all definitions having a reference of the same name as alive

To be called once all the files have been indexed and all the definitions and references discovered.

Signature:

  • -> void



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
203
204
205
206
207
208
209
210
 
# File 'lib/spoom/deadcode/index.rb', line 123

def finalize!
  @model.symbols.each do |_full_name, symbol|
    symbol.definitions.each do |symbol_def|
      case symbol_def
      when Model::Class
        definition = Definition.new(
          kind: Definition::Kind::Class,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::Module
        definition = Definition.new(
          kind: Definition::Kind::Module,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::Constant
        definition = Definition.new(
          kind: Definition::Kind::Constant,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::Method
        definition = Definition.new(
          kind: Definition::Kind::Method,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::AttrAccessor
        definition = Definition.new(
          kind: Definition::Kind::AttrReader,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)

        definition = Definition.new(
          kind: Definition::Kind::AttrWriter,
          name: "#{symbol.name}=",
          full_name: "#{symbol.full_name}=",
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::AttrReader
        definition = Definition.new(
          kind: Definition::Kind::AttrReader,
          name: symbol.name,
          full_name: symbol.full_name,
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      when Model::AttrWriter
        definition = Definition.new(
          kind: Definition::Kind::AttrWriter,
          name: "#{symbol.name}=",
          full_name: "#{symbol.full_name}=",
          location: symbol_def.location,
        )
        definition.ignored! if @ignored.include?(symbol_def)
        definition.alive! if @references.key?(symbol.name)
        define(definition)
      end
    end
  end
end

#ignore(symbol_def) ⇒ Object

Signature:

  • (Model::SymbolDef symbol_def) -> void



95
96
97
 
# File 'lib/spoom/deadcode/index.rb', line 95

def ignore(symbol_def)
  @ignored << symbol_def
end

#index_erb(erb, file:, plugins: []) ⇒ Object

Signature:

  • (String erb, file: String, ?plugins: Array[Plugins::Base]) -> void



46
47
48
 
# File 'lib/spoom/deadcode/index.rb', line 46

def index_erb(erb, file:, plugins: [])
  index_ruby(Deadcode::ERB.new(erb).wrapped_src, file: file, plugins: plugins)
end

#index_file(file, plugins: []) ⇒ Object

Signature:

  • (String file, ?plugins: Array[Plugins::Base]) -> void



35
36
37
38
39
40
41
42
43
 
# File 'lib/spoom/deadcode/index.rb', line 35

def index_file(file, plugins: [])
  if file.end_with?(".erb")
    erb = File.read(file)
    index_erb(erb, file: file, plugins: plugins)
  else
    rb = File.read(file)
    index_ruby(rb, file: file, plugins: plugins)
  end
end

#index_ruby(rb, file:, plugins: []) ⇒ Object

Signature:

  • (String rb, file: String, ?plugins: Array[Plugins::Base]) -> void



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
 
# File 'lib/spoom/deadcode/index.rb', line 51

def index_ruby(rb, file:, plugins: [])
  node, _ = Spoom.parse_ruby(rb, file: file)

  # Index definitions
  model_builder = Model::Builder.new(@model, file)
  model_builder.visit(node)

  # Ignore the special synthetic method generated by the ERB engine
  if (spoom_erb_wrapper = @model.symbols["__spoom_deadcode_erb_template__"])
    @ignored.merge(spoom_erb_wrapper.definitions)
  end

  # Index references
  refs_visitor = Model::ReferencesVisitor.new(file)
  refs_visitor.visit(node)
  refs_visitor.references.each do |ref|
    (@references[ref.name] ||= []) << ref
  end

  # Index references and sends
  indexer = Indexer.new(file, self, plugins: plugins)
  indexer.visit(node)
rescue ParseError => e
  raise e
rescue => e
  raise Error.new("Error while indexing #{file} (#{e.message})", parent: e)
end

#reference_constant(name, location) ⇒ Object

Signature:

  • (String name, Location location) -> void



85
86
87
 
# File 'lib/spoom/deadcode/index.rb', line 85

def reference_constant(name, location)
  (@references[name] ||= []) << Model::Reference.constant(name, location)
end

#reference_method(name, location) ⇒ Object

Signature:

  • (String name, Location location) -> void



90
91
92
 
# File 'lib/spoom/deadcode/index.rb', line 90

def reference_method(name, location)
  (@references[name] ||= []) << Model::Reference.method(name, location)
end