dsl_compose 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f215d3a5226d56e6f0f5e62b340e0212607a52c3097228f7fc24ef1f5028a20
-  data.tar.gz: afcf1aa8a22966ca83475f7e0d41780c5e0d44e50b13dc91b33a71011b6d1fc4
+  metadata.gz: 461fe3b90a0a36703aee0be51b3594472d2fc55ff1eab2b6b5bfabd851446d09
+  data.tar.gz: 65ba43be5dfcefbaf5588744b66fcd73a8266abbea65bcb59699132c43ed47a7
 SHA512:
-  metadata.gz: fff6880b4032551cabd769fa1c2c6eda13179f4b1e50cb652bdef9a6ecd0055e45994235d0ebb78ee06445086368c304279fa04feddcde41b78e046677aea86c
-  data.tar.gz: 409bae7843d156e2c1e6854ebd87381c2eafcccc8adaf3cd2adfbcc076282efde0d0d12c69fb661f95ac0404c7bfd1b28328bdc6e54f211790fb62571b1dd7a0
+  metadata.gz: 9d2b86c2398b49217ba29152f68f6666e0bcbe926d4adadaac29b4f4a3d8500b120192c469c4fa25f68b68c58e73782459356a7845bcabb0237076521e4e0f37
+  data.tar.gz: 4f58959006d911cb13d75ccddc1871416736236d0e278844f6beb1c22a546d2e8d3620230931a2108c8949ad346a65ce27f3ae437fd8d55e5563603ad8421d24

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.7.0](https://github.com/craigulliott/dsl_compose/compare/v1.6.0...v1.7.0) (2023-07-07)
+
+
+### Features
+
+* better error messages ([#19](https://github.com/craigulliott/dsl_compose/issues/19)) ([a9afa6c](https://github.com/craigulliott/dsl_compose/commit/a9afa6cb1b7482d0d7a646b6872ca5e969393eb7))
+
+## [1.6.0](https://github.com/craigulliott/dsl_compose/compare/v1.5.0...v1.6.0) (2023-07-07)
+
+
+### Features
+
+* added an interpreter clear method to erase state between tests ([#17](https://github.com/craigulliott/dsl_compose/issues/17)) ([9d0a0c9](https://github.com/craigulliott/dsl_compose/commit/9d0a0c9c521bed61f08fecaa388d1410f513498b))
+
 ## [1.5.0](https://github.com/craigulliott/dsl_compose/compare/v1.4.0...v1.5.0) (2023-07-07)
 
 

data/lib/dsl_compose/composer.rb

@@ -3,26 +3,17 @@
 module DSLCompose
   module Composer
     class ComposerAlreadyInstalledError < StandardError
-      def message
-        "This module has already been included or the define_dsl singleton method already exists for this class."
-      end
     end
 
     class MethodAlreadyExistsWithThisDSLNameError < StandardError
-      def message
-        "The `define_dsl` singleton method already exists for this class."
-      end
     end
 
     class GetDSLExecutionResultsMethodAlreadyExistsError < StandardError
-      def message
-        "The `dsls` singleton method already exists for this class."
-      end
     end
 
     def self.included klass
       if (klass.private_methods + klass.methods).include? :define_dsl
-        raise ComposerAlreadyInstalledError
+        raise ComposerAlreadyInstalledError, "This module has already been included or the define_dsl singleton method already exists for this class."
       end
 
       # create an interpreter for this class which will be shared by all child classes and all
@@ -31,7 +22,7 @@ module DSLCompose
 
       # return a specific DSL which is defined for this class
       if klass.respond_to? :dsls
-        raise GetDSLExecutionResultsMethodAlreadyExistsError
+        raise GetDSLExecutionResultsMethodAlreadyExistsError, "The `dsls` singleton method already exists for this class."
       end
 
       klass.define_singleton_method :dsls do
@@ -52,7 +43,7 @@ module DSLCompose
 
           # ensure that creating this DSL will not override any existing methods on this class
           if respond_to? name
-            raise MethodAlreadyExistsWithThisDSLNameError
+            raise MethodAlreadyExistsWithThisDSLNameError, "The `define_dsl` singleton method `#{name}` already exists for this class."
           end
 
           # add a singleton method with the name of this new DSL onto our class, this is how our new DSL will be accessed

data/lib/dsl_compose/dsl/arguments/argument/equal_to_validation.rb

@@ -6,9 +6,6 @@ module DSLCompose
       class Argument
         class EqualToValidation
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize value
@@ -16,7 +13,7 @@ module DSLCompose
           end
 
           def validate! value
-            raise ValidationFailedError unless value == @value
+            raise ValidationFailedError, "The argument is invalid. Expected #{@value} but received #{value}" unless value == @value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/format_validation.rb

@@ -6,9 +6,6 @@ module DSLCompose
       class Argument
         class FormatValidation
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize regex
@@ -16,7 +13,7 @@ module DSLCompose
           end
 
           def validate! value
-            raise ValidationFailedError if @regex.match(value).nil?
+            raise ValidationFailedError, "The argument is invalid. Expected format #{@regex} but received #{value}" if @regex.match(value).nil?
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/greater_than_or_equal_to_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class GreaterThanOrEqualToValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize value
             unless value.is_a?(Numeric)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type number"
             end
 
             @value = value
           end
 
           def validate! value
-            raise ValidationFailedError unless value >= @value
+            raise ValidationFailedError, "The argument is invalid. Expected greater than or equal to #{@value} but received #{value}" unless value >= @value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/greater_than_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class GreaterThanValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize value
             unless value.is_a?(Numeric)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type number"
             end
 
             @value = value
           end
 
           def validate! value
-            raise ValidationFailedError unless value > @value
+            raise ValidationFailedError, "The argument is invalid. Expected greater than #{@value} but received #{value}" unless value > @value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/in_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class InValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize values
             unless values.is_a?(Array)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{values}` provided to this validator must be of type Array"
             end
 
             @values = values
           end
 
           def validate! value
-            raise ValidationFailedError unless @values.include? value
+            raise ValidationFailedError, "The argument is invalid. Expected in #{@values} but received #{value}" unless @values.include? value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/length_validation.rb

@@ -6,9 +6,6 @@ module DSLCompose
       class Argument
         class LengthValidation
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize maximum: nil, minimum: nil, is: nil
@@ -20,17 +17,17 @@ module DSLCompose
           def validate! value
             maximum = @maximum
             unless maximum.nil?
-              raise ValidationFailedError if value.length > maximum
+              raise ValidationFailedError, "The argument is invalid. Expected #{value} to be less than or equal to #{maximum} characters" if value.length > maximum
             end
 
             minimum = @minimum
             unless minimum.nil?
-              raise ValidationFailedError if value.length < minimum
+              raise ValidationFailedError, "The argument is invalid. Expected #{value} to be greater than or equal to #{minimum} characters" if value.length < minimum
             end
 
             is = @is
             unless is.nil?
-              raise ValidationFailedError if value.length != is
+              raise ValidationFailedError, "The argument is invalid. Expected #{value} to be #{is} characters long" if value.length != is
             end
 
             true

data/lib/dsl_compose/dsl/arguments/argument/less_than_or_equal_to_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class LessThanOrEqualToValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize value
             unless value.is_a?(Numeric)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type number"
             end
 
             @value = value
           end
 
           def validate! value
-            raise ValidationFailedError unless value <= @value
+            raise ValidationFailedError, "The argument is invalid. Expected less than or equal to #{@value} but received #{value}" unless value <= @value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/less_than_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class LessThanValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize value
             unless value.is_a?(Numeric)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type number"
             end
 
             @value = value
           end
 
           def validate! value
-            raise ValidationFailedError unless value < @value
+            raise ValidationFailedError, "The argument is invalid. Expected less than #{@value} but received #{value}" unless value < @value
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument/not_in_validation.rb

@@ -6,27 +6,21 @@ module DSLCompose
       class Argument
         class NotInValidation
           class InvalidValueError < StandardError
-            def message
-              "The value provided to validate_greater_than must be a number"
-            end
           end
 
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize values
             unless values.is_a?(Array)
-              raise InvalidValueError
+              raise InvalidValueError, "The value `#{values}` provided to this validator must be of type Array"
             end
 
             @values = values
           end
 
           def validate! value
-            raise ValidationFailedError if @values.include?(value)
+            raise ValidationFailedError, "The argument is invalid. Expected not in #{@values} but received #{value}" if @values.include?(value)
           end
         end
       end

data/lib/dsl_compose/dsl/arguments/argument.rb

@@ -5,45 +5,27 @@ module DSLCompose
     class Arguments
       class Argument
         class ValidationIncompatibleError < StandardError
-          def message
-            "The validation is not compatible with this argument type"
-          end
         end
 
         class ValidationAlreadyExistsError < StandardError
-          def message
-            "This validation has already been applied to this method option."
-          end
         end
 
         class InvalidTypeError < StandardError
-          def message
-            "Argument type must be one of :integer, :boolean, :float, :string or :symbol"
-          end
         end
 
         class InvalidNameError < StandardError
-          def message
-            "The option name is invalid, it must be of type symbol."
-          end
         end
 
         class InvalidDescriptionError < StandardError
-          def message
-            "The option description is invalid, it must be of type string and have length greater than 0."
-          end
         end
 
         class DescriptionAlreadyExistsError < StandardError
-          def message
-            "The description has already been set"
-          end
         end
 
         class ArgumentNameReservedError < StandardError
-          def message
-            "This argument name is a reserved word. The names #{RESERVED_ARGUMENT_NAMES.join ", "} can not be used here because the Parser uses it to express a structural part of the DSL"
-          end
+        end
+
+        class ValidationInvalidArgumentError < StandardError
         end
 
         RESERVED_ARGUMENT_NAMES = [
@@ -87,18 +69,18 @@ module DSLCompose
           if name.is_a? Symbol
 
             if RESERVED_ARGUMENT_NAMES.include? name
-              raise ArgumentNameReservedError
+              raise ArgumentNameReservedError, "This argument name `#{name}` is a reserved word. The names #{RESERVED_ARGUMENT_NAMES.join ", "} can not be used here because the Parser uses them to express a structural part of the DSL"
             end
 
             @name = name
           else
-            raise InvalidNameError
+            raise InvalidNameError, "The option name `#{name}` is invalid, it must be of type symbol."
           end
 
           if type == :integer || type == :boolean || type == :float || type == :string || type == :symbol
             @type = type
           else
-            raise InvalidTypeError
+            raise InvalidTypeError, "Argument type `#{type}` must be one of :integer, :boolean, :float, :string or :symbol"
           end
 
           @required = required ? true : false
@@ -111,6 +93,8 @@ module DSLCompose
           if block
             Interpreter.new(self).instance_eval(&block)
           end
+        rescue => e
+          raise e, "Error defining argument #{name}: #{e.message}", e.backtrace
         end
 
         # Set the description for this Argument to the provided value.
@@ -119,11 +103,11 @@ module DSLCompose
         # The `description` can only be set once per Argument
         def set_description description
           unless description.is_a?(String) && description.length > 0
-            raise InvalidDescriptionError
+            raise InvalidDescriptionError, "The option description `#{description}` is invalid, it must be of type string and have length greater than 0."
           end
 
           if has_description?
-            raise DescriptionAlreadyExistsError
+            raise DescriptionAlreadyExistsError, "The description has already been set"
           end
 
           @description = description
@@ -146,11 +130,15 @@ module DSLCompose
 
         def validate_greater_than value
           if @greater_than_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `greater_than` has already been applied to this method option."
+          end
+
+          unless value.is_a?(Numeric)
+            raise ValidationInvalidArgumentError, value
           end
 
           unless @type == :integer || @type == :float
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @greater_than_validation = GreaterThanValidation.new value
@@ -158,15 +146,15 @@ module DSLCompose
 
         def validate_greater_than_or_equal_to value
           if @greater_than_or_equal_to_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `greater_than_or_equal_to` has already been applied to this method option."
           end
 
           unless value.is_a?(Numeric)
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, value
           end
 
           unless @type == :integer || @type == :float
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @greater_than_or_equal_to_validation = GreaterThanOrEqualToValidation.new value
@@ -174,15 +162,15 @@ module DSLCompose
 
         def validate_less_than value
           if @less_than_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `less_than` has already been applied to this method option."
           end
 
           unless value.is_a?(Numeric)
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, value
           end
 
           unless @type == :integer || @type == :float
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @less_than_validation = LessThanValidation.new value
@@ -190,15 +178,15 @@ module DSLCompose
 
         def validate_less_than_or_equal_to value
           if @less_than_or_equal_to_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `less_than_or_equal_to` has already been applied to this method option."
           end
 
           unless value.is_a?(Numeric)
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, value
           end
 
           unless @type == :integer || @type == :float
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @less_than_or_equal_to_validation = LessThanOrEqualToValidation.new value
@@ -206,26 +194,26 @@ module DSLCompose
 
         def validate_format regexp
           if @format_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `format` has already been applied to this method option."
           end
 
           unless regexp.is_a? Regexp
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, regexp
           end
 
           unless @type == :string || @type == :symbol
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
           @format_validation = FormatValidation.new regexp
         end
 
         def validate_equal_to value
           if @equal_to_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `equal_to` has already been applied to this method option."
           end
 
           unless @type == :integer || @type == :float || @type == :string || @type == :symbol || @type == :boolean
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @equal_to_validation = EqualToValidation.new value
@@ -233,15 +221,15 @@ module DSLCompose
 
         def validate_in values
           if @in_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `in` has already been applied to this method option."
           end
 
           unless values.is_a? Array
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, values
           end
 
           unless @type == :integer || @type == :float || @type == :string || @type == :symbol
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @in_validation = InValidation.new values
@@ -249,15 +237,15 @@ module DSLCompose
 
         def validate_not_in values
           if @not_in_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `not_in` has already been applied to this method option."
           end
 
           unless values.is_a? Array
-            raise ValidationInvalidArgumentError
+            raise ValidationInvalidArgumentError, values
           end
 
           unless @type == :integer || @type == :float || @type == :string || @type == :symbol
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @not_in_validation = NotInValidation.new values
@@ -265,11 +253,11 @@ module DSLCompose
 
         def validate_length maximum: nil, minimum: nil, is: nil
           if @length_validation
-            raise ValidationAlreadyExistsError
+            raise ValidationAlreadyExistsError, "The validation `length` has already been applied to this method option."
           end
 
           unless @type == :string || @type == :symbol
-            raise ValidationIncompatibleError
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
           @length_validation = LengthValidation.new(maximum: maximum, minimum: minimum, is: is)

data/lib/dsl_compose/dsl/arguments.rb

@@ -4,33 +4,18 @@ module DSLCompose
   class DSL
     class Arguments
       class ArgumentDoesNotExistError < StandardError
-        def message
-          "This argument does not exist for this DSLMethod"
-        end
       end
 
       class ArgumentOrderingError < StandardError
-        def message
-          "Required arguments can not be added after optional ones"
-        end
       end
 
       class ArgumentAlreadyExistsError < StandardError
-        def message
-          "An argument with this name already exists for this DSL method"
-        end
       end
 
       class RequestedOptionalArgumentIsRequiredError < StandardError
-        def message
-          "A specific argument which was expected to be optional was requested, but the argument found was flagged as required"
-        end
       end
 
       class RequestedRequiredArgumentIsOptionalError < StandardError
-        def message
-          "A specific argument which was expected to be required was requested, but the argument found was flagged as optional"
-        end
       end
 
       def initialize
@@ -58,7 +43,7 @@ module DSLCompose
         if has_argument? name
           @arguments[name]
         else
-          raise ArgumentDoesNotExistError
+          raise ArgumentDoesNotExistError, "The argument `#{name}` does not exist for this DSLMethod"
         end
       end
 
@@ -69,7 +54,7 @@ module DSLCompose
         if arg.optional?
           @arguments[name]
         else
-          raise RequestedOptionalArgumentIsRequiredError
+          raise RequestedOptionalArgumentIsRequiredError, "A specific argument `#{name}` which was expected to be optional was requested, but the argument found was flagged as required"
         end
       end
 
@@ -80,7 +65,7 @@ module DSLCompose
         if arg.required?
           @arguments[name]
         else
-          raise RequestedRequiredArgumentIsOptionalError
+          raise RequestedRequiredArgumentIsOptionalError, "A specific argument `#{name}` which was expected to be required was requested, but the argument found was flagged as optional"
         end
       end
 
@@ -98,12 +83,12 @@ module DSLCompose
       # or optional on the method which is exposed in our DSL.
       def add_argument name, required, type, &block
         if @arguments.key? name
-          raise ArgumentAlreadyExistsError
+          raise ArgumentAlreadyExistsError, "An argument with the name `#{name}` already exists for this DSL method"
         end
 
         # required arguments may not come after optional ones
         if required && optional_arguments.any?
-          raise ArgumentOrderingError
+          raise ArgumentOrderingError, "Required arguments can not be added after optional ones"
         end
 
         @arguments[name] = Argument.new(name, required, type, &block)