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
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(**params) ⇒ Object
- #returns(type) ⇒ Object
-
#type_parameters(*names) ⇒ Object
Declares valid type paramaters 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 33 |
# File 'lib/types/private/methods/decl_builder.rb', line 18 def initialize(mod, raw) # TODO RUBYPLAT-1278 - with ruby 2.5, use kwargs here @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
118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/types/private/methods/decl_builder.rb', line 118 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
74 75 76 77 78 79 80 81 82 83 |
# File 'lib/types/private/methods/decl_builder.rb', line 74 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
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/types/private/methods/decl_builder.rb', line 85 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 || level == :compiled) && !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
133 134 135 136 |
# File 'lib/types/private/methods/decl_builder.rb', line 133 def final check_live! raise BuilderError.new("The syntax for declaring a method final is `sig(:final) {...}`, not `sig {final. ...}`") end |
#finalize! ⇒ Object
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/types/private/methods/decl_builder.rb', line 200 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 || default_checked_level == :compiled) && !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 = {} end if decl.type_parameters.equal?(ARG_NOT_PROVIDED) decl.type_parameters = {} end decl.finalized = true self end |
#on_failure(*args) ⇒ Object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/types/private/methods/decl_builder.rb', line 103 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 || decl.checked == :compiled 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
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/types/private/methods/decl_builder.rb', line 156 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
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/types/private/methods/decl_builder.rb', line 138 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(**params) ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/types/private/methods/decl_builder.rb', line 35 def params(**params) check_live! if !decl.params.equal?(ARG_NOT_PROVIDED) raise BuilderError.new("You can't call .params twice") end if params.empty? raise BuilderError.new("params expects keyword arguments") end decl.params = params self end |
#returns(type) ⇒ Object
49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/types/private/methods/decl_builder.rb', line 49 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 paramaters 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
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/types/private/methods/decl_builder.rb', line 184 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
63 64 65 66 67 68 69 70 71 72 |
# File 'lib/types/private/methods/decl_builder.rb', line 63 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.new self end |