appraisal-matrix 0.1.0 → 0.3.0.pre.tstarck.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15e1a8f3f0f52235bc85e749b73a4fcf753393281f59ef10ce53033caa3a83b
-  data.tar.gz: 0b097af634a61f3bad05e7513a28902fba3516ed17c23fbb3add3bb35135bf5c
+  metadata.gz: 455050798ee698fa03781e94f45ea46774dfaacb293c0634346d25a0ffce067c
+  data.tar.gz: 818a60d1519378825f5bd40a564328d7c3440e5ce8cdbc26af9b9d6dda058b29
 SHA512:
-  metadata.gz: 4a1d81416bbc19307d92feaf5df8f24d232863ad1325793fb15097a4021c458eb619bb5e997043df9e5ec2eab42392440a0ba79cbf36e8f8bad927f0ae94dfb7
-  data.tar.gz: 81e255ddd188a08b97a81b6f5d4fefb558c20c884df44b10540cd6b4240717ad28519210b0dc24e9ee9347eb4e70b99f9e39c989a983d2c50b511acf8b281138
+  metadata.gz: 36660df655d219bbfb64b5f67c0bbd31718132d10adab5dccf28e1001e59340e41f18cc2a83493bb3be555d6f64a98ce5d36f4ccb1ce10cc744450a77bc38068
+  data.tar.gz: d4587264eec3f603cecc0b6fb1585dbe4769aefbfcb128a7b7e7c19b898c2b6acc95c097e8101f2d86c08004fdacb32ea12cc9dc54c4a7e27d16621f6a6b3da1

data/.ruby-version

@@ -0,0 +1 @@
+3.0.6

data/CHANGELOG.md

@@ -3,6 +3,16 @@ 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
+## 0.3.0 - Unreleased
+### Changed
+- Changed the block passed to `appraisal_matrix` to be called with the versions of gems for the current matrix entry.
+
+## 0.2.0 - 2024-07-09
+### Added
+- Support special request options for `appraisal_matrix`:
+    - `versions`: An array of version restriction strings.
+    - `step`: The granularity of a release to be included in the matrix. Allowed to be :major, :minor, or :patch.
+
+## [0.1.0] - 2024-06-26
 ### Added
 - Add an extension to the Appraisal gem that provides an interface for generating a matrix of appraisals.

data/README.md

@@ -53,6 +53,18 @@ appraisal_matrix(activesupport: "6.1") do
 end
 ```
 
+#### Block arguments
+If you would like to setup conditional logic based off of the versions of the gems in the matrix, you can pass a block with arguments to `appraisal_matrix`.
+
+```ruby
+appraisal_matrix(activesupport: "6.1") do |activesupport:, sidekiq:|
+  # activesupport <Gem::Version>
+  if activesupport < "7"
+    remove_gem 'test_after_commit'
+  end
+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.
@@ -65,18 +77,27 @@ appraisal_matrix(activesupport: "6.1", sidekiq: "7.0")
 
 In addition to specifying the minimum requested version, users will be able to make additional version requests.
 
-#### Maximum version (Coming soon!)
+#### Additional version restrictions
 
-Include a maximum boundary (inclusive).
+Include additional version boundaries. Either include the requirement strings as an array or pass the `versions` key to the options hash.
 ```ruby
-appraisal_matrix(activesupport: { min: "6.1", max: "7.1" })
+appraisal_matrix(activesupport: [">= 6.1", "< 7.1"])
+appraisal_matrix(activesupport: ["~> 6.0", "!= 6.1.0"])
+appraisal_matrix(activesupport: { versions: ["> 6.1.1"] })
 ```
 
-#### Version step (Coming soon!)
+#### Version step
+
+The default operation is to test against each minor version. You can choose to be more or less inclusive when necessary.
 
 Only test the latest release of each major version.
 ```ruby
-appraisal_matrix(activesupport: { min: "6.1", max: "7.1", step: :major })
+appraisal_matrix(activesupport: { versions: [">= 6.1", "< 7.1"], step: :major })
+```
+
+Or include all patch releases
+```ruby
+appraisal_matrix(activesupport: { versions: [">= 6.1", "< 7.1"], step: :patch })
 ```
 
 ## Development

data/catalog-info.yaml

@@ -0,0 +1,31 @@
+# This file is partially auto-generated by the invoca-backstage-tools gem
+# The following fields should not be edited manually as they are auto-generated
+# based on the contents of the repo:
+#  - metadata.name
+#  - metadata.title
+#  - metadata.description
+#  - annotations.github.com/project-slug
+#  - invoca.com/version-repository-location
+#  - invoca.com/version-repository-name
+#  - spec.type
+#  - spec.owner
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: appraisal-matrix-gem
+  title: Appraisal::Matrix
+  description: Appraisal file DSL for generating a matrix of gemfiles.
+  tags:
+  - ruby
+  - gem
+  annotations:
+    buildkite.com/project-slug: invoca/appraisal-matrix
+    github.com/project-slug: invoca/appraisal-matrix
+    invoca.com/version-repository-location: rubygems
+    invoca.com/version-repository-name: appraisal-matrix
+spec:
+  type: library
+  lifecycle: production
+  owner: octothorpe
+  dependsOn: []

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

@@ -5,14 +5,41 @@ 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
+    class VersionArray
+      SUPPORTED_VERSION_STEPS = [:major, :minor, :patch].freeze
+
+      attr_reader :gem_name, :version_requirements, :step
+
+      def initialize(gem_name:, versions:, step: :minor)
+        SUPPORTED_VERSION_STEPS.include?(step) or raise("Unsupported version step: #{step}")
+
+        @gem_name = gem_name
+        @version_requirements = Gem::Requirement.new(versions)
+        @step = step.to_sym
+      end
+
+      def versions
+        RubygemsHelper.versions_to_test(gem_name, version_requirements, step)
+      end
+    end
+
+    # Define a matrix of appraisals to test against
+    # Expected usage:
+    #   appraisal_matrix(rails: "6.0")
+    #   appraisal_matrix(rails: "> 6.0.3")
+    #   appraisal_matrix(rails: [">= 6.0", "< 7.1"])
+    #   appraisal_matrix(rails: { versions: [">= 6.0", "< 7.1"], step: "major" })
+    #   appraisal_matrix(rails: "6.0") do
+    #     gem "sqlite3", "~> 2.5"
+    #   end
+    #   appraisal_matrix(rails: "6.0", sidekiq: "5.0") do |rails:, sidekiq:|
+    #     if rails < "7"
+    #       # do something...
+    #     else
+    #       # do something else...
+    #     end
+    #   end
     def appraisal_matrix(**kwargs, &block)
       # names_and_versions_to_test
       # [
@@ -21,14 +48,21 @@ module Appraisal::Matrix
       #   [[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
+        kwargs.map do |gem_name, version_options|
+          version_array =
+            case version_options
+            when String
+              parsed_options = version_options.include?(" ") ? [version_options] : [">= #{version_options}"]
+              VersionArray.new(gem_name: gem_name, versions: parsed_options)
+            when Integer, Float
+              VersionArray.new(gem_name: gem_name, versions: [">= #{version_options}"])
+            when Array
+              VersionArray.new(gem_name: gem_name, versions: version_options)
+            when Hash
+              VersionArray.new(gem_name: gem_name, **version_options)
+            end
 
-          versions_to_test(gem_name, minimum_version).map do |version|
+          version_array.versions.map do |version|
             [gem_name, version]
           end
         end
@@ -49,7 +83,10 @@ module Appraisal::Matrix
           appraisal_spec.each do |gem_name, version|
             gem gem_name, "~> #{version}.0"
           end
-          instance_eval(&block) if block
+          if block
+            block_args = appraisal_spec.to_h { |gem_name, version| [gem_name.to_sym, Gem::Version.new(version)] }
+            instance_exec(**block_args, &block)
+          end
         end
       end
     end

data/lib/appraisal/matrix/rubygems_helper.rb

@@ -5,20 +5,46 @@ 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?
+    class RubygemsHelper
+      class << self
+        # Returns a set of versions to test against for a given gem.
+        #
+        # @param gem_name [String, Symbol] The name of the gem.
+        # @param version_requirement [Gem::Requirement] The version requirement for the gem.
+        # @param step [Symbol] The step value.
+        #
+        # @return [Set] A set of versions to test against.
+        def versions_to_test(gem_name, version_requirement, step)
+          # 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_for_step(version, step) if include_version?(version, version_requirement)
+            end
           end
+
+          versions_to_test
         end
 
-        versions_to_test
+        private
+
+        SEGMENT_STEP_SIZES = {
+          major: 1,
+          minor: 2,
+          patch: 3
+        }.freeze
+
+        def version_for_step(version, step)
+          size_for_step = SEGMENT_STEP_SIZES[step] or raise ArgumentError, "unsupported requested version step: #{step}, expected #{SEGMENT_STEP_SIZES.keys}"
+          version.segments.first(size_for_step).join(".")
+        end
+
+        def include_version?(version, version_requirement)
+          !version.prerelease? && version_requirement.satisfied_by?(version)
+        end
       end
     end
   end

data/lib/appraisal/matrix/version.rb

@@ -2,6 +2,6 @@
 
 module Appraisal
   module Matrix
-    VERSION = "0.1.0"
+    VERSION = "0.3.0.pre.tstarck.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appraisal-matrix
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0.pre.tstarck.1
 platform: ruby
 authors:
 - Drew Caddell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -33,11 +33,13 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Appraisals
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- catalog-info.yaml
 - gemfiles/appraisal_2_2.gemfile
 - gemfiles/appraisal_2_3.gemfile
 - gemfiles/appraisal_2_4.gemfile
@@ -64,11 +66,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Appraisal file DSL for generating a matrix of gemfiles.