parameterized_testing 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae68ed889f8978f18434df681d55770938eca2ec6a68622daddcc623c110d0d
-  data.tar.gz: be9768a8b3c3faaead709c2de45eea17aed72d8d5c56aca9e849ef1fb7d3e23f
+  metadata.gz: d2e0065076e770326c01f888a5f82b0a7cda3939e16a4e64824fd24a86d2c560
+  data.tar.gz: be46f52978f805296958da8e63514d860b6417c9e6cda5a0cb4f15ac85ff7c47
 SHA512:
-  metadata.gz: d0aa5bae0c96de4f2e184ccf9e62f1df1b0aee661ad030aa72caa1814cad1fb1066a262e706e29d300c3e9350b2b6ec92c7cf19bb72eabd70bc0c5fca373ac59
-  data.tar.gz: 2a091aa7e143f39ace374a1b1ce8c881284577449cda9737edd960b7763be98d4ce3534a3a66bc5eaa43dcc8aa4bd728dff6505d89ab7286baa654e1d23cc230
+  metadata.gz: cf153934ac5ce7fe4c8ff313df5c9719b10a4d373da59d38e861ce748594409f0d6cb2d7febfd0e3b62191176313081af6eb791b424d30865c0c7403fd43ea64
+  data.tar.gz: 0b817ca2c69ec215357e6a731b142df3c35e8b750703d592de85c47a67c8d0408d8c3f81ede96df4778d03e86d78d610bd3340f9d56284a7b479b83bede2ff73

data/lib/parameterized_testing/input.rb

@@ -1,28 +1,33 @@
 # frozen_string_literal: true
 
 module ParameterizedTesting
-  # `Input` represents a single test case for a parameterized test.
+  # {Input} represents a single test case for a parameterized test.
   class Input
-    attr_reader :index, :location, :initializer
-
-    # @param index [Integer]
-    # @param location [Thread::Backtrace::Location]
-    # @param initializer [Proc]
-    def initialize(index:, location:, initializer:)
+    # @return [Integer] index of the input
+    attr_reader :index
+    # @return [Thread::Backtrace::Location] the location of the <code>input { ... }</code> block
+    attr_reader :location
+    # @return [Proc] the block to compute the value of this input
+    attr_reader :initializer
+    # @return [String, nil] description of the input
+    attr_reader :description
+
+    def initialize(index:, location:, initializer:, description:)
       @index = index
       @location = location
       @initializer = initializer
+      @description = description
     end
 
-    # Gets a human-readable label string.
+    # Returns a human-readable label string.
     # @return [String]
     def label
-      "input[#{index}] at line #{location.lineno}"
+      "#{@description || "input[#{index}]"} (at line #{location.lineno})"
     end
 
-    # Collects all `input { ... }` in a block.
-    # It is important to notice that `#parameterized` collects inputs by actually `instance_exec`uting
-    # the block in a dedicated context in order to get the line number of input.
+    # Collects all <code>input { ... }</code> in a block.
+    # It is important to notice that this method collects inputs by actually <code>#instance_exec</code>uting
+    # the block in a dedicated context, in order to get the line number of input.
     # In this context, all other method calls are ignored.
     # @return [Array<Input>]
     def self.collect(&)
@@ -37,11 +42,11 @@ module ParameterizedTesting
         @next_index = 0
       end
 
-      def input(&initializer)
+      def input(description = nil, &initializer)
         index = @next_index
         @next_index += 1
         location = caller_locations(1, 1).first
-        @inputs << Input.new(index:, location:, initializer:)
+        @inputs << Input.new(index:, location:, initializer:, description:)
       end
 
       def method_missing(_name, ...)
@@ -52,5 +57,6 @@ module ParameterizedTesting
         true
       end
     end
+    private_constant :Collector
   end
 end

data/lib/parameterized_testing/signature.rb

@@ -1,25 +1,27 @@
 # frozen_string_literal: true
 
 module ParameterizedTesting
-  # `Signature` represents the signature that each `Input` in the parameterized test must satisfy.
+  # {Signature} represents the signature that each {Input} in the parameterized test must satisfy.
   class Signature
+    # @return [Array<Symbol>] names of the parameters
     attr_reader :params
 
-    # @param params [Array<Symbol>]
     def initialize(*params)
-      raise ArgumentError, "parameter name must be a symbol" if params.any? { !_1.is_a?(Symbol) }
+      raise TypeError, "parameter name must be a symbol" if params.any? { !_1.is_a?(Symbol) }
       raise ArgumentError, "parameter names must be unique" if params.uniq.size != params.size
 
       @params = params
     end
 
-    # @return [Symbol]
+    # @return [Symbol] a symbol for temporary variables that are unique for each signature
     def temporary_variable_name
       @temporary_variable_name ||= :"_input_#{params.join("_")}"
     end
 
-    # @param value [Object]
-    # @return [Hash<Symbol, Object>, nil] Mapping of parameters and values, or `nil` if mapping fails
+    # Compute the mapping between parameters and values, or <code>nil</code> if map fails.
+    # @param value [Object] An array with the same number of elements as the number of parameters,
+    #   or a hash with each parameter name as a key. For other objects, map will fail.
+    # @return [Hash{Symbol => Object}, nil]
     def map(value)
       case value
       when Array

data/lib/parameterized_testing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ParameterizedTesting
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parameterized_testing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - yubrot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-06-30 00:00:00.000000000 Z
 dependencies: []
 description: Parameterized testing utility
 email:
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Parameterized testing utility