pr-with-params 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ab35532543684c0467e8c85b4f05d6bb34c2f37a31f09d6d19f546b8f973ca0
+  data.tar.gz: 79e8ae8b681c506ebad08b38c7cf4ce624a89715cddbe37181f9c7aaa2e3fef5
+SHA512:
+  metadata.gz: 29e4a1bb172ff62a1ae49ce0fbb4c92ee3860c183c1db8b56614fe535e19e3b08a16cfff76b178d5fd2240b772c901f0c1affbcbb0b23cefddadb26838cff675
+  data.tar.gz: 4c15b85e016f2cff82f0f2b8e7cde845063b25074f3ae331bfcc3a9d7250f058a635006fc7d6bdaf26f1ef9592f76faecdf84dd2f5294a71f5428423818d1a6d

data/.github/PULL_REQUEST_TEMPLATE/bug_fix_template.md

@@ -0,0 +1,10 @@
+Fixes #<issue-number>
+
+### Description (Checkout [this article](https://chris.beams.io/posts/git-commit/) for examples of good commit messages):
+
+### Testing Steps
+
+### Gotchas
+
+### Dependencies
+

data/.github/PULL_REQUEST_TEMPLATE/new_feature_template.md

@@ -0,0 +1,14 @@
+Implements #<issue-number>
+
+### Description (Checkout [this article](https://chris.beams.io/posts/git-commit/) for examples of good commit messages):
+
+
+### Testing Steps
+
+### Gotchas
+
+### Dependencies
+
+### Release Plan
+
+

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    pr-with-params (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  launchy
+  minitest (~> 5.0)
+  pr-with-params!
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Khalil Kum
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pr-with-params'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pr-with-params
+
+## Usage
+
+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'
+```
+
+For a full list of options, run `$ pr-with-params -h`
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pr-with-params.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/pr-with-params

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup' # support local testing/development
+require_relative '../lib/pr/with/params'
+require 'json'
+require 'optparse'
+
+options = { expand: 1 }
+
+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('--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') 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
+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/.*: //'`
+  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}"
+
+  puts "current branch: \e[36m#{branch_name.chomp}\e[0m"
+  puts "base branch: \e[36m#{base_branch.chomp}\e[0m"
+  puts "repo path: \e[36m#{remote_git_uri}\e[0m"
+
+  push_message = "\nPushing your local branch to origin/#{branch_name.chomp}..."
+  puts "\e[32m#{push_message}\e[0m"
+  `sleep 1`
+  system("git push -u origin #{branch_name}")
+
+  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
+  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
+
+  STDERR.puts error_message
+  exit 1
+end

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

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

data/lib/pr/with/params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "params/version"
+require 'uri'
+require 'launchy'
+
+module PR
+  module With
+    module Params
+      class Error < StandardError; end
+
+      def self.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
+    end
+  end
+end

data/pr-with-params.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/pr/with/params/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pr-with-params"
+  spec.version       = PR::With::Params::VERSION
+  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.homepage      = "https://github.com/2k-joker/pr-with-params"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: pr-with-params
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- 2k-joker
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- kum.vanjunior@gmail.com
+executables:
+- pr-with-params
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/PULL_REQUEST_TEMPLATE/bug_fix_template.md"
+- ".github/PULL_REQUEST_TEMPLATE/new_feature_template.md"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pr-with-params
+- lib/pr/with/params.rb
+- lib/pr/with/params/version.rb
+- pr-with-params.gemspec
+homepage: https://github.com/2k-joker/pr-with-params
+licenses: []
+metadata:
+  homepage_uri: https://github.com/2k-joker/pr-with-params
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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.
+test_files: []