Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hidakatsuya/prawn-disable_word_break
Prawn::DisableWordBreak is a Prawn extension that provides an option to disable line breaks for characters such as spaces and hyphens.
https://github.com/hidakatsuya/prawn-disable_word_break
pdf prawn ruby
Last synced: 2 months ago
JSON representation
Prawn::DisableWordBreak is a Prawn extension that provides an option to disable line breaks for characters such as spaces and hyphens.
- Host: GitHub
- URL: https://github.com/hidakatsuya/prawn-disable_word_break
- Owner: hidakatsuya
- License: mit
- Created: 2020-05-18T16:52:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T14:23:52.000Z (11 months ago)
- Last Synced: 2024-10-10T03:39:41.753Z (2 months ago)
- Topics: pdf, prawn, ruby
- Language: Ruby
- Homepage:
- Size: 4.74 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Prawn::DisableWordBreak
[](https://badge.fury.io/rb/prawn-disable_word_break)
[](https://github.com/hidakatsuya/prawn-disable_word_break/actions/workflows/test.yml)
Prawn::DisableWordBreak is a [Prawn](https://github.com/prawnpdf/prawn) extension that provides an option to disable line breaks for characters such as spaces and hyphens.
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'
```
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
3.0, 3.1, 3.2, 3.3
### Prawn
2.4
## 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
$ bundle exec rake test
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 pull ghcr.io/hidakatsuya/ruby-with-diff-pdf:latest
$ docker run -v $PWD:/src:cached -it ghcr.io/hidakatsuya/ruby-with-diff-pdf bash
> src# bundle install
> src# bundle exec rake test
### Linting
$ bundle exec rake standard
Or fix automatically.
$ bundle exec rake standard:fix
See https://github.com/standardrb/standard for more details.
## 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).