pacing 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a8fc6f5350111b6fc551118c17dbd22eb496e7fe961b851b3b0c818ca28074
-  data.tar.gz: 3b19d2df9e4d3fd80d6b66fccf864a19a94ebcfbe337bf91bb7c5a030309694d
+  metadata.gz: a71bff11bdcc21f74452c5217d348302f8e3680e3c2ed9d753ba1acd156f4d4a
+  data.tar.gz: b78da81e0108e399aba1b422f56ce5509948d2708e8b6c5a011a0f82d91086fb
 SHA512:
-  metadata.gz: 3e5a7500a4873e8f7748052785fb914ad6b9b3a59c9f80df84a7a836346fe757da050fc81c369bd904184485c06da68757462874a8e25fcfac53b602f2db0f5b
-  data.tar.gz: 30f8e30fee65de76a98bc99b5e14ede8d94801647c3927e4aae2e43b73cc559797cd4f434f0d1c05b3bc4ac42b49d4021386fdbf791916d95eeba962c8123eea
+  metadata.gz: 87c3abd50e088736eae74610469c86972c2ec09c0e8da94d3c7e27dd02e34d62aef25ddab2acf602d90d46e8aefd515d3b1d6102fac37dd813bcbd24ef71f507
+  data.tar.gz: 98a2d9a5b3fc8bd62630273ead673bce8a2c2ec3667dd706b3e3ab8efdbdd6db95df39501d8ac0a08170db4b40d6c66439fad08f6937a8c1b61bc97051377c7e

data/README.md

@@ -1,6 +1,6 @@
 # Pacing
 
-Pacing is a tool that enables therapists to better manage and track their caseload. It is built for cases where there are therapy frequency limitations that need to be adhered to. For example, in the case of an [IEP (Individualized Education Program)](https://ambiki.com/glossary-concepts/iep), 504 plan, or a Services plan. This gem helps to calculate remaining visits as well as a therapist's current pace to meet visit mandates.
+Pacing is a tool that enables therapists to better manage and track their caseload. It is built for cases where there are therapy frequency limitations that need to be adhered to. For example, in the case of an [IEP (Individualized Education Program)](https://ambiki.com/glossary-concepts/iep), 504 plan, or a Service plan. This gem helps to calculate remaining visits as well as a therapist's current pace to meet visit mandates.
 
 - 🐇 Ahead of pace
 - 😁 On pace
@@ -31,7 +31,7 @@ gem 'pacing'
 school_plan = {
   school_plan_services: [
     {
-      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Services Plan' )
+      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Service Plan' )
       start_date: "01-01-2022", # string (mm-dd-yyyy)
       end_date: "01-01-2023", # string (mm-dd-yyyy)
       type_of_service: "Language Therapy", # string ('Language Therapy', 'Speech Therapy', 'Occupation Therapy', 'Physical Therapy', 'Feeding Therapy', 'Speech and Language Therapy')
@@ -43,7 +43,7 @@ school_plan = {
       interval_for_extra_sessions_allowable: "monthly", # string ('weekly', 'monthly', 'yearly')
     },
     {
-      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Services Plan' )
+      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Service Plan' )
       start_date: "01-01-2022", # string (mm-dd-yyyy)
       end_date: "01-01-2023", # string (mm-dd-yyyy)
       type_of_service: "Physical Therapy", # string ('Language Therapy', 'Speech Therapy', 'Occupation Therapy', 'Physical Therapy', 'Feeding Therapy', 'Speech and Language Therapy')
@@ -116,8 +116,29 @@ paced.calculate
     }
   ]
 =end
+
+paced.interval # Return current interval start and end dates
+
+# Below is the result you will get
+=begin
+=> [
+  {
+    discipline: 'Speech Therapy',
+    start_date: '04-01-2022',
+    reset_date: '05-01-2022'
+  },
+  {
+    discipline: 'Physical Therapy',
+    start_date: '04-01-2022',
+    reset_date: '05-01-2022'
+  }
+]
+# =>
+=end
 ```
 
+Interval `start_date` and `end_date`'s are different from start and end dates for the service. Here they define the start and end dates under evaluation in a specific interval, be it `month`, `week`, or `year`. They represent when the bounds of an interval.
+
 It is important to note that the `pace` is hugely influenced by the `summer_holidays` period and the `mode` in which it is calculated.
 
 ## Data Types
@@ -155,7 +176,7 @@ The following list shows the various variables and what they consist of:
 
 - **IEP (Individualized Education Program)**: Individualized Education Programs (IEPs) are required by law for every student who receives special education services and are developed on an annual basis. The IEP is an educational document that the school generates. The therapist is bound to the frequency on the IEP, and the insurance companies will not pay for anything above or beyond what is on the IEP. It is a blueprint for a student’s special education experience in a public school. The plan must ensure that the child receives a free appropriate public education, (FAPE).
 - **504 Plan**: 504 plans are formal plans that schools develop to give kids with disabilities the support they need. That covers any condition that limits daily activities in a major way. These plans prevent discrimination and they protect the rights of kids with disabilities in school. They are covered under Section 504 of the Rehabilitation Act, a civil rights law.
-- **Services Plan**: A plan paid for by the local school district for students with disabilities who attend private schools. A services plan does not have to ensure a child is provided with FAPE (free appropriate public education). A services plan spells out the special education and related services the LEA will make available to a child. These services are provided at no cost to parents. But the student may not be able to receive these services at the private school. Instead, the LEA can require him to go to a public school for services like speech therapy sessions. [§34 CFR 300.130 through §300.144 of IDEA](https://sites.ed.gov/idea/files/CWD_Enrolled_by_Their_Parents_in_Private_Schools_11-16-06.pdf) is a specific section that describes how services are provided to kids in private school.
+- **Service Plan**: A plan paid for by the local school district for students with disabilities who attend private schools. A Service plan does not have to ensure a child is provided with FAPE (free appropriate public education). A Service plan spells out the special education and related services the LEA will make available to a child. These services are provided at no cost to parents. But the student may not be able to receive these services at the private school. Instead, the LEA can require him to go to a public school for services like speech therapy sessions. [§34 CFR 300.130 through §300.144 of IDEA](https://sites.ed.gov/idea/files/CWD_Enrolled_by_Their_Parents_in_Private_Schools_11-16-06.pdf) is a specific section that describes how services are provided to kids in private school.
 
 ## Testing
 

data/lib/pacing/error.rb

@@ -0,0 +1,75 @@
+require 'date'
+require 'holidays'
+
+module Pacing
+  class Error
+    attr_reader :school_plan, :date, :non_business_days, :state, :mode, :interval, :summer_holidays
+
+    def initialize(school_plan:, date:, non_business_days:, state: :us_tn, mode: :liberal, summer_holidays: [])
+      @school_plan = school_plan
+      @non_business_days = non_business_days
+      @date = date
+      @state = state
+      @mode = [:strict, :liberal].include?(mode) ? mode : :liberal
+
+      raise ArgumentError.new("You must pass in at least one school plan") if school_plan.nil?
+      raise TypeError.new("School plan must be a hash") if school_plan.class != Hash
+
+      raise ArgumentError.new('You must pass in a date') if date.nil?
+      raise TypeError.new("The date should be formatted as a string in the format mm-dd-yyyy") if date.class != String || !/(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])-(19|20)\d\d/.match?(date)
+      raise ArgumentError.new('Date must be within the interval range of the school plan') if !date_within_range
+
+      non_business_days.each do |non_business_day|
+        raise TypeError.new('"Non business days" dates should be formatted as a string in the format mm-dd-yyyy') if non_business_day.class != String || !/(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])-(19|20)\d\d/.match?(non_business_day)
+      end
+
+      school_plan[:school_plan_services].each do |school_plan_service|
+        raise TypeError.new("School plan type must be a string and cannot be nil") if school_plan_service[:school_plan_type].class != String || school_plan_service[:school_plan_type].nil?
+
+        raise ArgumentError.new("School plan services start and end dates can not be nil") if school_plan_service[:start_date].nil? || school_plan_service[:end_date].nil?
+
+        raise TypeError.new("School plan services start and end dates should be formatted as a string in the format mm-dd-yyyy") if school_plan_service[:start_date].class != String || !/(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])-(19|20)\d\d/.match?(school_plan_service[:start_date])
+
+        raise TypeError.new("School plan services start and end dates should be formatted as a string in the format mm-dd-yyyy") if school_plan_service[:end_date].class != String || !/(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])-(19|20)\d\d/.match?(school_plan_service[:end_date])
+
+        raise TypeError.new("Type of service must be a string and cannot be nil") if school_plan_service[:type_of_service].class != String || school_plan_service[:type_of_service].nil?
+
+        raise TypeError.new("Frequency must be an integer and cannot be nil") if school_plan_service[:frequency].class != Integer || school_plan_service[:frequency].nil?
+
+        raise TypeError.new("Interval must be a string and cannot be nil") if school_plan_service[:interval].class != String || school_plan_service[:interval].nil?
+
+        raise TypeError.new("Time per session in minutes must be an integer and cannot be nil") if school_plan_service[:time_per_session_in_minutes].class != Integer || school_plan_service[:time_per_session_in_minutes].nil?
+
+        raise TypeError.new("Completed visits for current interval must be an integer and cannot be nil") if school_plan_service[:completed_visits_for_current_interval].class != Integer || school_plan_service[:completed_visits_for_current_interval].nil?
+
+        raise TypeError.new("Extra sessions allowable must be an integer and cannot be nil") if school_plan_service[:extra_sessions_allowable].class != Integer || school_plan_service[:extra_sessions_allowable].nil?
+
+        raise TypeError.new("Interval for extra sessions allowable must be a string and cannot be nil") if school_plan_service[:interval_for_extra_sessions_allowable].class != String || school_plan_service[:interval_for_extra_sessions_allowable].nil?
+      end
+    end
+
+    def date_within_range
+      valid_range_or_exceptions = false
+
+      begin
+        @school_plan[:school_plan_services].each do |school_plan_service|
+          if (parse_date(school_plan_service[:start_date]) < parse_date(@date) && parse_date(@date) < parse_date(school_plan_service[:end_date]))
+            valid_range_or_exceptions = true
+          end
+        end
+      rescue => exception
+        valid_range_or_exceptions = true
+      end
+
+      valid_range_or_exceptions
+    end
+
+    def parse_date(date)
+      begin
+        Date.strptime(date, '%m-%d-%Y')
+      rescue => exception
+      end
+    end
+  end
+end
+

data/lib/pacing/normalizer.rb

@@ -0,0 +1,210 @@
+require 'date'
+require 'holidays'
+
+module Pacing
+  class Normalizer
+
+    attr_accessor :services, :date
+
+    def initialize(services, date)
+      @date = date
+      @services = active_services(services)
+    end
+
+    def normalize
+      { school_plan_services: disciplines_cleaner([speech_discipline, occupational_discipline, physical_discipline, feeding_discipline]) }
+    end
+
+    def speech_discipline
+      discipline = {
+        :school_plan_type => 'IEP',
+        :start_date => "01-01-2100", # some arbitrary start date
+        :end_date => "01-01-2000", # some arbitrary end date
+        :type_of_service => 'Speech Therapy',
+        :frequency => 0,
+        :interval => '',
+        :time_per_session_in_minutes => 0,
+        :completed_visits_for_current_interval => 0,
+        :extra_sessions_allowable => 0,
+        :interval_for_extra_sessions_allowable => ''
+      }
+
+      discipline_services = services.filter do |service|
+        ["pragmatic language", "speech and language", "language", "speech", "language therapy", "speech therapy", "speech and language therapy", "speech language therapy"].include?(service[:type_of_service].downcase)
+      end
+      
+      return {} if discipline_services.empty?
+
+      discipline_services = normalize_to_monthly_frequency(discipline_services)
+
+      discipline_data(discipline_services, discipline)
+    end
+
+    def occupational_discipline
+      discipline = {
+        :school_plan_type => 'IEP',
+        :start_date => "01-01-2100", # some arbitrary start date
+        :end_date => "01-01-2000", # some arbitrary end date
+        :type_of_service => 'Occupational Therapy',
+        :frequency => 0,
+        :interval => '',
+        :time_per_session_in_minutes => 0,
+        :completed_visits_for_current_interval => 0,
+        :extra_sessions_allowable => 0,
+        :interval_for_extra_sessions_allowable => ''
+      }
+
+      discipline_services = services.filter do |service|
+        ["occupation therapy", "occupational therapy", "occupation"].include?(service[:type_of_service].downcase)
+      end
+      
+      return {} if discipline_services.empty?
+
+      discipline_services = normalize_to_monthly_frequency(discipline_services)
+
+      discipline_data(discipline_services, discipline)
+    end
+
+    def physical_discipline
+      discipline = {
+        :school_plan_type => 'IEP',
+        :start_date => "01-01-2100", # some arbitrary start date
+        :end_date => "01-01-2000", # some arbitrary end date
+        :type_of_service => 'Physical Therapy',
+        :frequency => 0,
+        :interval => '',
+        :time_per_session_in_minutes => 0,
+        :completed_visits_for_current_interval => 0,
+        :extra_sessions_allowable => 0,
+        :interval_for_extra_sessions_allowable => ''
+      }
+
+      discipline_services = services.filter do |service|
+        ["physical therapy", "physical"].include?(service[:type_of_service].downcase)
+      end
+      
+      return {} if discipline_services.empty?
+
+      discipline_services = normalize_to_monthly_frequency(discipline_services)
+
+      discipline_data(discipline_services, discipline)
+    end
+
+    def feeding_discipline
+      discipline = {
+        :school_plan_type => 'IEP',
+        :start_date => "01-01-2100", # some arbitrary start date
+        :end_date => "01-01-2000", # some arbitrary end date
+        :type_of_service => 'Feeding Therapy',
+        :frequency => 0,
+        :interval => '',
+        :time_per_session_in_minutes => 0,
+        :completed_visits_for_current_interval => 0,
+        :extra_sessions_allowable => 0,
+        :interval_for_extra_sessions_allowable => ''
+      }
+
+      discipline_services = services.filter do |service|
+        ["feeding therapy", "feeding"].include?(service[:type_of_service].downcase)
+      end
+      
+      return {} if discipline_services.empty?
+
+      discipline_services = normalize_to_monthly_frequency(discipline_services)
+
+      discipline_data(discipline_services, discipline)
+    end
+
+    def discipline_data(services, discipline)
+      services.each do |service|
+        discipline[:start_date] = parse_date(service[:start_date]) < parse_date(discipline[:start_date]) ? service[:start_date] : discipline[:start_date]
+
+        discipline[:end_date] = parse_date(service[:end_date]) > parse_date(discipline[:end_date]) ? service[:end_date] : discipline[:end_date]
+
+        discipline[:frequency] += service[:frequency].to_i
+
+        discipline[:completed_visits_for_current_interval] = service[:completed_visits_for_current_interval] if service[:completed_visits_for_current_interval] > discipline[:completed_visits_for_current_interval]
+
+        discipline[:time_per_session_in_minutes] = service[:time_per_session_in_minutes] > discipline[:time_per_session_in_minutes] ? service[:time_per_session_in_minutes] : discipline[:time_per_session_in_minutes]
+
+        discipline[:interval] = service[:interval]
+
+        discipline[:extra_sessions_allowable] += service[:extra_sessions_allowable].to_i
+
+        discipline[:interval_for_extra_sessions_allowable] = service[:interval_for_extra_sessions_allowable]
+      end
+
+      discipline
+    end
+
+    def same_interval(services)
+      interval = services[0].nil? ? "" : services[0][:interval]
+      same = true
+
+      services.each do |service|
+        if interval != service[:interval]
+          # puts "this happened for real? interval #{interval} and service interval #{service[:interval]} #{services}"
+          same = false
+        end
+      end
+
+      same
+    end
+
+    def normalize_to_monthly_frequency(services)
+      # average business days for each interval
+      interval_average_days = {
+        "weekly" => 5,
+        "monthly" => 22,
+        "yearly" => 210 # take away average holidays period with is 2.5 months
+      }
+
+      return services if same_interval(services)
+
+      services.map do |service|
+        if !(service[:interval] == "monthly")
+          # weekly(5 days) = frequency # weekly
+          # monthly(20 days) = frequency * monthly 
+          # yearly(200 days)
+
+          f = service[:frequency]
+
+          service[:frequency] = ((service[:frequency] * interval_average_days["monthly"].to_f) / interval_average_days[service[:interval]]).round
+
+          service[:interval] = "monthly"
+        end
+
+        service
+      end
+
+      services
+    end
+
+    def parse_date(date)
+      begin
+        Date.strptime(date, '%m-%d-%Y')
+      rescue => exception
+      end
+    end
+
+    def disciplines_cleaner(disciplines)
+      # use the fake arbitrary reset date to remove unrequired disciplines
+      disciplines.filter { |discipline| !discipline.empty? }
+    end
+
+    def active_services(services)
+      services.filter do |school_plan_service|
+        within = true
+        begin
+          if !(parse_date(school_plan_service[:start_date]) <= parse_date(date) && parse_date(date) <= parse_date(school_plan_service[:end_date]))
+            within = false
+          end
+        rescue => exception
+        end
+
+        within
+      end
+    end
+  end
+end
+