danger-dangermattic 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15ae97cc1a24568ecab35470fabcf26fcb858e586abf81f1c9cba4e8f28a095
-  data.tar.gz: 5a5441a1ffd66d05a136e3db188b3f20cb963ef8c376ea70af86b6194cf6a79c
+  metadata.gz: 3e67bce42d784090d66f708da30837272d7ba007361e0ca5e8a3112934f7662c
+  data.tar.gz: b52fd5c635ff28d370d19cbbcb5ce0149e947fdb7f6f2fd10b8e7e00543adf7d
 SHA512:
-  metadata.gz: b5fe63d7356f08bd84721b91436eb66e66e6a3b1cb4b53c17e5e503e10d95417af516224c904dd788c5971b5e69d79e09e1d11c0a87673051a2bd34deb6add6a
-  data.tar.gz: 03c6f7e8fe657924e88aeaecd6d0bf56ae68f133f3b5ed0214267507ab1c4692f711b181a5ec41e2de47bb12e13da4e2af7d6cb0a1155d6ad628a2abf7f74a6d
+  metadata.gz: 4e9316d9415127bfef3be854d7ef5662f15df950f623123f1c325ef282e520f0f75d229d6955ec5980cc4286e7c67a5f4738c76486a7a68f316cdc467da7f812
+  data.tar.gz: 58f1deea10b0c92e769de341fee2e918c04321b8bff563bf872e60cd4c8dba30d6b4dd0caf99c7ccdd2cec0e6c309ff5af17ad069ec2e9c27f194c74c061ec8d

data/.github/workflows/reusable-retry-buildkite-step-on-events.yml

@@ -35,7 +35,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🔄 Retry job on the latest Buildkite Build"
+        env:
+          READ_ONLY_MODE: ${{ github.event.pull_request.head.repo.fork || github.actor == 'dependabot[bot]' }}
         run: |
+          [ "$READ_ONLY_MODE" = true ] && { echo "ℹ️ Cannot retry a Buildkite job from GitHub when running in read-only mode (from a fork or a Dependabot Pull Request). Please find the Buildkite job and retry manually."; exit 0; }
+
           ORG_SLUG="${{ inputs.org-slug }}"
           PIPELINE_SLUG="${{ inputs.pipeline-slug }}"
           RETRY_STEP_KEY="${{ inputs.retry-step-key }}"

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ---
 
+## Trunk
+
+### Breaking Changes
+
+_None_
+
+### New Features
+
+_None_
+
+### Bug Fixes
+
+_None_
+
+### Internal Changes
+
+_None_
+
+## 1.1.2
+
+### Internal Changes
+
+- Bump Ruby dependencies (#76)
+
 ## 1.1.1
 
 ### Internal Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-dangermattic (1.1.1)
+    danger-dangermattic (1.1.2)
       danger (~> 9.4)
       danger-plugin-api (~> 1.0)
       danger-rubocop (~> 0.13)
@@ -10,10 +10,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
-    base64 (0.2.0)
     claide (1.1.0)
     claide-plugins (0.9.2)
       cork
@@ -23,7 +22,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (9.4.3)
+    danger (9.5.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -33,7 +32,6 @@ GEM
       git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
-      no_proxy_fix
       octokit (>= 4.0)
       terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
@@ -42,13 +40,15 @@ GEM
       danger
       rubocop (~> 1.0)
     diff-lcs (1.5.1)
-    faraday (2.9.0)
+    faraday (2.10.1)
       faraday-net_http (>= 2.0, < 3.2)
+      logger
     faraday-http-cache (2.5.1)
       faraday (>= 0.8)
-    faraday-net_http (3.1.0)
+    faraday-net_http (3.1.1)
       net-http
-    ffi (1.16.3)
+    ffi (1.17.0)
+    ffi (1.17.0-arm64-darwin)
     formatador (1.1.0)
     git (1.19.1)
       addressable (~> 2.8)
@@ -76,30 +76,29 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
     lumberjack (1.2.10)
     method_source (1.1.0)
     nap (1.1.0)
     nenv (0.3.0)
     net-http (0.4.1)
       uri
-    no_proxy_fix (0.1.2)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (8.1.0)
-      base64
+    octokit (9.1.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.5)
-    racc (1.8.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
@@ -107,47 +106,38 @@ GEM
       ffi (~> 1.0)
     rchardet (1.8.0)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.4)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.29.2)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     sawyer (0.9.2)
       addressable (>= 2.3.5)

data/Rakefile

@@ -11,7 +11,7 @@ task all: %i[specs lint]
 
 desc 'Ensure that the plugin passes `danger plugins lint`'
 task :danger_lint do
-  sh 'bundle exec danger plugins lint'
+  sh('bundle', 'exec', 'danger', 'plugins', 'lint')
 end
 
 desc 'Runs linting tasks: :rubocop and :danger_lint'
@@ -22,3 +22,90 @@ RSpec::Core::RakeTask.new(:specs)
 
 desc 'Run RuboCop on the lib/specs directory'
 RuboCop::RakeTask.new(:rubocop)
+
+desc 'Generate the docs using YARD'
+task :doc do
+  sh('bundle', 'exec', 'yard', 'doc')
+  # Open generated doc in browser
+  sh('open', 'yard-doc/index.html')
+end
+
+desc "Print stats about undocumented methods. Provide an optional path relative to 'lib/dangermattic/plugins' to only show stats for that subdirectory"
+task :docstats, [:path] do |_, args|
+  path = File.join('lib/dangermattic/plugins', args[:path] || '.')
+  sh('yard', 'stats', '--list-undoc', path)
+end
+
+VERSION_FILE = File.join('lib', 'dangermattic', 'gem_version.rb')
+
+desc 'Create a new version of the dangermattic gem'
+task :new_release do
+  require_relative(VERSION_FILE)
+
+  parser = ChangelogParser.new(file: 'CHANGELOG.md')
+  latest_version = parser.parse_pending_section
+
+  ## Print current info
+  Console.header "Current version is: #{Dangermattic::VERSION}"
+  Console.warning "Warning: Latest version number does not match latest version title in CHANGELOG (#{latest_version})!" unless latest_version == Dangermattic::VERSION
+
+  Console.header 'Pending CHANGELOG:'
+  changelog = parser.cleaned_pending_changelog_lines
+  Console.print_indented_lines(changelog)
+
+  ## Prompt for next version number
+  guess = parser.guessed_next_semantic_version(current: Dangermattic::VERSION)
+  new_version = Console.prompt('New version to release', guess)
+
+  ## Checkout branch, update files
+  GitHelper.check_or_create_branch(new_version)
+  Console.header 'Update `VERSION` constant in `version.rb`...'
+  update_version_constant(VERSION_FILE, new_version)
+  Console.header 'Updating CHANGELOG...'
+  parser.update_for_new_release(new_version: new_version)
+
+  # Commit and push
+  Console.header 'Commit and push changes...'
+  GitHelper.commit_files("Bumped to version #{new_version}", [VERSION_FILE, 'Gemfile.lock', 'CHANGELOG.md'])
+
+  Console.header 'Opening PR draft in your default browser...'
+  pr_body = <<~BODY
+    Releasing new version #{new_version}.
+
+    # What's Next
+
+    PR Author: Be sure to create and publish a GitHub Release pointing to `trunk` once this PR gets merged,
+    copy/pasting the following text as the GitHub Release's description:
+    ```
+    #{changelog.join}
+    ```
+  BODY
+  GitHelper.prepare_github_pr("release/#{new_version}", 'trunk', "Release #{new_version} into trunk", pr_body)
+
+  Console.info <<~INSTRUCTIONS
+
+    ---------------
+
+    >>> WHAT'S NEXT
+
+    Once the PR is merged, publish a GitHub release for `#{new_version}`, targeting `trunk`,
+    with the following text as description:
+
+    ```
+    #{changelog.join}
+    ```
+
+    The publication of the new GitHub release will create a git tag, which in turn will trigger
+    a CI workflow that will take care of doing the `gem push` of the new version to RubyGems.
+
+  INSTRUCTIONS
+end
+
+def update_version_constant(version_file, new_version)
+  content = File.read(version_file)
+  content.gsub!(/VERSION = .*/, "VERSION = '#{new_version}'")
+  File.write(version_file, content)
+
+  # Updates the Gemfile.lock with the new dangermattic version
+  sh('bundle', 'install', '--quiet')
+end

data/danger-dangermattic.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 3.2'
 
   spec.add_dependency 'danger', '~> 9.4'
-  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_dependency 'danger-plugin-api', '~> 1.0'
 
   # Danger plugins
   spec.add_dependency 'danger-rubocop', '~> 0.13'

data/lib/dangermattic/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dangermattic
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/rakelib/changelog_parser.rake

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Parses and updates changelog files for software projects.
+#
+# This class provides functionality to parse a changelog file, identify pending
+# sections for upcoming releases, and update the changelog for new releases based on
+# semantic versioning conventions.
+#
+# @example
+#   parser = ChangelogParser.new(file: 'CHANGELOG.md')
+#   latest_version = parser.parse_pending_section
+#   new_version = parser.guessed_next_semantic_version(current: '1.0.0')
+#   parser.update_for_new_release(new_version: new_version)
+class ChangelogParser
+  PENDING_SECTION_TITLE = 'Trunk'
+  EMPTY_PLACEHOLDER = '_None_'
+  SUBSECTIONS_SEMVER_MAP = { 'Breaking Changes': 3, 'New Features': 2, 'Bug Fixes': 1, 'Internal Changes': 1 }.freeze
+
+  def initialize(file: 'CHANGELOG.md')
+    @lines = File.readlines(file)
+    @current_index = nil
+    @pending_section = nil
+  end
+
+  # @return the title of the section after the pending one -- which should match the latest released version
+  def parse_pending_section
+    (lines_before_first_section, _, title) = advance_to_next_header(level: 2)
+    raise "Expected #{PENDING_SECTION_TITLE} as first section but found #{title} instead." unless title == PENDING_SECTION_TITLE
+
+    subsections = []
+    prev_subtitle = nil
+    loop do
+      (lines, next_level, next_subtitle) = advance_to_next_header(level: 2..3)
+      subsections.append({ title: prev_subtitle, lines: lines }) unless lines.reject { |l| l.chomp.empty? || l.chomp == EMPTY_PLACEHOLDER }.empty?
+      prev_subtitle = next_subtitle
+
+      break if next_level < 3
+    end
+    @pending_section = { lines_before: lines_before_first_section, subsections: subsections, next_title: prev_subtitle }
+    prev_subtitle
+  end
+
+  def cleaned_pending_changelog_lines
+    lines = []
+    @pending_section[:subsections].map do |s|
+      lines.append "### #{s[:title]}\n" unless s[:title].nil? # subsection title is nil for lines between h2 and first h3
+      lines += s[:lines]
+    end
+    lines
+  end
+
+  def guessed_next_semantic_version(current:)
+    comps = current.split('.')
+    idx_to_bump = 3 - semver_category
+    comps[idx_to_bump] = (comps[idx_to_bump].to_i + 1).to_s
+    ((idx_to_bump + 1)...(comps.length)).each { |i| comps[i] = '0' }
+    comps.join('.')
+  end
+
+  def update_for_new_release(new_version:, new_file: 'CHANGELOG.md')
+    raise 'You need to call #parse_pending_section first' if @pending_section.nil?
+
+    File.open(new_file, 'w') do |f|
+      f.puts @pending_section[:lines_before]
+      # Empty placeholder section for next version after this one
+      f.puts placeholder_section
+      # Section for new version, with the non-empty subsections found while parsing first section
+      f.puts "## #{new_version}\n\n"
+      f.puts cleaned_pending_changelog_lines
+      f.puts "## #{@pending_section[:next_title]}"
+      f.puts read_up_to_end
+    end
+  end
+
+  private
+
+  # Advance line pointer to next index of provided `level`
+  # @return [Array] A 3-item array of [scanned_lines, next_header_level, next_header_title]
+  def advance_to_next_header(level:)
+    range = level.is_a?(Range) ? level : level..level
+    regex = /^(\#{#{range.min},#{range.max}}) ?([^#].*)$/ # A line starting with {range.min,range.max} times '#' then optional space then a title
+    start_idx = @current_index.nil? ? 0 : @current_index + 1
+    offset = @lines[start_idx...].index { |l| l =~ regex }
+    @current_index = offset.nil? ? -1 : start_idx + offset
+
+    m = regex.match(@lines[@current_index])
+    [@lines[start_idx...@current_index], m[1].length, m[2]]
+  end
+
+  def read_up_to_end
+    idx = @current_index + 1
+    @current_index = -1
+    @lines[idx...]
+  end
+
+  def placeholder_section
+    lines = ["## #{PENDING_SECTION_TITLE}\n\n"]
+    lines += SUBSECTIONS_SEMVER_MAP.keys.map { |s| "### #{s}\n\n#{EMPTY_PLACEHOLDER}\n\n" }
+    lines.join
+  end
+
+  # @return the SemVer category (as described in Gem::Version doc). 3=major, 2=minor, 1=patch
+  def semver_category
+    raise 'You need to call #parse_pending_section first' if @pending_section.nil?
+
+    @pending_section[:subsections].map { |s| SUBSECTIONS_SEMVER_MAP[s[:title].to_sym] || 1 }.max || 1
+  end
+end

data/rakelib/console.rake

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Provides methods for colored console output and user interaction.
+#
+# The Console module contains methods for printing colored text to the terminal using
+# ANSI escape codes. It also includes utility methods for prompting user input.
+module Console
+  # ANSI colors
+  RED = 1
+  GREEN = 2
+  YELLOW = 3
+  PURPLE = 4
+
+  def self.color_puts(lines, color_code:)
+    puts "\x1b[3#{color_code}m#{lines}\x1b[0m"
+  end
+
+  def self.header(title)
+    color_puts(">>> #{title}", color_code: GREEN) # green
+  end
+
+  def self.info(text)
+    color_puts(text, color_code: YELLOW) # yellow
+  end
+
+  def self.warning(text)
+    color_puts(text, color_code: RED) # red
+  end
+
+  def self.print_indented_lines(lines)
+    color_puts(lines.map { |l| "| #{l}" }.join, color_code: YELLOW)
+  end
+
+  def self.prompt(text, default_value)
+    color_puts("#{text}? [default: #{default_value}] ", color_code: GREEN)
+    answer = $stdin.gets.chomp
+    answer = default_value if answer.empty?
+    answer
+  end
+
+  def self.confirm(text)
+    color_puts("#{text} [y/n]?", color_code: GREEN)
+    answer = $stdin.gets.chomp
+    answer.downcase == 'y'
+  end
+end

data/rakelib/git_helpers.rake

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+# Helper methods for common Git operations: checking / creating branches, preparing a pull request and
+# committing / pushing files.
+module GitHelper
+  def self.current_branch
+    `git --no-pager branch --show-current`.chomp
+  end
+
+  def self.check_or_create_branch(new_version)
+    release_branch = "release/#{new_version}"
+    branch_exists = !`git --no-pager branch -a --list --no-color #{release_branch}`.chomp.empty?
+    if current_branch == release_branch
+      puts 'Already on release branch'
+    elsif branch_exists
+      Rake.sh('git', 'checkout', release_branch)
+    else # create it
+      abort('Aborted, as not run from trunk nor release branch') unless current_branch == 'trunk' || Console.confirm("You are not on 'trunk', nor already on '#{release_branch}'. Do you really want to cut the release branch from #{current_branch}?")
+
+      Rake.sh('git', 'checkout', '-b', release_branch)
+    end
+  end
+
+  def self.prepare_github_pr(head, base, title, body)
+    require 'open-uri'
+    qtitle = CGI.escape(title)
+    qbody = CGI.escape(body)
+    uri = "https://github.com/Automattic/dangermattic/compare/#{base}...#{head}?expand=1&title=#{qtitle}&body=#{qbody}"
+    Rake.sh('open', uri)
+  end
+
+  def self.commit_files(message, files, push: true)
+    Rake.sh('git', 'add', *files)
+    Rake.sh('git', 'commit', '-m', message)
+    Rake.sh('git', 'push', '-q', '-u', 'origin', current_branch) if push
+  end
+end

data/spec/spec_helper.rb

@@ -28,7 +28,6 @@ require 'danger_plugin'
 # it comes with an extra function `.string` which will
 # strip all ANSI colours from the string.
 
-# rubocop:disable Lint/NestedMethodDefinition
 def testing_ui
   @output = StringIO.new
   def @output.winsize
@@ -41,7 +40,6 @@ def testing_ui
   end
   cork
 end
-# rubocop:enable Lint/NestedMethodDefinition
 
 # Example environment (ENV)
 def testing_env

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-dangermattic
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -234,6 +234,9 @@ files:
 - lib/dangermattic/plugins/pr_size_checker.rb
 - lib/dangermattic/plugins/tracks_checker.rb
 - lib/dangermattic/plugins/view_changes_checker.rb
+- rakelib/changelog_parser.rake
+- rakelib/console.rake
+- rakelib/git_helpers.rake
 - spec/android_release_checker_spec.rb
 - spec/android_strings_checker_spec.rb
 - spec/android_unit_test_checker_spec.rb