prawn-disable_word_break 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8364a4f45b68738bbc7312b486e8ed741885232bd7a17c96ce71309186e30df
-  data.tar.gz: e5394bb7d4f2a39365a8bca5a8cbdbf37027ef024e340a9aa6aed0bd69eca84f
+  metadata.gz: bba3067f6b8890dfb47cf0e4495b033ce771971a0800f0873ed2f1edaf872a0e
+  data.tar.gz: a6e5cf2ef7f57d66b4f3edd8ebb3ffa73b1078ba3a0dc429ea3f7327d0f68fe2
 SHA512:
-  metadata.gz: 2427b82f590702adba462958e0cff8ea203d382100fea7d281a8efc4826b0a8ad169146a367674f9e0a91a5f288494937e4c94156830a3d3ac769d99fc17241e
-  data.tar.gz: a3bb8bf3b97ecf0588b71d6690e6e04415bbe5f233771b3fb2a0c4a4fdd62066ade574e0949fc2ec68095c40928cdd2d421625dd4ac96f52b3d82bd48ec2ea70
+  metadata.gz: ca2b9e2759bbf4ae1b1cf2ee18e60434c444f60bdd4104a22659e414859738034958a1c3181d1cb0e244da4154501bf6bf55b2ab8da0bb198e625df3871c42de
+  data.tar.gz: 10ca0137d172f48cbab43e01992cce09d2d571a30bcb1554fc744cc7785b98e2cb004e524dd36648dcf4c76dde223cc3ab2f47533fcc093de0a28037e5ec709e

data/.github/workflows/test.yml

@@ -4,30 +4,37 @@ on: [push, pull_request]
 
 jobs:
   test:
-    name: Test on ruby ${{ matrix.ruby_version }}
+    name: Test on ruby ${{ matrix.ruby_version }} and ${{ matrix.prawn_version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby_version:
-          - 2.4.x
-          - 2.5.x
-          - 2.6.x
-          - 2.7.x
+          - 2.6
+          - 2.7
+          - 3.0
+        prawn_version:
+          - 2.3
+          - 2.4
+        exclude:
+          - ruby_version: 3.0
+            prawn_version: 2.3
+
     steps:
     - uses: actions/checkout@v1
-    - name: Set up diff-pdf
-      run: |
-        sudo apt-get update
-        sudo apt-get install make automake g++ libpoppler-glib-dev poppler-utils libwxgtk3.0-dev
-        git clone https://github.com/vslavik/diff-pdf.git -b v0.3 --depth 1 /tmp/diff-pdf-src
-        cd /tmp/diff-pdf-src
-        ./bootstrap && ./configure && make && sudo make install
+
+    - uses: hidakatsuya/setup-diff-pdf@v1
+      with:
+        diff-pdf-version: 0.5
+
     - name: Set up Ruby ${{ matrix.ruby_version }}
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
-    - name: Build and test with Rake
+
+    - name: Install dependencies
       run: |
         gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake test
+        bundle install --gemfile test/gemfiles/prawn-${{ matrix.prawn_version }}.gemfile --jobs 4 --retry 3
+
+    - name: Run tests
+      run: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Main (Unreleased)
+
+## 2.0.0
+
+### Breaking Changes
+
+- Disable word break globally when required
+- Removed `#disable_word_break` and `#word_break`
+- Drop ruby 2.4, 2.5 support
+- Drop prawn 2.2 support

data/Dockerfile

@@ -6,7 +6,7 @@ RUN apt-get update -qq && apt-get install -y build-essential xvfb
 WORKDIR /tmp
 RUN apt-get install -y libpoppler-glib-dev poppler-utils libwxgtk3.0-dev && curl -L https://github.com/vslavik/diff-pdf/archive/master.tar.gz -o diff-pdf-master.tar.gz && tar zxf diff-pdf-master.tar.gz && cd diff-pdf-master && ./bootstrap && ./configure && make && make install
 
-RUN mkdir /prawn-disable_word_break
+RUN mkdir /src
 
-WORKDIR /prawn-disable_word_break
-VOLUME /prawn-disable_word_break
+WORKDIR /src
+VOLUME /src

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'rake', '>= 0'
-gem 'test-unit', '>= 3.3.5'
-gem 'test-unit-rr', '>= 1.0.5'

data/README.md

@@ -1,10 +1,11 @@
 # Prawn::DisableWordBreak
 
+[![Gem Version](https://badge.fury.io/rb/prawn-disable_word_break.svg)](https://badge.fury.io/rb/prawn-disable_word_break)
 [![Test](https://github.com/hidakatsuya/prawn-disable_word_break/workflows/Test/badge.svg?branch=master)](https://github.com/hidakatsuya/prawn-disable_word_break/actions)
 
-Prawn::DisableWordBreak is an extension that adds a method to disable word-breaking by character such as space and hyphen to [Prawn](https://github.com/prawnpdf/prawn).
+Prawn::DisableWordBreak is an extension that disables word-breaking by character such as space and hyphen to [Prawn](https://github.com/prawnpdf/prawn).
 
-![](doc/comparison-of-word-breaking.png)
+![](https://raw.githubusercontent.com/hidakatsuya/prawn-disable_word_break/master/doc/comparison-of-word-breaking.png)
 
 See [feature test](test/features/text_line_wrapping_test.rb) for details.
 
@@ -13,7 +14,7 @@ See [feature test](test/features/text_line_wrapping_test.rb) for details.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prawn-disable_word_break'
+gem 'prawn-disable_word_break', require: false
 ```
 
 And then execute:
@@ -28,37 +29,17 @@ Or install it yourself as:
 
 ```ruby
 require 'prawn/disable_word_break'
-
-Prawn::Document.generate 'foo.pdf' do
-  disable_word_break do
-    # word-breaking is disabled here
-    text_box 'text without word-breaking', at: [100, 100], width: 50, height: 50
-  end
-
-  word_break(true) do
-    # word-breaking is disabled here
-    formatted_box [{ text: 'text without word-breaking' }], at: [100, 100], width: 50, height: 50
-  end
-
-  word_break(false) do
-    # word-breaking is disabled here
-    text_box 'text without word-breaking', at: [100, 100], width: 50, height: 50
-  end
-
-  # word-breaking is enabled here
-  formatted_box [{ text: 'text with word-breaking' }], at: [100, 100], width: 50, height: 50
-end
 ```
 
 ## Supported Versions
 
 ### Ruby
 
-2.6, 2.7
+2.6, 2.7, 3.0
 
 ### Prawn
 
-2.2+
+2.3+
 
 ## Development
 
@@ -66,25 +47,16 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Testing
 
-This project has two test types, each of which can be run with the following command:
-
-    $ bundle exec rake test:units
-    $ bundle exec rake test:features
-
-Or, both tests can be run below:
-
     $ bundle exec rake test
 
-To run `test:features`, you need [diff-pdf](https://github.com/vslavik/diff-pdf). You can run by installing it or using a Docker container for testing.
-
-Here's how to run `test:features` in the Docker container:
+To run the test, you need [diff-pdf](https://github.com/vslavik/diff-pdf). You can run by installing it or using a Docker container for testing.
 
-    $ docker build -t prawn-disable_word_break-dev .
-    $ docker run -v $PWD:/prawn-disable_word_break:cached -it prawn-disable_word_break-dev bash
+    $ docker build -t prawn-disable_word_break:latest .
+    $ docker run -v $PWD:/src:cached -it prawn-disable_word_break bash
 
-    > /prawn-disable_word_break#
-    > /prawn-disable_word_break# bundle install
-    > /prawn-disable_word_break# bundle exec rake test:features
+    > /src#
+    > /src# bundle install
+    > /src# bundle exec rake test
 
 ## Contributing
 

data/Rakefile

@@ -1,16 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new('test:units') do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/units/**/*_test.rb']
-end
-
 Rake::TestTask.new('test:features') do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/features/**/*_test.rb']
 end
 
-task test: %i( test:units test:features )
+task test: %i( test:features )

data/lib/prawn/disable_word_break.rb

@@ -1,12 +1,9 @@
+# frozen_string_literal: true
+
 require 'prawn'
 
 require_relative 'disable_word_break/version'
-require_relative 'disable_word_break/disabler'
-require_relative 'disable_word_break/formatted_box'
+require_relative 'disable_word_break/wrap'
 
-Prawn::DisableWordBreak::Disabler.tap { |mod|
-  Prawn::Document.include mod unless Prawn::Document.include?(mod)
-}
-Prawn::DisableWordBreak::FormattedBox.tap { |mod|
-  Prawn::Text::Formatted::Box.prepend mod unless Prawn::Text::Formatted::Box.include?(mod)
-}
+Prawn::Text::Box.extensions << Prawn::DisableWordBreak::Wrap
+Prawn::Text::Formatted::Box.extensions << Prawn::DisableWordBreak::Wrap

data/lib/prawn/disable_word_break/line_wrap.rb

@@ -5,28 +5,11 @@ module Prawn
     class LineWrap < Text::Formatted::LineWrap
       private
 
-      attr_reader :word_break_disabled
-
-      # Override
-      def initialize_line(options)
-        super
-        @word_break_disabled = @document.word_break_disabled?
-      end
-
       # Override
       def add_fragment_to_line(fragment)
-        if fragment == ''
-          true
-        elsif fragment == "\n"
-          @newline_encountered = true
-          false
-        else
-          if word_break_disabled
-            insert_fragment_without_word_break(fragment)
-          else
-            insert_fragment_with_word_break(fragment)
-          end
-        end
+        return super(fragment) if fragment == '' || fragment == "\n"
+
+        insert_fragment_without_word_break(fragment)
       end
 
       def insert_fragment_without_word_break(fragment)
@@ -45,36 +28,6 @@ module Prawn
         end
       end
 
-      def insert_fragment_with_word_break(fragment)
-        tokenize(fragment).each do |segment|
-          segment_width = if segment == zero_width_space(segment.encoding)
-                            0
-                          else
-                            @document.width_of(segment, kerning: @kerning)
-                          end
-
-          if @accumulated_width + segment_width <= @width
-            @accumulated_width += segment_width
-            shy = soft_hyphen(segment.encoding)
-            if segment[-1] == shy
-              sh_width = @document.width_of(shy, kerning: @kerning)
-              @accumulated_width -= sh_width
-            end
-            @fragment_output += segment
-          else
-            if @accumulated_width.zero? && @line_contains_more_than_one_word
-              @line_contains_more_than_one_word = false
-            end
-            end_of_the_line_reached(segment)
-            fragment_finished(fragment)
-            return false
-          end
-        end
-
-        fragment_finished(fragment)
-        true
-      end
-
       def delete_invisible_chars(fragment)
         encoding = fragment.encoding
 

data/lib/prawn/disable_word_break/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module DisableWordBreak
-    VERSION = '1.0.0'
+    VERSION = '2.0.0'
   end
 end

data/lib/prawn/disable_word_break/{formatted_box.rb → wrap.rb}

@@ -4,10 +4,11 @@ require_relative 'line_wrap'
 
 module Prawn
   module DisableWordBreak
-    module FormattedBox
-      def initialize(*)
-        super
+    module Wrap
+      # override
+      def wrap(*)
         @line_wrap = DisableWordBreak::LineWrap.new
+        super
       end
     end
   end

data/prawn-disable_word_break.gemspec

@@ -6,16 +6,20 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Katsuya Hidaka']
   spec.email         = ['hidakatsuya@gmail.com']
 
-  spec.summary       = 'Adds a method to disable word-breaking by character such as space and hyphen'
-  spec.description   = 'Prawn::DisableWordBreak is an extension for Prawn that adds a method to disable word-breaking by character such as space and hyphen to Prawn'
+  spec.summary       = 'Disables word-breaking by character such as space and hyphen'
+  spec.description   = 'Prawn::DisableWordBreak is an extension for Prawn that disables word-breaking by character such as space and hyphen.'
   spec.homepage      = 'https://github.com/hidakatsuya/prawn-disable_word_break'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'prawn', '~> 2.2'
+  spec.add_dependency 'prawn', '~> 2.3'
+  spec.add_development_dependency 'rake', '>= 0'
+  spec.add_development_dependency 'test-unit', '>= 3.3.5'
+  spec.add_development_dependency 'test-unit-rr', '>= 1.0.5'
+  spec.add_development_dependency 'pdf_matcher-testing', '>= 1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-disable_word_break
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Katsuya Hidaka
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -16,25 +16,81 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-description: Prawn::DisableWordBreak is an extension for Prawn that adds a method
-  to disable word-breaking by character such as space and hyphen to Prawn
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: pdf_matcher-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Prawn::DisableWordBreak is an extension for Prawn that disables word-breaking
+  by character such as space and hyphen.
 email:
 - hidakatsuya@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -43,16 +99,15 @@ files:
 - Rakefile
 - doc/comparison-of-word-breaking.png
 - lib/prawn/disable_word_break.rb
-- lib/prawn/disable_word_break/disabler.rb
-- lib/prawn/disable_word_break/formatted_box.rb
 - lib/prawn/disable_word_break/line_wrap.rb
 - lib/prawn/disable_word_break/version.rb
+- lib/prawn/disable_word_break/wrap.rb
 - prawn-disable_word_break.gemspec
 homepage: https://github.com/hidakatsuya/prawn-disable_word_break
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,15 +115,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: Adds a method to disable word-breaking by character such as space and hyphen
+summary: Disables word-breaking by character such as space and hyphen
 test_files: []

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: [hidakatsuya]

data/lib/prawn/disable_word_break/disabler.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Prawn
-  module DisableWordBreak
-    module Disabler
-      def word_break(disable, &block)
-        if disable
-          disable_word_break(&block)
-        else
-          block.call
-        end
-      end
-
-      def disable_word_break
-        @word_break_disabled = true
-        yield
-      ensure
-        @word_break_disabled = false
-      end
-
-      def word_break_disabled?
-        defined?(@word_break_disabled) ? @word_break_disabled : false
-      end
-    end
-  end
-end