field_struct 0.15.0 → 1.0.0.pre1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.claude-plugin/marketplace.json +13 -0
- data/.claude-plugin/plugin.json +9 -0
- data/AGENTS.md +47 -54
- data/CHANGELOG.md +53 -640
- data/LICENSE.txt +21 -0
- data/README.md +33 -628
- data/USAGE.md +771 -715
- data/docs/getting_started.md +139 -325
- data/lib/field_struct/base.rb +241 -1149
- data/lib/field_struct/class_macros.rb +163 -0
- data/lib/field_struct/describer.rb +167 -0
- data/lib/field_struct/errors.rb +182 -62
- data/lib/field_struct/exceptions.rb +40 -0
- data/lib/field_struct/field.rb +69 -135
- data/lib/field_struct/field_builder.rb +110 -0
- data/lib/field_struct/field_checks.rb +50 -0
- data/lib/field_struct/introspection.rb +199 -0
- data/lib/field_struct/json_codec.rb +240 -0
- data/lib/field_struct/metadata.rb +65 -260
- data/lib/field_struct/model_name.rb +27 -27
- data/lib/field_struct/option_checker.rb +121 -0
- data/lib/field_struct/partial.rb +49 -0
- data/lib/field_struct/presence.rb +45 -0
- data/lib/field_struct/rbs.rb +151 -271
- data/lib/field_struct/registered_option.rb +113 -0
- data/lib/field_struct/registry.rb +40 -50
- data/lib/field_struct/restrictions.rb +90 -0
- data/lib/field_struct/scaffold.rb +274 -301
- data/lib/field_struct/suggestion.rb +33 -0
- data/lib/field_struct/types/array.rb +147 -126
- data/lib/field_struct/types/base.rb +113 -124
- data/lib/field_struct/types/big_decimal.rb +59 -55
- data/lib/field_struct/types/binary.rb +18 -25
- data/lib/field_struct/types/boolean.rb +74 -97
- data/lib/field_struct/types/builtin.rb +32 -0
- data/lib/field_struct/types/date.rb +23 -137
- data/lib/field_struct/types/datetime.rb +30 -139
- data/lib/field_struct/types/element_options.rb +51 -0
- data/lib/field_struct/types/email.rb +27 -38
- data/lib/field_struct/types/float.rb +58 -56
- data/lib/field_struct/types/format_presets.rb +30 -0
- data/lib/field_struct/types/hash.rb +144 -0
- data/lib/field_struct/types/immutable_string.rb +16 -9
- data/lib/field_struct/types/integer.rb +74 -102
- data/lib/field_struct/types/nested.rb +57 -58
- data/lib/field_struct/types/preset_resolver.rb +9 -24
- data/lib/field_struct/types/rfc3339_format.rb +70 -153
- data/lib/field_struct/types/string.rb +48 -46
- data/lib/field_struct/types/symbol.rb +23 -20
- data/lib/field_struct/types/temporal.rb +232 -0
- data/lib/field_struct/types/time.rb +32 -145
- data/lib/field_struct/types/union.rb +111 -65
- data/lib/field_struct/types/union_pick.rb +139 -0
- data/lib/field_struct/types/url.rb +24 -35
- data/lib/field_struct/types/uuid.rb +24 -35
- data/lib/field_struct/types/value.rb +14 -9
- data/lib/field_struct/types/zone.rb +118 -0
- data/lib/field_struct/version.rb +3 -3
- data/lib/field_struct.rb +102 -122
- data/sig/field_struct.rbs +1180 -2300
- data/sig/manifest.yaml +6 -0
- data/skills/field-struct/SKILL.md +73 -159
- metadata +37 -28
- data/CODE_OF_CONDUCT.md +0 -132
- data/UPGRADING.md +0 -743
- data/lib/field_struct/error.rb +0 -48
- data/lib/field_struct/types/temporal_parser.rb +0 -93
- data/lib/field_struct/types/time_format_resolver.rb +0 -54
- data/lib/field_struct/types/zone_option.rb +0 -267
data/lib/field_struct.rb
CHANGED
|
@@ -1,159 +1,139 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
require '
|
|
3
|
+
require 'date'
|
|
4
|
+
require 'time'
|
|
4
5
|
require 'pathname'
|
|
6
|
+
require 'pp'
|
|
7
|
+
require 'bigdecimal'
|
|
8
|
+
require 'oj'
|
|
9
|
+
|
|
5
10
|
require_relative 'field_struct/version'
|
|
6
|
-
require_relative 'field_struct/
|
|
7
|
-
require_relative 'field_struct/
|
|
11
|
+
require_relative 'field_struct/exceptions'
|
|
12
|
+
require_relative 'field_struct/errors'
|
|
13
|
+
require_relative 'field_struct/suggestion'
|
|
14
|
+
require_relative 'field_struct/registry'
|
|
8
15
|
require_relative 'field_struct/types/base'
|
|
9
16
|
require_relative 'field_struct/types/preset_resolver'
|
|
10
|
-
require_relative 'field_struct/types/temporal_parser'
|
|
11
|
-
require_relative 'field_struct/types/rfc3339_format'
|
|
12
|
-
require_relative 'field_struct/types/time_format_resolver'
|
|
13
|
-
require_relative 'field_struct/types/zone_option'
|
|
14
17
|
require_relative 'field_struct/types/string'
|
|
15
18
|
require_relative 'field_struct/types/immutable_string'
|
|
16
19
|
require_relative 'field_struct/types/integer'
|
|
17
20
|
require_relative 'field_struct/types/float'
|
|
18
21
|
require_relative 'field_struct/types/big_decimal'
|
|
19
22
|
require_relative 'field_struct/types/boolean'
|
|
23
|
+
require_relative 'field_struct/types/rfc3339_format'
|
|
24
|
+
require_relative 'field_struct/types/zone'
|
|
25
|
+
require_relative 'field_struct/types/temporal'
|
|
20
26
|
require_relative 'field_struct/types/date'
|
|
21
27
|
require_relative 'field_struct/types/time'
|
|
22
28
|
require_relative 'field_struct/types/datetime'
|
|
23
|
-
require_relative 'field_struct/types/value'
|
|
24
|
-
require_relative 'field_struct/types/array'
|
|
25
|
-
require_relative 'field_struct/types/nested'
|
|
26
29
|
require_relative 'field_struct/types/symbol'
|
|
30
|
+
require_relative 'field_struct/types/format_presets'
|
|
27
31
|
require_relative 'field_struct/types/uuid'
|
|
28
32
|
require_relative 'field_struct/types/url'
|
|
29
33
|
require_relative 'field_struct/types/email'
|
|
30
|
-
require_relative 'field_struct/types/union'
|
|
31
34
|
require_relative 'field_struct/types/binary'
|
|
32
|
-
require_relative 'field_struct/
|
|
35
|
+
require_relative 'field_struct/types/value'
|
|
36
|
+
require_relative 'field_struct/types/nested'
|
|
37
|
+
require_relative 'field_struct/types/element_options'
|
|
38
|
+
require_relative 'field_struct/types/array'
|
|
39
|
+
require_relative 'field_struct/types/hash'
|
|
40
|
+
require_relative 'field_struct/types/union_pick'
|
|
41
|
+
require_relative 'field_struct/types/union'
|
|
42
|
+
require_relative 'field_struct/types/builtin'
|
|
43
|
+
require_relative 'field_struct/restrictions'
|
|
44
|
+
require_relative 'field_struct/describer'
|
|
33
45
|
require_relative 'field_struct/field'
|
|
46
|
+
require_relative 'field_struct/option_checker'
|
|
34
47
|
require_relative 'field_struct/metadata'
|
|
35
|
-
require_relative 'field_struct/
|
|
48
|
+
require_relative 'field_struct/model_name'
|
|
49
|
+
require_relative 'field_struct/field_builder'
|
|
50
|
+
require_relative 'field_struct/registered_option'
|
|
51
|
+
require_relative 'field_struct/class_macros'
|
|
52
|
+
require_relative 'field_struct/partial'
|
|
53
|
+
require_relative 'field_struct/json_codec'
|
|
54
|
+
require_relative 'field_struct/presence'
|
|
55
|
+
require_relative 'field_struct/field_checks'
|
|
36
56
|
require_relative 'field_struct/base'
|
|
37
|
-
require_relative 'field_struct/rbs'
|
|
38
57
|
require_relative 'field_struct/scaffold'
|
|
58
|
+
require_relative 'field_struct/introspection'
|
|
59
|
+
require_relative 'field_struct/rbs'
|
|
39
60
|
|
|
40
|
-
# Typed
|
|
41
|
-
# and per-field validation. Subclass {FieldStruct::Base} to get a value object
|
|
42
|
-
# whose attributes coerce, validate on assignment, and introspect cleanly.
|
|
61
|
+
# Typed plain Ruby objects with declared, coerced, validated fields.
|
|
43
62
|
module FieldStruct
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
47
|
-
# @return [String]
|
|
63
|
+
# Placeholder printed by +inspect+ in place of sensitive values.
|
|
64
|
+
# @return [::String]
|
|
48
65
|
FILTERED = '[FILTERED]'
|
|
49
66
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
def self.root
|
|
58
|
-
@root ||= Pathname.new(File.expand_path('..', __dir__))
|
|
59
|
-
end
|
|
67
|
+
class << self
|
|
68
|
+
# The directory that contains +lib/+.
|
|
69
|
+
#
|
|
70
|
+
# @return [Pathname]
|
|
71
|
+
def root
|
|
72
|
+
@root ||= Pathname.new(__dir__).parent
|
|
73
|
+
end
|
|
60
74
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
# @field_types ||= FieldStruct.new_registry do
|
|
68
|
-
# register :money, Acme::Types::Money
|
|
69
|
-
# end
|
|
70
|
-
# end
|
|
71
|
-
# end
|
|
72
|
-
#
|
|
73
|
-
# Equivalent to the longhand:
|
|
74
|
-
#
|
|
75
|
-
# FieldStruct::Registry.new(FieldStruct.types).tap do |r|
|
|
76
|
-
# r.register :money, Acme::Types::Money
|
|
77
|
-
# end
|
|
78
|
-
#
|
|
79
|
-
# Pass +parent: nil+ for an unparented registry (no fallback chain).
|
|
80
|
-
#
|
|
81
|
-
# @param parent [Registry, nil] the parent registry; defaults to
|
|
82
|
-
# {FieldStruct.types}. Pass +nil+ explicitly for no parent.
|
|
83
|
-
# @yield evaluated in the new registry's instance scope, so methods
|
|
84
|
-
# like +register+ / +lookup+ / +key?+ work without an explicit receiver
|
|
85
|
-
# @return [Registry]
|
|
86
|
-
def self.new_registry(parent = types, &block)
|
|
87
|
-
registry = Registry.new(parent)
|
|
88
|
-
registry.instance_eval(&block) if block
|
|
89
|
-
registry
|
|
90
|
-
end
|
|
75
|
+
# The memoized base registry, seeded with every built-in type.
|
|
76
|
+
#
|
|
77
|
+
# @return [FieldStruct::Registry]
|
|
78
|
+
def types
|
|
79
|
+
@types ||= Types.install(Registry.new)
|
|
80
|
+
end
|
|
91
81
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
r.register :integer, Types::Integer
|
|
102
|
-
r.register :float, Types::Float
|
|
103
|
-
r.register :big_decimal, Types::BigDecimal
|
|
104
|
-
r.register :decimal, :big_decimal
|
|
105
|
-
r.register :boolean, Types::Boolean
|
|
106
|
-
r.register :date, Types::Date
|
|
107
|
-
r.register :time, Types::Time
|
|
108
|
-
r.register :datetime, Types::DateTime
|
|
109
|
-
r.register :value, Types::Value
|
|
110
|
-
r.register :array, Types::Array
|
|
111
|
-
r.register :symbol, Types::Symbol
|
|
112
|
-
r.register :uuid, Types::UUID
|
|
113
|
-
r.register :url, Types::URL
|
|
114
|
-
r.register :email, Types::Email
|
|
115
|
-
r.register :union, Types::Union
|
|
116
|
-
r.register :binary, Types::Binary
|
|
82
|
+
# Builds a registry, evaluating the block with the new registry as +self+.
|
|
83
|
+
#
|
|
84
|
+
# @param parent [FieldStruct::Registry, nil] where unknown names fall through to
|
|
85
|
+
# @yield evaluated with the registry as +self+
|
|
86
|
+
# @return [FieldStruct::Registry]
|
|
87
|
+
def new_registry(parent = types, &block)
|
|
88
|
+
registry = Registry.new(parent)
|
|
89
|
+
registry.instance_eval(&block) if block
|
|
90
|
+
registry
|
|
117
91
|
end
|
|
118
|
-
end
|
|
119
92
|
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
# FieldStruct, raises +NameError+ rather than clobbering.
|
|
133
|
-
#
|
|
134
|
-
# @param name [Symbol] the top-level constant to define (default +:FS+)
|
|
135
|
-
# @return [self] for chaining
|
|
136
|
-
# @raise [NameError] when the constant already points at something else
|
|
137
|
-
def self.use_alias!(name = :FS)
|
|
138
|
-
sym = name.to_sym
|
|
139
|
-
if Object.const_defined?(sym, false)
|
|
140
|
-
existing = Object.const_get(sym)
|
|
141
|
-
unless existing.equal?(self)
|
|
142
|
-
raise ::NameError, "::#{sym} is already defined (#{existing.inspect}); not aliasing FieldStruct"
|
|
93
|
+
# Defines a top-level constant for FieldStruct and switches every +inspect+ prefix to it.
|
|
94
|
+
#
|
|
95
|
+
# @param name [Symbol, String] the constant name
|
|
96
|
+
# @return [Module] FieldStruct
|
|
97
|
+
# @raise [NameError] when the constant already names something else
|
|
98
|
+
def use_alias!(name = :FS)
|
|
99
|
+
name = name.to_sym
|
|
100
|
+
if Object.const_defined?(name, false)
|
|
101
|
+
existing = Object.const_get(name, false)
|
|
102
|
+
raise NameError, "::#{name} is already defined (#{existing.inspect}); not aliasing FieldStruct" unless existing.equal?(self)
|
|
103
|
+
else
|
|
104
|
+
Object.const_set(name, self)
|
|
143
105
|
end
|
|
144
|
-
|
|
145
|
-
|
|
106
|
+
@inspect_namespace = name.to_s
|
|
107
|
+
self
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Makes +name+ a known field option, so declaring it on a field doesn't raise (FS-B10a). Adapters call this
|
|
111
|
+
# for the keys they read; an app can too. Registering the same name, type and owner again does nothing.
|
|
112
|
+
#
|
|
113
|
+
# @example
|
|
114
|
+
# FieldStruct.register_option(:catalog, type: Hash, owner: 'my_app')
|
|
115
|
+
#
|
|
116
|
+
# @param name [Symbol] the option key
|
|
117
|
+
# @param type [Class, Array<Class>] what a declared value must be an instance of (+nil+ is always allowed)
|
|
118
|
+
# @param owner [String] the gem or app that reads the option, named in error messages
|
|
119
|
+
# @return [Symbol] +name+
|
|
120
|
+
# @raise [ArgumentError] for a universal or built-in native key, or a name already registered differently
|
|
121
|
+
def register_option(name, type:, owner:)
|
|
122
|
+
OptionRegistry.register(name, type, owner)
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# Every registered field option, by name, in registration order.
|
|
126
|
+
#
|
|
127
|
+
# @return [Hash{Symbol=>FieldStruct::RegisteredOption}] frozen
|
|
128
|
+
def registered_options
|
|
129
|
+
OptionRegistry.entries
|
|
146
130
|
end
|
|
147
|
-
@short_alias = sym.to_s
|
|
148
|
-
self
|
|
149
|
-
end
|
|
150
131
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
@short_alias || 'FieldStruct'
|
|
132
|
+
# The prefix library +inspect+ output uses.
|
|
133
|
+
#
|
|
134
|
+
# @return [String] +'FieldStruct'+ or the alias name
|
|
135
|
+
def inspect_namespace
|
|
136
|
+
@inspect_namespace || 'FieldStruct'
|
|
137
|
+
end
|
|
158
138
|
end
|
|
159
139
|
end
|