Add overflow_wrap to wrap lines based on its value

Author: hidakatsuya

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

@@ -25,6 +25,8 @@ def build_graphic_attributes(style, &block)
           # @yieldparam [Hash] attrs
           # @return [Hash]
           def build_text_attributes(style, &block)
+            word_wrap = word_wrap(style['word-wrap'])
+
             text_attributes = {
               font: font_family(style['font-family']),
               size: style['font-size'],
@@ -35,12 +37,32 @@ def build_text_attributes(style, &block)
               letter_spacing: letter_spacing(style['letter-spacing']),
               line_height: line_height(style['line-height']),
               overflow: text_overflow(style['overflow']),
-              word_wrap: word_wrap(style['word-wrap'])
+              word_wrap: word_wrap,
+              # Deprecated: Use overflow_wrap instead of word_wrap
+              overflow_wrap: overflow_wrap(style['overflow-wrap'], word_wrap)
             }
             block.call(text_attributes) if block_given?
             text_attributes
           end
 
+          def overflow_wrap(style, computed_word_wrap)
+            case style || migrate_overflow_wrap_from_word_wrap(computed_word_wrap)
+            when 'normal', nil then :normal
+            when 'anywhere' then :anywhere
+            # Deprecated: This is a temporary value for migrating from word_wrap.
+            when 'disable-break-word-by-space' then :disable_break_word_by_space
+            else :normal
+            end
+          end
+
+          def migrate_overflow_wrap_from_word_wrap(computed_word_wrap)
+            case computed_word_wrap
+            when :none then 'disable-break-word-by-space'
+            when :break_word then 'normal'
+            else raise ArgumentError, 'Invalid computed word_wrap value'
+            end
+          end
+
           # @param [Array<String>] font_names
           # @return [String]
           def font_family(font_names)

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

@@ -23,6 +23,7 @@ module Graphics
           # @option attrs [Boolean] :single (false)
           # @option attrs [:trancate, :shrink_to_fit, :expand] :overflow (:trancate)
           # @option attrs [:none, :break_word] :word_wrap (:none)
+          # @option attrs [:normal, :anywhere, :disable_break_word_by_space] :overflow_wrap (:normal)
           def text_box(content, x, y, w, h, attrs = {}, &block)
             w, h = s2f(w, h)
 
@@ -32,8 +33,7 @@ def text_box(content, x, y, w, h, attrs = {}, &block)
               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
+            content = replace_space_to_nbsp(content) if attrs[:overflow_wrap] == :disable_break_word_by_space
 
             with_text_styles(attrs) do |built_attrs, font_styles|
               if block
@@ -112,6 +112,12 @@ def with_text_styles(attrs, &block)
             spacing = attrs.delete(:letter_spacing)
             attrs[:character_spacing] = s2f(spacing) if spacing
 
+            # Disable line breaking on chars such as spaces and hyphens
+            attrs[:disable_word_break] = true if attrs.delete(:overflow_wrap) == :anywhere
+
+            # Delete unnecessary attributes
+            attrs.delete(:word_wrap)
+
             # Or... with_font_styles(attrs, fontinfo, &block)
             with_font_styles(attrs, fontinfo) do |modified_attrs, styles|
               block.call(modified_attrs, styles)
@@ -131,7 +137,7 @@ def text_line_leading(line_height, font)
 
           # @param [String] content
           # @return [String]
-          def text_without_line_wrap(content)
+          def replace_space_to_nbsp(content)
             content.gsub(/ /, Prawn::Text::NBSP)
           end
 

test/basic_report/units/generator/pdf/document/graphics/test_attributes.rb

@@ -32,7 +32,7 @@ def test_build_graphic_attributes
   end
 
   def test_build_text_attributes
-    text_styles = {
+    text_styles_without_overflow_wrap = {
       'font-family' => %w( Helvetica IPAMincho ),
       'font-size' => 18.0,
       'color' => 'red',
@@ -44,7 +44,26 @@ def test_build_text_attributes
       'overflow' => 'expand',
       'word-wrap' => 'break-word'
     }
+    assert_equal(
+      {
+        font: 'Helvetica',
+        size: 18.0,
+        color: 'red',
+        align: :right,
+        valign: :bottom,
+        styles: [:bold, :italic],
+        letter_spacing: 2.0,
+        line_height: 20.0,
+        overflow: :expand,
+        word_wrap: :break_word,
+        overflow_wrap: :normal
+      },
+      @pdf.build_text_attributes(text_styles_without_overflow_wrap)
+    )
 
+    text_styles_with_overflow_wrap = text_styles_without_overflow_wrap.merge(
+      'overflow-wrap' => 'anywhere'
+    )
     assert_equal(
       {
         font: 'Helvetica',
@@ -56,12 +75,15 @@ def test_build_text_attributes
         letter_spacing: 2.0,
         line_height: 20.0,
         overflow: :expand,
-        word_wrap: :break_word
+        word_wrap: :break_word,
+        overflow_wrap: :anywhere
       },
-      @pdf.build_text_attributes(text_styles)
+      @pdf.build_text_attributes(text_styles_with_overflow_wrap)
     )
 
-    customized_attributes = @pdf.build_text_attributes(text_styles) { |attrs| attrs[:color] = 'blue' }
+    customized_attributes = @pdf.build_text_attributes(text_styles_without_overflow_wrap) { |attrs|
+      attrs[:color] = 'blue'
+    }
     assert_equal 'blue', customized_attributes[:color]
   end
 
@@ -132,4 +154,25 @@ def test_image_position_y
     assert_equal :top, @pdf.image_position_y('')
     assert_equal :top, @pdf.image_position_y(nil)
   end
+
+  def test_overflow_wrap
+    assert_equal :anywhere, @pdf.overflow_wrap('anywhere', :none)
+    assert_equal :disable_break_word_by_space, @pdf.overflow_wrap('disable-break-word-by-space', :break_word)
+    assert_equal :normal, @pdf.overflow_wrap('normal', :none)
+
+    # When value is unexpected value
+    assert_equal :normal, @pdf.overflow_wrap('', :none)
+  end
+
+  def text_overflow_wrap_fallback_to_word_wrap
+    # word_wrap: none fallbacks to :disable_break_word_by_space
+    assert_equal :disable_break_word_by_space, @pdf.overflow_wrap(nil, :none)
+    # word_wrap: break_word fallbacks to :normal
+    assert_equal :normal, @pdf.overflow_wrap(nil, :break_word)
+  end
+
+  def test_migrate_overflow_wrap_from_word_wrap
+    assert_equal 'normal', @pdf.migrate_overflow_wrap_from_word_wrap(:break_word)
+    assert_equal 'disable-break-word-by-space', @pdf.migrate_overflow_wrap_from_word_wrap(:none)
+  end
 end

test/basic_report/units/generator/pdf/document/graphics/test_text.rb

@@ -118,8 +118,8 @@ def test_text_line_leading_should_return_a_specified_leading_value_minus_the_fon
     assert_equal @pdf.send(:text_line_leading, 100, font), 100 - font_height
   end
 
-  def test_text_without_line_wrap_should_replace_the_spaces_NBSP
-    assert_equal @pdf.send(:text_without_line_wrap, ' ' * 2), Prawn::Text::NBSP * 2
+  def test_replace_space_to_nbsp_should_replace_the_spaces_NBSP
+    assert_equal @pdf.send(:replace_space_to_nbsp, ' ' * 2), Prawn::Text::NBSP * 2
   end
 
   def test_text_box_should_not_raise_PrawnCannotFitError