dsl_compose 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c143f5741011efd1d4311e4b2b5beab52fb75600f0c7f492fdb199cc3221c502
-  data.tar.gz: '09a0982fa552f3e36a1005e4b345eaf5294bc3b62c10c41eebb6dbdf42e3a102'
+  metadata.gz: 952d89e2f9b95412aec641b8faa5219512290924b02923819ca3438f8d6d1500
+  data.tar.gz: 3f66573596355a16a9477bd6844d552691ea9dded5525335de8ae4b1ca114cea
 SHA512:
-  metadata.gz: 45988d0bbd27cbc1ee285608a795d1cdc95dccf4bce14ccdd76ea0aad26daec4345262c140f73a4059becbe4148aef9548b5b8f127585557ad90b974c9b0807b
-  data.tar.gz: e889b48f585730f5a8a05349e8c90e527885e5393512ecea5568feab6c71e0a82ce9e5b7b417af6d7bcbb4a35f9459a4537b0bbb337e5825bc1e72833cef4edf
+  metadata.gz: cc1ed1223977ff6acfa4eb6827180673f69f91449ce060f8a1c99e6756e459f78c22261c46bfcf9359e7ac2fc6ea4aa3ba44f9ed839462e04b7518c3a419e928
+  data.tar.gz: af5c4e85b2d3368a57610af4ef4b580651e12b32896dcd61d270f5c2d1ebdcda2acf4341a83497f965c695ace817d1d46d827b3da5696f306bf2febf9e8ff04e

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.14.0](https://github.com/craigulliott/dsl_compose/compare/v2.13.1...v2.14.0) (2023-09-06)
+
+
+### Features
+
+* adding start_with/end_with and format validators to classes ([d390d15](https://github.com/craigulliott/dsl_compose/commit/d390d15bf2ebec2340815ff0a372a938072efd0e))
+
+## [2.13.1](https://github.com/craigulliott/dsl_compose/compare/v2.13.0...v2.13.1) (2023-09-05)
+
+
+### Bug Fixes
+
+* fixed a nil value in error message caused by overwriting method argument ([dd7848b](https://github.com/craigulliott/dsl_compose/commit/dd7848b3861bff6176c8326f6784fb29f1ba2fdd))
+
 ## [2.13.0](https://github.com/craigulliott/dsl_compose/compare/v2.12.0...v2.13.0) (2023-09-04)
 
 

data/README.md

@@ -597,16 +597,16 @@ The following validations can be added to the arguments of your DSL methods. Val
         validate_in ["cat", "dog"]
 
         # The argument must start with the following string.
-        validate_start_with [:foo_]
+        validate_start_with ["foo_"]
 
         # The argument must not start with the following string.
-        validate_not_start_with [:foo_]
+        validate_not_start_with ["foo_"]
 
         # The argument must end with the following string.
-        validate_end_with [:_foo]
+        validate_end_with ["_foo"]
 
         # The argument must not end with the following string.
-        validate_not_end_with [:_foo]
+        validate_not_end_with ["_foo"]
 
         # The argument must match the provided regex.
         validate_format /\A[A-Z][a-z]+\Z/
@@ -692,7 +692,20 @@ The following validations can be added to the arguments of your DSL methods. Val
 
       requires :my_first_argument, :class do
 
-        # There are no validations for :class types
+        # The class name must start with the following string.
+        validate_start_with ["foo_"]
+
+        # The class name must not start with the following string.
+        validate_not_start_with ["foo_"]
+
+        # The class name must end with the following string.
+        validate_end_with ["_foo"]
+
+        # The class name must not end with the following string.
+        validate_not_end_with ["_foo"]
+
+        # The class name must match the provided regex.
+        validate_format /\A[A-Z][a-z]+\Z/
 
       end
 

data/lib/dsl_compose/class_coerce.rb

@@ -5,6 +5,8 @@ module DSLCompose
     class UnexpectedClassNameError < StandardError
     end
 
+    attr_reader :class_name
+
     def initialize class_name
       unless class_name.is_a? String
         raise UnexpectedClassNameError, "expected `#{class_name}` to be a String"

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               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"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             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"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               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"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             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"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               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"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             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"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               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"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             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"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -225,7 +225,7 @@ module DSLCompose
             raise ValidationInvalidArgumentError, regexp
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
           @format_validation = FormatValidation.new regexp
@@ -278,11 +278,11 @@ module DSLCompose
         end
 
         def validate_end_with value
-          unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
-            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
+          unless value.is_a?(Symbol) || value.is_a?(String) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol }) || (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -295,11 +295,11 @@ module DSLCompose
         end
 
         def validate_not_end_with value
-          unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
-            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
+          unless value.is_a?(Symbol) || value.is_a?(String) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol }) || (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -312,11 +312,11 @@ module DSLCompose
         end
 
         def validate_start_with value
-          unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
-            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
+          unless value.is_a?(Symbol) || value.is_a?(String) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol }) || (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -329,11 +329,11 @@ module DSLCompose
         end
 
         def validate_not_start_with value
-          unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
-            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
+          unless value.is_a?(Symbol) || value.is_a?(String) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol }) || (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -421,8 +421,11 @@ module DSLCompose
 
         # returns true if every provided class validation also returns true
         def validate_class! value
-          # there are no class validations
-          true
+          (format_validation.nil? || format_validation.validate!(value.class_name)) &&
+            (end_with_validation.nil? || end_with_validation.validate!(value.class_name)) &&
+            (not_end_with_validation.nil? || not_end_with_validation.validate!(value.class_name)) &&
+            (start_with_validation.nil? || start_with_validation.validate!(value.class_name)) &&
+            (not_start_with_validation.nil? || not_start_with_validation.validate!(value.class_name))
         end
 
         # returns true if every provided object validation also returns true

data/lib/dsl_compose/reader.rb

@@ -24,24 +24,25 @@ module DSLCompose
       # Move up through this classes ancestors until we find the class which defined
       # the DSL with the provided name. When we reach the top of the ancestor chain we
       # exit the loop.
-      while klass
+      k = klass
+      while k
         # if we find a DSL with this name, then store a reference to the DSL and the
         # ancestor class where it was defined
-        if DSLs.class_dsl_exists?(klass, dsl_name)
-          @dsl = DSLs.class_dsl(klass, dsl_name)
-          @dsl_defining_class = klass
+        if DSLs.class_dsl_exists?(k, dsl_name)
+          @dsl = DSLs.class_dsl(k, dsl_name)
+          @dsl_defining_class = k
           # stop once we find the DSL
           break
         end
 
         # the DSL was not found here, so traverse up the provided classes hierachy
         # and keep looking for where this DSL was initially defined
-        klass = klass.superclass
+        k = k.superclass
       end
 
       # if no DSL was found, then raise an error
       if @dsl.nil? && @dsl_defining_class.nil?
-        raise DSLNotFound, "No DSL named `#{dsl_name}` was found for class `#{klass}`"
+        raise DSLNotFound, "No DSL named `#{dsl_name}` was found for class `#{@klass}`"
       end
     end
 

data/lib/dsl_compose/version.rb

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

data/sig/dsl_compose/dsl/arguments/argument/end_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class EndWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/interpreter.rbs

@@ -19,10 +19,10 @@ module DSLCompose
           def validate_length: (?minimum: Numeric?, ?maximum: Numeric?, ?is: Numeric?) -> void
           def validate_not_in: ([Numeric | Symbol | String] values) -> void
           def validate_in: ([Numeric | Symbol | String] values) -> void
-          def validate_end_with: (Symbol | Array[Symbol] value) -> void
-          def validate_not_end_with: (Symbol | Array[Symbol] value) -> void
-          def validate_start_with: (Symbol | Array[Symbol] value) -> void
-          def validate_not_start_with: (Symbol | Array[Symbol] value) -> void
+          def validate_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_not_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_not_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
           def validate_format: (Regexp regex) -> void
           def validate_is_a: (String class_name) -> void
         end

data/sig/dsl_compose/dsl/arguments/argument/not_end_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class NotEndWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/not_start_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class NotStartWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/start_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class StartWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument.rbs

@@ -42,10 +42,10 @@ module DSLCompose
         def validate_equal_to: (Numeric | Symbol | String value) -> void
         def validate_in: (Array[Numeric | Symbol | String] values) -> void
         def validate_not_in: (Array[Numeric | Symbol | String] values) -> void
-        def validate_end_with: (Symbol | Array[Symbol] value) -> void
-        def validate_not_end_with: (Symbol | Array[Symbol] value) -> void
-        def validate_start_with: (Symbol | Array[Symbol] value) -> void
-        def validate_not_start_with: (Symbol | Array[Symbol] value) -> void
+        def validate_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_not_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_not_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
         def validate_length: (?maximum: nil | Numeric, ?minimum: nil | Numeric, ?is: nil | Numeric) -> void
         def validate_is_a: (String class_name) -> void
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_spec_helper