pr-with-params 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c782747263091187d47cf06777699c11fea56d9fb74d1fd137c4cde86216a911
-  data.tar.gz: f8217fa6768ed3ed8f81d553a496ab84e7008e8c493f5cac3232dc8606a35fa5
+  metadata.gz: 4374906553024e9cff3a612ac9baa8aed678fe6a025f6a7ad15c060b145a11c8
+  data.tar.gz: 2f0b0cc426dbbd284a19e74ae1ee197a12941957ae1bf95cbcd13517e0578dcc
 SHA512:
-  metadata.gz: e5b569b26a32a57e47323544eaef3b56f538afce354cb3c2d33cb3d23f096b2070f0855fbc9c0111c46412627585c94493b12898569d7ca93c3c33785439d141
-  data.tar.gz: 5fbf9e79107c81f09337f11f2fa0c91423df37bfc51b5dd759e77c07815a1d99053bb5e0d6f0ae930082bea9564837a28973ffefc56115138446389f20f95d08
+  metadata.gz: 0cfa3f9578b19dfcd1ba614cfa4dfc7b8b7001f057f00e3678ba3f42e2d3345c0d7a85886adb6e5891f622c5d35de10b9ab565643df973c30d10e5e58341e9ee
+  data.tar.gz: b92649ee79ff701cd40c20a78ecdf869700a6aa13f38dbb1fadc1628be66a7dc94248a8e7fc05ff1dd27f838c237e7d935378a275f4c1112d0aafddf45441e9e

data/.rubocop.yml

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

data/Gemfile

@@ -8,4 +8,3 @@ gemspec
 gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 gem "rubocop", "~> 0.80"
-gem "launchy"

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    pr-with-params (1.2.1)
+    pr-with-params (1.3.1)
+      launchy (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     launchy (2.5.0)
       addressable (~> 2.7)
@@ -15,7 +16,7 @@ GEM
     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)
@@ -38,7 +39,6 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
-  launchy
   minitest (~> 5.0)
   pr-with-params!
   rake (~> 13.0)

data/README.md

@@ -1,8 +1,11 @@
 # 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.
+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)
 
+## Prerequisites
+This gem currently uses the [launchy gem](https://github.com/copiousfreetime/launchy) to open URLs. Ensure your code base satisfies launchy's dependencies.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/exe/pr-with-params

@@ -23,6 +23,13 @@ parser = OptionParser.new do |opt|
 
   opt.separator ''
 
+  opt.on('-v', '--version', 'Returns your current local gem version') do |_h|
+    puts 'pr-with-params ' + PR::With::Params::VERSION
+    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
@@ -32,7 +39,7 @@ parser = OptionParser.new do |opt|
     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|
+  opt.on('-b', '--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
 
@@ -70,7 +77,7 @@ begin
   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)
+  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'
@@ -90,12 +97,11 @@ begin
   `sleep 1`
   PR::With::Params.open(host: uri_host, path: uri_path, query: options)
 rescue StandardError => e
-  error_message = {
-    message: 'An error occurred while building or opening your custom pull request URL',
-    reason: e.message,
-    backtrace: e.backtrace&.last(10)
-  }.to_json
+  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 "\e[31mERROR\e[0m: " + error_message + "\n"
+  warn error_message
   exit 1
 end

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

@@ -25,7 +25,7 @@ module PR
       end
 
       class ConventionalCommitValidator
-        CONVENTIONAL_COMMIT_REGEX = /^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+\))?(!)?(: (.*\s*)*))|(^Merge (.*\s*)*)|(^Initial commit$)/.freeze
+        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]

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

@@ -3,7 +3,7 @@
 module PR
   module With
     module Params
-      VERSION = "1.2.1"
+      VERSION = "1.3.1"
     end
   end
 end

data/lib/pr/with/params.rb

@@ -23,18 +23,17 @@ module PR
       def parse_config(file_path, scope)
         file_path.empty? ? {} : ConfigParser.new(config_file_path: file_path, scope: scope).parse!
       rescue StandardError => e
-        error_message = {
-          message: "Error parsing config file. Using defaults",
-          reason: e.message,
-          backtrace: e.backtrace&.last(10)
-        }.to_json
+        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 "\e[35mWARNING\e[0m: " + error_message + "\n"
+        warn error_message
 
         {}
       end
 
-      def validate_options(options)
+      def validate_options!(options)
         validators = options.delete(:validators)
         OptionsValidator.validate!(options, validators: validators)
       end

data/pr-with-params.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   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"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
-dependencies: []
+date: 2022-12-16 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'
 description:
 email:
 - kum.vanjunior@gmail.com
@@ -48,14 +62,14 @@ 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].