submission_rule.rb

class SubmissionRule < ActiveRecord::Base

  class InvalidRuleType < Exception
    def initialize(rule_name)
      super I18n.t('assignment.not_valid_submission_rule', type: rule_name)
    end
  end

  belongs_to :assignment
  has_many :periods, dependent: :destroy, order: 'id'
  accepts_nested_attributes_for :periods, allow_destroy: true
  attr_accessible :type

#  validates_associated :assignment
#  validates_presence_of :assignment

  def self.descendants
    [NoLateSubmissionRule,
     PenaltyPeriodSubmissionRule,
     PenaltyDecayPeriodSubmissionRule,
     GracePeriodSubmissionRule]
  end

  def can_collect_now?
    return @can_collect_now if !@can_collect_now.nil?
    @can_collect_now = Time.zone.now >= get_collection_time
  end

  def can_collect_grouping_now?(grouping)
    Time.zone.now >= calculate_grouping_collection_time(grouping)
  end

  # Cache that allows us to quickly get collection time
  def get_collection_time
    return @get_collection_time if !@get_collection_time.nil?
    @get_collection_time = calculate_collection_time
  end
  
  def calculate_collection_time
    assignment.latest_due_date + hours_sum.hours
  end

  def calculate_grouping_collection_time(grouping)
    if grouping.inviter.section
      SectionDueDate.due_date_for(grouping.inviter.section,
                                         assignment)
    else
      assignment.due_date + hours_sum.hours
    end
  end

  # When Students commit code after the collection time, MarkUs should warn
  # the Students with a message saying that the due date has passed, and the
  # work they're submitting will probably not be graded
  def commit_after_collection_message
    #I18n.t 'submission_rules.submission_rule.commit_after_collection_message'
    raise NotImplementedError.new('SubmissionRule:  commit_after_collection_message not implemented')
  end

  # When Students view the File Manager after the collection time,
  # MarkUs should warnthe Students with a message saying that the
  # due date has passed, and that any work they're submitting will
  # probably not be graded
  def after_collection_message
    raise NotImplementedError.new('SubmissionRule:  after_collection_message not implemented')
  end

  # When we're past the due date, the File Manager for the students will display
  # a message to tell them that they're currently past the due date.
  def overtime_message
    raise NotImplementedError.new('SubmissionRule: overtime_message not implemented')
  end

  # Returns true or false based on whether the attached Assignment's properties
  # will work with this particular SubmissionRule
  def assignment_valid?
    raise NotImplementedError.new('SubmissionRule: assignment_valid? not implemented')
  end

  # Takes a Submission (with an attached Result), and based on the properties of
  # this SubmissionRule, applies penalties to the Result - for example, will
  # add an ExtraMark of a negative value, or perhaps add the use of a Grace Day.
  def apply_submission_rule(submission)
    raise NotImplementedError.new('SubmissionRule:  apply_submission_rule not implemented')
  end

  def description_of_rule
    raise NotImplementedError.new('SubmissionRule:  description_of_rule not implemented')
  end

  def grader_tab_partial(grouping)
    raise NotImplementedError.new('SubmissionRule:  render_grader_tab not implemented')
  end

  def reset_collection_time
    @get_collection_time = nil
    @can_collect_now = nil
  end

  private

  def calculate_overtime_hours_from(from_time)
    overtime_hours = ((from_time - assignment.due_date) / 1.hour).ceil
    # If the overtime is less than 0, that means it was submitted early, so
    # just return 0 - otherwise, return overtime_hours.
    [0, overtime_hours].max
  end

  def hours_sum
    0
  end

end