pr-with-params 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd62108def63836659f73059843a5260211596b80e344a2543939688b3dadaba
-  data.tar.gz: b538c821030781006c3df77169c082ada6ccf68c7a74d330f23363d93792ccaa
+  metadata.gz: 9d4ad8c0505135845906a907642802d1e6426610e114cfd33be9c090a4866713
+  data.tar.gz: 71b40495173262b6ef5cf9ce0ea85f160e677d95505cc2cded45036831e86a90
 SHA512:
-  metadata.gz: e7d30fbe9b54a10925d688bd9ece749c034ada2b300e0f4bbb3022a0ae0380f335257506aa7b41c8bf7593ceab8639cefc55a84fad88585d288ccf365b33587d
-  data.tar.gz: 3fe80d1fdbae5795051485882a56d5ff5ac26e1bdabf01b62121655fe52a34d7f95d0fa3a302b0d064ca64ca6b5a52d6969f6dd541bab0e60ff6526297f11a25
+  metadata.gz: c592f1a860463ae680e56dc919d91a1e575c0beead05bfc0f64d759fc509b28cd06e2bc42ddd4240a38e85ee40c7d74c9b64b87157cf740579b2fe63c6632fff
+  data.tar.gz: 2dd182433b8815efe50dd0405232c9319d2d0795f61479a54dc9c80e4f4be6e51feeb832789ab73286c1c7c3bed1f81513469ab4d2feb8292ca1fb2538f6889e

data/.rubocop.yml

@@ -1,10 +1,23 @@
+# Style
 Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+  Enabled: false
 
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Layout
 Layout/LineLength:
-  Max: 120
+  Max: 200

data/Gemfile.lock

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

data/README.md

@@ -34,6 +34,8 @@ For a full list of options, run `$ pr-with-params -h`
 Gem supports defining options in a yaml file (`.yaml`, `.yml`) like so:
 ```yaml
 default:
+  validators:
+    - conventional_commits
   base_branch: main
   template: new_feature_template.md
   assignees: 2k-joker
@@ -54,11 +56,17 @@ bug_fix:
 ```
 
 **Supported configs**
-* base_branch
-* template
-* title
-* labels
-* assignees
+| Config | Type | Example |
+| :--- | :---: | :--- |
+| validators | `Array` | \`[conventional_commits]\` |
+| base_branch | `String` | develop |
+| template | `String` | new_feature_template.md |
+| title | `String` | 'Update login screen' |
+| lables | `String` | frontend,WIP |
+| 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.
 
 ## Development
 

data/exe/pr-with-params

@@ -10,6 +10,7 @@ options = { expand: 1 }
 config_file_path = ''
 config_scope = nil
 
+# rubocop:disable Metrics/BlockLength
 parser = OptionParser.new do |opt|
   opt.banner = "Usage pr-with-params [options]"
 
@@ -39,7 +40,7 @@ parser = OptionParser.new do |opt|
     options[:template] = pr_template
   end
 
-  opt.on('-d', '--description DESC', 'Specify a custom PR title') do |pr_description|
+  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
 
@@ -50,7 +51,12 @@ parser = OptionParser.new do |opt|
   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!
@@ -60,8 +66,13 @@ begin
 
   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
 
+  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}"
 
@@ -85,6 +96,6 @@ rescue StandardError => e
     backtrace: e.backtrace&.last(10)
   }.to_json
 
-  STDERR.puts "\n" + "\e[31mERROR:\e[0m " + error_message + "\n"
+  warn "\e[31mERROR\e[0m: " + error_message + "\n"
   exit 1
 end

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

@@ -8,7 +8,7 @@ module PR
         attr_reader :config_file_path, :scope, :parsed_config, :filtered_config
 
         # Constants
-        VALID_CONFIG_KEYS = %i[base_branch template title labels assignees].freeze
+        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
@@ -23,7 +23,7 @@ module PR
         private
 
         def parse_yaml_config
-          @parsed_config = YAML::load(IO.read(config_file_path)).transform_keys(&:to_sym)
+          @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
 
@@ -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(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?

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

@@ -0,0 +1,46 @@
+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)(\(\w+\))?(!)?(: (.*\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

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

data/lib/pr/with/params.rb

@@ -2,6 +2,7 @@
 
 require_relative 'params/version'
 require_relative 'params/config_parser'
+require_relative 'params/options_validator'
 require 'uri'
 require 'json'
 require 'launchy'
@@ -20,7 +21,7 @@ module PR
       end
 
       def parse_config(file_path, scope)
-        config_options = 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
         error_message = {
           message: "Error parsing config file. Using defaults",
@@ -28,10 +29,15 @@ module PR
           backtrace: e.backtrace&.last(10)
         }.to_json
 
-        STDERR.puts "\e[35mWARNING\e[0m: " + error_message + "\n"
-        
+        warn "\e[35mWARNING\e[0m: " + error_message + "\n"
+
         {}
       end
+
+      def validate_options(options)
+        validators = options.delete(:validators)
+        OptionsValidator.validate!(options, validators: validators)
+      end
     end
   end
 end

data/pr-with-params.gemspec

@@ -10,6 +10,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.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-with-params
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - 2k-joker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -32,10 +32,12 @@ files:
 - 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
 - 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: