Class: Module
- Defined in:
- opal/opal/corelib/module.rb,
opal/opal/corelib/unsupported.rb,
opal/opal/corelib/marshal/write_buffer.rb
Class Method Summary collapse
Instance Method Summary collapse
- #<(other) ⇒ Object
- #<=(other) ⇒ Object
- #<=>(other) ⇒ Object
- #===(object) ⇒ Object
- #>(other) ⇒ Object
- #>=(other) ⇒ Object
- #__marshal__(buffer) ⇒ Object
- #alias_method(newname, oldname) ⇒ Object
- #alias_native(mid, jsid = mid) ⇒ Object
- #ancestors ⇒ Object
- #append_features(includer) ⇒ Object
- #attr_accessor(*names) ⇒ Object (also: #attr)
- #attr_reader(*names) ⇒ Object
- #attr_writer(*names) ⇒ Object
- #autoload(const, path) ⇒ Object
- #class_variable_defined?(name) ⇒ Boolean
- #class_variable_get(name) ⇒ Object
- #class_variable_set(name, value) ⇒ Object
- #class_variables ⇒ Object
-
#const_defined?(name, inherit = true) ⇒ Boolean
check for constant within current scope if inherit is true or self is Object, will also check ancestors.
- #const_get(name, inherit = true) ⇒ Object
- #const_missing(name) ⇒ Object
- #const_set(name, value) ⇒ Object
- #constants(inherit = true) ⇒ Object
- #copy_class_variables(other) ⇒ Object
- #copy_constants(other) ⇒ Object
- #define_method(name, method = undefined, &block) ⇒ Object
- #dup ⇒ Object
- #extend_object(object) ⇒ Object
- #extended(mod) ⇒ Object
- #include(*mods) ⇒ Object
- #include?(mod) ⇒ Boolean
- #included(mod) ⇒ Object
- #included_modules ⇒ Object
-
#initialize(&block) ⇒ Module
constructor
A new instance of Module.
- #instance_method(name) ⇒ Object (also: #public_instance_method)
- #instance_methods(include_super = true) ⇒ Object (also: #public_instance_methods)
- #instance_variables ⇒ Object
- #method_added ⇒ Object
- #method_defined?(method) ⇒ Boolean (also: #public_method_defined?)
- #method_removed ⇒ Object
- #method_undefined ⇒ Object
- #module_eval(*args, &block) ⇒ Object (also: #class_eval)
- #module_exec(*args, &block) ⇒ Object (also: #class_exec)
- #module_function(*methods) ⇒ Object
- #name ⇒ Object
- #prepend(*mods) ⇒ Object
- #prepend_features(prepender) ⇒ Object
- #prepended(mod) ⇒ Object
- #private_class_method ⇒ Object (also: #public_class_method)
- #private_constant ⇒ Object
- #private_method_defined?(obj) ⇒ Boolean (also: #protected_method_defined?)
- #public(*methods) ⇒ Object (also: #private, #protected, #nesting)
- #public_constant(const_name) ⇒ Object
- #remove_class_variable(name) ⇒ Object
- #remove_const(name) ⇒ Object
- #remove_method(*names) ⇒ Object
- #singleton_class? ⇒ Boolean
- #to_s ⇒ Object
- #undef_method(*names) ⇒ Object
Constructor Details
#initialize(&block) ⇒ Module
Returns a new instance of Module
11 12 13 |
# File 'opal/opal/corelib/module.rb', line 11 def initialize(&block) module_eval(&block) if block_given? end |
Class Method Details
.allocate ⇒ Object
2 3 4 5 6 7 8 9 |
# File 'opal/opal/corelib/module.rb', line 2 def self.allocate %x{ var module = Opal.allocate_module(nil, function(){}); // Link the prototype of Module subclasses if (self !== Opal.Module) Object.setPrototypeOf(module, self.$$prototype); return module; } end |
.constants(inherit = undefined) ⇒ Object
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'opal/opal/corelib/module.rb', line 231 def self.constants(inherit = undefined) %x{ if (inherit == null) { var nesting = (self.$$nesting || []).concat(Opal.Object), constant, constants = {}, i, ii; for(i = 0, ii = nesting.length; i < ii; i++) { for (constant in nesting[i].$$const) { constants[constant] = true; } } return Object.keys(constants); } else { return Opal.constants(self, inherit) } } end |
.nesting ⇒ Object
250 251 252 |
# File 'opal/opal/corelib/module.rb', line 250 def self.nesting `self.$$nesting || []` end |
Instance Method Details
#<(other) ⇒ Object
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'opal/opal/corelib/module.rb', line 21 def <(other) unless Module === other raise TypeError, 'compared with non class/module' end # class cannot be a descendant of itself %x{ var working = self, ancestors, i, length; if (working === other) { return false; } for (i = 0, ancestors = Opal.ancestors(self), length = ancestors.length; i < length; i++) { if (ancestors[i] === other) { return true; } } for (i = 0, ancestors = Opal.ancestors(other), length = ancestors.length; i < length; i++) { if (ancestors[i] === self) { return false; } } return nil; } end |
#<=(other) ⇒ Object
52 53 54 |
# File 'opal/opal/corelib/module.rb', line 52 def <=(other) equal?(other) || self < other end |
#<=>(other) ⇒ Object
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'opal/opal/corelib/module.rb', line 68 def <=>(other) %x{ if (self === other) { return 0; } } unless Module === other return nil end lt = self < other return nil if lt.nil? lt ? -1 : 1 end |
#===(object) ⇒ Object
15 16 17 18 19 |
# File 'opal/opal/corelib/module.rb', line 15 def ===(object) return false if `object == null` `Opal.is_a(object, self)` end |
#>(other) ⇒ Object
56 57 58 59 60 61 62 |
# File 'opal/opal/corelib/module.rb', line 56 def >(other) unless Module === other raise TypeError, 'compared with non class/module' end other < self end |
#>=(other) ⇒ Object
64 65 66 |
# File 'opal/opal/corelib/module.rb', line 64 def >=(other) equal?(other) || self > other end |
#__marshal__(buffer) ⇒ Object
113 114 115 116 117 118 119 120 121 |
# File 'opal/opal/corelib/marshal/write_buffer.rb', line 113 def __marshal__(buffer) unless name raise TypeError, "can't dump anonymous module" end buffer.save_link(self) buffer.append('m') buffer.write_module(self) end |
#alias_method(newname, oldname) ⇒ Object
84 85 86 87 88 |
# File 'opal/opal/corelib/module.rb', line 84 def alias_method(newname, oldname) `Opal.alias(self, newname, oldname)` self end |
#alias_native(mid, jsid = mid) ⇒ Object
90 91 92 93 94 |
# File 'opal/opal/corelib/module.rb', line 90 def alias_native(mid, jsid = mid) `Opal.alias_native(self, mid, jsid)` self end |
#ancestors ⇒ Object
96 97 98 |
# File 'opal/opal/corelib/module.rb', line 96 def ancestors `Opal.ancestors(self)` end |
#append_features(includer) ⇒ Object
100 101 102 103 |
# File 'opal/opal/corelib/module.rb', line 100 def append_features(includer) `Opal.append_features(self, includer)` self end |
#attr_accessor(*names) ⇒ Object Also known as: attr
105 106 107 108 |
# File 'opal/opal/corelib/module.rb', line 105 def attr_accessor(*names) attr_reader(*names) attr_writer(*names) end |
#attr_reader(*names) ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'opal/opal/corelib/module.rb', line 112 def attr_reader(*names) %x{ var proto = self.$$prototype; for (var i = names.length - 1; i >= 0; i--) { var name = names[i], id = '$' + name, ivar = Opal.ivar(name); // the closure here is needed because name will change at the next // cycle, I wish we could use let. var body = (function(ivar) { return function() { if (this[ivar] == null) { return nil; } else { return this[ivar]; } }; })(ivar); // initialize the instance variable as nil Opal.defineProperty(proto, ivar, nil); body.$$parameters = []; body.$$arity = 0; Opal.defn(self, id, body); } } nil end |
#attr_writer(*names) ⇒ Object
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'opal/opal/corelib/module.rb', line 147 def attr_writer(*names) %x{ var proto = self.$$prototype; for (var i = names.length - 1; i >= 0; i--) { var name = names[i], id = '$' + name + '=', ivar = Opal.ivar(name); // the closure here is needed because name will change at the next // cycle, I wish we could use let. var body = (function(ivar){ return function(value) { return this[ivar] = value; } })(ivar); body.$$parameters = [['req']]; body.$$arity = 1; // initialize the instance variable as nil Opal.defineProperty(proto, ivar, nil); Opal.defn(self, id, body); } } nil end |
#autoload(const, path) ⇒ Object
177 178 179 180 181 182 183 184 |
# File 'opal/opal/corelib/module.rb', line 177 def autoload(const, path) %x{ if (self.$$autoload == null) self.$$autoload = {}; Opal.const_cache_version++; self.$$autoload[#{const}] = #{path}; return nil; } end |
#class_variable_defined?(name) ⇒ Boolean
207 208 209 210 211 |
# File 'opal/opal/corelib/module.rb', line 207 def class_variable_defined?(name) name = Opal.class_variable_name!(name) `Opal.class_variables(self).hasOwnProperty(name)` end |
#class_variable_get(name) ⇒ Object
190 191 192 193 194 195 196 197 198 199 |
# File 'opal/opal/corelib/module.rb', line 190 def class_variable_get(name) name = Opal.class_variable_name!(name) %x{ var value = Opal.class_variables(self)[name]; if (value == null) { #{raise NameError.new("uninitialized class variable #{name} in #{self}", name)} } return value; } end |
#class_variable_set(name, value) ⇒ Object
201 202 203 204 205 |
# File 'opal/opal/corelib/module.rb', line 201 def class_variable_set(name, value) name = Opal.class_variable_name!(name) `Opal.class_variable_set(self, name, value)` end |
#class_variables ⇒ Object
186 187 188 |
# File 'opal/opal/corelib/module.rb', line 186 def class_variables `Object.keys(Opal.class_variables(self))` end |
#const_defined?(name, inherit = true) ⇒ Boolean
check for constant within current scope if inherit is true or self is Object, will also check ancestors
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'opal/opal/corelib/module.rb', line 256 def const_defined?(name, inherit = true) name = Opal.const_name!(name) raise NameError.new("wrong constant name #{name}", name) unless name =~ Opal::CONST_NAME_REGEXP %x{ var module, modules = [self], module_constants, i, ii; // Add up ancestors if inherit is true if (inherit) { modules = modules.concat(Opal.ancestors(self)); // Add Object's ancestors if it's a module – modules have no ancestors otherwise if (self.$$is_module) { modules = modules.concat([Opal.Object]).concat(Opal.ancestors(Opal.Object)); } } for (i = 0, ii = modules.length; i < ii; i++) { module = modules[i]; if (module.$$const[name] != null) { return true; } } return false; } end |
#const_get(name, inherit = true) ⇒ Object
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'opal/opal/corelib/module.rb', line 285 def const_get(name, inherit = true) name = Opal.const_name!(name) %x{ if (name.indexOf('::') === 0 && name !== '::'){ name = name.slice(2); } } if `name.indexOf('::') != -1 && name != '::'` return name.split('::').inject(self) { |o, c| o.const_get(c) } end raise NameError.new("wrong constant name #{name}", name) unless name =~ Opal::CONST_NAME_REGEXP %x{ if (inherit) { return $$([self], name); } else { return Opal.const_get_local(self, name); } } end |
#const_missing(name) ⇒ Object
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'opal/opal/corelib/module.rb', line 309 def const_missing(name) %x{ if (self.$$autoload) { var file = self.$$autoload[name]; if (file) { self.$require(file); return #{const_get name}; } } } full_const_name = self == Object ? name : "#{self}::#{name}" raise NameError.new("uninitialized constant #{full_const_name}", name) end |
#const_set(name, value) ⇒ Object
327 328 329 330 331 332 333 334 335 336 337 |
# File 'opal/opal/corelib/module.rb', line 327 def const_set(name, value) name = Opal.const_name!(name) if name !~ Opal::CONST_NAME_REGEXP || name.start_with?('::') raise NameError.new("wrong constant name #{name}", name) end `Opal.const_set(self, name, value)` value end |
#constants(inherit = true) ⇒ Object
227 228 229 |
# File 'opal/opal/corelib/module.rb', line 227 def constants(inherit = true) `Opal.constants(self, inherit)` end |
#copy_class_variables(other) ⇒ Object
654 655 656 657 658 659 660 |
# File 'opal/opal/corelib/module.rb', line 654 def copy_class_variables(other) %x{ for (var name in other.$$cvars) { self.$$cvars[name] = other.$$cvars[name]; } } end |
#copy_constants(other) ⇒ Object
662 663 664 665 666 667 668 669 670 |
# File 'opal/opal/corelib/module.rb', line 662 def copy_constants(other) %x{ var name, other_constants = other.$$const; for (name in other_constants) { Opal.const_set(self, name, other_constants[name]); } } end |
#define_method(name, method = undefined, &block) ⇒ Object
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'opal/opal/corelib/module.rb', line 342 def define_method(name, method = undefined, &block) if `method === undefined && block === nil` raise ArgumentError, 'tried to create a Proc object without a block' end block ||= case method when Proc method when Method `#{method.to_proc}.$$unbound` when UnboundMethod ->(*args) { bound = method.bind(self) bound.call(*args) } else raise TypeError, "wrong argument type #{block.class} (expected Proc/Method)" end %x{ var id = '$' + name; block.$$jsid = name; block.$$s = null; block.$$def = block; block.$$define_meth = true; Opal.defn(self, id, block); return name; } end |
#dup ⇒ Object
647 648 649 650 651 652 |
# File 'opal/opal/corelib/module.rb', line 647 def dup copy = super copy.copy_class_variables(self) copy.copy_constants(self) copy end |
#extend_object(object) ⇒ Object
460 461 |
# File 'opal/opal/corelib/module.rb', line 460 def extend_object(object) end |
#extended(mod) ⇒ Object
457 458 |
# File 'opal/opal/corelib/module.rb', line 457 def extended(mod) end |
#include(*mods) ⇒ Object
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'opal/opal/corelib/module.rb', line 392 def include(*mods) %x{ for (var i = mods.length - 1; i >= 0; i--) { var mod = mods[i]; if (!mod.$$is_module) { #{raise TypeError, "wrong argument type #{`mod`.class} (expected Module)"}; } #{`mod`.append_features self}; #{`mod`.included self}; } } self end |
#include?(mod) ⇒ Boolean
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'opal/opal/corelib/module.rb', line 413 def include?(mod) %x{ if (!mod.$$is_module) { #{raise TypeError, "wrong argument type #{`mod`.class} (expected Module)"}; } var i, ii, mod2, ancestors = Opal.ancestors(self); for (i = 0, ii = ancestors.length; i < ii; i++) { mod2 = ancestors[i]; if (mod2 === mod && mod2 !== self) { return true; } } return false; } end |
#included(mod) ⇒ Object
454 455 |
# File 'opal/opal/corelib/module.rb', line 454 def included(mod) end |
#included_modules ⇒ Object
409 410 411 |
# File 'opal/opal/corelib/module.rb', line 409 def included_modules `Opal.included_modules(self)` end |
#instance_method(name) ⇒ Object Also known as: public_instance_method
432 433 434 435 436 437 438 439 440 441 442 |
# File 'opal/opal/corelib/module.rb', line 432 def instance_method(name) %x{ var meth = self.$$prototype['$' + name]; if (!meth || meth.$$stub) { #{raise NameError.new("undefined method `#{name}' for class `#{self.name}'", name)}; } return #{UnboundMethod.new(self, `meth.$$owner || #{self}`, `meth`, name)}; } end |
#instance_methods(include_super = true) ⇒ Object Also known as: public_instance_methods
444 445 446 447 448 449 450 451 452 |
# File 'opal/opal/corelib/module.rb', line 444 def instance_methods(include_super = true) %x{ if (#{Opal.truthy?(include_super)}) { return Opal.instance_methods(self); } else { return Opal.own_instance_methods(self); } } end |
#instance_variables ⇒ Object
632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'opal/opal/corelib/module.rb', line 632 def instance_variables consts = constants %x{ var result = []; for (var name in self) { if (self.hasOwnProperty(name) && name.charAt(0) !== '$' && name !== 'constructor' && !#{consts.include?(`name`)}) { result.push('@' + name); } } return result; } end |
#method_added ⇒ Object
463 464 |
# File 'opal/opal/corelib/module.rb', line 463 def method_added(*) end |
#method_defined?(method) ⇒ Boolean Also known as: public_method_defined?
524 525 526 527 528 529 |
# File 'opal/opal/corelib/module.rb', line 524 def method_defined?(method) %x{ var body = self.$$prototype['$' + method]; return (!!body) && !body.$$stub; } end |
#method_removed ⇒ Object
466 467 |
# File 'opal/opal/corelib/module.rb', line 466 def method_removed(*) end |
#method_undefined ⇒ Object
469 470 |
# File 'opal/opal/corelib/module.rb', line 469 def method_undefined(*) end |
#module_eval(*args, &block) ⇒ Object Also known as: class_eval
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'opal/opal/corelib/module.rb', line 472 def module_eval(*args, &block) if block.nil? && `!!Opal.compile` Kernel.raise ArgumentError, 'wrong number of arguments (0 for 1..3)' unless (1..3).cover? args.size string, file, _lineno = *args = { file: (file || '(eval)'), eval: true } = __OPAL_COMPILER_CONFIG__.merge() compiled = Opal.compile string, block = Kernel.proc do %x{ return (function(self) { return eval(compiled); })(self) } end elsif args.any? Kernel.raise ArgumentError, "wrong number of arguments (#{args.size} for 0)" \ "\n\n NOTE:If you want to enable passing a String argument please add \"require 'opal-parser'\" to your script\n" end %x{ var old = block.$$s, result; block.$$s = null; result = block.apply(self, [self]); block.$$s = old; return result; } end |
#module_exec(*args, &block) ⇒ Object Also known as: class_exec
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'opal/opal/corelib/module.rb', line 506 def module_exec(*args, &block) %x{ if (block === nil) { #{raise LocalJumpError, 'no block given'} } var block_self = block.$$s, result; block.$$s = null; result = block.apply(self, args); block.$$s = block_self; return result; } end |
#module_function(*methods) ⇒ Object
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'opal/opal/corelib/module.rb', line 531 def module_function(*methods) %x{ if (methods.length === 0) { self.$$module_function = true; } else { for (var i = 0, length = methods.length; i < length; i++) { var meth = methods[i], id = '$' + meth, func = self.$$prototype[id]; Opal.defs(self, id, func); } } return self; } end |
#name ⇒ Object
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 |
# File 'opal/opal/corelib/module.rb', line 550 def name %x{ if (self.$$full_name) { return self.$$full_name; } var result = [], base = self; while (base) { // Give up if any of the ancestors is unnamed if (base.$$name === nil || base.$$name == null) return nil; result.unshift(base.$$name); base = base.$$base_module; if (base === Opal.Object) { break; } } if (result.length === 0) { return nil; } return self.$$full_name = result.join('::'); } end |
#prepend(*mods) ⇒ Object
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
# File 'opal/opal/corelib/module.rb', line 579 def prepend(*mods) %x{ if (mods.length === 0) { #{raise ArgumentError, 'wrong number of arguments (given 0, expected 1+)'} } for (var i = mods.length - 1; i >= 0; i--) { var mod = mods[i]; if (!mod.$$is_module) { #{raise TypeError, "wrong argument type #{`mod`.class} (expected Module)"}; } #{`mod`.prepend_features self}; #{`mod`.prepended self}; } } self end |
#prepend_features(prepender) ⇒ Object
600 601 602 603 604 605 606 607 608 609 |
# File 'opal/opal/corelib/module.rb', line 600 def prepend_features(prepender) %x{ if (!self.$$is_module) { #{raise TypeError, "wrong argument type #{self.class} (expected Module)"}; } Opal.prepend_features(self, prepender) } self end |
#prepended(mod) ⇒ Object
611 612 |
# File 'opal/opal/corelib/module.rb', line 611 def prepended(mod) end |
#private_class_method ⇒ Object Also known as: public_class_method
173 174 175 |
# File 'opal/opal/corelib/unsupported.rb', line 173 def private_class_method(*) self end |
#private_constant ⇒ Object
183 184 |
# File 'opal/opal/corelib/unsupported.rb', line 183 def private_constant(*) end |
#private_method_defined?(obj) ⇒ Boolean Also known as: protected_method_defined?
179 180 181 |
# File 'opal/opal/corelib/unsupported.rb', line 179 def private_method_defined?(obj) false end |
#public(*methods) ⇒ Object Also known as: private, protected, nesting
157 158 159 160 161 162 163 164 165 |
# File 'opal/opal/corelib/unsupported.rb', line 157 def public(*methods) %x{ if (methods.length === 0) { self.$$module_function = false; } return nil; } end |
#public_constant(const_name) ⇒ Object
339 340 |
# File 'opal/opal/corelib/module.rb', line 339 def public_constant(const_name) end |
#remove_class_variable(name) ⇒ Object
213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'opal/opal/corelib/module.rb', line 213 def remove_class_variable(name) name = Opal.class_variable_name!(name) %x{ if (Opal.hasOwnProperty.call(self.$$cvars, name)) { var value = self.$$cvars[name]; delete self.$$cvars[name]; return value; } else { #{raise NameError, "cannot remove #{name} for #{self}"} } } end |
#remove_const(name) ⇒ Object
614 615 616 |
# File 'opal/opal/corelib/module.rb', line 614 def remove_const(name) `Opal.const_remove(self, name)` end |
#remove_method(*names) ⇒ Object
378 379 380 381 382 383 384 385 386 |
# File 'opal/opal/corelib/module.rb', line 378 def remove_method(*names) %x{ for (var i = 0, length = names.length; i < length; i++) { Opal.rdef(self, "$" + names[i]); } } self end |
#singleton_class? ⇒ Boolean
388 389 390 |
# File 'opal/opal/corelib/module.rb', line 388 def singleton_class? `!!self.$$is_singleton` end |
#to_s ⇒ Object
618 619 620 |
# File 'opal/opal/corelib/module.rb', line 618 def to_s `Opal.Module.$name.call(self)` || "#<#{`self.$$is_module ? 'Module' : 'Class'`}:0x#{__id__.to_s(16)}>" end |
#undef_method(*names) ⇒ Object
622 623 624 625 626 627 628 629 630 |
# File 'opal/opal/corelib/module.rb', line 622 def undef_method(*names) %x{ for (var i = 0, length = names.length; i < length; i++) { Opal.udef(self, "$" + names[i]); } } self end |