cql 1.4.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba9e7d8795d805ccd50924027199c698f2365df1
-  data.tar.gz: 0a452146ee7d5ca32764671835de2dcc486addd2
+SHA256:
+  metadata.gz: c95630cf653362dc9364c4ffe7c5099efbd779abec07c8fe42ebb4fffc23008b
+  data.tar.gz: 7f1c6a3f3e728fe9b92ad1ba1df4001d5a10cca8469997a47bf82c6f0b301664
 SHA512:
-  metadata.gz: 703ed14d3880d6017ea2d0699ead3aa22ffb6ee3235071fb095300db35c7754ba857225623265a39e382d8c24b0ec4ca9e547bf04ef16b4ee5fe39037fee3c16
-  data.tar.gz: 9cec568a459073e2bf91bea830b8365748724091592b00eb56df32037393cdad119d6de2d5c1e1a858c564832e6948ffc2e7c82dc480861ec97f26f716e447eb
+  metadata.gz: d449609ec93c7ef3cece4da854e6b2ecb83198eb02bfe9f17688974f9ee3aa8f17bf5dcf94241ebdbb201414f18fc938bdca86b16141f7937246a903abbef070
+  data.tar.gz: c7b9588db438b973b1714d2191f5725ba17ad30aa363d6f8d10337767d86616fd982ea603fc266628209518de0d2a6c4d265dbfe043c19f0966f88387254a279

data/lib/cql/dsl.rb

@@ -80,8 +80,13 @@ module CQL
 
     # Not a part of the public API. Subject to change at any time.
     class Comparison
-      attr_accessor :operator, :amount
 
+                    # the operator used for comparison
+      attr_accessor :operator,
+                    # value that will be compared against
+                    :amount
+
+      # Creates a new comparison object
       def initialize operator, amount
         @operator = operator
         @amount = amount
@@ -134,6 +139,11 @@ module CQL
       Comparison.new '<=', amount
     end
 
+    # Adds an *eq* filter operator to the query. See the corresponding Cucumber documentation for details.
+    def eq amount
+      Comparison.new '==', amount
+    end
+
     # Adds a *tags* filter to the query. See the corresponding Cucumber documentation for details.
     def tags *tags
       return "tags" if tags.size == 0

data/lib/cql/filters.rb

@@ -2,12 +2,16 @@ module CQL
 
   # Not a part of the public API. Subject to change at any time.
   class TagFilter
+
+    # Tags to match
     attr_reader :tags
 
+    # Creates a new filter
     def initialize tags
       @tags = tags
     end
 
+    # Returns whether or not the object has the target tags
     def has_tags?(object, target_tags)
       target_tags.all? { |target_tag|
         tags = object.tags
@@ -27,14 +31,18 @@ module CQL
 
   # Not a part of the public API. Subject to change at any time.
   class ContentMatchFilter
+
+    # Pattern to match
     attr_reader :pattern
 
+    # Creates a new filter
     def initialize(pattern)
       raise(ArgumentError, "Can only match a String or Regexp. Got #{pattern.class}.") unless pattern.is_a?(String) || pattern.is_a?(Regexp)
 
       @pattern = pattern
     end
 
+    # Returns whether or not the content matches the pattern
     def content_match?(content)
       if pattern.is_a?(String)
         content.any? { |thing| thing == pattern }
@@ -47,8 +55,13 @@ module CQL
 
   # Not a part of the public API. Subject to change at any time.
   class TypeCountFilter
-    attr_reader :types, :comparison
 
+                # the types of object that will be filtered against
+    attr_reader :types,
+                # the comparison that will be made between the objects
+                :comparison
+
+    # Creates a new filter
     def initialize types, comparison
       @types = types
       @comparison = comparison

data/lib/cql/query.rb

@@ -5,9 +5,12 @@ module CQL
 
     include Dsl
 
-    attr_reader :data, :what
-
+                # the root object that will be queried
+    attr_reader :data,
+                # what kinds of objects will be selected
+                :what
 
+    # Creates a new query object
     def initialize(directory, &block)
       # Set root object
       @data = directory

data/lib/cql/repository.rb

@@ -7,6 +7,7 @@ module CQL
     include Queriable
 
 
+    # Creates a new repository object based on the passed directory path or model
     def initialize(repository_root)
       case
         when repository_root.is_a?(String)

data/lib/cql/version.rb

@@ -1,4 +1,4 @@
 module CQL
   # The current version of the gem
-  VERSION = '1.4.1'
+  VERSION = '1.7.0'
 end

data/testing/cucumber/features/clauses/from_clause.feature

@@ -119,11 +119,3 @@ Feature: 'from' clause
       from :all
       """
     Then all models are queried from
-
-
-# Commented out so that they aren't picked up by Relish
-#  @wip
-#  Scenario: Can 'from' from all type of model
-#
-#  @wip
-#  Scenario: From-ing from a collection

data/testing/cucumber/features/clauses/predefined_with_filters.feature

@@ -0,0 +1,392 @@
+# todo - Rewrite the scenarios such that they use their own test specific feature files instead of setting up a large suite in the background
+Feature: 'with' clause
+
+  There are several predefined filters that can be used with the *with* clause. Like regular 'block style' conditions, they can be negated using *without*, used in a targeted fashion, etc.
+
+  Sample usage:
+  ````
+  cql_repo.query do
+  select name, tags, description_text
+  from features
+  with tc lt 3
+  end
+  ````
+
+  The following filters are supported for models that have tags:
+
+  * tags - Filters out models that do not have the exact set of tags provided.
+  * tc   - (tag count) Filters out models based on the number of tags that they have.
+
+  The following filters are supported for models that have names:
+
+  * name - Filters out models whose name does not match the name provided. Can be a string or regular expression.
+
+  The following filters are supported for models that have steps:
+
+  * line - Filters out models whose steps do not include the provided step (keywords and blocks are ignored). Can be a string or regular expression.
+  * lc   - (line count) Filters out models based on the number of steps that they have.
+
+  The following filters are supported for feature models:
+
+  * sc   - (scenario count) Filters out models based on the number of scenarios that they have.
+  * soc  - (scenario outline count) Filters out models based on the number of outlines that they have.
+  * ssoc - (scenario and scenario outline count) Filters out models based on the total number of scenarios and outlines that they have.
+
+  For count based filters, the following operators are available:
+
+  * lt   (Less than)
+  * lte  (Less than or equals)
+  * gt   (Greater than)
+  * gte  (Greater than or equals)
+  * eq   (Equals)
+
+
+  Background: A sample Cucumber suite
+    Given a repository to query
+    And the following feature has been modeled in the repository:
+      """
+      Feature: A test feature
+
+        @tag_1 @tag_2
+        Scenario: Test 1
+          * some steps
+
+        @special_tag @tag_2
+        Scenario: Test 2
+          * some other steps
+          * some other steps
+          * some other steps
+
+        @a @b @c
+        Scenario Outline: Test 3
+          * some steps
+          * some more steps
+          * some more steps
+          * some more steps
+        Examples: First examples
+          | param |
+          | value |
+        Examples: Second examples
+          | param |
+          | value |
+
+        Scenario: Test 4
+      """
+    And the following feature has been modeled in the repository:
+      """
+      Feature: A feature with lots of scenarios
+
+        Scenario: 1
+          * different steps
+          * different steps
+
+        Scenario: 2
+          * different steps
+          * different steps
+
+        Scenario: 3
+          * different steps
+          * different steps
+      """
+    And the following feature has been modeled in the repository:
+      """
+      Feature: A feature with lots of outlines
+
+        Scenario Outline: 1
+          * different steps
+          * different steps
+        Examples:
+          | param |
+          | value |
+
+        Scenario Outline: 2
+          * different steps
+          * different steps
+        Examples:
+          | param |
+          | value |
+
+        Scenario Outline: 3
+          * different steps
+          * different steps
+        Examples:
+          | param |
+          | value |
+      """
+    And the following feature has been modeled in the repository:
+      """
+      Feature: A feature with a mix of tests
+
+        Scenario: 4
+          * different steps
+          * different steps
+
+        Scenario Outline: 4
+          * different steps
+          * different steps
+        Examples:
+          | param |
+          | value |
+      """
+
+
+  Scenario: Filtering by tags
+    When the following query is executed:
+      """
+      select name
+      from scenarios
+      with tags '@tag_1', '@tag_2'
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 1 |
+
+  Scenario: Filtering by tag count
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with tc gt 2
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 3 |
+
+  Scenario: Filtering by name (exact match)
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with name 'Test 3'
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 3 |
+
+  Scenario: Filtering by name (regular expression)
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with name /Test [12]/
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 1 |
+      | Test 2 |
+
+  Scenario: Filtering by line (exact match)
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with line 'some steps'
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 1 |
+      | Test 3 |
+
+  Scenario: Filtering by line (regular expression)
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with line /other/
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 2 |
+
+  Scenario: Filtering by line count
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with lc gt 3
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 3 |
+
+  Scenario: Filtering by scenario count
+    When the following query is executed:
+      """
+      select name
+      from features
+      with sc gt 2
+      """
+    Then the following values are returned:
+      | name                             |
+      | A test feature                   |
+      | A feature with lots of scenarios |
+
+  Scenario: Filtering by outline count
+    When the following query is executed:
+      """
+      select name
+      from features
+      with soc gt 2
+      """
+    Then the following values are returned:
+      | name                            |
+      | A feature with lots of outlines |
+
+  Scenario: Filtering by combined test count
+    When the following query is executed:
+      """
+      select name
+      from features
+      with ssoc lt 3
+      """
+    Then the following values are returned:
+      | name                          |
+      | A feature with a mix of tests |
+
+  Scenario: Using the 'lt' count filter
+    When the following query is executed:
+      """
+      select name
+      from features
+      with ssoc lt 3
+      """
+    Then the following values are returned:
+      | name                          |
+      | A feature with a mix of tests |
+
+  Scenario: Using the 'lte' count filter
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with lc lte 1
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 1 |
+      | Test 4 |
+
+  Scenario: Using the 'gt' count filter
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with lc gt 3
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 3 |
+
+  Scenario: Using the 'gte' count filter
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with lc gte 3
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 2 |
+      | Test 3 |
+
+  Scenario: Using the 'eq' count filter
+    When the following query is executed:
+      """
+      select name
+      from scenarios, outlines
+      with tc eq 3
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 3 |
+
+
+  Scenario: Using multiple filters
+    When the following query is executed:
+      """
+      select name
+      from scenarios
+      with tc eq 2
+      with lc gt 1
+      """
+    Then the following values are returned:
+      | name   |
+      | Test 2 |
+
+  Scenario: Using the 'with' clause multiple times
+
+  Behavior is the same as combining regular, block style filters but the syntax has to become more explicit.
+
+    When the following query is executed:
+      """
+      select name
+      from scenarios
+      with tc(eq(2)),
+           lc(gt(1))
+      """
+    Then the result is the same as the result of the following query:
+      """
+      select name
+      from scenarios
+      with tc eq 2
+      with lc gt 1
+      """
+
+  Scenario: Selectively filtering models
+    When the following query is executed:
+      """
+      select name
+      from scenarios, features
+      with scenarios => lc(eq(1))
+      """
+    Then the following values are returned:
+      | name                             |
+      | Test 1                           |
+      | A test feature                   |
+      | A feature with lots of scenarios |
+      | A feature with lots of outlines  |
+      | A feature with a mix of tests    |
+
+
+  Scenario: Mixing targeted and blanket filters
+    When the following query is executed:
+      """
+      select name
+      from scenarios, features
+      with name /test/i
+      with scenarios => tc(eq(0))
+      """
+    Then the following values are returned:
+      | name                          |
+      | Test 4                        |
+      | A test feature                |
+      | A feature with a mix of tests |
+
+  Scenario: Using 'without' for negation
+    When the following query is executed:
+      """
+      select name
+      from features
+      without ssoc lt 3
+      """
+    Then the result is the same as the result of the following query:
+      """
+      select name
+      from features
+      with ssoc gt 2
+      """
+
+  Scenario: Mixing predefined filters and regular filters
+    When the following query is executed:
+      """
+      select name
+      from scenarios, features
+      with { |element| element.name =~ /test/i }
+      with scenarios => tc(eq(0))
+      """
+    Then the following values are returned:
+      | name                          |
+      | Test 4                        |
+      | A test feature                |
+      | A feature with a mix of tests |
+