dsl_compose 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a691703918ebafb30bb7c158e627e6a02597e9171e38d1b87cd4cd066d825d
-  data.tar.gz: 4e750c6839f7946299f13e81b8af0a7ca94e8d852d7a418f8be97658a0ba67a8
+  metadata.gz: f39f962fc5991e68164ab544ca3cb85b7f538296d393f360fdda683956c883bd
+  data.tar.gz: d68a46d791c33ac1ed435d9be92490ebbd76b053f13d2ef5a17247caf245b148
 SHA512:
-  metadata.gz: aa82b56b1c7b6cfcbf4b0116c34b4084f5873cd5d957ceb615b16ab4b36f44a6d3da1ffea8a8ef779b837322d0622254e8688fa4fecffdcb6a011a531aa31106
-  data.tar.gz: b1d02bc6e922d35aeee52095bfd3847d5ae347ef56e6278a4f90bb4c76666e0829dad6638956f96a555400a129160f5431d197b264dc1103532c2a1b6df14de2
+  metadata.gz: 97b3fdcdd3b2ded2028155a9a767fb9cacf8a0e39b00a3cf8e203290d78a7bdbce9119b0b2b856b82afb61c209e24025c9e94991dfa5abe7383f55efc69446e4
+  data.tar.gz: 38d4eda779bb41af8300ce7d266307eb8fa58529bca51d9c9dcf1589ed1b11f535d4a0746ea359c18f56ca5aae30a13655d987bc0f3de06bf2bdc6f560701f82

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.8.0](https://github.com/craigulliott/dsl_compose/compare/v1.7.0...v1.8.0) (2023-07-11)
+
+
+### Features
+
+* adding start_with, not_start_with, end_with and not_end_with ar… ([#21](https://github.com/craigulliott/dsl_compose/issues/21)) ([ea2f213](https://github.com/craigulliott/dsl_compose/commit/ea2f2130c1b9a856e89cbf9b4f09c0c3c739d3de))
+
+## [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)
 
 

data/README.md

@@ -292,6 +292,18 @@ The following validations can be added to the arguments of your DSL methods. Val
         # The argument must be one of the provided values.
         validate_in ["cat", "dog"]
 
+        # The argument must start with the following string.
+        validate_start_with ["foo_"]
+
+        # The argument must not start with the following string.
+        validate_not_start_with ["foo_"]
+
+        # The argument must end with the following string.
+        validate_end_with ["_foo"]
+
+        # The argument must not end with the following string.
+        validate_not_end_with ["_foo"]
+
         # The argument must match the provided regex.
         validate_format /\A[A-Z][a-z]+\Z/
 
@@ -327,6 +339,18 @@ The following validations can be added to the arguments of your DSL methods. Val
         # The argument must be one of the provided values.
         validate_in [:cat, :dog]
 
+        # The argument must start with the following string.
+        validate_start_with ["foo_"]
+
+        # The argument must not start with the following string.
+        validate_not_start_with ["foo_"]
+
+        # The argument must end with the following string.
+        validate_end_with ["_foo"]
+
+        # The argument must not end with the following string.
+        validate_not_end_with ["_foo"]
+
         # The argument must match the provided regex.
         validate_format /\A[A-Z][a-z]+\Z/
 

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/end_with_validation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class EndWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize value
+            unless value.is_a?(String)
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type String"
+            end
+
+            @value = value
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to end with `#{@value}`" unless value.end_with? @value
+            true
+          end
+        end
+      end
+    end
+  end
+end

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,8 @@ 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
+            true
           end
         end
       end

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

@@ -6,17 +6,19 @@ module DSLCompose
       class Argument
         class FormatValidation
           class ValidationFailedError < StandardError
-            def message
-              "The argument is invalid"
-            end
           end
 
           def initialize regex
+            unless regex.is_a?(Regexp)
+              raise InvalidValueError, "The value `#{regex}` provided to this validator must be of type Regexp"
+            end
+
             @regex = regex
           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?
+            true
           end
         end
       end

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

@@ -6,27 +6,22 @@ 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
+            true
           end
         end
       end

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

@@ -6,27 +6,22 @@ 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
+            true
           end
         end
       end

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

@@ -6,27 +6,22 @@ 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
+            true
           end
         end
       end

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

@@ -75,6 +75,26 @@ module DSLCompose
             @argument.validate_in values
           end
 
+          # adds an end_with validator to the argument
+          def validate_end_with value
+            @argument.validate_end_with value
+          end
+
+          # adds a not_end_with validator to the argument
+          def validate_not_end_with value
+            @argument.validate_not_end_with value
+          end
+
+          # adds a start_with validator to the argument
+          def validate_start_with value
+            @argument.validate_start_with value
+          end
+
+          # adds a not_start_with validator to the argument
+          def validate_not_start_with value
+            @argument.validate_not_start_with value
+          end
+
           # adds a format validator to the argument
           def validate_format regexp
             @argument.validate_format regexp

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,22 @@ 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
+            true
           end
         end
       end

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

@@ -6,27 +6,22 @@ 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
+            true
           end
         end
       end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class NotEndWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize value
+            unless value.is_a?(String)
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type String"
+            end
+
+            @value = value
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to not end with `#{@value}`" if value.end_with? @value
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,27 +6,22 @@ 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)
+            true
           end
         end
       end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class NotStartWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize value
+            unless value.is_a?(String)
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type String"
+            end
+
+            @value = value
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to not start with `#{@value}`" if value.start_with? @value
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class StartWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize value
+            unless value.is_a?(String)
+              raise InvalidValueError, "The value `#{value}` provided to this validator must be of type String"
+            end
+
+            @value = value
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to start with `#{@value}`" unless value.start_with? @value
+            true
+          end
+        end
+      end
+    end
+  end
+end