appraisal-matrix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a15e1a8f3f0f52235bc85e749b73a4fcf753393281f59ef10ce53033caa3a83b
+  data.tar.gz: 0b097af634a61f3bad05e7513a28902fba3516ed17c23fbb3add3bb35135bf5c
+SHA512:
+  metadata.gz: 4a1d81416bbc19307d92feaf5df8f24d232863ad1325793fb15097a4021c458eb619bb5e997043df9e5ec2eab42392440a0ba79cbf36e8f8bad927f0ae94dfb7
+  data.tar.gz: 81e255ddd188a08b97a81b6f5d4fefb558c20c884df44b10540cd6b4240717ad28519210b0dc24e9ee9347eb4e70b99f9e39c989a983d2c50b511acf8b281138

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# This rubocop config file inherits from our centralized style-guide repository.
+# If you are looking to update the ruby style guide, be sure to both update the rubocop config
+# as well as the README.md
+# https://github.com/Invoca/style-guide/tree/master/ruby
+inherit_from: https://raw.githubusercontent.com/Invoca/style-guide/master/ruby/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.1

data/Appraisals

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "appraisal/matrix"
+
+appraisal_matrix(appraisal: "2.2")

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+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).
+
+## [0.1.0] - Unreleased
+### Added
+- Add an extension to the Appraisal gem that provides an interface for generating a matrix of appraisals.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Drew Caddell
+
+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 @@
+# Appraisal::Matrix
+
+Sometimes our gems are using dependencies which have consistent major/minor versions released with breaking changes, and we want to ensure compatibility by explicitly testing against the array of versions.
+
+Appraisal::Matrix provides an interface for testing against that entire array without repetition in the Appraisals file.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+### Single gem usage
+
+The most common use-case is wanting to test compatibility with all supported versions of Rails.
+
+```ruby
+# Appraisals
+# frozen_string_literal: true
+
+require "appraisal/matrix"
+
+appraisal_matrix(activesupport: "6.1")
+```
+
+Then run
+
+    $ bundle exec appraisal install
+
+A gemfile like the one below will be created for each major/minor version of activesupport starting with 6.1.
+```ruby
+# activesupport_6_1.gemfile
+# This file was generated by Appraisal
+
+gem "activesupport", "~> 6.1.0"
+```
+
+### Passing blocks to Appraisal
+
+Any block passed to `appraisal_matrix` will be run in each individual appraisal. For example, if you [rely on removing gems using appraisal](https://github.com/thoughtbot/appraisal?tab=readme-ov-file#removing-gems-using-appraisal) you can pass the exact same block to `appraisal_matrix`.
+
+```ruby
+appraisal_matrix(activesupport: "6.1") do
+  remove_gem 'test_after_commit'
+end
+```
+
+### Appraising more than one Gem
+
+You can also pass more than one gem to `appraisal_matrix` to create a matrix of all combinations of the specified gems.
+
+```ruby
+appraisal_matrix(activesupport: "6.1", sidekiq: "7.0")
+```
+
+### Version argument options
+
+In addition to specifying the minimum requested version, users will be able to make additional version requests.
+
+#### Maximum version (Coming soon!)
+
+Include a maximum boundary (inclusive).
+```ruby
+appraisal_matrix(activesupport: { min: "6.1", max: "7.1" })
+```
+
+#### Version step (Coming soon!)
+
+Only test the latest release of each major version.
+```ruby
+appraisal_matrix(activesupport: { min: "6.1", max: "7.1", step: :major })
+```
+
+## 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/invoca/appraisal-matrix.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gemfiles/appraisal_2_2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "appraisal", "~> 2.2.0"
+
+gemspec path: "../"

data/gemfiles/appraisal_2_3.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "appraisal", "~> 2.3.0"
+
+gemspec path: "../"

data/gemfiles/appraisal_2_4.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "appraisal", "~> 2.4.0"
+
+gemspec path: "../"

data/gemfiles/appraisal_2_5.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "appraisal", "~> 2.5.0"
+
+gemspec path: "../"

data/lib/appraisal/matrix/extensions/appraisal_file.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'appraisal'
+require 'appraisal/matrix/rubygems_helper'
+
+module Appraisal::Matrix
+  module AppraiseFileWithMatrix
+    include RubygemsHelper
+
+    # appraisal_matrix(rails: "6.0")
+    # appraisal_matrix(rails: "6.0", sidekiq: "5")
+    # appraisal_matrix(rails: "6.0", sidekiq: { min: “5.0”, max: “6.0”, step: :major })
+    # appraisal_matrix(rails: "6.0") do
+    #   gem "sqlite3", "~> 2.5"
+    # end
+    def appraisal_matrix(**kwargs, &block)
+      # names_and_versions_to_test
+      # [
+      #   [[rails, 6.0], [rails, 6.1], [rails, 7.0], [rails, 7.1]],
+      #   [[sidekiq, 1.0], [sidekiq, 2.0]],
+      #   [[a, x], [a, y], [a, z]]
+      # ]
+      names_and_versions_to_test =
+        kwargs.map do |gem_name, version_request|
+          if version_request.is_a?(Hash)
+            raise "TODO: Version request options not implemented yet"
+          else
+            minimum_version = Gem::Version.new(version_request)
+          end
+
+          versions_to_test(gem_name, minimum_version).map do |version|
+            [gem_name, version]
+          end
+        end
+
+      # matrix
+      # [
+      #   [[rails, 6.0], [sidekiq, 1.0], ...[a, x]]
+      #   [[rails, 6.0], [sidekiq, 1.0], ...[a, y]]
+      #   [[rails, 6.0], [sidekiq, 1.0], ...[a, z]]
+      #   ...
+      #   [[rails, 7.1], [sidekiq, 2.0], ...[a, z]]
+      # ]
+      matrix = names_and_versions_to_test[0].product(*names_and_versions_to_test[1..])
+
+      # Iterate over versions to test and create appraisal per
+      matrix.each do |appraisal_spec|
+        appraise appraisal_file_name(appraisal_spec) do
+          appraisal_spec.each do |gem_name, version|
+            gem gem_name, "~> #{version}.0"
+          end
+          instance_eval(&block) if block
+        end
+      end
+    end
+
+    private
+
+    # [["rails", "6.0"], ["sidekiq", "5"]]
+    # => "rails-6_0-sidekiq-5"
+    def appraisal_file_name(names_and_versions)
+      names_and_versions.map do |name, version|
+        "#{name}-#{version.gsub('.', '_')}"
+      end.join("-")
+    end
+  end
+end
+
+Appraisal::AppraisalFile.prepend(Appraisal::Matrix::AppraiseFileWithMatrix)

data/lib/appraisal/matrix/rubygems_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open-uri'
+
+module Appraisal
+  module Matrix
+    module RubygemsHelper
+      def versions_to_test(gem_name, minimum_version)
+        # Generate a set to store the versions to test against 
+        versions_to_test = Set.new
+
+        # Load versions from rubygems api
+        URI.parse("https://rubygems.org/api/v1/versions/#{gem_name}.json").open do |raw_version_data|
+          JSON.parse(raw_version_data.read).each do |version_data|
+            version = Gem::Version.new(version_data['number'])
+            versions_to_test << version.segments[0..1].join('.') if version >= minimum_version && !version.prerelease?
+          end
+        end
+
+        versions_to_test
+      end
+    end
+  end
+end

data/lib/appraisal/matrix/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Appraisal
+  module Matrix
+    VERSION = "0.1.0"
+  end
+end

data/lib/appraisal/matrix.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "matrix/version"
+require_relative "matrix/rubygems_helper"
+require_relative "matrix/extensions/appraisal_file"
+
+module Appraisal
+  module Matrix
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/appraisal/matrix.rbs

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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: appraisal-matrix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Caddell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Appraisal file DSL for generating a matrix of gemfiles.
+email:
+- dcaddell@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Appraisals
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/appraisal_2_2.gemfile
+- gemfiles/appraisal_2_3.gemfile
+- gemfiles/appraisal_2_4.gemfile
+- gemfiles/appraisal_2_5.gemfile
+- lib/appraisal/matrix.rb
+- lib/appraisal/matrix/extensions/appraisal_file.rb
+- lib/appraisal/matrix/rubygems_helper.rb
+- lib/appraisal/matrix/version.rb
+- sig/appraisal/matrix.rbs
+homepage: https://github.com/invoca/appraisal-matrix
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/invoca/appraisal-matrix
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Appraisal file DSL for generating a matrix of gemfiles.
+test_files: []