Class: ViewComponent::Compiler

Inherits:
Object
  • Object
show all
Defined in:
lib/view_component/compiler.rb

Constant Summary collapse

DEVELOPMENT_MODE =

Compiler mode. Can be either:

  • development (a blocking mode which ensures thread safety when redefining the ‘call` method for components,

    default in Rails development and test mode)

  • production (a non-blocking mode, default in Rails production mode)

:development
PRODUCTION_MODE = 
:production

Instance Method Summary collapse

Constructor Details

#initialize(component_class) ⇒ Compiler

Returns a new instance of Compiler.



16
17
18
19
 
# File 'lib/view_component/compiler.rb', line 16

def initialize(component_class)
  @component_class = component_class
  @redefinition_lock = Mutex.new
end

Instance Method Details

#compile(raise_errors: false, force: false) ⇒ Object 



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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/view_component/compiler.rb', line 29

def compile(raise_errors: false, force: false)
  return if compiled? && !force
  return if component_class == ViewComponent::Base

  component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
  subclass_instance_methods = component_class.instance_methods(false)

  if subclass_instance_methods.include?(:with_content) && raise_errors
    raise ViewComponent::ComponentError.new(
      "#{component_class} implements a reserved method, `#with_content`.\n\n" \
      "To fix this issue, change the name of the method."
    )
  end

  if template_errors.present?
    raise ViewComponent::TemplateError.new(template_errors) if raise_errors

    return false
  end

  if subclass_instance_methods.include?(:before_render_check)
    ViewComponent::Deprecation.deprecation_warning(
      "`before_render_check`", :"`before_render`"
    )
  end

  if raise_errors
    component_class.validate_initialization_parameters!
    component_class.validate_collection_parameter!
  end

  templates.each do |template|
    # Remove existing compiled template methods,
    # as Ruby warns when redefining a method.
    method_name = call_method_name(template[:variant])

    redefinition_lock.synchronize do
      component_class.silence_redefinition_of_method(method_name)
      # rubocop:disable Style/EvalWithLocation
      component_class.class_eval <<-RUBY, template[:path], 0
      def #{method_name}
        #{compiled_template(template[:path])}
      end
      RUBY
      # rubocop:enable Style/EvalWithLocation
    end
  end

  define_render_template_for

  component_class.build_i18n_backend

  CompileCache.register(component_class)
end

#compiled? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/view_component/compiler.rb', line 21

def compiled?
  CompileCache.compiled?(component_class)
end

#development? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/view_component/compiler.rb', line 25

def development?
  self.class.mode == DEVELOPMENT_MODE
end