Module: Opal

Defined in:
opal/opal/corelib/helpers.rb

Overview

helpers: type_error, coerce_to

Class Method Summary collapse

Class Method Details

.bridge(constructor, klass) ⇒ Object

[View source]

4
5
6
 
# File 'opal/opal/corelib/helpers.rb', line 4

def self.bridge(constructor, klass)
  `Opal.bridge(constructor, klass)`
end

.class_variable_name!(name) ⇒ Object

[View source]

87
88
89
90
91
92
93
94
95
 
# File 'opal/opal/corelib/helpers.rb', line 87

def self.class_variable_name!(name)
  name = Opal.coerce_to!(name, String, :to_str)

  if `name.length < 3 || name.slice(0,2) !== '@@'`
    raise NameError.new("`#{name}' is not allowed as a class variable name", name)
  end

  name
end

.coerce_to!(object, type, method, *args) ⇒ Object

[View source]

8
9
10
11
12
13
14
15
16
 
# File 'opal/opal/corelib/helpers.rb', line 8

def self.coerce_to!(object, type, method, *args)
  coerced = `$coerce_to(object, type, method, args)`

  unless type === coerced
    raise `$type_error(object, type, method, coerced)`
  end

  coerced
end

.coerce_to?(object, type, method, *args) ⇒ Boolean

Returns:

[View source]

18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'opal/opal/corelib/helpers.rb', line 18

def self.coerce_to?(object, type, method, *args)
  return unless object.respond_to? method

  coerced = `$coerce_to(object, type, method, args)`

  return if coerced.nil?

  unless type === coerced
    raise `$type_error(object, type, method, coerced)`
  end

  coerced
end

.compare(a, b) ⇒ Object

[View source]

40
41
42
43
44
45
46
47
48
 
# File 'opal/opal/corelib/helpers.rb', line 40

def self.compare(a, b)
  compare = a <=> b

  if `compare === nil`
    raise ArgumentError, "comparison of #{a.class} with #{b.class} failed"
  end

  compare
end

.const_name!(const_name) ⇒ Object

[View source]

97
98
99
100
101
102
103
104
105
 
# File 'opal/opal/corelib/helpers.rb', line 97

def self.const_name!(const_name)
  const_name = Opal.coerce_to!(const_name, String, :to_str)

  if const_name[0] != const_name[0].upcase
    raise NameError, "wrong constant name #{const_name}"
  end

  const_name
end

.destructure(args) ⇒ Object

[View source]

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

def self.destructure(args)
  %x{
    if (args.length == 1) {
      return args[0];
    }
    else if (args.$$is_array) {
      return args;
    }
    else {
      var args_ary = new Array(args.length);
      for(var i = 0, l = args_ary.length; i < l; i++) { args_ary[i] = args[i]; }

      return args_ary;
    }
  }
end

.instance_variable_name!(name) ⇒ Object

[View source]

77
78
79
80
81
82
83
84
85
 
# File 'opal/opal/corelib/helpers.rb', line 77

def self.instance_variable_name!(name)
  name = Opal.coerce_to!(name, String, :to_str)

  unless `/^@[a-zA-Z_][a-zA-Z0-9_]*?$/.test(name)`
    raise NameError.new("'#{name}' is not allowed as an instance variable name", name)
  end

  name
end

.pristine(owner_class, *method_names) ⇒ nil

Mark some methods as pristine in order to apply optimizations when they are still in their original form. This could probably be moved to the Opal.def() JS API, but for now it will stay manual.

Examples:


Opal.pristine Array, :allocate, :copy_instance_variables, :initialize_dup

class Array
  def dup
    %x{
      if (
        self.$allocate.$$pristine &&
        self.$copy_instance_variables.$$pristine &&
        self.$initialize_dup.$$pristine
      ) return self.slice(0);
    }

    super
  end
end

Parameters:

  • owner_class (Class) —

    the class owning the methods

  • method_names (Array<Symbol>) —

    the list of methods names to mark

Returns:

  • (nil)
[View source]

133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'opal/opal/corelib/helpers.rb', line 133

def self.pristine(owner_class, *method_names)
  %x{
    var method_name, method;
    for (var i = method_names.length - 1; i >= 0; i--) {
      method_name = method_names[i];
      method = owner_class.$$prototype['$'+method_name];

      if (method && !method.$$stub) {
        method.$$pristine = true;
      }
    }
  }
  nil
end

.respond_to?(obj, method, include_all = false) ⇒ Boolean

Returns:

[View source]

67
68
69
70
71
72
73
74
75
 
# File 'opal/opal/corelib/helpers.rb', line 67

def self.respond_to?(obj, method, include_all = false)
  %x{
    if (obj == null || !obj.$$class) {
      return false;
    }
  }

  obj.respond_to?(method, include_all)
end

.try_convert(object, type, method) ⇒ Object

[View source]

32
33
34
35
36
37
38
 
# File 'opal/opal/corelib/helpers.rb', line 32

def self.try_convert(object, type, method)
  return object if type === object

  if object.respond_to? method
    object.__send__ method
  end
end