sciolyff 0.9.1 → 0.10.0

data/lib/sciolyff/validator.rb

@@ -21,13 +21,13 @@ module SciolyFF
       @checkers = {}
     end
 
-    def valid?(rep_or_file)
+    def valid?(rep_or_yaml)
       @logger.flush
 
-      if rep_or_file.instance_of? String
-        valid_file?(rep_or_file, @logger)
+      if rep_or_yaml.instance_of? String
+        valid_yaml?(rep_or_yaml, @logger)
       else
-        valid_rep?(rep_or_file, @logger)
+        valid_rep?(rep_or_yaml, @logger)
       end
     end
 
@@ -49,14 +49,14 @@ module SciolyFF
       result
     end
 
-    def valid_file?(path, logger)
-      rep = YAML.safe_load(
-        File.read(path),
+    def valid_yaml?(yaml, logger)
+      rep = Psych.safe_load(
+        yaml,
         permitted_classes: [Date],
         symbolize_names: true
       )
     rescue StandardError => e
-      logger.error "could not read file as YAML:\n#{e.message}"
+      logger.error "could not read input as YAML:\n#{e.message}"
     else
       valid_rep?(rep, logger)
     end
@@ -80,7 +80,7 @@ module SciolyFF
     end
 
     def check(klass, top_level_rep, rep, logger)
-      @checkers[klass] ||= klass.new top_level_rep
+      @checkers[klass] ||= klass.new top_level_rep, logger
       checks = klass.instance_methods - Checker.instance_methods
       checks.map { |im| @checkers[klass].send im, rep, logger }.all?
     end

data/lib/sciolyff/validator/checker.rb

@@ -6,6 +6,19 @@ module SciolyFF
   class Validator::Checker
     def initialize(rep); end
 
+    # Wraps initialize for child classes
+    module SafeInitialize
+      def initialize(rep, logger)
+        super rep
+      rescue StandardError => e
+        logger.debug "#{e}\n  #{e.backtrace.first}"
+      end
+    end
+
+    def self.inherited(subclass)
+      subclass.prepend SafeInitialize
+    end
+
     # wraps method calls (always using send in Validator) so that exceptions
     # in the check cause check to pass, as what caused the exception should
     # cause some other check to fail if the SciolyFF is truly invalid

data/lib/sciolyff/validator/events.rb

@@ -32,7 +32,7 @@ module SciolyFF
     end
 
     def placings_for_all_teams?(event, logger)
-      count = @placings[event[:name]].count
+      count = @placings[event[:name]]&.count || 0
       return true if count == @teams
 
       logger.error "'event: #{event[:name]}' has incorrect number of "\

data/lib/sciolyff/validator/placings.rb

@@ -78,6 +78,13 @@ module SciolyFF
         "#{placing_log(placing)}"
     end
 
+    def having_a_tie_makes_sense?(placing, logger)
+      return true unless placing.key?(:tie) && placing[:raw]
+
+      logger.error 'having a tie value does make sense for '\
+        "#{placing_log(placing)}"
+    end
+
     def possible_participated_disqualified_combination?(placing, logger)
       return true unless placing[:participated] == false &&
                          placing[:disqualified]

data/lib/sciolyff/validator/raws.rb

@@ -13,6 +13,7 @@ module SciolyFF
     }.freeze
 
     OPTIONAL = {
+      'tier': Integer,
       'tiebreaker rank': Integer
     }.freeze
   end

data/lib/sciolyff/validator/sections.rb

@@ -4,6 +4,12 @@ module SciolyFF
   # Generic tests for (sub-)sections and types. Including classes must have two
   # hashes REQUIRED and OPTIONAL (see other files in this dir for examples)
   module Validator::Sections
+    def rep_is_hash?(rep, logger)
+      return true if rep.instance_of? Hash
+
+      logger.error "entry in #{section_name} is not a Hash"
+    end
+
     def all_required_sections?(rep, logger)
       missing = self.class::REQUIRED.keys - rep.keys
       return true if missing.empty?
@@ -22,11 +28,25 @@ module SciolyFF
       correct_types = self.class::REQUIRED.merge self.class::OPTIONAL
       rep.all? do |key, value|
         correct = correct_types[key]
-        next true if (correct.instance_of?(Array) && correct.include?(value)) ||
-                     (value.instance_of? correct)
+        next true if
+        (correct.instance_of?(Array) && correct.include?(value)) ||
+        (correct.instance_of?(Class) && value.instance_of?(correct)) ||
+        correct_date?(correct, value)
 
         logger.error "#{key}: #{value} is not #{correct}"
       end
     end
+
+    private
+
+    def correct_date?(correct, value)
+      correct == Date && Date.parse(value)
+    rescue StandardError
+      false
+    end
+
+    def section_name
+      self.class.to_s.split('::').last
+    end
   end
 end

data/sciolyff.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.authors  = ['Em Zhan']
+  s.homepage = 'https://github.com/zqianem/sciolyff'
+  s.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.start_with? 'examples/', '.'
+  end
+  s.license  = 'MIT'
+  s.name     = 'sciolyff'
+  s.summary  = 'A file format for Science Olympiad tournament results.'
+  s.version  = '0.10.0'
+  s.executables << 'sciolyff'
+  s.add_runtime_dependency 'erubi', '~> 1.9'
+  s.add_runtime_dependency 'optimist', '~> 3.0'
+  s.add_runtime_dependency 'psych', '~> 3.1'
+  s.required_ruby_version = '>= 2.5'
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sciolyff
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Em Zhan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.1'
 description: 
 email: 
 executables:
@@ -45,6 +59,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - bin/sciolyff
 - lib/sciolyff.rb
 - lib/sciolyff/interpreter.rb
@@ -71,6 +87,7 @@ files:
 - lib/sciolyff/validator/teams.rb
 - lib/sciolyff/validator/top_level.rb
 - lib/sciolyff/validator/tournament.rb
+- sciolyff.gemspec
 homepage: https://github.com/zqianem/sciolyff
 licenses:
 - MIT
@@ -83,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="