school_year 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbe56e5041f75f9252c4fd8a5741618213ba65ab03bb34eda204ba093f27416a
+  data.tar.gz: 45250bf23366d3be3f6f4adbc0e60937a732a297a80a82bb8968f15edb899660
+SHA512:
+  metadata.gz: be0817cb9558ba5280f61743f81fd83d471bcc2d42fcd15d01dfed2bfd0d293f8674c672860a55b405a2469e8e01b6acde49c022a76bc1e88f8c375c038ee339
+  data.tar.gz: b907542a1b22368aecded760581ba3ea68faec635d85d2b14117c971f112ad6ea3154cce7463a57a45c573277c5e4e16907adc21e8697bfff57850d6d848bcce

data/lib/school_year.rb

@@ -0,0 +1,53 @@
+require 'date'
+
+class SchoolYear
+class << self
+
+  def grade_to_graduation_year(grade, academic_year=academic_year(Date.today))
+    return nil unless (0..12).include? grade
+    academic_year + (12 - grade)
+  end
+
+  def grade_to_year(grade, standard_graduation_year)
+    standard_graduation_year - 12 + grade
+  end
+
+  def year_to_grade(year, standard_graduation_year)
+    year + 12 - standard_graduation_year
+  end
+
+  def academic_year(date)
+    date.year + (date.month < 7 ? 0 : 1)
+  end
+
+  def grade_on_date(date, standard_graduation_year)
+    year_to_grade(academic_year(date), standard_graduation_year)
+  end
+
+  def default_first_day_of_school(academic_year_or_date)
+    if academic_year_or_date.class == Integer
+      Date.new(academic_year_or_date - 1, 9, 1)
+    elsif academic_year_or_date.class == Date
+      Date.new(academic_year_or_date.year - (academic_year_or_date.month < 7 ? 1 : 0), 9, 1)
+    end
+  end
+
+  def default_last_day_of_school(academic_year_or_date)
+    if academic_year_or_date.class == Integer
+      Date.new(academic_year_or_date, 6, 15)
+    elsif academic_year_or_date.class == Date
+      Date.new(academic_year_or_date.year + (academic_year_or_date.month < 7 ? 0 : 1), 6, 15)
+    end
+  end
+
+  def school_days_elapsed(date = nil, first_attendance_day = nil)
+    if date
+      first_attendance_day ||= default_first_day_of_school(date)
+      (date - first_attendance_day) * 5 / 7.0
+    else
+      (default_last_day_of_school(1901) - default_first_day_of_school(1901)) * 5 / 7.0 # 1901 in order to miss leap year
+    end
+  end
+
+end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: school_year
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Peter Kirwin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-02 00:00:00.000000000 Z
+dependencies: []
+description: "\n    # School Year\n    Simple logic for translating between academic
+  year and grade for a student\n\n    ## Sample Usage\n    `SchoolYear.grade_to_graduation_year(grade,
+  academic_year)` determines the graduation year for a student based on their grade
+  and the academic year    `SchoolYear.grade_to_year(grade, graduation_year)` determines
+  the calendar year from the student's grade based on the graduation year\n    `SchoolYear.year_to_grade(year,
+  graduation_year)` determines the student's grade from the calendar year based on
+  the graduation year\n    `SchoolYear.default_first_day_of_school(academic_year_or_date)`
+  determines the first day of school (as September 1st) based on an integer representing
+  the academic year (e.g., 1998), or a date (e.g., '1998-04-04'.to_date)\n    `SchoolYear.default_last_day_of_school(academic_year_or_date)`
+  determines the last day of school (as June 15th) based on an integer representing
+  the academic year (e.g., 1998), or a date (e.g., '1998-04-04'.to_date)\n    `SchoolYear.school_days_elapsed(date,
+  first_attendace_day)` determines the approximate number of days elapsed from the
+  first_attendance_day to the date. Both arguments can be blank: if date is blank,
+  the approximate number of total days in the 1901 school year will be returned.\n
+  \   "
+email: peter@puzzlesandwich.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/school_year.rb
+homepage: http://www.puzzlesandwich.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key:
+specification_version: 4
+summary: School Year Logic
+test_files: []