https://github.com/rubyonworld/content_spinning
ContentSpinning is a ruby library made to spin some text. It manages nested spinning.
https://github.com/rubyonworld/content_spinning
library made ruby spin
Last synced: 4 months ago
JSON representation
ContentSpinning is a ruby library made to spin some text. It manages nested spinning.
- Host: GitHub
- URL: https://github.com/rubyonworld/content_spinning
- Owner: RubyOnWorld
- License: mit
- Created: 2022-09-23T02:40:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-23T02:41:02.000Z (over 2 years ago)
- Last Synced: 2024-12-28T14:26:34.534Z (6 months ago)
- Topics: library, made, ruby, spin
- Language: Ruby
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Content Spinning
[](https://badge.fury.io/rb/content_spinning) [](https://travis-ci.org/maximeg/content_spinning)
`ContentSpinning` is a ruby library made to spin some text.
It manages nested spinning.
## Example
```ruby
"Hi {there|you}! I'm {efficient|productive}.".spin
# or
ContentSpinning.spin("Hi {there|you}! I'm {efficient|productive}.")
```
returns this array :
```ruby
[
"Hi there! I'm efficient.",
"Hi there! I'm productive.",
"Hi you! I'm efficient.",
"Hi you! I'm productive."
]
```
## Install
```
gem install content_spinning
```
## Usage
### All spins
Calculating the number of possibilities:
```ruby
> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").count
4
```
Generating:
```ruby
> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin
[
"Hi there! I'm efficient.",
"Hi there! I'm productive.",
"Hi you! I'm efficient.",
"Hi you! I'm productive."
]
```
Beware, spins being combinatory, generating all the spins could be quite long.
### Partial spins
There is no guaranty of unicity among the results returned (this is random).
If you ask for a limit greater than the number of possibilities, this returns all the possibilities.
```ruby
> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin(limit: 2)
[
"Hi there! I'm efficient.",
"Hi you! I'm productive."
]
> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin(limit: 500)
[
"Hi there! I'm efficient.",
"Hi there! I'm productive.",
"Hi you! I'm efficient.",
"Hi you! I'm productive."
]
```
## Todo
A few things to do :
* Executable