class Prawn::SVG::Elements::Base
Constants
- COMMA_WSP_REGEXP
- MissingAttributesError
- PAINT_TYPES
- SVG_NAMESPACE
- SkipElementError
- SkipElementQuietly
Attributes
attributes[R]
base_calls[R]
calls[RW]
document[R]
parent_calls[R]
properties[R]
source[R]
state[R]
Public Class Methods
new(document, source, parent_calls, state)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 28 def initialize(document, source, parent_calls, state) @document = document @source = source @parent_calls = parent_calls @state = state @base_calls = @calls = [] @attributes = {} @properties = Prawn::SVG::Properties.new if source && !state.inside_use id = source.attributes["id"] id = id.strip if id document.elements_by_id[id] = self if id && id != '' end end
Public Instance Methods
name()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 65 def name @name ||= source ? source.name : "???" end
parse_and_apply()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 50 def parse_and_apply parse_standard_attributes parse apply_calls_from_standard_attributes apply process_child_elements if container? append_calls_to_parent unless computed_properties.display == 'none' rescue SkipElementQuietly rescue SkipElementError => e @document.warnings << e.message end
process()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 45 def process extract_attributes_and_properties parse_and_apply end
Protected Instance Methods
add_call(name, *arguments)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 92 def add_call(name, *arguments) @calls << [name.to_s, arguments, []] end
add_call_and_enter(name, *arguments)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 96 def add_call_and_enter(name, *arguments) @calls << [name.to_s, arguments, []] @calls = @calls.last.last end
add_calls_from_element(other)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 114 def add_calls_from_element(other) @calls.concat duplicate_calls(other.base_calls) end
append_calls_to_parent()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 110 def append_calls_to_parent @parent_calls.concat(@base_calls) end
apply()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 74 def apply end
apply_calls_from_standard_attributes()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 150 def apply_calls_from_standard_attributes parse_transform_attribute_and_call parse_opacity_attributes_and_call parse_clip_path_attribute_and_call apply_colors parse_stroke_attributes_and_call apply_drawing_call end
apply_colors()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 180 def apply_colors PAINT_TYPES.each do |type| color = properties.send(type) next if [nil, 'inherit', 'none'].include?(color) if color == 'currentColor' color = computed_properties.color end results = Prawn::SVG::Color.parse(color, document.gradients) success = results.detect do |result| case result when Prawn::SVG::Color::Hex add_call "#{type}_color", result.value true when Prawn::SVG::Elements::Gradient arguments = result.gradient_arguments(self) if arguments add_call "#{type}_gradient", **arguments true end end end # If we were unable to find a suitable color candidate, # we turn off this type of paint. if success.nil? computed_properties.set(type, 'none') end end end
apply_drawing_call()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 159 def apply_drawing_call return if state.disable_drawing || !drawable? fill = computed_properties.fill != 'none' stroke = computed_properties.stroke != 'none' if fill command = stroke ? 'fill_and_stroke' : 'fill' if computed_properties.fill_rule == 'evenodd' add_call_and_enter(command, {fill_rule: :even_odd}) else add_call_and_enter(command) end elsif stroke add_call_and_enter('stroke') else add_call_and_enter('end_path') end end
bounding_box()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 77 def bounding_box end
clamp(value, min_value, max_value)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 214 def clamp(value, min_value, max_value) [[value, min_value].max, max_value].min end
container?()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 80 def container? false end
drawable?()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 84 def drawable? !container? end
extract_attributes_and_properties()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 218 def extract_attributes_and_properties if styles = document.element_styles[source] # TODO : implement !important, at the moment it's just ignored styles.each do |name, value, _important| @properties.set(name, value) end end @properties.load_hash(parse_css_declarations(source.attributes['style'] || '')) source.attributes.each do |name, value| # Properties#set returns nil if it's not a recognised property name @properties.set(name, value) or @attributes[name] = value end state.computed_properties.compute_properties(@properties) end
extract_element_from_url_id_reference(value, expected_type = nil)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 263 def extract_element_from_url_id_reference(value, expected_type = nil) matches = value.strip.match(/\Aurl\(\s*#(\S+)\s*\)\z/i) if value element = document.elements_by_id[matches[1]] if matches element if element && (expected_type.nil? || element.name == expected_type) end
new_call_context_from_base() { || ... }
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 118 def new_call_context_from_base old_calls = @calls @calls = @base_calls yield @calls = old_calls end
parse()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 71 def parse end
parse_css_declarations(declarations)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 236 def parse_css_declarations(declarations) # copied from css_parser declarations.gsub!(/(^[\s]*)|([\s]*$)/, '') output = {} declarations.split(/[\;$]+/m).each do |decs| if matches = decs.match(/\s*(.[^:]*)\s*\:\s*(.[^;]*)\s*(;|\Z)/i) property, value, _ = matches.captures output[property.downcase] = value end end output end
parse_standard_attributes()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 88 def parse_standard_attributes parse_xml_space_attribute end
pop_call_position()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 106 def pop_call_position @calls = @call_positions.pop end
process_child_elements()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 125 def process_child_elements return unless source svg_child_elements.each do |elem| if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym] add_call "save" child = element_class.new(@document, elem, @calls, state.dup) child.process add_call "restore" else @document.warnings << "Unknown tag '#{elem.name}'; ignoring" end end end
push_call_position()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 101 def push_call_position @call_positions ||= [] @call_positions << @calls end
require_attributes(*names)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 250 def require_attributes(*names) missing_attrs = names - attributes.keys if missing_attrs.any? raise MissingAttributesError, "Must have attributes #{missing_attrs.join(", ")} on tag #{name}; skipping tag" end end
require_positive_value(*args)
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 257 def require_positive_value(*args) if args.any? {|arg| arg.nil? || arg <= 0} raise SkipElementError, "Invalid attributes on tag #{name}; skipping tag" end end
svg_child_elements()
click to toggle source
# File lib/prawn/svg/elements/base.rb, line 142 def svg_child_elements source.elements.select do |elem| # To be strict, we shouldn't treat namespace-less elements as SVG, but for # backwards compatibility, and because it doesn't hurt, we will. elem.namespace == SVG_NAMESPACE || elem.namespace == '' end end