Module: ReactOnRails::WebpackerUtils

Defined in:
lib/react_on_rails/webpacker_utils.rb

Class Method Summary collapse

Class Method Details

.bundle_js_uri_from_webpacker(bundle_name) ⇒ Object

This returns either a URL for the webpack-dev-server, non-server bundle or the hashed server bundle if using the same bundle for the client. Otherwise returns a file path.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 29

def self.bundle_js_uri_from_webpacker(bundle_name)
  # Note Webpacker 3.4.3 manifest lookup is inside of the public_output_path
  # [2] (pry) ReactOnRails::WebpackerUtils: 0> Webpacker.manifest.lookup("app-bundle.js")
  # "/webpack/development/app-bundle-c1d2b6ab73dffa7d9c0e.js"
  # Next line will throw if the file or manifest does not exist
  hashed_bundle_name = Webpacker.manifest.lookup!(bundle_name)

  # Support for hashing the server-bundle and having that built
  # the webpack-dev-server is provided by the config value
  # "same_bundle_for_client_and_server" where a value of true
  # would mean that the bundle is created by the webpack-dev-server
  is_server_bundle = bundle_name == ReactOnRails.configuration.server_bundle_js_file

  if Webpacker.dev_server.running? && (!is_server_bundle ||
    ReactOnRails.configuration.same_bundle_for_client_and_server)
    "#{Webpacker.dev_server.protocol}://#{Webpacker.dev_server.host_with_port}#{hashed_bundle_name}"
  else
    File.expand_path(File.join("public", hashed_bundle_name)).to_s
  end
end

.check_manifest_not_cached ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 77

def self.check_manifest_not_cached
  return unless using_webpacker? && Webpacker.config.cache_manifest?

  msg = <<-MSG.strip_heredoc
      ERROR: you have enabled cache_manifest in the #{Rails.env} env when using the
      ReactOnRails::TestHelper.configure_rspec_to_compile_assets helper
      To fix this: edit your config/webpacker.yml file and set cache_manifest to false for test.
  MSG
  puts wrap_message(msg)
  exit!
end

.dev_server_running? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 14

def self.dev_server_running?
  return false unless using_webpacker?

  Webpacker.dev_server.running?
end

.manifest_exists? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 67

def self.manifest_exists?
  Webpacker.config.public_manifest_path.exist?
end

.nested_entries? ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 58

def self.nested_entries?
  Webpacker.config.nested_entries?
end

.shakapacker_version ⇒ Object 



20
21
22
23
24
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 20

def self.shakapacker_version
  return nil unless ReactOnRails::Utils.gem_available?("shakapacker")

  Gem.loaded_specs["shakapacker"].version.to_s
end

.using_webpacker? ⇒ Boolean

TODO: V13 code should be cleaned up so that the webpacker gem is required. This check should only be done at startup.

Returns:

  • (Boolean) 


7
8
9
10
11
12
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 7

def self.using_webpacker?
  return @using_webpacker if defined?(@using_webpacker)

  @using_webpacker = ReactOnRails::Utils.gem_available?("webpacker") ||
                     ReactOnRails::Utils.gem_available?("shakapacker")
end

.webpacker_public_output_path ⇒ Object 



62
63
64
65
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 62

def self.webpacker_public_output_path
  # Webpacker has the full absolute path of webpacker output files in a Pathname
  Webpacker.config.public_output_path.to_s
end

.webpacker_source_entry_path ⇒ Object 



54
55
56
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 54

def self.webpacker_source_entry_path
  Webpacker.config.source_entry_path
end

.webpacker_source_path ⇒ Object 



50
51
52
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 50

def self.webpacker_source_path
  Webpacker.config.source_path
end

.webpacker_source_path_explicit? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
75
 
# File 'lib/react_on_rails/webpacker_utils.rb', line 71

def self.webpacker_source_path_explicit?
  # WARNING: Calling private method `data` on Webpacker::Configuration, lib/webpacker/configuration.rb
  config_webpacker_yml = Webpacker.config.send(:data)
  config_webpacker_yml[:source_path].present?
end