Module: WeasyPDF

Defined in:
lib/weasy_pdf.rb,
lib/weasy_pdf/railtie.rb,
lib/weasy_pdf/version.rb,
lib/weasy_pdf/middleware.rb,
lib/weasy_pdf/pdf_helper.rb,
lib/weasy_pdf/configuration.rb,
lib/weasy_pdf/command_builder.rb,
lib/weasy_pdf/view_helpers/assets.rb,
lib/weasy_pdf/view_helpers/vite_assets.rb,
lib/generators/weasy_pdf/install_generator.rb,
sig/renderer.rbs,
sig/weasy_pdf.rbs,
sig/configuration.rbs

Defined Under Namespace

Modules: Generators, PdfHelper, ViewHelpers Classes: BinaryNotFoundError, CommandBuilder, Configuration, Error, GenerationError, Middleware, MissingAsset, MissingLocalAsset, MissingRemoteAsset, Railtie, Renderer, TimeoutError, ViteDevServerConfigError

Constant Summary collapse

VERSION =

Returns:

  • (String) 
"0.1.2"

Class Method Summary collapse

Class Method Details

.clear_config ⇒ Configuration

Some WickedPdf initializers call clear_config between requests — alias reset! for drop-in compat.

Returns:



59
60
61
 
# File 'lib/weasy_pdf.rb', line 59

def clear_config
  reset!
end

.config ⇒ Configuration

Returns:



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

def config
  configuration
end

.config=(hash) ⇒ void

This method returns an undefined value.

Parameters:

  • hash (Hash[Symbol, untyped]) 


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

def config=(hash)
  hash.each { |k, v| configuration[k] = v }
end

.configuration ⇒ Configuration

Returns:



46
47
48
 
# File 'lib/weasy_pdf.rb', line 46

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

Yield Returns:

  • (void) 


42
43
44
 
# File 'lib/weasy_pdf.rb', line 42

def configure
  yield configuration
end

.new(options = {}) ⇒ Renderer

Drop-in equivalent of WickedPdf.new — returns a Renderer instance. WeasyPDF.new(options).pdf_from_string(html) ≡ WickedPdf.new.pdf_from_string(html).

Parameters:

  • options (Hash[Symbol, untyped]) (defaults to: {})

Returns:



73
74
75
 
# File 'lib/weasy_pdf.rb', line 73

def new(options = {})
  Renderer.new(options)
end

.reset! ⇒ Configuration

Returns:



63
64
65
 
# File 'lib/weasy_pdf.rb', line 63

def reset!
  @configuration = Configuration.new
end

.silence_deprecations ⇒ void

This method returns an undefined value.

No-op for API compat — WeasyPDF has no deprecation warnings to silence.



68
69
 
# File 'lib/weasy_pdf.rb', line 68

def silence_deprecations
end