Class: Opal::Sprockets::Processor

Inherits:
Object
  • Object
show all
Defined in:
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

Defined Under Namespace

Modules: PlainJavaScriptLoader

Constant Summary collapse

@@cache_key = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input) ⇒ Processor

Returns a new instance of Processor.



39
40
41
42
43
44
 
# File 'lib/opal/sprockets/processor.rb', line 39

def initialize(input)
  @input = input
  @sprockets = input[:environment]
  @context = sprockets.context_class.new(input)
  @data = input[:data]
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



46
47
48
 
# File 'lib/opal/sprockets/processor.rb', line 46

def context
  @context
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



46
47
48
 
# File 'lib/opal/sprockets/processor.rb', line 46

def data
  @data
end

#input ⇒ Object (readonly)

Returns the value of attribute input.



46
47
48
 
# File 'lib/opal/sprockets/processor.rb', line 46

def input
  @input
end

#sprockets ⇒ Object (readonly)

Returns the value of attribute sprockets.



46
47
48
 
# File 'lib/opal/sprockets/processor.rb', line 46

def sprockets
  @sprockets
end

Class Method Details

.cache_key ⇒ Object 



13
14
15
16
 
# File 'lib/opal/sprockets/processor.rb', line 13

def self.cache_key
  gem_config = Gem.loaded_specs.map {|gem_key, gem_spec| [gem_spec.name, gem_spec.version.to_s] }
  @@cache_key ||= ['Opal', Opal::VERSION, Opal::Config.config, gem_config].to_json.freeze
end

.call(input) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/opal/sprockets/processor.rb', line 22

def self.call(input)
  data, map, dependencies, required = input[:cache].fetch([self.cache_key, input[:filename], input[:data]]) do
    new(input).call
  end

  if map
    map = ::Sprockets::SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
  end

  {
    data: data,
    map: map,
    dependencies: input[:metadata][:dependencies].to_a + dependencies.to_a,
    required: input[:metadata][:required].to_a + required.to_a,
  }
end

.reset_cache_key! ⇒ Object 



18
19
20
 
# File 'lib/opal/sprockets/processor.rb', line 18

def self.reset_cache_key!
  @@cache_key = nil
end

Instance Method Details

#call ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/opal/sprockets/processor.rb', line 54

def call
  compiler_options = Opal::Config.compiler_options.merge(requirable: true, file: logical_path)

  compiler = Opal::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 = compiler.source_map.as_json.transform_keys!(&:to_s)
    map["sources"][0] = input[:filename]
    map = ::Sprockets::SourceMapUtils.format_source_map(map, input)
  end

  [result.to_s, map , context.metadata[:dependencies], context.metadata[:required]]
end

#logical_path ⇒ Object

In Sprockets 3 logical_path has an odd behavior when the filename is “index” thus we need to bake our own logical_path



50
51
52
 
# File 'lib/opal/sprockets/processor.rb', line 50

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



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

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(input[:filename]).gsub(/#{Regexp.escape File.dirname(context.logical_path)}#{Opal::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(input[:filename], '..', 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(input[:filename]))
    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
      pathname_noext = pathname.sub(sprockets_extnames_regexp, '')

      if path.to_s == logical_path then next
      elsif ::Opal::Config.stubbed_files.include?(pathname_noext) then next
      elsif path.directory? then context.depend_on(path.to_s)
      else context.require_asset(pathname_noext)
      end
    end
  end
end

#process_requires(requires, context) ⇒ Object 



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

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 



72
73
74
 
# File 'lib/opal/sprockets/processor.rb', line 72

def sprockets_extnames_regexp
  @sprockets_extnames_regexp ||= Opal::Sprockets.sprockets_extnames_regexp(@sprockets)
end