Class: RubyIndexer::Configuration

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/ruby_indexer/lib/ruby_indexer/configuration.rb

Constant Summary collapse

CONFIGURATION_SCHEMA = 
T.let(
  {
    "excluded_gems" => Array,
    "included_gems" => Array,
    "excluded_patterns" => Array,
    "included_patterns" => Array,
    "excluded_magic_comments" => Array,
  }.freeze,
  T::Hash[String, T.untyped],
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ruby_indexer/lib/ruby_indexer/configuration.rb', line 23

def initialize
  @workspace_path = T.let(Dir.pwd, String)
  @excluded_gems = T.let(initial_excluded_gems, T::Array[String])
  @included_gems = T.let([], T::Array[String])
  @excluded_patterns = T.let([File.join("**", "*_test.rb"), File.join("tmp", "**", "*")], T::Array[String])

  path = Bundler.settings["path"]
  if path
    # Substitute Windows backslashes into forward slashes, which are used in glob patterns
    glob = path.gsub(/[\\]+/, "/")
    @excluded_patterns << File.join(glob, "**", "*.rb")
  end

  @included_patterns = T.let([File.join("**", "*.rb")], T::Array[String])
  @excluded_magic_comments = T.let(
    [
      "frozen_string_literal:",
      "typed:",
      "compiled:",
      "encoding:",
      "shareable_constant_value:",
      "warn_indent:",
      "rubocop:",
      "nodoc:",
      "doc:",
      "coding:",
      "warn_past_scope:",
    ],
    T::Array[String],
  )
end

Instance Attribute Details

#workspace_path=(value) ⇒ Object (writeonly)

Sets the attribute workspace_path

Parameters:

  • value —

    the value to set the attribute workspace_path to.



20
21
22
 
# File 'lib/ruby_indexer/lib/ruby_indexer/configuration.rb', line 20

def workspace_path=(value)
  @workspace_path = value
end

Instance Method Details

#apply_config(config) ⇒ Object 



168
169
170
171
172
173
174
175
176
 
# File 'lib/ruby_indexer/lib/ruby_indexer/configuration.rb', line 168

def apply_config(config)
  validate_config!(config)

  @excluded_gems.concat(config["excluded_gems"]) if config["excluded_gems"]
  @included_gems.concat(config["included_gems"]) if config["included_gems"]
  @excluded_patterns.concat(config["excluded_patterns"]) if config["excluded_patterns"]
  @included_patterns.concat(config["included_patterns"]) if config["included_patterns"]
  @excluded_magic_comments.concat(config["excluded_magic_comments"]) if config["excluded_magic_comments"]
end

#indexables ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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
 
# File 'lib/ruby_indexer/lib/ruby_indexer/configuration.rb', line 56

def indexables
  excluded_gems = @excluded_gems - @included_gems
  locked_gems = Bundler.locked_gems&.specs

  # NOTE: indexing the patterns (both included and excluded) needs to happen before indexing gems, otherwise we risk
  # having duplicates if BUNDLE_PATH is set to a folder inside the project structure

  # Add user specified patterns
  indexables = @included_patterns.flat_map do |pattern|
    load_path_entry = T.let(nil, T.nilable(String))

    Dir.glob(File.join(@workspace_path, pattern), File::FNM_PATHNAME | File::FNM_EXTGLOB).map! do |path|
      path = File.expand_path(path)
      # All entries for the same pattern match the same $LOAD_PATH entry. Since searching the $LOAD_PATH for every
      # entry is expensive, we memoize it until we find a path that doesn't belong to that $LOAD_PATH. This happens
      # on repositories that define multiple gems, like Rails. All frameworks are defined inside the current
      # workspace directory, but each one of them belongs to a different $LOAD_PATH entry
      if load_path_entry.nil? || !path.start_with?(load_path_entry)
        load_path_entry = $LOAD_PATH.find { |load_path| path.start_with?(load_path) }
      end

      IndexablePath.new(load_path_entry, path)
    end
  end

  # If the patterns are relative, we make it relative to the workspace path. If they are absolute, then we shouldn't
  # concatenate anything
  excluded_patterns = @excluded_patterns.map do |pattern|
    if File.absolute_path?(pattern)
      pattern
    else
      File.join(@workspace_path, pattern)
    end
  end

  # Remove user specified patterns
  indexables.reject! do |indexable|
    excluded_patterns.any? do |pattern|
      File.fnmatch?(pattern, indexable.full_path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
    end
  end

  # Add default gems to the list of files to be indexed
  Dir.glob(File.join(RbConfig::CONFIG["rubylibdir"], "*")).each do |default_path|
    # The default_path might be a Ruby file or a folder with the gem's name. For example:
    #   bundler/
    #   bundler.rb
    #   psych/
    #   psych.rb
    pathname = Pathname.new(default_path)
    short_name = pathname.basename.to_s.delete_suffix(".rb")

    # If the gem name is excluded, then we skip it
    next if excluded_gems.include?(short_name)

    # If the default gem is also a part of the bundle, we skip indexing the default one and index only the one in
    # the bundle, which won't be in `default_path`, but will be in `Bundler.bundle_path` instead
    next if locked_gems&.any? do |locked_spec|
      locked_spec.name == short_name &&
        !Gem::Specification.find_by_name(short_name).full_gem_path.start_with?(RbConfig::CONFIG["rubylibprefix"])
    rescue Gem::MissingSpecError
      # If a default gem is scoped to a specific platform, then `find_by_name` will raise. We want to skip those
      # cases
      true
    end

    if pathname.directory?
      # If the default_path is a directory, we index all the Ruby files in it
      indexables.concat(
        Dir.glob(File.join(default_path, "**", "*.rb"), File::FNM_PATHNAME | File::FNM_EXTGLOB).map! do |path|
          IndexablePath.new(RbConfig::CONFIG["rubylibdir"], path)
        end,
      )
    elsif pathname.extname == ".rb"
      # If the default_path is a Ruby file, we index it
      indexables << IndexablePath.new(RbConfig::CONFIG["rubylibdir"], default_path)
    end
  end

  # Add the locked gems to the list of files to be indexed
  locked_gems&.each do |lazy_spec|
    next if excluded_gems.include?(lazy_spec.name)

    spec = Gem::Specification.find_by_name(lazy_spec.name)

    # When working on a gem, it will be included in the locked_gems list. Since these are the project's own files,
    # we have already included and handled exclude patterns for it and should not re-include or it'll lead to
    # duplicates or accidentally ignoring exclude patterns
    next if spec.full_gem_path == @workspace_path

    indexables.concat(
      spec.require_paths.flat_map do |require_path|
        load_path_entry = File.join(spec.full_gem_path, require_path)
        Dir.glob(File.join(load_path_entry, "**", "*.rb")).map! { |path| IndexablePath.new(load_path_entry, path) }
      end,
    )
  rescue Gem::MissingSpecError
    # If a gem is scoped only to some specific platform, then its dependencies may not be installed either, but they
    # are still listed in locked_gems. We can't index them because they are not installed for the platform, so we
    # just ignore if they're missing
  end

  indexables.uniq!(&:full_path)
  indexables
end

#magic_comment_regex ⇒ Object 



163
164
165
 
# File 'lib/ruby_indexer/lib/ruby_indexer/configuration.rb', line 163

def magic_comment_regex
  @magic_comment_regex ||= T.let(/^#\s*#{@excluded_magic_comments.join("|")}/, T.nilable(Regexp))
end