Class: GemBench::Team

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/gem_bench/team.rb

Overview

It doesn’t make sense to use Team unless the Gemfile you want to evaluate is currently loaded. For example:

- if you are in a rails console, and want to evaluate the Gemfile of the Rails app, that's great!
- if you are in a context with no Gemfile loaded, or a different Gemfile loaded than the one you want to evaluate,
  this class may not give sensible results. This is because it checks loaded gems via RubyGems and Bundler.

Terminology:

starter: a gem that needs to be loaded when bundler normally loads gems

bencher: a gem that can, or should, have require: false to delay loading until after bootstrap

Constant Summary collapse

EXCLUDE = 
%w[
  bundler
  gem_bench
  i18n-airbrake
  devise-async
  km
  vestal_versions
  omniauth-facebook
  flag_shih_tzu
  pry-remote
  koala
  simple_form
  thumbs_up
  memoist
  cancan
  friendly_id
  faker
  capistrano3-puma
  wkhtmltopdf-binary
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**options) ⇒ Team

Returns a new instance of Team.



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
78
79
80
81
82
83
84
85
86
 
# File 'lib/gem_bench/team.rb', line 51

def initialize(**options)
  @look_for_regex = options[:look_for_regex]
  # find: Find gems containing specific strings in code
  # bench: Find gems that can probably be benched (require: false) in the Gemfile
  @check_type = @look_for_regex ? :find : :bench
  @benching = @check_type == :bench
  @scout = GemBench::Scout.new(
    check_gemfile: options.fetch(:check_gemfile, benching?),
    gemfile_path: options.fetch(:gemfile_path, "#{Dir.pwd}/Gemfile"),
  )
  @exclude_file_pattern_regex_proc = options[:exclude_file_pattern_regex_proc].respond_to?(:call) ? options[:exclude_file_pattern_regex_proc] : GemBench::EXCLUDE_FILE_PATTERN_REGEX_PROC
  # Among the loaded gems there may be some that did not need to be.
  exclude!
  exclusions = " + #{excluded.length} loaded gems which GemBench is configured to ignore.\n" if excluded.any?
  @starters = []
  @benchers = []
  @current_gemfile_suggestions = []
  @verbose = options[:verbose]
  check_all
  @bad_ideas = if benching?
    if options[:bad_ideas]
      true
    else
      check_gemfile? ? false : !(options[:bad_ideas] == false)
    end
  else
    false
  end
  puts "[GemBench] Will search for gems in #{gem_paths.inspect}\n#{if benching?
                                                                     check_gemfile? ? "[GemBench] Will check Gemfile at #{gemfile_path}.\n" : "[GemBench] No Gemfile found.\n"
                                                                   else
                                                                     ""
                                                                   end}#{bad_ideas ? "[GemBench] Will show bad ideas.  Be Careful.\n" : ""}[GemBench] Detected #{all.length} loaded gems#{exclusions}"
  compare_gemfile if benching? && check_gemfile?
  self.print if verbose
end

Instance Attribute Details

#all ⇒ Object

Returns the value of attribute all.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def all
  @all
end

#bad_ideas ⇒ Object

Returns the value of attribute bad_ideas.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def bad_ideas
  @bad_ideas
end

#benchers ⇒ Object

Returns the value of attribute benchers.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def benchers
  @benchers
end

#current_gemfile_suggestions ⇒ Object

Returns the value of attribute current_gemfile_suggestions.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def current_gemfile_suggestions
  @current_gemfile_suggestions
end

#excluded ⇒ Object

Returns the value of attribute excluded.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def excluded
  @excluded
end

#gemfile_lines ⇒ Object

Returns the value of attribute gemfile_lines.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def gemfile_lines
  @gemfile_lines
end

#look_for_regex ⇒ Object (readonly)

Returns the value of attribute look_for_regex.



40
41
42
 
# File 'lib/gem_bench/team.rb', line 40

def look_for_regex
  @look_for_regex
end

#scout ⇒ Object (readonly)

Returns the value of attribute scout.



40
41
42
 
# File 'lib/gem_bench/team.rb', line 40

def scout
  @scout
end

#starters ⇒ Object

Returns the value of attribute starters.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def starters
  @starters
end

#trash_lines ⇒ Object

Returns the value of attribute trash_lines.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def trash_lines
  @trash_lines
end

#verbose ⇒ Object

Returns the value of attribute verbose.



41
42
43
 
# File 'lib/gem_bench/team.rb', line 41

def verbose
  @verbose
end

Instance Method Details

#add_to_roster(player) ⇒ Object 



221
222
223
224
225
226
227
 
# File 'lib/gem_bench/team.rb', line 221

def add_to_roster(player)
  if player.starter?
    starters << player
  else
    benchers << player
  end
end

#check(player) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/gem_bench/team.rb', line 209

def check(player)
  gem_paths.detect do |path|
    glob_path = "#{path}/#{player.file_path_glob}"
    file_paths = Dir.glob(glob_path)
    puts "[GemBench] checking #{player} at #{glob_path} (#{file_paths.length} files)" if extra_verbose?
    file_paths.detect do |file_path|
      player.set_starter(file_path, line_match: look_for_regex)
      player.starter?
    end
  end
end

#check_all ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/gem_bench/team.rb', line 196

def check_all
  all.each do |player_data|
    exclude_file_pattern = @exclude_file_pattern_regex_proc.call(player_data[0])
    player = GemBench::Player.new({
      name: player_data[0],
      version: player_data[1],
      exclude_file_pattern: exclude_file_pattern,
    })
    check(player)
    add_to_roster(player)
  end
end

#compare_gemfile ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/gem_bench/team.rb', line 179

def compare_gemfile
  benchers.each do |player|
    scout.gemfile_lines.each do |line|
      found = (line =~ player.gemfile_regex)
      next unless found

      # remove the found line from the array, because no sane person has more than one gem dependency per line... right?
      line = scout.gemfile_lines.delete_at(scout.gemfile_lines.index(line))
      # does the line already have require: false?
      unless line =~ GemBench::REQUIRE_FALSE_REGEX
        current_gemfile_suggestions << benchers.delete_at(benchers.index(player))
      end
      break # outside of the inner loop
    end
  end
end

#list_starters(format: :name) ⇒ Object 



88
89
90
 
# File 'lib/gem_bench/team.rb', line 88

def list_starters(format: :name)
  starters.map { |starter| starter.to_s(format) }
end

#nothing ⇒ Object 



161
162
163
 
# File 'lib/gem_bench/team.rb', line 161

def nothing
  "[GemBench] No gems were evaluated by GemBench.\n#{GemBench::USAGE}"
end

#prepare_bad_ideas ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/gem_bench/team.rb', line 165

def prepare_bad_ideas
  string = ""
  if benchers.any?
    gemfile_instruction = check_gemfile? ? "" : "To safely evaluate a Gemfile:\n\t1. Make sure you are in the root of a project with a Gemfile\n\t2. Make sure the gem is actually a dependency in the Gemfile\n"
    string << "[GemBench] Evaluated #{all.length} loaded gems and found #{benchers.length} which may be able to skip boot loading (require: false).\n*** => WARNING <= ***: Be careful adding non-primary dependencies to your Gemfile as it is generally a bad idea.\n#{gemfile_instruction}"
    benchers.each_with_index do |player, index|
      string << "#{player.careful(index + 1)}\n"
    end
  else
    string << strike_out
  end
  string
end

#print ⇒ Object

Returns void.

Returns:

  • void



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
 
# File 'lib/gem_bench/team.rb', line 93

def print
  string = ""
  if all.empty?
    string << nothing
  elsif starters.empty?
    string << if benching?
      "[GemBench] Found no gems that need to load at boot time.\n"
    else
      "[GemBench] Found no gems containing #{look_for_regex} in Ruby code.\n"
    end
  else
    string << "\n#{GemBench::USAGE}" unless check_gemfile?
    string << if benching?
      "[GemBench] We found a Rails::Railtie or Rails::Engine in the following files. However, it is possible that there are false positives, so you may want to verify that this is the case.\n\n"
    else
      "[GemBench] We found #{look_for_regex} in the following files.\n\n"
    end
    starters.each do |starter|
      string << "\t#{starter}:\n"
      starter.stats.each do |stat|
        string << "\t\t#{stat[0]}:#{stat[1]}\n"
      end
    end
    if benching?
      string << "[GemBench] If you want to check for false positives, the files to check for Railties and Engines are listed above.\n"
    end
    string << if benching?
      "[GemBench] #{starters.length} out of #{all.length} evaluated gems actually need to be loaded at boot time. They are:\n"
    else
      "[GemBench] #{starters.length} out of #{all.length} evaluated gems contain #{look_for_regex}. They are:\n"
    end
    starters.each_with_index do |starter, index|
      string << "#{starter.info(index + 1)}\n"
    end
    if extra_verbose? && !benching? && benchers.any?
      string << "[GemBench] #{benchers.length} out of #{all.length} evaluated gems did not contain #{look_for_regex}. They are:\n"
      benchers.each_with_index do |bencher, index|
        string << "#{bencher.info(index + 1)}\n"
      end
    end
  end
  if check_gemfile? && benching?
    if current_gemfile_suggestions.any?
      string << "[GemBench] Evaluated #{all.length} gems and Gemfile at #{gemfile_path}.\n[GemBench] Here are #{current_gemfile_suggestions.length} suggestions for improvement:\n"
      current_gemfile_suggestions.each_with_index do |player, index|
        string << "#{player.suggest(index + 1)}\n"
      end
    else
      string << strike_out
    end
  end

  if benching? && bad_ideas
    # Only bad ideas if you are evaluating an actual Gemfile. If just evaluating loaded gems, then info is fine.
    string << prepare_bad_ideas
  end

  puts string
end

#strike_out ⇒ Object 



153
154
155
156
157
158
159
 
# File 'lib/gem_bench/team.rb', line 153

def strike_out
  if check_gemfile?
    "[GemBench] Evaluated #{all.length} gems against your Gemfile but found no primary dependencies which can safely skip require on boot (require: false).\n"
  else
    "[GemBench] Evaluated #{all.length} gems but found none which can safely skip require on boot (require: false).\n"
  end
end