data_model 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f87b58a7e7706f284041ccc8479520af309c3e632ef89311be431a11112273
-  data.tar.gz: e945d11a1ac73459be8b1c067eb8bc40cafe7f43a665cb069fecf880d413d91d
+  metadata.gz: c62c4d806d3e7bbbac5e4031d91b6f681dcb2697fd09e6a81c90e1b3cdc95ad6
+  data.tar.gz: 6bde7c362323265251688a38946ea992451fdd9d1c57838d6dfaa563a49b814d
 SHA512:
-  metadata.gz: f6470deed88de3b60a5aad2e5926724f4d3255567d0668016ff6c13e1a82608ea71dc8b82ae82a4b0993771c222ad3a9353236243e6c0e8f8c4c0423614e8c71
-  data.tar.gz: 82434cccbdb292e7e416e46eb1eb353193ff39329008a107b2837d97b2c907228c79c62f3be16a2f5966c437c777372f2c08708e0acf5b688fb2f22232565dae
+  metadata.gz: 7ed6672730afd6792a13c753ad5bc96694d5dc8982d3411b3d0af3f25e5682096f6a08c939837f473983f264960e1047d076c3304ca98618c020796ab312449f
+  data.tar.gz: 2a849997505c5d60c04fc48a51bd5049eb4ee2b90a2d5490929261fb1c03fed818e87834bdc800d748e71d5fd7fd454a19c2664e3c28044c486884149452feed

data/.editorconfig

@@ -2,9 +2,13 @@ root = true
 
 [*]
 indent_style = tab
-indent_size = 2
+indent_size = tab
+insert_final_newline = true
+tab_width = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
 
 [*.yml]
 indent_style = space
 indent_size = 2
-

data/.rubocop.yml

@@ -1,4 +1,13 @@
 inherit_from: "https://raw.githubusercontent.com/mbriggs/configs/main/dotfiles/rubocop.yml"
 
-Style/SymbolArray:
-  EnforcedStyle: brackets
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - 'sorbet/**/*'
+
+Style/GlobalStdStream:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1,2 @@
+system
+

data/Gemfile.lock

@@ -1,80 +1,117 @@
 PATH
   remote: .
   specs:
-    data_model (0.0.1)
-      zeitwerk (~> 2.6)
+    data_model (0.2.0)
+      sorbet
+      zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    backport (1.2.0)
-    benchmark (0.2.0)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
-    e2mmap (0.1.0)
-    jaro_winkler (1.5.4)
-    json (2.6.2)
-    kramdown (2.4.0)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    mini_portile2 (2.8.0)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-rake (1.0.0)
+      guard
+      rake
+    json (2.6.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nenv (0.3.0)
+    netrc (0.11.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    racc (1.6.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
-    regexp_parser (2.6.0)
-    reverse_markdown (2.1.1)
-      nokogiri
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rubocop (1.36.0)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    solargraph (0.47.2)
-      backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
-    sus (0.14.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    shellany (0.0.1)
+    sorbet (0.5.10795)
+      sorbet-static (= 0.5.10795)
+    sorbet-runtime (0.5.10795)
+    sorbet-static (0.5.10795-universal-darwin-22)
+    sorbet-static-and-runtime (0.5.10795)
+      sorbet (= 0.5.10795)
+      sorbet-runtime (= 0.5.10795)
+    spoom (1.2.1)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.11.5)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     thor (1.2.1)
-    tilt (2.0.11)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.1)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    yard (0.9.34)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.6.7)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
   data_model!
-  solargraph
-  sus (~> 0.14)
+  guard
+  guard-rake
+  minitest
+  rake
+  rubocop
+  sorbet-runtime
+  tapioca
 
 BUNDLED WITH
-   2.3.7
+   2.4.12

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard "rake", task: "test" do
+	watch(/.rb$/)
+end

data/Rakefile

@@ -0,0 +1,32 @@
+# typed: false
+
+require "minitest/test_task"
+
+Minitest::TestTask.create # named test, sensible defaults
+
+# or more explicitly:
+
+Minitest::TestTask.create(:test) do |t|
+	t.libs << "test"
+	t.libs << "lib"
+	t.warning = false
+	t.test_globs = ["test/**/*_test.rb"]
+end
+
+task default: :test
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "bundler"
+namespace :gem do
+	Bundler::GemHelper.install_tasks
+end
+
+task "test:watch" do
+	sh "bundle exec guard"
+end
+
+task :tc do
+	sh "bundle exec srb tc"
+end

data/data_model.gemspec

@@ -0,0 +1,52 @@
+require_relative "lib/data_model/version"
+
+Gem::Specification.new do |spec|
+	spec.name = "data_model"
+	spec.version = DataModel::VERSION
+	spec.authors = ["Matt Briggs"]
+	spec.email = ["matt@mattbriggs.net"]
+
+	spec.summary = "Define a model for your data"
+	spec.description = "A framework for describing and validating data."
+	spec.homepage = "https://github.com/mbriggs/data_model"
+	spec.license = "MIT"
+	spec.required_ruby_version = ">= 3.1"
+
+	spec.metadata["homepage_uri"] = spec.homepage
+	spec.metadata["source_code_uri"] = "https://github.com/mbriggs/data_model"
+	spec.metadata[
+		"changelog_uri"
+		] = "https://github.com/mbriggs/data_model/releases"
+	spec.metadata["funding_uri"] = "https://github.com/sponsors/mbriggs"
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files =
+		Dir.chdir(File.expand_path(__dir__)) do
+			`git ls-files -z`.split("\x0")
+																				.reject do |f|
+				(f == __FILE__) ||
+					f.match(
+						%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)},
+					)
+			end
+		end
+	spec.bindir = "exe"
+	spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "sorbet"
+	spec.add_dependency "zeitwerk"
+
+	spec.add_development_dependency "guard"
+	spec.add_development_dependency "guard-rake"
+	spec.add_development_dependency "minitest"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rubocop"
+	spec.add_development_dependency "sorbet-runtime"
+	spec.add_development_dependency "tapioca"
+
+	# For more information and examples about making a new gem, check out our
+	# guide at: https://bundler.io/guides/creating_gem.html
+	spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/data_model/boolean.rb

@@ -0,0 +1,7 @@
+# typed: strict
+
+module DataModel
+	# fills in for lack of boolean type in ruby
+	class Boolean
+	end
+end

data/lib/data_model/builtin/array.rb

@@ -0,0 +1,73 @@
+# typed: strict
+
+module DataModel
+	class Builtin::Array < Type
+		include Errors
+
+		class Arguments < T::Struct
+			prop :optional, T::Boolean, default: false
+			prop :wrap_single_value, T::Boolean, default: false
+			prop :min, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+			prop :max, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+			prop :length, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+		end
+
+		# support either :string shorthand or [:string, {optional: true}]
+		sig { override.params(params: T::Array[Object]).void }
+		def configure(params)
+			if params.first.is_a?(Array)
+				params = params.first
+			end
+
+			params = T.cast(params, TSchema)
+			node = Scanner.scan(params)
+			type = instantiate(node.type, args: node.args, params: node.params)
+
+			@child_type = T.let(type, T.nilable(Type))
+		end
+
+		sig { returns(Type) }
+		def child_type
+			if @child_type.nil?
+				raise "children not configured"
+			end
+
+			return @child_type
+		end
+
+		sig { override.params(val: Object, coerce: T::Boolean).returns(TTypeResult) }
+		def read(val, coerce: false)
+			args = Arguments.new(type_args)
+			err = Error.new
+
+			if val.nil? && !args.optional
+				err.add(missing_error(Array))
+				return [val, err]
+			end
+
+			if coerce && args.wrap_single_value
+				val = Array(val)
+			end
+
+			if !val.is_a?(Array)
+				err.add(type_error(Array, val))
+				return [val, err]
+			end
+
+			coerced = []
+
+			for i in 0...val.length
+				child_val = T.let(val[i], Object)
+				child, child_err = child_type.read(child_val, coerce:)
+				if child_err
+					err.merge_child(i.to_s.to_sym, child_err)
+				end
+				coerced << child
+			end
+
+			result = coerce ? coerced : val
+
+			return [result, err]
+		end
+	end
+end

data/lib/data_model/builtin/big_decimal.rb

@@ -0,0 +1,64 @@
+# typed: strict
+
+module DataModel
+	class Builtin::BigDecimal < Type
+		include Errors
+
+		class Arguments < T::Struct
+			prop :optional, T::Boolean, default: false
+			prop :min, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+			prop :max, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+		end
+
+		sig { override.params(val: Object, coerce: T::Boolean).returns(TTypeResult) }
+		def read(val, coerce: false)
+			err = Error.new
+			args = Arguments.new(type_args)
+
+			if args.optional && val.nil?
+				return [val, err]
+			end
+
+			if !args.optional && val.nil?
+				err.add(missing_error(BigDecimal))
+				return [val, err]
+			end
+
+			if !val.is_a?(BigDecimal) && !coerce
+				err.add(type_error(BigDecimal, val))
+				return [val, err]
+			end
+
+			if !val.is_a?(BigDecimal) && coerce
+				if val.is_a?(String) || val.is_a?(Numeric)
+					val = BigDecimal(T.unsafe(val))
+				elsif val.respond_to?(:to_d)
+					val = T.cast(T.unsafe(val).to_d, BigDecimal)
+				end
+
+				if !val.is_a?(BigDecimal)
+					err.add(coerce_error(BigDecimal, val))
+					return [val, err]
+				end
+			end
+
+			val = T.cast(val, BigDecimal)
+
+			min = args.min
+			if min && val <= min
+				err.add(min_error(min, val))
+
+				return [val, err]
+			end
+
+			max = args.max
+			if max && val <= max
+				err.add(max_error(max, val))
+
+				return [val, err]
+			end
+
+			[val, err]
+		end
+	end
+end

data/lib/data_model/builtin/boolean.rb

@@ -0,0 +1,37 @@
+# typed: strict
+
+module DataModel
+	class Builtin::Boolean < Type
+		include Errors
+
+		class Arguments < T::Struct
+			prop :optional, T::Boolean, default: false
+		end
+
+		sig { override.params(val: Object, coerce: T::Boolean).returns(TTypeResult) }
+		def read(val, coerce: false)
+			err = Error.new
+
+			if val.nil?
+				err.add(missing_error(DataModel::Boolean))
+				return [val, err]
+			end
+
+			if coerce
+				case val
+				when "true"
+					val = true
+				when "false"
+					val = false
+				end
+			end
+
+			if !val.is_a?(TrueClass) && !val.is_a?(FalseClass)
+				err.add(type_error(Boolean, val))
+				return [val, err]
+			end
+
+			return [val, err]
+		end
+	end
+end

data/lib/data_model/builtin/date.rb

@@ -0,0 +1,60 @@
+# typed: strict
+
+module DataModel
+	class Builtin::Date < Type
+		include Errors
+
+		class Arguments < T::Struct
+			prop :optional, T::Boolean, default: false
+			prop :earliest, T.nilable(::Date), default: nil
+			prop :latest, T.nilable(::Date), default: nil
+		end
+
+		sig { override.params(val: Object, coerce: T::Boolean).returns(TTypeResult) }
+		def read(val, coerce: false)
+			args = Arguments.new(type_args)
+			err = Error.new
+
+			# missing, but allowed, don't do any more checks
+			if val.nil? && args.optional
+				return [val, err]
+			end
+
+			# missing, but not allowed, don't do any more checks
+			if val.nil?
+				err.add(missing_error(Date))
+				return [val, err]
+			end
+
+			# coercion is enabled, and the value is a string, try to parse it
+			if val.is_a?(String) && coerce
+				begin
+					val = Date.parse(val)
+				rescue ArgumentError
+					err.add(type_error(Date, val))
+					return [val, err]
+				end
+			end
+
+			# not a date, don't do any more checks
+			if !val.is_a?(Date)
+				err.add(type_error(Date, val))
+				return [val, err]
+			end
+
+			# date is before the earliest point allowed
+			if args.earliest && (val < args.earliest)
+				error = earliest_error(T.must(args.earliest), val)
+				err.add(error)
+			end
+
+			# date is after the latest point allowed
+			if args.latest && (val > args.latest)
+				error = latest_error(T.must(args.latest), val)
+				err.add(error)
+			end
+
+			return [val, err]
+		end
+	end
+end

data/lib/data_model/builtin/float.rb

@@ -0,0 +1,64 @@
+# typed: strict
+
+module DataModel
+	class Builtin::Float < Type
+		include Errors
+
+		class Arguments < T::Struct
+			prop :optional, T::Boolean, default: false
+			prop :min, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+			prop :max, T.nilable(T.any(Integer, Float, Rational, BigDecimal)), default: nil
+		end
+
+		sig { override.params(val: Object, coerce: T::Boolean).returns(TTypeResult) }
+		def read(val, coerce: false)
+			err = Error.new
+			args = Arguments.new(type_args)
+
+			if args.optional && val.nil?
+				return [val, err]
+			end
+
+			if !args.optional && val.nil?
+				err.add(missing_error(Float))
+				return [val, err]
+			end
+
+			if !val.is_a?(Float) && !coerce
+				err.add(type_error(Float, val))
+				return [val, err]
+			end
+
+			if !val.is_a?(Float) && coerce
+				if val.is_a?(String) || val.is_a?(Numeric)
+					val = Float(val)
+				elsif val.respond_to?(:to_f)
+					val = T.cast(T.unsafe(val).to_f, Float)
+				end
+
+				if !val.is_a?(Float)
+					err.add(coerce_error(Float, val))
+					return [val, err]
+				end
+			end
+
+			val = T.cast(val, Float)
+
+			min = args.min
+			if min && val <= min
+				err.add(min_error(min, val))
+
+				return [val, err]
+			end
+
+			max = args.max
+			if max && val <= max
+				err.add(max_error(max, val))
+
+				return [val, err]
+			end
+
+			[val, err]
+		end
+	end
+end