version_gem 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2743c035006592c0f69c6aadd90a0b92f6117e7dff255e904caaa49c188505c
-  data.tar.gz: 954c7f45ccfa74232e9e87d9f772aef5fad889283bdde78c9aa4321b49149b41
+  metadata.gz: 617f64c21f615e873f17b3774d4cc1e156d10f276c670f7f84308b2fd0853d75
+  data.tar.gz: '082c40a241be990945f0f4c9939419b5aa49c632bc1ff77e2ab9459736855519'
 SHA512:
-  metadata.gz: a7abd21eb351d7f7654583ce7c07df67f95b6f930c5ad308f7b4167f2955b441b9533a73329fc8c487f1692d654c8144cb9fd98faa637c4cb0a6fa30d08312e3
-  data.tar.gz: 73b702bfa29ddd6595bfe434acbb6612c7cbaa3ed40d2bb507fd9f25a69bfd6607383436267fe60406d58762ba3dfa6eb381f4ddca85fe210e6e7cade6314867
+  metadata.gz: 396d61f301aac49502dcef070dcbca71343b9e1532062e8b5c90b2dfbb1d2bd63d714ea8261c76bcbb2048c49de2810742cfba8235b048b7c958dc567f57da66
+  data.tar.gz: 2f8a9fabf0e1388528fc25ee8e6372c9347413acb3ad31726a831b768c49df2da5f493de4f290039d4afb4248855e1a963967abd835151271db11f3193124df0

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-    # Changelog
+# Changelog
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,29 +6,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-
 ### Changed
-
 ### Fixed
-
 ### Removed
 
-## [1.0.2] - 2022-06-23
+## [1.1.1] - 2022-09-19 ([tag][1.1.1t])
+### Added
+- Alternatives section to README.md (@pboling)
+- Signing cert for gem releases (@pboling)
+- Mailing List and other metadata URIs (@pboling)
+- Checksums for released gems (@pboling)
+### Changed
+- SECURITY.md policy (@pboling)
+- Version methods are now memoized (||=) on initial call for performance (@pboling)
+- Gem releases are now cryptographically signed (@pboling)
+
+## [1.1.0] - 2022-06-24 ([tag][1.1.0t])
+### Fixed
+- to_a uses same type casting as major, minor, patch, and pre (@pboling)
 ### Added
-- Delay loading of library code until after code coverage tool is loaded
+- RSpec Matchers and Shared Example (@pboling)
 
-## [1.0.1] - 2022-06-23
+## [1.0.2] - 2022-06-23 ([tag][1.0.2t])
 ### Added
-- CI Build improvements
-- Code coverage reporting
-- Documentation improvements
-- Badges!
+- Delay loading of library code until after code coverage tool is loaded (@pboling)
 
-## [1.0.0] - 2022-06-21
+## [1.0.1] - 2022-06-23 ([tag][1.0.1t])
 ### Added
-- Initial release, with basic version parsing API
+- CI Build improvements (@pboling)
+- Code coverage reporting (@pboling)
+- Documentation improvements (@pboling)
+- Badges! (@pboling)
 
-[Unreleased]: https://github.com/pboling/version_gem/compare/v1.0.2...HEAD
-[1.0.2]: https://github.com/pboling/version_gem/compare/v1.0.1...v1.0.2
-[1.0.1]: https://github.com/pboling/version_gem/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/pboling/version_gem/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
+## [1.0.0] - 2022-06-21 ([tag][1.0.0t])
+### Added
+- Initial release, with basic version parsing API (@pboling)
+
+[Unreleased]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.1...HEAD
+[1.1.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.0...v1.1.1
+[1.1.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.1
+[1.1.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.2...v1.1.0
+[1.1.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.0
+[1.0.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.1...v1.0.2
+[1.0.2t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.2
+[1.0.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.0...v1.0.1
+[1.0.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.1
+[1.0.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
+[1.0.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.0

data/README.md

@@ -1,6 +1,21 @@
 # VersionGem
 
-Give your next library an introspectable `Version` module.
+## Alternatives
+
+This gem has a very niche purpose, which is:
+
+1. providing introspection of a `Version` module based on a `Version::VERSION` constant string,
+2. while not interfering with `gemspec` parsing where the `VERSION` string is traditionally used.
+
+If this isn't **precisely** your use case you may be better off looking at
+[`Versionaire`](https://www.alchemists.io/projects/versionaire), a wonderful, performant, well-maintained,
+gem from the Alchemists.
+
+For more discussion about this [see issue #2](https://github.com/pboling/version_gem/issues/2)
+
+## Still here?
+
+Give your next library an introspectable `Version` module without breaking your Gemspec.
 
 ```ruby
 MyLib::Version.to_s # => "1.2.3.rc3"
@@ -40,7 +55,7 @@ badge #s:
 📗
 
 appended indicators:
-♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
+♻️ - URL needs to be updated from SAAS integration. Find / Replace is insufficient.
 -->
 
 |     | Project                        | bundle add version_gem                                                                                                                                                                                                                                                                        |
@@ -86,8 +101,8 @@ The link tokens in the following sections should be kept ordered by the row and
 [⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/b504d61c4ed1d46aec02/maintainability
 [🖇triage-help]: https://www.codetriage.com/pboling/version_gem
 [🖇triage-help-img]: https://www.codetriage.com/pboling/version_gem/badges/users.svg
-[🏘depfu♻️]: https://depfu.com/github/pboling/version_gem?project_id=34924
-[🏘depfu-img♻️]: https://badges.depfu.com/badges/300630ab4b7c2efea20806d13d1ef41f/count.svg
+[🏘depfu♻️]: https://depfu.com/github/pboling/version_gem?project_id=35803
+[🏘depfu-img♻️]: https://badges.depfu.com/badges/5d8943de6cfdf1ee048ad6d907f3e35b/count.svg
 [🚎contributors]: https://github.com/pboling/version_gem/graphs/contributors
 [🚎contributors-img]: https://img.shields.io/github/contributors-anon/pboling/version_gem
 [🖐style-wf]: https://github.com/pboling/version_gem/actions/workflows/style.yml
@@ -219,6 +234,37 @@ This design keeps your `version.rb` file compatible with the way `gemspec` files
 This means that the introspection is _not_ available within the gemspec.
 The enhancement from this gem is only available at runtime.
 
+### RSpec Matchers
+
+In `spec_helper.rb`:
+```ruby
+require 'version_gem/rspec'
+```
+
+Then you can write a test like:
+
+```ruby
+RSpec.describe MyLib::Version do
+  it_behaves_like 'a Version module', described_class
+end
+
+# Or, if you want to write your own, here is the a la carte menu:
+RSpec.describe MyLib::Version do
+  it "is a Version module" do
+    expect(described_class).is_a?(Module)
+    expect(described_class).to have_version_constant
+    expect(described_class).to have_version_as_string
+    expect(described_class.to_s).to be_a(String)
+    expect(described_class).to have_major_as_integer
+    expect(described_class).to have_minor_as_integer
+    expect(described_class).to have_patch_as_integer
+    expect(described_class).to have_pre_as_nil_or_string
+    expect(described_class.to_h.keys).to match_array(%i[major minor patch pre])
+    expect(described_class.to_a).to be_a(Array)
+  end
+end
+```
+
 ## 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.
@@ -227,8 +273,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-## Contributing
-
 See [CONTRIBUTING.md][contributing]
 
 ## Contributors
@@ -262,7 +306,7 @@ the [Pessimistic Version Constraint][pvc] with two digits of precision.
 For example:
 
 ```ruby
-spec.add_dependency "version_gem", "~> 1.0"
+spec.add_dependency "version_gem", "~> 1.1"
 ```
 
 ## Security
@@ -287,10 +331,6 @@ See [SECURITY.md](https://github.com/pboling/version_gem/blob/main/SECURITY.md).
 
 [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
 
-[railsbling]: http://www.railsbling.com
-
-[peterboling]: http://www.peterboling.com
-
 [aboutme]: https://about.me/peter.boling
 
 [angelme]: https://angel.co/peter-boling

data/SECURITY.md

@@ -2,9 +2,9 @@
 
 ## Supported Versions
 
-| Version      | Supported |
-|--------------|-----------|
-| 1.0.<latest> | ✅         |
+| Version  | Supported |
+|----------|-----------|
+| 1.latest | ✅         |
 
 ## Reporting a Vulnerability
 

data/lib/version_gem/api.rb

@@ -11,35 +11,35 @@ module VersionGem
     #
     # @return [Integer]
     def major
-      to_a[0].to_i
+      @major ||= _to_a[0].to_i
     end
 
     # The minor version
     #
     # @return [Integer]
     def minor
-      to_a[1].to_i
+      @minor ||= _to_a[1].to_i
     end
 
     # The patch version
     #
     # @return [Integer]
     def patch
-      to_a[2].to_i
+      @patch ||= _to_a[2].to_i
     end
 
     # The pre-release version, if any
     #
     # @return [String, NilClass]
     def pre
-      to_a[3]
+      @pre ||= _to_a[3]
     end
 
     # The version number as a hash
     #
     # @return [Hash]
     def to_h
-      {
+      @to_h ||= {
         major: major,
         minor: minor,
         patch: patch,
@@ -47,11 +47,20 @@ module VersionGem
       }
     end
 
-    # The version number as an array
+    # The version number as an array of cast values
     #
-    # @return [Array]
+    # @return [Array<[Integer, String, NilClass]>]
     def to_a
-      self::VERSION.split('.')
+      @to_a ||= [major, minor, patch, pre]
+    end
+
+    private
+
+    # The version number as an array of strings
+    #
+    # @return [Array<String>]
+    def _to_a
+      @_to_a = self::VERSION.split('.')
     end
   end
 end

data/lib/version_gem/rspec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_version_constant do
+  match do |version_mod|
+    version_mod.const_defined?(:VERSION, false)
+  end
+end
+
+RSpec::Matchers.define :have_version_as_string do
+  match do |version_mod|
+    !version_mod::VERSION.nil? && version_mod::VERSION.is_a?(String)
+  end
+end
+
+RSpec::Matchers.define :have_major_as_integer do
+  match do |version_mod|
+    version_mod.major.is_a?(Integer)
+  end
+end
+
+RSpec::Matchers.define :have_minor_as_integer do
+  match do |version_mod|
+    version_mod.minor.is_a?(Integer)
+  end
+end
+
+RSpec::Matchers.define :have_patch_as_integer do
+  match do |version_mod|
+    version_mod.patch.is_a?(Integer)
+  end
+end
+
+RSpec::Matchers.define :have_pre_as_nil_or_string do
+  match do |version_mod|
+    version_mod.pre.nil? || version_mod.pre.is_a?(String)
+  end
+end
+
+RSpec.shared_examples_for 'a Version module' do |version_mod|
+  it 'is introspectable' do
+    aggregate_failures 'introspectable api' do
+      expect(version_mod).is_a?(Module)
+      expect(version_mod).to have_version_constant
+      expect(version_mod).to have_version_as_string
+      expect(version_mod.to_s).to be_a(String)
+      expect(version_mod).to have_major_as_integer
+      expect(version_mod).to have_minor_as_integer
+      expect(version_mod).to have_patch_as_integer
+      expect(version_mod).to have_pre_as_nil_or_string
+      expect(version_mod.to_h.keys).to match_array(%i[major minor patch pre])
+      expect(version_mod.to_a).to be_a(Array)
+    end
+  end
+end

data/lib/version_gem/version.rb

@@ -2,7 +2,7 @@
 
 module VersionGem
   module Version
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.1.1'.freeze
     # This would work in this gem, but not in external libraries,
     #   because version files are loaded in Gemspecs before bundler
     #   has a chance to load dependencies.

metadata

@@ -1,14 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: version_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Peter Boling
-autorequire: 
-bindir: exe
-cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+  ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0yMjA5MTgyMzEyMzBaFw0yMzA5MTgyMzEyMzBaMEMxFTATBgNVBAMM
+  DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA2Dn1GM3W
+  8K2/rvN1zz+06bQMcxD16ZKTihVwi7Pb1v3T98rM4Omnxohm3s+CwpDWGeiB9pj6
+  0I/CTce0e4e3s8GKJSOrg93veImPSoH2PfsMsRsuB8wtqyiOCjLbF5o6S29x87r0
+  LA5EawH+Lh4xqrkkPjdffsmLk7TaCig/vlmNvnzxXKBdey/X/aEJZXzzBiWRfVdh
+  O1fmMbVKyieGv9HK7+pLotIoT08bjDv8NP6V7zZslwQRqW27bQc6cqC2LGIbTYO3
+  3jt1kQxfMWmhOictS6SzG9VtKSrXf0L4Neq0Gh7CLBZBvJFWJYZPfb92YNITDbd8
+  emPOAQlXXNMN4mMXsEqtEhCPZRMnmwO+fOk/cC4AyglKi9lnQugCQoFV1XDMZST/
+  CYbzdQyadOdPDInTntG6V+Uw51d2QGXZ6PDDfrx9+toc/3sl5h68rCUGgE6Q3jPz
+  srinqmBsxv2vTpmd4FjmiAtEnwH5/ooLpQYL8UdAjEoeysxS3AwIh+5dAgMBAAGj
+  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQWU6D156a2cle+
+  lb5RBfvVXlxTwjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+  A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+  ggGBAJ4SqhPlgUiLYIrphGXIaxXScHyvx4kixuvdrwhI4VoQV2qXvO7R6ZjOXVwX
+  f/z84BWPiTZ8lzThPbt1UV/BGwkvLw9I4RjOdzvUz3J42j9Ly6q63isall07bo3F
+  QWe/OBvIMBF1IbjC3q5vKPg4rq8+TkNRJNoE86U2gfR+PkW3jYYs9uiy0GloHDCP
+  k5xgaj0vSL0Uy5mTOPdk3K6a/sUGZyYniWK05zdhIi956ynhfGaFO988FFdVw5Jq
+  LHtXfIpAU8F7ES04syZSslxOluw7VlcSKyRdVIr737J92ZTduppB4PRGSKRgBsWV
+  hXTahRE72Kyw53Q7FAuzF3v102WxAAQ7BuMjW+MyCUT75fwPm3W4ELPL8HYkNGE7
+  2oA5CPghFitRnvYS3GNrDG+9bNiRMEskeaBYwZ9UgReBQIwGYVj7LZk3UhiAsn44
+  gwGrEXGQGDZ0NIgBcmvMOqlXjkGQwQvugKycJ024z89+fz2332vdZIKTrSxJrXGk
+  4/bR9A==
+  -----END CERTIFICATE-----
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -103,6 +131,7 @@ dependencies:
 description: Versions are good. Versions are cool. Versions will win.
 email:
 - peter.boling@gmail.com
+- oauth-ruby@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -117,20 +146,22 @@ files:
 - lib/version_gem/api.rb
 - lib/version_gem/basic.rb
 - lib/version_gem/error.rb
+- lib/version_gem/rspec.rb
 - lib/version_gem/version.rb
-- sig/version_gem.rbs
-homepage: https://github.com/pboling/version_gem
+homepage: https://gitlab.com/oauth-xx/version_gem
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/pboling/version_gem
-  source_code_uri: https://github.com/pboling/version_gem/tree/v1.0.2
-  changelog_uri: https://github.com/pboling/version_gem/blob/v1.0.2/CHANGELOG.md
-  bug_tracker_uri: https://github.com/pboling/version_gem/issues
-  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.0.2
-  wiki_uri: https://github.com/pboling/version_gem/wiki
+  homepage_uri: https://gitlab.com/oauth-xx/version_gem
+  source_code_uri: https://gitlab.com/oauth-xx/version_gem/-/tree/v1.1.1
+  changelog_uri: https://gitlab.com/oauth-xx/version_gem/-/blob/v1.1.1/CHANGELOG.md
+  bug_tracker_uri: https://gitlab.com/oauth-xx/version_gem/-/issues
+  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.1
+  wiki_uri: https://gitlab.com/oauth-xx/version_gem/-/wiki
+  mailing_list_uri: https://groups.google.com/g/oauth-ruby
+  funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
-signing_key: 
+rubygems_version: 3.3.20
+signing_key:
 specification_version: 4
 summary: Enhance your VERSION! Sugar for Version modules.
 test_files: []

metadata.gz.sig

@@ -0,0 +1 @@
+$M�B��|G*��屽EM�.|.�X�0�m�,��{�s�p���Œ��d��J��XM)}-�P��	�q;�64��;z���%\�"�x��P�±�d6�I����X5�N�]-���.B�$�F���f*}���S8#�w��\3ũ4�A$���T�WM�>��:Q(�t�]�A�E��P�F�&oX���4�t{�sG�

data/sig/version_gem.rbs

@@ -1,4 +0,0 @@
-module VersionGem
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end