cql 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe541449ce515566bd3a3483b42f2260829a03e1
-  data.tar.gz: 846f80e853bef0ba8d441187370ce948e6cca50b
+SHA256:
+  metadata.gz: 2cef04f054cecd8e489f46daa063be8ac02360c53f5d7d8fe8e551ce337e5d34
+  data.tar.gz: 6714fecd35d662a966cb82f9bda4a43e308b38597834a53d03c337fe9ad1d75d
 SHA512:
-  metadata.gz: 5f5bb7cb738155ad68f98b877d4889be5f57b69adec5c37804307aa47d29bde11c7819e3a883994e85ff3b903f636a542a575668b1cac9b299068244e3b08df6
-  data.tar.gz: ee4e8bf2dee1d7aeb0128c65fe3001c1d21c97290b6668384d044de2066880de687a2398040616f8f000eefb6d4aed1ff269a975ae2c8f51e6769ac7364063f6
+  metadata.gz: 5779cca5eef6d487d88fc9089bc4374b03ccea619443f333490217fbf2b747288b7f297078d8c148969bc53c50c00ea5fa4d0f876473cb9e22afe70bbfbbe795
+  data.tar.gz: 4def191c2d3dd5ee166980dde04f3f05599614797d015ca242574a467dcdb1a6bab05c3b6648e70c50d5a66f8b960da6f1790cd44117ec699ee7902b040a3909

data/lib/cql.rb

@@ -1,176 +1,11 @@
 require 'cuke_modeler'
 require 'cql/map_reduce'
 require 'cql/queriable'
+require 'cql/query'
+require 'cql/repository'
 
-module CQL
-
-  class Query
-    include Dsl
-    attr_reader :data, :what
-
-    def format_data data
-      space_data
-
-      Array.new.tap do |result_array|
-        data.each do |element|
-          result_array << Hash.new.tap do |result|
-            @what.each_with_index do |attribute, index|
-              key = determine_key(attribute, index)
-              value = determine_value(element, attribute, index)
-
-              result[key] = value
-            end
-          end
-        end
-      end
-
-    end
-
-    def initialize(directory, &block)
-      # Set root object
-      @data = directory
-
-      # Populate configurables from DSL block
-      self.instance_eval(&block)
-
-
-      raise(ArgumentError, "A query must specify a 'select' clause") unless @what
-      raise(ArgumentError, "A query must specify a 'from' clause") unless @from
-
-      warn("Multiple selections made without using an 'as' clause") unless @name_transforms || (@what.count == @what.uniq.count)
-
-      # Gather relevant objects from root object and filters
-      @data = CQL::MapReduce.gather_objects(@data, @from, @filters)
-
-      # Extract properties from gathered objects
-      @data = format_output(@data)
-    end
-
-
-    private
-
-
-    def format_output(data)
-      format_data(data)
-    end
-
-    def determine_key(attribute, index)
-      key = mapped_attribute(@name_transforms, attribute, index) if @name_transforms
-
-      key || attribute
-    end
-
-    def determine_value(element, attribute, index)
-      original_value = attribute.is_a?(Symbol) ? determine_special_value(element, attribute) : determine_normal_value(element, attribute)
-
-      if @value_transforms
-        value = mapped_attribute(@value_transforms, attribute, index)
-        value = value.call(original_value) if value.is_a?(Proc)
-      end
-
-      value || original_value
-    end
 
-    def determine_special_value(element, attribute)
-      # todo - Not sure what other special values to have but this could be expanded upon later.
-      case attribute
-        when :self, :model
-          val = element
-        else
-          raise(ArgumentError, ":#{attribute} is not a valid attribute for selection.")
-      end
+# The top level namespace for CQL related code.
 
-      val
-    end
-
-    def determine_normal_value(element, attribute)
-      if element.respond_to?(attribute)
-        element.send(attribute)
-      else
-        raise(ArgumentError, "'#{attribute}' is not a valid attribute for selection from a '#{element.class}'.")
-      end
-    end
-
-    def mapped_attribute(mappings, attribute, location)
-      case
-        when mappings.is_a?(Array)
-          value = mappings[location]
-        when mappings.is_a?(Hash)
-          if mappings[attribute]
-            value = mappings[attribute][location]
-          end
-        else
-          # todo - add error message
-      end
-
-      value
-    end
-
-    def space_data
-      space_renamings
-      space_transforms
-    end
-
-    def space_renamings
-      if @name_transforms.is_a?(Hash)
-        new_names = {}
-
-        @name_transforms.each_pair do |key, value|
-          new_names[key] = []
-
-          @what.each do |attribute|
-            if attribute == key
-              new_names[key] << value.shift
-            else
-              new_names[key] << nil
-            end
-          end
-        end
-
-        @name_transforms = new_names
-      end
-    end
-
-    def space_transforms
-      if @value_transforms.is_a?(Hash)
-        new_values = {}
-
-        @value_transforms.each_pair do |key, value|
-          new_values[key] = []
-
-          @what.each do |attribute|
-            if attribute == key
-              new_values[key] << value.shift
-            else
-              new_values[key] << nil
-            end
-          end
-        end
-
-        @value_transforms = new_values
-      end
-    end
-
-  end
-
-
-  class Repository
-
-    include Queriable
-
-
-    def initialize(repository_root)
-      case
-        when repository_root.is_a?(String)
-          root = CukeModeler::Directory.new(repository_root)
-        when repository_root.class.to_s =~ /CukeModeler/
-          root = repository_root
-        else
-          raise(ArgumentError, "Don't know how to make a repository from a #{repository_root.class}")
-      end
-
-      @query_root = root
-    end
-
-  end
+module CQL
 end

data/lib/cql/dsl.rb

@@ -1,10 +1,16 @@
 module CQL
+
+  # The Domain Specific Language used for performing queries.
+
   module Dsl
 
+
+    # Any undefined method is assumed to mean its String equivalent, thus allowing a more convenient query syntax.
     def method_missing(method_name)
       method_name.to_s
     end
 
+    # Adds a *transform* clause to the query. See the corresponding Cucumber documentation for details.
     def transform(*attribute_transforms, &block)
       # todo - Still feels like some as/transform code duplication but I think that it would get too meta if I
       # reduced it any further. Perhaps change how the transforms are handled so that there doesn't have to be
@@ -16,13 +22,14 @@ module CQL
       add_transforms(attribute_transforms, @value_transforms)
     end
 
+    # Adds an *as* clause to the query. See the corresponding Cucumber documentation for details.
     def as(*name_transforms)
       prep_variable('name_transforms', name_transforms) unless @name_transforms
 
       add_transforms(name_transforms, @name_transforms)
     end
 
-    #Select clause
+    # Adds a *select* clause to the query. See the corresponding Cucumber documentation for details.
     def select *what
       what = [:self] if what.empty?
 
@@ -30,17 +37,19 @@ module CQL
       @what.concat(what)
     end
 
+    # Adds a *name* filter to the query. See the corresponding Cucumber documentation for details.
     def name *args
       return 'name' if args.size == 0
       CQL::NameFilter.new args[0]
     end
 
+    # Adds a *line* filter to the query. See the corresponding Cucumber documentation for details.
     def line *args
       return 'line' if args.size == 0
       CQL::LineFilter.new args.first
     end
 
-    #from clause
+    # Adds a *from* clause to the query. See the corresponding Cucumber documentation for details.
     def from(*targets)
       @from ||= []
 
@@ -49,7 +58,7 @@ module CQL
       @from.concat(targets)
     end
 
-    #with clause
+    # Adds a *with* clause to the query. See the corresponding Cucumber documentation for details.
     def with(*conditions, &block)
       @filters ||= []
 
@@ -59,7 +68,7 @@ module CQL
       end
     end
 
-    #without clause
+    # Adds a *without* clause to the query. See the corresponding Cucumber documentation for details.
     def without(*conditions, &block)
       @filters ||= []
 
@@ -69,9 +78,15 @@ module CQL
       end
     end
 
+    # 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
@@ -79,48 +94,67 @@ module CQL
 
     end
 
+    # Adds a *tc* filter to the query. See the corresponding Cucumber documentation for details.
     def tc comparison
       TagCountFilter.new 'tc', comparison
     end
 
+    # Adds a *lc* filter to the query. See the corresponding Cucumber documentation for details.
     def lc comparison
       CQL::SsoLineCountFilter.new('lc', comparison)
     end
 
+    # Adds an *ssoc* filter to the query. See the corresponding Cucumber documentation for details.
     def ssoc comparison
       TestCountFilter.new([CukeModeler::Scenario, CukeModeler::Outline], comparison)
     end
 
+    # Adds an *sc* filter to the query. See the corresponding Cucumber documentation for details.
     def sc comparison
       TestCountFilter.new([CukeModeler::Scenario], comparison)
     end
 
+    # Adds an *soc* filter to the query. See the corresponding Cucumber documentation for details.
     def soc comparison
       TestCountFilter.new([CukeModeler::Outline], comparison)
     end
 
+    # Adds a *gt* filter operator to the query. See the corresponding Cucumber documentation for details.
     def gt amount
       Comparison.new '>', amount
     end
 
+    # Adds a *gte* filter operator to the query. See the corresponding Cucumber documentation for details.
     def gte amount
       Comparison.new '>=', amount
     end
 
+    # Adds an *lt* filter operator to the query. See the corresponding Cucumber documentation for details.
     def lt amount
       Comparison.new '<', amount
     end
 
+    # Adds an *lte* filter operator to the query. See the corresponding Cucumber documentation for details.
     def lte amount
       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
 
       TagFilter.new tags
     end
 
+
+    private
+
+
     def translate_shorthand(where)
       where.split('_').map(&:capitalize).join
     end

data/lib/cql/feature_filters.rb

@@ -3,8 +3,10 @@ require 'cql/filters'
 
 module CQL
 
+  # Not a part of the public API. Subject to change at any time.
   class TestCountFilter < TypeCountFilter
 
+    # Counts the numbers of tests of a certain type
     def type_count(feature)
       feature.tests.find_all { |test| types.include?(test.class) }.size
     end

data/lib/cql/filters.rb

@@ -1,12 +1,17 @@
 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
@@ -15,6 +20,7 @@ module CQL
       }
     end
 
+    # Filters the input models so that only the desired ones are returned
     def execute(objects, negate)
       method = negate ? :reject : :select
 
@@ -23,15 +29,20 @@ module CQL
 
   end
 
+  # 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 }
@@ -42,14 +53,22 @@ module CQL
 
   end
 
+  # 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
     end
 
+    # Not a part of the public API. Subject to change at any time.
+    # Filters the input models so that only the desired ones are returned
     def execute(input, negate)
       method = negate ? :reject : :select
 
@@ -60,8 +79,10 @@ module CQL
 
   end
 
+  # Not a part of the public API. Subject to change at any time.
   class NameFilter < ContentMatchFilter
 
+    # Filters the input models so that only the desired ones are returned
     def execute(input, negate)
       method = negate ? :reject : :select
 
@@ -72,8 +93,11 @@ module CQL
 
   end
 
+
+  # Not a part of the public API. Subject to change at any time.
   class TagCountFilter < TypeCountFilter
 
+    # Counts the numbers of tags on a test
     def type_count(test)
       test.tags.size
     end