pull_request_templates 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0cf51f3a6b4c2d45d07e740fb3e2bcac4f3b1f88fd4307adbb06ab0b53a941
-  data.tar.gz: 2c67e9cce44dccdd94a59f8483fa87165a407bd9f6c378ca26866573c240657a
+  metadata.gz: e611a2cbdb56bda1b85bc97bcd1e9ba850944a956aca3772e2479e2080780ed0
+  data.tar.gz: f22afc24c2cab63778da2174ffdbde15a375a0f6d96b8643ffe7e5ec9a10dfd5
 SHA512:
-  metadata.gz: 1fa8d5796afaeb1a187cba4025f11edbaacdfdd685636717aa243acb86f7e5d9fc6b74eb810f91384c2e54ff4a9536eaa7ce0407ac9a26fe28f77609df024359
-  data.tar.gz: 6ae32df0357873efb44def8080b7478bee857e6f24f7485a9e915260b401053c06cbf61a3f03cd33271ff4523d0066de7a7b29608bfeb69aabd98f912666840b
+  metadata.gz: e285e78b50d6a53f31a3bf8c1c8162816e6310175a1ddda470d01490e82ff1744d6663a392870992adead8bd2856a609024e62e93218629aa3b2bfe925a9beee
+  data.tar.gz: a0c10b8ee580963bd2a109f4d262a311681d76558e486ae0ecfa2f08c007134a6ef99b9762deff4ab0fb3edb7398843e7e0a3f2c98b6dc88d60e18a57db593b8

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-06-11
+
+- Added support for multiple templates via `.mapping.yml` configuration
+- Implemented MECE template selection based on changed files
+- Improved error handling for ambiguous template selection
+- Clarified YAML parsing issues with examples in tests and README
+
 ## [0.1.0] - 2025-04-11
 
 - Initial release

data/README.md

@@ -12,6 +12,80 @@ PullRequestTemplates helps teams by:
 
 Works seamlessly both in local development and GitHub Actions workflows.
 
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add pull_request_templates
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install pull_request_templates
+```
+
+## Configuration
+
+To support multiple templates and automatically select the right one based on changed files, add a `.mapping.yml` file to your template directory:
+
+```yaml
+# .github/PULL_REQUEST_TEMPLATE/.mapping.yml
+feature.md:
+  - "**/feature*.txt"
+bug_fix.md:
+  - "**/fix*.txt"
+```
+
+- Each key is a template filename.
+- Each value is a list of glob patterns (quoted for YAML compatibility).
+- The tool will select the template whose patterns match all changed files (MECE logic).
+- If more than one template matches, you'll get an error listing the ambiguous templates and files.
+
+## Usage
+
+> **Note:** This is pre-release software. Currently, it only works with a single template in the pull request template directory.
+
+### Setting Up Templates
+
+Place your PR templates in the `.github/PULL_REQUEST_TEMPLATE/` directory. For example:
+
+```
+.github/
+└── PULL_REQUEST_TEMPLATE/
+    ├── feature.md
+    ├── bug_fix.md
+    └── .mapping.yml
+```
+
+The `.mapping.yml` file should define which templates apply to which files:
+
+```yaml
+# .github/PULL_REQUEST_TEMPLATE/.mapping.yml
+feature.md:
+  - "**/feature*.txt"
+bug_fix.md:
+  - "**/fix*.txt"
+```
+
+This setup allows the tool to automatically select the appropriate template based on your changes.
+
+### Creating a Pull Request
+
+When you're ready to create a pull request:
+
+```bash
+pull_request_templates pr-url
+```
+
+This command:
+- Selects an appropriate template based on your changes
+- Generates a GitHub PR URL with the template parameter
+- Outputs the URL to your terminal
+
+Open the URL in your browser to create a pull request with the template pre-applied.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/pull_request_templates

@@ -1,3 +1,6 @@
 #!/usr/bin/env ruby
 
+require "bundler/setup"
 require "pull_request_templates"
+
+PullRequestTemplates::Cli.start(ARGV)

data/lefthook.yml

@@ -0,0 +1,7 @@
+pre-commit:
+  parallel: true
+  commands:
+    standardrb:
+      glob: "*.{rb,rake,gemspec}"
+      run: bundle exec standardrb --fix {staged_files}
+      stage_fixed: true

data/lib/pull_request_templates/cli.rb

@@ -0,0 +1,92 @@
+require "thor"
+require "yaml"
+require "pathname"
+
+module PullRequestTemplates
+  class Cli < Thor
+    # Set exit_on_failure to ensure Thor exits with non-zero status on errors
+    def self.exit_on_failure? = true
+
+    desc "pr-url", "Generate a pull request URL based on changes"
+    def pr_url
+      # Find all available templates
+      templates = get_available_templates
+
+      if templates.empty?
+        raise Thor::Error, "No templates found"
+      end
+
+      # Check if we're on the default branch
+      current_branch = `git rev-parse --abbrev-ref HEAD`.strip
+
+      if current_branch == "main"
+        raise Thor::Error, "Cannot generate PR URL while on default branch"
+      end
+
+      # Check if there are any changes to detect
+      changes = get_changes
+
+      if changes.empty?
+        raise Thor::Error, "No changes detected"
+      end
+
+      # Select appropriate template
+      template = select_template(templates, changes)
+
+      # Generate the pull request URL
+      url = generate_pr_url(current_branch, template)
+      say url
+    end
+
+    private
+
+    def get_available_templates
+      template_dir = ".github/PULL_REQUEST_TEMPLATE"
+      Dir.glob("#{template_dir}/*.md").map { |path| File.basename(path) }
+    end
+
+    def get_changes
+      # Get changes between current branch and main branch
+      # Returns an array of changed file paths or an empty array if no changes
+      changes = `git diff --name-only main...HEAD`.strip
+      changes.split("\n").reject(&:empty?)
+    end
+
+    def select_template(templates, changes)
+      mapping_file = ".github/PULL_REQUEST_TEMPLATE/.mapping.yml"
+      candidates = []
+      if File.exist?(mapping_file)
+        mapping = YAML.load_file(mapping_file)
+        matches = Hash.new { |h, k| h[k] = [] }
+        changes.each do |file|
+          mapping.each do |template, patterns|
+            Array(patterns).each do |pattern|
+              matches[template] << file if File.fnmatch(pattern, file, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+            end
+          end
+        end
+        selected = matches.select { |_, files| files.sort == changes.sort }
+        candidates = selected.keys if selected.any?
+      end
+      candidates = templates if candidates.empty?
+      if candidates.length == 1
+        return candidates.first
+      end
+      raise AmbiguousTemplateSelection, <<~MESSAGE
+        Unable to pick one template from #{candidates} for the changes to #{changes.count} files:
+        * #{changes.join("\n* ")}
+      MESSAGE
+    end
+
+    def generate_pr_url(branch, template)
+      # Get the repository URL from git config
+      remote_url = `git config --get remote.origin.url`.strip
+
+      # Extract repository path from SSH URL format (git@github.com:user/repo.git)
+      repo_path = remote_url.sub(/^git@github\.com:/, "").sub(/\.git$/, "")
+
+      # Generate GitHub pull request URL with template parameter
+      "https://github.com/#{repo_path}/compare/#{branch}?expand=1&quick_pull=1&template=#{template}"
+    end
+  end
+end

data/lib/pull_request_templates/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PullRequestTemplates
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pull_request_templates.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "pull_request_templates/version"
+require_relative "pull_request_templates/cli"
 
 module PullRequestTemplates
-  class Error < StandardError; end
-  # Your code goes here...
+  Error = Class.new(StandardError)
+  AmbiguousTemplateSelection = Class.new(Error)
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pull_request_templates
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Caleb Buxton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
-dependencies: []
+date: 2025-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: A tool that reduces pull request description toil and provides the right
   context for changes.
 email:
@@ -27,9 +41,10 @@ files:
 - README.md
 - Rakefile
 - exe/pull_request_templates
+- lefthook.yml
 - lib/pull_request_templates.rb
+- lib/pull_request_templates/cli.rb
 - lib/pull_request_templates/version.rb
-- sig/pull_request_templates.rbs
 homepage: https://github.com/cpb/pull_request_templates
 licenses:
 - MIT
@@ -52,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Match pull request templates to your changes.

data/sig/pull_request_templates.rbs

@@ -1,4 +0,0 @@
-module PullRequestTemplates
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end