dsl_compose 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461fe3b90a0a36703aee0be51b3594472d2fc55ff1eab2b6b5bfabd851446d09
-  data.tar.gz: 65ba43be5dfcefbaf5588744b66fcd73a8266abbea65bcb59699132c43ed47a7
+  metadata.gz: 44f916259ac32c44bb38f5c8a423d6e41f9c3b61604715bb1e550b1ab9f5dc64
+  data.tar.gz: 22a2303459feb386ac8fa0995323fa95001d2312e83d90271d0868f66cf69e82
 SHA512:
-  metadata.gz: 9d2b86c2398b49217ba29152f68f6666e0bcbe926d4adadaac29b4f4a3d8500b120192c469c4fa25f68b68c58e73782459356a7845bcabb0237076521e4e0f37
-  data.tar.gz: 4f58959006d911cb13d75ccddc1871416736236d0e278844f6beb1c22a546d2e8d3620230931a2108c8949ad346a65ce27f3ae437fd8d55e5563603ad8421d24
+  metadata.gz: fcf694293406ec2b317da5a9ea7f9fcfac87efae1ecd8cf481e27325d916b61ffdb23b54909589d01cdbb2e30d1fc612c5f6bd7d6e1618e2db937bf97c43f052
+  data.tar.gz: a50c27fe9ffab7b47326c1e4826983fe0bcec1428fed0f2d5d7e0b54d928e5c592cba2d8973b88f11e08bcc295f50a6def76058de086d97fd14f98273c656019

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.9.0](https://github.com/craigulliott/dsl_compose/compare/v1.8.0...v1.9.0) (2023-07-11)
+
+
+### Features
+
+* start_with, not_start_with, end_with and not_end_with validators now accept an array of values to test against ([#23](https://github.com/craigulliott/dsl_compose/issues/23)) ([cddcb4b](https://github.com/craigulliott/dsl_compose/commit/cddcb4b629499e3af0d71cc27f5c2f1dd8ae76d5))
+
+## [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)
 
 

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class EndWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize values
+            # if the provided values is a symbol, then convert it to an array
+            if values.is_a? Symbol
+              values = [values]
+            end
+
+            # assert that the provided values is an array
+            unless values.is_a? Array
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            # assert that the provided values is an array of symbols
+            unless values.all? { |value| value.is_a? Symbol }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            @values = values
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to end with `#{@values}`" unless @values.filter { |v| value.end_with? v.to_s }.any?
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module DSLCompose
 
           def validate! 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

@@ -9,11 +9,16 @@ module DSLCompose
           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, "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

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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/less_than_or_equal_to_validation.rb

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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,41 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class NotEndWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize values
+            # if the provided values is a symbol, then convert it to an array
+            if values.is_a? Symbol
+              values = [values]
+            end
+
+            # assert that the provided values is an array
+            unless values.is_a? Array
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            # assert that the provided values is an array of symbols
+            unless values.all? { |value| value.is_a? Symbol }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            @values = values
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to not end with `#{@values}`" if @values.filter { |v| value.end_with? v.to_s }.any?
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ module DSLCompose
 
           def validate! 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,41 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class NotStartWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize values
+            # if the provided values is a symbol, then convert it to an array
+            if values.is_a? Symbol
+              values = [values]
+            end
+
+            # assert that the provided values is an array
+            unless values.is_a? Array
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            # assert that the provided values is an array of symbols
+            unless values.all? { |value| value.is_a? Symbol }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            @values = values
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to not start with `#{@values}`" if @values.filter { |v| value.start_with? v.to_s }.any?
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class DSL
+    class Arguments
+      class Argument
+        class StartWithValidation
+          class InvalidValueError < StandardError
+          end
+
+          class ValidationFailedError < StandardError
+          end
+
+          def initialize values
+            # if the provided values is a symbol, then convert it to an array
+            if values.is_a? Symbol
+              values = [values]
+            end
+
+            # assert that the provided values is an array
+            unless values.is_a? Array
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            # assert that the provided values is an array of symbols
+            unless values.all? { |value| value.is_a? Symbol }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            end
+
+            @values = values
+          end
+
+          def validate! value
+            raise ValidationFailedError, "The argument is invalid. Expected `#{value}` to start with `#{@values}`" unless @values.filter { |v| value.start_with? v.to_s }.any?
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -56,6 +56,10 @@ module DSLCompose
         attr_reader :equal_to_validation
         attr_reader :in_validation
         attr_reader :not_in_validation
+        attr_reader :end_with_validation
+        attr_reader :not_end_with_validation
+        attr_reader :start_with_validation
+        attr_reader :not_start_with_validation
         attr_reader :length_validation
 
         # Create a new Attribute object.
@@ -251,6 +255,70 @@ module DSLCompose
           @not_in_validation = NotInValidation.new values
         end
 
+        def validate_end_with value
+          if @end_with_validation
+            raise ValidationAlreadyExistsError, "The validation `end_with` has already been applied to this method option."
+          end
+
+          unless value.is_a? Symbol
+            raise ValidationInvalidArgumentError, value
+          end
+
+          unless @type == :string || @type == :symbol
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
+          end
+
+          @end_with_validation = EndWithValidation.new value
+        end
+
+        def validate_not_end_with value
+          if @not_end_with_validation
+            raise ValidationAlreadyExistsError, "The validation `not_end_with` has already been applied to this method option."
+          end
+
+          unless value.is_a? Symbol
+            raise ValidationInvalidArgumentError, value
+          end
+
+          unless @type == :string || @type == :symbol
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
+          end
+
+          @not_end_with_validation = NotEndWithValidation.new value
+        end
+
+        def validate_start_with value
+          if @start_with_validation
+            raise ValidationAlreadyExistsError, "The validation `start_with` has already been applied to this method option."
+          end
+
+          unless value.is_a? Symbol
+            raise ValidationInvalidArgumentError, value
+          end
+
+          unless @type == :string || @type == :symbol
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
+          end
+
+          @start_with_validation = StartWithValidation.new value
+        end
+
+        def validate_not_start_with value
+          if @not_start_with_validation
+            raise ValidationAlreadyExistsError, "The validation `not_start_with` has already been applied to this method option."
+          end
+
+          unless value.is_a? Symbol
+            raise ValidationInvalidArgumentError, value
+          end
+
+          unless @type == :string || @type == :symbol
+            raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
+          end
+
+          @not_start_with_validation = NotStartWithValidation.new value
+        end
+
         def validate_length maximum: nil, minimum: nil, is: nil
           if @length_validation
             raise ValidationAlreadyExistsError, "The validation `length` has already been applied to this method option."
@@ -282,6 +350,10 @@ module DSLCompose
             (equal_to_validation.nil? || equal_to_validation.validate!(value)) &&
             (in_validation.nil? || in_validation.validate!(value)) &&
             (not_in_validation.nil? || not_in_validation.validate!(value)) &&
+            (end_with_validation.nil? || end_with_validation.validate!(value)) &&
+            (not_end_with_validation.nil? || not_end_with_validation.validate!(value)) &&
+            (start_with_validation.nil? || start_with_validation.validate!(value)) &&
+            (not_start_with_validation.nil? || not_start_with_validation.validate!(value)) &&
             (length_validation.nil? || length_validation.validate!(value))
         end
 
@@ -291,6 +363,10 @@ module DSLCompose
             (equal_to_validation.nil? || equal_to_validation.validate!(value)) &&
             (in_validation.nil? || in_validation.validate!(value)) &&
             (not_in_validation.nil? || not_in_validation.validate!(value)) &&
+            (end_with_validation.nil? || end_with_validation.validate!(value)) &&
+            (not_end_with_validation.nil? || not_end_with_validation.validate!(value)) &&
+            (start_with_validation.nil? || start_with_validation.validate!(value)) &&
+            (not_start_with_validation.nil? || not_start_with_validation.validate!(value)) &&
             (length_validation.nil? || length_validation.validate!(value))
         end
 

data/lib/dsl_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DSLCompose
-  VERSION = "1.7.0"
+  VERSION = "1.9.0"
 end

data/lib/dsl_compose.rb

@@ -3,6 +3,7 @@
 require "dsl_compose/version"
 
 require "dsl_compose/dsl/arguments/argument/equal_to_validation"
+require "dsl_compose/dsl/arguments/argument/end_with_validation"
 require "dsl_compose/dsl/arguments/argument/format_validation"
 require "dsl_compose/dsl/arguments/argument/greater_than_or_equal_to_validation"
 require "dsl_compose/dsl/arguments/argument/greater_than_validation"
@@ -10,7 +11,10 @@ require "dsl_compose/dsl/arguments/argument/in_validation"
 require "dsl_compose/dsl/arguments/argument/length_validation"
 require "dsl_compose/dsl/arguments/argument/less_than_or_equal_to_validation"
 require "dsl_compose/dsl/arguments/argument/less_than_validation"
+require "dsl_compose/dsl/arguments/argument/not_end_with_validation"
 require "dsl_compose/dsl/arguments/argument/not_in_validation"
+require "dsl_compose/dsl/arguments/argument/not_start_with_validation"
+require "dsl_compose/dsl/arguments/argument/start_with_validation"
 
 require "dsl_compose/dsl/arguments/argument/interpreter"
 require "dsl_compose/dsl/arguments/argument"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem to add dynamic DSLs to classes. DSLs are added to classes by
   including the DSLCompose module, and then calling the add_dsl singleton method within
@@ -28,6 +28,7 @@ files:
 - lib/dsl_compose/dsl.rb
 - lib/dsl_compose/dsl/arguments.rb
 - lib/dsl_compose/dsl/arguments/argument.rb
+- lib/dsl_compose/dsl/arguments/argument/end_with_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/equal_to_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/format_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/greater_than_or_equal_to_validation.rb
@@ -37,7 +38,10 @@ files:
 - lib/dsl_compose/dsl/arguments/argument/length_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/less_than_or_equal_to_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/less_than_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/not_end_with_validation.rb
 - lib/dsl_compose/dsl/arguments/argument/not_in_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/not_start_with_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/start_with_validation.rb
 - lib/dsl_compose/dsl/dsl_method.rb
 - lib/dsl_compose/dsl/dsl_method/interpreter.rb
 - lib/dsl_compose/dsl/interpreter.rb