semverrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb686be329e56bd75507313253c5e11584792c3b1bc6bacc39ea6c529153007a
+  data.tar.gz: 7741fbd23e81b218f0fbf3a9a7ad500d2f3d59daafdd07fe1fa264abe4861e62
+SHA512:
+  metadata.gz: e7397e8cc29fc7499d2c403ccc991e2b4c0261de3bb302db4c8999791ad442e48811d14871e8778718ac49432ea46b1f69871d33b4ffe8dd4a2f70492d71da61
+  data.tar.gz: 55a75538bea9117625760de1013f6163881920b5fcf7473a99b53196c856b2ff790fbd765944776b5694c29130b9ae22895b7172e83db973c9dbc797d4c66645

data/.github/workflows/gem-push.yml

@@ -0,0 +1,46 @@
+# name: Publish Ruby Gem
+
+# on:
+#   push:
+#     branches:
+#       - main
+
+# jobs:
+#   build:
+#     name: Build + Publish
+#     runs-on: ubuntu-latest
+#     permissions:
+#       contents: read
+#       packages: write
+
+#     steps:
+#     - name: Checkout Code
+#       uses: actions/checkout@v4
+
+#     - name: Set up Ruby 3.2.6
+#       uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+#       with:
+#         ruby-version: 3.2.6
+
+#     - name: Publish to GitHub Packages
+#       run: |
+#         mkdir -p $HOME/.gem
+#         touch $HOME/.gem/credentials
+#         chmod 0600 $HOME/.gem/credentials
+#         printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+#         gem build *.gemspec
+#         gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+#       env:
+#         GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+#         OWNER: ${{ github.repository_owner }}
+
+#     - name: Publish to RubyGems.org
+#       run: |
+#         mkdir -p $HOME/.gem
+#         touch $HOME/.gem/credentials
+#         chmod 0600 $HOME/.gem/credentials
+#         printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+#         gem build *.gemspec
+#         gem push *.gem
+#       env:
+#         GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+*.rbc
+/.yardoc
+.yardoc/
+.yardtmp
+/config/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 160
+
+Metrics/ClassLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+  Max: 18
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in semverrb.gemspec
+gemspec
+gem "octokit"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    semverrb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.3)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    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.37.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-24
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  semverrb!
+
+BUNDLED WITH
+   2.6.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,113 @@
+# Semver (Semantic Versioning)
+
+`semverrb` is a lightweight and intuitive CLI tool to help you manage **semantic versioning** for your projects. It simplifies version management by automating version bumps (`major`, `minor`, `patch`, or `prerelease`) and supports multiple formats including **plain text**, **JSON**, and **YAML**.
+
+`semverrb` follows the Semantic Versioning 2.0.0 standard:
+
+1. Versions are in the format MAJOR.MINOR.PATCH.
+    - Increment MAJOR when making incompatible API changes.
+    - Increment MINOR when adding functionality in a backward-compatible manner.
+    - Increment PATCH for backward-compatible bug fixes.
+2. Prerelease identifiers (e.g., -alpha, -beta) and build metadata (e.g., +build.1) are supported.
+
+Learn more about Semantic Versioning at https://semver.org.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semverrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install semverrb
+
+## Usage
+### Show the Current Version
+
+To display the current version from your VERSION file (default is plain text):
+
+```
+semver current
+```
+You can also specify the format explicitly:
+
+```
+semver current --format json
+semver current --format yaml
+```
+
+### Bump the Version
+
+Available Bump Types
+
+- major: Increment the major version (e.g., 1.2.3 → 2.0.0).
+- minor: Increment the minor version (e.g., 1.2.3 → 1.3.0).
+- patch: Increment the patch version (e.g., 1.2.3 → 1.2.4).
+- prerelease: Add a pre-release identifier (e.g., 1.2.3 → 1.2.3-alpha).
+
+Example Commands
+
+```
+# Bump the patch version (default format: plain text)
+semver bump patch
+```
+
+```
+# Bump the minor version in JSON format
+semver bump minor --format json
+```
+```
+# Bump the major version in YAML format
+semver bump major --format yaml
+```
+```
+# Add a prerelease identifier (e.g., alpha, beta, rc)
+semver bump prerelease --prerelease alpha
+```
+
+### Supported Formats
+
+The semverrb gem supports managing version numbers in multiple formats:
+
+- Plain Text (Default):
+
+```
+1.2.3
+```
+
+- JSON:
+
+```json
+{
+  "version": "1.2.3"
+}
+```
+
+- YAML:
+
+```yaml
+version: 1.2.3
+```
+
+Specify the format with the `--format` flag, and the gem will read/write the version file accordingly.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/semverrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "semverrb"
+
+# 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/lib/semver/cli.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require_relative "version_parser"
+require "octokit"
+
+module Semver
+  class CLI < Thor
+    VERSION_FILE = "VERSION"
+
+    desc "current", "Displays the current semantic version"
+    option :format, type: :string, default: "plain", enum: %w[plain json yaml], desc: "Specify the version format"
+    def current
+      version = read_version(options[:format])
+      puts "Current version: #{version}"
+    end
+
+    desc "bump [major|minor|patch|prerelease]", "Bumps the semantic version"
+    option :format, type: :string, default: "plain", enum: %w[plain json yaml], desc: "Specify the version format"
+    option :prerelease, type: :string, desc: "Specify a prerelease identifier (e.g., alpha, beta)"
+    option :github_release_notes, type: :boolean, default: false, desc: "Create GitHub release notes"
+    def bump(type)
+      current_version = read_version(options[:format])
+      version = VersionParser.new(current_version)
+
+      case type
+      when "major"
+        version = bump_major(version)
+      when "minor"
+        version = bump_minor(version)
+      when "patch"
+        version = bump_patch(version)
+      when "prerelease"
+        prerelease = options[:prerelease] || "alpha"
+        version = bump_prerelease(version, prerelease)
+      else
+        puts "Invalid type. Use 'major', 'minor', 'patch', or 'prerelease'."
+        return
+      end
+
+      write_version(version.to_s, options[:format])
+      update_version_rb(version.to_s)
+
+      puts "Version bumped to: #{version}"
+
+      return unless options[:github_release_notes]
+
+      create_github_release(version.to_s)
+    end
+
+    private
+
+    def read_version(format)
+      case format
+      when "plain"
+        File.exist?(VERSION_FILE) ? File.read(VERSION_FILE).strip : "0.0.0"
+      when "json"
+        require "json"
+        JSON.parse(File.read(VERSION_FILE))["version"]
+      when "yaml"
+        require "yaml"
+        YAML.safe_load(File.read(VERSION_FILE))["version"]
+      else
+        raise ArgumentError, "Unsupported format: #{format}"
+      end
+    end
+
+    def write_version(version, format)
+      case format
+      when "plain"
+        File.write(VERSION_FILE, version)
+      when "json"
+        require "json"
+        File.write(VERSION_FILE, JSON.pretty_generate({ "version" => version }))
+      when "yaml"
+        require "yaml"
+        File.write(VERSION_FILE, { "version" => version }.to_yaml)
+      else
+        raise ArgumentError, "Unsupported format: #{format}"
+      end
+    end
+
+    def update_version_rb(new_version)
+      version_rb_path = find_version_rb
+      if version_rb_path
+        content = File.read(version_rb_path)
+        updated_content = content.gsub(/VERSION = ["']\d+\.\d+\.\d+["']/, "VERSION = \"#{new_version}\"")
+        File.write(version_rb_path, updated_content)
+        puts "Updated #{version_rb_path} to version #{new_version}"
+      else
+        puts "Warning: version.rb file not found. Skipping update."
+      end
+    end
+
+    def find_version_rb
+      gemspec = Dir["*.gemspec"].first
+      return nil unless gemspec
+
+      gem_name = File.basename(gemspec, ".gemspec")
+      version_rb = File.join("lib", gem_name, "version.rb")
+
+      File.exist?(version_rb) ? version_rb : nil
+    end
+
+    def bump_major(version)
+      VersionParser.new("#{version.major + 1}.0.0")
+    end
+
+    def bump_minor(version)
+      VersionParser.new("#{version.major}.#{version.minor + 1}.0")
+    end
+
+    def bump_patch(version)
+      VersionParser.new("#{version.major}.#{version.minor}.#{version.patch + 1}")
+    end
+
+    def bump_prerelease(version, prerelease)
+      VersionParser.new("#{version.major}.#{version.minor}.#{version.patch}-#{prerelease}")
+    end
+
+    def create_github_release(version)
+      github_token = ENV["GITHUB_TOKEN"]
+      repo = ENV["GITHUB_REPO"]
+
+      unless github_token && repo
+        config = load_config
+        github_token ||= config["github_token"]
+        repo ||= config["github_repo"]
+      end
+
+      unless github_token && repo
+        puts "Error: GitHub token and repository must be set in environment variables or config file."
+        return
+      end
+
+      client = Octokit::Client.new(access_token: github_token)
+
+      client.create_release(
+        repo,
+        "v#{version}",
+        name: "Release #{version}",
+        body: "Release notes for version #{version}",
+        draft: false,
+        prerelease: false
+      )
+
+      puts "GitHub release created for version #{version}"
+    end
+  end
+end

data/lib/semver/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Semver
+  VERSION = "0.1.0"
+end

data/lib/semver/version_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Semver
+  class VersionParser
+    SEMVER_REGEX = /\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(?:-(?<prerelease>[0-9A-Za-z\.-]+))?(?:\+(?<buildmetadata>[0-9A-Za-z\.-]+))?\z/.freeze
+
+    attr_reader :major, :minor, :patch, :prerelease, :buildmetadata
+
+    def initialize(version_string)
+      match = version_string.match(SEMVER_REGEX)
+      raise ArgumentError, "Invalid semantic version: #{version_string}" unless match
+
+      @major = match[:major].to_i
+      @minor = match[:minor].to_i
+      @patch = match[:patch].to_i
+      @prerelease = match[:prerelease]
+      @buildmetadata = match[:buildmetadata]
+    end
+
+    def to_s
+      version = "#{major}.#{minor}.#{patch}"
+      version += "-#{prerelease}" if prerelease
+      version += "+#{buildmetadata}" if buildmetadata
+      version
+    end
+  end
+end

data/lib/semver.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "semver/version"
+require_relative "semver/version_parser"
+require_relative "semver/cli"
+
+module Semver
+  class Error < StandardError; end
+end

data/semverrb.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/semver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "semverrb"
+  spec.version       = Semver::VERSION
+  spec.authors       = ["Chris Davis"]
+  spec.email         = ["chrisdavis179@gmail.com"]
+
+  spec.summary       = "Semantic Versioning for Ruby"
+  spec.description   = "Semantic Versioning for Ruby"
+  spec.homepage      = "https://github.com/thecdavis/semverrb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.txt"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: semverrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Davis
+bindir: exe
+cert_chain: []
+date: 2024-12-24 00:00:00.000000000 Z
+dependencies: []
+description: Semantic Versioning for Ruby
+email:
+- chrisdavis179@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.txt
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/semver
+- bin/setup
+- lib/semver.rb
+- lib/semver/cli.rb
+- lib/semver/version.rb
+- lib/semver/version_parser.rb
+- semverrb.gemspec
+homepage: https://github.com/thecdavis/semverrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thecdavis/semverrb
+  source_code_uri: https://github.com/thecdavis/semverrb
+  changelog_uri: https://github.com/thecdavis/semverrb/CHANGELOG.txt
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Semantic Versioning for Ruby
+test_files: []