data_model 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f03f11c2ab99a1d4e680f8d0ef911b6508bc2802795c7d0ede161f88ea366e
-  data.tar.gz: d5278afd3d3aa5a14c4972ee8024d94b86722ac5bfe9a5a01e6a21c521a8e29a
+  metadata.gz: c62c4d806d3e7bbbac5e4031d91b6f681dcb2697fd09e6a81c90e1b3cdc95ad6
+  data.tar.gz: 6bde7c362323265251688a38946ea992451fdd9d1c57838d6dfaa563a49b814d
 SHA512:
-  metadata.gz: f5e57acc83fbc9657ccf2923570d1bc8b91ddcb4f097a74b75335130552df0f91463e59a435f7f62c841bf29aafdd3ca5d9ca88099294d183fb7f1e1329b1a53
-  data.tar.gz: 88b48a214de563da00ff1db868a18a1319c0b3d290317d940738f2eb1c516d51eaee5435ce9d054594fb4a1aef0f87fa0f23ccd1b02fa67c33d7067640a86863
+  metadata.gz: 7ed6672730afd6792a13c753ad5bc96694d5dc8982d3411b3d0af3f25e5682096f6a08c939837f473983f264960e1047d076c3304ca98618c020796ab312449f
+  data.tar.gz: 2a849997505c5d60c04fc48a51bd5049eb4ee2b90a2d5490929261fb1c03fed818e87834bdc800d748e71d5fd7fd454a19c2664e3c28044c486884149452feed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    data_model (0.1.0)
+    data_model (0.2.0)
       sorbet
       zeitwerk
 

data/lib/data_model/builtin/string.rb

@@ -4,9 +4,12 @@ module DataModel
 	class Builtin::String < Type
 		include Errors
 
+		TFormatter = T.type_alias { T.proc.params(val: String).returns(T::Boolean) }
+
 		class Arguments < T::Struct
 			prop :optional, T::Boolean, default: false
 			prop :allow_blank, T::Boolean, default: true
+			prop :format, T.nilable(T.any(String, Regexp, TFormatter)), default: nil
 			prop :included, T::Array[String], default: []
 			prop :excluded, T::Array[String], default: []
 		end
@@ -42,22 +45,40 @@ module DataModel
 				end
 			end
 
+			val = T.cast(val, String)
+
+			# format
+			fmt = args.format
+			if fmt
+				case fmt
+				when String
+					if !val.match?(fmt)
+						err.add(format_error(fmt, val))
+					end
+				when Regexp
+					if !val.match?(fmt)
+						err.add(format_error(fmt, val))
+					end
+				when Proc
+					if !fmt.call(val)
+						err.add(format_error("<Custom Proc>", val))
+					end
+				end
+			end
+
 			# inclusion
 			if args.included.any? && !args.included.include?(val)
 				err.add(inclusion_error(args.included))
-				return [val, err]
 			end
 
 			# exclusion
 			if args.excluded.any? && args.excluded.include?(val)
 				err.add(exclusion_error(args.excluded))
-				return [val, err]
 			end
 
 			# allow blank
-			if val.is_a?(String) && !args.allow_blank && val.empty?
+			if !args.allow_blank && val.empty?
 				err.add(blank_error)
-				return [val, err]
 			end
 
 			# done

data/lib/data_model/errors.rb

@@ -76,6 +76,12 @@ module DataModel
 			[:latest, [latest, val]]
 		end
 
+		# Format applies when value does not match a format
+		sig { params(format: Object, val: String).returns(TError) }
+		def format_error(format, val)
+			[:format, [format, val]]
+		end
+
 		## Messages
 
 		# Generate a message for a type error
@@ -144,6 +150,12 @@ module DataModel
 			"value #{val} is after #{latest}"
 		end
 
+		# Generate a message for a value that does not match the format
+		sig { params(format: Object, val: String).returns(String) }
+		def format_error_message(format, val)
+			"value #{val} does not match format #{format}"
+		end
+
 		## API
 		# TODO: split this file
 
@@ -161,6 +173,7 @@ module DataModel
 		TSetCtx = T.type_alias { T::Array[Symbol] }
 		TWithinCtx = T.type_alias { [Numeric, Numeric] }
 		TWithinTemporalCtx = T.type_alias { [TTemporal, TTemporal] }
+		TFormatCtx = T.type_alias { [Object, String] }
 
 		# Get the error message builders
 		sig { returns(TErrorMessages) }
@@ -223,6 +236,11 @@ module DataModel
 				register_error_message(:blank) do
 					blank_error_message
 				end
+
+				register_error_message(:format) do |ctx|
+					format, val = T.let(ctx, TFormatCtx)
+					format_error_message(format, val)
+				end
 			end
 
 			@error_messages

data/lib/data_model/fixtures/string.rb

@@ -18,6 +18,39 @@ module DataModel
 			)
 		end
 
+		sig { returns(Example) }
+		def email
+			Example.new(
+				[:string, { format: "@" }],
+				variants: {
+					valid: "foo@bar.com",
+					invalid: "invalid"
+				},
+			)
+		end
+
+		sig { returns(Example) }
+		def email_regexp
+			Example.new(
+				[:string, { format: /@/ }],
+				variants: {
+					valid: "foo@bar.com",
+					invalid: "invalid"
+				},
+			)
+		end
+
+		sig { returns(Example) }
+		def email_proc
+			Example.new(
+				[:string, { format: ->(val) { val.match?(/@/) } }],
+				variants: {
+					valid: "foo@bar.com",
+					invalid: "invalid"
+				},
+			)
+		end
+
 		sig { returns(Example) }
 		def optional
 			Example.new(

data/lib/data_model/version.rb

@@ -1,5 +1,5 @@
 # typed: strict
 
 module DataModel
-	VERSION = "0.1.0"
+	VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Briggs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet