Class: Module

Inherits:
Object show all
Defined in:
opal/opal/corelib/module.rb,
opal/opal/corelib/unsupported.rb,
opal/opal/corelib/marshal/write_buffer.rb

Overview

helpers: truthy, coerce_to

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ Module

Returns a new instance of Module.


13
14
15
# File 'opal/opal/corelib/module.rb', line 13

def initialize(&block)
  module_eval(&block) if block_given?
end

Class Method Details

.allocateObject


4
5
6
7
8
9
10
11
# File 'opal/opal/corelib/module.rb', line 4

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


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'opal/opal/corelib/module.rb', line 246

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

.nestingObject


265
266
267
# File 'opal/opal/corelib/module.rb', line 265

def self.nesting
  `self.$$nesting || []`
end

Instance Method Details

#<(other) ⇒ Object


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
51
52
# File 'opal/opal/corelib/module.rb', line 23

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


54
55
56
# File 'opal/opal/corelib/module.rb', line 54

def <=(other)
  equal?(other) || self < other
end

#<=>(other) ⇒ Object


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'opal/opal/corelib/module.rb', line 70

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


17
18
19
20
21
# File 'opal/opal/corelib/module.rb', line 17

def ===(object)
  return false if `object == null`

  `Opal.is_a(object, self)`
end

#>(other) ⇒ Object


58
59
60
61
62
63
64
# File 'opal/opal/corelib/module.rb', line 58

def >(other)
  unless Module === other
    raise TypeError, 'compared with non class/module'
  end

  other < self
end

#>=(other) ⇒ Object


66
67
68
# File 'opal/opal/corelib/module.rb', line 66

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


86
87
88
89
90
91
92
# File 'opal/opal/corelib/module.rb', line 86

def alias_method(newname, oldname)
  newname = `$coerce_to(newname, #{String}, 'to_str')`
  oldname = `$coerce_to(oldname, #{String}, 'to_str')`
  `Opal.alias(self, newname, oldname)`

  self
end

#alias_native(mid, jsid = mid) ⇒ Object


94
95
96
97
98
# File 'opal/opal/corelib/module.rb', line 94

def alias_native(mid, jsid = mid)
  `Opal.alias_native(self, mid, jsid)`

  self
end

#ancestorsObject


100
101
102
# File 'opal/opal/corelib/module.rb', line 100

def ancestors
  `Opal.ancestors(self)`
end

#append_features(includer) ⇒ Object


104
105
106
107
# File 'opal/opal/corelib/module.rb', line 104

def append_features(includer)
  `Opal.append_features(self, includer)`
  self
end

#attr(*args) ⇒ Object


114
115
116
117
118
119
120
121
122
123
124
125
# File 'opal/opal/corelib/module.rb', line 114

def attr(*args)
  %x{
    if (args.length == 2 && (args[1] === true || args[1] === false)) {
      #{warn 'optional boolean argument is obsoleted', uplevel: 1}

      args[1] ? #{attr_accessor(`args[0]`)} : #{attr_reader(`args[0]`)};
      return nil;
    }
  }

  attr_reader(*args)
end

#attr_accessor(*names) ⇒ Object


109
110
111
112
# File 'opal/opal/corelib/module.rb', line 109

def attr_accessor(*names)
  attr_reader(*names)
  attr_writer(*names)
end

#attr_reader(*names) ⇒ Object


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'opal/opal/corelib/module.rb', line 127

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


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'opal/opal/corelib/module.rb', line 162

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


192
193
194
195
196
197
198
199
# File 'opal/opal/corelib/module.rb', line 192

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

Returns:


222
223
224
225
226
# File 'opal/opal/corelib/module.rb', line 222

def class_variable_defined?(name)
  name = Opal.class_variable_name!(name)

  `Opal.class_variables(self).hasOwnProperty(name)`
end

#class_variable_get(name) ⇒ Object


205
206
207
208
209
210
211
212
213
214
# File 'opal/opal/corelib/module.rb', line 205

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


216
217
218
219
220
# File 'opal/opal/corelib/module.rb', line 216

def class_variable_set(name, value)
  name = Opal.class_variable_name!(name)

  `Opal.class_variable_set(self, name, value)`
end

#class_variablesObject


201
202
203
# File 'opal/opal/corelib/module.rb', line 201

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

Returns:

Raises:


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'opal/opal/corelib/module.rb', line 271

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

Raises:


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'opal/opal/corelib/module.rb', line 300

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

Raises:


324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'opal/opal/corelib/module.rb', line 324

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


342
343
344
345
346
347
348
349
350
351
352
# File 'opal/opal/corelib/module.rb', line 342

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


242
243
244
# File 'opal/opal/corelib/module.rb', line 242

def constants(inherit = true)
  `Opal.constants(self, inherit)`
end

#copy_class_variables(other) ⇒ Object


669
670
671
672
673
674
675
# File 'opal/opal/corelib/module.rb', line 669

def copy_class_variables(other)
  %x{
    for (var name in other.$$cvars) {
      self.$$cvars[name] = other.$$cvars[name];
    }
  }
end

#copy_constants(other) ⇒ Object


677
678
679
680
681
682
683
684
685
# File 'opal/opal/corelib/module.rb', line 677

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


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'opal/opal/corelib/module.rb', line 357

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

#dupObject


662
663
664
665
666
667
# File 'opal/opal/corelib/module.rb', line 662

def dup
  copy = super
  copy.copy_class_variables(self)
  copy.copy_constants(self)
  copy
end

#extend_object(object) ⇒ Object


475
476
# File 'opal/opal/corelib/module.rb', line 475

def extend_object(object)
end

#extended(mod) ⇒ Object


472
473
# File 'opal/opal/corelib/module.rb', line 472

def extended(mod)
end

#include(*mods) ⇒ Object


407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'opal/opal/corelib/module.rb', line 407

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

Returns:


428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'opal/opal/corelib/module.rb', line 428

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


469
470
# File 'opal/opal/corelib/module.rb', line 469

def included(mod)
end

#included_modulesObject


424
425
426
# File 'opal/opal/corelib/module.rb', line 424

def included_modules
  `Opal.included_modules(self)`
end

#instance_method(name) ⇒ Object Also known as: public_instance_method


447
448
449
450
451
452
453
454
455
456
457
# File 'opal/opal/corelib/module.rb', line 447

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


459
460
461
462
463
464
465
466
467
# File 'opal/opal/corelib/module.rb', line 459

def instance_methods(include_super = true)
  %x{
    if ($truthy(#{include_super})) {
      return Opal.instance_methods(self);
    } else {
      return Opal.own_instance_methods(self);
    }
  }
end

#instance_variablesObject


647
648
649
650
651
652
653
654
655
656
657
658
659
660
# File 'opal/opal/corelib/module.rb', line 647

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_addedObject


478
479
# File 'opal/opal/corelib/module.rb', line 478

def method_added(*)
end

#method_defined?(method) ⇒ Boolean Also known as: public_method_defined?

Returns:


539
540
541
542
543
544
# File 'opal/opal/corelib/module.rb', line 539

def method_defined?(method)
  %x{
    var body = self.$$prototype['$' + method];
    return (!!body) && !body.$$stub;
  }
end

#method_removedObject


481
482
# File 'opal/opal/corelib/module.rb', line 481

def method_removed(*)
end

#method_undefinedObject


484
485
# File 'opal/opal/corelib/module.rb', line 484

def method_undefined(*)
end

#module_eval(*args, &block) ⇒ Object Also known as: class_eval


487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
# File 'opal/opal/corelib/module.rb', line 487

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
    default_eval_options = { file: (file || '(eval)'), eval: true }
    compiling_options = __OPAL_COMPILER_CONFIG__.merge(default_eval_options)
    compiled = Opal.compile string, compiling_options
    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


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'opal/opal/corelib/module.rb', line 521

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


546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
# File 'opal/opal/corelib/module.rb', line 546

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

#nameObject


565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'opal/opal/corelib/module.rb', line 565

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


594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'opal/opal/corelib/module.rb', line 594

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


615
616
617
618
619
620
621
622
623
624
# File 'opal/opal/corelib/module.rb', line 615

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


626
627
# File 'opal/opal/corelib/module.rb', line 626

def prepended(mod)
end

#private_class_methodObject Also known as: public_class_method


173
174
175
# File 'opal/opal/corelib/unsupported.rb', line 173

def private_class_method(*)
  self
end

#private_constantObject


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?

Returns:


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


354
355
# File 'opal/opal/corelib/module.rb', line 354

def public_constant(const_name)
end

#remove_class_variable(name) ⇒ Object


228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'opal/opal/corelib/module.rb', line 228

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


629
630
631
# File 'opal/opal/corelib/module.rb', line 629

def remove_const(name)
  `Opal.const_remove(self, name)`
end

#remove_method(*names) ⇒ Object


393
394
395
396
397
398
399
400
401
# File 'opal/opal/corelib/module.rb', line 393

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

Returns:


403
404
405
# File 'opal/opal/corelib/module.rb', line 403

def singleton_class?
  `!!self.$$is_singleton`
end

#to_sObject


633
634
635
# File 'opal/opal/corelib/module.rb', line 633

def to_s
  `Opal.Module.$name.call(self)` || "#<#{`self.$$is_module ? 'Module' : 'Class'`}:0x#{__id__.to_s(16)}>"
end

#undef_method(*names) ⇒ Object


637
638
639
640
641
642
643
644
645
# File 'opal/opal/corelib/module.rb', line 637

def undef_method(*names)
  %x{
    for (var i = 0, length = names.length; i < length; i++) {
      Opal.udef(self, "$" + names[i]);
    }
  }

  self
end