Class: Module

Inherits:
Object
  • Object
show all
Defined in:
opal/opal/corelib/module.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.new(&block) ⇒ Object 



2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'opal/opal/corelib/module.rb', line 2

def self.new(&block)
  %x{
    function AnonModule(){}
    var klass      = Opal.boot(Opal.Module, AnonModule);
    klass.$$name   = nil;
    klass.$$class  = Opal.Module;
    klass.$$dep    = []
    klass.$$is_mod = true;
    klass.$$proto  = {};

    // inherit scope from parent
    Opal.create_scope(Opal.Module.$$scope, klass);

    if (block !== nil) {
      var block_self = block.$$s;
      block.$$s = null;
      block.call(klass);
      block.$$s = block_self;
    }

    return klass;
  }
end

Instance Method Details

#<(other) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'opal/opal/corelib/module.rb', line 32

def <(other)
  %x{
    var working = self;

    while (working) {
      if (working === other) {
        return true;
      }

      working = working.$$parent;
    }

    return false;
  }
end

#===(object) ⇒ Object 



26
27
28
29
30
 
# File 'opal/opal/corelib/module.rb', line 26

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

  `Opal.is_a(object, self)`
end

#alias_method(newname, oldname) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'opal/opal/corelib/module.rb', line 48

def alias_method(newname, oldname)
  %x{
    var newjsid = '$' + newname,
        body    = self.$$proto['$' + oldname];

    if (self.$$is_singleton) {
      self.$$proto[newjsid] = body;
    }
    else {
      Opal.defn(self, newjsid, body);
    }

    return self;
  }
  self
end

#alias_native(mid, jsid = mid) ⇒ Object 



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

def alias_native(mid, jsid = mid)
  `self.$$proto['$' + mid] = self.$$proto[jsid]`
end

#ancestors ⇒ Object 



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

def ancestors
  %x{
    var parent = self,
        result = [];

    while (parent) {
      result.push(parent);
      result = result.concat(parent.$$inc);

      parent = parent.$$super;
    }

    return result;
  }
end

#append_features(klass) ⇒ Object 



85
86
87
88
 
# File 'opal/opal/corelib/module.rb', line 85

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

#attr_accessor(*names) ⇒ Object Also known as: attr 



90
91
92
93
 
# File 'opal/opal/corelib/module.rb', line 90

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

#attr_reader(*names) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'opal/opal/corelib/module.rb', line 95

def attr_reader(*names)
  %x{
    for (var i = 0, length = names.length; i < length; i++) {
      (function(name) {
        self.$$proto[name] = nil;
        var func = function() { return this[name] };

        if (self.$$is_singleton) {
          self.$$proto.constructor.prototype['$' + name] = func;
        }
        else {
          Opal.defn(self, '$' + name, func);
        }
      })(names[i]);
    }
  }

  nil
end

#attr_writer(*names) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'opal/opal/corelib/module.rb', line 115

def attr_writer(*names)
  %x{
    for (var i = 0, length = names.length; i < length; i++) {
      (function(name) {
        self.$$proto[name] = nil;
        var func = function(value) { return this[name] = value; };

        if (self.$$is_singleton) {
          self.$$proto.constructor.prototype['$' + name + '='] = func;
        }
        else {
          Opal.defn(self, '$' + name + '=', func);
        }
      })(names[i]);
    }
  }
  nil
end

#autoload(const, path) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'opal/opal/corelib/module.rb', line 136

def autoload(const, path)
  %x{
    var autoloaders;

    if (!(autoloaders = self.$$autoload)) {
      autoloaders = self.$$autoload = {};
    }

    autoloaders[#{const}] = #{path};
    return nil;
  }
end

#class_variable_get(name) ⇒ Object

Raises:



149
150
151
152
153
154
155
156
157
 
# File 'opal/opal/corelib/module.rb', line 149

def class_variable_get(name)
  name = Opal.coerce_to!(name, String, :to_str)
  raise NameError, 'class vars should start with @@' if `name.length < 3 || name.slice(0,2) !== '@@'`
  %x{
    var value = Opal.cvars[name.slice(2)];
    #{raise NameError, 'uninitialized class variable @@a in' if `value == null`}
    return value;
  }
end

#class_variable_set(name, value) ⇒ Object

Raises:



159
160
161
162
163
164
165
166
 
# File 'opal/opal/corelib/module.rb', line 159

def class_variable_set(name, value)
  name = Opal.coerce_to!(name, String, :to_str)
  raise NameError if `name.length < 3 || name.slice(0,2) !== '@@'`
  %x{
    Opal.cvars[name.slice(2)] = value;
    return value;
  }
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:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'opal/opal/corelib/module.rb', line 174

def const_defined?(name, inherit = true)
  raise NameError, "wrong constant name #{name}" unless name =~ /^[A-Z]\w*$/

  %x{
    scopes = [self.$$scope];
    if (inherit || self === Opal.Object) {
      var parent = self.$$super;
      while (parent !== Opal.BasicObject) {
        scopes.push(parent.$$scope);
        parent = parent.$$super;
      }
    }

    for (var i = 0, len = scopes.length; i < len; i++) {
      if (scopes[i].hasOwnProperty(name)) {
        return true;
      }
    }

    return false;
  }
end

#const_get(name, inherit = true) ⇒ Object

Raises:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'opal/opal/corelib/module.rb', line 197

def const_get(name, inherit = true)
  raise NameError, "wrong constant name #{name}" unless name =~ /^[A-Z]\w*$/

  %x{
    var scopes = [self.$$scope];
    if (inherit || self == Opal.Object) {
      var parent = self.$$super;
      while (parent !== Opal.BasicObject) {
        scopes.push(parent.$$scope);
        parent = parent.$$super;
      }
    }

    for (var i = 0, len = scopes.length; i < len; i++) {
      if (scopes[i].hasOwnProperty(name)) {
        return scopes[i][name];
      }
    }

    return #{const_missing name};
  }
end

#const_missing(const) ⇒ Object

Raises:



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'opal/opal/corelib/module.rb', line 220

def const_missing(const)
  %x{
    if (self.$$autoload) {
      var file = self.$$autoload[#{const}];

      if (file) {
        self.$require(file);

        return #{const_get const};
      }
    }
  }

  raise NameError, "uninitialized constant #{self}::#{const}"
end

#const_set(name, value) ⇒ Object

Raises:



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'opal/opal/corelib/module.rb', line 236

def const_set(name, value)
  raise NameError, "wrong constant name #{name}" unless name =~ /^[A-Z]\w*$/

  begin
    name = name.to_str
  rescue
    raise TypeError, 'conversion with #to_str failed'
  end

  `Opal.casgn(self, name, value)`

  value
end

#constants ⇒ Object 



168
169
170
 
# File 'opal/opal/corelib/module.rb', line 168

def constants
  `self.$$scope.constants`
end

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'opal/opal/corelib/module.rb', line 250

def define_method(name, method = undefined, &block)
  %x{
    if (method) {
      block = #{method.to_proc};
    }

    if (block === nil) {
      throw new Error("no block given");
    }

    var jsid    = '$' + name;
    block.$$jsid = name;
    block.$$s    = null;
    block.$$def  = block;

    if (self.$$is_singleton) {
      self.$$proto[jsid] = block;
    }
    else {
      Opal.defn(self, jsid, block);
    }

    return name;
  }
end

#extended(mod) ⇒ Object 



373
374
 
# File 'opal/opal/corelib/module.rb', line 373

def extended(mod)
end

#include(*mods) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'opal/opal/corelib/module.rb', line 288

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

      if (mod === self) {
        continue;
      }

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

  self
end

#include?(mod) ⇒ Boolean

Returns:



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'opal/opal/corelib/module.rb', line 305

def include?(mod)
  %x{
    for (var cls = self; cls; cls = cls.parent) {
      for (var i = 0; i != cls.$$inc.length; i++) {
        var mod2 = cls.$$inc[i];
        if (mod === mod2) {
          return true;
        }
      }
    }
    return false;
  }
end

#included(mod) ⇒ Object 



370
371
 
# File 'opal/opal/corelib/module.rb', line 370

def included(mod)
end

#instance_method(name) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
 
# File 'opal/opal/corelib/module.rb', line 319

def instance_method(name)
  %x{
    var meth = self.$$proto['$' + name];

    if (!meth || meth.$$stub) {
      #{raise NameError, "undefined method `#{name}' for class `#{self.name}'"};
    }

    return #{UnboundMethod.new(self, `meth`, name)};
  }
end

#instance_methods(include_super = false) ⇒ Object Also known as: public_instance_methods 



331
332
333
334
335
336
337
338
339
340
341
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
 
# File 'opal/opal/corelib/module.rb', line 331

def instance_methods(include_super = false)
  %x{
    var methods = [],
        proto   = self.$$proto;

    for (var prop in proto) {
      if (!prop.charAt(0) === '$') {
        continue;
      }

      if (typeof(proto[prop]) !== "function") {
        continue;
      }

      if (proto[prop].$$stub) {
        continue;
      }

      if (!self.$$is_mod) {
        if (self !== Opal.BasicObject && proto[prop] === Opal.BasicObject.$$proto[prop]) {
          continue;
        }

        if (!include_super && !proto.hasOwnProperty(prop)) {
          continue;
        }

        if (!include_super && proto[prop].$$donated) {
          continue;
        }
      }

      methods.push(prop.substr(1));
    }

    return methods;
  }
end

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

Returns:



411
412
413
414
415
416
 
# File 'opal/opal/corelib/module.rb', line 411

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

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

Raises:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'opal/opal/corelib/module.rb', line 376

def module_eval(&block)
  raise ArgumentError, 'no block given' unless block

  %x{
    var old = block.$$s,
        result;

    block.$$s = null;
    result = block.call(self);
    block.$$s = old;

    return result;
  }
end

#module_exec(&block) ⇒ Object Also known as: class_exec 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'opal/opal/corelib/module.rb', line 393

def module_exec(&block)
  %x{
    if (block === nil) {
      throw new Error("no block given");
    }

    var block_self = block.$$s, result;

    block.$$s = null;
    result = block.apply(self, $slice.call(arguments));
    block.$$s = block_self;

    return result;
  }
end

#module_function(*methods) ⇒ Object 



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'opal/opal/corelib/module.rb', line 418

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], func = self.$$proto['$' + meth];

        self.constructor.prototype['$' + meth] = func;
      }
    }

    return self;
  }
end

#name ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'opal/opal/corelib/module.rb', line 435

def name
  %x{
    if (self.$$full_name) {
      return self.$$full_name;
    }

    var result = [], base = self;

    while (base) {
      if (base.$$name === nil) {
        return result.length === 0 ? nil : result.join('::');
      }

      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

#private_class_method(name) ⇒ Object Also known as: public_class_method 



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

def private_class_method(name)
  `self['$' + name] || nil`
end

#private_constant ⇒ Object 



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

def private_constant(*)
end

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

Returns:



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

def private_method_defined?(obj)
  false
end

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



465
466
467
468
469
470
471
472
473
 
# File 'opal/opal/corelib/module.rb', line 465

def public(*methods)
  %x{
    if (methods.length === 0) {
      self.$$module_function = false;
    }

    return nil;
  }
end

#remove_class_variable ⇒ Object 



497
498
 
# File 'opal/opal/corelib/module.rb', line 497

def remove_class_variable(*)
end

#remove_const(name) ⇒ Object 



500
501
502
503
504
505
506
 
# File 'opal/opal/corelib/module.rb', line 500

def remove_const(name)
  %x{
    var old = self.$$scope[name];
    delete self.$$scope[name];
    return old;
  }
end

#remove_method(name) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
 
# File 'opal/opal/corelib/module.rb', line 276

def remove_method(name)
  %x{
    var jsid    = '$' + name;
    var current = self.$$proto[jsid];
    delete self.$$proto[jsid];

    // Check if we need to reverse Opal.donate
    // Opal.retire(self, [jsid]);
    return self;
  }
end

#to_s ⇒ Object 



508
509
510
 
# File 'opal/opal/corelib/module.rb', line 508

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

#undef_method(symbol) ⇒ Object 



512
513
514
515
516
 
# File 'opal/opal/corelib/module.rb', line 512

def undef_method(symbol)
  `Opal.add_stub_for(self.$$proto, "$" + symbol)`

  self
end