pacing 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9682bf40847898cd9daf1230c6c71306fd28286ed513450383e68236c667d305
-  data.tar.gz: 5fbdcdfbb13eca9854befe9e1aa297a6475cec918f8b1e87242fc419a05cadf6
+  metadata.gz: 3c9f1bb20d57079d96b0bf851745a047e274cc2ac91698dafb61ddc34800875d
+  data.tar.gz: b83584cd4d641299955cb4b28666d742e17d6ac90ab0168bdf9898e3b20f7307
 SHA512:
-  metadata.gz: d9299ed6be2821c309b056025559bc1fc871ef3de6554772d1ad590f92e2605089d769dc4bc24be937e207e33df462e7a5a1acb02aa43904458c6ba2ae7ce199
-  data.tar.gz: f0ab3cf08f73ae25b9caacf6a971bef108ca00068aa2a3f9d00bf57de22bf8c3ac26bb6a3e19924f7bf02d3d0c4766d80f1fcecc0e127a23c4e055e616d0892b
+  metadata.gz: 7f9df40d14c5428d64a4465930a675f803eb428d1ccc0602de23e591fd3225993c8c37b9e3437e1954885cd07584d29c7d447d93e2fda4d9d94df4cae0da60a6
+  data.tar.gz: ed423571438c677b40fde49964c6866fd63a40c763a93c2bcac563f9547c12ad64d5371a4ef705d97f35f2b7594b34dd00b0ee70d5951d29aec1ab05a3b19172

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+.vscode/launch.json

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "holidays", "~> 8.6"
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ambitious Idea Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,191 @@
+# 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.
+
++ 🐇 Ahead of pace
++ 😁 On pace
++ 🐢 Behind pace
+
+## Getting started
+
+**Ruby**
+
+*Supports Ruby x.x.x and above*
+```
+gem install pacing
+```
+
+**Ruby on Rails**
+
+Add this line to your application’s Gemfile:
+```ruby
+gem 'pacing'
+```
+
+## How it works
+
+```ruby
+
+school_plan = {
+  school_plan_services: [
+    {
+      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Services 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')
+      frequency: 6, # integer
+      interval: "monthly", # string ('weekly', 'monthly', 'yearly')
+      time_per_session_in_minutes: 30, # integer
+      completed_visits_for_current_interval: 7, # integer
+      extra_sessions_allowable: 1, # integer
+      interval_for_extra_sessions_allowable: "monthly", # string ('weekly', 'monthly', 'yearly')
+    },
+    {
+      school_plan_type: "IEP", # string ('IEP', '504 Plan', 'Services 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')
+      frequency: 6, # integer
+      interval: "monthly", # string ('weekly', 'monthly', 'yearly')
+      time_per_session_in_minutes: 30, # integer
+      completed_visits_for_current_interval: 7, # integer
+      extra_sessions_allowable: 1, # integer
+      interval_for_extra_sessions_allowable: "monthly", # string ('weekly', 'monthly', 'yearly')
+    }
+  ]
+}
+
+date = '01-22-2022' # string (mm-dd-yyyy)
+non_business_days = ['01-25-2022'] # array of strings (mm-dd-yyyy)
+paced = Pacing::Pacer.new(school_plan: school_plan, date: date, non_business_days: non_business_days)
+paced.calculate
+
+=begin
+=> {
+    school_plan_services: [
+      {
+        school_plan_type: "IEP",
+        start_date: "01-01-2022",
+        end_date: "01-01-2023",
+        type_of_service: "Language Therapy",
+        frequency: 6,
+        interval: "monthly",
+        time_per_session_in_minutes: 30,
+        completed_visits_for_current_interval: 7,
+        extra_sessions_allowable: 1,
+        interval_for_extra_sessions_allowable: "monthly",
+        pace: 3,
+        reset_date: "01-31-2022",
+        remaining_visits: 0,
+        pace_indicator: "🐇"
+      },
+      {
+        school_plan_type: "IEP",
+        start_date: "01-01-2022",
+        end_date: "01-01-2023",
+        type_of_service: "Physical Therapy",
+        frequency: 6,
+        interval: "monthly",
+        time_per_session_in_minutes: 30,
+        completed_visits_for_current_interval: 7,
+        extra_sessions_allowable: 1,
+        interval_for_extra_sessions_allowable: "monthly",
+        pace: 3,
+        reset_date: "01-31-2022",
+        remaining_visits: 0,
+        pace_indicator: "🐇"
+      }
+    ]
+  }
+=end
+
+```
+
+## Data Types
+
+Pacing accepts input which consists of a school_plan, a date and a non_business_day variable. The school_plan variable is a hash that includes the various school plan services that the client received, the date is a string and the non_business_days variable is an array of dates.
+
+The output received is a hash that contains all the necessary information that is useful to the user.
+
+The following list shows the various variables and what they consist of:
+
+1. Input
+   - `school_plan_type` is a string.
+   - `start_date` is a string.
+   - `end_date` is a string.
+   - `type_of_service` is a string.
+   - `frequency` is an integer.
+   - `interval` is a string.
+   - `time_per_session_in_minutes` is an integer.
+   - `extra_sessions_allowable` is an integer.
+   - `interval_for_extra_sessions_allowable` is a string.
+2. Output
+   - `school_plan_type` is a string.
+   - `start_date` is a string.
+   - `end_date` is a string.
+   - `type_of_service` is a string.
+   - `frequency` is an integer.
+   - `interval` is a string.
+   - `time_per_session_in_minutes` is an integer.
+   - `extra_sessions_allowable` is an integer.
+   - `interval_for_extra_sessions_allowable` is a string.
+   - `reset_date` is a string.
+   - `pace` is an integer.
+   - `pace_indicator` is a string.
+
+## Terminology
+
++ **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.
+
+## Testing
+
++ `bundle exec rspec`
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
++ [Report bugs](https://github.com/Ambiki/pacing/issues)
++ Fix bugs and [submit pull requests](https://github.com/Ambiki/pacing/pulls)
++ Write, clarify, or fix documentation
++ Suggest or add new features
+
+To get started with development:
+
+1. Fork it ( https://github.com/Ambiki/pacing/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Publishing
+
+1. gem build pacing.gemspec
+2. gem push pacing-x.x.x.gem
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2022 Ambitious Idea Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/pacing/pacer.rb

@@ -0,0 +1,215 @@
+require 'date'
+require 'holidays'
+
+module Pacing
+  class Pacer
+    COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    attr_reader :school_plan, :date, :non_business_days, :state
+
+    def initialize(school_plan:, date:, non_business_days:, state: :us_tn)
+      @school_plan = school_plan
+      @non_business_days = non_business_days
+      @date = date
+      @state = state
+
+      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)
+      
+      @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 calculate
+      services = @school_plan[:school_plan_services]
+
+      services = services.map do |service|
+        expected = expected_visits(start_date: parse_date(service[:start_date]), end_date: parse_date(service[:end_date]), frequency: service[:frequency], interval: service[:interval])
+
+        service[:pace] = pace(service[:completed_visits_for_current_interval], expected)
+        service[:reset_date] = reset_date(start_date: service[:start_date], interval: service[:interval_for_extra_sessions_allowable])
+        service[:remaining_visits] = remaining_visits(completed_visits: service[:completed_visits_for_current_interval], required_visits: service[:frequency])
+        service[:pace_indicator] = pace_indicator(service[:pace])
+
+        service
+      end
+
+      { school_plan_services: services }
+    end
+
+    # get a spreadout of visit dates over an interval by using simple proportion.
+    def expected_visits(start_date:, end_date:, frequency:, interval:)
+      reset_start = start_of_treatment_date(start_date, interval)
+
+      reset_end =  reset_start + interval_days(interval)
+
+      days_between = business_days(reset_start, reset_end).count
+
+      days_passed = business_days(reset_start, parse_date(@date)).count
+
+      if days_between != 0
+        return ((frequency/days_between.to_f) * days_passed).round
+      else
+        return 0
+      end
+    end
+
+    def interval_days(interval)
+      case interval
+      when "monthly"
+        return COMMON_YEAR_DAYS_IN_MONTH[(parse_date(@date)).month]
+      when "weekly"
+        return 6
+      when "yearly"
+        return parse_date(@date).leap? ? 366 : 365
+      end
+    end
+
+    def pace(actual_visits, expected_visits)
+      # Pace = actual visits at point in time - expected visits to meet frequency at that point in time
+      actual_visits - expected_visits
+    end
+
+    def pace_indicator(pace)
+      if pace == 0
+        return "😁"
+      elsif pace > 0
+        return "🐇"
+      elsif pace < 0
+        return "🐢"
+      end
+    end
+
+    def parse_date(date)
+      Date.strptime(date, '%m-%d-%Y')
+    end
+
+    def parsed_non_business_days
+      @non_business_days.map do |day|
+        parse_date(day)
+      end
+    end
+
+    # days on which a session can hold
+    def business_days(start_date, end_date)
+      # remove saturdays and sundays
+      # remove holidays(array from Ambiki)
+      # remove school holidays/non business days
+      # should we remove today?(datetime call?)
+      working_days = get_working_days(start_date, end_date)
+
+      holidays = get_holidays(start_date, end_date)
+      
+      working_days.sort - parsed_non_business_days.sort - holidays.sort
+    end
+
+    # scoped to the interval
+    def remaining_visits(completed_visits:, required_visits:)
+      visits = required_visits.to_i - completed_visits.to_i
+      visits = 0 if visits < 0
+      visits
+    end
+
+    # scoped to the interval
+    def reset_date(start_date:, interval:)
+      case interval
+      when "monthly"
+        return reset_date_monthly(start_date, interval)
+      when "weekly"
+        return reset_date_weekly(start_date, interval)
+      when "yearly"
+        return reset_date_yearly(start_date)
+      end
+    end
+
+    # scoped to the interval
+    def start_of_treatment_date(start_date, interval="monthly")
+      case interval
+      when "monthly"
+        return start_of_treatment_date_monthly(start_date)
+      when "weekly"
+        return start_of_treatment_date_weekly(start_date)
+      when "yearly"
+        return start_of_treatment_date_yearly(start_date)
+      end
+    end
+
+    def get_working_days(start_date, end_date)
+      (start_date..end_date).filter do |day|
+        !(day.saturday? || day.sunday?)
+      end
+    end
+
+    def get_holidays(start_date, end_date)
+      Holidays.between(start_date, end_date, @state).map { |holiday| holiday[:date] }
+    end
+
+    # get actual date of the first day of the week where date falls
+    def week_start(date, offset_from_sunday=0)
+      date - ((date.wday - offset_from_sunday)%7)
+    end
+    
+    # reset date for the yearly interval
+    def reset_date_yearly(start_date)
+      (parse_date(@date).leap? ? parse_date(start_date) + 366 : parse_date(start_date) + 365).strftime("%m-%d-%Y")
+    end
+
+    # reset date for the monthly interval
+    def reset_date_monthly(start_date, interval)
+      (start_of_treatment_date(parse_date(start_date), interval) + COMMON_YEAR_DAYS_IN_MONTH[(parse_date(@date)).month]-1).strftime("%m-%d-%Y")
+    end
+
+    # reset date for the weekly interval
+    def reset_date_weekly(start_date, interval)
+      (start_of_treatment_date(parse_date(start_date), interval) + 7).strftime("%m-%d-%Y")
+    end
+
+    # start of treatment for the yearly interval
+    def start_of_treatment_date_yearly(start_date)
+      parse_date("#{start_date.month}-#{start_date.day}-#{parse_date(@date).year}")
+    end
+
+    # start of treatment for the montly interval
+    def start_of_treatment_date_monthly(start_date)
+      parse_date("#{parse_date(@date).month}-#{start_date.day}-#{parse_date(@date).year}")
+    end
+
+    # start of treatment for the weekly interval
+    def start_of_treatment_date_weekly(start_date)
+      date = parse_date(@date)
+
+      week_start_date = week_start(date)
+      weekly_date = week_start_date + start_date.wday
+      weekly_date = date < weekly_date ? weekly_date - 7 : weekly_date
+
+      weekly_date
+    end
+  end
+end

data/lib/pacing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pacing
+  VERSION = "0.1.3"
+end

data/pacing.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pacing/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'pacing'
+  s.version       = Pacing::VERSION
+  s.summary       = "Pacing is a tool that enables therapists to better manage and track their caseload."
+  s.description   = "Pacing 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."
+  s.authors       = ["Kevin S. Dias", "Samuel Okoth", "Lukong I. Nsoseka"]
+  s.email         = 'info@ambiki.com'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.homepage      = 'https://github.com/Ambiki/pacing'
+  s.license       = 'MIT'
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "holidays", '~> 8.6', '>= 8.6'
+end
+