Class: Opal::Processor

Inherits:
TiltTemplate show all
Defined in:
opal/lib/opal/sprockets/processor.rb

Overview

The Processor class is used to make ruby files (with rb or opal extensions) available to any sprockets based server. Processor will then get passed any ruby source file to build.

Direct Known Subclasses

ERB::Processor

Constant Summary

@@cache_key = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TiltTemplate

compiler_options, #compiler_options, engine_initialized?, inherited, #initialize_engine, #prepare, version

Class Method Details

.cache_key ⇒ Object 



23
24
25
 
# File 'opal/lib/opal/sprockets/processor.rb', line 23

def self.cache_key
  @@cache_key ||= ['Opal', Opal::VERSION, Opal::Config.config].to_json.freeze
end

.load_asset_code(sprockets, name) ⇒ Object 



125
126
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
 
# File 'opal/lib/opal/sprockets/processor.rb', line 125

def self.load_asset_code(sprockets, name)
  asset = sprockets[name.sub(/(\.(js|rb|opal))*#{REGEXP_END}/, '.js')]
  return '' if asset.nil?

  opal_extnames = sprockets.engines.map do |ext, engine|
    ext if engine <= ::Opal::Processor
  end.compact

  module_name = -> asset { asset.logical_path.sub(/\.js#{REGEXP_END}/, '') }
  path_extnames = -> path { File.basename(path).scan(/\.[^.]+/) }
  mark_as_loaded = -> path { "Opal.mark_as_loaded(#{path.inspect});" }
  processed_by_opal = -> asset { (path_extnames[asset.pathname] & opal_extnames).any? }

  non_opal_assets = ([asset]+asset.dependencies)
    .select { |asset| not(processed_by_opal[asset]) }
    .map { |asset| module_name[asset] }

  mark_as_loaded = (['opal'] + non_opal_assets + stubbed_files.to_a)
    .map { |path| mark_as_loaded[path] }

  if processed_by_opal[asset]
    load_asset_code = "Opal.load(#{module_name[asset].inspect});"
  end

  <<-JS
  if (typeof(Opal) !== 'undefined') {
    #{mark_as_loaded.join("\n")}
    #{load_asset_code}
  }
  JS
end

.reset_cache_key! ⇒ Object 



27
28
29
 
# File 'opal/lib/opal/sprockets/processor.rb', line 27

def self.reset_cache_key!
  @@cache_key = nil
end

.sprockets_extnames_regexp(sprockets) ⇒ Object 



65
66
67
68
 
# File 'opal/lib/opal/sprockets/processor.rb', line 65

def self.sprockets_extnames_regexp(sprockets)
  joined_extnames = (['.js']+sprockets.engines.keys).map { |ext| Regexp.escape(ext) }.join('|')
  Regexp.new("(#{joined_extnames})*$")
end

.stub_file(name) ⇒ Object 



161
162
163
 
# File 'opal/lib/opal/sprockets/processor.rb', line 161

def self.stub_file(name)
  stubbed_files << name.to_s
end

.stubbed_files ⇒ Object 



157
158
159
 
# File 'opal/lib/opal/sprockets/processor.rb', line 157

def self.stubbed_files
  @stubbed_files ||= Set.new
end

Instance Method Details

#evaluate(context, locals, &block) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'opal/lib/opal/sprockets/processor.rb', line 31

def evaluate(context, locals, &block)
  return super unless context.is_a? ::Sprockets::Context

  @sprockets = sprockets = context.environment

  # In Sprockets 3 logical_path has an odd behavior when the filename is "index"
  # thus we need to bake our own logical_path
  filename = context.respond_to?(:filename) ? context.filename : context.pathname.to_s
  logical_path = filename.gsub(%r{^#{context.root_path}/?(.*?)#{sprockets_extnames_regexp}}, '\1')

  compiler_options = self.compiler_options.merge(file: logical_path)

  # Opal will be loaded immediately to as the runtime redefines some crucial
  # methods such that need to be implemented as soon as possible:
  #
  # E.g. It forwards .toString() to .$to_s() for Opal objects including Array.
  #      If .$to_s() is not implemented and some other lib is loaded before
  #      corelib/* .toString results in an `undefined is not a function` error.
  compiler_options.merge!(requirable: false) if logical_path == 'opal'

  compiler = Compiler.new(data, compiler_options)
  result = compiler.compile

  process_requires(compiler.requires, context)
  process_required_trees(compiler.required_trees, context)

  if Opal::Config.source_map_enabled
    map_contents = compiler.source_map.as_json.to_json
    ::Opal::SourceMapServer.set_map_cache(sprockets, logical_path, map_contents)
  end

  result.to_s
end

#process_required_trees(required_trees, context) ⇒ Object

Mimics (v2) Sprockets::DirectiveProcessor#process_require_tree_directive



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'opal/lib/opal/sprockets/processor.rb', line 82

def process_required_trees(required_trees, context)
  return if required_trees.empty?

  # This is the root dir of the logical path, we need this because
  # the compiler gives us the path relative to the file's logical path.
  dirname = File.dirname(file).gsub(/#{Regexp.escape File.dirname(context.logical_path)}#{REGEXP_END}/, '')
  dirname = Pathname(dirname)

  required_trees.each do |original_required_tree|
    required_tree = Pathname(original_required_tree)

    unless required_tree.relative?
      raise ArgumentError, "require_tree argument must be a relative path: #{required_tree.inspect}"
    end

    required_tree = dirname.join(file, '..', required_tree)

    unless required_tree.directory?
      raise ArgumentError, "require_tree argument must be a directory: #{[original_required_tree, required_tree].inspect}"
    end

    context.depend_on required_tree.to_s

    environment = context.environment

    processor = ::Sprockets::DirectiveProcessor.new
    processor.instance_variable_set('@dirname', File.dirname(file))
    processor.instance_variable_set('@environment', environment)
    path = processor.__send__(:expand_relative_dirname, :require_tree, original_required_tree)
    absolute_paths = environment.__send__(:stat_sorted_tree_with_dependencies, path).first.map(&:first)

    absolute_paths.each do |path|
      path = Pathname(path)
      pathname = path.relative_path_from(dirname).to_s

      if name.to_s == file  then next
      elsif path.directory? then context.depend_on(path.to_s)
      else context.require_asset(pathname)
      end
    end
  end
end

#process_requires(requires, context) ⇒ Object 



74
75
76
77
78
79
 
# File 'opal/lib/opal/sprockets/processor.rb', line 74

def process_requires(requires, context)
  requires.each do |required|
    required = required.to_s.sub(sprockets_extnames_regexp, '')
    context.require_asset required unless stubbed_files.include? required
  end
end

#sprockets_extnames_regexp ⇒ Object 



70
71
72
 
# File 'opal/lib/opal/sprockets/processor.rb', line 70

def sprockets_extnames_regexp
  @sprockets_extnames_regexp ||= self.class.sprockets_extnames_regexp(@sprockets)
end

#stubbed_files ⇒ Object 



165
166
167
 
# File 'opal/lib/opal/sprockets/processor.rb', line 165

def stubbed_files
  self.class.stubbed_files
end