spreen-pr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4bd88e557037018e0fe5ed7d0afa88e9f3d1cb1de2348a8c4802ccdfb95e5d2
+  data.tar.gz: 14b233e9c702e1f2f3ad37c56522fcb76cd56065dc311bd05cc17306b6f765db
+SHA512:
+  metadata.gz: 6dd4e77155364cb333c582175fb381b767082d879ca9a0da706a0550e0c878c476206fed589df53277c6fc9821c134a4c55697f040d1f097d222a44807469041
+  data.tar.gz: d20b0604b0329df8d8b89426b92f2981732b02a10b1cdce4ad30e8b77732fc139cb666a8067c4d599e6bb599321332f8593d7d46999e29550e02a1ecc2634d52

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - present @hayat01sh1da
+
+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,98 @@
+## 1. Environment
+
+- Ruby 4.0.6
+- Gemfile 4.0.16
+- Bundler 4.0.16
+
+## 2. Installation
+
+```command
+$ gem install spreen-pr
+```
+
+For development, install the dependencies via Gemfile and Bundler:
+
+```command
+$ bundle install
+$ bundle lock --add-checksums
+```
+
+## 3. Execution
+
+```command
+$ pr-title hayat01sh1da/issue-89/service/improve-onboarding-flow
+[service] Improve Onboarding Flow
+```
+
+With no argument, the current git branch is used:
+
+```command
+$ git switch hayat01sh1da/issue-90/hotfix/service/fix_login_crash
+$ pr-title
+[Hotfix][service] Fix Login Crash
+```
+
+`--format json` exposes the labels separately for scripting and CI:
+
+```command
+$ pr-title hayat01sh1da/issue-90/hotfix/service/fix_login_crash --format json
+{"title":"[Hotfix][service] Fix Login Crash","labels":["Hotfix","service"]}
+```
+
+As a library:
+
+```ruby
+require 'spreen_pr' # or require 'spreen-pr'
+
+SpreenPr::Application.run(branch_name: 'hayat01sh1da/issue-89/service/improve-onboarding-flow')
+# => "[service] Improve Onboarding Flow"
+
+application = SpreenPr::Application.new(branch_name: 'hayat01sh1da/issue-90/hotfix/service/fix_login_crash')
+application.title  # => "[Hotfix][service] Fix Login Crash"
+application.labels # => ["Hotfix", "service"]
+```
+
+## 4. Unit Test
+
+```command
+$ rake
+Run options: --seed 30407
+
+# Running:
+
+...............
+
+Finished in 0.002625s, 5715.1305 runs/s, 9906.2261 assertions/s.
+
+15 runs, 26 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## 5. Static Code Analysis
+
+```command
+$ bundle exec rubocop
+Inspecting 12 files
+............
+
+12 files inspected, no offenses detected
+```
+
+## 6. Type Checks
+
+```command
+$ bundle exec rbs-inline --output sig/generated/ .
+🎉 Generated 7 RBS files under sig/generated
+$ bundle exec steep check
+# Type checking files:
+
+..............
+
+No type error detected. 🫖
+```
+
+## 7. Build
+
+```command
+$ gem build spreen-pr.gemspec
+$ gem install ./spreen-pr-0.1.0.gem
+```

data/exe/pr-title

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'spreen_pr'
+
+exit SpreenPr::CLI.start

data/lib/spreen-pr.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+# Convenience shim so that both `require 'spreen-pr'` (the gem name) and
+# `require 'spreen_pr'` (the conventional path) work.
+require_relative 'spreen_pr'

data/lib/spreen_pr/application.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module SpreenPr
+  # Derives a pull request title and labels from a topic branch name shaped
+  # `{user}/{issue}/{category}/{summary}`, with the hotfix special case
+  # `{user}/{issue}/hotfix/{category}/{summary}`.
+  class Application
+    EXPECTED_SHAPE = '{user}/{issue}/{category}/{summary}' #: String
+
+    # @rbs branch_name: String
+    # @rbs return: String
+    def self.run(branch_name:)
+      new(branch_name:).title
+    end
+
+    # @rbs branch_name: String
+    # @rbs return: void
+    def initialize(branch_name:)
+      @branch_name = branch_name
+      @segments    = branch_name.split('/')
+      validate!
+    end
+
+    # @rbs return: String
+    def title
+      "#{labels.map { |label| "[#{label}]" }.join} #{topic}"
+    end
+
+    # @rbs return: Array[String]
+    def labels
+      hotfix? ? [segments[-3].capitalize, segments[-2]] : [segments[-2]]
+    end
+
+    # @rbs return: String
+    def topic
+      segments.last.split(/[-_]/).map(&:capitalize).join("\s")
+    end
+
+    # @rbs return: Hash[Symbol, String | Array[String]]
+    def to_h
+      { title:, labels: }
+    end
+
+    private
+
+    attr_reader :branch_name #: String
+    attr_reader :segments #: Array[String]
+
+    # @rbs return: bool
+    def hotfix?
+      segments[-3] == 'hotfix'
+    end
+
+    # @rbs return: void
+    def validate!
+      return if segments.size >= 3 && segments.none?(&:empty?)
+
+      raise ArgumentError,
+            "Branch name `#{branch_name}` does not match the expected `#{EXPECTED_SHAPE}` shape"
+    end
+  end
+end

data/lib/spreen_pr/cli.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require 'json'
+require 'optparse'
+require_relative 'version'
+require_relative 'application'
+
+module SpreenPr
+  # Command line interface behind the `pr-title` executable:
+  # `pr-title [BRANCH_NAME] [--format text|json]`.
+  class CLI
+    FORMATS = %w[text json].freeze #: Array[String]
+
+    # @rbs argv: Array[String]
+    # @rbs return: Integer
+    def self.start(argv = ARGV)
+      new(argv).run
+    end
+
+    # @rbs argv: Array[String]
+    # @rbs return: void
+    def initialize(argv)
+      @argv   = argv.dup
+      @format = 'text'
+      @action = :print_title
+    end
+
+    # @rbs return: Integer
+    def run
+      parser.parse!(argv)
+      __send__(action)
+    rescue ArgumentError, OptionParser::ParseError => e
+      warn e.message
+      1
+    end
+
+    private
+
+    attr_reader :argv #: Array[String]
+    attr_reader :format #: String
+    attr_reader :action #: Symbol
+
+    # @rbs return: Integer
+    def print_title
+      application = Application.new(branch_name:)
+      puts(format == 'json' ? JSON.generate(application.to_h) : application.title)
+      0
+    end
+
+    # @rbs return: Integer
+    def print_version
+      puts VERSION
+      0
+    end
+
+    # @rbs return: Integer
+    def print_help
+      puts parser
+      0
+    end
+
+    # @rbs return: String
+    def branch_name
+      branch = argv.shift || current_git_branch
+      return branch unless branch.nil? || branch.empty?
+
+      raise ArgumentError,
+            'No branch name given and the current git branch could not be detected'
+    end
+
+    # @rbs return: String?
+    def current_git_branch
+      IO.popen(%w[git branch --show-current], err: File::NULL, &:read).strip
+    rescue SystemCallError
+      nil
+    end
+
+    # @rbs return: OptionParser
+    def parser
+      @parser ||= OptionParser.new('Usage: pr-title [BRANCH_NAME] [options]') do |opt|
+        opt.on('--format FORMAT', FORMATS,
+               "Output format (#{FORMATS.join(' or ')}, default: text)") { |value| @format = value }
+        opt.on('--version', 'Print the version') { @action = :print_version }
+        opt.on('-h', '--help', 'Print this help') { @action = :print_help }
+      end
+    end
+  end
+end

data/lib/spreen_pr/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module SpreenPr
+  VERSION = '0.1.0'
+end

data/lib/spreen_pr.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require_relative 'spreen_pr/version'
+require_relative 'spreen_pr/application'
+require_relative 'spreen_pr/cli'
+
+# Spreens a pull request — the falcon's stoop, then the preen: derives a PR
+# title and labels from a topic branch name shaped
+# `{user}/{issue}/{category}/{summary}` (with a hotfix special case) and
+# prints them as plain text or JSON.
+module SpreenPr
+end

data/sig/generated/spreen-pr.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/spreen-pr.rb with RBS::Inline
+

data/sig/generated/spreen_pr/application.rbs

@@ -0,0 +1,42 @@
+# Generated from lib/spreen_pr/application.rb with RBS::Inline
+
+module SpreenPr
+  # Derives a pull request title and labels from a topic branch name shaped
+  # `{user}/{issue}/{category}/{summary}`, with the hotfix special case
+  # `{user}/{issue}/hotfix/{category}/{summary}`.
+  class Application
+    EXPECTED_SHAPE: String
+
+    # @rbs branch_name: String
+    # @rbs return: String
+    def self.run: (branch_name: String) -> String
+
+    # @rbs branch_name: String
+    # @rbs return: void
+    def initialize: (branch_name: String) -> void
+
+    # @rbs return: String
+    def title: () -> String
+
+    # @rbs return: Array[String]
+    def labels: () -> Array[String]
+
+    # @rbs return: String
+    def topic: () -> String
+
+    # @rbs return: Hash[Symbol, String | Array[String]]
+    def to_h: () -> Hash[Symbol, String | Array[String]]
+
+    private
+
+    attr_reader branch_name: String
+
+    attr_reader segments: Array[String]
+
+    # @rbs return: bool
+    def hotfix?: () -> bool
+
+    # @rbs return: void
+    def validate!: () -> void
+  end
+end

data/sig/generated/spreen_pr/cli.rbs

@@ -0,0 +1,46 @@
+# Generated from lib/spreen_pr/cli.rb with RBS::Inline
+
+module SpreenPr
+  # Command line interface behind the `pr-title` executable:
+  # `pr-title [BRANCH_NAME] [--format text|json]`.
+  class CLI
+    FORMATS: Array[String]
+
+    # @rbs argv: Array[String]
+    # @rbs return: Integer
+    def self.start: (?Array[String] argv) -> Integer
+
+    # @rbs argv: Array[String]
+    # @rbs return: void
+    def initialize: (Array[String] argv) -> void
+
+    # @rbs return: Integer
+    def run: () -> Integer
+
+    private
+
+    attr_reader argv: Array[String]
+
+    attr_reader format: String
+
+    attr_reader action: Symbol
+
+    # @rbs return: Integer
+    def print_title: () -> Integer
+
+    # @rbs return: Integer
+    def print_version: () -> Integer
+
+    # @rbs return: Integer
+    def print_help: () -> Integer
+
+    # @rbs return: String
+    def branch_name: () -> String
+
+    # @rbs return: String?
+    def current_git_branch: () -> String?
+
+    # @rbs return: OptionParser
+    def parser: () -> OptionParser
+  end
+end

data/sig/generated/spreen_pr/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/spreen_pr/version.rb with RBS::Inline
+
+module SpreenPr
+  VERSION: ::String
+end

data/sig/generated/spreen_pr.rbs

@@ -0,0 +1,8 @@
+# Generated from lib/spreen_pr.rb with RBS::Inline
+
+# Spreens a pull request — the falcon's stoop, then the preen: derives a PR
+# title and labels from a topic branch name shaped
+# `{user}/{issue}/{category}/{summary}` (with a hotfix special case) and
+# prints them as plain text or JSON.
+module SpreenPr
+end

data/sig/generated/test/application_test.rbs

@@ -0,0 +1,21 @@
+# Generated from test/application_test.rb with RBS::Inline
+
+class ApplicationTest < Minitest::Test
+  def test_run: () -> untyped
+
+  def test_run_in_the_case_of_hotfix: () -> untyped
+
+  def test_run_in_the_case_of_kebab_case_summary: () -> untyped
+
+  def test_labels: () -> untyped
+
+  def test_labels_in_the_case_of_hotfix: () -> untyped
+
+  def test_to_h: () -> untyped
+
+  def test_run_raises_on_a_branch_name_with_too_few_segments: () -> untyped
+
+  def test_run_raises_on_a_branch_name_with_empty_segments: () -> untyped
+
+  def test_run_raises_on_an_empty_branch_name: () -> untyped
+end

data/sig/generated/test/cli_test.rbs

@@ -0,0 +1,15 @@
+# Generated from test/cli_test.rb with RBS::Inline
+
+class CLITest < Minitest::Test
+  def test_text_format: () -> untyped
+
+  def test_json_format: () -> untyped
+
+  def test_invalid_branch_name: () -> untyped
+
+  def test_invalid_format: () -> untyped
+
+  def test_version: () -> untyped
+
+  def test_help: () -> untyped
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: spreen-pr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hayat01sh1da
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Spreen — the falcon's stoop, then the preen. Derives a pull request title
+  and labels from a topic branch name shaped {user}/{issue}/{category}/{summary} (with
+  a hotfix special case) and prints them as plain text or JSON via the pr-title CLI,
+  defaulting to the current git branch.
+executables:
+- pr-title
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/pr-title
+- lib/spreen-pr.rb
+- lib/spreen_pr.rb
+- lib/spreen_pr/application.rb
+- lib/spreen_pr/cli.rb
+- lib/spreen_pr/version.rb
+- sig/generated/spreen-pr.rbs
+- sig/generated/spreen_pr.rbs
+- sig/generated/spreen_pr/application.rbs
+- sig/generated/spreen_pr/cli.rbs
+- sig/generated/spreen_pr/version.rbs
+- sig/generated/test/application_test.rbs
+- sig/generated/test/cli_test.rbs
+homepage: https://github.com/hayat01sh1da/spreen-pr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hayat01sh1da/spreen-pr
+  source_code_uri: https://github.com/hayat01sh1da/spreen-pr
+  changelog_uri: https://github.com/hayat01sh1da/spreen-pr/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hayat01sh1da/spreen-pr/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: 'Spreen your pull request: print a PR title with labels derived from the
+  topic branch name.'
+test_files: []