Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amake/srx-languagetool-ruby
SRX segmentation rules from LanguageTool, for Ruby
https://github.com/amake/srx-languagetool-ruby
languagetool ruby segmentation srx
Last synced: 2 months ago
JSON representation
SRX segmentation rules from LanguageTool, for Ruby
- Host: GitHub
- URL: https://github.com/amake/srx-languagetool-ruby
- Owner: amake
- License: lgpl-2.1
- Created: 2021-02-13T13:38:03.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T23:01:31.000Z (3 months ago)
- Last Synced: 2024-09-27T23:18:09.270Z (3 months ago)
- Topics: languagetool, ruby, segmentation, srx
- Language: Ruby
- Homepage: https://rubygems.org/gems/srx-languagetool
- Size: 177 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# LanguageTool SRX for Ruby
This gem provides SRX segmentation rules from
[LanguageTool](https://languagetool.org/). It is a companion to
[srx-ruby](https://github.com/amake/srx-ruby), which implements an SRX engine to
apply these rules for segmenting text.
For details, please see [srx-ruby](https://github.com/amake/srx-ruby).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'srx-languagetool'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install srx-languagetool
## Usage
For detailed usage information about the engine, please see
[srx-ruby](https://github.com/amake/srx-ruby).
```ruby
require 'srx/languagetool'
data = Srx::Data.languagetool
engine = Srx::Engine.new(data)
engine.segment('Hi. How are you?', language: 'en') #=> ["Hi.", " How are you?"]
```
**Note:** To split on single line breaks, append the suffix `_one` to the
language. To split only on two or more consecutive line breaks, append `_two`.
```ruby
engine.segment("Hi. \n\n\nHow are you?", language: 'en')
#=> ["Hi. \n\n\nHow are you?"]
engine.segment('Hi. \n\n\nHow are you?', language: 'en_one')
#=> ["Hi. \n", "\n", "\n", "How are you?"]
engine.segment('Hi. \n\n\nHow are you?', language: 'en_two')
#=> ["Hi. \n\n\n", "How are you?"]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake test` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.
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 the created tag, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/amake/srx-languagetool.
## License
The gem is available as open source under the terms of the [GNU Lesser General
Public License, version 2.1](https://opensource.org/licenses/LGPL-2.1).