Class: GitHubChangelogGenerator::Parser
- Inherits:
-
Object
- Object
- GitHubChangelogGenerator::Parser
- Defined in:
- lib/github_changelog_generator/parser.rb
Class Method Summary collapse
-
.default_options ⇒ Object
just get default options.
-
.detect_user_and_project(options, arg0 = nil, arg1 = nil) ⇒ Object
Detects user and project from git.
-
.parse_options ⇒ Object
parse options with optparse.
- .print_options(options) ⇒ Object
-
.setup_parser(options) ⇒ Object
setup parsing options.
- .user_and_project_from_git(options) ⇒ Object
-
.user_project_from_option(arg0, arg1, github_site) ⇒ Array
Try to find user and project name from git remote output.
-
.user_project_from_remote(remote) ⇒ Array
Try to find user and project name from git remote output.
Class Method Details
.default_options ⇒ Object
just get default options
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/github_changelog_generator/parser.rb', line 168 def self. { tag1: nil, tag2: nil, date_format: "%Y-%m-%d", output: "CHANGELOG.md", base: "HISTORY.md", issues: true, add_issues_wo_labels: true, add_pr_wo_labels: true, pulls: true, filter_issues_by_milestone: true, author: true, unreleased: true, unreleased_label: "Unreleased", compare_link: true, enhancement_labels: %w(enhancement Enhancement), bug_labels: %w(bug Bug), exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix), max_issues: nil, simple_list: false, verbose: true, header: "# Change Log", merge_prefix: "**Merged pull requests:**", issue_prefix: "**Closed issues:**", bug_prefix: "**Fixed bugs:**", enhancement_prefix: "**Implemented enhancements:**", git_remote: "origin" } end |
.detect_user_and_project(options, arg0 = nil, arg1 = nil) ⇒ Object
Detects user and project from git
206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/github_changelog_generator/parser.rb', line 206 def self.detect_user_and_project(, arg0 = nil, arg1 = nil) [:user], [:project] = user_project_from_option(arg0, arg1, [:github_site]) return if [:user] && [:project] if ENV["RUBYLIB"] =~ /ruby-debug-ide/ [:user] = "skywinder" [:project] = "changelog_test" else remote = `git config --get remote.#{[:git_remote]}.url` [:user], [:project] = user_project_from_remote(remote) end end |
.parse_options ⇒ Object
parse options with optparse
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/github_changelog_generator/parser.rb', line 9 def self. = ParserFile.new().parse! parser = setup_parser() parser.parse! user_and_project_from_git() abort(parser.) unless [:user] && [:project] () end |
.print_options(options) ⇒ Object
27 28 29 30 31 32 33 34 35 |
# File 'lib/github_changelog_generator/parser.rb', line 27 def self.() if [:verbose] Helper.log.info "Performing task with options:" = .clone [:token] = [:token].nil? ? nil : "hidden value" pp puts "" end end |
.setup_parser(options) ⇒ Object
setup parsing options
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/github_changelog_generator/parser.rb', line 38 def self.setup_parser() parser = OptionParser.new do |opts| opts. = "Usage: github_changelog_generator [options]" opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last| [:user] = last end opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last| [:project] = last end opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last| [:token] = last end opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last| [:date_format] = last end opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last| [:output] = last end opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last| [:base] = last end opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v| [:bug_prefix] = v end opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v| [:enhancement_prefix] = v end opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v| [:issue_prefix] = v end opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v| [:header] = v end opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v| [:frontmatter] = JSON.parse(v).to_yaml + "---\n" end opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v| [:merge_prefix] = v end opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v| [:issues] = v end opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v| [:add_issues_wo_labels] = v end opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v| [:add_pr_wo_labels] = v end opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v| [:pulls] = v end opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last| [:filter_issues_by_milestone] = last end opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do || [:author] = end opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v| [:unreleased_only] = v end opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v| [:unreleased] = v end opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v| [:unreleased_label] = v end opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v| [:compare_link] = v end opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list| [:include_labels] = list end opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list| [:exclude_labels] = list end opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list| [:bug_labels] = list end opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list| [:enhancement_labels] = list end opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list| [:between_tags] = list end opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list| [:exclude_tags] = list end opts.on("--since-tag x", "Change log will start after specified tag") do |v| [:since_tag] = v end opts.on("--due-tag x", "Change log will end before specified tag") do |v| [:due_tag] = v end opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max| [:max_issues] = max end opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url| [:release_url] = url end opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last| [:github_site] = last end opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last| [:github_endpoint] = last end opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v| [:simple_list] = v end opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release| [:future_release] = future_release end opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch| [:release_branch] = release_branch end opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v| [:verbose] = v end opts.on("-v", "--version", "Print version number") do |_v| puts "Version: #{GitHubChangelogGenerator::VERSION}" exit end opts.on("-h", "--help", "Displays Help") do puts opts exit end end parser end |
.user_and_project_from_git(options) ⇒ Object
199 200 201 202 203 |
# File 'lib/github_changelog_generator/parser.rb', line 199 def self.user_and_project_from_git() if [:user].nil? || [:project].nil? detect_user_and_project(, ARGV[0], ARGV[1]) end end |
.user_project_from_option(arg0, arg1, github_site) ⇒ Array
Try to find user and project name from git remote output
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/github_changelog_generator/parser.rb', line 223 def self.user_project_from_option(arg0, arg1, github_site) user = nil project = nil github_site ||= "github.com" if arg0 && !arg1 # this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name puts arg0 match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0) begin param = match[2].nil? rescue puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'" return end if param return else user = match[1] project = match[2] end end [user, project] end |
.user_project_from_remote(remote) ⇒ Array
Try to find user and project name from git remote output
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/github_changelog_generator/parser.rb', line 252 def self.user_project_from_remote(remote) # try to find repo in format: # origin [email protected]:skywinder/Github-Changelog-Generator.git (fetch) # [email protected]:skywinder/Github-Changelog-Generator.git regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/ # try to find repo in format: # origin https://github.com/skywinder/ChangelogMerger (fetch) # https://github.com/skywinder/ChangelogMerger regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/ remote_structures = [regex1, regex2] user = nil project = nil remote_structures.each do |regex| matches = Regexp.new(regex).match(remote) if matches && matches[1] && matches[2] puts "Detected user:#{matches[1]}, project:#{matches[2]}" user = matches[1] project = matches[2] end break unless matches.nil? end [user, project] end |