Class: Dependabot::PullRequestCreator::MessageBuilder

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

Defined Under Namespace

Classes: IssueLinker, LinkAndMentionSanitizer

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MessageBuilder.



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

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

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def credentials
  @credentials
end

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def dependencies
  @dependencies
end

#files ⇒ Object (readonly)

Returns the value of attribute files.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def files
  @files
end

#github_redirection_service ⇒ Object (readonly)

Returns the value of attribute github_redirection_service.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def github_redirection_service
  @github_redirection_service
end

#pr_message_footer ⇒ Object (readonly)

Returns the value of attribute pr_message_footer.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def pr_message_footer
  @pr_message_footer
end

#signoff_details ⇒ Object (readonly)

Returns the value of attribute signoff_details.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def signoff_details
  @signoff_details
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def source
  @source
end

#vulnerabilities_fixed ⇒ Object (readonly)

Returns the value of attribute vulnerabilities_fixed.



34
35
36
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 34

def vulnerabilities_fixed
  @vulnerabilities_fixed
end

Instance Method Details

#commit_message ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 61

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 



57
58
59
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 57

def pr_message
  commit_message_intro + metadata_cascades + prefixed_pr_message_footer
end

#pr_name ⇒ Object 



51
52
53
54
55
 
# File 'lib/dependabot/pull_request_creator/message_builder.rb', line 51

def pr_name
  return library_pr_name if library?

  application_pr_name
end