sciolyff 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d439db52050ce2e14cdefb6e5d2520d1105dbea5dbe49a4cf5a5e83323a30bd
-  data.tar.gz: 1f6611b0af9696973430b849c5241a61ef9d23fa254db9cba12b4b08d3c8647d
+  metadata.gz: 64f19b6f05fc3a19ae643aa8c783561f094ddd93959021b77eda3ad437ec9f6d
+  data.tar.gz: e0359c5b02d570f75d068ae5d4b0dd2965d0bece8acfa7451b6cc29acfe19cb7
 SHA512:
-  metadata.gz: 2901fb2fdb8e8e7aa26e9cc97cd1c2c0989d1cc18233f1cd9b038c724dae54530b64be62d812abc03a753f92bed46763df2d487a7b377471d9559bfc809049d9
-  data.tar.gz: 61b9fca3f88e142116e211cf576b6751d98e99ba7a464433a96af2ec401b9f6a71acf4879ea247f6612965a65e5672b81264790e812cfb8006252e128190879c
+  metadata.gz: dfacd78064019cebf1be0d4cf7351965eb6dd134d2457a1f00d8ed26babb535c94d292d90b9cb6f21f04350faa8b9d96745bdb61d05b8c00806e8a4fbde57df6
+  data.tar.gz: 51e0a6fd2deaa74b1f0692e7a39a4d2712bef21f3a4f92b322d205219ac58d2dd0102ba438c2a6b085850d2d23885ee1d95386f67c81c5c66d355b4c7bef2db0

data/bin/sciolyff

@@ -6,7 +6,7 @@ require 'yaml'
 require 'sciolyff'
 
 opts = Optimist.options do
-  version 'sciolyff 0.5.3'
+  version 'sciolyff 0.6.0'
   banner <<~STRING
     Checks if a given file is in the Scioly File Format
 

data/lib/sciolyff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'date'
 require 'sciolyff/top_level'
 require 'sciolyff/sections'
 require 'sciolyff/tournament'
@@ -9,6 +10,7 @@ require 'sciolyff/teams'
 require 'sciolyff/placings'
 require 'sciolyff/scores'
 require 'sciolyff/penalties'
+require 'sciolyff/interpreter'
 
 # API methods for the Scioly File Format
 #
@@ -46,6 +48,8 @@ module SciolyFF
 
   STRING
 
+  # Deprecated: Please use `SciolyFF::Interpreter` instead
+  #
   # Wrapper class around a SciolyFF Ruby object representation with utility
   # methods to help in displaying results
   class Helper
@@ -53,6 +57,9 @@ module SciolyFF
     attr_reader :placings_by_event, :placings_by_team, :penalties_by_team
 
     def initialize(rep)
+      warn 'Class `SciolyFF::Helper` is deprecated. '\
+           'Please use `SciolyFF::Interpreter` instead.'
+
       @rep = rep
       @exhibition_teams_count = rep[:Teams].count { |t| t[:exhibition] }
       @exempt_placings_count = rep[:Placings].count { |p| p[:exempt] }

data/lib/sciolyff/interpreter.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module SciolyFF
+  # Interprets the YAML representation of a SciolyFF file through objects that
+  # respond to idiomatic Ruby method calls
+  class Interpreter
+    require 'sciolyff/interpreter/tournament'
+    require 'sciolyff/interpreter/event'
+    require 'sciolyff/interpreter/team'
+    require 'sciolyff/interpreter/placing'
+    require 'sciolyff/interpreter/penalty'
+
+    attr_reader :tournament, :events, :teams, :placings, :penalties
+
+    def initialize(rep)
+      create_models(rep)
+      link_models(self)
+
+      sort_events_naturally
+      sort_teams_by_rank
+
+      freeze_models
+    end
+
+    private
+
+    def create_models(rep)
+      @tournament = Tournament.new(rep)
+      @events    = map_array_to_models rep[:Events],    Event,   rep
+      @teams     = map_array_to_models rep[:Teams],     Team,    rep
+      @placings  = map_array_to_models rep[:Placings],  Placing, rep
+      @penalties = map_array_to_models rep[:Penalties], Penalty, rep
+    end
+
+    def map_array_to_models(arr, object_class, rep)
+      return [] if arr.nil?
+
+      arr.map.with_index { |_, index| object_class.new(rep, index) }
+    end
+
+    def link_models(interpreter)
+      # models have to linked in reverse order because reasons
+      @penalties.each { |m| m.link_to_other_models(interpreter) }
+      @placings .each { |m| m.link_to_other_models(interpreter) }
+      @teams    .each { |m| m.link_to_other_models(interpreter) }
+      @events   .each { |m| m.link_to_other_models(interpreter) }
+      @tournament.link_to_other_models(interpreter)
+    end
+
+    def freeze_models
+      @events.freeze
+      @teams.freeze
+      @placings.freeze
+      @penalties.freeze
+    end
+
+    def sort_events_naturally
+      @events.sort! do |a, b|
+        next  1 if  a.trial? && !b.trial?
+        next -1 if !a.trial? &&  b.trial?
+
+        a.name <=> b.name
+      end
+    end
+
+    def sort_teams_by_rank
+      @teams.sort! do |team_a, team_b|
+        next  1 if  team_a.exhibition? && !team_b.exhibition?
+        next -1 if !team_a.exhibition? &&  team_b.exhibition?
+
+        cmp = team_a.points <=> team_b.points
+        cmp.zero? ? break_tie(team_a, team_b) : cmp
+      end
+    end
+
+    def break_tie(team_a, team_b)
+      team_a.medal_counts
+            .zip(team_b.medal_counts)
+            .map { |counts| counts.last - counts.first }
+            .find(proc { break_second_tie(team_a, team_b) }, &:nonzero?)
+    end
+
+    def break_second_tie(team_a, team_b)
+      cmp = team_a.trial_event_points <=> team_b.trial_event_points
+      cmp.zero? ? break_third_tie(team_a, team_b) : cmp
+    end
+
+    def break_third_tie(team_a, team_b)
+      team_a.trial_event_medal_counts
+            .zip(team_b.trial_event_medal_counts)
+            .map { |counts| counts.last - counts.first }
+            .find(proc { team_a.number <=> team_b.number }, &:nonzero?)
+    end
+  end
+end

data/lib/sciolyff/interpreter/event.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'sciolyff/interpreter/model'
+
+module SciolyFF
+  # Models an instance of a Science Olympiad event at a specific tournament
+  class Interpreter::Event < Interpreter::Model
+    def link_to_other_models(interpreter)
+      super
+      @placings = interpreter.placings.select { |p| p.event == self }
+      @placings_by_team =
+        @placings.group_by(&:team).transform_values!(&:first)
+
+      @placings.freeze
+    end
+
+    attr_reader :placings
+
+    def name
+      @rep[:name]
+    end
+
+    def trial?
+      @rep[:trial] == true
+    end
+
+    def trialed?
+      @rep[:trialed] == true
+    end
+
+    def high_score_wins?
+      @rep[:scoring] == 'high'
+    end
+
+    def low_score_wins?
+      !high_score_wins?
+    end
+
+    def placing_for(team)
+      @placings_by_team[team]
+    end
+
+    def competing_teams
+      return placings.map(&:team) if trial?
+
+      placings.map(&:team).reject(&:exhibition?)
+    end
+  end
+end

data/lib/sciolyff/interpreter/model.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SciolyFF
+  # Parent class for other nested classes within Interpreter
+  class Interpreter::Model
+    def initialize(rep, index)
+      @rep = rep[pluralize_for_key(self.class)][index]
+      @cache = {}
+    end
+
+    def link_to_other_models(interpreter)
+      @tournament = interpreter.tournament
+    end
+
+    attr_reader :tournament
+
+    # prevents infinite loop due caused by intentional circular references
+    def inspect
+      to_s.delete_suffix('>') + " @rep=#{@rep}>"
+    end
+
+    private
+
+    def pluralize_for_key(klass)
+      name = klass.name.split('::').last
+      name = name.delete_suffix('y') + 'ie' if name.end_with?('y')
+      (name + 's').to_sym
+    end
+  end
+end

data/lib/sciolyff/interpreter/penalty.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'sciolyff/interpreter/model'
+
+module SciolyFF
+  # Models a team penalty for a Science Olympiad team at a tournament
+  class Interpreter::Penalty < Interpreter::Model
+    def link_to_other_models(interpreter)
+      super
+      @team = interpreter.teams.find { |t| t.number == @rep[:team] }
+    end
+
+    attr_reader :team
+
+    def points
+      @rep[:points]
+    end
+  end
+end

data/lib/sciolyff/interpreter/placing.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'sciolyff/interpreter/model'
+
+module SciolyFF
+  # Models the result of a team participating (or not) in an event
+  class Interpreter::Placing < Interpreter::Model
+    def link_to_other_models(interpreter)
+      super
+      @event = interpreter.events.find { |e| e.name   == @rep[:event] }
+      @team  = interpreter.teams .find { |t| t.number == @rep[:team]  }
+    end
+
+    attr_reader :event, :team
+
+    def participated?
+      @rep[:participated] == true || @rep[:participated].nil?
+    end
+
+    def disqualified?
+      @rep[:disqualified] == true
+    end
+
+    def exempt?
+      @rep[:exempt] == true
+    end
+
+    def unknown?
+      @rep[:unknown] == true
+    end
+
+    def tie?
+      @rep[:tie] == true
+    end
+
+    def place
+      @rep[:place]
+    end
+
+    def did_not_participate?
+      !participated? && !disqualified?
+    end
+
+    def participation_only?
+      participated? && !place && !unknown?
+    end
+
+    def points
+      return @cache[:points] if @cache[:points]
+
+      n = event.competing_teams.count
+
+      @cache[:points] =
+        if    disqualified?        then n + 2
+        elsif did_not_participate? then n + 1
+        elsif participation_only?  then n
+        elsif unknown?             then n - 1
+        else  calculate_points
+        end
+    end
+
+    def considered_for_team_points?
+      !(event.trial? || event.trialed? || exempt?)
+    end
+
+    private
+
+    def calculate_points
+      return place if event.trial?
+
+      place - event.placings.count do |p|
+        (p.exempt? || p.team.exhibition?) &&
+          p.place &&
+          p.place < place
+      end
+    end
+  end
+end

data/lib/sciolyff/interpreter/team.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'sciolyff/interpreter/model'
+
+module SciolyFF
+  # Models an instance of a Science Olympiad team at a specific tournament
+  class Interpreter::Team < Interpreter::Model
+    def link_to_other_models(interpreter)
+      super
+      @placings  = interpreter.placings .select { |p| p.team == self }
+      @penalties = interpreter.penalties.select { |p| p.team == self }
+      @placings_by_event =
+        @placings.group_by(&:event).transform_values!(&:first)
+
+      @placings.freeze
+      @penalties.freeze
+    end
+
+    attr_reader :placings, :penalties
+
+    def school
+      @rep[:school]
+    end
+
+    def school_abbreviation
+      @rep[:'school abbreviation']
+    end
+
+    def suffix
+      @rep[:suffix]
+    end
+
+    def subdivision
+      @rep[:subdivision]
+    end
+
+    def exhibition?
+      @rep[:exhibition] == true
+    end
+
+    def number
+      @rep[:number]
+    end
+
+    def city
+      @rep[:city]
+    end
+
+    def state
+      @rep[:state]
+    end
+
+    def placing_for(event)
+      @placings_by_event[event]
+    end
+
+    def rank
+      @tournament.teams.find_index(self) + 1
+    end
+
+    def points
+      return @cache[:points] if @cache[:points]
+
+      counted_placings = placings.select(&:considered_for_team_points?)
+
+      if @tournament.worst_placings_dropped?
+        counted_placings
+          .sort!(&:points)
+          .reverse!
+          .drop!(@tournament.worst_placings_dropped)
+      end
+
+      @cache[:points] =
+        counted_placings.sum(&:points) + penalties.sum(&:points)
+    end
+
+    def trial_event_points
+      placings.select { |p| p.event.trial? }.sum(&:points)
+    end
+
+    def medal_counts
+      (1..@tournament.max_points_per_event).map do |medal_points|
+        placings.select(&:considered_for_team_points?)
+                .count { |p| p.points == medal_points }
+      end
+    end
+
+    def trial_event_medal_counts
+      (1..@tournament.max_points_per_event(trial: true)).map do |medal_points|
+        placings.select { |p| p.event.trial? }
+                .count { |p| p.points == medal_points }
+      end
+    end
+  end
+end

data/lib/sciolyff/interpreter/tournament.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'sciolyff/interpreter/model'
+
+module SciolyFF
+  # Models a Science Olympiad tournament
+  class Interpreter::Tournament < Interpreter::Model
+    def initialize(rep)
+      @rep = rep[:Tournament]
+    end
+
+    def link_to_other_models(interpreter)
+      @events = interpreter.events
+      @teams = interpreter.teams
+      @placings = interpreter.placings
+      @penalties = interpreter.penalties
+    end
+
+    attr_reader :events, :teams, :placings, :penalties
+
+    undef tournament
+
+    def name
+      @rep[:name]
+    end
+
+    def short_name
+      @rep[:'short name']
+    end
+
+    def location
+      @rep[:location]
+    end
+
+    def level
+      @rep[:level]
+    end
+
+    def state
+      @rep[:state]
+    end
+
+    def division
+      @rep[:division]
+    end
+
+    def year
+      @rep[:year]
+    end
+
+    def date
+      @rep[:date]
+    end
+
+    def worst_placings_dropped?
+      @rep[:'worst placings dropped'].instance_of? Integer
+    end
+
+    def worst_placings_dropped
+      return 0 unless @rep[:'worst placings dropped']
+
+      @rep[:'worst placings dropped']
+    end
+
+    def max_points_per_event(trial: false)
+      return @teams.size + 2 if trial
+
+      @teams.count { |t| !t.exhibition? } + 2
+    end
+  end
+end

data/lib/sciolyff/interpreter/ztestscript.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'sciolyff/interpreter'
+require 'sciolyff'
+require 'pp'
+
+FILENAME = '/home/qianm/Repositories/unosmium/unosmium.org/data/2019-04-27_OH_states_b.yaml'
+
+rep = YAML.safe_load(File.read(FILENAME), symbolize_names: true); nil
+interpreter = SciolyFF::Interpreter.new(rep)
+# helper = SciolyFF::Helper.new(rep)
+# helper.sort_teams_by_rank
+
+pp interpreter.teams.map { |t| "#{t.number} #{t.school} #{t.points}" }
+
+p interpreter.teams.first.medal_counts
+
+p interpreter.teams.find { |t| t.number == 1 }.rank
+
+# puts interpreter.teams.find { |t| t.exhibition? }.placings.map(&:points)

data/lib/sciolyff/placings.rb

@@ -101,8 +101,9 @@ module SciolyFF
         event = SciolyFF.rep[:Events].find do |e|
           e[:name] == placing[:event]
         end
-        assert event[:trial] || event[:trialed] || event.nil?,
-               'Cannot have unknown place for non-trial/trialed event'
+        assert event[:trial] || event[:trialed] || placing[:exempt],
+               'Cannot have unknown place for non-trial/trialed event '\
+               'or non-exempt place'
       end
     end
 
@@ -171,7 +172,7 @@ module SciolyFF
                    .select { |p| p[:team] == team[:number] }
                    .map { |p| p[:event] }
 
-        assert_equal events, events_with_placings
+        assert_equal events.sort, events_with_placings.sort
       end
     end
   end

data/lib/sciolyff/scores.rb

@@ -66,17 +66,13 @@ module SciolyFF
 
     def test_each_score_has_valid_exempt
       @scores.select { |s| s.instance_of? Hash }.each do |score|
-        if score.key? :exempt
-          assert_includes [true, false], score[:exempt]
-        end
+        assert_includes [true, false], score[:exempt] if score.key? :exempt
       end
     end
 
     def test_each_score_has_valid_unknown
       @scores.select { |s| s.instance_of? Hash }.each do |score|
-        if score.key? :unknown
-          assert_includes [true, false], score[:unknown]
-        end
+        assert_includes [true, false], score[:unknown] if score.key? :unknown
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sciolyff
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Em Zhan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -62,6 +62,14 @@ files:
 - bin/sciolyff
 - lib/sciolyff.rb
 - lib/sciolyff/events.rb
+- lib/sciolyff/interpreter.rb
+- lib/sciolyff/interpreter/event.rb
+- lib/sciolyff/interpreter/model.rb
+- lib/sciolyff/interpreter/penalty.rb
+- lib/sciolyff/interpreter/placing.rb
+- lib/sciolyff/interpreter/team.rb
+- lib/sciolyff/interpreter/tournament.rb
+- lib/sciolyff/interpreter/ztestscript.rb
 - lib/sciolyff/penalties.rb
 - lib/sciolyff/placings.rb
 - lib/sciolyff/scores.rb
@@ -88,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A file format for Science Olympiad tournament results.