prawn-svg 0.36.2 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2b791daa33f85948c08bdafec3f1a3ab8dffa8b07dd50ce7bb7a55320d663b
-  data.tar.gz: 78e45c7790de4b1cf2d328ad6ec8bbb77bab707cdeb8e75fcf52055410f36fc4
+  metadata.gz: d9d63836ebf08ec1ebd6320b61a8f4b93c5df29e91e6e1397b53c65d548e8afe
+  data.tar.gz: 25ad6658329c42589d086e592589908a1c556a631503578219c308ab095fa513
 SHA512:
-  metadata.gz: da875e08d850fd7d3b74d9e5a629d4f3125bc933614e0d241ddd4c5122ad75495d6b530c01914ad0bc44dbcbdec41ee5e35196e008c484652bbb99ecb0e66e53
-  data.tar.gz: 79f54a51c1acdea4a5d5de5bb72f130b5ca692aed48c72ceb36aced4f16df223be1a81f1152164dbdf3452571b79a676df96a4c38ba825afeedd32748e4f3919
+  metadata.gz: d73e5adc3fa832d2ed9159cf02cea3b47cf3923ff0e145af4de426effeb6157d4d133d600bf708ccd963a736d517fccb8a7c8d410ee479025288193659d34859
+  data.tar.gz: 20d5d9f28438c3ca4c23454541f763b1766f3df9719ced30a3451abc08e21913cf4276d2c148d9af695bab9e4670b01dcc1985fe5d9a9ebd94cfc08cee755818

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prawn-svg (0.36.2)
+    prawn-svg (0.38.0)
       css_parser (~> 1.6)
       matrix (~> 0.4.2)
       prawn (>= 0.11.1, < 3)

data/README.md

@@ -114,9 +114,9 @@ prawn-svg supports CSS, both in `<style>` blocks and `style` attributes.
 In CSS selectors you can use element names, IDs, classes, attributes (existence, `=`, `^=`, `$=`, `*=`, `~=`, `|=`)
 and all combinators (` `, `>`, `+`, `~`).
 The pseudo-classes `:first-child`, `:last-child` and `:nth-child(n)` (where n is a number) also work.
+`!important` is supported.
 
-Pseudo-elements and the other pseudo-classes are not supported.  Specificity ordering is
-implemented, but `!important` is not.
+Pseudo-elements and the other pseudo-classes are not supported.
 
 ## Not supported
 

data/lib/prawn/svg/attributes/transform.rb

@@ -1,5 +1,7 @@
 module Prawn::SVG::Attributes::Transform
   def parse_transform_attribute_and_call
+    # Some elements do not support transforms
+    return unless transformable?
     return unless (transform = attributes['transform'])
 
     matrix = matrix_for_pdf(parse_transform_attribute(transform))

data/lib/prawn/svg/css/stylesheets.rb

@@ -1,7 +1,5 @@
 module Prawn::SVG::CSS
   class Stylesheets
-    USER_AGENT_STYLESHEET = 'svg, symbol, image, marker, pattern, foreignObject { overflow: hidden }'.freeze
-
     attr_reader :css_parser, :root, :media
 
     def initialize(css_parser, root, media = :all)
@@ -11,7 +9,6 @@ module Prawn::SVG::CSS
     end
 
     def load
-      load_user_agent_stylesheet
       load_style_elements
       xpath_styles = gather_xpath_styles
       associate_xpath_styles_with_elements(xpath_styles)
@@ -19,10 +16,6 @@ module Prawn::SVG::CSS
 
     private
 
-    def load_user_agent_stylesheet
-      css_parser.add_block!(USER_AGENT_STYLESHEET)
-    end
-
     def load_style_elements
       REXML::XPath.match(root, '//style').each do |source|
         data = source.texts.map(&:value).join

data/lib/prawn/svg/elements/base.rb

@@ -36,7 +36,7 @@ class Prawn::SVG::Elements::Base
     @attributes = {}
     @properties = Prawn::SVG::Properties.new
 
-    if source && !state.inside_use
+    if source && add_to_elements_by_id? && !state.inside_use
       id = source.attributes['id']
       id = id.strip if id
 
@@ -114,6 +114,10 @@ class Prawn::SVG::Elements::Base
     @calls.concat duplicate_calls(other.base_calls)
   end
 
+  def add_yield_call(&block)
+    add_call('svg:yield', block)
+  end
+
   def new_call_context_from_base
     old_calls = @calls
     @calls = @base_calls
@@ -142,7 +146,7 @@ class Prawn::SVG::Elements::Base
     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 == ''
+      [SVG_NAMESPACE, ''].include?(elem.namespace)
     end
   end
 
@@ -203,20 +207,27 @@ class Prawn::SVG::Elements::Base
   end
 
   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
+    # Apply user agent stylesheet
+    if %w[svg symbol image marker pattern foreignObject].include?(source.name)
+      @properties.set('overflow', 'hidden')
     end
 
-    @properties.load_hash(parse_css_declarations(source.attributes['style'] || ''))
-
+    # Apply presentation attributes, and set attributes that aren't presentation attributes
     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
 
+    # Apply stylesheet styles
+    if (styles = document.element_styles[source])
+      styles.each do |name, value, important|
+        @properties.set(name, value, important: important)
+      end
+    end
+
+    # Apply inline styles
+    @properties.load_hash(parse_css_declarations(source.attributes['style'] || ''))
+
     state.computed_properties.compute_properties(@properties)
   end
 
@@ -262,6 +273,14 @@ class Prawn::SVG::Elements::Base
     ['hidden', 'scroll'].include?(computed_properties.overflow)
   end
 
+  def transformable?
+    true
+  end
+
+  def add_to_elements_by_id?
+    true
+  end
+
   def stroke_width
     if computed_properties.stroke.none?
       0

data/lib/prawn/svg/elements/direct_render_base.rb

@@ -0,0 +1,27 @@
+#
+# This element base class is used for elements that render directly to the Prawn canvas.
+#
+# Initially when I wrote prawn-svg, I was expecting to have multiple renderers and thought separating the codebase
+# from the Prawn renderer would be a good idea.  However, it turns out that the Prawn renderer was the only one
+# that was targeted, and it ended up being tightly coupled with the Prawn library.
+#
+# This class is probably how I should have written it.  Direct render is required to do text rendering properly
+# because we need to know the width of all the things we print.  As of the time of this comment it's the only
+# system that uses DirectRenderBase in prawn-svg.
+#
+class Prawn::SVG::Elements::DirectRenderBase < Prawn::SVG::Elements::Base
+  # Called by Renderer when it finds the svg:render call added below.
+  def render(prawn, renderer); end
+
+  protected
+
+  def parse_and_apply
+    parse_standard_attributes
+    parse
+    apply_calls_from_standard_attributes
+    @parent_calls << ['svg:render', [self], [], []] unless computed_properties.display == 'none'
+  rescue SkipElementQuietly
+  rescue SkipElementError => e
+    @document.warnings << e.message
+  end
+end

data/lib/prawn/svg/elements/polygon.rb

@@ -16,9 +16,9 @@ class Prawn::SVG::Elements::Polygon < Prawn::SVG::Elements::Base
   def commands
     @commands ||= [
       Prawn::SVG::Pathable::Move.new(@points[0])
-    ] + @points[1..].map { |point|
+    ] + @points[1..].map do |point|
       Prawn::SVG::Pathable::Line.new(point)
-    } + [
+    end + [
       Prawn::SVG::Pathable::Close.new(@points[0])
     ]
   end

data/lib/prawn/svg/elements/text.rb

@@ -1,70 +1,72 @@
-class Prawn::SVG::Elements::Text < Prawn::SVG::Elements::DepthFirstBase
-  private
+module Prawn::SVG
+  class Elements::Text < Elements::DirectRenderBase
+    Cursor = Struct.new(:x, :y)
 
-  # This class doesn't represent an element in the SVG document; it's here
-  # to hold together text information.  Because of this, we overload the
-  # parse_step and apply_step methods, and bypass all the normal processing
-  # of the element, delegating it to our root text component.
+    def parse
+      @root_component = Elements::TextComponent.new(document, source, [], state.dup)
+      @root_component.process
 
-  def parse_step
-    state.text = Prawn::SVG::Elements::TextComponent::TextState.new
+      reintroduce_trailing_and_leading_whitespace
+    end
 
-    @text_root = Prawn::SVG::Elements::TextComponent.new(document, source, nil, state.dup)
-    @text_root.parse_step
+    def render(prawn, renderer)
+      @root_component.lay_out(prawn)
 
-    reintroduce_trailing_and_leading_whitespace
-  end
+      translate_x =
+        case @root_component.computed_properties.text_anchor
+        when 'middle'
+          -@root_component.calculated_width / 2.0
+        when 'end'
+          -@root_component.calculated_width
+        end
 
-  def apply_step(calls)
-    @base_calls = @calls = calls
-    add_call_and_enter 'text_group'
-    @text_root.apply_step(@calls)
-  end
+      cursor = Cursor.new(0, document.sizing.output_height)
+      @root_component.render_component(prawn, renderer, cursor, translate_x)
+    end
 
-  def drawable?
-    false
-  end
+    private
 
-  def reintroduce_trailing_and_leading_whitespace
-    printables = []
-    built_printable_queue(printables, @text_root)
+    def reintroduce_trailing_and_leading_whitespace
+      text_nodes = []
+      build_text_node_queue(text_nodes, @root_component)
 
-    remove_whitespace_only_printables_and_start_and_end(printables)
-    remove_printables_that_are_completely_empty(printables)
-    apportion_leading_and_trailing_spaces(printables)
-  end
+      remove_whitespace_only_text_nodes_and_start_and_end(text_nodes)
+      remove_text_nodes_that_are_completely_empty(text_nodes)
+      apportion_leading_and_trailing_spaces(text_nodes)
+    end
 
-  def built_printable_queue(queue, component)
-    component.commands.each do |command|
-      case command
-      when Prawn::SVG::Elements::TextComponent::Printable
-        queue << command
-      else
-        built_printable_queue(queue, command)
+    def build_text_node_queue(queue, component)
+      component.children.each do |element|
+        case element
+        when Elements::TextNode
+          queue << element
+        else
+          build_text_node_queue(queue, element)
+        end
       end
     end
-  end
 
-  def remove_whitespace_only_printables_and_start_and_end(printables)
-    printables.pop   while printables.last  && printables.last.text.empty?
-    printables.shift while printables.first && printables.first.text.empty?
-  end
+    def remove_whitespace_only_text_nodes_and_start_and_end(text_nodes)
+      text_nodes.pop   while text_nodes.last  && text_nodes.last.text.empty?
+      text_nodes.shift while text_nodes.first && text_nodes.first.text.empty?
+    end
 
-  def remove_printables_that_are_completely_empty(printables)
-    printables.reject! do |printable|
-      printable.text.empty? && !printable.trailing_space? && !printable.leading_space?
+    def remove_text_nodes_that_are_completely_empty(text_nodes)
+      text_nodes.reject! do |text_node|
+        text_node.text.empty? && !text_node.trailing_space? && !text_node.leading_space?
+      end
     end
-  end
 
-  def apportion_leading_and_trailing_spaces(printables)
-    printables.each_cons(2) do |a, b|
-      if a.text.empty?
-        # Empty strings can only get a leading space from the previous non-empty text,
-        # and never get a trailing space
-      elsif a.trailing_space?
-        a.text += ' '
-      elsif b.leading_space?
-        b.text = " #{b.text}"
+    def apportion_leading_and_trailing_spaces(text_nodes)
+      text_nodes.each_cons(2) do |a, b|
+        if a.text.empty?
+          # Empty strings can only get a leading space from the previous non-empty text,
+          # and never get a trailing space
+        elsif a.trailing_space?
+          a.text += ' '
+        elsif b.leading_space?
+          b.text = " #{b.text}"
+        end
       end
     end
   end