semverify 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf302b5c8e8ab6b9be87ddb70378f18f245e7b7d43afb5d376615223e616b43
-  data.tar.gz: e50594d56243014bddef3e9f14beb080d9c6f92f9dad19a6fdc9ccb9932ed1ab
+  metadata.gz: 70523fa457e6370bd31c6e0ac31d47c7a145670e3d3c3a521161aa4f931df504
+  data.tar.gz: 3f8b105ee8359ecd413ae649f5571d471f7abfcd466fe2a4b4114ca02f76da9a
 SHA512:
-  metadata.gz: 4d87143ccec81e7f12c4bb4d290deab89bd22436475156ac723966b0c3238bfe41af8e1c29693e503c1b20d5f7ea49fcb0be5428f02f519af5b1fe93dcbb00bd
-  data.tar.gz: 1c1522952aa2c6204f9f93198104e49054786b84cad71a57fcce50dfc7a6ecea53dd68e3f1c6868e45f4428923c8a1224357b9ba40a3a2583b7acf6bf7012bed
+  metadata.gz: c1edf2e300a7b7121cadefcacf8bcc0ec37ff2c8ad91042524c96e28204eaf3f696a5a6b736c3c33cedaf9108e20667d278d5eb55c09278f58cc4181014166f1
+  data.tar.gz: cf5ea76b244214a159036db34b0e0f4b1234acb5dcb49d50c52d115bf9867bc325ffaac056debf222e11821df3003366f1e952d8897af9a3efa25110140e6c0d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.3.2 (2024-01-11)
+
+[Full Changelog](https://github.com/main-branch/semverify/compare/v0.3.1..v0.3.2)
+
+Changes since v0.3.1:
+
+* 91c3780 Update README and gemspec introduction text (#19)
+
 ## v0.3.1 (2024-01-05)
 
 [Full Changelog](https://github.com/main-branch/semverify/compare/v0.3.0..v0.3.1)

data/README.md

@@ -7,30 +7,59 @@
 [![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.
+Parse, compare, and increment RubyGem versions.
 
-Can be used as an alternative to the [bump RubyGem](https://rubygems.org/gems/bump/).
+This gem installs the `semverify` CLI tool to display and increment a gem's version
+based on SemVer rules. This tool can replace the `bump` command from the
+[bump gem](https://rubygems.org/gems/bump/) for incrementing gem version strings.
 
-* [Semverify](#semverify)
-  * [Installation](#installation)
-  * [Command Line Usage](#command-line-usage)
-  * [Library Usage](#library-usage)
-  * [Development](#development)
-  * [Contributing](#contributing)
-  * [License](#license)
+This gem also provides the `Semverify::Semver` class which knows how to parse,
+validate, and compare [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) version
+strings.
+
+Both the CLI tool and the library code support prerelease versions and versions
+with build metadata.
+
+Example CLI commands:
+
+```bash
+# Increment the gem version
+semverify {next-major|next-minor|next-patch} [--pre [--pretype=TYPE]] [--build=METADATA] [--dryrun]
+semverify next-pre [--pretype=TYPE] [--build=METADATA] [--dryrun]
+semverify next-release [--build=METADATA] [--dryrun]
+
+# Command to display the current gem version
+semverify current
+
+# Display the gem version file
+semverify file
+
+# Validate that a version conforms to SemVer 2.0.0
+semverify validate VERSION
+
+# Get more detailed help for each command listed above
+semverify help [COMMAND]
+```
+
+* [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
+bundle add semverify
 ```
 
 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
+gem install semverify
 ```
 
 ## Command Line Usage

data/lib/semverify/command_line.rb

@@ -85,7 +85,7 @@ module Semverify
       --pre can be used to specify that the version should be incremented AND
       given a pre-release part. For instance:
 
-      /x5 $ semverify next-major --pre
+      $ semverify next-major --pre
 
       increments '1.2.3' to '2.0.0-pre.1'.
 
@@ -93,7 +93,7 @@ module Semverify
       --pre to specify a different pre-release type such as alpha, beta, rc, etc.
       For instance:
 
-      /x5 $ semverify next-major --pre --pre-type=alpha
+      $ semverify next-major --pre --pre-type=alpha
 
       increments '1.2.3' to '2.0.0-alpha.1'.
 
@@ -144,7 +144,7 @@ module Semverify
       --pre can be used to specify that the version should be incremented AND
       given a pre-release part. For instance:
 
-      /x5 $ semverify next-minor --pre
+      $ semverify next-minor --pre
 
       increments '1.2.3' to '2.0.0-pre.1'.
 
@@ -152,7 +152,7 @@ module Semverify
       --pre to specify a different pre-release type such as alpha, beta, rc, etc.
       For instance:
 
-      /x5 $ semverify next-patch --pre --pre-type=alpha
+      $ semverify next-patch --pre --pre-type=alpha
 
       increments '1.2.3' to '1.2.4-alpha.1'.
 
@@ -203,7 +203,7 @@ module Semverify
       --pre can be used to specify that the version should be incremented AND
       given a pre-release part. For instance:
 
-      /x5 $ semverify next-patch --pre
+      $ semverify next-patch --pre
 
       increments '1.2.3' to '1.2.4-pre.1'.
 
@@ -211,7 +211,7 @@ module Semverify
       --pre to specify a different pre-release type such as alpha, beta, rc, etc.
       For instance:
 
-      /x5 $ semverify next-patch --pre --pre-type=alpha
+      $ semverify next-patch --pre --pre-type=alpha
 
       increments '1.2.3' to '1.2.4-alpha.1'.
 
@@ -260,7 +260,7 @@ module Semverify
 
       By default, the existing pre-release type is preserved. For instance:
 
-      /x5 $ semverify next-pre
+      $ semverify next-pre
 
       Increments 1.2.3-alpha.1 to 1.2.3-alpha.2.
 
@@ -270,16 +270,16 @@ module Semverify
 
       For example, if the version starts as 1.2.3-alpha.4, then:
 
-      /x5 $ semverify current
-      /x5 1.2.3-alpha.4
-      /x5 $ semver next-pre --pre-type=beta
-      /x5 1.2.3-beta.1
-      /x5 $ semver next-pre --pre-type=beta
-      /x5 1.2.3-beta.2
-      /x5 $ semver next-pre --pre-type=rc
-      /x5 1.2.3-rc.1
-      /x5 $ semverify next-release
-      /x5 1.2.3
+      $ semverify current
+      1.2.3-alpha.4
+      $ semver next-pre --pre-type=beta
+      1.2.3-beta.1
+      $ semver next-pre --pre-type=beta
+      1.2.3-beta.2
+      $ semver next-pre --pre-type=rc
+      1.2.3-rc.1
+      $ semverify next-release
+      1.2.3
 
       The command fails if the existing pre-release type is not lexically less than or
       equal to TYPE. For example, it the current version is '1.2.3-beta.1' and the TYPE

data/lib/semverify/version.rb

@@ -2,5 +2,5 @@
 
 module Semverify
   # The current version of this gem
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/semverify.gemspec

@@ -8,8 +8,43 @@ Gem::Specification.new do |spec|
   spec.authors = ['James Couball']
   spec.email = ['jcouball@yahoo.com']
 
-  spec.summary = 'A Gem to parse and compare semver versions AND bump versions for Ruby Gems'
-  spec.description = spec.summary
+  spec.summary = 'A Gem to parse and compare SemVer versions AND increment versions for Ruby Gems'
+  spec.description = <<~DESC
+    Parse, compare, and increment RubyGem versions.
+
+    This gem installs the `semverify` CLI tool to display and increment a gem's version
+    based on SemVer rules. This tool can replace the `bump` command from the
+    [bump gem](https://rubygems.org/gems/bump/) for incrementing gem version strings.
+
+    This gem also provides the `Semverify::Semver` class which knows how to parse,
+    validate, and compare [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) version
+    strings.
+
+    Both the CLI tool and the library code support prerelease versions and versions
+    with build metadata.
+
+    Example CLI commands:
+
+    ```bash
+    # Increment the gem version
+    semverify {next-major|next-minor|next-patch} [--pre [--pretype=TYPE]] [--build=METADATA] [--dryrun]
+    semverify next-pre [--pretype=TYPE] [--build=METADATA] [--dryrun]
+    semverify next-release [--build=METADATA] [--dryrun]
+
+    # Command to display the current gem version
+    semverify current
+
+    # Display the gem version file
+    semverify file
+
+    # Validate that a version conforms to SemVer 2.0.0
+    semverify validate VERSION
+
+    # Get more detailed help for each command listed above
+    semverify help [COMMAND]
+    ```
+  DESC
+
   spec.homepage = 'http://github.com/main-branch/semverify'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.0.0'
@@ -32,13 +67,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'thor', '~> 1.2'
+  spec.add_runtime_dependency 'thor', '~> 1.3'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  spec.add_development_dependency 'create_github_release', '~> 1.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'create_github_release', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 13.1'
   spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.48'
+  spec.add_development_dependency 'rubocop', '~> 1.59'
   spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semverify
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.48'
+        version: '1.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.48'
+        version: '1.59'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,8 +170,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: A Gem to parse and compare semver versions AND bump versions for Ruby
-  Gems
+description: |
+  Parse, compare, and increment RubyGem versions.
+
+  This gem installs the `semverify` CLI tool to display and increment a gem's version
+  based on SemVer rules. This tool can replace the `bump` command from the
+  [bump gem](https://rubygems.org/gems/bump/) for incrementing gem version strings.
+
+  This gem also provides the `Semverify::Semver` class which knows how to parse,
+  validate, and compare [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) version
+  strings.
+
+  Both the CLI tool and the library code support prerelease versions and versions
+  with build metadata.
+
+  Example CLI commands:
+
+  ```bash
+  # Increment the gem version
+  semverify {next-major|next-minor|next-patch} [--pre [--pretype=TYPE]] [--build=METADATA] [--dryrun]
+  semverify next-pre [--pretype=TYPE] [--build=METADATA] [--dryrun]
+  semverify next-release [--build=METADATA] [--dryrun]
+
+  # Command to display the current gem version
+  semverify current
+
+  # Display the gem version file
+  semverify file
+
+  # Validate that a version conforms to SemVer 2.0.0
+  semverify validate VERSION
+
+  # Get more detailed help for each command listed above
+  semverify help [COMMAND]
+  ```
 email:
 - jcouball@yahoo.com
 executables:
@@ -211,8 +243,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: http://github.com/main-branch/semverify
   source_code_uri: http://github.com/main-branch/semverify
-  changelog_uri: https://rubydoc.info/gems/semverify/0.3.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/semverify/0.3.1
+  changelog_uri: https://rubydoc.info/gems/semverify/0.3.2/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/semverify/0.3.2
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -232,5 +264,6 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: A Gem to parse and compare semver versions AND bump versions for Ruby Gems
+summary: A Gem to parse and compare SemVer versions AND increment versions for Ruby
+  Gems
 test_files: []