Skip to content
A query language for Gherkin
Branch: master
Clone or download
Latest commit 4c0b264 Apr 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Bump gem version Apr 20, 2019
testing
.cucumberproignore Filtering test files from documentation Jun 24, 2017
.gitignore
.simplecov
.travis.yml Be more flexible with Bundler Apr 17, 2019
CHANGELOG.md Update CHANGELOG Apr 20, 2019
Gemfile
LICENSE.txt Update copyright notice Apr 18, 2019
README.md
Rakefile Clean up Rake tasks Apr 17, 2019
appveyor.yml
cacert.pem Fix for recursively finding all files Oct 1, 2012
cql.gemspec
todo.txt

README.md

Basic stuff: Gem Version Project License Downloads

User stuff: Cucumber Docs Yard Docs

Developer stuff: Build Status Build status Coverage Status Maintainability Inline docs


CQL (Cucumber Query Language)

CQL is a domain specific language used for querying a Cucumber (or other Gherkin based) test suite. It is written in Ruby and powered by the cuke_modeler gem. The goal of CQL is to increase the ease with which useful information can be extracted from a modeled test suite and turned into summarized data or reports.

Some uses for example are:

  • Build systems
  • Reporting

Quick Start

  • Install the gem

Use the following command:

gem install cql

Alternatively you can add it to your Gemfile if you are using bundler.

  • Create a new ruby file and require the gem

      require 'cql'
    
  • Start querying things!

The first thing that needs to be done is to create a CQL Repository. This can be done with the following line:

require 'cql'
cql_repo = CQL::Repository.new "/path-to/my/feature-files"

Repositories can also be created from an existing model:

directory = CukeModeler::Directory.new("/path-to/my/feature-files")
cql_repo = CQL::Repository.new(directory)

Now that you have a repository you can write a query. A simple example is given below

cql_repo.query do
    select name, source_line
    from features
end

This will return a list of all of the feature names and source lines in the form of a list of hashes.

[{'name' => 'Feature 1', 'source_line' => 1},
 {'name' => 'Feature 2', 'source_line' => 3},
 {'name' => 'Feature 3', 'source_line' => 10}]

Alternatively, you can activate the extensions to the cuke_modeler gem and query models directly:

require 'cql'
require 'cql/model_dsl'

directory = CukeModeler::Directory.new("/path-to/my/feature-files")

directory.query do
    select name, source_line
    from features
end

For more information on the query options, see the documentation here.

You can’t perform that action at this time.