https://github.com/danini-the-panini/kql-rb

KQL (KDL Query Language) for Ruby
https://github.com/danini-the-panini/kql-rb

Last synced: 15 days ago
JSON representation

KQL (KDL Query Language) for Ruby

• Host: GitHub
• URL: https://github.com/danini-the-panini/kql-rb
• Owner: danini-the-panini
• License: mit
• Created: 2021-09-29T20:34:11.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-03T12:47:22.000Z (almost 3 years ago)
• Last Synced: 2024-12-01T18:36:50.935Z (22 days ago)
• Language: Ruby
• Size: 44.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# KQL Ruby

[KDL](https://kdl.dev) Query Language for [kdl-rb](https://github.com/danini-the-panini/kdl-rb)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'kql'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install kql

## Usage

Parse and execute a query:

```ruby

query = KQL.parse_query('a > b[foo]')

query.execute(document) #=> [#, ...]

```

Or do both at once:

```ruby

KQL.query_document(document, 'a > b[foo]') #=> [#, ...]

```

## 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/danini-the-panini/kql-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/danini-the-panini/kql-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 Kql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/danini-the-panini/kql-rb/blob/master/CODE_OF_CONDUCT.md).