mumuki-text-runner 1.0.0 → 1.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjRkYTVjMzc2MmM5NTExNDE4ZjgwMTIxMTk4ZDM3M2E1MWYwYTJkMw==
-  data.tar.gz: !binary |-
-    ZGVhMjUxYWNjYmQwZTAyZGMwYzcxZjM4MGE0MzM1NzQ2ZGQ3M2Q4ZA==
+SHA256:
+  metadata.gz: 43678016289325cc51c7f82a3c3696d8113641032b2c1b97f4a68ce4835bc3c6
+  data.tar.gz: b237d0b7ec9d0fe5e8dc110accf493fbd17ac35d55bb3f2e14856b1f277922f9
 SHA512:
-  metadata.gz: !binary |-
-    Y2RmMjgxNzEzMmQ4NzFkM2JjMGEzMTQ1NzI2NzA5ZDc2N2UyNmNjMTVhYzQ2
-    ZWVjNTlmNWM0YjIzMzMwMzlkYmJhM2QwY2RkOTgwNGQ3OWU3ZTVkOTIxYzE1
-    NDRmNDNjOTkzMDQ2MjNjY2RhNTZjMGQ2YWZhNGQ4OTFiMDZiY2Q=
-  data.tar.gz: !binary |-
-    MzBjNTIxMzEzZjBiZmVlODI4ZjlmYTg5ODdjMjlmYmY2Y2E0OWMzODI4Y2U3
-    YmQzMTM2NWExYzFhOGIzY2FkODYyZjcyM2I2YThiMWFkNzk0NmJhYTY1NWRk
-    YWE2YzY5MDk1MTk4ZDM0OTM1NzFkYTlkZWYxMzYzMjFkODViYzg=
+  metadata.gz: 134703fbbf89aa87c224e1efa93752e7f7681b82586ce56325b31cd342ac72fda98ba38136a747b54e9e635068e372f0236fe837caa569f6b1072048719e4371
+  data.tar.gz: a224bb63533f2f352c4a4be7cfa51ea9030a6fe7c3d0258bfb15a63f711678994fa60007207ee1823960c0dc1b60b9ccda5ac0d339c395400de98abc42e02f2e

data/lib/checker.rb

@@ -1,7 +1,39 @@
 class TextChecker < Mumukit::Metatest::Checker
-  def check_equal(test, config)
-    actual = test[:source]
-    comparer = EqualityComparer.new(config)
-    fail comparer.locale_error_message unless comparer.satisfies?(actual)
+  require_relative './comparators/comparator'
+  require_relative './comparators/equality_comparator'
+  require_relative './comparators/contain_comparator'
+  require_relative './comparators/regexp_comparator'
+  require_relative './comparators/valid_ip_comparator'
+
+  require_relative './options/ignore_whitespace'
+  require_relative './options/ignore_case'
+
+  COMPARATORS = {
+    match: TextChecker::RegexpComparator,
+    equal: TextChecker::EqualityComparator,
+    contain: TextChecker::ContainComparator,
+    valid_ip: TextChecker::ValidIpComparator
+  }
+
+  def check_assertion(key, input, config, example)
+    if key == :keys
+      check_keys input, config, example
+    else
+      check_comparators key, input, config
+    end
+  end
+
+  def check_comparators(key, input, config)
+    COMPARATORS[key]
+        .new(config.is_a?(Hash) ? config : {expected: config})
+        .compare(input[:source])
+        .try { |error| fail error }
+  end
+
+  def check_keys(input, config, example)
+    source_hash = YAML.load(input[:source]).with_indifferent_access
+      config.each do |subkey, subconfig|
+        check_assertions({source: source_hash[subkey]}, subconfig, example)
+    end
   end
 end

data/lib/comparators/comparator.rb

@@ -0,0 +1,26 @@
+class TextChecker::Comparator
+  def initialize(config = {})
+    @config = config
+  end
+
+  def compare(source)
+    @config[:error] || error_message(source) unless success?(transform(source))
+  end
+
+  def expected
+    transform @config[:expected]
+  end
+
+  private
+
+  def modifiers
+    modifiers = []
+    modifiers << TextChecker::IgnoreWhitespace if @config[:ignore_whitespace]
+    modifiers << TextChecker::IgnoreCase if @config[:ignore_case]
+    modifiers
+  end
+
+  def transform(source)
+    modifiers.inject(source) { |text, modifier| modifier.apply(text) }
+  end
+end

data/lib/comparators/contain_comparator.rb

@@ -0,0 +1,12 @@
+class TextChecker::ContainComparator < TextChecker::Comparator
+
+  def success?(source)
+    source.include? expected.to_s
+  end
+
+  private
+
+  def error_message(source)
+    I18n.t 'contain.failure', actual: source
+  end
+end

data/lib/comparators/equality_comparator.rb

@@ -0,0 +1,12 @@
+class TextChecker::EqualityComparator < TextChecker::Comparator
+
+  def success?(source)
+    source == expected.to_s
+  end
+
+  private
+
+  def error_message(source)
+    I18n.t 'equality.failure', actual: source
+  end
+end

data/lib/comparators/regexp_comparator.rb

@@ -0,0 +1,13 @@
+class TextChecker::RegexpComparator < TextChecker::Comparator
+
+  def success?(source)
+    !!Regexp.new(expected).match(source)
+  end
+
+  private
+
+
+  def error_message(source)
+    I18n.t 'expression.failure', actual: source
+  end
+end

data/lib/comparators/valid_ip_comparator.rb

@@ -0,0 +1,14 @@
+class TextChecker::ValidIpComparator < TextChecker::Comparator
+
+    def success?(source)
+      !!REGEXP.match(source)
+    end
+
+  private
+
+  REGEXP = /^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/i
+
+  def error_message(source)
+    I18n.t 'valid_ip.failure', actual: source
+  end
+end

data/lib/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  equality:
+    failure: '**%{actual}** is not the right value.'
+  contain:
+    failure: '**%{actual}** does not contain the right value.'
+  expression:
+      failure: '**%{actual}** does not match the expected expression.'
+  valid_ip:
+    failure: '**%{actual}** is not a valid IP address.'

data/lib/locales/es.yml

@@ -0,0 +1,9 @@
+es:
+  equality:
+    failure: '**%{actual}** no es el valor correcto.'
+  contain:
+    failure: '**%{actual}** no contiene el valor correcto.'
+  expression:
+    failure: '**%{actual}** no coincide con la expresión correcta.'
+  valid_ip:
+    failure: '**%{actual}** no es una dirección IP válida.'

data/lib/metadata_hook.rb

@@ -1,13 +1,15 @@
 class TextMetadataHook < Mumukit::Hook
   def metadata
-    { language: {
-      name: 'text',
-      icon: { type: 'devicon', name: 'code' },
-      extension: 'txt',
+    {
+      language: {
+        name: 'text',
+        icon: { type: 'devicon', name: 'code' },
+        extension: 'txt',
+      },
       test_framework: {
         name: 'text',
         test_extension: 'yml'
       }
-    } }
+    }
   end
 end

data/lib/options/ignore_case.rb

@@ -1,7 +1,5 @@
-module IgnoreCase
-  class << self
-    def apply(text)
-      text.downcase
-    end
+module TextChecker::IgnoreCase
+  def self.apply(text)
+    text.downcase
   end
 end

data/lib/options/ignore_whitespace.rb

@@ -1,7 +1,5 @@
-module IgnoreWhitespace
-  class << self
-    def apply(text)
-      text.delete(' ')
-    end
+module TextChecker::IgnoreWhitespace
+  def self.apply(text)
+    text.delete(' ')
   end
 end

data/lib/test_hook.rb

@@ -17,6 +17,24 @@ class TextTestHook < Mumukit::Hook
   end
 
   def parse_test(tests)
-    YAML.load(tests).map { |example| example.deep_symbolize_keys }
+    parsed_test = YAML.load(tests)
+    if parsed_test.is_a? Array
+      parse_multi_scenario_test(parsed_test)
+    else
+      parse_single_scenario_test(parsed_test)
+    end
+  end
+
+  def parse_single_scenario_test(parsed_test)
+    [{ name: 'test',
+       postconditions: { equal: {
+           expected: parsed_test['equal'],
+           ignore_case: parsed_test['ignore_case'].present?,
+           ignore_whitespace: parsed_test['ignore_whitespace'].present? } }
+     }]
+  end
+
+  def parse_multi_scenario_test(parsed_test)
+    parsed_test.map { |example| example.deep_symbolize_keys }
   end
 end

data/lib/text_runner.rb

@@ -1,20 +1,15 @@
 require 'mumukit'
 require 'yaml'
-require 'i18n'
-require 'active_support/all'
+
+I18n.load_translations_path File.join(__dir__, 'locales', '*.yml')
 
 Mumukit.runner_name = 'text'
 Mumukit.configure do |config|
   config.content_type = 'markdown'
 end
 
-I18n.load_path += Dir[File.join('.', 'locales', '*.yml')]
-
+require_relative './version_hook'
 require_relative './metadata_hook'
 require_relative './test_hook'
 
 require_relative './checker'
-
-require_relative './comparers/equality_comparer'
-require_relative './options/ignore_whitespace'
-require_relative './options/ignore_case'

data/lib/version_hook.rb

@@ -0,0 +1,3 @@
+module TextVersionHook
+  VERSION = '1.4.0'
+end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-text-runner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.27'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mumukit-bridge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
 description: 
 email:
 - franco@mumuki.org
@@ -102,12 +116,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/checker.rb
-- lib/comparers/equality_comparer.rb
+- lib/comparators/comparator.rb
+- lib/comparators/contain_comparator.rb
+- lib/comparators/equality_comparator.rb
+- lib/comparators/regexp_comparator.rb
+- lib/comparators/valid_ip_comparator.rb
+- lib/locales/en.yml
+- lib/locales/es.yml
 - lib/metadata_hook.rb
 - lib/options/ignore_case.rb
 - lib/options/ignore_whitespace.rb
 - lib/test_hook.rb
 - lib/text_runner.rb
+- lib/version_hook.rb
 homepage: http://github.com/mumuki/mumuki-text-server
 licenses:
 - MIT
@@ -118,17 +139,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Text Runner for Mumuki

data/lib/comparers/equality_comparer.rb

@@ -1,29 +0,0 @@
-class EqualityComparer
-  def initialize(config)
-    opts = config
-    opts = { expected: config } unless config.is_a? Hash
-    @expected = opts[:expected]
-    parse_options(opts)
-  end
-
-  def satisfies?(source)
-    @actual = transform(source)
-    @actual == @expected
-  end
-
-  def locale_error_message
-    I18n.t 'equality.failure', actual: @actual
-  end
-
-  private
-
-  def transform(source)
-    @modifiers.inject(source) { |text, modifier| modifier.apply(text) }
-  end
-
-  def parse_options(config)
-    @modifiers = []
-    @modifiers << IgnoreWhitespace if config[:ignore_whitespace]
-    @modifiers << IgnoreCase if config[:ignore_case]
-  end
-end