gem_enforcer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 259683929871f4f3ba6aabed1d4730837860fd2fe0c983f19baf735da1be2edc
+  data.tar.gz: 962e62bd2f891d48b4abf50efe0e44fbb4d43938ef745189c075c5753ca86faf
+SHA512:
+  metadata.gz: 86b8b4f2755007c7f1973c2dc844066b4060cc0eb1729906cdabcbd3ad91d17eed1274be1bc3c26a01d6c5459ed660cd547657409b25b844b45d7dc75919e8e0
+  data.tar.gz: debf1f1abd7668a5a36413ee1156b69bba9b0a8d0cb0f4bfd16801c5db74cb58d66e3175a5b1e92d21d1df216a8cebe7da9a0b3db996152aaafef450304d2a4d

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@1.0
+  node: circleci/node@2
+  cst: cst/framework@1
+
+workflows:
+  version: 2
+  yeet-le-jobs:
+    jobs:
+      - cst/enforce-gem-version-bump
+      - cst/rspec-ruby:
+          rspec-system-args: "SIMPLE_COV_RUN=true"
+          cc-report-collect-ruby: "3.2.5"
+          matrix:
+            parameters:
+              ruby-version: ["3.2.5", "3.3.5"]
+            alias: required-matrix-tests
+          name: test-ruby<< matrix.ruby-version >>
+      - cst/publish-gem:
+          publish-git: true
+          publish-default-gem: true
+          requires:
+            - required-matrix-tests
+          filters:
+            branches:
+              only:
+                - main

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt*
+/tmp/
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+# generated gems
+*.gem

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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]
+
+## [X.y.z] - YYYY-MM-DD
+
+### Added
+
+### Changed
+- Changed feature 1
+
+### Removed
+- Removed feature 1
+
+### Fixed
+- Bug fix 1
+
+[//]: # (Added, Changed, Removed, Fixed are the possible headers for each changlog version)

data/CODEOWNERS

@@ -0,0 +1 @@
+* @matt-taylor

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:3.2.5
+RUN cd /tmp && curl -L --output ghr.tar.gz https://github.com/tcnksm/ghr/releases/download/v0.12.0/ghr_v0.12.0_linux_amd64.tar.gz && \
+    tar -xzvf ghr.tar.gz && chmod +x ghr_v0.12.0_linux_amd64/ghr && mv ghr_v0.12.0_linux_amd64/ghr /usr/local/bin/ghr && rm -rf /tmp/*
+
+WORKDIR /gem
+COPY Gemfile /gem/Gemfile
+
+COPY gem_enforcer.gemspec /gem/gem_enforcer.gemspec
+COPY lib/gem_enforcer/version.rb /gem/lib/gem_enforcer/version.rb
+
+
+RUN gem update --system && gem install bundler && bundle install --jobs=3 --retry=3 && \
+    rm -rf /usr/local/bundle/cache
+
+COPY . /gem

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "faraday", "< 2.6"
+gem 'activesupport'
+gem 'faker'
+gem 'pry'
+gem 'rspec', '~> 3.0'
+gem 'rspec_junit_formatter'
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    gem_enforcer (0.0.1)
+      class_composer (>= 1.0)
+      faraday
+      octokit
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    byebug (11.1.3)
+    class_composer (1.0.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    faker (3.4.2)
+      i18n (>= 1.8.11, < 2)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.1.0)
+    minitest (5.25.1)
+    mutex_m (0.2.0)
+    octokit (9.1.0)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (6.0.1)
+    rake (12.3.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.0)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  aarch64-linux
+  ruby
+
+DEPENDENCIES
+  activesupport
+  faker
+  faraday (< 2.6)
+  gem_enforcer!
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  simplecov
+
+BUNDLED WITH
+   2.5.18

data/Makefile

@@ -0,0 +1,21 @@
+.PHONY: bash build bundle rspec
+
+APP_NAME?=gem_enforcer
+
+build: #: Build the containers that we'll need
+	docker-compose build --pull
+
+bash: #: Get a bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=development $(APP_NAME) bash
+
+bash_test: #: Get a test bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=test $(APP_NAME) bash
+
+down: #: Bring down the service -- Destroys everything in redis and all containers
+	docker-compose down
+
+clean: #: Clean up stopped/exited containers
+	docker-compose rm -f
+
+bundle: #: install gems for Dummy App with
+	docker-compose run --rm $(APP_NAME) bundle install

data/README.md

@@ -0,0 +1,33 @@
+# GemEnforcer
+
+`GemEnforcer` is
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gem_enforcer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gem_enforcer
+
+
+## Development
+
+This gem can be developed against local machine or while using docker. Simpleified Docker commands can be found in the `Makefile` or execute `make help`
+
+## Contributing
+
+This gem welcomes contribution.
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/matt-taylor/json_schematize.
+
+

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem_enforcer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier.
+
+require "pry"
+GemEnforcer::Setup.validate_yml!
+Pry.start

data/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  gem_enforcer:
+    command: tail -f /dev/null
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    volumes:
+      - .:/gem
+      - ..:/local
+      - bundle-cache:/usr/local/bundle:delegated
+    environment:
+      GITHUB_TOKEN: ${GITHUB_TOKEN}
+
+volumes:
+  bundle-cache:

data/gem_enforcer.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/gem_enforcer/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "gem_enforcer"
+  spec.version = GemEnforcer::VERSION
+  spec.authors = ["Matt Taylor"]
+  spec.email   = ["mattius.taylor@gmail.com"]
+
+  spec.summary     = "Long form of the description"
+  spec.description = "Provide the ability to validate targetted gems are up to date before executing commands"
+  spec.homepage    = "https://github.com/matt-taylor/gem_enforcer"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2")
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "class_composer", ">= 1.0"
+  spec.add_dependency "faraday"
+  spec.add_dependency "octokit"
+
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+end

data/gem_enforcer.yml

@@ -0,0 +1,61 @@
+---
+invalid_config:
+  log_level: error
+  behavior: exit
+gems:
+  rails:
+    on_failure:
+      log_level: warn # on failure, log a warn message
+      behavior: exit
+    version_threshold:
+      minor: 3 # within the last 3 minor releases
+    server: true # when set to true, defaults to https://rubygems.org
+
+  shoryuken:
+    on_failure:
+      log_level: info # on failure, log a info message
+      behavior: skip
+    version_threshold:
+      # Must be within the most current version released
+      # If above is true, must be within the last 2 minor releases
+      # If above is true, must be within the last 3 patches released
+      major: 0 # within the current major version
+      minor: 2 # within the last 3 minor releases
+      patch: 3 # within the last 3 patches released
+    server: true # when set to true, defaults to https://rubygems.org
+
+  redis:
+    on_failure:
+      log_level: error
+      behavior: raise # on failure, log error and exit(1)
+    enforce_insync: true # Ensure gem is up to date
+    server:
+      source: https://rubygems.org
+
+  faraday:
+    on_failure:
+      log_level: error
+      behavior: exit # on failure, log error and exit(1)
+    enforce_insync: true
+    # version_threshold:
+
+      # For most gems, this is effectively the same as `enforce_insync: true`
+      # major: 0
+      # minor: 6
+      # patch: 0
+    server:
+      source: https://rubygems.org
+
+  custom_gem:
+    enforce_insync: true
+    server: true
+  sidekiq:
+    version_threshold:
+      releases: 5 # within the last 5 releases
+    git:
+      owner: sidekiq # Github root page for the gem
+
+
+
+
+

data/lib/gem_enforcer/configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "class_composer"
+require "logger"
+require "gem_enforcer/errors"
+
+module GemEnforcer
+  class Configuration
+    include ClassComposer::Generator
+
+    GITHUB_ACCESS_TOKEN = Proc.new do
+      token = ENV.fetch("GITHUB_TOKEN") do
+        ENV.fetch("BUNDLE_GITHUB__COM") do
+          raise GemEnforcer::Error, "Expected access token in `GITHUB_TOKEN` or `BUNDLE_GITHUB__COM`"
+        end
+      end
+      if token.end_with?(":x-oauth-basic")
+        token.split(":x-oauth-basic")[0]
+      else
+        token
+      end
+    end
+
+    DEFAULT_YAML_PATH = Proc.new do
+      if defined?(Rails)
+        "#{Rails.root}/config/gem_enforcer.yml"
+      else
+        "/gem/gem_enforcer.yml"
+      end
+    end
+
+    add_composer :github_access_token, allowed: String, default: GITHUB_ACCESS_TOKEN.()
+    add_composer :yml_config_path, allowed: String, default: DEFAULT_YAML_PATH.()
+    add_composer :raise_on_invalid_config, allowed: [TrueClass, FalseClass], default: true
+    add_composer :logger, allowed: [Logger, (TTY::Logger if defined?(TTY::Logger))].compact, default: Logger.new(STDOUT)
+  end
+end

data/lib/gem_enforcer/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module GemEnforcer
+  class Error < StandardError; end
+  class ValidationError < Error; end
+end

data/lib/gem_enforcer/retrieve/gem_server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module GemEnforcer
+  module Retrieve
+    class GemServer
+      def initialize(source: DEFAULT_SOURCE)
+        @source = source
+      end
+
+      def gem_versions(name:)
+        raw_gem_versions = raw_server_versions.select { _1.match?(/^#{name} /) }
+        return [] if raw_gem_versions.nil? || raw_gem_versions.empty?
+
+        versions = raw_gem_versions.map do |metadata|
+          raw_name, raw_version_list, _sha = metadata.split(" ")
+          next if raw_name != name
+
+          raw_version_list.split(",").map { Gem::Version.new(_1) }
+        end.flatten.compact.uniq
+
+        versions
+      end
+
+      # expensive call .. do this once gem source
+      def raw_server_versions
+        @server_versions ||= begin
+          api_call = Faraday.new(url: @source).get("versions")
+          api_call.body.split("\n")
+        end
+      end
+    end
+  end
+end

data/lib/gem_enforcer/retrieve/git_tag.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "octokit"
+
+module GemEnforcer
+  module Retrieve
+    class GitTag
+      def initialize(owner:, access_token: GemEnforcer.github_access_token)
+        @access_token = access_token
+        @owner = owner
+      end
+
+      def gem_versions(name:)
+        repo_name = "#{@owner}/#{name}"
+        releases = client.releases(repo_name, { per_page: 50 })
+        while next_page_href = client.last_response.rels[:next]&.href
+          releases.concat(client.get(next_page_href, { per_page: 50 }))
+        end
+
+        releases.map { Gem::Version.new(_1.tag_name.gsub(/.*?(?=\d*\.)/im, "")) }.compact
+      end
+
+      def client
+        @client ||= ::Octokit::Client.new(access_token: @access_token)
+      end
+    end
+  end
+end

data/lib/gem_enforcer/retrieve.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "gem_enforcer/retrieve/gem_server"
+require "gem_enforcer/retrieve/git_tag"
+
+module GemEnforcer
+  module Retrieve
+    module_function
+
+    def server_retrieval_by_source(source:)
+      @server_retrieval_by_source ||= {}
+
+      return @server_retrieval_by_source[source] if @server_retrieval_by_source[source]
+
+      @server_retrieval_by_source[source] = GemServer.new(source: source)
+      @server_retrieval_by_source[source]
+    end
+
+    def github_retrieval_by_owner(owner:)
+      @github_retrieval_by_owner ||= {}
+
+      return @github_retrieval_by_owner[owner] if @github_retrieval_by_owner[owner]
+
+      @github_retrieval_by_owner[owner] = GitTag.new(owner: owner)
+      @github_retrieval_by_owner[owner]
+    end
+  end
+end

data/lib/gem_enforcer/setup/helper/on_failure.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module GemEnforcer
+  module Setup
+    module Helper
+      module OnFailure
+        ALLOWED_ON_FAILURE = [:raise, :exit, DEFAULT_BEHAVIOR = :none]
+        DEFAULT_LOG_LEVEL = :error
+
+        def validate_on_failure
+          on_failure = params["on_failure"]
+          if on_failure.nil?
+            @on_failure_log_level = DEFAULT_LOG_LEVEL
+            @on_failure_behavior = DEFAULT_BEHAVIOR
+            return true
+          end
+
+          if Hash === on_failure
+            @on_failure_log_level = on_failure.fetch("log_level", DEFAULT_LOG_LEVEL)
+            behavior = on_failure.fetch("behavior", DEFAULT_BEHAVIOR).to_sym rescue nil
+            if ALLOWED_ON_FAILURE.include?(behavior)
+              @on_failure_behavior = behavior
+              return true
+            else
+              errors << "on_failure.behavior: Expected behavior to be in #{ALLOWED_ON_FAILURE}"
+              return false
+            end
+          end
+
+          errors << "on_failure: Expected value hash with :behavior and/or :log_level keys"
+          false
+        end
+
+        def on_failure_default_message
+          message = params.dig("on_failure", "message") rescue nil
+          return message if message
+
+          version_default_message
+        end
+
+        def on_failure_behavior(msg:)
+
+        end
+
+        def execute_on_failure!(behavior:, msg: on_failure_default_message)
+          GemEnforcer.logger.public_send(@on_failure_log_level, "Validation failed for #{gem_name}. Current Version is #{current_version}. #{msg}")
+
+          case @on_failure_behavior.to_sym
+          when :raise
+            raise ValidationError, "Validation failed for #{gem_name}. Current Version is #{current_version}. #{msg}"
+          when :exit
+            Kernel.exit(1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gem_enforcer/setup/helper/retrieval.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GemEnforcer
+  module Setup
+    module Helper
+      module Retrieval
+        def validate_retrieval
+          if params["server"]
+            @retrieval_method = :server
+            server_result = _server_validate
+            @factory_version_list = Retrieve.server_retrieval_by_source(source: @retrieval_source)
+
+            server_result
+          elsif params["git"]
+            @retrieval_method = :git
+            git_result = _git_validate
+            @factory_version_list = Retrieve.github_retrieval_by_owner(owner: @retrieval_owner)
+
+            git_result
+          else
+            errors << "retrieval: Missing retrieval type. Expected `server` or `git`"
+            false
+          end
+        end
+
+        def retrieve_version_list
+          @factory_version_list.gem_versions(name: @gem_name).sort
+        end
+
+        def _server_validate
+          server = params.dig("server")
+
+          if server == true
+            @retrieval_source = GemEnforcer::DEFAULT_SERVER_SOURCE
+            return true
+          end
+
+          if Hash === server && server["source"]
+            @retrieval_source = server["source"]
+            return true
+          end
+
+          errors << "retrieval.server: Missing source"
+          false
+        end
+
+        def _git_validate
+          git = params.dig("git")
+          if Hash === git && git["owner"]
+            @retrieval_owner = git["owner"]
+            return true
+          end
+
+          errors << "retrieval.git: Missing owner"
+          false
+        end
+      end
+    end
+  end
+end

data/lib/gem_enforcer/setup/helper/version.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module GemEnforcer
+  module Setup
+    module Helper
+      module Version
+        ALLOWED_VERSION_REALEASE = :releases
+        ALLOWED_VERSION_SEMVER = [:major, :minor, :patch]
+        ALLOWED_VERSION_THRESHOLD_KEYS = [ALLOWED_VERSION_REALEASE, *ALLOWED_VERSION_SEMVER]
+
+        def version_default_message
+          @default_version_message
+        end
+
+        def validate_version
+          if params.keys.include?("enforce_insync") && params.keys.include?("version_threshold")
+            errors << "version: Must only contain `enforce_insync` or `version_threshold`"
+            return false
+          end
+
+          if params["enforce_insync"]
+            @version_type = :enforce_insync
+            @default_version_message = "Version must be the most recently released version."
+            return true
+          end
+
+          @version_type = :version_threshold
+          version_threshold_keys = params["version_threshold"]&.keys || []
+          if version_threshold_keys.sort == [ALLOWED_VERSION_REALEASE.to_s].sort
+            @version_threshold = :releases
+            @default_version_message = "Version must be within #{params["version_threshold"]["releases"]} of the most recently released versions"
+            _releases_validate
+          elsif ALLOWED_VERSION_THRESHOLD_KEYS.any? { version_threshold_keys.include?(_1.to_s) }
+            @version_threshold = :semver
+            message = []
+            message << "#{params["version_threshold"]["major"]} major versions"  if params["version_threshold"]["major"]
+            message << "#{params["version_threshold"]["minor"]} minor versions"  if params["version_threshold"]["minor"]
+            message << "#{params["version_threshold"]["patch"]} patch versions"  if params["version_threshold"]["patch"]
+            @default_version_message = "Version must be within #{message.join(" and ")} of the most recent release."
+            _semver_validate
+          else
+            errors << "version.version_threshold: Expected keys to contain [#{ALLOWED_VERSION_REALEASE}] or #{ALLOWED_VERSION_SEMVER}"
+            false
+          end
+        end
+
+        def _semver_validate
+          boolean = true
+          if major = params["version_threshold"]["major"]
+            unless Integer === major
+              boolean = false
+              errors << "version.version_threshold.major: Expected value to be an Integer"
+            end
+          end
+
+          if minor = params["version_threshold"]["minor"]
+            unless Integer === minor
+              boolean = false
+              errors << "version.version_threshold.minor: Expected value to be an Integer"
+            end
+          end
+
+          if patch = params["version_threshold"]["patch"]
+            unless Integer === patch
+              boolean = false
+              errors << "version.version_threshold.patch: Expected value to be an Integer"
+            end
+          end
+
+          boolean
+        end
+
+        def _releases_validate
+          release_count = params["version_threshold"]["releases"]
+          unless Integer === release_count
+            errors << "version.version_threshold.releases: Expected value to be an Integer"
+            return false
+          end
+
+          true
+        end
+
+        def version_execute?(version_list:)
+          if @version_type == :enforce_insync
+            __validate_enforce_insync?(version_list:)
+          else
+            if @version_threshold == :releases
+              __validate_version_threshold_releases?(version_list:)
+            else
+              __validate_version_threshold_semver?(version_list:)
+            end
+          end
+        end
+
+        def __validate_version_threshold_semver?(version_list:)
+          if max_major_versions_behind = params.dig("version_threshold", "major")
+            return false unless __threshold_semver_distance(type: :major, number: current_version.segments[0], list: version_list.map { _1.segments[0] }, threshold: max_major_versions_behind)
+          end
+
+          if max_minor_versions_behind = params.dig("version_threshold", "minor")
+            # Select only the minor versions that match the major version
+            current_major_version = current_version.segments[0]
+            minor_version_check_list = version_list.select { _1.segments[0] == current_major_version }.map { _1.segments[1] }
+            return false unless __threshold_semver_distance(type: :minor, number: current_version.segments[1], list: minor_version_check_list, threshold: max_minor_versions_behind)
+          end
+
+          if max_patch_versions_behind = params.dig("version_threshold", "patch")
+            # Select only the patch versions that match the major version
+            current_major_minor_version = current_version.segments[0..1]
+            patch_version_check_list = version_list.select { _1.segments[0..1] == current_major_minor_version }.map { _1.segments[2] }
+            return false unless __threshold_semver_distance(type: :patch, number: current_version.segments[2], list: patch_version_check_list, threshold: max_patch_versions_behind)
+          end
+
+          true
+        end
+
+        def __threshold_semver_distance(type:, number:, list:, threshold:)
+          # remove duplicates ans sort in highest to lowest number
+          uniq_list = list.uniq.sort.reverse
+
+          # get the position in the sorted array
+          position_in_sorted_array = uniq_list.find_index(number)
+
+          # if position is less than or equal to the threshold, we are good
+          # otherwise, it is out of compliance
+          return true if position_in_sorted_array <= threshold
+
+          @default_version_message += " Failed to match #{type} version threshold"
+
+          false
+        end
+
+        def __validate_version_threshold_releases?(version_list:)
+          releases_behind = params.dig("version_threshold", "releases").to_i
+
+          min_version_allowed = version_list[-releases_behind]
+          current_version >= min_version_allowed
+        end
+
+        def __validate_enforce_insync?(version_list:)
+          max_version = version_list.max
+          return true if current_version >= max_version
+
+          @default_version_message += " Please upgrade to at least v#{max_version}"
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/gem_enforcer/setup/validate.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require "gem_enforcer/setup/helper/retrieval"
+require "gem_enforcer/setup/helper/on_failure"
+require "gem_enforcer/setup/helper/version"
+
+module GemEnforcer
+  module Setup
+    class Validate
+      attr_reader :gem_name, :params, :validation_status
+
+      include Helper::Retrieval
+      include Helper::OnFailure
+      include Helper::Version
+
+      def initialize(name:, **params)
+        @params = params
+        @gem_name = name
+
+        @validation_status = validate!
+      end
+
+      # Allow behavior to be overridden if desired
+      def run_validation!(behavior: nil)
+        unless validation_status
+          raise Error, "Unable to run validation with invalid config."
+        end
+
+        return true if current_version.nil?
+
+        return true if version_execute?(version_list: retrieve_version_list)
+
+        execute_on_failure!(behavior: behavior)
+        false
+      end
+
+      def current_version
+        Gem.loaded_specs[gem_name]&.version
+      end
+
+      def error_status
+        return nil if errors.empty?
+
+        errors.map { "#{gem_name}.#{_1}" }
+      end
+
+      private
+
+      def errors
+        @errors ||= []
+      end
+
+      def validate!
+        boolean = validate_retrieval
+        boolean &= validate_on_failure
+        boolean &= validate_version
+
+        boolean
+      end
+    end
+  end
+end

data/lib/gem_enforcer/setup.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "gem_enforcer/setup/validate"
+
+module GemEnforcer
+  module Setup
+    module_function
+
+    def validate_yml!
+      errors = config_yml["gems"].map do |name, metadata|
+        validator = Validate.new(name: name, **metadata)
+        validations << validator
+
+        validator.error_status
+      end.compact
+      return true if errors.empty?
+
+      log_level = config_yml.dig("invalid_config", "log_level") || "error"
+      behavior = config_yml.dig("invalid_config", "behavior") || "exit"
+    end
+
+    def validations
+      @validations ||= []
+    end
+
+    def run_validations!(behavior: nil)
+      validations.each { _1.run_validation!(behavior: behavior) }
+    end
+
+    def config_yml
+      @read_config_yml ||= begin
+        path = GemEnforcer.configuration.yml_config_path
+        file = File.read(path)
+        erb = ERB.new(file)
+
+        YAML.load(erb.result)
+      end
+    end
+  end
+end

data/lib/gem_enforcer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GemEnforcer
+  VERSION = "0.0.1"
+end

data/lib/gem_enforcer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "gem_enforcer/configuration"
+require "gem_enforcer/errors"
+require "gem_enforcer/retrieve"
+require "gem_enforcer/setup"
+require "gem_enforcer/version"
+
+module GemEnforcer
+  DEFAULT_SERVER_SOURCE = "https://rubygems.org"
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= GemEnforcer::Configuration.new
+  end
+
+  def self.configuration=(object)
+    raise ConfigError, "Expected configuration to be a GemEnforcer::Configuration" unless object.is_a?(GemEnforcer::Configuration)
+
+    @configuration = object
+  end
+
+  def self.github_access_token
+    configuration.github_access_token
+  end
+
+  def self.logger
+    configuration.logger
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: gem_enforcer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: class_composer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: Provide the ability to validate targetted gems are up to date before
+  executing commands
+email:
+- mattius.taylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CODEOWNERS
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- bin/console
+- docker-compose.yml
+- gem_enforcer.gemspec
+- gem_enforcer.yml
+- lib/gem_enforcer.rb
+- lib/gem_enforcer/configuration.rb
+- lib/gem_enforcer/errors.rb
+- lib/gem_enforcer/retrieve.rb
+- lib/gem_enforcer/retrieve/gem_server.rb
+- lib/gem_enforcer/retrieve/git_tag.rb
+- lib/gem_enforcer/setup.rb
+- lib/gem_enforcer/setup/helper/on_failure.rb
+- lib/gem_enforcer/setup/helper/retrieval.rb
+- lib/gem_enforcer/setup/helper/version.rb
+- lib/gem_enforcer/setup/validate.rb
+- lib/gem_enforcer/version.rb
+homepage: https://github.com/matt-taylor/gem_enforcer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matt-taylor/gem_enforcer
+  source_code_uri: https://github.com/matt-taylor/gem_enforcer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: Long form of the description
+test_files: []