cql 1.4.0 → 1.6.0

data/testing/gemfiles/cuke_modeler0.gemfile

@@ -7,27 +7,30 @@ gemspec :path => "../../"
 if RUBY_VERSION =~ /^1\.8/
   gem 'cucumber', '< 1.3.0'
   gem 'gherkin', '< 2.12.0'
-  gem 'mime-types', '< 2.0.0' # (For the relish gem) Ruby 1.8.x dropped somewhere in the 2.x series
-  gem 'rest-client', '< 1.7.0' # (For the relish gem) Ruby 1.8.x dropped on/after this version
+  gem 'rainbow', '< 2.0' # Ruby 1.8.x support dropped after this version
   gem 'rake', '< 11.0' # Rake dropped 1.8.x support after this version
 elsif RUBY_VERSION =~ /^1\./
   gem 'cucumber', '< 2.0.0'
   gem 'mime-types', '< 3.0.0' # Requires Ruby 2.x on/after this version
-  gem 'rest-client', '< 2.0.0' # Requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Requires Ruby 2.x on/after this version
 end
 
 if RUBY_VERSION =~ /^1\./
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
-
-  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
-    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
-  end
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
 end
 
 if RUBY_VERSION =~ /^2\.[23456789]/
   gem 'test-unit'
+  # Cucumber 4.x uses the `cucumber-gherkin` gem, which is incompatible with
+  # the `gherkin` gem, upon which the `cuke_modeler` gem depends
+  gem 'cucumber', '< 4.0'
+
+  # The oldest versions of the `cuke_modeler` gem did not properly limit their dependencies
+  # and CukeModeler 0.x can not handle a higher Gherkin 5.x+
+  gem 'gherkin', '< 5.0'
 end
 
 

data/testing/gemfiles/cuke_modeler1.gemfile

@@ -7,27 +7,26 @@ gemspec :path => "../../"
 if RUBY_VERSION =~ /^1\.8/
   gem 'cucumber', '< 1.3.0'
   gem 'gherkin', '< 2.12.0'
-  gem 'mime-types', '< 2.0.0' # (For the relish gem) Ruby 1.8.x dropped somewhere in the 2.x series
-  gem 'rest-client', '< 1.7.0' # (For the relish gem) Ruby 1.8.x dropped on/after this version
+  gem 'rainbow', '< 2.0' # Ruby 1.8.x support dropped after this version
   gem 'rake', '< 11.0' # Rake dropped 1.8.x support after this version
 elsif RUBY_VERSION =~ /^1\./
   gem 'cucumber', '< 2.0.0'
   gem 'mime-types', '< 3.0.0' # Requires Ruby 2.x on/after this version
-  gem 'rest-client', '< 2.0.0' # Requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Requires Ruby 2.x on/after this version
 end
 
 if RUBY_VERSION =~ /^1\./
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
-
-  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
-    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
-  end
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
 end
 
 if RUBY_VERSION =~ /^2\.[23456789]/
   gem 'test-unit'
+  # Cucumber 4.x uses the `cucumber-gherkin` gem, which is incompatible with
+  # the `gherkin` gem, upon which the `cuke_modeler` gem depends
+  gem 'cucumber', '< 4.0'
 end
 
 

data/testing/gemfiles/cuke_modeler2.gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+
+# cql can play with pretty much any version of these but they all play differently with Ruby
+if RUBY_VERSION =~ /^1\.8/
+  gem 'cucumber', '< 1.3.0'
+  gem 'gherkin', '< 2.12.0'
+  gem 'rainbow', '< 2.0' # Ruby 1.8.x support dropped after this version
+  gem 'rake', '< 11.0' # Rake dropped 1.8.x support after this version
+elsif RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 2.0.0'
+  gem 'mime-types', '< 3.0.0' # Requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Requires Ruby 2.x on/after this version
+end
+
+if RUBY_VERSION =~ /^1\./
+  gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
+  gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
+  gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
+end
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+  # Cucumber 4.x uses the `cucumber-gherkin` gem, which is incompatible with
+  # the `gherkin` gem, upon which the `cuke_modeler` gem depends
+  gem 'cucumber', '< 4.0'
+end
+
+
+gem 'cuke_modeler', '~> 2.0'

data/testing/gemfiles/cuke_modeler3.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+# Cueumber 4.x doesn't work on all JRubies and this is the only earlier version
+# that is compatible with the `cucumber-gherkin` gem, upon which CukeModler 3.x depends
+gem 'cucumber', '2.2.0'
+
+# The version of CukeModeler being tested
+gem 'cuke_modeler', '~> 3.0'

data/testing/helper_methods.rb

@@ -0,0 +1,13 @@
+module CQL
+  module HelperMethods
+
+    def cuke_modeler?(*versions)
+      versions.include?(cuke_modeler_major_version)
+    end
+
+    def cuke_modeler_major_version
+      Gem.loaded_specs['cuke_modeler'].version.version.match(/^(\d+)\./)[1].to_i
+    end
+
+  end
+end

data/testing/model_helper.rb

@@ -0,0 +1,28 @@
+module CQL
+  module ModelHelper
+
+    def directory_with(*models)
+      directory_model = CukeModeler::Directory.new
+
+      models.each do |model|
+        case
+          when model.is_a?(CukeModeler::Feature)
+            file_model = CukeModeler::FeatureFile.new
+
+            if cuke_modeler?(0)
+              file_model.features = [model]
+            else
+              file_model.feature = model
+            end
+
+            directory_model.feature_files << file_model
+          else
+            raise(ArgumentError, "Don't know how to handle a '#{model.class}'")
+        end
+      end
+
+      directory_model
+    end
+
+  end
+end

data/testing/rspec/spec/clauses/as_clause_spec.rb

@@ -0,0 +1 @@
+#TODO - add some specs for the 'as' clause

data/testing/rspec/spec/clauses/from_clause_spec.rb

@@ -0,0 +1,146 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+
+describe 'an object that uses the DSL' do
+
+
+  let(:nodule) { CQL::Dsl }
+  let(:dsl_enabled_object) { Object.new.extend(nodule) }
+
+
+  describe "from" do
+
+    it 'knows from what to select attributes' do
+      expect(dsl_enabled_object).to respond_to(:from)
+    end
+
+    it 'selects from one or more things' do
+      expect(dsl_enabled_object.method(:from).arity).to eq(-1)
+    end
+
+    it "can handle an empty 'from' clause" do
+      gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+      result = gs.query do
+        select name
+        from
+      end
+
+      expect(result).to eq([])
+    end
+
+    describe "multiple targets" do
+
+      it 'raises an exception for inapplicable attributes' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect {
+          gs.query do
+            select name, steps
+            from features
+            from scenarios
+          end
+        }.to raise_error(ArgumentError)
+      end
+
+    end
+
+    describe 'shorthand' do
+
+      it 'should consider an exact match over a pluralization' do
+        plural_class_model = CukeModeler::CqlTestModels.new
+        singular_class_model = CukeModeler::CqlTestModel.new
+
+        plural_class_model.attribute_1 = 'plural'
+        singular_class_model.attribute_1 = 'singular'
+        plural_class_model.children << singular_class_model
+
+        repo = CQL::Repository.new(plural_class_model)
+
+        result = repo.query do
+          select attribute_1
+          from cql_test_model
+        end
+
+        expect(result.first['attribute_1']).to eq('singular')
+      end
+
+      it 'raises an exception if the shorthand form of a class cannot be mapped to a real class' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect {
+          gs.query do
+            select name
+            from not_a_real_class
+          end
+        }.to raise_error(ArgumentError, "Class 'CukeModeler::NotARealClass' does not exist")
+
+      end
+
+      it 'can freely mix shorthand and long-form names' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        # All long-form
+        base_result = gs.query do
+          select name
+          from CukeModeler::Scenario, CukeModeler::Feature
+        end
+
+        # All shorthand
+        expect(
+            gs.query do
+              select name
+              from scenarios, features
+            end
+        ).to eq(base_result)
+
+        # A mix of both
+        expect(
+            gs.query do
+              select name
+              from CukeModeler::Scenario, features
+            end
+        ).to eq(base_result)
+      end
+
+    end
+
+
+    describe 'special scopes' do
+
+      it 'understands the :all scope' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect { gs.query do
+          select :model
+          from :all
+        end
+        }.to_not raise_error
+      end
+
+      it 'queries from all models when scoped to :all' do
+        model_1 = CukeModeler::CqlTestModel.new
+        model_2 = CukeModeler::CqlTestModel.new
+        model_3 = CukeModeler::CqlTestModel.new
+
+        model_1.children << model_2
+        model_1.children << model_3
+
+        repo = CQL::Repository.new(model_1)
+
+        result = repo.query do
+          select :model
+          from :all
+        end
+
+        expect(result).to match_array([{:model => model_1},
+                                       {:model => model_2},
+                                       {:model => model_3}])
+      end
+
+    end
+
+  end
+
+
+end

data/testing/rspec/spec/clauses/select_clause_spec.rb

@@ -0,0 +1,184 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+
+describe 'an object that uses the DSL' do
+
+
+  let(:nodule) { CQL::Dsl }
+  let(:dsl_enabled_object) { Object.new.extend(nodule) }
+
+  describe "select" do
+
+    it 'knows how to select attributes' do
+      expect(dsl_enabled_object).to respond_to(:select)
+    end
+
+    it 'selects one or more attributes' do
+      expect(dsl_enabled_object.method(:select).arity).to eq(-1)
+    end
+
+    it 'correctly selects a single attribute from a model' do
+      model = CukeModeler::CqlTestModel.new
+      model.attribute_1 = 'foo'
+
+      repo = CQL::Repository.new(model)
+
+      result = repo.query do
+        select attribute_1
+        from cql_test_model
+      end
+
+
+      expect(result).to eq([{'attribute_1' => 'foo'}])
+    end
+
+    it 'correctly selects multiple attributes from a model' do
+      model = CukeModeler::CqlTestModel.new
+      model.attribute_1 = 'foo'
+      model.attribute_2 = 'bar'
+
+      repo = CQL::Repository.new(model)
+
+      result = repo.query do
+        select attribute_1, attribute_2
+        from cql_test_model
+      end
+
+
+      expect(result).to eq([{'attribute_1' => 'foo',
+                             'attribute_2' => 'bar'}])
+    end
+
+
+    describe 'special attributes' do
+
+      it 'understands the :model attribute' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect { gs.query do
+          select :model
+          from features
+        end
+        }.to_not raise_error
+      end
+
+      it 'interprets :model in the same manner that it interprets :self' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        self_result = gs.query do
+          select :self
+          from features
+        end
+
+        model_result = gs.query do
+          select :model
+          from features
+        end
+
+        # Only checking the values of the results because they will have different :model/:self keys
+        expect(model_result.collect { |result| result.values }).to eq(self_result.collect { |result| result.values })
+      end
+
+      it 'complains if an unknown special attribute is queried' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect {
+          gs.query do
+            select :foo
+            from scenarios
+          end
+        }.to raise_error(ArgumentError, ":foo is not a valid attribute for selection.")
+      end
+
+      it 'uses the :self attribute by default' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        default_result = gs.query do
+          select
+          from features
+        end
+
+        self_result = gs.query do
+          select :self
+          from features
+        end
+
+        expect(self_result).to eq(default_result)
+      end
+
+    end
+
+
+    it 'complains if an unknown normal attribute is queried' do
+      gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+      expect {
+        gs.query do
+          select steps
+          from features
+        end
+      }.to raise_error(ArgumentError, "'steps' is not a valid attribute for selection from a 'CukeModeler::Feature'.")
+    end
+
+
+    describe "multiple selections" do
+
+      it 'can freely mix empty selections and attribute selections' do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        base_result = gs.query do
+          select :self
+          select name
+          select :self
+          as 'foo', 'bar', 'baz'
+          from scenarios
+        end
+
+
+        expect(
+            gs.query do
+              select
+              select name
+              select
+              as 'foo', 'bar', 'baz'
+              from scenarios
+            end
+        ).to eq(base_result)
+      end
+
+    end
+
+
+    describe 'duplicate selections' do
+
+      let(:warning_message) { "Multiple selections made without using an 'as' clause\n" }
+
+      it "warns if the same attribute is selected more than once without an 'as' clause being used" do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect {
+          gs.query do
+            select :model, :model, :model
+            from :all
+          end
+        }.to output(warning_message).to_stderr
+      end
+
+      it "does not warn if the same attribute is selected more than once and an 'as' clause is used" do
+        gs = CQL::Repository.new("#{CQL_FEATURE_FIXTURES_DIRECTORY}/scenario/simple")
+
+        expect {
+          gs.query do
+            select :model, :model, :model
+            # Usage of the clause is sufficient. Not going to try and count the mappings or anything like that.
+            as foo
+            from :all
+          end
+        }.to_not output(warning_message).to_stderr
+      end
+
+    end
+
+  end
+
+end