radiant-race_results-extension 1.0.1

data/README.md

@@ -0,0 +1,8 @@
+# Race Results
+
+This extension was writting to process and display the results of fell races. It should work for any timed event, including those with intermediate checkpoints. I don't expect it to be of interest to anyone else so I haven't bothered much with documentation or convenience: if you think you'd like to use it please let me know and I'll write it up properly.
+
+# Author
+
+William Ross for spanner
+will at spanner dot org, or messages via github are welcome.

data/Rakefile

@@ -0,0 +1,137 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-race_results-extension"
+    gem.summary = %Q{Race results analysis and presentation for the Radiant CMS}
+    gem.description = %Q{Makes easy the uploading, analysis and display of race results. Built for fell races but should work for most timed or score events including those with checkpoints.}
+    gem.email = "will@spanner.org"
+    gem.homepage = "http://github.com/radiant/radiant-race_results-extension"
+    gem.authors = ["spanner"]
+    gem.add_dependency "radiant", ">= 0.9.0"
+    gem.add_dependency "radiant-layouts-extension"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package event_calendar as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the race_results extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RaceResultsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the race_results extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/admin/race_clubs_controller.rb

@@ -0,0 +1,15 @@
+class Admin::RaceClubsController < Admin::ResourceController
+  helper :races
+  before_filter :get_club, :only => [:edit, :update, :delete]
+  before_filter :make_club, :only => [:new, :create]
+
+protected
+
+  def get_club
+    @race_club = RaceClub.find(params[:id])
+  end
+
+  def make_club
+    @race_club = RaceClub.new(params[:race_club])
+  end
+end

data/app/controllers/admin/race_competitors_controller.rb

@@ -0,0 +1,15 @@
+class Admin::RaceCompetitorsController < Admin::ResourceController
+  helper :races
+  before_filter :get_competitor, :only => [:edit, :update, :delete]
+  before_filter :make_competitor, :only => [:new, :create]
+
+protected
+
+  def get_competitor
+    @race_competitor = RaceCompetitor.find(params[:id])
+  end
+
+  def make_competitor
+    @race_competitor = RaceCompetitor.new(params[:race_competitor])
+  end
+end

data/app/controllers/admin/race_instances_controller.rb

@@ -0,0 +1,17 @@
+class Admin::RaceInstancesController < Admin::ResourceController
+  
+protected
+
+  def continue_url(options)
+    admin_races_url
+  end
+
+  def load_model
+    @race = Race.find_by_slug(params[:race_id])
+    self.model = if params[:id]
+      @race.instances.find_by_slug(params[:id])
+    else
+      @race.instances.build
+    end
+  end
+end

data/app/controllers/admin/races_controller.rb

@@ -0,0 +1,35 @@
+class Admin::RacesController < Admin::ResourceController
+  helper :races
+
+  def update
+    Rails.logger.warn "updating with #{params[model_symbol].inspect}"
+    model.update_attributes!(params[model_symbol])
+    response_for :update
+  end
+
+  def continue_url(options)
+    options[:redirect_to] || (params[:continue] ? {:action => 'edit', :id => model.slug} : {:action => "index"})
+  end
+
+  def load_model
+    Rails.logger.warn "loading model with id #{params[:id].inspect}"
+    
+    self.model = if params[:id]
+      model_class.find(params[:id])
+    else
+      model_class.new
+    end
+  end
+
+protected
+
+  def load_model
+    self.model = if params[:id]
+      model_class.find_by_slug(params[:id])
+    else
+      model_class.new
+    end
+  end
+  
+  
+end

data/app/controllers/race_instances_controller.rb

@@ -0,0 +1,23 @@
+class RaceInstancesController < ApplicationController
+  radiant_layout { |controller| controller.layout_for :races }
+  no_login_required
+  before_filter :get_race, :only => :show
+
+  def show
+    @instance = @race.instances.find_by_slug(params[:slug])
+    @performances = @instance.performances
+    if params[:club] && @club = RaceClub.find(params[:club])
+      @performances = @performances.by_members_of(@club)
+    end
+    if params[:cat] && @category = @instance.categories.find_by_name(params[:cat])
+      @performances = @performances.eligible_for_category(@category)
+    end
+  end
+
+private
+
+  def get_race
+    @race = Race.find_by_slug(params[:race_slug])
+  end
+
+end

data/app/controllers/race_performances_controller.rb

@@ -0,0 +1,16 @@
+class RacePerformancesController < ApplicationController
+  radiant_layout { |controller| controller.layout_for :races }
+  no_login_required
+  before_filter :get_race, :only => :show
+
+  def show
+    @performance = @race.performances.find(params[:id])
+  end
+
+private
+
+  def get_race
+    @race = Race.find(params[:race_id])
+  end
+
+end

data/app/controllers/races_controller.rb

@@ -0,0 +1,13 @@
+class RacesController < ApplicationController
+  radiant_layout { |controller| controller.layout_for :races }
+  no_login_required
+
+  def show
+    @race = Race.find_by_slug(params[:slug])
+  end
+  
+  def index
+    @races = Race.all.paginate(pagination_parameters)
+  end
+
+end

data/app/helpers/races_helper.rb

@@ -0,0 +1,38 @@
+module RacesHelper
+
+  #
+  # Support methods for nested forms lifted from http://transfs.com/devblog/2009/06/26/nested-forms-with-rails-2-3-helpers-and-javascript-tricks/
+  #
+  
+  def link_to_new_nested_form(name, form_builder, method, options = {})
+    klass = form_builder.object.class.reflect_on_association(method).klass
+    Rails.logger.warn "!!  link_to_new_nested_form: klass is #{klass.inspect}"
+    options[:object] ||= klass.new
+    options[:partial] ||= method.to_s.singularize
+    options[:form_builder_local] ||= :f
+    options[:element_id] ||= method.to_s
+    options[:position] ||= :bottom
+    link_to_function name do |page|
+      html = generate_nested_form(form_builder,
+                    method,
+                    :object => options[:object],
+                    :partial => options[:partial],
+                    :form_builder_local => options[:form_builder_local]
+                   )
+      page << %{
+        $('#{options[:element_id]}').insert({ #{options[:position]}: "#{ escape_javascript html }".replace(/NEW_RECORD/g, new Date().getTime()) });
+      }
+    end
+  end
+
+  def generate_nested_form(form_builder, method, options = {})
+    options[:object] ||= form_builder.object.class.reflect_on_association(method).klass.new
+    options[:partial] ||= method.to_s.singularize
+    options[:form_builder_local] ||= :f
+ 
+    form_builder.fields_for(method, options[:object], :child_index => 'NEW_RECORD') do |f|
+      render(:partial => options[:partial], :locals => { options[:form_builder_local] => f })
+    end
+  end
+
+end

data/app/models/race.rb

@@ -0,0 +1,64 @@
+class Race < ActiveRecord::Base
+  
+  has_site if respond_to? :has_site
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  has_many :instances, :class_name => 'RaceInstance'
+
+  has_many :records, :class_name => 'RaceRecord'
+  accepts_nested_attributes_for :records, :allow_destroy => true
+
+  has_many :checkpoints, :class_name => 'RaceCheckpoint'
+  accepts_nested_attributes_for :checkpoints, :allow_destroy => true
+  
+  belongs_to :picture_asset, :class_name => 'Asset'
+  accepts_nested_attributes_for :picture_asset, :allow_destroy => true
+
+  belongs_to :map_asset, :class_name => 'Asset'
+  accepts_nested_attributes_for :map_asset, :allow_destroy => true
+
+  validates_presence_of :name, :slug
+  validates_uniqueness_of :name, :slug
+  validates_length_of :slug, :maximum => 100, :message => '{{count}}-character limit'
+  validates_format_of :slug, :with => %r{^([-_.A-Za-z0-9]*|)$}, :message => 'not URL-friendly'
+
+  object_id_attr :filter, TextFilter
+
+  default_scope :order => 'name ASC'
+
+  def to_param
+    slug
+  end
+
+  def latest
+    instances.past.first   # they sort by start time desc
+  end
+
+  def in(name)
+    instances.find_by_name(name)
+  end
+  
+  def next
+    instances.future.first
+  end
+  
+  def record(category_name="M")
+    category = RaceCategory.find_or_create_by_normalized_name(category_name)
+    if new_record?
+      self.records.build(:race_category => category)
+    else 
+      RaceRecord.find_or_create_by_race_id_and_race_category_id(self.id, category.id)
+    end
+  end
+  
+  def checkpoint_before(cp)
+    checkpoints.at(checkpoints.index(cp) - 1) if checkpoints.contain?(cp) and checkpoints.first != cp
+  end
+
+  def checkpoint_after(cp)
+    checkpoints.at(checkpoints.index(cp) + 1) if checkpoints.contain?(cp) and checkpoints.last != cp
+  end
+  
+
+end
+

data/app/models/race_category.rb

@@ -0,0 +1,114 @@
+class RaceCategory < ActiveRecord::Base
+  
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  validates_presence_of :name
+  
+  # RaceCategory.within returns the list of categories (including this one) in which performances are eligible for prizes
+  # in this category. Eg. for MV50 the list will include MV50, MV60 and MV70.
+  
+  named_scope :within, lambda {|category|
+    category = RaceCategory.find_by_name(category) unless category.is_a? RaceCategory
+    conditions = []
+    bound = {}
+    if category.age_above
+      conditions.push "race_categories.age_above >= :above"
+      bound[:above] = category.age_above
+    end
+    if category.age_below
+      conditions.push "race_categories.age_below <= :below"
+      bound[:below] = category.age_below
+    end
+    if category.gender
+      conditions.push "race_categories.gender = :gender"
+      bound[:gender] = category.gender
+    end
+    
+    { :conditions => [conditions.join(' AND '), bound] }
+  }
+  
+  # RaceCategory.containing returns the list of categories in which a performance in this category is eligible for prizes
+  # eg. for MV50, the list will include M, MV40 and MV50.
+  # The list will always include both the passed category and any category of the right gender that has no other restrictions
+
+  named_scope :containing, lambda {|category|
+    category = RaceCategory.find_by_name(category) unless category.is_a? RaceCategory
+    conditions = []
+    bound = {}
+    if category.gender
+      conditions.push "(race_categories.gender = :gender)"
+      bound[:gender] = category.gender
+    end
+    if category.age_above
+      conditions.push "(race_categories.age_above IS NULL OR race_categories.age_above <= :above)"
+      bound[:above] = category.age_above
+    else
+      conditions.push "(race_categories.age_above IS NULL)"
+    end
+    if category.age_below
+      conditions.push "(race_categories.age_below IS NULL OR race_categories.age_below >= :below)"
+      bound[:below] = category.age_below
+    else
+      conditions.push "(race_categories.age_below IS NULL)"
+    end
+
+    { :conditions => [conditions.join(' AND '), bound] }
+  }
+  
+  default_scope :order => 'name ASC'
+
+  def to_param
+    name
+  end
+
+  def self.find_or_create_by_normalized_name(name)
+    name = normalized_name(name)
+    unless category = find_by_name(name)
+      category = new(:name => name)
+      if matches = name.match(/^([A-Z]+)(\d*)$/)
+        if matches[2] 
+          category.send(matches[1].match(/U/) ? :age_below= : :age_above=, matches[2])
+        end
+        category.gender = matches[1].match(/L/) ? "F" : "M"
+      end
+      category.save!
+    end
+    category
+  end
+  
+protected
+  
+  def self.normalized_name(name)
+    name.gsub!(/\W*/, '')
+    return "M" if name.blank?
+    name.upcase!
+    case name
+    when /M(\d\d)/
+      "MV#{$1}"
+    when /L(\d\d)/
+      "LV#{$1}"
+    when "F"
+      "L"
+    when /F(\d\d)/
+      "LV#{$1}"
+    when /FV(\d\d)/
+      "LV#{$1}"
+    when /FU(\d\d)/
+      "LU#{$1}"
+    when "W"
+      "L"
+    when /W(\d\d)/
+      "LV#{$1}"
+    when /WV(\d\d)/
+      "LV#{$1}"
+    when /WU(\d\d)/
+      "LU#{$1}"
+    when "", nil
+      "M"
+    else
+      name
+    end
+  end
+
+end
+

data/app/models/race_checkpoint.rb

@@ -0,0 +1,31 @@
+class RaceCheckpoint < ActiveRecord::Base
+  
+  has_site if respond_to? :has_site
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  belongs_to :race
+  acts_as_list :scope => :race_id
+  has_many :times, :class_name => 'RaceCheckpointTime'
+
+  default_scope :order => :position
+
+  named_scope :in, lambda {|race|
+    {
+      :conditions => ['race_id = ?', race.id]
+    }
+  }
+  
+  def previous
+    race.checkpoint_before(self)
+  end
+
+  def next
+    race.checkpoint_after(self)
+  end
+
+  def self.find_by_normalized_name(name)
+    find_by_name(name.gsub(/\s+/, "_").downcase)
+  end
+
+end
+

data/app/models/race_checkpoint_time.rb

@@ -0,0 +1,64 @@
+class RaceCheckpointTime < ActiveRecord::Base
+  
+  has_site if respond_to? :has_site
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  belongs_to :performance, :class_name => 'RacePerformance'
+  belongs_to :checkpoint, :class_name => 'RaceCheckpoint'
+  # delegate :race_instance, :category, :competitor, :club, :to => :performance
+
+  # validates_presence_of :checkpoint, :performance
+  
+  named_scope :time_at, lambda {|checkpoint|
+    {
+      :conditions => ["race_checkpoint_id = ?", checkpoint.id]
+    }
+  }
+
+  named_scope :time_in, lambda {|instance|
+    {
+      :joins => "INNER JOIN race_performances as performances ON race_checkpoint_times.race_performance_id = performances.id",  
+      :conditions => ["performances.race_instance_id = ?", instance.id]
+    }
+  }
+
+  named_scope :quicker_than, lambda {|duration|
+    {
+      :conditions => ["elapsed_time < ?", duration]
+    }
+  }
+
+  def position
+    checkpoint.times.in(race_instance).quicker_than(duration).count + 1
+  end
+  
+  def elapsed_time
+    if s = read_attribute(:elapsed_time)
+      s.to_timecode
+    else
+      ""
+    end
+  end
+  
+  def elapsed_time=(time)
+    write_attribute(:elapsed_time, time.seconds)    # numbers will pass through unchanged. strings will be timecode-parsed
+  end
+  
+  def previous
+    performance.checkpoint_times.time_at(checkpoint.previous) if checkpoint.previous
+  end
+  
+  def previous_position
+    if previous
+      previous.position
+    else
+      1
+    end
+  end
+  
+  def gain
+    sprintf('+%d', position - previous_position)
+  end
+
+end
+

data/app/models/race_club.rb

@@ -0,0 +1,48 @@
+class RaceClub < ActiveRecord::Base
+  
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  has_many :performances, :class_name => 'RacePerformance'
+  has_many :competitors, :class_name => 'RaceCompetitor'
+
+  has_many :other_names, :class_name => 'RaceClubAlias'
+  accepts_nested_attributes_for :other_names, :allow_destroy => true
+
+  validates_presence_of :name
+  default_scope :order => 'name ASC'
+  
+  named_scope :by_name_or_alias, lambda { |name|
+    {
+      :select => 'race_clubs.*',
+      :joins => "LEFT JOIN race_club_aliases AS aliases ON aliases.race_club_id = race_clubs.id",
+      :conditions => ["race_clubs.name LIKE :name OR aliases.name LIKE :name", {:name => "#{normalize_name(name)}%"}],
+      :group => "race_clubs.id"
+    }
+  }
+  
+  def self.find_by_any_name(name)
+    by_name_or_alias(name).first
+  end
+
+  def self.find_or_create_by_any_name(name=nil)
+    name = normalize_name(name)
+    return if name.blank?
+    return if %w{unattached ua u/a}.include? name.downcase
+    unless club = find_by_any_name(name) 
+      club = new(:name => name)
+      club.save!
+    end
+    club
+  end
+  
+  #TODO make this a lot more UTF-friendly:
+  # strip control characters and excel mmska without losing accents and symbols?
+  
+  def self.normalize_name(name="")
+    name.gsub!(/\B&\B/, "and")
+    name.gsub!(/\s+/, " ")
+    name.gsub!(/[^A-Za-z -,]/, "")
+    name.strip
+  end
+
+end

data/app/models/race_club_alias.rb

@@ -0,0 +1,9 @@
+class RaceClubAlias < ActiveRecord::Base
+  
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  belongs_to :club, :class_name => 'RaceClub'
+
+  validates_presence_of :name
+end
+

data/app/models/race_competitor.rb

@@ -0,0 +1,20 @@
+class RaceCompetitor < ActiveRecord::Base
+  
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  belongs_to :reader
+  belongs_to :race_club#, :class_name => 'RaceClub'
+  has_many :performances, :class_name => 'RacePerformance'
+  default_scope :order => 'name ASC'
+  
+  def club
+    race_club
+  end
+  
+  def self.find_or_create_by_name_and_club(name="", club=nil)
+    return if name.blank?
+    club_id = club.nil? ? nil : club.id
+    find_or_create_by_name_and_race_club_id(name, club_id)
+  end
+end
+