prawn-disable_word_break 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62bd33bf26599cc230f633d631c00a21a0268ac4ccbde4b50c2a7e32598824eb
-  data.tar.gz: eb787813d173984a74cc1902e4a2991a1ba3780910636eccd902aa8785abb70e
+  metadata.gz: 0ea1ad1bbcf83c99a1fb6f05a484f892700fa89ab49062295980e5c5aa4880b1
+  data.tar.gz: 8176b2596ac86a88f501afb75f86c21b5921962f287f3114ec42ddac04d18f93
 SHA512:
-  metadata.gz: ff21289a2839522110a0a4dbaeb0679844d90367149858266646723ee76e4de21e56fb7afea52e75488bfea7c575893b8cc738de337e213a76bd6305e4715df0
-  data.tar.gz: 1e688f6d3fed0f0e7b760c1745664f496be3ce6ac0a7e12c474727a5ff16b26fdb654b8854fc5e0baa5690fe64a8b4d3930e21f4617032cfd8213d2c4982e6c7
+  metadata.gz: 2fee79aa17f0d4e96bc4791a472a3ddf5fa01babcfd258093d9aa574dd8d3de6317a3b9e08dce4d88e6bbc26cb51e2880e6132fa017588568e1608aa17d7d99f
+  data.tar.gz: 044623aa23ec015bba0487cebf92e9829c036b61f2fa048210f467af92c55d04a0bed3888f9d8eee9564e37a1d359f219a718e64b90067057a171b9f9783ea78

data/.github/workflows/test.yml

@@ -1,10 +1,14 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
 
 jobs:
   test:
-    name: Test on ruby ${{ matrix.ruby_version }} and ${{ matrix.prawn_version }}
+    name: Ruby ${{ matrix.ruby_version }}
+
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -12,12 +16,6 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
-        prawn_version:
-          - '2.3'
-          - '2.4'
-        exclude:
-          - ruby_version: '3.0'
-            prawn_version: '2.3'
 
     steps:
     - uses: actions/checkout@v4
@@ -26,8 +24,7 @@ jobs:
       with:
         diff-pdf-version: '0.5'
 
-    - name: Set up Ruby ${{ matrix.ruby_version }}
-      uses: ruby/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
         bundler-cache: true

data/README.md

@@ -1,9 +1,9 @@
 # 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)
+[![Test](https://github.com/hidakatsuya/prawn-disable_word_break/actions/workflows/test.yml/badge.svg)](https://github.com/hidakatsuya/prawn-disable_word_break/actions/workflows/test.yml)
 
-Prawn::DisableWordBreak is an extension that disables word-breaking by character such as space and hyphen to [Prawn](https://github.com/prawnpdf/prawn).
+Prawn::DisableWordBreak is an extension to [Prawn](https://github.com/prawnpdf/prawn) that provides an option to disable line breaking on characters such as spaces and hyphens.
 
 ![](https://raw.githubusercontent.com/hidakatsuya/prawn-disable_word_break/master/doc/comparison-of-word-breaking.png)
 
@@ -14,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', require: false
+gem 'prawn-disable_word_break'
 ```
 
 And then execute:
@@ -31,6 +31,27 @@ Or install it yourself as:
 require 'prawn/disable_word_break'
 ```
 
+Or, you can set it for each method such as `text_box`.
+
+```ruby
+# Disable the default setting.
+Prawn::DisableWordBreak.config.default = false
+```
+
+```ruby
+Prawn::Document.generate "prawn.pdf" do
+  text_box "text",
+    at: [0, cursor], width: 150, height: 50, disable_word_break: true
+
+  formatted_text_box [{ text: "text" }],
+    at: [0, cursor], width: 150, height: 50, disable_word_break: true
+
+  bounding_box [0, cursor], width: 150, height: 50 do
+    text "text", disable_word_break: true
+  end
+end
+```
+
 ## Supported Versions
 
 ### Ruby
@@ -39,7 +60,7 @@ require 'prawn/disable_word_break'
 
 ### Prawn
 
-2.3, 2.4
+2.4
 
 ## Development
 

data/lib/prawn/disable_word_break/{line_wrap.rb → line_break_anywhere.rb}

@@ -2,7 +2,7 @@
 
 module Prawn
   module DisableWordBreak
-    class LineWrap < Text::Formatted::LineWrap
+    class LineBreakAnywhere < Text::Formatted::LineWrap
       private
 
       # Override

data/lib/prawn/disable_word_break/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module DisableWordBreak
-    VERSION = '2.1.0'
+    VERSION = '2.3.0'
   end
 end

data/lib/prawn/disable_word_break/wrap.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 
-require_relative 'line_wrap'
+require_relative 'line_break_anywhere'
 
 module Prawn
   module DisableWordBreak
     module Wrap
       # override
-      def wrap(*)
-        @line_wrap = DisableWordBreak::LineWrap.new
+      def initialize(_, options)
         super
+
+        @line_wrap = LineBreakAnywhere.new if DisableWordBreak.config.default || options[:disable_word_break]
+      end
+
+      # override
+      def valid_options
+        super + %i(disable_word_break)
       end
     end
   end

data/lib/prawn/disable_word_break.rb

@@ -1,9 +1,28 @@
 # frozen_string_literal: true
 
 require 'prawn'
+require 'forwardable'
 
 require_relative 'disable_word_break/version'
 require_relative 'disable_word_break/wrap'
 
-Prawn::Text::Box.extensions << Prawn::DisableWordBreak::Wrap
-Prawn::Text::Formatted::Box.extensions << Prawn::DisableWordBreak::Wrap
+module Prawn
+  module DisableWordBreak
+    extend Forwardable
+
+    Config = Struct.new(
+      # Sets the default value for the disable_word_break option. Default is false.
+      :default,
+
+      keyword_init: true
+    )
+
+    def self.config
+      @config ||= Config.new(default: false)
+    end
+  end
+end
+
+Prawn::DisableWordBreak::Wrap.tap do |mod|
+  Prawn::Text::Formatted::Wrap.prepend(mod) unless Prawn::Text::Formatted::Wrap.include?(mod)
+end

data/prawn-disable_word_break.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'prawn', '~> 2.3'
+  spec.add_dependency 'prawn', '>= 2.4.0'
   spec.add_runtime_dependency 'matrix', '~> 0.4'
 
   spec.add_development_dependency 'rake', '>= 0'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prawn-disable_word_break
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: matrix
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +111,7 @@ files:
 - Rakefile
 - doc/comparison-of-word-breaking.png
 - lib/prawn/disable_word_break.rb
-- lib/prawn/disable_word_break/line_wrap.rb
+- lib/prawn/disable_word_break/line_break_anywhere.rb
 - lib/prawn/disable_word_break/version.rb
 - lib/prawn/disable_word_break/wrap.rb
 - prawn-disable_word_break.gemspec