pr-with-params 0.1.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab35532543684c0467e8c85b4f05d6bb34c2f37a31f09d6d19f546b8f973ca0
-  data.tar.gz: 79e8ae8b681c506ebad08b38c7cf4ce624a89715cddbe37181f9c7aaa2e3fef5
+  metadata.gz: bd62108def63836659f73059843a5260211596b80e344a2543939688b3dadaba
+  data.tar.gz: b538c821030781006c3df77169c082ada6ccf68c7a74d330f23363d93792ccaa
 SHA512:
-  metadata.gz: 29e4a1bb172ff62a1ae49ce0fbb4c92ee3860c183c1db8b56614fe535e19e3b08a16cfff76b178d5fd2240b772c901f0c1affbcbb0b23cefddadb26838cff675
-  data.tar.gz: 4c15b85e016f2cff82f0f2b8e7cde845063b25074f3ae331bfcc3a9d7250f058a635006fc7d6bdaf26f1ef9592f76faecdf84dd2f5294a71f5428423818d1a6d
+  metadata.gz: e7d30fbe9b54a10925d688bd9ece749c034ada2b300e0f4bbb3022a0ae0380f335257506aa7b41c8bf7593ceab8639cefc55a84fad88585d288ccf365b33587d
+  data.tar.gz: 3fe80d1fdbae5795051485882a56d5ff5ac26e1bdabf01b62121655fe52a34d7f95d0fa3a302b0d064ca64ca6b5a52d6969f6dd541bab0e60ff6526297f11a25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pr-with-params (0.1.3)
+    pr-with-params (1.0.2)
 
 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
 
@@ -27,6 +29,37 @@ $ pr-with-params -t new_feature_template.md -l 'work in progress'
 
 For a full list of options, run `$ pr-with-params -h`
 
+#### Using Config File
+
+Gem supports defining options in a yaml file (`.yaml`, `.yml`) like so:
+```yaml
+default:
+  base_branch: main
+  template: new_feature_template.md
+  assignees: 2k-joker
+  labels: enhancement
+
+bug_fix:
+  template: bug_fix_template.md
+  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.
+* 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
+{ base_branch: 'main', template: 'bug_fix_template.md', assignees: '2k-joker', labels: 'bug,urgent' }
+```
+
+**Supported configs**
+* base_branch
+* template
+* title
+* labels
+* assignees
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/pr-with-params

@@ -4,8 +4,11 @@ require 'bundler/setup' # support local testing/development
 require_relative '../lib/pr/with/params'
 require 'json'
 require 'optparse'
+require 'open3'
 
 options = { expand: 1 }
+config_file_path = ''
+config_scope = nil
 
 parser = OptionParser.new do |opt|
   opt.banner = "Usage pr-with-params [options]"
@@ -19,6 +22,15 @@ parser = OptionParser.new do |opt|
 
   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
@@ -43,21 +55,24 @@ end
 begin
   parser.parse!
 
-  branch_name = `git rev-parse --abbrev-ref HEAD`
-  base_branch = options.delete(:base_branch) || `git remote show origin | grep "HEAD branch" | sed 's/.*: //'`
+  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
   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.chomp}...#{branch_name.chomp}"
+  uri_path = "/#{remote_git_uri}/compare/#{base_branch}...#{branch_name}"
 
-  puts "current branch: \e[36m#{branch_name.chomp}\e[0m"
-  puts "base branch: \e[36m#{base_branch.chomp}\e[0m"
+  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.chomp}..."
+  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"
@@ -67,9 +82,9 @@ 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)
+    backtrace: e.backtrace&.last(10)
   }.to_json
 
-  STDERR.puts error_message
+  STDERR.puts "\n" + "\e[31mERROR:\e[0m " + error_message + "\n"
   exit 1
 end

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

@@ -0,0 +1,53 @@
+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[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::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 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?
+        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/version.rb

@@ -3,7 +3,7 @@
 module PR
   module With
     module Params
-      VERSION = "0.1.3"
+      VERSION = "1.0.2"
     end
   end
 end

data/lib/pr/with/params.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "params/version"
+require_relative 'params/version'
+require_relative 'params/config_parser'
 require 'uri'
+require 'json'
 require 'launchy'
 
 module PR
@@ -9,11 +11,27 @@ module PR
     module Params
       class Error < StandardError; end
 
-      def self.open(host:, path:, query:)
+      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)
+        config_options = 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
+
+        STDERR.puts "\e[35mWARNING\e[0m: " + error_message + "\n"
+        
+        {}
+      end
     end
   end
 end

data/pr-with-params.gemspec

@@ -8,7 +8,7 @@ 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.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.2
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-06 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -31,6 +31,7 @@ files:
 - bin/setup
 - exe/pr-with-params
 - lib/pr/with/params.rb
+- lib/pr/with/params/config_parser.rb
 - lib/pr/with/params/version.rb
 - pr-with-params.gemspec
 homepage: https://github.com/2k-joker/pr-with-params
@@ -55,7 +56,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: []