Class: Bridgetown::Utils::LoadersManager

Inherits:
Object
  • Object
show all
Defined in:
lib/bridgetown-core/utils/loaders_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ LoadersManager

Returns a new instance of LoadersManager.

Parameters:



12
13
14
15
16
17
18
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 12

def initialize(config)
  @config = config
  @loaders = {}
  @root_dir = config.root_dir

  FileUtils.rm_f(Bridgetown.build_errors_path)
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



6
7
8
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 6

def config
  @config
end

#loaders ⇒ Object (readonly)

Returns the value of attribute loaders.



8
9
10
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 8

def loaders
  @loaders
end

#root_dir ⇒ Object (readonly)

Returns the value of attribute root_dir.



8
9
10
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 8

def root_dir
  @root_dir
end

Instance Method Details

#clear_descendants_for_reload(_cpath, value, _abspath) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 31

def clear_descendants_for_reload(_cpath, value, _abspath)
  unless value.is_a?(Class) && value.singleton_class < ActiveSupport::DescendantsTracker
    return
  end

  if defined?(ActiveSupport::RubyFeatures) && ActiveSupport::RubyFeatures::CLASS_SUBCLASSES
    ActiveSupport::DescendantsTracker.clear([value.superclass])
    return
  end

  # TODO: this could probably be refactored to work like the above
  if ActiveSupport::DescendantsTracker.class_variables.include?(:@@direct_descendants)
    ActiveSupport::DescendantsTracker.class_variable_get(
      :@@direct_descendants
    )[value.superclass]&.reject! { _1 == value }
  end
end

#reload_loaders ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 83

def reload_loaders
  FileUtils.rm_f(Bridgetown.build_errors_path)

  @loaders.each do |load_path, loader|
    next unless reloading_enabled?(load_path)

    Bridgetown::Hooks.trigger :loader, :pre_reload, loader, load_path
    loader.reload
    loader.eager_load if config.eager_load_paths.include?(load_path)
    Bridgetown::Hooks.trigger :loader, :post_reload, loader, load_path
  end
end

#reloading_enabled?(load_path) ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 27

def reloading_enabled?(load_path)
  load_path.start_with?(root_dir) && ENV["BRIDGETOWN_ENV"] != "production"
end

#setup_loaders(autoload_paths = []) ⇒ Object

rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity



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
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 49

def setup_loaders(autoload_paths = []) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
  (autoload_paths.presence || config.autoload_paths).each do |load_path| # rubocop:todo Metrics/BlockLength
    if @loaders.key?(load_path)
      raise "Zeitwerk loader already added for `#{load_path}'. Please check your config"
    end

    next unless Dir.exist? load_path

    loader = Zeitwerk::Loader.new
    loader.inflector = config.inflector if config.inflector
    begin
      loader.push_dir(load_path)
    rescue Zeitwerk::Error
      next
    end
    loader.enable_reloading if reloading_enabled?(load_path)
    loader.ignore(File.join(load_path, "**", "*.js.rb"))
    loader.ignore(
      File.join(File.expand_path(config[:islands_dir], config[:source]), "routes")
    )
    config.autoloader_collapsed_paths.each do |collapsed_path|
      next unless collapsed_path.starts_with?(load_path)

      loader.collapse(collapsed_path)
    end
    loader.on_unload(&method(:clear_descendants_for_reload)) # rubocop:disable Performance/MethodObjectAsBlock
    Bridgetown::Hooks.trigger :loader, :pre_setup, loader, load_path
    loader.setup
    loader.eager_load if config.eager_load_paths.include?(load_path)
    Bridgetown::Hooks.trigger :loader, :post_setup, loader, load_path
    @loaders[load_path] = loader
  end
end

#unload_loaders ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/bridgetown-core/utils/loaders_manager.rb', line 20

def unload_loaders
  return if @loaders.keys.empty?

  @loaders.each_value(&:unload)
  @loaders = {}
end