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, const_set, Object, return_ivar, assign_ivar, ivar, deny_frozen_access, freeze, prop, jsid

Direct Known Subclasses

Refinement

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'opal/opal/corelib/module.rb', line 277

def self.constants(inherit = undefined)
  %x{
    if (inherit == null) {
      var nesting = (self.$$nesting || []).concat($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



296
297
298
# File 'opal/opal/corelib/module.rb', line 296

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
    ::Kernel.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
    ::Kernel.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
    ::Kernel.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
93
94
# File 'opal/opal/corelib/module.rb', line 86

def alias_method(newname, oldname)
  `$deny_frozen_access(self)`

  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



96
97
98
99
100
101
102
# File 'opal/opal/corelib/module.rb', line 96

def alias_native(mid, jsid = mid)
  `$deny_frozen_access(self)`

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

  self
end

#ancestorsObject



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

def ancestors
  `Opal.ancestors(self)`
end

#append_features(includer) ⇒ Object



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

def append_features(includer)
  `$deny_frozen_access(includer)`

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

#attr(*args) ⇒ Object



120
121
122
123
124
125
126
127
128
129
130
131
# File 'opal/opal/corelib/module.rb', line 120

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



115
116
117
118
# File 'opal/opal/corelib/module.rb', line 115

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

#attr_reader(*names) ⇒ Object



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

def attr_reader(*names)
  %x{
    $deny_frozen_access(self);

    var proto = self.$$prototype;

    for (var i = names.length - 1; i >= 0; i--) {
      var name = names[i],
          id   = $jsid(name),
          ivar = $ivar(name);

      var body = $return_ivar(ivar);

      // initialize the instance variable as nil
      Opal.prop(proto, ivar, nil);

      body.$$parameters = [];
      body.$$arity = 0;

      Opal.defn(self, id, body);
    }
  }

  nil
end

#attr_writer(*names) ⇒ Object



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'opal/opal/corelib/module.rb', line 159

def attr_writer(*names)
  %x{
    $deny_frozen_access(self);

    var proto = self.$$prototype;

    for (var i = names.length - 1; i >= 0; i--) {
      var name = names[i],
          id   = $jsid(name + '='),
          ivar = $ivar(name);

      var body = $assign_ivar(ivar)

      body.$$parameters = [['req']];
      body.$$arity = 1;

      // initialize the instance variable as nil
      Opal.prop(proto, ivar, nil);

      Opal.defn(self, id, body);
    }
  }

  nil
end

#autoload(const, path) ⇒ Object



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'opal/opal/corelib/module.rb', line 185

def autoload(const, path)
  %x{
    $deny_frozen_access(self);

    if (!#{Opal.const_name?(const)}) {
      #{::Kernel.raise ::NameError, "autoload must be constant name: #{const}"}
    }

    if (path == "") {
      #{::Kernel.raise ::ArgumentError, 'empty file name'}
    }

    if (!self.$$const.hasOwnProperty(#{const})) {
      if (!self.$$autoload) {
        self.$$autoload = {};
      }
      Opal.const_cache_version++;
      self.$$autoload[#{const}] = { path: #{path}, loaded: false, required: false, success: false, exception: false };

      if (self.$const_added && !self.$const_added.$$pristine) {
        self.$const_added(#{const});
      }
    }
    return nil;
  }
end

#autoload?(const) ⇒ Boolean

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'opal/opal/corelib/module.rb', line 212

def autoload?(const)
  %x{
    if (self.$$autoload && self.$$autoload[#{const}] && !self.$$autoload[#{const}].required && !self.$$autoload[#{const}].success) {
      return self.$$autoload[#{const}].path;
    }

    var ancestors = self.$ancestors();

    for (var i = 0, length = ancestors.length; i < length; i++) {
      if (ancestors[i].$$autoload && ancestors[i].$$autoload[#{const}] && !ancestors[i].$$autoload[#{const}].required && !ancestors[i].$$autoload[#{const}].success) {
        return ancestors[i].$$autoload[#{const}].path;
      }
    }
    return nil;
  }
end

#class_variable_defined?(name) ⇒ Boolean

Returns:



247
248
249
250
251
# File 'opal/opal/corelib/module.rb', line 247

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

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

#class_variable_get(name) ⇒ Object



233
234
235
236
237
# File 'opal/opal/corelib/module.rb', line 233

def class_variable_get(name)
  name = ::Opal.class_variable_name!(name)

  `Opal.class_variable_get(self, name, false)`
end

#class_variable_set(name, value) ⇒ Object



239
240
241
242
243
244
245
# File 'opal/opal/corelib/module.rb', line 239

def class_variable_set(name, value)
  `$deny_frozen_access(self)`

  name = ::Opal.class_variable_name!(name)

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

#class_variablesObject



229
230
231
# File 'opal/opal/corelib/module.rb', line 229

def class_variables
  `Object.keys(Opal.class_variables(self))`
end

#const_added(name) ⇒ Object



253
254
# File 'opal/opal/corelib/module.rb', line 253

def const_added(name)
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:



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'opal/opal/corelib/module.rb', line 302

def const_defined?(name, inherit = true)
  name = Opal.const_name!(name)

  ::Kernel.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([$Object]).concat(Opal.ancestors($Object));
      }
    }

    for (i = 0, ii = modules.length; i < ii; i++) {
      module = modules[i];
      if (module.$$const[#{name}] != null) { return true; }
      if (
        module.$$autoload &&
        module.$$autoload[#{name}] &&
        !module.$$autoload[#{name}].required &&
        !module.$$autoload[#{name}].success
      ) {
        return true;
      }
    }

    return false;
  }
end

#const_get(name, inherit = true) ⇒ Object



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'opal/opal/corelib/module.rb', line 337

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

  ::Kernel.raise ::NameError.new("wrong constant name #{name}", name) unless name =~ ::Opal::CONST_NAME_REGEXP

  %x{
    if (inherit) {
      return Opal.$$([self], name);
    } else {
      return Opal.const_get_local(self, name);
    }
  }
end

#const_missing(name) ⇒ Object



361
362
363
364
365
# File 'opal/opal/corelib/module.rb', line 361

def const_missing(name)
  full_const_name = self == ::Object ? name : "#{self}::#{name}"

  ::Kernel.raise ::NameError.new("uninitialized constant #{full_const_name}", name)
end

#const_set(name, value) ⇒ Object



367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'opal/opal/corelib/module.rb', line 367

def const_set(name, value)
  `$deny_frozen_access(self)`

  name = ::Opal.const_name!(name)

  if name !~ ::Opal::CONST_NAME_REGEXP || name.start_with?('::')
    ::Kernel.raise ::NameError.new("wrong constant name #{name}", name)
  end

  `$const_set(self, name, value)`

  value
end

#constants(inherit = true) ⇒ Object



273
274
275
# File 'opal/opal/corelib/module.rb', line 273

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

#copy_class_variables(other) ⇒ Object



742
743
744
745
746
747
748
# File 'opal/opal/corelib/module.rb', line 742

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

#copy_constants(other) ⇒ Object



750
751
752
753
754
755
756
757
758
# File 'opal/opal/corelib/module.rb', line 750

def copy_constants(other)
  %x{
    var name, other_constants = other.$$const;

    for (name in other_constants) {
      $const_set(self, name, other_constants[name]);
    }
  }
end

#define_method(name, method = undefined, &block) ⇒ Object



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'opal/opal/corelib/module.rb', line 384

def define_method(name, method = undefined, &block)
  %x{
    $deny_frozen_access(self);

    if (method === undefined && block === nil)
      #{::Kernel.raise ::ArgumentError, 'tried to create a Proc object without a block'}
  }

  block ||= case method
            when ::Proc
              method

            when ::Method
              `#{method.to_proc}.$$unbound`

            when ::UnboundMethod
              ->(*args) {
                bound = method.bind(self)
                bound.call(*args)
              }

            else
              ::Kernel.raise ::TypeError, "wrong argument type #{block.class} (expected Proc/Method)"
            end

  %x{
    if (typeof(Proxy) !== 'undefined') {
      var meta = Object.create(null)

      block.$$proxy_target = block
      block = new Proxy(block, {
        apply: function(target, self, args) {
          var old_name = target.$$jsid
          target.$$jsid = name;
          try {
            return target.apply(self, args);
          } catch(e) {
            if (e === target.$$brk || e === target.$$ret) return e.$v;
            throw e;
          } finally {
            target.$$jsid = old_name
          }
        }
      })
    }

    block.$$jsid        = name;
    block.$$s           = null;
    block.$$def         = block;
    block.$$define_meth = true;

    return Opal.defn(self, $jsid(name), block);
  }
end

#dupObject



735
736
737
738
739
740
# File 'opal/opal/corelib/module.rb', line 735

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

#extend_object(object) ⇒ Object



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

def extend_object(object)
  `$deny_frozen_access(object)`
  nil
end

#extended(mod) ⇒ Object



537
538
# File 'opal/opal/corelib/module.rb', line 537

def extended(mod)
end

#freezeObject



439
440
441
442
443
444
445
446
447
448
449
450
# File 'opal/opal/corelib/module.rb', line 439

def freeze
  # Specialized version of freeze, because the $$base_module property needs to be
  # accessible despite the frozen status

  return self if frozen?

  %x{
    if (!self.hasOwnProperty('$$base_module')) { $prop(self, '$$base_module', null); }

    return $freeze(self);
  }
end

#include(*mods) ⇒ Object



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# File 'opal/opal/corelib/module.rb', line 472

def include(*mods)
  %x{
    for (var i = mods.length - 1; i >= 0; i--) {
      var mod = mods[i];

      if (!mod.$$is_module) {
        #{::Kernel.raise ::TypeError, "wrong argument type #{`mod`.class} (expected Module)"};
      }

      #{`mod`.append_features self};
      #{`mod`.included self};
    }
  }

  self
end

#include?(mod) ⇒ Boolean

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# File 'opal/opal/corelib/module.rb', line 493

def include?(mod)
  %x{
    if (!mod.$$is_module) {
      #{::Kernel.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



534
535
# File 'opal/opal/corelib/module.rb', line 534

def included(mod)
end

#included_modulesObject



489
490
491
# File 'opal/opal/corelib/module.rb', line 489

def included_modules
  `Opal.included_modules(self)`
end

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



512
513
514
515
516
517
518
519
520
521
522
# File 'opal/opal/corelib/module.rb', line 512

def instance_method(name)
  %x{
    var meth = self.$$prototype[$jsid(name)];

    if (!meth || meth.$$stub) {
      #{::Kernel.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



524
525
526
527
528
529
530
531
532
# File 'opal/opal/corelib/module.rb', line 524

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



720
721
722
723
724
725
726
727
728
729
730
731
732
733
# File 'opal/opal/corelib/module.rb', line 720

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



545
546
# File 'opal/opal/corelib/module.rb', line 545

def method_added(*)
end

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

Returns:



598
599
600
601
602
603
# File 'opal/opal/corelib/module.rb', line 598

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

#method_removedObject



548
549
# File 'opal/opal/corelib/module.rb', line 548

def method_removed(*)
end

#method_undefinedObject



551
552
# File 'opal/opal/corelib/module.rb', line 551

def method_undefined(*)
end

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



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
# File 'opal/opal/corelib/module.rb', line 554

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{new Function("Opal,self", "return " + compiled)(Opal, 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



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'opal/opal/corelib/module.rb', line 582

def module_exec(*args, &block)
  %x{
    if (block === nil) {
      #{::Kernel.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



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
# File 'opal/opal/corelib/module.rb', line 605

def module_function(*methods)
  %x{
    $deny_frozen_access(self);

    if (methods.length === 0) {
      self.$$module_function = true;
      return nil;
    }
    else {
      for (var i = 0, length = methods.length; i < length; i++) {
        var meth = methods[i],
            id   = $jsid(meth),
            func = self.$$prototype[id];

        Opal.defs(self, id, func);
      }
      return methods.length === 1 ? methods[0] : methods;
    }

    return self;
  }
end

#nameObject



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
# File 'opal/opal/corelib/module.rb', line 628

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 === $Object) {
        break;
      }
    }

    if (result.length === 0) {
      return nil;
    }

    return self.$$full_name = result.join('::');
  }
end

#prepend(*mods) ⇒ Object



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
# File 'opal/opal/corelib/module.rb', line 657

def prepend(*mods)
  %x{
    if (mods.length === 0) {
      #{::Kernel.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) {
        #{::Kernel.raise ::TypeError, "wrong argument type #{`mod`.class} (expected Module)"};
      }

      #{`mod`.prepend_features self};
      #{`mod`.prepended self};
    }
  }

  self
end

#prepend_features(prepender) ⇒ Object



678
679
680
681
682
683
684
685
686
687
688
689
# File 'opal/opal/corelib/module.rb', line 678

def prepend_features(prepender)
  %x{
    $deny_frozen_access(prepender);

    if (!self.$$is_module) {
      #{::Kernel.raise ::TypeError, "wrong argument type #{self.class} (expected Module)"};
    }

    Opal.prepend_features(self, prepender)
  }
  self
end

#prepended(mod) ⇒ Object



691
692
# File 'opal/opal/corelib/module.rb', line 691

def prepended(mod)
end

#private_class_method(*methods) ⇒ Object Also known as: public_class_method



71
72
73
# File 'opal/opal/corelib/unsupported.rb', line 71

def private_class_method(*methods)
  `return (methods.length === 1) ? methods[0] : methods`
end

#private_constantObject



79
80
# File 'opal/opal/corelib/unsupported.rb', line 79

def private_constant(*)
end

#private_method_defined?(obj) ⇒ Boolean Also known as: protected_method_defined?

Returns:



75
76
77
# File 'opal/opal/corelib/unsupported.rb', line 75

def private_method_defined?(obj)
  false
end

#public(*methods) ⇒ Object Also known as: nesting, private, protected



61
62
63
64
65
66
67
68
69
# File 'opal/opal/corelib/unsupported.rb', line 61

def public(*methods)
  %x{
    if (methods.length === 0) {
      self.$$module_function = false;
      return nil;
    }
    return (methods.length === 1) ? methods[0] : methods;
  }
end

#public_constant(const_name) ⇒ Object



381
382
# File 'opal/opal/corelib/module.rb', line 381

def public_constant(const_name)
end

#refine(klass, &block) ⇒ Object



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'opal/opal/corelib/module.rb', line 760

def refine(klass, &block)
  refinement_module, m, klass_id = self, nil, nil
  %x{
    klass_id = Opal.id(klass);
    if (typeof self.$$refine_modules === "undefined") {
      self.$$refine_modules = Object.create(null);
    }
    if (typeof self.$$refine_modules[klass_id] === "undefined") {
      m = self.$$refine_modules[klass_id] = #{::Refinement.new};
    }
    else {
      m = self.$$refine_modules[klass_id];
    }
    m.refinement_module = refinement_module
    m.refined_class = klass
  }
  m.class_exec(&block)
  m
end

#refinementsObject



780
781
782
783
784
785
786
787
788
789
# File 'opal/opal/corelib/module.rb', line 780

def refinements
  %x{
    var refine_modules = self.$$refine_modules, hash = #{{}};;
    if (typeof refine_modules === "undefined") return hash;
    for (var id in refine_modules) {
      hash['$[]='](refine_modules[id].refined_class, refine_modules[id]);
    }
    return hash;
  }
end

#remove_class_variable(name) ⇒ Object



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'opal/opal/corelib/module.rb', line 257

def remove_class_variable(name)
  `$deny_frozen_access(self)`

  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 {
      #{::Kernel.raise ::NameError, "cannot remove #{name} for #{self}"}
    }
  }
end

#remove_const(name) ⇒ Object



694
695
696
697
698
# File 'opal/opal/corelib/module.rb', line 694

def remove_const(name)
  `$deny_frozen_access(self)`

  `Opal.const_remove(self, name)`
end

#remove_method(*names) ⇒ Object



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# File 'opal/opal/corelib/module.rb', line 452

def remove_method(*names)
  %x{
    for (var i = 0; i < names.length; i++) {
      var name = names[i];
      if (!(typeof name === "string" || name.$$is_string)) {
        #{raise ::TypeError, "#{name} is not a symbol nor a string"}
      }
      $deny_frozen_access(self);

      Opal.rdef(self, "$" + name);
    }
  }

  self
end

#singleton_class?Boolean

Returns:



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

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

#to_sObject Also known as: inspect



700
701
702
# File 'opal/opal/corelib/module.rb', line 700

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

#undef_method(*names) ⇒ Object



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
# File 'opal/opal/corelib/module.rb', line 704

def undef_method(*names)
  %x{
    for (var i = 0; i < names.length; i++) {
      var name = names[i];
      if (!(typeof name === "string" || name.$$is_string)) {
        #{raise ::TypeError, "#{name} is not a symbol nor a string"}
      }
      $deny_frozen_access(self);

      Opal.udef(self, "$" + names[i]);
    }
  }

  self
end

#using(mod) ⇒ Object

Compiler overrides this method



792
793
794
# File 'opal/opal/corelib/module.rb', line 792

def using(mod)
  ::Kernel.raise 'Module#using is not permitted in methods'
end