Class: Opal::Processor

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

Overview

Internal: 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 



16
17
18
 
# File 'opal/lib/opal/sprockets/processor.rb', line 16

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

.reset_cache_key! ⇒ Object 



20
21
22
 
# File 'opal/lib/opal/sprockets/processor.rb', line 20

def self.reset_cache_key!
  @@cache_key = nil
end

.sprockets_extnames_regexp(sprockets) ⇒ Object 



59
60
61
62
 
# File 'opal/lib/opal/sprockets/processor.rb', line 59

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

Deprecated. 


128
129
130
131
 
# File 'opal/lib/opal/sprockets/processor.rb', line 128

def self.stub_file(name)
  warn "DEPRECATION WARNING: `::Opal::Processor.stub_file' is deprecated, use `::Opal::Config.stubbed_files << #{name.inspect}.to_s' instead"
  ::Opal::Config.stubbed_files << name.to_s
end

.stubbed_files ⇒ Object

Deprecated. 


122
123
124
125
 
# File 'opal/lib/opal/sprockets/processor.rb', line 122

def self.stubbed_files
  warn "DEPRECATION WARNING: `::Opal::Processor.stubbed_files' is deprecated, use `::Opal::Config.stubbed_files' instead"
  ::Opal::Config.stubbed_files
end

Instance Method Details

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



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
53
54
55
56
57
 
# File 'opal/lib/opal/sprockets/processor.rb', line 24

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
  root_path_regexp = Regexp.escape(context.root_path)
  logical_path = filename.gsub(%r{^#{root_path_regexp}/?(.*?)#{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

Internal: Add files required with require_tree as asset dependencies.

Mimics (v2) Sprockets::DirectiveProcessor#process_require_tree_directive



78
79
80
81
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
 
# File 'opal/lib/opal/sprockets/processor.rb', line 78

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: #{{source: original_required_tree, pathname: 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 



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

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

#sprockets_extnames_regexp ⇒ Object 



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

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