semverify 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fcbd22e660e49a8687593008433ffbfd859760a9ecb7a2f61c1277786d34a25
+  data.tar.gz: d4973af279ee22a2ed02874972908c47ddb4c3db604166c577d00c29885114c6
+SHA512:
+  metadata.gz: d92b11f52be46b8d19b434b1a219a603785ad3cd7570bd64c313e37b78b8c066f8e15d0a491e6834db98206de967359e93c8cb08b03863f97dce0c6c5d6a3477
+  data.tar.gz: 9b88892ebc937cf4f18a64b16d0a0fe5eb1a706a7564ee1a23e5b5d35089d7d9e1fc5f74c4cf42ffcad32413085ca015166a12703432f1701e551c973b51b451

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  NewCops: enable
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  SuggestExtensions: false
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 3.0
+
+# The default max line length is 80 characters
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"
+
+# When writing minitest tests, it is very hard to limit test class length:
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*_test.rb"

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+- CHANGELOG.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## v0.3.0 (2023-03-19)
+
+[Full Changelog](https://github.com/main-branch/semverify/compare/v0.2.0..v0.3.0)
+
+Changes since v0.2.0:
+
+* 83cf403 Update CodeClimate badges after project rename (#13)
+* 7079244 Rename gem from 'semversion' to 'semverify' (#11)
+
+## v0.2.0 (2023-03-18)
+
+[Full Changelog](https://github.com/main-branch/semverify/compare/v0.1.0..v0.2.0)
+
+Changes since v0.1.0:
+
+* 7a8069c Integrate the create_github_release gem (#9)
+* 96cdae4 Add Library Usage documentation to README.md (#8)
+* 8196c2e Add JRuby Linux and Windows builds to CI builds (#7)
+* e6b0739 Add windows build to CI builds (#6)
+* 59e310f Fix reported CodeClimate complexity issues (#3)
+* 2d28b30 Integrate CodeClimate maintainability and test coverage tracking (#1)
+* 2bda849 Add CODEOWNERS file to indicate who can review PRs
+* 4599554 Add the CommandLine class and semverify script
+* 6204835 Add the #next_release method to IncrementableSemver
+* 4219c88 Add the #next_pre method to IncrementableSemver
+* 6f3bd22 Add the #next_major, #next_minor, #next_patch methods to IncrementableSemver
+* 76782ac Add the IncrementableSemver class
+* 98d12cc Add the VersionFile and the VersionFileFactory classes
+* 713fddd Add the Semver class
+* e5c9864 Update README.md
+
+## [Unreleased]
+
+## [0.1.0] - 2023-03-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jcouball@yahoo.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in semverify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 James Couball
+
+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,116 @@
+# Semverify
+
+[![Gem Version](https://badge.fury.io/rb/semverify.svg)](https://badge.fury.io/rb/semverify)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/semverify/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/semverify/file/CHANGELOG.md)
+[![Build Status](https://github.com/main-branch/semverify/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/semverify/actions?query=workflow%3ACI%20Build)
+[![Maintainability](https://api.codeclimate.com/v1/badges/44a42ed085fe162e5dff/maintainability)](https://codeclimate.com/github/main-branch/semverify/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/44a42ed085fe162e5dff/test_coverage)](https://codeclimate.com/github/main-branch/semverify/test_coverage)
+
+A Gem to parse, compare, and increment versions for RubyGems.
+
+Can be used as an alternative to the [bump RubyGem](https://rubygems.org/gems/bump/).
+
+* [Semverify](#semverify)
+  * [Installation](#installation)
+  * [Command Line Usage](#command-line-usage)
+  * [Library Usage](#library-usage)
+  * [Development](#development)
+  * [Contributing](#contributing)
+  * [License](#license)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Command Line Usage
+
+The `semverify` command line has built in help for all its commands. List the
+commands by invoking `semverify` with no arguments or `semverify help` as
+follows:
+
+```shell
+semverify help
+```
+
+The output is the following:
+
+```shell
+Commands:
+  semverify current [-q]                                              # Show the current gem version
+  semverify file [-q]                                                 # Show the path to the file containing the g...
+  semverify help [COMMAND]                                            # Describe available commands or one specifi...
+  semverify next-major [VERSION] [-p [-t TYPE]] [-b BUILD] [-n] [-q]  # Increment the version's major part
+  semverify next-minor [VERSION] [-p [-t TYPE]] [-b BUILD] [-n] [-q]  # Increment the version's minor part
+  semverify next-patch [VERSION] [-p [-t TYPE]] [-b BUILD] [-n] [-q]  # Increment the version's patch part
+  semverify next-pre [VERSION] [-t TYPE] [-b BUILD] [-n] [-q]         # Increment the version's pre-release part
+  semverify next-release [VERSION] [-b BUILD] [-n] [-q]               # Increment a pre-release version to the rel...
+  semverify validate VERSION [-q]                                     # Validate the given version
+$
+```
+
+The `semverify help COMMAND` command will give further help for a specific command:
+
+```shell
+semverify help current
+```
+
+The output is the following:
+
+```shell
+Usage:
+  semverify current [-q]
+
+Options:
+  -q, [--quiet], [--no-quiet]  # Do not print the current version to stdout
+
+Description:
+  Output the current gem version from the file that stores the gem version.
+
+  The command fails if the gem version could not be found or is invalid.
+
+  Use `--quiet` to ensure that a gem version could be found and is valid without producing any output.
+$
+```
+
+## Library Usage
+
+[Detailed API documenation](https://rubydoc.info/gems/semverify/) is hosted on rubygems.org.
+
+The main classes are:
+
+* **Semverify::Semver**: Parse and compare generic semver version strings. See
+  [semver.org](https://semver.org) for details on what makes a valid semver string.
+
+* **Semverify::IncrementableSemver**: Extends the Semverify::Semver class that knows
+  how to increment (aka bump) parts of the version string (major, minor, patch,
+  pre-release). Some additional restrictions are put onto the pre-release part
+  so that the pre-release part of the version can be incremented.
+
+* **Semverify::VersionFileFactory**: find the gem's version file and returns a
+  **Semverify::VersionFile** that knows it's path, the contained version, and how to update
+  the version file with a new version.
+
+## 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/main-branch/semverify.
+
+## 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,85 @@
+# frozen_string_literal: true
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+end
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLEAN << 'Gemfile.lock'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do
+  if RUBY_PLATFORM == 'java'
+    ENV['JAVA_OPTS'] = '-Djdk.io.File.enableADS=true'
+    ENV['JRUBY_OPTS'] = '--debug'
+    ENV['NOCOV'] = 'TRUE'
+  end
+end
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+unless RUBY_PLATFORM == 'java'
+  # YARD
+
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # Yardstick
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # Yardstick coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
+end

data/exe/semverify

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'semverify'
+
+Semverify::CommandLine.start(ARGV)