mumuki-sqlite-runner 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ae7f324d12e24d38f8ac0fbf573406453c0cece8e1853800314feb3ba9b2b8
-  data.tar.gz: c0619a88e63b5df94d0dc9c715a7539dddc6a9b82d38bf7b89461a6b080c8326
+  metadata.gz: 3734b0af25cc1a8f563c7bfda8e13a7891f78421fbcda0710553bc3c5140ee8e
+  data.tar.gz: 78b63bfb30f4f4ef26742db5e5b1f98deb80a9b89ff64d1eeddc2b0111b7ceb9
 SHA512:
-  metadata.gz: b971e4cc0cac4b5f9d71067bd06e4e9ace57b31c14184fadfb269d35471a101f0a4fda7d35f6148db7c6c4fe417db5d559edf23db2188ef64aaf6d9443544f45
-  data.tar.gz: 6d1fb79de256ba8903fe326da8beef481c28e7b04a26b094f872fe48992bfd273e55c366e03f6c87dfba099a6206b5774be44d01371fafc7e5d44ada0e4b80d7
+  metadata.gz: eb05abd4833c0f3f7ab3a3d6125bbbfd6a1fceea140b9dead9be60a37c4030b562a2c0548614854b0afc1a3f4e2c4db9b42cca954fa8e81c48de5f6c73fa354b
+  data.tar.gz: 30cd885678391688ff8fe2b0d3cea9a34cc51a4bf31d5bae8eee956102a7986b2f646f8db194ac4ef00bf3d883ded8418f77e4eaa4c2ca1749cdfac06fc52c82

data/lib/helpers.rb

@@ -1,17 +1,16 @@
 module Sqlite
   module TestHelper
 
-    def set_test_parsers_hash
-      @test_parsers = {
-          query: Sqlite::QueryTestParser,
-          display: Sqlite::DisplayTestParser,
-          datasets: Sqlite::DatasetTestParser,
-          final_dataset: Sqlite::FinalDatasetTestParser,
+    def parsers
+      @parsers ||= {
+          query: Sqlite::QueryParser,
+          display: Sqlite::DisplayParser,
+          datasets: Sqlite::DatasetsParser,
+          final_dataset: Sqlite::FinalDatasetParser,
       }
-      @test_parsers.default = Sqlite::InvalidTestParser
     end
 
-    def load_tests(test)
+    def collect_tests(test)
       tests = YAML.load test
       tests = [tests] unless tests.kind_of? Array
       tests.map(&:to_struct)

data/lib/locales/en.yml

@@ -9,4 +9,10 @@ en:
       query:   'Queries do not match'
       tests:
         lint: "Invalid tests, It should be a valid YAML format. Try with this validator http://www.yamllint.com/"
+        type: "You need to declare field type:"
         types: "Unsupported test type '%{type}'. Use one of these: datasets, query, display, final_dataset"
+        fields:
+          query: "For type:query you should use ONLY these fields: type (required), seed (optional), expected (required)"
+          datasets: "For type:datasets you should use ONLY these fields: type (required), seed (optional), expected (required)"
+          final_dataset: "For type:final_dataset you should use ONLY these fields: type (required), seed (optional), final (required), expected (required)"
+          display: "For type:display you should use ONLY these fields: type (required), seed (optional), query (required)"

data/lib/locales/es.yml

@@ -9,4 +9,10 @@ es:
       query:   'Las consultas no coinciden'
     tests:
       lint: "¡Tests inválidos! No tienen el formato YAML correcto. Podés probar en este validador http://www.yamllint.com/"
+      type: "Tenés que declarar el campo type:"
       types: "El test type '%{type}' no está soportado. Tenés que usar uno de éstos: datasets, query, display, final_dataset"
+      fields:
+        query: "Para el type:query deberías usar ÚNICAMENTE estos campos: type (requerido), seed (opcional), expected (requerido)"
+        datasets: "Para el type:datasets deberías usar ÚNICAMENTE estos campos: type (requerido), seed (opcional), expected (requerido)"
+        final_dataset: "Para el type:final_dataset, deberías usar ÚNICAMENTE estos campos: type (requerido), seed (opcional), final (requerido), expected (requerido)"
+        display: "Para el type:display deberías usar ÚNICAMENTE estos campos: type (requerido), seed (opcional), query (requerido)"

data/lib/parsers/datasets_parser.rb

@@ -0,0 +1,33 @@
+module Sqlite
+  class DatasetsParser < BaseParser
+
+    def initialize
+      @fields = {
+          required: [:type, :expected],
+          optional: [:seed]
+      }
+    end
+
+    def choose_solution(_solution)
+      @solutions
+    end
+
+    protected
+
+    def transform_test
+      @solutions = strip_lines get(:expected)
+      super
+    end
+
+    def get_expected
+      COMMENT
+    end
+
+    def strip_lines(array)
+      array.to_s
+          .split("\n")
+          .map(&:strip)
+          .join("\n")
+    end
+  end
+end

data/lib/parsers/display_parser.rb

@@ -0,0 +1,21 @@
+module Sqlite
+  class DisplayParser < BaseParser
+
+    def initialize
+      @fields = {
+        required: [:type, :query],
+        optional: [:seed]
+      }
+    end
+
+    def get_final_query
+      get(:query)
+    end
+
+    protected
+
+    def get_expected
+      get_final_query
+    end
+  end
+end

data/lib/parsers/final_dataset_parser.rb

@@ -0,0 +1,25 @@
+module Sqlite
+  class FinalDatasetParser < DatasetsParser
+
+    def initialize
+      @fields = {
+        required: [:type, :final, :expected],
+        optional: [:seed]
+      }
+      @alias = {
+          query: :final
+      }
+    end
+
+    def get_final_query
+      has?(:final) ? get(:final) : get(:query)
+    end
+
+    protected
+
+    def process_alias(keys)
+      keys.map { |item| @alias.include?(item) ? @alias[item] : item }
+    end
+
+  end
+end

data/lib/parsers/general_parser.rb

@@ -0,0 +1,54 @@
+module Sqlite
+  class BaseParser
+
+    COMMENT = '-- NONE'
+    attr_reader :test_result
+
+    def parse_test(test)
+      @test = test
+      @test_result = transform_test
+    end
+
+    def test_has_valid_fields?(test)
+      required = @fields[:required].sort
+      optional = @fields[:optional]
+      keys = process_alias test.to_h.keys.map(&:to_sym).sort
+      (keys - optional).eql? required
+    end
+
+    # A Parser can choose it's own solution or just return which is passed.
+    # This is default choice
+    def choose_solution(solution)
+      solution
+    end
+
+    def get_final_query
+      ''
+    end
+
+    protected
+
+    def transform_test
+      {
+          seed: get_seed,
+          expected: get_expected
+      }
+    end
+
+    def has?(key)
+      !@test[key.to_sym].blank?
+    end
+
+    def get(key)
+      @test[key.to_sym]
+    end
+
+    def get_seed
+      has?(:seed) ? get(:seed).strip : ''
+    end
+
+    def process_alias(keys)
+      keys
+    end
+  end
+end

data/lib/parsers/query_parser.rb

@@ -0,0 +1,17 @@
+module Sqlite
+  class QueryParser < BaseParser
+
+    def initialize
+      @fields = {
+        required: [:type, :expected],
+        optional: [:seed]
+      }
+    end
+
+    protected
+
+    def get_expected
+      get(:expected).strip
+    end
+  end
+end

data/lib/sqlite_runner.rb

@@ -16,12 +16,11 @@ require_relative './version_hook'
 require_relative './metadata_hook'
 require_relative './html_renderer'
 require_relative './multiple_executions_runner'
-require_relative './parsers/common_test_parser'
-require_relative './parsers/query_test_parser'
-require_relative './parsers/display_test_parser'
-require_relative './parsers/dataset_test_parser'
-require_relative './parsers/final_dataset_test_parser'
-require_relative './parsers/invalid_test_parser'
+require_relative './parsers/general_parser'
+require_relative './parsers/query_parser'
+require_relative './parsers/display_parser'
+require_relative './parsers/datasets_parser'
+require_relative './parsers/final_dataset_parser'
 require_relative './helpers'
 require_relative './test_hook'
 require_relative './validation_hook'

data/lib/test_hook.rb

@@ -8,11 +8,6 @@ class SqliteTestHook < Mumukit::Templates::FileHook
   isolated
   include Sqlite::TestHelper
 
-  def initialize(config = nil)
-    super(config)
-    set_test_parsers_hash
-  end
-
   def tempfile_extension
     '.json'
   end
@@ -23,12 +18,11 @@ class SqliteTestHook < Mumukit::Templates::FileHook
 
   # Transform Mumuki Request into Docker file style
   def compile_file_content(request)
-    tests = parse_tests request.test
-    final = get_final_query
+    parse_tests request.test
     {
         init:    "#{request.extra&.strip}",
-        student: "#{request.content&.strip}#{final}",
-        tests:   tests
+        student: "#{request.content&.strip}#{get_final_query}",
+        tests:   get_tests
     }.to_json
   end
 
@@ -52,7 +46,7 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     student  = output['student']
     expected = output['expected']
     expected.map!.with_index do |expect, i|
-      @tests[i].choose expect
+      @tests[i].choose_solution expect
     end
     diff(expected, student)
   end
@@ -90,15 +84,19 @@ class SqliteTestHook < Mumukit::Templates::FileHook
 
   # This method receives a list of test cases and transforms each one according it parser
   def parse_tests(tests)
-    @tests = load_tests(tests).map do | test |
-      @test_parsers[test.type.to_sym].new test
+    @tests = collect_tests(tests).map do |test|
+      parser = parsers[test.type.to_sym].new
+      parser.parse_test test
+      parser
     end
-    @tests.map(&:result)
+  end
+
+  def get_tests
+    @tests.map(&:test_result)
   end
 
   def get_final_query
-    tests = @tests.select { |test| test.has_final? }
-    tests.empty? ? '' : tests.first.get_final
+    @tests.map{ |t| t.get_final_query.to_s }.reject(&:empty?).join
   end
 
   # Initialize Metatest Framework with Checker & Runner

data/lib/validation_hook.rb

@@ -2,30 +2,35 @@ class SqliteValidationHook < Mumukit::Hook
 
   include Sqlite::TestHelper
 
-  def initialize(config = nil)
-    super(config)
-    set_test_parsers_hash
-  end
-
   def validate!(request)
     lint_tests request.test
     types_tests request.test
+    fields_of_test_types request.test
   end
 
   def lint_tests(tests)
-    begin
-      YAML.load tests
-    rescue
-      raise Mumukit::RequestValidationError, I18n.t('message.failure.tests.lint')
-    end
+    YAML.load tests
+  rescue
+    fail! 'message.failure.tests.lint'
   end
 
   def types_tests(tests)
-    # Assumes that pass lint_tests
-    load_tests(tests).each do |test|
-      valid = @test_parsers.has_key? test.type.to_sym
-      raise Mumukit::RequestValidationError, I18n.t('message.failure.tests.types', type: test.type) unless valid
+    # Assumes pass lint_tests
+    collect_tests(tests).each do |test|
+      fail! 'message.failure.tests.type' if test.type.blank?
+      fail!('message.failure.tests.types', type: test.type) unless parsers.has_key? test.type.to_sym
     end
   end
 
+  def fields_of_test_types(tests)
+    # Assumes pass types_tests
+    collect_tests(tests).each do |test|
+      parser = parsers[test.type.to_sym].new
+      fail! "message.failure.tests.fields.#{test.type}" unless parser.test_has_valid_fields? test
+    end
+  end
+
+  def fail!(*args)
+    raise Mumukit::RequestValidationError, I18n.t(*args)
+  end
 end

data/lib/version_hook.rb

@@ -1,3 +1,3 @@
 module SqliteVersionHook
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-sqlite-runner
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Leandro Di Lorenzo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit
@@ -180,12 +180,11 @@ files:
 - lib/locales/es.yml
 - lib/metadata_hook.rb
 - lib/multiple_executions_runner.rb
-- lib/parsers/common_test_parser.rb
-- lib/parsers/dataset_test_parser.rb
-- lib/parsers/display_test_parser.rb
-- lib/parsers/final_dataset_test_parser.rb
-- lib/parsers/invalid_test_parser.rb
-- lib/parsers/query_test_parser.rb
+- lib/parsers/datasets_parser.rb
+- lib/parsers/display_parser.rb
+- lib/parsers/final_dataset_parser.rb
+- lib/parsers/general_parser.rb
+- lib/parsers/query_parser.rb
 - lib/sqlite_runner.rb
 - lib/test_hook.rb
 - lib/validation_hook.rb
@@ -212,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: SQLite Runner for Mumuki

data/lib/parsers/common_test_parser.rb

@@ -1,45 +0,0 @@
-module Sqlite
-  module CommonTestParser
-
-    COMMENT = '-- NONE'
-    attr_reader :result, :final
-    required :parse, 'You need to implement parse method when use CommonTestParse mixin!'
-
-    def initialize(test)
-      @test = test
-      @result = parse test
-    end
-
-    def choose(solution)
-      solution
-    end
-
-    def has?(key)
-      !@test[key.to_sym].blank?
-    end
-
-    def get(key)
-      @test[key.to_sym]
-    end
-
-    def has_final?
-      # Only FinalDataset should have final query
-      false
-    end
-
-    def get_final
-      ''
-    end
-
-    protected
-
-    def final_parse(test, override = {})
-      seed = test[:seed].blank? ? '' : test[:seed].strip
-      {
-          seed:     override[:seed]     || seed,
-          expected: override[:expected] || test[:expected].strip
-      }
-    end
-
-  end
-end

data/lib/parsers/dataset_test_parser.rb

@@ -1,29 +0,0 @@
-module Sqlite
-  class DatasetTestParser
-
-    include Sqlite::CommonTestParser
-
-    # test = {
-    #   type: dataset,
-    #   seed: INSERT INTO ...,
-    #   expected: |
-    #     id|field
-    #     1|row 1
-    #     ...
-    # }
-    #
-    # return {
-    #   seed: INSERT INTO ...,
-    #   expected: -- NONE
-    # }
-    def parse(test)
-      @solutions = test[:expected].to_s.split("\n").map(&:strip).join("\n")
-      final_parse test, {expected: '-- NONE'}
-    end
-
-    def choose(_solution)
-      @solutions
-    end
-
-  end
-end

data/lib/parsers/display_test_parser.rb

@@ -1,18 +0,0 @@
-module Sqlite
-  class DisplayTestParser
-    include Sqlite::CommonTestParser
-
-    def has_final?
-      has?(:query)
-    end
-
-    def get_final
-      # Assume has_final? is true
-      get(:query)
-    end
-
-    def parse(test)
-      final_parse test, { expected: get_final }
-    end
-  end
-end

data/lib/parsers/final_dataset_test_parser.rb

@@ -1,14 +0,0 @@
-module Sqlite
-  class FinalDatasetTestParser < DatasetTestParser
-
-    def has_final?
-      has?(:final) || has?(:query)
-    end
-
-    def get_final
-      # Assume has_final? is true
-      has?(:final) ? get(:final) : get(:query)
-    end
-
-  end
-end

data/lib/parsers/invalid_test_parser.rb

@@ -1,10 +0,0 @@
-module Sqlite
-  class InvalidTestParser
-
-    include Sqlite::CommonTestParser
-
-    def parse(test)
-      raise I18n.t('message.failure.tests.types', type: test.type)
-    end
-  end
-end

data/lib/parsers/query_test_parser.rb

@@ -1,21 +0,0 @@
-module Sqlite
-  class QueryTestParser
-
-    include Sqlite::CommonTestParser
-
-    # test = {
-    #   type: query,
-    #   seed: INSERT INTO ...,
-    #   expected: SELECT * FROM ...
-    # }
-    #
-    # return {
-    #   seed: INSERT INTO ...,
-    #   expected: SELECT * FROM ...
-    # }
-    def parse(test)
-      final_parse test
-    end
-
-  end
-end