Class: GemXray::Editors::GemfileEditor

Inherits:
Object
  • Object
show all
Defined in:
lib/gemxray/editors/gemfile_editor.rb

Defined Under Namespace

Classes: EditResult

Instance Method Summary collapse

Constructor Details

#initialize(gemfile_path) ⇒ GemfileEditor

Returns a new instance of GemfileEditor.



10
11
12
 
# File 'lib/gemxray/editors/gemfile_editor.rb', line 10

def initialize(gemfile_path)
  @gemfile_path = File.expand_path(gemfile_path)
end

Instance Method Details

#apply(results, dry_run:, comment:, backup: true) ⇒ Object 



14
15
16
17
18
19
20
21
22
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
54
55
56
57
58
59
60
61
62
 
# File 'lib/gemxray/editors/gemfile_editor.rb', line 14

def apply(results, dry_run:, comment:, backup: true)
  lines = File.readlines(gemfile_path, chomp: false)
  preview_hunks = []
  removed = []
  skipped = []

  results.sort_by { |result| -(result.gemfile_line || 0) }.each do |result|
    line_number = result.gemfile_line
    end_line = result.gemfile_end_line || line_number
    if !line_number || !gem_line?(lines[line_number - 1], result.gem_name)
      skipped << result.gem_name
      next
    end

    replacement =
      if comment
        ["#{leading_whitespace(lines[line_number - 1])}# Removed by gemxray: #{comment_summary(result)}\n"]
      else
        []
      end
    original = lines[(line_number - 1)..(end_line - 1)]
    preview_hunks << build_preview_hunk(result, original, replacement)

    if comment
      lines[(line_number - 1)..(end_line - 1)] = replacement
    else
      lines[(line_number - 1)..(end_line - 1)] = replacement
    end

    removed << result.gem_name
  end

  backup_path = nil
  unless dry_run || removed.empty?
    if backup
      backup_path = "#{gemfile_path}.bak"
      File.write(backup_path, File.read(gemfile_path))
    end
    File.write(gemfile_path, lines.join)
  end

  EditResult.new(
    removed: removed.reverse,
    skipped: skipped.uniq,
    dry_run: dry_run,
    backup_path: backup_path,
    preview: preview_hunks.reverse.join("\n")
  )
end

#bundle_install! ⇒ Object

Raises:



64
65
66
67
68
69
 
# File 'lib/gemxray/editors/gemfile_editor.rb', line 64

def bundle_install!
  stdout, stderr, status = Open3.capture3("bundle", "install", chdir: project_root)
  return stdout if status.success?

  raise Error, "bundle install failed: #{stderr.strip.empty? ? stdout.strip : stderr.strip}"
end