prawn-disable_word_break 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8364a4f45b68738bbc7312b486e8ed741885232bd7a17c96ce71309186e30df
+  data.tar.gz: e5394bb7d4f2a39365a8bca5a8cbdbf37027ef024e340a9aa6aed0bd69eca84f
+SHA512:
+  metadata.gz: 2427b82f590702adba462958e0cff8ea203d382100fea7d281a8efc4826b0a8ad169146a367674f9e0a91a5f288494937e4c94156830a3d3ac769d99fc17241e
+  data.tar.gz: a3bb8bf3b97ecf0588b71d6690e6e04415bbe5f233771b3fb2a0c4a4fdd62066ade574e0949fc2ec68095c40928cdd2d421625dd4ac96f52b3d82bd48ec2ea70

data/.github/FUNDING.yml

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

data/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.4.x
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
+    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
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/test/features/tmp/*.pdf

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hidakatsuya@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.7.1
+
+RUN apt-get update -qq && apt-get install -y build-essential xvfb
+
+# Install diff-pdf
+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
+
+WORKDIR /prawn-disable_word_break
+VOLUME /prawn-disable_word_break

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Katsuya HIDAKA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Prawn::DisableWordBreak
+
+[![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).
+
+![](doc/comparison-of-word-breaking.png)
+
+See [feature test](test/features/text_line_wrapping_test.rb) for details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prawn-disable_word_break'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install prawn-disable_word_break
+
+## Usage
+
+```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
+
+### Prawn
+
+2.2+
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### 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:
+
+    $ docker build -t prawn-disable_word_break-dev .
+    $ docker run -v $PWD:/prawn-disable_word_break:cached -it prawn-disable_word_break-dev bash
+
+    > /prawn-disable_word_break#
+    > /prawn-disable_word_break# bundle install
+    > /prawn-disable_word_break# bundle exec rake test:features
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/prawn-disable_word_break. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hidakatsuya/prawn-disable_word_wrap/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+(c) 2020 Katsuya HIDAKA. The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). See [LICENSE.txt](https://github.com/hidakatsuya/prawn-disable_word_break/blob/master/LICENSE.txt) for further details.
+
+## Code of Conduct
+
+Everyone interacting in the Prawn::DisableWordBreak project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hidakatsuya/prawn-disable_word_break/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+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 )

data/lib/prawn/disable_word_break.rb

@@ -0,0 +1,12 @@
+require 'prawn'
+
+require_relative 'disable_word_break/version'
+require_relative 'disable_word_break/disabler'
+require_relative 'disable_word_break/formatted_box'
+
+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)
+}

data/lib/prawn/disable_word_break/disabler.rb

@@ -0,0 +1,26 @@
+# 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

data/lib/prawn/disable_word_break/formatted_box.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'line_wrap'
+
+module Prawn
+  module DisableWordBreak
+    module FormattedBox
+      def initialize(*)
+        super
+        @line_wrap = DisableWordBreak::LineWrap.new
+      end
+    end
+  end
+end

data/lib/prawn/disable_word_break/line_wrap.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Prawn
+  module DisableWordBreak
+    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
+      end
+
+      def insert_fragment_without_word_break(fragment)
+        fragment = delete_invisible_chars(fragment)
+        fragment_width = @document.width_of(fragment, kerning: @kerning)
+
+        if @accumulated_width + fragment_width <= @width
+          @accumulated_width += fragment_width
+          @fragment_output += fragment
+          fragment_finished(fragment)
+          true
+        else
+          end_of_the_line_reached(fragment)
+          fragment_finished(fragment)
+          false
+        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
+
+        invisible_chars = [
+          soft_hyphen(encoding),
+          zero_width_space(encoding)
+        ].join
+        fragment.delete(invisible_chars)
+      end
+    end
+  end
+end

data/lib/prawn/disable_word_break/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Prawn
+  module DisableWordBreak
+    VERSION = '1.0.0'
+  end
+end

data/prawn-disable_word_break.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/prawn/disable_word_break/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prawn-disable_word_break'
+  spec.version       = Prawn::DisableWordBreak::VERSION
+  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.homepage      = 'https://github.com/hidakatsuya/prawn-disable_word_break'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.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'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: prawn-disable_word_break
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katsuya Hidaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  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
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- 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
+- prawn-disable_word_break.gemspec
+homepage: https://github.com/hidakatsuya/prawn-disable_word_break
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Adds a method to disable word-breaking by character such as space and hyphen
+test_files: []