version_gem 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d64ccd004d84d985193814b22b94eb0131e7d3de5d4414a775a82343ac3b88bb
+  data.tar.gz: b99052895d88af63e8d5e217ca18d0161b8edca03ee4cd17e3a07cd2a8e8e3a5
+SHA512:
+  metadata.gz: d5ef0dac07a5548b9e6fd0f21eacfd16443acb196ad9c8f3fce45f851f74129fd2a30de5674bcebcb97ed73efc0d0cc0c71fd8b42a71d5d18a50282e33604d38
+  data.tar.gz: c96480d2fcd3d8b0b0c3566a967a8f7dd197558301eb4075e6ad525eb179871f7f97256e65785b06ef5587f0229adcd8339ca9bee048908a2c6ed4d593439c5b

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+    # 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/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+
+### Changed
+
+### Fixed
+
+### Removed
+
+s## [1.0.0] - 2022-06-21
+### Added
+- Initial release, with basic version parsing API
+
+[Unreleased]: https://github.com/pboling/version_gem/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/pboling/version_gem/compare/a3055964517c159bf214712940982034b75264be...v1.0.0

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 peter.boling@gmail.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/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/pboling/version_gem][source]
+. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct][conduct].
+
+To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request!
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=pboling/version_gem)][contributors]
+
+Made with [contributors-img][contrib-rocks].
+
+[comment]: <> (Following links are used by README, CONTRIBUTING)
+
+[conduct]: https://github.com/pboling/version_gem/blob/main/CODE_OF_CONDUCT.md
+
+[contrib-rocks]: https://contrib.rocks
+
+[contributors]: https://github.com/pboling/version_gem/graphs/contributors
+
+[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
+
+[source]: https://github.com/pboling/version_gem

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Peter Boling
+
+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,94 @@
+# VersionGem
+
+Give your next library an introspectable `Version` module.
+
+```ruby
+MyLib::Version.to_s # => "1.2.3.rc3"
+MyLib::Version.major # => 1
+MyLib::Version.minor # => 2
+MyLib::Version.patch # => 3
+MyLib::Version.pre # => "rc3"
+MyLib::Version.to_a # => [1, 2, 3, "rc3"]
+MyLib::Version.to_h # => { major: 1, minor: 2, patch: 3, pre: "rc3" }
+```
+
+This library was extracted from the gem [`oauth2`](https://github.com/oauth-xx/oauth2).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add version_gem
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install version_gem
+
+## Usage
+
+In the standard `bundle gem my_lib` code you get the following in `lib/my_lib/version.rb:
+
+```ruby
+module MyLib
+  VERSION = "0.1.0"
+end
+```
+
+Add a Version namespace (the one implied by the path => namespace convention):
+
+```ruby
+module MyLib
+  module Version
+    VERSION = "0.1.0"
+  end
+end
+```
+
+Now add the following near the top of the file the manages requiring external libraries.
+Using the same example of `bundle gem my_lib`, this would be `lib/my_lib.rb`.
+
+```ruby
+require "version_gem"
+```
+
+Then, add the following wherever you want in the same file (recommend the bottom).
+
+```ruby
+MyLib::Version.class_eval do
+  extend VersionGem::Basic
+end
+```
+
+And now you have some version introspection methods available:
+
+```ruby
+MyLib::Version.to_s # => "0.1.0"
+MyLib::Version.major # => 0
+MyLib::Version.minor # => 1
+MyLib::Version.patch # => 0
+MyLib::Version.pre # => ""
+MyLib::Version.to_a # => [0, 1, 0]
+MyLib::Version.to_h # => { major: 0, minor: 1, patch: 0, pre: "" }
+```
+
+### Side benefit
+
+Your `version.rb` file now abides the Ruby convention of directory / path matching the namespace / class!
+
+## 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/pboling/version_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pboling/version_gem/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the VersionGem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pboling/version_gem/blob/main/CODE_OF_CONDUCT.md).

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version      | Supported |
+|--------------|-----------|
+| 1.0.<latest> | ✅         |
+
+## Reporting a Vulnerability
+
+Peter Boling is the primary maintainer of this gem. Please find a way
+to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
+possible.

data/lib/version_gem/api.rb

@@ -0,0 +1,57 @@
+module VersionGem
+  module Api
+    # The version number as a string
+    #
+    # @return [String]
+    def to_s
+      self::VERSION
+    end
+
+    # The major version
+    #
+    # @return [Integer]
+    def major
+      to_a[0].to_i
+    end
+
+    # The minor version
+    #
+    # @return [Integer]
+    def minor
+      to_a[1].to_i
+    end
+
+    # The patch version
+    #
+    # @return [Integer]
+    def patch
+      to_a[2].to_i
+    end
+
+    # The pre-release version, if any
+    #
+    # @return [String, NilClass]
+    def pre
+      to_a[3]
+    end
+
+    # The version number as a hash
+    #
+    # @return [Hash]
+    def to_h
+      {
+        major: major,
+        minor: minor,
+        patch: patch,
+        pre: pre
+      }
+    end
+
+    # The version number as an array
+    #
+    # @return [Array]
+    def to_a
+      self::VERSION.split('.')
+    end
+  end
+end

data/lib/version_gem/basic.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+require_relative 'api'
+
+module VersionGem
+  # This is a very *basic* version parser. Others could be built based on this pattern!
+  module Basic
+    def self.extended(base)
+      raise Error, "VERSION must be defined before 'extend #{name}'" unless defined?(base::VERSION)
+
+      base.extend Api
+    end
+  end
+end

data/lib/version_gem/error.rb

@@ -0,0 +1,3 @@
+module VersionGem
+  class Error < RuntimeError; end
+end

data/lib/version_gem/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'basic'
+
+module VersionGem
+  module Version
+    VERSION = '1.0.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.
+    # Instead, see lib/version_gem.rb for a solution that will work everywhere
+    # extend VersionGem::Basic
+  end
+end

data/lib/version_gem.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'version_gem/version'
+
+module VersionGem
+end
+
+VersionGem::Version.class_eval do
+  extend VersionGem::Basic
+end

data/sig/version_gem.rbs

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

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: version_gem
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-lts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Versions are good. Versions are cool. Versions will win.
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- SECURITY.md
+- lib/version_gem.rb
+- lib/version_gem/api.rb
+- lib/version_gem/basic.rb
+- lib/version_gem/error.rb
+- lib/version_gem/version.rb
+- sig/version_gem.rbs
+homepage: https://github.com/pboling/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.0
+  changelog_uri: https://github.com/pboling/version_gem/blob/v1.0.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/pboling/version_gem/issues
+  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.0.0
+  wiki_uri: https://github.com/pboling/version_gem/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key: 
+specification_version: 4
+summary: Enhance your VERSION! Sugar for Version modules.
+test_files: []