thinreports 0.7.6 → 0.8.0

data/lib/thinreports/generator/pdf/document/font.rb

@@ -1,75 +1,84 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
-    # @private
+
     module PDF::Font
-      FONT_STORE = File.join(ThinReports::ROOTDIR, 'resources', 'fonts')
-      
+      FONT_STORE = File.join(Thinreports::ROOT, 'fonts')
+
       BUILTIN_FONTS = {
-        'IPAMincho'  => {:normal => File.join(FONT_STORE, 'ipam.ttf')},
-        'IPAPMincho' => {:normal => File.join(FONT_STORE, 'ipamp.ttf')},
-        'IPAGothic'  => {:normal => File.join(FONT_STORE, 'ipag.ttf')},
-        'IPAPGothic' => {:normal => File.join(FONT_STORE, 'ipagp.ttf')}
+        'IPAMincho'  => { normal: File.join(FONT_STORE, 'ipam.ttf') },
+        'IPAPMincho' => { normal: File.join(FONT_STORE, 'ipamp.ttf') },
+        'IPAGothic'  => { normal: File.join(FONT_STORE, 'ipag.ttf') },
+        'IPAPGothic' => { normal: File.join(FONT_STORE, 'ipagp.ttf') }
+      }
+
+      DEFAULT_FALLBACK_FONTS = %w( Helvetica IPAMincho )
+
+      PRAWN_BUINTIN_FONT_ARIASES = {
+        'Courier New' => 'Courier',
+        'Times New Roman' => 'Times-Roman'
       }
-      
-    private
-      
+
       def setup_fonts
         # Install built-in fonts.
         pdf.font_families.update(BUILTIN_FONTS)
-        
+
+        # Create aliases from the font list provided by Prawn.
+        PRAWN_BUINTIN_FONT_ARIASES.each do |alias_name, name|
+          pdf.font_families[alias_name] = pdf.font_families[name]
+        end
+
+        # Setup custom fallback fonts
         fallback_fonts = []
-        
-        # Install EUDC fonts.
-        ThinReports.config.generator.pdf.eudc_fonts.each_with_index do |eudc, i|
-          eudc_name = "EUDC#{i}"
-          install_font_family(eudc_name, eudc)
-          fallback_fonts << eudc_name
+        # For compatible to v0.7 or less
+        fallback_fonts |= Thinreports.config.generator.pdf.eudc_fonts
+        fallback_fonts |= Thinreports.config.fallback_fonts
+        fallback_fonts.uniq!
+
+        fallback_fonts.map!.with_index do |font, i|
+          unless pdf.font_families.key?(font)
+            install_font "Custom-fallback-font#{i}", font
+          else
+            font
+          end
         end
-        
-        # Install fall-back font(default font) that IPAMincho.
-        install_font_family('DefaultFont', BUILTIN_FONTS['IPAMincho'][:normal])
-        fallback_fonts << 'DefaultFont'
-        
-        # Setup fallback fonts.
-        pdf.fallback_fonts(fallback_fonts)
-        
-        # Create aliases from the font list provided by Prawn.
-        pdf.font_families.update(
-          'Courier New'     => pdf.font_families['Courier'],
-          'Times New Roman' => pdf.font_families['Times-Roman']
-        )
+
+        # Set fallback fonts
+        pdf.fallback_fonts(fallback_fonts + DEFAULT_FALLBACK_FONTS)
       end
-      
+
       # @param [String] name
       # @param [String] file
-      def install_font_family(name, file)
-        pdf.font_families[name] = {:normal      => file,
-                                   :bold        => file,
-                                   :italic      => file,
-                                   :bold_italic => file}
+      # @return [String] installed font name
+      def install_font(name, file)
+        raise Errors::FontFileNotFound unless File.exists?(file)
+
+        pdf.font_families[name] = {normal: file,
+                                   bold: file,
+                                   italic: file,
+                                   bold_italic: file}
+        name
       end
-      
+
       # @return [String]
       def default_family
         'Helvetica'
       end
-      
+
       # @param [String] family
       # @return [String]
       def default_family_if_missing(family)
         pdf.font_families.key?(family) ? family : default_family
       end
-      
+
       # @param [String] font
       # @param [Symbol] style
       # @return [Boolean]
       def font_has_style?(font, style)
         (f = pdf.font_families[font]) && f.key?(style)
-      end      
+      end
     end
-    
+
   end
-end
+end

data/lib/thinreports/generator/pdf/document/graphics/attributes.rb

@@ -1,23 +1,23 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     module PDF::Graphics
       # @param [Hash] svg_attrs
       # @yield [attrs]
       # @yieldparam [Hash] attrs
       # @return [Hash]
       def common_graphic_attrs(svg_attrs, &block)
-        attrs = {:stroke       => svg_attrs['stroke'],
-                 :stroke_width => svg_attrs['stroke-width'],
-                 :fill         => svg_attrs['fill']}
-        
+        attrs = {stroke: svg_attrs['stroke'],
+                 stroke_width: svg_attrs['stroke-width'],
+                 fill: svg_attrs['fill']}
+
         # Set 0 to stroke_width if stroke_opacity is '0'.
         if svg_attrs['stroke-opacity'] == '0'
           attrs[:stroke_width] = 0
         end
-        
+
         # Setting for stroke dash.
         if (dash = svg_attrs['stroke-dasharray']) && dash != 'none'
           attrs[:stroke_dash] = dash.split(',')
@@ -25,40 +25,40 @@ module ThinReports
         block.call(attrs) if block_given?
         attrs
       end
-      
+
       # @param [Hash] svg_attrs
       # @yield [attrs]
       # @yieldparam [Hash] attrs
       # @return [Hash]
       def common_text_attrs(svg_attrs, &block)
-        attrs = {:font   => default_family_if_missing(svg_attrs['font-family']),
-                 :size   => svg_attrs['font-size'],
-                 :color  => svg_attrs['fill'],
-                 :align  => text_align(svg_attrs['text-anchor']),
-                 :styles => font_styles(svg_attrs)}
-        
+        attrs = {font: default_family_if_missing(svg_attrs['font-family']),
+                 size: svg_attrs['font-size'],
+                 color: svg_attrs['fill'],
+                 align: text_align(svg_attrs['text-anchor']),
+                 styles: font_styles(svg_attrs)}
+
         # The Letter Spacing Property.
-        # 
+        #
         # When the version of Layout is
-        #   smaller then 0.6.0: 
+        #   smaller then 0.6.0:
         #     Use letter-spacing attribute (normal is none).
         #   0.6.0 or more:
         #     Use kerning attribute (auto is none).
-        # 
+        #
         if space = text_letter_spacing(svg_attrs['kerning'] || svg_attrs['letter-spacing'])
           attrs[:letter_spacing] = space
         end
         block.call(attrs) if block_given?
         attrs
       end
-      
+
       # @param [Hash] svg_attrs
       # @return [Array<Symbol>]
       def font_styles(svg_attrs)
         styles = []
         styles << :bold   if svg_attrs['font-weight'] == 'bold'
         styles << :italic if svg_attrs['font-style'] == 'italic'
-        
+
         if (deco = svg_attrs['text-decoration']) && deco != 'none'
           deco = deco.split(' ')
           styles << :underline     if deco.include?('underline')
@@ -66,13 +66,13 @@ module ThinReports
         end
         styles
       end
-      
+
       # @param [String] space
       # @return [String, nil]
       def text_letter_spacing(space)
         %w( normal auto ).include?(space) ? nil : space
       end
-      
+
       # @param [String] svg_align
       # @return [Symbol]
       def text_align(svg_align)
@@ -83,7 +83,7 @@ module ThinReports
         else :left
         end
       end
-      
+
       # @param [String] svg_valign
       # @return [Symbol]
       def text_valign(svg_valign)
@@ -94,7 +94,7 @@ module ThinReports
         else :top
         end
       end
-      
+
       # @param [String] overflow
       # @return [Symbol]
       def text_overflow(overflow)
@@ -105,13 +105,22 @@ module ThinReports
         else :truncate
         end
       end
-        
+
+      # @param [String] word_wrap
+      # @return [Symbol]
+      def text_word_wrap(word_wrap)
+        case word_wrap
+        when 'break-word' then :break_word
+        else :none
+        end
+      end
+
       # @param [String] xlink
       # @return [String]
       def extract_base64_string(xlink)
         xlink.sub(%r{^data:image/[a-z]+?;base64,}, '')
       end
     end
-    
+
   end
 end

data/lib/thinreports/generator/pdf/document/graphics/basic.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     module PDF::Graphics
       # @param [Numeric, String] x1
       # @param [Numeric, String] y1
@@ -17,7 +17,7 @@ module ThinReports
           pdf.line(pos(x1, y1), pos(x2, y2))
         end
       end
-      
+
       # @param [Numeric, String] x
       # @param [Numeric, String] y
       # @param [Numeric, String] w width
@@ -31,7 +31,7 @@ module ThinReports
       def rect(x, y, w, h, attrs = {})
         w, h   = s2f(w, h)
         radius = s2f(attrs[:radius])
-        
+
         with_graphic_styles(attrs) do
           if radius && !radius.zero?
             pdf.rounded_rectangle(pos(x, y), w, h, radius)
@@ -40,7 +40,7 @@ module ThinReports
           end
         end
       end
-      
+
       # @param [Numeric, String] x center-x
       # @param [Numeric, String] y center-y
       # @param [Numeric, String] rx
@@ -52,30 +52,30 @@ module ThinReports
       # @option attrs [String] :fill
       def ellipse(x, y, rx, ry, attrs = {})
         rx, ry = s2f(rx, ry)
-        
+
         with_graphic_styles(attrs) do
           pdf.ellipse(pos(x, y), rx, ry)
         end
       end
-      
+
     private
-      
+
       # @param [Hash] attrs
       def with_graphic_styles(attrs, &block)
         stroke = build_stroke_styles(attrs)
         fill   = build_fill_styles(attrs)
-        
+
         # Do not draw if no colors given.
         return unless fill || stroke
-        
+
         save_graphics_state
 
         # Apply stroke-dashed.
         if stroke && stroke[:dash]
           length, space = stroke[:dash]
-          pdf.dash(length, :space => space)
+          pdf.dash(length, space: space)
         end
-        
+
         case
         # Draw with fill and stroke.
         when fill && stroke
@@ -99,34 +99,34 @@ module ThinReports
             block.call
           }
         end
-        
+
         restore_graphics_state
-      end      
-      
+      end
+
       # @param [Hash] styles
       # @return [Hash, nil]
       def build_stroke_styles(styles)
         color = styles[:stroke]
         width = styles[:stroke_width]
-        
+
         if color && color != 'none' && width && width != 0
-          {:color => parse_color(color),
-           :width => s2f(width),
-           :dash  => s2f(*styles[:stroke_dash])}
+          {color: parse_color(color),
+           width: s2f(width),
+           dash: s2f(*styles[:stroke_dash])}
         end
       end
-      
+
       # @param [Hash] styles
       # @return [Hash, nil]
       def build_fill_styles(styles)
         color = styles[:fill]
-        
+
         if color && color != 'none'
-          {:color => parse_color(color)}
+          {color: parse_color(color)}
         end
-      end      
-      
+      end
+
     end
-    
+
   end
 end

data/lib/thinreports/generator/pdf/document/graphics/image.rb

@@ -3,9 +3,9 @@
 require 'tempfile'
 require 'base64'
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     module PDF::Graphics
       # @param [String] filename
       # @param [Numeric, Strng] x
@@ -14,9 +14,9 @@ module ThinReports
       # @param [Numeric, Strng] h
       def image(filename, x, y, w, h)
         w, h = s2f(w, h)
-        pdf.image(filename, :at => pos(x, y), :width  => w, :height => h)
+        pdf.image(filename, at: pos(x, y), width: w, height: h)
       end
-      
+
       # @param [String] base64
       # @param [Numeric, Strng] x
       # @param [Numeric, Strng] y
@@ -26,7 +26,7 @@ module ThinReports
         image = create_temp_imagefile(base64)
         image(image.path, x, y, w, h)
       end
-      
+
       # @param file (see Prawn#image)
       # @param [Numeric, Strng] x
       # @param [Numeric, Strng] y
@@ -37,23 +37,23 @@ module ThinReports
       # @option options [:top, :center, :bottom] :position_y (:top)
       def image_box(file, x, y, w, h, options = {})
         w, h = s2f(w, h)
-        pdf.bounding_box(pos(x, y), :width => w, :height => h) do
-          pdf.image(file, :position  => options[:position_x] || :left,
-                          :vposition => options[:position_y] || :top,
-                          :auto_fit  => [w, h])
+        pdf.bounding_box(pos(x, y), width: w, height: h) do
+          pdf.image(file, position: options[:position_x] || :left,
+                          vposition: options[:position_y] || :top,
+                          auto_fit: [w, h])
         end
       end
-      
+
     private
-      
+
       def clean_temp_images
         temp_image_registry.each {|tmp| tmp.unlink }
       end
-      
+
       def temp_image_registry
         @temp_image_registry ||= []
       end
-      
+
       # @param [String] base64
       # @return [Tempfile]
       def create_temp_imagefile(base64)
@@ -64,8 +64,8 @@ module ThinReports
         file
       ensure
         file.close
-      end      
+      end
     end
-    
+
   end
 end

data/lib/thinreports/generator/pdf/document/graphics/text.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 
-module ThinReports
+module Thinreports
   module Generator
-    
+
     module PDF::Graphics
       # @param [String] content
       # @param [Numeric, String] x
@@ -21,32 +21,34 @@ module ThinReports
       # @option attrs [Numeric, String] :letter_spacing
       # @option attrs [Boolean] :single (false)
       # @option attrs [:trancate, :shrink_to_fit, :expand] :overflow (:trancate)
+      # @option attrs [:none, :break_word] :word_wrap (:none)
       def text_box(content, x, y, w, h, attrs = {})
         w, h = s2f(w, h)
-        box_attrs = text_box_attrs(x, y, w, h, :single   => attrs.delete(:single), 
-                                               :overflow => attrs[:overflow])
-        
+        box_attrs = text_box_attrs(x, y, w, h, single: attrs.delete(:single),
+                                               overflow: attrs[:overflow])
+        # Do not break by word unless :word_wrap is :break_word
+        content = text_without_line_wrap(content) if attrs[:word_wrap] == :none
+
         with_text_styles(attrs) do |built_attrs, font_styles|
-          pdf.formatted_text_box([{:text   => text_without_line_wrap(content),
-                                   :styles => font_styles}],
-                                 built_attrs.merge(box_attrs))
+          pdf.formatted_text_box([{ text: content, styles: font_styles }],
+            built_attrs.merge(box_attrs))
         end
       rescue Prawn::Errors::CannotFit => e
         # Nothing to do.
-        # 
+        #
         # When the area is too small compared
         # with the content and the style of the text.
         #   (See prawn/core/text/formatted/line_wrap.rb#L185)
       end
-      
+
       # @see #text_box
       def text(content, x, y, w, h, attrs = {})
         # Set the :overflow property to :shirink_to_fit.
-        text_box(content, x, y, w, h, {:overflow => :shrink_to_fit}.merge(attrs))
+        text_box(content, x, y, w, h, { overflow: :shirink_to_fit }.merge(attrs))
       end
-      
+
     private
-      
+
       # @param x (see #text_box)
       # @param y (see #text_box)
       # @param w (see #text_box)
@@ -56,15 +58,15 @@ module ThinReports
       # @option states [Symbold] :overflow
       # @return [Hash]
       def text_box_attrs(x, y, w, h, states = {})
-        attrs = {:at    => pos(x, y),
-                 :width => s2f(w)}
+        attrs = {at: pos(x, y),
+                 width: s2f(w)}
         if states[:single]
-          states[:overflow] != :expand ? attrs.merge(:single_line => true) : attrs
+          states[:overflow] != :expand ? attrs.merge(single_line: true) : attrs
         else
-          attrs.merge(:height => s2f(h))
+          attrs.merge(height: s2f(h))
         end
       end
-      
+
       # @param attrs (see #text)
       # @yield [built_attrs, font_styles]
       # @yieldparam [Hash] built_attrs The finalized attributes.
@@ -72,48 +74,48 @@ module ThinReports
       def with_text_styles(attrs, &block)
         # When no color is given, do not draw.
         return unless attrs.key?(:color) && attrs[:color] != 'none'
-        
+
         save_graphics_state
-        
-        fontinfo = {:name  => attrs.delete(:font).to_s,
-                    :color => parse_color(attrs.delete(:color)),
-                    :size  => s2f(attrs.delete(:size))}
-        
+
+        fontinfo = {name: attrs.delete(:font).to_s,
+                    color: parse_color(attrs.delete(:color)),
+                    size: s2f(attrs.delete(:size))}
+
         # Add the specified value to :leading option.
         if line_height = attrs.delete(:line_height)
           attrs[:leading] = text_line_leading(s2f(line_height),
-                                              :name => fontinfo[:name],
-                                              :size => fontinfo[:size])
+                                              name: fontinfo[:name],
+                                              size: fontinfo[:size])
         end
-        
+
         # Set the :character_spacing option.
         if space = attrs.delete(:letter_spacing)
           attrs[:character_spacing] = s2f(space)
         end
-        
+
         # Or... with_font_styles(attrs, fontinfo, &block)
         with_font_styles(attrs, fontinfo) do |modified_attrs, styles|
           block.call(modified_attrs, styles)
         end
-        
+
         restore_graphics_state
       end
-      
+
       # @param [Numeric] line_height
       # @param [Hash] font
       # @option font [String] :name Name of font.
       # @option font [Numeric] :size Size of font.
       # @return [Numeric]
       def text_line_leading(line_height, font)
-        line_height - pdf.font(font[:name], :size => font[:size]).height
+        line_height - pdf.font(font[:name], size: font[:size]).height
       end
-      
+
       # @param [String] content
       # @return [String]
       def text_without_line_wrap(content)
         content.gsub(/ /, Prawn::Text::NBSP)
       end
-      
+
       # @param [Hash] attrs
       # @param [Hash] font
       # @option font [String] :color
@@ -129,29 +131,29 @@ module ThinReports
             [:bold, :italic].include?(style) && !font_has_style?(font[:name], style)
           end
         end
-        
+
         # Emulate bold style.
         if manual && manual.include?(:bold)
           pdf.stroke_color(font[:color])
           pdf.line_width(font[:size] * 0.025)
-          
+
           # Change rendering mode to :fill_stroke.
           attrs[:mode] = :fill_stroke
         end
-        
+
         # Emulate italic style.
         if manual && manual.include?(:italic)
           # FIXME
           # pdf.transformation_matrix(1, 0, 0.26, 1, 0, 0)
         end
-        
-        pdf.font(font[:name], :size => font[:size]) do
+
+        pdf.font(font[:name], size: font[:size]) do
           pdf.fill_color(font[:color])
           block.call(attrs, styles || [])
         end
-      end      
-      
+      end
+
     end
-    
+
   end
 end