Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drbragg/cooklang_rb
A Cooklang parser in Ruby
https://github.com/drbragg/cooklang_rb
cooklang parser ruby
Last synced: 3 months ago
JSON representation
A Cooklang parser in Ruby
- Host: GitHub
- URL: https://github.com/drbragg/cooklang_rb
- Owner: DRBragg
- License: mit
- Created: 2022-04-01T15:01:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T19:17:41.000Z (over 1 year ago)
- Last Synced: 2024-10-04T08:41:20.185Z (4 months ago)
- Topics: cooklang, parser, ruby
- Language: Ruby
- Homepage:
- Size: 22.5 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CooklangRb
[](https://badge.fury.io/rb/cooklang_rb)
[](https://github.com/DRBragg/cooklang_rb/actions/workflows/main.yml)
A Ruby parser for [Cooklang](https://cooklang.org/).
If you're unfamiliar with [Cooklang](https://cooklang.org/), please visit [https://cooklang.org/](https://cooklang.org/) to learn more about using Cooklang.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cooklang_rb'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install cooklang_rb
## Usage
```ruby
source = <> source: https://www.dinneratthezoo.com/wprm_print/6796
>> total time: 6 minutes
>> servings: 2
Place the @apple juice{1,5%cups}, @banana{one sliced}, @frozen mixed berries{1,5%cups} and @vanilla greek yogurt{3/4%cup} in a #blender{}; blend until smooth. If the smoothie seems too thick, add a little more liquid (1/4 cup).
Taste and add @honey{} if desired. Pour into two glasses and garnish with fresh berries and mint sprigs if desired.
EOF
recipe = CooklangRb::Recipe.new(source)
pp recipe.data
# {
# "metadata"=> {...},
# "steps"=> [
# [...],
# [...]
# ]
# }
pp recipe.metadata
# {
# "source"=>"https://www.dinneratthezoo.com/wprm_print/6796",
# "total time"=>"6 minutes",
# "servings"=>"2"
# }
pp recipe.steps
# [
# [
# {
# "type"=>"text",
# "value"=>"Place the "
# },
# {
# "type"=>"ingredient",
# "name"=>"apple juice",
# "quantity"=>"1,5",
# "units"=>"cups"
# },
# {
# "type"=>"text",
# "value"=>", "
# },
# ...
# ],
# [
# {
# "type"=>"text",
# "value"=>"Taste and add "
# },
# ...
# ]
# ]
```
Please visit the [Cooklang Docs](https://cooklang.org/docs) for more information about the Cooklang specification. Including parser impementations in other languages
## 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.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/drbragg/cooklang_rb. 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/drbragg/cooklang_rb/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the CooklangRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drbragg/cooklang_rb/blob/master/CODE_OF_CONDUCT.md).