sciolyff-duosmium 0.13.0

data/lib/sciolyff/validator/top_level.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'sciolyff/validator/checker'
+require 'sciolyff/validator/sections'
+
+module SciolyFF
+  # Top-level sections of a SciolyFF file
+  class Validator::TopLevel < Validator::Checker
+    include Validator::Sections
+
+    REQUIRED = {
+      Tournament: Hash,
+      Events: Array,
+      Teams: Array,
+      Placings: Array
+    }.freeze
+
+    OPTIONAL = {
+      Subdivisions: Array,
+      Penalties: Array
+    }.freeze
+  end
+end

data/lib/sciolyff/validator/tournament.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'sciolyff/validator/checker'
+require 'sciolyff/validator/sections'
+require 'sciolyff/validator/range'
+
+module SciolyFF
+  # Checks for Tournament section of a SciolyFF file
+  class Validator::Tournament < Validator::Checker
+    include Validator::Sections
+
+    REQUIRED = {
+      location: String,
+      level: %w[Invitational Regionals States Nationals],
+      division: %w[A B C],
+      year: Integer
+    }.freeze
+
+    OPTIONAL = {
+      name: String,
+      state: String,
+      medals: Integer,
+      trophies: Integer,
+      bids: Integer,
+      'bids per school': Integer,
+      'short name': String,
+      'worst placings dropped': Integer,
+      'exempt placings': Integer,
+      'maximum place': Integer,
+      'per-event n': %w[place participation],
+      'n offset': Integer,
+      date: Date,
+      'start date': Date,
+      'end date': Date,
+      'awards date': Date
+    }.freeze
+
+    def initialize(rep)
+      @maximum_place = rep[:Teams].count { |t| !t[:exhibition] }
+      @schools_count = rep[:Teams].uniq do |t|
+        [t[:school], t[:city], t[:state]]
+      end.count
+    end
+
+    def name_for_not_states_or_nationals?(tournament, logger)
+      level = tournament[:level]
+      return true if %w[States Nationals].include?(level) || tournament[:name]
+
+      logger.error 'name for Tournament required '\
+        "('level: #{level}' is not States or Nationals)"
+    end
+
+    def state_for_not_nationals?(tournament, logger)
+      return true if tournament[:level] == 'Nationals' || tournament[:state]
+
+      logger.error 'state for Tournament required '\
+        "('level: #{tournament[:level]}' is not Nationals)"
+    end
+
+    def bids_for_regionals_or_states?(tournament, logger)
+      level = tournament[:level]
+
+      if %w[Regionals States].include?(level)
+        return true if tournament.key? :bids
+
+        logger.warn "field 'bids:' recommended for level: #{level}"
+      else
+        return true unless tournament.key? :bids
+
+        logger.error "bids: does not make sense for level: #{level}"
+      end
+    end
+
+    def bids_per_school_positive?(tournament, logger)
+      bids = tournament[:'bids per school']
+      return true if bids.nil? || tournament[:'bids per school'].positive?
+
+      logger.error "'bids per school: #{bids}' is not positive"
+    end
+
+    def bids_per_school_relevant?(tournament, logger)
+      return true unless tournament[:'bids per school'] &&
+                         !tournament.key?(:bids)
+
+      logger.error "field 'bids per school:' not relevant without field 'bids:'"
+    end
+
+    def short_name_is_relevant?(tournament, logger)
+      return true unless tournament[:'short name'] && !tournament[:name]
+
+      logger.error "'short name: #{tournament[:'short name']}' for Tournament "\
+        "requires a normal 'name:' as well"
+    end
+
+    def short_name_is_short?(tournament, logger)
+      return true if tournament[:'short name'].nil? ||
+                     tournament[:'short name'].length < tournament[:name].length
+
+      logger.error "'short name: #{tournament[:'short name']}' for Tournament "\
+        "is longer than normal 'name: #{tournament[:name]}'"
+    end
+
+    include Validator::Range
+
+    def n_offset_within_range?(tournament, logger)
+      # not a perfect check, can still have event maximum place be lower
+      # probably should add warning for use of n offset anyways?
+      min = -[@maximum_place, tournament[:'maximum place']].compact.min
+      within_range?(tournament, :'n offset', logger, min, Float::INFINITY)
+    end
+
+    def maximum_place_within_range?(tournament, logger)
+      within_range?(tournament, :'maximum place', logger, 1, @maximum_place)
+    end
+
+    def medals_within_range?(tournament, logger)
+      max = [@maximum_place, tournament[:'maximum place']].compact.min
+      within_range?(tournament, :medals, logger, 1, max)
+    end
+
+    def trophies_within_range?(tournament, logger)
+      within_range?(tournament, :trophies, logger, 1, @maximum_place)
+    end
+
+    def bids_within_range?(tournament, logger)
+      within_range?(tournament, :bids, logger, 1, @schools_count)
+    end
+
+    def date_included?(tournament, logger)
+      if !tournament[:date].is_a?(Date) || (!tournament[:'start date'].is_a?(Date) && !tournament[:'end date'].is_a?(Date))
+        return true
+      end
+
+      logger.error 'You need either a date for the tournament (if it took place in one day) '\
+        'or beginning and end dates (if it took place over the course of multiple days).'
+    end
+  end
+end

data/sciolyff.gemspec

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sciolyff-duosmium
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: ruby
+authors:
+- Em Zhan
+- Shreyas Mayya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-12 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description:
+email:
+executables:
+- sciolyff
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/sciolyff
+- lib/sciolyff.rb
+- lib/sciolyff/interpreter.rb
+- lib/sciolyff/interpreter/bids.rb
+- lib/sciolyff/interpreter/event.rb
+- lib/sciolyff/interpreter/html.rb
+- lib/sciolyff/interpreter/html/helpers.rb
+- lib/sciolyff/interpreter/html/main.css
+- lib/sciolyff/interpreter/html/main.js
+- lib/sciolyff/interpreter/html/template.html.erb
+- lib/sciolyff/interpreter/model.rb
+- lib/sciolyff/interpreter/penalty.rb
+- lib/sciolyff/interpreter/placing.rb
+- lib/sciolyff/interpreter/raw.rb
+- lib/sciolyff/interpreter/subdivisions.rb
+- lib/sciolyff/interpreter/team.rb
+- lib/sciolyff/interpreter/tiebreaks.rb
+- lib/sciolyff/interpreter/tournament.rb
+- lib/sciolyff/validator.rb
+- lib/sciolyff/validator/canonical.rb
+- lib/sciolyff/validator/checker.rb
+- lib/sciolyff/validator/events.rb
+- lib/sciolyff/validator/logger.rb
+- lib/sciolyff/validator/penalties.rb
+- lib/sciolyff/validator/placings.rb
+- lib/sciolyff/validator/range.rb
+- lib/sciolyff/validator/raws.rb
+- lib/sciolyff/validator/sections.rb
+- lib/sciolyff/validator/subdivisions.rb
+- lib/sciolyff/validator/teams.rb
+- lib/sciolyff/validator/top_level.rb
+- lib/sciolyff/validator/tournament.rb
+- sciolyff.gemspec
+homepage: https://github.com/duosmium/sciolyff
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A file format for Science Olympiad tournament results.
+test_files: []