prawn-svg 0.34.1 → 0.35.0

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

@@ -10,15 +10,17 @@ module Prawn::SVG::CSS
         case token
         when Modifier
           part = token.type
-          result.last[part] ||= part == :name ? +"" : []
+          result.last[part] ||= part == :name ? +'' : []
         when Identifier
           return unless part
+
           result.last[part] << token.name
         when Attribute
-          return unless ["=", "*=", "~=", "^=", "|=", "$=", nil].include?(token.operator)
+          return unless ['=', '*=', '~=', '^=', '|=', '$=', nil].include?(token.operator)
+
           (result.last[:attribute] ||= []) << [token.key, token.operator, token.value]
         when Combinator
-          result << {combinator: token.type}
+          result << { combinator: token.type }
           part = nil
         end
       end
@@ -26,9 +28,7 @@ module Prawn::SVG::CSS
       result
     end
 
-    private
-
-    VALID_CSS_IDENTIFIER_CHAR = /[a-zA-Z0-9_\u00a0-\uffff-]/
+    VALID_CSS_IDENTIFIER_CHAR = /[a-zA-Z0-9_\u00a0-\uffff-]/.freeze
     Identifier = Struct.new(:name)
     Modifier = Struct.new(:type)
     Combinator = Struct.new(:type)
@@ -50,38 +50,38 @@ module Prawn::SVG::CSS
             if VALID_CSS_IDENTIFIER_CHAR.match(char)
               result.last.key = String.new(char)
               attribute = :key
-            elsif char != " " && char != "\t"
+            elsif char != ' ' && char != "\t"
               return
             end
 
           when :key
             if VALID_CSS_IDENTIFIER_CHAR.match(char)
               result.last.key << char
-            elsif char == "]"
+            elsif char == ']'
               attribute = nil
-            elsif "=*~^|$".include?(char)
+            elsif '=*~^|$'.include?(char)
               result.last.operator = String.new(char)
               attribute = :operator
-            elsif char == " " || char == "\t"
+            elsif [' ', "\t"].include?(char)
               attribute = :pre_operator
             else
               return
             end
 
           when :pre_operator
-            if "=*~^|$".include?(char)
+            if '=*~^|$'.include?(char)
               result.last.operator = String.new(char)
               attribute = :operator
-            elsif char != " " && char != "\t"
+            elsif char != ' ' && char != "\t"
               return
             end
 
           when :operator
-            if "=*~^|$".include?(char)
+            if '=*~^|$'.include?(char)
               result.last.operator << char
-            elsif char == " " || char == "\t"
+            elsif [' ', "\t"].include?(char)
               attribute = :pre_value
-            elsif char == '"' || char == "'"
+            elsif ['"', "'"].include?(char)
               result.last.value = +''
               attribute = String.new(char)
             else
@@ -90,16 +90,16 @@ module Prawn::SVG::CSS
             end
 
           when :pre_value
-            if char == '"' || char == "'"
+            if ['"', "'"].include?(char)
               result.last.value = +''
               attribute = String.new(char)
-            elsif char != " " && char != "\t"
+            elsif char != ' ' && char != "\t"
               result.last.value = String.new(char)
               attribute = :value
             end
 
           when :value
-            if char == "]"
+            if char == ']'
               result.last.value = String.new(result.last.value.rstrip)
               attribute = nil
             else
@@ -107,7 +107,7 @@ module Prawn::SVG::CSS
             end
 
           when '"', "'"
-            if char == "\\" && !quote
+            if char == '\\' && !quote
               quote = true
             elsif char == attribute && !quote
               attribute = :post_string
@@ -117,9 +117,9 @@ module Prawn::SVG::CSS
             end
 
           when :post_string
-            if char == "]"
+            if char == ']'
               attribute = nil
-            elsif char != " " && char != "\t"
+            elsif char != ' ' && char != "\t"
               return
             end
           end
@@ -129,37 +129,41 @@ module Prawn::SVG::CSS
           when Identifier
             result.last.name << char
           else
-            result << Modifier.new(:name) if !result.last.is_a?(Modifier)
+            result << Modifier.new(:name) unless result.last.is_a?(Modifier)
             result << Identifier.new(char)
           end
         else
           case char
-          when "."
+          when '.'
             result << Modifier.new(:class)
-          when "#"
+          when '#'
             result << Modifier.new(:id)
-          when ":"
+          when ':'
             result << Modifier.new(:pseudo_class)
-          when " ", "\t"
+          when ' ', "\t"
             result << Combinator.new(:descendant) unless result.last.is_a?(Combinator)
-          when ">"
+          when '>'
             result.pop if result.last == Combinator.new(:descendant)
             result << Combinator.new(:child)
-          when "+"
+          when '+'
             result.pop if result.last == Combinator.new(:descendant)
             result << Combinator.new(:adjacent)
-          when "~"
+          when '~'
             result.pop if result.last == Combinator.new(:descendant)
             result << Combinator.new(:siblings)
-          when "*"
+          when '*'
             return unless result.empty? || result.last.is_a?(Combinator)
+
             result << Modifier.new(:name)
-            result << Identifier.new("*")
-          when "(" # e.g. :nth-child(3n+4)
-            return unless result.last.is_a?(Identifier) && result[-2] && result[-2].is_a?(Modifier) && result[-2].type == :pseudo_class
-            result.last.name << "("
+            result << Identifier.new('*')
+          when '(' # e.g. :nth-child(3n+4)
+            unless result.last.is_a?(Identifier) && result[-2] && result[-2].is_a?(Modifier) && result[-2].type == :pseudo_class
+              return
+            end
+
+            result.last.name << '('
             brackets = true
-          when "["
+          when '['
             result << Attribute.new
             attribute = :pre_key
           else

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

@@ -1,5 +1,7 @@
 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)
@@ -9,6 +11,7 @@ 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)
@@ -16,6 +19,10 @@ 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
@@ -32,14 +39,14 @@ module Prawn::SVG::CSS
         rule_set.each_declaration { |*data| declarations << data }
 
         rule_set.selectors.each do |selector_text|
-          if selector = Prawn::SVG::CSS::SelectorParser.parse(selector_text)
-            xpath = css_selector_to_xpath(selector)
-            specificity = calculate_specificity(selector)
-            specificity << order
-            order += 1
+          next unless (selector = Prawn::SVG::CSS::SelectorParser.parse(selector_text))
 
-            xpath_styles << [xpath, declarations, specificity]
-          end
+          xpath = css_selector_to_xpath(selector)
+          specificity = calculate_specificity(selector)
+          specificity << order
+          order += 1
+
+          xpath_styles << [xpath, declarations, specificity]
         end
       end
 
@@ -59,7 +66,7 @@ module Prawn::SVG::CSS
     end
 
     def xpath_quote(value)
-      %{"#{value.gsub('\\', '\\\\').gsub('"', '\\"')}"} if value
+      %("#{value.gsub('\\', '\\\\').gsub('"', '\\"')}") if value
     end
 
     def css_selector_to_xpath(selector)
@@ -69,33 +76,33 @@ module Prawn::SVG::CSS
 
         result = case element[:combinator]
                  when :child
-                   +"/"
+                   +'/'
                  when :adjacent
                    pseudo_classes << 'first-child'
-                   +"/following-sibling::"
+                   +'/following-sibling::'
                  when :siblings
-                   +"/following-sibling::"
+                   +'/following-sibling::'
                  else
-                   +"//"
+                   +'//'
                  end
 
         positions = []
         pseudo_classes.each do |pc|
           case pc
-          when "first-child" then positions << '1'
-          when "last-child"  then positions << 'last()'
+          when 'first-child' then positions << '1'
+          when 'last-child'  then positions << 'last()'
           when /^nth-child\((\d+)\)$/ then positions << $1
           end
         end
 
-        if !positions.empty?
-          result << "*" unless require_function_name
+        unless positions.empty?
+          result << '*' unless require_function_name
           require_function_name = true
 
           logic = if positions.length == 1
                     positions.first
                   else
-                    positions.map { |position| "position()=#{position}" }.join(" and ")
+                    positions.map { |position| "position()=#{position}" }.join(' and ')
                   end
 
           result << "[#{logic}]"
@@ -114,17 +121,17 @@ module Prawn::SVG::CSS
           case operator
           when nil
             result << "[@#{key}]"
-          when "="
+          when '='
             result << "[@#{key}=#{xpath_quote value}]"
-          when "^="
+          when '^='
             result << "[starts-with(@#{key}, #{xpath_quote value})]"
-          when "$="
+          when '$='
             result << "[substring(@#{key}, string-length(@#{key}) - #{value.length - 1}) = #{xpath_quote value})]"
-          when "*="
+          when '*='
             result << "[contains(@#{key}, #{xpath_quote value})]"
-          when "~="
+          when '~='
             result << "[contains(concat(' ',@#{key},' '), #{xpath_quote " #{value} "})]"
-          when "|="
+          when '|='
             result << "[contains(concat('-',@#{key},'-'), #{xpath_quote "-#{value}-"})]"
           end
         end
@@ -138,7 +145,7 @@ module Prawn::SVG::CSS
         [
           a + (element[:id] || []).length,
           b + (element[:class] || []).length + (element[:attribute] || []).length + (element[:pseudo_class] || []).length,
-          c + (element[:name] && element[:name] != "*" ? 1 : 0)
+          c + (element[:name] && element[:name] != '*' ? 1 : 0)
         ]
       end
     end

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

@@ -0,0 +1,68 @@
+module Prawn::SVG::CSS
+  class ValuesParser
+    class << self
+      def parse(values)
+        result = []
+
+        while values
+          value, remainder = parse_next(values)
+          break unless value
+
+          result << value
+          values = remainder
+        end
+
+        result
+      end
+
+      private
+
+      def parse_next(values)
+        values = values.strip
+        return if values.empty?
+
+        if (matches = values.match(/\A([a-z-]+)\(\s*(.+)/i))
+          parse_function_call(matches[1].downcase, matches[2])
+        else
+          values.split(/\s+/, 2)
+        end
+      end
+
+      # Note this does not support space-separated arguments.
+      # I don't think CSS 2 has any, but in case it does here is the place to add them.
+      def parse_function_call(name, rest)
+        arguments = []
+        in_quote = nil
+        in_escape = false
+        current = +''
+
+        rest.each_char.with_index do |char, index|
+          if in_escape
+            current << char
+            in_escape = false
+          elsif %w[" '].include?(char)
+            if in_quote == char
+              in_quote = nil
+            elsif in_quote.nil?
+              in_quote = char
+            else
+              current << char
+            end
+          elsif char == '\\'
+            in_escape = true
+          elsif in_quote.nil? && char == ','
+            arguments << current.strip
+            current = +''
+          elsif in_quote.nil? && char == ')'
+            arguments << current.strip
+            return [[name, arguments], rest[index + 1..]]
+          else
+            current << char
+          end
+        end
+
+        [rest, nil]
+      end
+    end
+  end
+end

data/lib/prawn/svg/document.rb

@@ -2,7 +2,7 @@ class Prawn::SVG::Document
   Error = Class.new(StandardError)
   InvalidSVGData = Class.new(Error)
 
-  DEFAULT_FALLBACK_FONT_NAME = "Times-Roman"
+  DEFAULT_FALLBACK_FONT_NAME = 'Times-Roman'.freeze
 
   # An +Array+ of warnings that occurred while parsing the SVG data.
   attr_reader :warnings
@@ -20,10 +20,11 @@ class Prawn::SVG::Document
     @root = REXML::Document.new(data).root
 
     if @root.nil?
-      if data.respond_to?(:end_with?) && data.end_with?(".svg")
-        raise InvalidSVGData, "The data supplied is not a valid SVG document.  It looks like you've supplied a filename instead; use IO.read(filename) to get the data before you pass it to prawn-svg."
+      if data.respond_to?(:end_with?) && data.end_with?('.svg')
+        raise InvalidSVGData,
+          "The data supplied is not a valid SVG document.  It looks like you've supplied a filename instead; use IO.read(filename) to get the data before you pass it to prawn-svg."
       else
-        raise InvalidSVGData, "The data supplied is not a valid SVG document."
+        raise InvalidSVGData, 'The data supplied is not a valid SVG document.'
       end
     end
 
@@ -65,7 +66,7 @@ class Prawn::SVG::Document
     when nil, :rgb then :rgb
     when :cmyk then :cmyk
     else
-      raise ArgumentError, ":color_mode must be set to :rgb (default) or :cmyk"
+      raise ArgumentError, ':color_mode must be set to :rgb (default) or :cmyk'
     end
   end
 end

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

@@ -13,9 +13,9 @@ class Prawn::SVG::Elements::Base
 
   include Prawn::SVG::TransformParser
 
-  PAINT_TYPES = %w(fill stroke)
+  PAINT_TYPES = %w[fill stroke].freeze
   COMMA_WSP_REGEXP = Prawn::SVG::Elements::COMMA_WSP_REGEXP
-  SVG_NAMESPACE = "http://www.w3.org/2000/svg"
+  SVG_NAMESPACE = 'http://www.w3.org/2000/svg'.freeze
 
   SkipElementQuietly = Class.new(StandardError)
   SkipElementError = Class.new(StandardError)
@@ -37,7 +37,7 @@ class Prawn::SVG::Elements::Base
     @properties = Prawn::SVG::Properties.new
 
     if source && !state.inside_use
-      id = source.attributes["id"]
+      id = source.attributes['id']
       id = id.strip if id
 
       document.elements_by_id[id] = self if id && id != ''
@@ -65,19 +65,16 @@ class Prawn::SVG::Elements::Base
   end
 
   def name
-    @name ||= source ? source.name : "???"
+    @name ||= source ? source.name : '???'
   end
 
   protected
 
-  def parse
-  end
+  def parse; end
 
-  def apply
-  end
+  def apply; end
 
-  def bounding_box
-  end
+  def bounding_box; end
 
   def container?
     false
@@ -128,13 +125,13 @@ class Prawn::SVG::Elements::Base
     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"
+      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"
+        add_call 'restore'
       else
         @document.warnings << "Unknown tag '#{elem.name}'; ignoring"
       end
@@ -185,9 +182,7 @@ class Prawn::SVG::Elements::Base
 
       next if [nil, 'inherit', 'none'].include?(color)
 
-      if color == 'currentColor'
-        color = computed_properties.color
-      end
+      color = computed_properties.color if color == 'currentColor'
 
       results = Prawn::SVG::Color.parse(color, document.gradients, document.color_mode)
 
@@ -207,18 +202,12 @@ class Prawn::SVG::Elements::Base
 
       # 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
+      computed_properties.set(type, 'none') if success.nil?
     end
   end
 
-  def clamp(value, min_value, max_value)
-    [[value, min_value].max, max_value].min
-  end
-
   def extract_attributes_and_properties
-    if styles = document.element_styles[source]
+    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)
@@ -238,11 +227,11 @@ class Prawn::SVG::Elements::Base
   def parse_css_declarations(declarations)
     # copied from css_parser
     declarations
-      .gsub(/(^[\s]*)|([\s]*$)/, '')
-      .split(/[\;$]+/m)
+      .gsub(/(^\s*)|(\s*$)/, '')
+      .split(/[;$]+/m)
       .each_with_object({}) do |decs, output|
-        if matches = decs.match(/\s*(.[^:]*)\s*\:\s*(.[^;]*)\s*(;|\Z)/i)
-          property, value, _ = matches.captures
+        if (matches = decs.match(/\s*(.[^:]*)\s*:\s*(.[^;]*)\s*(;|\Z)/i))
+          property, value, = matches.captures
           output[property.downcase] = value
         end
       end
@@ -251,23 +240,39 @@ class Prawn::SVG::Elements::Base
   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"
+      raise MissingAttributesError, "Must have attributes #{missing_attrs.join(', ')} on tag #{name}; skipping tag"
     end
   end
 
   def require_positive_value(*args)
-    if args.any? {|arg| arg.nil? || arg <= 0}
+    if args.any? { |arg| arg.nil? || arg <= 0 }
       raise SkipElementError, "Invalid attributes on tag #{name}; skipping tag"
     end
   end
 
-  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)
+  def extract_element_from_url_id_reference(values, expected_type = nil)
+    Prawn::SVG::CSS::ValuesParser.parse(values).detect do |value|
+      case value
+      in ['url', [url]]
+        element = document.elements_by_id[url[1..]] if url.start_with?('#')
+        break element if element && (expected_type.nil? || element.name == expected_type)
+      else
+        nil
+      end
+    end
   end
 
   def href_attribute
     attributes['xlink:href'] || attributes['href']
   end
+
+  def overflow_hidden?
+    ['hidden', 'scroll'].include?(computed_properties.overflow)
+  end
+
+  def clone_element_source(source)
+    new_source = source.dup
+    document.element_styles[new_source] = document.element_styles[source]
+    new_source
+  end
 end

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

@@ -4,8 +4,8 @@ class Prawn::SVG::Elements::Circle < Prawn::SVG::Elements::Base
   def parse
     require_attributes 'r'
 
-    @x = x(attributes['cx'] || "0")
-    @y = y(attributes['cy'] || "0")
+    @x = x(attributes['cx'] || '0')
+    @y = y(attributes['cy'] || '0')
     @r = pixels(attributes['r'])
 
     require_positive_value @r
@@ -13,9 +13,9 @@ class Prawn::SVG::Elements::Circle < Prawn::SVG::Elements::Base
 
   def apply
     if USE_NEW_CIRCLE_CALL
-      add_call "circle", [@x, @y], @r
+      add_call 'circle', [@x, @y], @r
     else
-      add_call "circle_at", [@x, @y], radius: @r
+      add_call 'circle_at', [@x, @y], radius: @r
     end
   end
 

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

@@ -9,4 +9,3 @@ class Prawn::SVG::Elements::ClipPath < Prawn::SVG::Elements::Base
     true
   end
 end
-

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

@@ -13,7 +13,7 @@ class Prawn::SVG::Elements::DepthFirstBase < Prawn::SVG::Elements::Base
   end
 
   def parse_and_apply
-    raise "unsupported"
+    raise 'unsupported'
   end
 
   protected
@@ -36,11 +36,11 @@ class Prawn::SVG::Elements::DepthFirstBase < Prawn::SVG::Elements::Base
     return unless source
 
     svg_child_elements.each do |elem|
-      if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym]
-        child = element_class.new(@document, elem, @calls, state.dup)
-        child.parse_step
-        @children << child
-      end
+      next unless (element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym])
+
+      child = element_class.new(@document, elem, @calls, state.dup)
+      child.parse_step
+      @children << child
     end
   end
 

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

@@ -4,8 +4,8 @@ class Prawn::SVG::Elements::Ellipse < Prawn::SVG::Elements::Base
   def parse
     require_attributes 'rx', 'ry'
 
-    @x = x(attributes['cx'] || "0")
-    @y = y(attributes['cy'] || "0")
+    @x = x(attributes['cx'] || '0')
+    @y = y(attributes['cy'] || '0')
     @rx = x_pixels(attributes['rx'])
     @ry = y_pixels(attributes['ry'])
 
@@ -13,11 +13,10 @@ class Prawn::SVG::Elements::Ellipse < Prawn::SVG::Elements::Base
   end
 
   def apply
-    add_call USE_NEW_ELLIPSE_CALL ? "ellipse" : "ellipse_at", [@x, @y], @rx, @ry
+    add_call USE_NEW_ELLIPSE_CALL ? 'ellipse' : 'ellipse_at', [@x, @y], @rx, @ry
   end
 
   def bounding_box
     [@x - @rx, @y + @ry, @x + @rx, @y - @ry]
   end
 end
-