Module: Lapidario::Helper

Defined in:
lib/helper.rb

Constant Summary collapse

@@GEM_VERSION_FRAGMENT =

regex to match the version fragment in a Gemfile, such as ‘~> 0.21’, ‘1.2’, ‘>= 10.2.1’, ‘1.2alpha’ etc;

/^\s*([<>]=?|~>)?\s*[0-9a-zA-Z\s.]+\s*$/
@@DETECT_GEMFILE_IN_PATH = 
/\/Gemfile/
@@DETECT_LOCKFILE_IN_PATH = 
/\/Gemfile\.lock/
@@DETECT_LOCKED_LINE =

checks 0 or more spaces to the left or 1 or more to the right, also asserting that LOCK is at the end of string

/\s*LOCK\s*\z/
@@VERSION_SIGNS = 
['~>', '>=', '<=', '>', '<', '']

Class Method Summary collapse

Class Method Details

.extract_git_gem_info(git_gem_fragment) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/helper.rb', line 82

def self.extract_git_gem_info(git_gem_fragment)
  remote = ""
  # extract repo address
  git_gem_fragment.each do |line|
    if line.match?(/^\s*remote:\s/)
      remote = line.split(":", 2)[1].strip 
      break
    end
  end
  name = ""
  version = ""
  # extract gem name and version
  git_gem_fragment.each_with_index do |line, index|
    if line.match?(/^\s*specs:$/) # gem name will come immediately after 'specs'
      gem_name_line = git_gem_fragment[index + 1].gsub(/\s/, '')
      name = gem_name_line.split("(")[0]
      version = gem_name_line.split("(")[1].sub(")", '')
      break
    end
  end
  version_and_remote = "#{version}, git: '#{remote}'"
  [name, version_and_remote]
end

.format_path(filepath, for_lockfile = false) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/helper.rb', line 39

def self.format_path(filepath, for_lockfile = false)
  # path can be ./project/, ./project or ./project/Gemfile, but never ./project/Gemfile/
  appendage = ""
  appendage = "/" unless (filepath =~ /\/$/ or filepath =~ @@DETECT_GEMFILE_IN_PATH) # checks if path finishes on '/' or if it contains Gemfile (also valid for lockfile)
  unless for_lockfile
    appendage = appendage + "Gemfile" unless filepath =~ @@DETECT_GEMFILE_IN_PATH
  else
    appendage = appendage + "Gemfile.lock" unless filepath =~ @@DETECT_LOCKFILE_IN_PATH
  end
  filepath + appendage
end

.format_version_based_on_depth(version_fragment, depth = 2) ⇒ Object

formats based on depth; ex: version_fragment = ‘3.12.4’ with depth 2 returns 3.12

Raises:



34
35
36
37
 
# File 'lib/helper.rb', line 34

def self.format_version_based_on_depth(version_fragment, depth = 2)
  raise Lapidario::Error, "Tried to format #{version_fragment} with inadequate depth '#{depth}'." unless depth >= 1 && depth <= 3
  version_fragment.split(".").slice(0, depth).join(".")
end

.gem_line?(gemfile_line) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
22
23
24
25
26
 
# File 'lib/helper.rb', line 19

def self.gem_line?(gemfile_line)
  commented_portion = gemfile_line.split("#", 2)[1] # gets everything to the right of a '#' if present in line
  if commented_portion && commented_portion.match?(@@DETECT_LOCKED_LINE)
    puts "Ignoring line as it ends in # LOCK: \n#{gemfile_line}"
    return false
  end
  gemfile_line.match?(/^\s*gem\s+["']([^"']+)["']/)
end

.get_file_as_array_of_lines(filepath) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/helper.rb', line 56

def self.get_file_as_array_of_lines(filepath)
  begin
    File.read(filepath).split("\n")
  rescue => e
    raise Lapidario::Error, "#{e.message}\n\nDouble-check the path provided for the Gemfile or Gemfile.lock\nProvided path:\n#{filepath}"
  end
end

.get_version_sign_from_number(version_sign_num) ⇒ Object 



28
29
30
31
 
# File 'lib/helper.rb', line 28

def self.get_version_sign_from_number(version_sign_num)
  raise "Available version signs range from 0 to 5, run `$lapidario --help` for details" if version_sign_num > 5 || version_sign_num < 0
  @@VERSION_SIGNS[version_sign_num]
end

.lockfile_primary_gem_line?(line) ⇒ Boolean

a primary gem line will always begin with 4 whitespaces.

Returns:

  • (Boolean) 


75
76
77
78
79
80
 
# File 'lib/helper.rb', line 75

def self.lockfile_primary_gem_line?(line)
  # \A: Asserts the start of the string.
  # \x20: represents a whitespace character; whitespace is char 32 in ascii, 20 is 32 in hex
  # {4}: Indicates exactly 4 occurrences of the preceding character (whitespace in this case).
  line.match?(/\A\x20{4}[A-Za-z0-9]/)
end

.save_file(save_path, content) ⇒ Object 



51
52
53
54
 
# File 'lib/helper.rb', line 51

def self.save_file(save_path, content)
  content.join("\n") if content.is_a? Array
  File.write(save_path, content)
end

.slice_up_to_next_empty_line(initial_index, lines_array) ⇒ Object

Lockfile-focused helpers

Raises:



65
66
67
68
69
70
71
72
 
# File 'lib/helper.rb', line 65

def self.slice_up_to_next_empty_line(initial_index, lines_array)
  final_index = -1
  (initial_index...lines_array.size).each do |i|
    final_index = i if lines_array[i].empty?
  end
  raise Lapidario::Error, "Gemfile.lock should have an empty line as the last line in the file." if final_index < 0
  lines_array.slice(initial_index, final_index)
end

.version_fragment?(line_section) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/helper.rb', line 15

def self.version_fragment?(line_section)
  line_section.match? @@GEM_VERSION_FRAGMENT
end