Class: Dependabot::PullRequestCreator::MessageBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/pull_request_creator/message_builder.rb

Constant Summary collapse

ANGULAR_PREFIXES = 
%w(build chore ci docs feat fix perf refactor style
test).freeze
ESLINT_PREFIXES = 
%w(Breaking Build Chore Docs Fix New Update
Upgrade).freeze
GITMOJI_PREFIXES = 
%w(alien ambulance apple arrow_down arrow_up art beers
bento bookmark boom bug building_construction bulb
busts_in_silhouette camera_flash card_file_box
chart_with_upwards_trend checkered_flag
children_crossing clown_face construction
construction_worker egg fire globe_with_meridians
green_apple green_heart hankey heavy_minus_sign
heavy_plus_sign iphone lipstick lock loud_sound memo
mute ok_hand package page_facing_up pencil2 penguin
pushpin recycle rewind robot rocket rotating_light
see_no_evil sparkles speech_balloon tada truck
twisted_rightwards_arrows whale wheelchair
white_check_mark wrench zap).freeze
ISSUE_TAG_REGEX = 
/(?<=[^A-Za-z0-9\[\\]|^)\\*(?<tag>(?:\#|GH-)\d+)(?=[^A-Za-z0-9\-]|$)/.
freeze
GITHUB_REF_REGEX = 
%r{
  (?:https?://)?
  github\.com/[^/\s]+/[^/\s]+/
  (?:issue|pull)s?/(?<number>\d+)
}x.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source:, dependencies:, files:, credentials:, pr_message_footer: nil, author_details: nil, vulnerabilities_fixed: {}) ⇒ MessageBuilder

Returns a new instance of MessageBuilder.



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 42

def initialize(source:, dependencies:, files:, credentials:,
               pr_message_footer: nil, author_details: nil,
               vulnerabilities_fixed: {})
  @dependencies          = dependencies
  @files                 = files
  @source                = source
  @credentials           = credentials
  @pr_message_footer     = pr_message_footer
  @author_details        = author_details
  @vulnerabilities_fixed = vulnerabilities_fixed
end

Instance Attribute Details

#author_details ⇒ Object (readonly)

Returns the value of attribute author_details.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def author_details
  @author_details
end

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def credentials
  @credentials
end

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def dependencies
  @dependencies
end

#files ⇒ Object (readonly)

Returns the value of attribute files.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def files
  @files
end

#pr_message_footer ⇒ Object (readonly)

Returns the value of attribute pr_message_footer.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def pr_message_footer
  @pr_message_footer
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def source
  @source
end

#vulnerabilities_fixed ⇒ Object (readonly)

Returns the value of attribute vulnerabilities_fixed.



39
40
41
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 39

def vulnerabilities_fixed
  @vulnerabilities_fixed
end

Instance Method Details

#commit_message ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 64

def commit_message
  message = commit_subject + "\n\n"
  message += commit_message_intro
  message += metadata_links
  message += "\n\n" + message_trailers if message_trailers
  message
end

#pr_message ⇒ Object 



60
61
62
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 60

def pr_message
  commit_message_intro + metadata_cascades + prefixed_pr_message_footer
end

#pr_name ⇒ Object 



54
55
56
57
58
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 54

def pr_name
  return library_pr_name if library?

  application_pr_name
end