operating_hours 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 291eb1f59e1cfb8adebbdca95faafc0d5d4cab0d
+  data.tar.gz: 9425bef0ab1765b0f72e9742828d6e579399d307
+SHA512:
+  metadata.gz: 2010feae17c9e1d88aee8930bef3079f44c2840f8c3a7ad3191536aa1316fa4368e33815774bbe62166a056d4e214fe453e8be95b5d44f56dd94d263179dadcb
+  data.tar.gz: 696e738507b5528bbc3edb9d35cb97ce32927abfbeef2404b8536c37904d4b5f136f608ee29a2f42bd0f8976553d23a3f829e7367476fdbcc91e58db409e8b07

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jordinoguera83@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in operating_hours.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Spreemo, Inc.
+
+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,90 @@
+# OperatingHours
+
+Time calculations based on business hours. Inspired by [business_time](https://github.com/bokmann/business_time) but with significantly better performance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'operating_hours'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install operating_hours
+
+## Usage
+
+#### Initializiation
+
+First initialize a calculator, a calculator needs a `schedule` and `holidays`:
+
+```
+schedule = {
+  [:mon, :tue, :wed, :thu, :fri] => [[9 * 3600, 17 * 3600]]
+}
+holidays = [Date.new(2016, 1, 1), Date.new(2016, 12, 25)]
+calculator = OperatingHours::Calculator.new(schedule: schedule, holidays: holidays)
+
+```
+
+`schedule` is a hash whose keys are an array of weekdays and the values are an array of time intervals in seconds since the beginning of the day. So if we have a business that works on Monday 9:00-13:00, 14:00-17:30 and Tue-Fri 9:00-17:00 we would set schedule to:
+
+````
+schedule = {
+  [:mon] => [[9 * 3600, 13 * 3600], [14 * 3600, 17 * 3600 + 30 * 60]],
+  [:tue, :wed, :thu, :fri] => [[9 * 3600, 17 * 3600]]]
+}
+````
+
+`holidays` is an array of dates, you could probably use the [holiday gem](https://github.com/holidays/holidays)
+
+It's recommended to memoize the calculators, so you could do:
+
+````
+class TimeCalculators
+  def self.ny
+	@ny ||= OperatingHours::Calculator.new(
+	          schedule: [:mon, :tue, :wed, :thu, :fri] => [[9 * 3600, 17 * 3600]],
+	          holidays: [Date.new(2016, 1, 1), Date.new(2016, 12, 25)]
+	        )
+  end
+
+  def self.sf
+  	@sf ||= OperatingHours::Calculator.new(
+	          schedule: [:mon, :tue, :wed, :thu, :fri] => [[9 * 3600, 18 * 3600]],
+	          holidays: [Date.new(2016, 1, 1), Date.new(2016, 12, 25)]
+	        )
+  end
+end
+````
+
+#### Methods
+
+* `calculator.seconds_between_times(time1, time2)`: (Integer) Working seconds between two times.
+* `calculator.days_between_dates(date1, date2)`: (Integer) Number of work days between two dates (excluding edges).
+* `calculator.seconds_since_beginning_of_workday(time)`: (Integer) Working seconds since workday started.
+* `calculator.seconds_until_end_of_workday(time)`: (Integer) Working seconds until workday finishes.
+* `calculator.holiday?(time_or_date)`: (Boolean) Whether time or date is a holiday.
+* `calculator.add_days_to_date(days, date)`: (Date) Adds given work days to a date.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spreemo/operating_hours. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+Copyright (c) 2016 Spreemo. The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "operating_hours"
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/operating_hours.rb

@@ -0,0 +1,5 @@
+require 'operating_hours/version'
+require 'operating_hours/calculator'
+require 'operating_hours/work_day'
+require 'operating_hours/schedule'
+require 'operating_hours/holiday_collection'

data/lib/operating_hours/calculator.rb

@@ -0,0 +1,50 @@
+module OperatingHours
+  class Calculator
+    def initialize(schedule:, holidays: [])
+      @schedule = Schedule.new(schedule)
+      @holidays = HolidayCollection.new(collection: holidays, schedule: @schedule)
+    end
+
+    def seconds_between_times(first_time, last_time)
+      return -1 * seconds_between_times(last_time, first_time) if last_time < first_time
+      schedule.seconds_in_date_range(first_time.to_date, last_time.to_date) -
+        holidays.seconds_in_date_range(first_time.to_date, last_time.to_date) -
+        seconds_since_beginning_of_workday(first_time) -
+        seconds_until_end_of_workday(last_time)
+    end
+
+    def seconds_since_beginning_of_workday(time)
+      return 0 if holiday?(time)
+      schedule.seconds_since_beginning_of_day(time)
+    end
+
+    def seconds_until_end_of_workday(time)
+      return 0 if holiday?(time)
+      schedule.seconds_until_end_of_day(time)
+    end
+
+    def days_between_dates(first_date, second_date)
+      return 0 if first_date == second_date
+      schedule.days_in_date_range(first_date, second_date - 1) -
+        holidays.days_in_date_range(first_date, second_date - 1)
+    end
+
+    def holiday?(time)
+      holidays.include?(time.to_date)
+    end
+
+    def add_days_to_date(days, date)
+      holiday_count = 0
+      loop do
+        last_date = schedule.add_days_to_date(days + holiday_count, date)
+        return last_date if holiday_count == holidays.days_in_date_range(date, last_date)
+        holiday_count = holidays.days_in_date_range(date, last_date)
+      end
+    end
+
+    private
+
+    attr_reader :holidays, :schedule
+  end
+end
+

data/lib/operating_hours/holiday_collection.rb

@@ -0,0 +1,61 @@
+require 'set'
+
+class OperatingHours::HolidayCollection
+  def initialize(collection:, schedule:)
+    @schedule = schedule
+    @dates = calculate_holidays_time(collection)
+  end
+
+  def days_in_date_range(first_date, second_date)
+    holidays_before(second_date + 1) - holidays_before(first_date)
+  end
+
+  def seconds_in_date_range(first_date, second_date)
+    holiday_seconds_before(second_date + 1) - holiday_seconds_before(first_date)
+  end
+
+  def include?(date)
+    get(date)[:holiday?]
+  end
+
+  private
+
+  attr_reader :schedule
+
+  def holidays_before(date)
+    get(date)[:holidays_before]
+  end
+
+  def holiday_seconds_before(date)
+    get(date)[:holiday_seconds_before]
+  end
+
+  def get(date)
+    @dates[date] || { holiday?: false, holidays_before: 0, holiday_seconds_before: 0 }
+  end
+
+  def calculate_holidays_time(collection)
+    return {} if collection.empty?
+
+    holidays_before = 0
+    holiday_seconds_before = 0
+
+    sorted_holidays = SortedSet.new(collection)
+    first_holiday = sorted_holidays.min
+    last_holiday = sorted_holidays.max
+
+    (first_holiday..last_holiday).each_with_object({}) do |date, hash|
+      holiday = sorted_holidays.include?(date)
+      working_seconds = schedule.seconds_per_wday(date.wday)
+      hash[date] = {
+        holiday?: holiday,
+        holidays_before: holidays_before,
+        holiday_seconds_before: holiday_seconds_before
+      }
+      if holiday && working_seconds > 0
+        holidays_before += 1
+        holiday_seconds_before += working_seconds
+      end
+    end
+  end
+end

data/lib/operating_hours/schedule.rb

@@ -0,0 +1,125 @@
+class OperatingHours::Schedule
+  WDAYS = {
+    sun: 0,
+    mon: 1,
+    tue: 2,
+    wed: 3,
+    thu: 4,
+    fri: 5,
+    sat: 6
+  }
+
+  attr_reader :seconds_per_week
+
+  def initialize(times)
+    @times = unpack_times(times)
+    @seconds_per_week = @times.values.map(&:seconds).inject(&:+)
+    @days_per_week = @times.keys.count
+    @seconds_in_wday_ranges = calculate_seconds_in_wday_ranges
+    @days_in_wday_ranges = calculate_days_in_wday_ranges
+    @wdays_plus_days = calculate_wdays_plus_days
+  end
+
+  def seconds_per_wday(wday)
+    day = @times[wday]
+    return 0 unless day
+    day.seconds
+  end
+
+  def seconds_in_date_range(first_date, second_date)
+    number_of_days = (second_date - first_date + 1).to_i
+    full_weeks = number_of_days / 7
+    seconds = @seconds_per_week * full_weeks
+    return seconds if number_of_days % 7 == 0
+    seconds + @seconds_in_wday_ranges[[first_date.wday, second_date.wday]]
+  end
+
+  def days_in_date_range(first_date, second_date)
+    number_of_days = (second_date - first_date + 1).to_i
+    full_weeks = number_of_days / 7
+    work_days = @days_per_week * full_weeks
+    return work_days if number_of_days % 7 == 0
+    work_days + @days_in_wday_ranges[[first_date.wday, second_date.wday]]
+  end
+
+  def seconds_since_beginning_of_day(time)
+    day = @times[time.wday]
+    return 0 unless day
+    time_in_seconds = time_in_seconds(time)
+    day.times.map do |start, _end|
+      time_intersection([start, time_in_seconds], [start, _end])
+    end.inject(&:+)
+  end
+
+  def seconds_until_end_of_day(time)
+    day = @times[time.wday]
+    return 0 unless day
+    time_in_seconds = time_in_seconds(time)
+    day.times.map do |start, _end|
+      time_intersection([time_in_seconds, _end], [start, _end])
+    end.inject(&:+)
+  end
+
+  def add_days_to_date(days, date)
+    weeks = days / @days_per_week
+    rest = days % @days_per_week
+
+    date + 7 * weeks + @wdays_plus_days[[date.wday, rest]]
+  end
+
+  private
+
+  def unpack_times(times)
+    times.each_with_object({}) do |(days, day_times), hash|
+      days.each do |day|
+        hash[WDAYS[day]] = OperatingHours::WorkDay.new(day_times)
+      end
+    end
+  end
+
+  def calculate_seconds_in_wday_ranges
+    (0..6).each_with_object({}) do |first_wday, hash|
+      total_seconds = 0
+      (0..5).each do |offset|
+        second_wday = (first_wday + offset) % 7
+        total_seconds += seconds_per_wday(second_wday)
+        hash[[first_wday, second_wday]] = total_seconds
+      end
+    end
+  end
+
+  def calculate_days_in_wday_ranges
+    (0..6).each_with_object({}) do |first_wday, hash|
+      total_days = 0
+      (0..5).each do |offset|
+        second_wday = (first_wday + offset) % 7
+        total_days += 1 if @times.has_key?(second_wday)
+        hash[[first_wday, second_wday]] = total_days
+      end
+    end
+  end
+
+  def calculate_wdays_plus_days
+    (0..6).each_with_object({}) do |first_wday, hash|
+      calendar_days = 0
+      last_wday = first_wday
+      (0..@days_per_week - 1).each do |days|
+        while !@times.has_key?(last_wday)
+          calendar_days += 1
+          last_wday = (last_wday + 1) % 7
+        end
+        hash[[first_wday, days]] = calendar_days
+        calendar_days += 1
+        last_wday = (last_wday + 1) % 7
+      end
+    end
+  end
+
+  def time_intersection(segment1, segment2)
+    [[segment1[1], segment2[1]].min - [segment1[0], segment2[0]].max, 0].max
+  end
+
+  def time_in_seconds(time)
+    time.hour * 3600 + time.min * 60 + time.sec
+  end
+end

data/lib/operating_hours/version.rb

@@ -0,0 +1,3 @@
+module OperatingHours
+  VERSION = "0.1.0"
+end

data/lib/operating_hours/work_day.rb

@@ -0,0 +1,10 @@
+class OperatingHours::WorkDay
+  attr_reader :times, :seconds
+
+  def initialize(times)
+    @times = times
+    @seconds = times.map do |(first, last)|
+      last - first
+    end.inject(&:+)
+  end
+end

data/operating_hours.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'operating_hours/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'operating_hours'
+  spec.version       = OperatingHours::VERSION
+  spec.authors       = ['Jordi Noguera']
+  spec.email         = ['jordinoguera83@gmail.com']
+
+  spec.summary       = %q{Time calculations based on business hours}
+  spec.homepage      = 'https://github.com/spreemo/operating_hours'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: operating_hours
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordi Noguera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jordinoguera83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/operating_hours.rb
+- lib/operating_hours/calculator.rb
+- lib/operating_hours/holiday_collection.rb
+- lib/operating_hours/schedule.rb
+- lib/operating_hours/version.rb
+- lib/operating_hours/work_day.rb
+- operating_hours.gemspec
+homepage: https://github.com/spreemo/operating_hours
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Time calculations based on business hours
+test_files: []