version_gem 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2743c035006592c0f69c6aadd90a0b92f6117e7dff255e904caaa49c188505c
-  data.tar.gz: 954c7f45ccfa74232e9e87d9f772aef5fad889283bdde78c9aa4321b49149b41
+  metadata.gz: 21e250531f2630bae1d9b1961c58451b9bb25bcacff9e725ecfc8b58e5b23997
+  data.tar.gz: 236e288d1bc0ea792e86887555c716224e441448aae87b6a2d4e4f78d195c2d0
 SHA512:
-  metadata.gz: a7abd21eb351d7f7654583ce7c07df67f95b6f930c5ad308f7b4167f2955b441b9533a73329fc8c487f1692d654c8144cb9fd98faa637c4cb0a6fa30d08312e3
-  data.tar.gz: 73b702bfa29ddd6595bfe434acbb6612c7cbaa3ed40d2bb507fd9f25a69bfd6607383436267fe60406d58762ba3dfa6eb381f4ddca85fe210e6e7cade6314867
+  metadata.gz: 9dee2a6a560776eb93d8104fbe4e2c20e31a62172103972b94f636d1dd793d0c623674d78c31f8a21139167e4d09e48d292efd53d27a3de943349505e1d467f4
+  data.tar.gz: eecbc666ad24fd08d2516bc5c64b5ada2273fc153199dba97f089254eeb4fcefaa8d0e903832dae31c39108e1eb31301deb57c152b48f0c2f30e919558737266

data/CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [1.1.0] - 2022-06-24
+### Fixed
+- to_a uses same type casting as major, minor, patch, and pre
+### Added
+- RSpec Matchers and Shared Example
+
 ## [1.0.2] - 2022-06-23
 ### Added
 - Delay loading of library code until after code coverage tool is loaded
@@ -28,7 +34,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release, with basic version parsing API
 
-[Unreleased]: https://github.com/pboling/version_gem/compare/v1.0.2...HEAD
+[Unreleased]: https://github.com/pboling/version_gem/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/pboling/version_gem/compare/v1.0.2...v1.1.0
 [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

data/README.md

@@ -86,8 +86,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 +219,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 +258,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-## Contributing
-
 See [CONTRIBUTING.md][contributing]
 
 ## Contributors
@@ -262,7 +291,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

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,28 +11,28 @@ module VersionGem
     #
     # @return [Integer]
     def major
-      to_a[0].to_i
+      _to_a[0].to_i
     end
 
     # The minor version
     #
     # @return [Integer]
     def minor
-      to_a[1].to_i
+      _to_a[1].to_i
     end
 
     # The patch version
     #
     # @return [Integer]
     def patch
-      to_a[2].to_i
+      _to_a[2].to_i
     end
 
     # The pre-release version, if any
     #
     # @return [String, NilClass]
     def pre
-      to_a[3]
+      _to_a[3]
     end
 
     # The version number as a hash
@@ -47,10 +47,19 @@ 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
+      [major, minor, patch, pre]
+    end
+
+    private
+
+    # The version number as an array of strings
+    #
+    # @return [Array<String>]
+    def _to_a
       self::VERSION.split('.')
     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.0'.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,14 @@
 --- !ruby/object:Gem::Specification
 name: version_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -117,6 +117,7 @@ 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
@@ -124,10 +125,10 @@ 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
+  source_code_uri: https://github.com/pboling/version_gem/tree/v1.1.0
+  changelog_uri: https://github.com/pboling/version_gem/blob/v1.1.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/version_gem/issues
-  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.0.2
+  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.0
   wiki_uri: https://github.com/pboling/version_gem/wiki
   rubygems_mfa_required: 'true'
 post_install_message: