Class: T::Private::Methods::DeclBuilder
- Inherits:
-
Object
- Object
- T::Private::Methods::DeclBuilder
- Defined in:
- lib/types/private/methods/decl_builder.rb
Defined Under Namespace
Classes: BuilderError
Constant Summary collapse
- FROZEN_HASH =
{}.freeze
Instance Attribute Summary collapse
-
#decl ⇒ Object
readonly
Returns the value of attribute decl.
Instance Method Summary collapse
- #abstract ⇒ Object
- #bind(type) ⇒ Object
- #checked(level) ⇒ Object
- #final ⇒ Object
- #finalize! ⇒ Object
-
#initialize(mod, raw) ⇒ DeclBuilder
constructor
A new instance of DeclBuilder.
- #on_failure(*args) ⇒ Object
- #overridable ⇒ Object
- #override(allow_incompatible: false) ⇒ Object
- #params(*unused_positional_params, **params) ⇒ Object
- #returns(type) ⇒ Object
-
#type_parameters(*names) ⇒ Object
Declares valid type parameters which can be used with ‘T.type_parameter` in this `sig`.
- #void ⇒ Object
Constructor Details
#initialize(mod, raw) ⇒ DeclBuilder
Returns a new instance of DeclBuilder.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/types/private/methods/decl_builder.rb', line 18 def initialize(mod, raw) @decl = Declaration.new( mod, ARG_NOT_PROVIDED, # params ARG_NOT_PROVIDED, # returns ARG_NOT_PROVIDED, # bind Modes.standard, # mode ARG_NOT_PROVIDED, # checked false, # finalized ARG_NOT_PROVIDED, # on_failure nil, # override_allow_incompatible ARG_NOT_PROVIDED, # type_parameters raw ) end |
Instance Attribute Details
#decl ⇒ Object (readonly)
Returns the value of attribute decl.
8 9 10 |
# File 'lib/types/private/methods/decl_builder.rb', line 8 def decl @decl end |
Instance Method Details
#abstract ⇒ Object
131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/types/private/methods/decl_builder.rb', line 131 def abstract check_live! case decl.mode when Modes.standard decl.mode = Modes.abstract when Modes.abstract raise BuilderError.new(".abstract cannot be repeated in a single signature") else raise BuilderError.new("`.abstract` cannot be combined with `.override` or `.overridable`.") end self end |
#bind(type) ⇒ Object
87 88 89 90 91 92 93 94 95 96 |
# File 'lib/types/private/methods/decl_builder.rb', line 87 def bind(type) check_live! if !decl.bind.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .bind multiple times in a signature.") end decl.bind = type self end |
#checked(level) ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/types/private/methods/decl_builder.rb', line 98 def checked(level) check_live! if !decl.checked.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .checked multiple times in a signature.") end if level == :never && !decl.on_failure.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't use .checked(:#{level}) with .on_failure because .on_failure will have no effect.") end if !T::Private::RuntimeLevels::LEVELS.include?(level) raise BuilderError.new("Invalid `checked` level '#{level}'. Use one of: #{T::Private::RuntimeLevels::LEVELS}.") end decl.checked = level self end |
#final ⇒ Object
146 147 148 149 |
# File 'lib/types/private/methods/decl_builder.rb', line 146 def final check_live! raise BuilderError.new("The syntax for declaring a method final is `sig(:final) {...}`, not `sig {final. ...}`") end |
#finalize! ⇒ Object
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/types/private/methods/decl_builder.rb', line 213 def finalize! check_live! if decl.returns.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You must provide a return type; use the `.returns` or `.void` builder methods.") end if decl.bind.equal?(ARG_NOT_PROVIDED) decl.bind = nil end if decl.checked.equal?(ARG_NOT_PROVIDED) default_checked_level = T::Private::RuntimeLevels.default_checked_level if default_checked_level == :never && !decl.on_failure.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("To use .on_failure you must additionally call .checked(:tests) or .checked(:always), otherwise, the .on_failure has no effect.") end decl.checked = default_checked_level end if decl.on_failure.equal?(ARG_NOT_PROVIDED) decl.on_failure = nil end if decl.params.equal?(ARG_NOT_PROVIDED) decl.params = FROZEN_HASH end if decl.type_parameters.equal?(ARG_NOT_PROVIDED) decl.type_parameters = FROZEN_HASH end decl.finalized = true self end |
#on_failure(*args) ⇒ Object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/types/private/methods/decl_builder.rb', line 116 def on_failure(*args) check_live! if !decl.on_failure.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .on_failure multiple times in a signature.") end if decl.checked == :never raise BuilderError.new("You can't use .on_failure with .checked(:#{decl.checked}) because .on_failure will have no effect.") end decl.on_failure = args self end |
#overridable ⇒ Object
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/types/private/methods/decl_builder.rb', line 169 def overridable check_live! case decl.mode when Modes.abstract raise BuilderError.new("`.overridable` cannot be combined with `.#{decl.mode}`") when Modes.override decl.mode = Modes.overridable_override when Modes.standard decl.mode = Modes.overridable when Modes.overridable, Modes.overridable_override raise BuilderError.new(".overridable cannot be repeated in a single signature") end self end |
#override(allow_incompatible: false) ⇒ Object
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/types/private/methods/decl_builder.rb', line 151 def override(allow_incompatible: false) check_live! case decl.mode when Modes.standard decl.mode = Modes.override decl.override_allow_incompatible = allow_incompatible when Modes.override, Modes.overridable_override raise BuilderError.new(".override cannot be repeated in a single signature") when Modes.overridable decl.mode = Modes.overridable_override else raise BuilderError.new("`.override` cannot be combined with `.abstract`.") end self end |
#params(*unused_positional_params, **params) ⇒ Object
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/types/private/methods/decl_builder.rb', line 34 def params(*unused_positional_params, **params) check_live! if !decl.params.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .params twice") end if unused_positional_params.any? some_or_only = params.any? ? "some" : "only" raise BuilderError.new(<<~MSG) 'params' was called with #{some_or_only} positional arguments, but it needs to be called with keyword arguments. The keyword arguments' keys must match the name and order of the method's parameters. MSG end if params.empty? raise BuilderError.new(<<~MSG) 'params' was called without any arguments, but it needs to be called with keyword arguments. The keyword arguments' keys must match the name and order of the method's parameters. Omit 'params' entirely for methods with no parameters. MSG end decl.params = params self end |
#returns(type) ⇒ Object
62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/types/private/methods/decl_builder.rb', line 62 def returns(type) check_live! if decl.returns.is_a?(T::Private::Types::Void) raise BuilderError.new("You can't call .returns after calling .void.") end if !decl.returns.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .returns multiple times in a signature.") end decl.returns = type self end |
#type_parameters(*names) ⇒ Object
Declares valid type parameters which can be used with ‘T.type_parameter` in this `sig`.
This is used for generic methods. Example usage:
sig do
type_parameters(:U)
.params(blk: T.proc.params(arg0: Elem).returns(T.type_parameter(:U)))
.returns(T::Array[T.type_parameter(:U)])
end
def map(&blk); end
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/types/private/methods/decl_builder.rb', line 197 def type_parameters(*names) check_live! names.each do |name| raise BuilderError.new("not a symbol: #{name}") unless name.is_a?(Symbol) end if !decl.type_parameters.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .type_parameters multiple times in a signature.") end decl.type_parameters = names self end |
#void ⇒ Object
76 77 78 79 80 81 82 83 84 85 |
# File 'lib/types/private/methods/decl_builder.rb', line 76 def void check_live! if !decl.returns.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .void after calling .returns.") end decl.returns = T::Private::Types::Void::Private::INSTANCE self end |