pr-with-params 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73e0d7cdcfe3e16d632105a2a54564b94e04b0fe523a7faa3449e11e6ad7edb
-  data.tar.gz: 3260ff8eec71435baf10bbce8ba8633b37077e8d8e26dad28c6ee729a23e6783
+  metadata.gz: fb5d7b7436528a5a08568892974cc238bd5ffc1dd6fb40e2157be5600b72dd04
+  data.tar.gz: 8904c400e3fc49e1ac68f1434279af3d2b2a92f8c39fddc0b0b4b35c825d3b5f
 SHA512:
-  metadata.gz: 4039bc9e0d935d8355899f6b71c34b958d7900c447e710c6fccfe12dea0e4172279207cd8bd559226da2e4e33c1cd90961f9d1221d21ddc2349a6748aae457e5
-  data.tar.gz: 0ead5bf501b295bf8892600773872c9132a8857de609d78146636de50d4447cdf37e0ad746b0f81d765b4c2b5e859ece057d74d310defb3859decd6c85a2c3ed
+  metadata.gz: 00473d4b542df9d312c51f8e6801b2050109108780f914fe49cd5f5048493792d002ab3bfb5b992461644352612e9cfc2c70ff80d010fcfc32d71596d14f7379
+  data.tar.gz: 4b86fc3db6832b59830123dce6a2b1077b90fc312d28cd360bcc648a931692680c03059c218e7acd2d8da3ccdbc3886541dd98ee677ed699347d3a5d1d523fbe

data/.rubocop.yml

@@ -1,3 +1,6 @@
+# All Cops
+AllCops:
+  TargetRubyVersion: 3.1.2
 # Style
 Style/StringLiterals:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [2.0.0] - 2023-06-05
+  
+To migrate to this version, simply run `gem update pr-with-params`
+ 
+### Added
+- Ability to specify a list of validators to run as an option
+- Ability to set `ignore_conventional_commits` in config file
+- Default path for config file at `~/.pwp/config.yml`
+
+### Changed
+- `--conf` is now `--config_path` or `-path` or `-p`
+- Make specifying config path optional - was previously a required
+- CLI name is now `pr-wip` - was previously `pr-with-params`
+- `--validate-conventional-commits` is now `--ignore-conventional-commits` - optionally turn off versus optionally turn on
+ 
+### Fixed
+- Occasional failures related to `launchy` not being loaded properly

data/Gemfile

@@ -4,8 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in pr-with-params.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
-gem "rubocop", "~> 0.80"
-gem "launchy"

data/Gemfile.lock

@@ -1,21 +1,33 @@
 PATH
   remote: .
   specs:
-    pr-with-params (1.3.0)
+    pr-with-params (2.0.0)
+      activesupport
+      launchy (~> 2.5)
+      rake (~> 13.0)
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    launchy (2.5.0)
-      addressable (~> 2.7)
-    minitest (5.16.2)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    launchy (2.5.2)
+      addressable (~> 2.8)
+    minitest (5.18.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -32,16 +44,18 @@ GEM
     rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
-  launchy
-  minitest (~> 5.0)
+  minitest (~> 5.18.0)
   pr-with-params!
-  rake (~> 13.0)
   rubocop (~> 0.80)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,5 @@
-# PR::With::Params [![Gem Version](https://badge.fury.io/rb/pr-with-params.svg)](https://badge.fury.io/rb/pr-with-params)
-A lightweight gem that pushes current local branch to remote with upstream at origin/[local-branch-name]. It also opens a new pull request browser window at a URL with customized query params, based on specified options, which pre-populates certain fields in the pull request. This is especially useful when supporting multiple PR templates within a code base.
+# PRWithParams [![Gem Version](https://badge.fury.io/rb/pr-with-params.svg)](https://badge.fury.io/rb/pr-with-params)
+A lightweight ruby gem that pushes current local branch to remote with upstream at origin/[local-branch-name]. It also opens a new pull request browser window at a URL with customized query params, based on specified options, which pre-populates certain fields in the pull request. This is especially useful when supporting multiple PR templates within a code base.
 
 Inspired by GitHub's documentation on [using query params to create pull requets](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)
 
@@ -21,13 +21,15 @@ Or install it yourself as:
 
 ## Usage
 
+NOTE: CLI name has changed as of v2.0.0 from `pr-with-params` to `pr-wip` along with some other breaking changes. See changelog for more details
+
 Assuming you've committed your changes and your local branch is ready to be pushed, run:
 
 ```
-$ pr-with-params -t new_feature_template.md -l 'work in progress'
+$ pr-wip -t new_feature_template.md -l 'work in progress'
 ```
 
-For a full list of options, run `$ pr-with-params -h`
+For a full list of options, run `$ pr-wip -h`
 
 #### Using Config File
 
@@ -46,8 +48,8 @@ bug_fix:
   labels: bug,urgent
 ```
 
-* To run with config file, use `$ pr-with-params --conf='path/to/file.yml' --scope=bug_fix`. If `--scope` option is not specified, only `:default` scope will apply.
-* If you specify a config file (`--conf`) and also pass options by flag (e.g `--base-branch=develop`), the flag value will override the config value.
+* To run with config file, use `$ pr-wip --config_path='path/to/file.yml' --scope=bug_fix`. If `--scope` option is not specified, only `:default` scope will apply.
+* If you specify a config file (`--config_path`) and also pass options by flag (e.g `--base-branch=develop`), the flag value will override the config value.
 * All your defaults go in the `:default` scope.
 * Only fields defined in another scope will override the defaults. In the example above, the final list of configs will be:
 
@@ -59,6 +61,7 @@ bug_fix:
 | Config | Type | Example |
 | :--- | :---: | :--- |
 | validators | `Array` | \`[conventional_commits]\` |
+| ignore_conventional_commits | `Boolean` | true |
 | base_branch | `String` | develop |
 | template | `String` | new_feature_template.md |
 | title | `String` | 'Update login screen' |
@@ -66,7 +69,7 @@ bug_fix:
 | assignees | `String` | 2k-joker |
 
 #### Validators
-* **Conventional Commits**: Gem supports validation of conventional commits for PR `:title`. If you want to follow [conventional commit specs](https://www.conventionalcommits.org/en/v1.0.0/#specification) in your codebase, you may want to use this validation. To turn it on, set the `--validate-conventional-commits` flag or add `conventional_commits` to the list of validators in your config file.
+* **Conventional Commits**: Gem supports validation of conventional commits for PR `:title` by default. This is to encourage users to follow [conventional commit specs](https://www.conventionalcommits.org/en/v1.0.0/#specification). To turn it off, pass the `--ignore-conventional-commits` flag or add `conventional_commits` to the list of validators in your config file or set `ignore_conventional_commits: true` in your config file.
 
 ## Development
 

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "pr/with/params"
+require "pr_with_params"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/bin/setup

@@ -4,5 +4,5 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
+Bundler.require(:default, :development)
 # Do any other automated setup that you need to do here

data/exe/pr-wip

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup' # support local testing/development
+require_relative '../lib/pr_with_params'
+
+PRWithParams::CLI.start

data/lib/pr_with_params/cli.rb

@@ -0,0 +1,77 @@
+require 'active_support/core_ext/hash'
+require 'thor'
+require 'launchy'
+require 'uri'
+
+module PRWithParams
+  class CLI < Thor
+    desc "open", "Open a new pull request for local branch"
+    long_desc <<-LONGDESC
+      `pr-wip open [options]` will open a new browser window with a pull request at a URL with customized query params from <options>.
+      
+      The pull request will be pre-populated with certain fields based on custom query params
+    LONGDESC
+    option :template, type: :string, aliases: ['-t'], desc: 'Specify the filename of the target custom PR template (e.g: bug_squash_template.md). Will use default template otherwise.'
+    option :config_path, type: :string, aliases: ['-path', '-p'], default: '/.pwp/config.yml', desc: 'Path to yaml file where configs are defined. Defaults to: ~/.pwp/config.yml'
+    option :scope, type: :string, aliases: ['-s'], default: 'default', desc: 'Specify the scope name under which options are defined.'
+    option :base_branch, type: :string, aliases: ['-b'], desc: 'Specify the base branch for your PR (e.g: develop). Will use default branch otherwise.'
+    option :title, type: :string, aliases: ['-d', '-desc', '--description'], desc: 'Specify a custom PR title. Will use the first branch commit message otherwise.'
+    option :labels, type: :string, aliases: ['-l'], desc: "Specify a list of labels (e.g: 'help+wanted,bug,urgent,work+in+progress')."
+    option :assignees, type: :string, aliases: ['-a'], desc: "Specify a list of assignees (e.g: 'octocat,codedog')."
+    option :validators, type: :array, default: [:conventional_commits], desc: 'Specify a list of validations to run against local branch before opening pull request'
+    option :ignore_conventional_commits, type: :boolean, desc: 'Allow PR titles that do not conform to conventional commits spec.'
+    def open
+      home_dir_path = `echo $HOME`.chomp
+      config_file_path = "#{home_dir_path}/#{options[:config_path].delete_prefix('/')}"
+      config_options = (options[:config_path].empty? ? {} : PRWithParams::ConfigParser.new(config_file_path: config_file_path, scope: options[:scope]).parse!).with_indifferent_access
+      options[:validators].delete(:conventional_commits) if options[:ignore_conventional_commits]
+      all_options = config_options.merge(options)
+
+      branch_name = `git rev-parse --abbrev-ref HEAD`.chomp
+      base_branch = all_options.delete(:base_branch) || `git remote show origin | grep "HEAD branch" | sed 's/.*: //'`.chomp
+
+      default_title = `git show-branch --no-name $(git log #{base_branch}..#{branch_name} --pretty=format:"%h" | tail -1)`.chomp
+      all_options[:title] ||= default_title
+
+      puts all_options
+      puts options
+      PRWithParams::OptionsValidator.validate!(all_options.except(:validators), validators: all_options[:validators])
+
+      remote_git_uri = `git config --get remote.origin.url`.sub('git@github.com:', '').sub('.git', '').chomp
+      uri_path = "/#{remote_git_uri}/compare/#{base_branch}...#{branch_name}"
+
+      push_local_to_remote(branch_name, base_branch, remote_git_uri)
+      open_pr_in_browser(uri_path, all_options)
+    rescue StandardError => e
+      message = "\e[31mERROR\e[0m: An error occurred while building or opening your custom pull request URL"
+      reason = "reason: #{e.message}"
+      backtrace = "backtrace: #{e.backtrace&.last(10)&.join("\n")}"
+      error_message = [message, reason, backtrace, "\n\n"].join("\n")
+    
+      warn error_message
+      exit 1
+    end
+
+    private
+
+    def push_local_to_remote(branch_name, base_branch, remote_git_uri)
+      puts "current branch: \e[36m#{branch_name}\e[0m"
+      puts "base branch: \e[36m#{base_branch}\e[0m"
+      puts "repo path: \e[36m#{remote_git_uri}\e[0m"
+    
+      push_message = "\nPushing your local branch to origin/#{branch_name}..."
+      puts "\e[32m#{push_message}\e[0m"
+      `sleep 1`
+
+      system("git push -u origin #{branch_name}", exception: true)
+    end
+
+    def open_pr_in_browser(uri_path, options)
+      uri_host = 'www.github.com'
+      uri_query = URI.encode_www_form(options)
+      url_string = URI::HTTPS.build(host: uri_host, path: uri_path, query: uri_query).to_s
+
+      Launchy.open(url_string)
+    end
+  end
+end

data/lib/pr_with_params/config_parser.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+
+module PRWithParams
+  class ConfigParser
+    class ParserError < StandardError; end
+
+    # Attributes
+    attr_reader :config_file_path, :scope, :parsed_config, :filtered_config
+
+    # Constants
+    VALID_CONFIG_KEYS = %i[validators base_branch template title labels assignees].freeze
+
+    def initialize(config_file_path:, scope: nil)
+      @config_file_path = config_file_path
+      @scope = scope&.to_sym || :default
+    end
+
+    def parse!
+      validate_file_type!
+      parse_yaml_config
+    end
+
+    private
+
+    def parse_yaml_config
+      @parsed_config = YAML.safe_load(IO.read(config_file_path)).to_h.transform_keys(&:to_sym)
+      @filtered_config = scoped_config.transform_keys(&:to_sym).slice(*VALID_CONFIG_KEYS)
+    end
+
+    def scoped_config
+      if scope == :default || parsed_config.fetch(scope, {}).empty?
+        parsed_config.fetch(:default, {})
+      else
+        parsed_config.fetch(:default, {}).merge(parsed_config[scope])
+      end
+    end
+
+    def validate_file_type!
+      raise ParserError, 'Config file type must be YAML (.yaml or .yml)' unless yaml_file?
+      raise ParserError, "Config file path is invalid or file does not exist: #{config_file_path}" unless file_exists?
+    end
+
+    def yaml_file?
+      config_file_path.end_with?('.yaml') || config_file_path.end_with?('yml')
+    end
+
+    def file_exists?
+      File.file?(config_file_path)
+    end
+  end
+end

data/lib/pr_with_params/options_validator.rb

@@ -0,0 +1,44 @@
+module PRWithParams
+  class OptionsValidator
+    class ValidatorError < StandardError; end
+
+    VALIDATOR_CLASS_MAP = {
+      conventional_commits: 'PRWithParams::ConventionalCommitValidator'
+    }.freeze
+
+    class << self
+      def validate!(options, validators: [])
+        validators.each do |validator|
+          validate_options(validator, options)
+        end
+      end
+
+      private
+
+      def validate_options(validator, options)
+        class_name = VALIDATOR_CLASS_MAP[validator.to_sym]
+        raise(ValidatorError, "Invalid or undefined validator: #{validator}") if class_name.nil?
+
+        Object.const_get(class_name).new(options).validate!
+      end
+    end
+  end
+
+  class ConventionalCommitValidator
+    CONVENTIONAL_COMMIT_REGEX = /^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(.*\))?(!)?(: (.*\s*)*))|(^Merge (.*\s*)*)|(^Initial commit$)/.freeze
+
+    def initialize(options)
+      @commit_message = options[:title]
+    end
+
+    def validate!
+      raise OptionsValidator::ValidatorError, "Conventional commit specifications not met for commit message: '#{@commit_message}'" unless valid_commit?
+    end
+
+    private
+
+    def valid_commit?
+      CONVENTIONAL_COMMIT_REGEX.match?(@commit_message)
+    end
+  end
+end

data/lib/pr_with_params/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PRWithParams
+  VERSION = "2.0.0"
+end

data/lib/pr_with_params.rb

@@ -0,0 +1,4 @@
+require_relative 'pr_with_params/config_parser'
+require_relative 'pr_with_params/options_validator'
+require_relative 'pr_with_params/version'
+require_relative 'pr_with_params/cli'

data/pr-with-params.gemspec

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "lib/pr/with/params/version"
+require_relative "lib/pr_with_params/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "pr-with-params"
-  spec.version       = PR::With::Params::VERSION
+  spec.version       = PRWithParams::VERSION
   spec.authors       = ["2k-joker"]
   spec.email         = ["kum.vanjunior@gmail.com"]
 
   spec.summary       = "Pushes current local branch to remote with upstream at origin/[local-branch-name]. It also opens a new pull request browser window at a URL with customized query params, based on specified options, which pre-populates certain fields in the pull request. This is especially useful when supporting multiple PR templates within a code base."
   spec.homepage      = "https://github.com/2k-joker/pr-with-params"
   spec.licenses      = ["MIT"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new("~> 3.1.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
 
@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "launchy", "~> 2.5"
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "minitest", "~> 5.18.0"
+  spec.add_development_dependency "rubocop", "~> 0.80"
 end

metadata

@@ -1,20 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
-dependencies: []
+date: 2023-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
 description:
 email:
 - kum.vanjunior@gmail.com
 executables:
-- pr-with-params
+- pr-wip
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,6 +106,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE/new_feature_template.md"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -29,11 +114,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/pr-with-params
-- lib/pr/with/params.rb
-- lib/pr/with/params/config_parser.rb
-- lib/pr/with/params/options_validator.rb
-- lib/pr/with/params/version.rb
+- exe/pr-wip
+- lib/pr_with_params.rb
+- lib/pr_with_params/cli.rb
+- lib/pr_with_params/config_parser.rb
+- lib/pr_with_params/options_validator.rb
+- lib/pr_with_params/version.rb
 - pr-with-params.gemspec
 homepage: https://github.com/2k-joker/pr-with-params
 licenses:
@@ -46,16 +132,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Pushes current local branch to remote with upstream at origin/[local-branch-name].

data/exe/pr-with-params

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup' # support local testing/development
-require_relative '../lib/pr/with/params'
-require 'json'
-require 'optparse'
-require 'open3'
-
-options = { expand: 1, validators: [] }
-config_file_path = ''
-config_scope = nil
-
-# rubocop:disable Metrics/BlockLength
-parser = OptionParser.new do |opt|
-  opt.banner = "Usage pr-with-params [options]"
-
-  opt.separator ''
-
-  opt.on('-h', '--help', 'Show this usage help menu') do |_h|
-    puts opt
-    exit
-  end
-
-  opt.separator ''
-
-  opt.on('--conf FILE_PATH', 'Path to yaml file where options are defined. NOTE that relative paths are not supported.') do |conf_file|
-    stdout, _stderr, _status = Open3.capture3("echo #{conf_file}")
-    config_file_path = stdout.chomp
-  end
-
-  opt.on('--scope CONFIG_SCOPE', 'Specify the scope name under which options are defined.') do |scope|
-    config_scope = scope
-  end
-
-  opt.on('--base-branch BRANCH', "Specify the base branch for your PR (e.g: 'develop'). Will use default branch otherwise.") do |pr_base_branch|
-    options[:base_branch] = pr_base_branch
-  end
-
-  opt.on('-t', '--template TEMPLATE', "Specify the filename of the target custom PR template (e.g: 'bug_squash_template.md'). Will use default template otherwise.") do |pr_template|
-    options[:template] = pr_template
-  end
-
-  opt.on('-d', '--description DESC', 'Specify a custom PR title. Will use the first branch commit message otherwise.') do |pr_description|
-    options[:title] = pr_description
-  end
-
-  opt.on('-l', '--labels LABELS', "Specify a list of labels (e.g: 'help+wanted,bug,urgent,work+in+progress').") do |pr_labels|
-    options[:labels] = pr_labels
-  end
-
-  opt.on('-a', '--assignees ASSIGNEES', "Specify a list of assignees (e.g: 'octocat,codedog').") do |pr_assignees|
-    options[:assignees] = pr_assignees
-  end
-
-  opt.on('--validate-conventional-commits', 'Validates that your PR title conforms to conventional commits specs.') do |_|
-    options[:validators] = options[:validators].to_a << :conventional_commits
-  end
-end
-# rubocop:enable Metrics/BlockLength
-
-begin
-  parser.parse!
-
-  config_options = PR::With::Params.parse_config(config_file_path, config_scope)
-  options = config_options.merge(options)
-
-  branch_name = `git rev-parse --abbrev-ref HEAD`.chomp
-  base_branch = options.delete(:base_branch) || `git remote show origin | grep "HEAD branch" | sed 's/.*: //'`.chomp
-
-  default_title = `git show-branch --no-name $(git log #{base_branch}..#{branch_name} --pretty=format:"%h" | tail -1)`.chomp
-  options[:title] ||= default_title
-
-  PR::With::Params.validate_options(options)
-
-  remote_git_uri = `git config --get remote.origin.url`.sub('git@github.com:', '').sub('.git', '').chomp
-  uri_host = 'www.github.com'
-  uri_path = "/#{remote_git_uri}/compare/#{base_branch}...#{branch_name}"
-
-  puts "current branch: \e[36m#{branch_name}\e[0m"
-  puts "base branch: \e[36m#{base_branch}\e[0m"
-  puts "repo path: \e[36m#{remote_git_uri}\e[0m"
-
-  push_message = "\nPushing your local branch to origin/#{branch_name}..."
-  puts "\e[32m#{push_message}\e[0m"
-  `sleep 1`
-  system("git push -u origin #{branch_name}", exception: true)
-
-  open_url_message = "\nOpening pull request browser window..."
-  puts "\e[32m#{open_url_message}\e[0m"
-  `sleep 1`
-  PR::With::Params.open(host: uri_host, path: uri_path, query: options)
-rescue StandardError => e
-  message = "\e[31mERROR\e[0m: An error occurred while building or opening your custom pull request URL"
-  reason = "reason: #{e.message}"
-  backtrace = "backtrace: #{e.backtrace&.last(10)&.join("\n")}"
-  error_message = [message, reason, backtrace, "\n\n"].join("\n")
-
-  warn error_message
-  exit 1
-end

data/lib/pr/with/params/config_parser.rb

@@ -1,53 +0,0 @@
-require 'yaml'
-
-module PR
-  module With
-    module Params
-      class ConfigParser
-        # Attributes
-        attr_reader :config_file_path, :scope, :parsed_config, :filtered_config
-
-        # Constants
-        VALID_CONFIG_KEYS = %i[validators base_branch template title labels assignees].freeze
-
-        def initialize(config_file_path:, scope: nil)
-          @config_file_path = config_file_path
-          @scope = scope&.to_sym || :default
-        end
-
-        def parse!
-          validate_file_type!
-          parse_yaml_config
-        end
-
-        private
-
-        def parse_yaml_config
-          @parsed_config = YAML.safe_load(IO.read(config_file_path)).transform_keys(&:to_sym)
-          @filtered_config = scoped_config.transform_keys(&:to_sym).slice(*VALID_CONFIG_KEYS)
-        end
-
-        def scoped_config
-          if scope == :default || parsed_config.fetch(scope, {}).empty?
-            parsed_config.fetch(:default, {})
-          else
-            parsed_config.fetch(:default, {}).merge(parsed_config[scope])
-          end
-        end
-
-        def validate_file_type!
-          raise(TypeError, 'Config file type must be YAML (.yaml or .yml)') unless yaml_file?
-          raise(ArgumentError, "Config file path is invalid or file does not exist: #{config_file_path}") unless file_exists?
-        end
-
-        def yaml_file?
-          config_file_path.end_with?('.yaml') || config_file_path.end_with?('yml')
-        end
-
-        def file_exists?
-          File.file?(config_file_path)
-        end
-      end
-    end
-  end
-end

data/lib/pr/with/params/options_validator.rb

@@ -1,46 +0,0 @@
-module PR
-  module With
-    module Params
-      class OptionsValidator
-        VALIDATOR_CLASS_MAP = {
-          conventional_commits: 'PR::With::Params::ConventionalCommitValidator'
-        }.freeze
-
-        class << self
-          def validate!(options, validators: [])
-            validators.each do |validator|
-              validate_options(validator, options)
-            end
-          end
-
-          private
-
-          def validate_options(validator, options)
-            class_name = VALIDATOR_CLASS_MAP[validator.to_sym]
-            raise(ArgumentError, "Invalid or undefined validator: #{validator}") if class_name.nil?
-
-            Object.const_get(class_name).new(options).validate!
-          end
-        end
-      end
-
-      class ConventionalCommitValidator
-        CONVENTIONAL_COMMIT_REGEX = /^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(.*\))?(!)?(: (.*\s*)*))|(^Merge (.*\s*)*)|(^Initial commit$)/.freeze
-
-        def initialize(options)
-          @commit_message = options[:title]
-        end
-
-        def validate!
-          raise("Conventional commit specifications not met for commit message: '#{@commit_message}'") unless valid_commit?
-        end
-
-        private
-
-        def valid_commit?
-          CONVENTIONAL_COMMIT_REGEX.match?(@commit_message)
-        end
-      end
-    end
-  end
-end

data/lib/pr/with/params/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module PR
-  module With
-    module Params
-      VERSION = "1.3.0"
-    end
-  end
-end

data/lib/pr/with/params.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'params/version'
-require_relative 'params/config_parser'
-require_relative 'params/options_validator'
-require 'uri'
-require 'json'
-require 'launchy'
-
-module PR
-  module With
-    module Params
-      class Error < StandardError; end
-
-      extend self
-
-      def open(host:, path:, query:)
-        uri_query = URI.encode_www_form(query)
-        url_string = URI::HTTPS.build(host: host, path: path, query: uri_query).to_s
-        Launchy.open(url_string)
-      end
-
-      def parse_config(file_path, scope)
-        ConfigParser.new(config_file_path: file_path, scope: scope).parse!
-
-        file_path.empty? ? {} : ConfigParser.new(config_file_path: file_path, scope: scope).parse!
-      rescue StandardError => e
-        message = "\e[35mWARNING\e[0m: Error parsing config file. Using defaults"
-        reason = "reason: #{e.message}"
-        backtrace = "backtrace: #{e.backtrace&.last(10)&.join("\n")}"
-        error_message = [message, reason, backtrace, "\n\n"].join("\n")
-
-        warn error_message
-
-        {}
-      end
-
-      def validate_options(options)
-        validators = options.delete(:validators)
-        OptionsValidator.validate!(options, validators: validators)
-      end
-    end
-  end
-end