pr-with-params 0.2.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eba5280a74bea8222e60654a6798ac5cdf60b659a9e085903e0a74a374a900a8
-  data.tar.gz: 78acb1fcda0cd7043fd25e51169365ed66c3ce36616209c8856a569bdf6e76cd
+  metadata.gz: 445be6f9d1bb4ce51a180ab2461e571f9493fe99a0449513368ebec0af97a452
+  data.tar.gz: f1f45b9f921973258461cdb61b61f058bf9ad7e60e3fe79043bff02804189e60
 SHA512:
-  metadata.gz: efd0f0b2bc418846d6eb9ca8e37b8c15c03feb77be602e65e811432592108eb22841e8509506050f82f8a1deba547c89eae86ca58d375f38ad0b588d894a621d
-  data.tar.gz: bc35fade6fcf7ddda8ffd4e6ccdaf12e2075060806d326c770b300ccf86a179055a8fe262ad529fc094ae4873156fd72ad7a412877417ded357fa6d7e520d118
+  metadata.gz: d2b60aa172d6def35082fee5ac9826a6e155eaae786b1a2aa8a2eacde81448417a42883672f08b5defaaac41be40c725fba0d0084860b8b96df6d1b703a403d0
+  data.tar.gz: 4d651b5b57042e4d25daadabeb4088863cabf38d3106b0d12b10226973bfc0eb736b52223744fe8218cecb37963631ca6bf1d71bd5d5e06073fe27d39a67733c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pr-with-params (0.2.0)
+    pr-with-params (1.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
-# PR::With::Params
-A lightweight gem that pushes current local branch to remote with upstream to origin/[local-branch-name]. It also opens a new browser window at a URL with customized params, based on specified options, which allows to open pull request with pre-populated fields.
+# 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.
+
+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)
 
 ## Installation
 
@@ -43,7 +45,8 @@ bug_fix:
 ```
 
 * 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.
-* All your defaults go in the `:default` scope
+* 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.
+* 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:
 
 ```ruby

data/exe/pr-with-params

@@ -56,7 +56,7 @@ begin
   parser.parse!
 
   config_options = PR::With::Params.parse_config(config_file_path, config_scope)
-  options.merge!(config_options)
+  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
@@ -72,7 +72,7 @@ begin
   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}")
+  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"
@@ -85,6 +85,6 @@ rescue StandardError => e
     backtrace: e.backtrace&.last(10)
   }.to_json
 
-  STDERR.puts "\e[31mERROR\e[0m: " + error_message + "\n"
+  STDERR.puts "\n" + "\e[31mERROR:\e[0m " + error_message + "\n"
   exit 1
 end

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

@@ -36,8 +36,8 @@ module PR
         end
 
         def validate_file_type!
-          raise ArgumentError.new('Config file path is invalid or file does not exist.') unless file_exists?
           raise TypeError.new('Config file type must be YAML (.yaml or .yml)') unless yaml_file?
+          raise ArgumentError.new("Config file path is invalid or file does not exist: #{config_file_path}") unless file_exists?
         end
 
         def yaml_file?

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

@@ -3,7 +3,7 @@
 module PR
   module With
     module Params
-      VERSION = "0.2.0"
+      VERSION = "1.0.3"
     end
   end
 end

data/lib/pr/with/params.rb

@@ -20,7 +20,9 @@ module PR
       end
 
       def parse_config(file_path, scope)
-        config_options = ConfigParser.new(config_file_path: file_path, scope: scope).parse!
+        return {} if 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",

data/pr-with-params.gemspec

@@ -8,8 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["2k-joker"]
   spec.email         = ["kum.vanjunior@gmail.com"]
 
-  spec.summary       = "Pushes current local branch to remote with upstream to origin/[local-branch-name]. It also opens a new browser window at a URL with customized params, based on specified options, which allows to open pull request with pre-populated fields."
+  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.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.3
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -35,7 +35,8 @@ files:
 - lib/pr/with/params/version.rb
 - pr-with-params.gemspec
 homepage: https://github.com/2k-joker/pr-with-params
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/2k-joker/pr-with-params
 post_install_message:
@@ -56,7 +57,8 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Pushes current local branch to remote with upstream to origin/[local-branch-name].
-  It also opens a new browser window at a URL with customized params, based on specified
-  options, which allows to open pull request with pre-populated fields.
+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.
 test_files: []