Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kairichard/zq
Unixy building blocks in ruby
https://github.com/kairichard/zq
composer concept orchestra ruby unix
Last synced: 8 days ago
JSON representation
Unixy building blocks in ruby
- Host: GitHub
- URL: https://github.com/kairichard/zq
- Owner: kairichard
- Created: 2014-03-09T18:34:21.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-02-28T18:38:47.000Z (almost 5 years ago)
- Last Synced: 2024-12-14T17:08:10.769Z (about 1 month ago)
- Topics: composer, concept, orchestra, ruby, unix
- Language: Ruby
- Homepage:
- Size: 89.8 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ZQ - Unixy building blocks in ruby
========
[](https://travis-ci.org/kairichard/zq) [](https://badge.fury.io/rb/zq) [](https://gemnasium.com/kairichard/zq) [](https://coveralls.io/r/kairichard/zq?branch=master)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkairichard%2Fzq?ref=badge_shield)
This started as a simple proof of concept and looked kinda promising.
The hole concept is centered around an Orchestra which has a `source` where it can
read chunks of data from. The data is than passed through chainable `composers`.
The source and the composers just need to implement a certain method each in order to work.
#### Examples-Orchestras
This is how the Echo-Orchestra looks like
```ruby
class Echo
include ZQ::Orchestra
source ZQ::Sources::IOSource.new $stdin
compose_with ZQ::Composer::Echo.new
desc 'prints contents from stdin'
end
```
Thats fairly verbose to just implement a `PIPE`. But consider the following
```ruby
equire 'redis'
require 'zq'
CLIENT = Redis.new(db: 1)
class RedisPull
include ZQ::Orchestra
source ZQ::Sources::RedisLPOP.new(CLIENT, "incoming")
compose_with ZQ::Composer::Echo.new
desc "reads from redis:key:'incoming' and prints to stdout"
end
```
Here we print items from a redis list. Checkout the examples directory for more.
Also check the lib/source and lib/composers directory and mix and match your tool
###### Synopsis
```bash
zq [--file=]
# or
Commands:
zq help [COMMAND] # Describe available commands or one specific command
zq list # List available orchestras.
zq play ORCHESTRA_NAME # Start orchestrating.
Options:
-r, [--file=FILE] # Require file to load orchestras from
---
Usage:
zq play ORCHESTRA_NAME
Options:
-d, [--forever], [--no-forever] # Keep running even if source is exhausted
-i, [--interval=N] # Play orchestra every N seconds
# Default: 0
-r, [--file=FILE] # Require file to load orchestras from
Start orchestrating.
```
Installing
-------------
ZQ comes as a gem, so given you have ruby installed simply do the following
```bash
> gem install zq
```
## Contributing Code
If you want to contribute code, please try to:
* Follow the same coding style as used in the project. Pay attention to the
usage of tabs, spaces, newlines and brackets. Try to copy the aesthetics the
best you can.
* Add a scenario under `features` that verifies your change (test with `rake features`). Look at the existing test
suite to get an idea for the kind of tests I like. If you do not provide a
test, explain why.
* Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
explain what your patch does, and why it is needed.
* Keep it simple: Any patch that changes a lot of code or is difficult to
understand should be discussed before you put in the effort.
Once you have tried the above, create a GitHub pull request to notify me of your
changes.
##TODO
* add more sources and composers
* better error handling for transactions
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkairichard%2Fzq?ref=badge_large)