opening_hours 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Albert Hild
+
+MIT License
+
+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,55 @@
+# OpeningHours
+
+Let you apply opening hours, closed periods and holidays to all kind of business including timezone support. Heavily based on the code from pleax (RPCFN#10: Business Hours competition winner) - thx a lot: [Source](https://gist.github.com/pleax/e9c0da1a6e92dd12cbc7)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opening_hours'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opening_hours
+
+## Usage
+
+Init new hours object:
+```ruby
+hours = OpeningHours.new("9:00 AM", "3:00 PM", "Berlin")
+```
+
+Methods to set the hours, closed times or holidays:
+```ruby
+hours.update :fri, "10:00 AM", "5:00 PM"
+hours.update "Dec 24, 2010", "8:00 AM", "1:00 PM"
+hours.closed :sun, :wed, "Dec 25, 2010"
+```
+
+Calculate the deadline (next available working hour)
+```ruby
+# offset and time
+hours.calculate_deadline(4*60*60, "Dec 23, 2010 8:00 PM")
+ => "Fri, 24 Dec 2010 12:00:00 +0100" 
+
+# now with timezone
+hours.calculate_deadline(0, "Dec 23, 2010 9:00 AM -0400")
+ => "Thu, 23 Dec 2010 14:00:00 +0100"
+```
+
+Check if business is open right now:
+```ruby
+hours.now_open?
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/opening_hours/version.rb

@@ -0,0 +1,3 @@
+class OpeningHours
+  VERSION = "0.0.2"
+end

data/lib/opening_hours.rb

@@ -0,0 +1,133 @@
+require 'time'
+require 'date'
+require 'active_support/time'
+require "opening_hours/version"
+
+class OpeningHours
+
+  class OpenHours
+
+    attr_reader :open, :close
+
+    def initialize(open, close)
+      @open, @close = open, close
+    end
+
+    def duration
+      @duration ||= @open < @close ? @close - @open : 0
+    end
+
+    CLOSED = new(0, 0)
+
+    def self.parse(open, close)
+      open  = Time.parse(open)
+      close = Time.parse(close)
+    
+      open  = TimeUtils::seconds_from_midnight(open)
+      close = TimeUtils::seconds_from_midnight(close)
+    
+      new(open, close)
+    end
+
+    def offset(seconds)
+      self.class.new([@open, seconds].max, @close)
+    end
+
+  end
+
+  module TimeUtils
+
+    class << self
+
+      def seconds_from_midnight(time)
+        time.hour*60*60 + time.min*60 + time.sec
+      end
+      
+      def time_from_midnight(seconds)
+        hours, seconds = seconds.divmod(60 * 60)
+        minutes, seconds = seconds.divmod(60)
+        [hours, minutes, seconds]
+      end
+
+    end
+
+  end
+
+  # makes it possible to access each day like: b.week[:sun].open, or iterate through all weekdays
+  attr_reader :week
+
+  WEEK_DAYS = Time::RFC2822_DAY_NAME.map { |m| m.downcase.to_sym }
+
+  def initialize(start_time, end_time, time_zone = Time.now.gmt_offset)
+    open_hours = OpenHours.parse(start_time, end_time)
+
+    @time_zone = time_zone
+
+    @week = {}
+    WEEK_DAYS.each do |day|
+      @week[day] = open_hours
+    end
+
+    @specific_days = {}
+  end
+
+  def update(day, start_time, end_time, time_zone = Time.now.zone)
+
+    @time_zone = time_zone
+
+    set_open_hours day, OpenHours.parse(start_time, end_time)
+  end
+
+  def closed(*days)
+    days.each do |day|
+      set_open_hours day, OpenHours::CLOSED
+    end
+  end
+
+  def now_open?
+    calculate_deadline(0, Time.now.to_s) == Time.now.to_formatted_s(:rfc822)
+  end
+
+  def calculate_deadline(job_duration, start_date_time)
+    Time.zone = @time_zone
+    start_date_time = Time.zone.parse(start_date_time)
+
+    today = Date.civil(start_date_time.year, start_date_time.month, start_date_time.day)
+    open_hours = get_open_hours(today).offset(TimeUtils::seconds_from_midnight(start_date_time))
+
+    # here is possible to use strict greater operator if you want to stop on edge of previous business day.
+    # see "BusinessHours schedule without exceptions should flip the edge" spec
+    while job_duration >= open_hours.duration
+      job_duration -= open_hours.duration
+
+      today = today.next
+      open_hours = get_open_hours(today)
+    end
+
+    Time.zone.local(today.year, today.month, today.day, *TimeUtils::time_from_midnight(open_hours.open + job_duration)).to_formatted_s(:rfc822)
+  end
+
+  private
+
+  def get_open_hours(date)
+    @specific_days[date] || @week[WEEK_DAYS[date.wday]]
+  end
+
+  def set_open_hours(day, open_hours)
+    case day
+    when Symbol
+      @week[day] = open_hours
+    when String
+      @specific_days[Date.parse(day)] = open_hours
+    end
+  end
+
+end
+
+class Time
+  class << self
+    def parse_rfc822(date, now=self.now)
+      parse(date, now).to_formatted_s(:rfc822)
+    end
+  end
+end

data/opening_hours.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opening_hours/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "opening_hours"
+  gem.version       = OpeningHours::VERSION
+  gem.authors       = ["Albert Hild"]
+  gem.email         = ["mail@albert-hild.de"]
+  gem.description   = %q{Opening hours for all kind of businesses}
+  gem.summary       = %q{Let you apply opening hours, closed periods and holidays to all kind of business including timezone support. Heavily based on: https://gist.github.com/pleax/e9c0da1a6e92dd12cbc7 }
+  gem.homepage      = "https://github.com/alberthild/opening_hours"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_runtime_dependency "activesupport"
+end

data/spec/opening_hours_spec.rb

@@ -0,0 +1,186 @@
+require 'opening_hours'
+require 'active_support/time'
+
+describe OpeningHours do
+
+  subject { OpeningHours.new("9:00 AM", "3:00 PM") }
+
+  it { should respond_to(:update) }
+
+  it { should respond_to(:closed) }
+
+  it { should respond_to(:calculate_deadline) }
+  
+  it { should respond_to(:week) }
+
+  context "schedule without exceptions" do
+    before { @hours = OpeningHours.new("9:00 AM", "3:00 PM") }
+
+    it "should handle start time during open hours" do
+      @hours.calculate_deadline(1*60*60, "Jun 7, 2010 9:10 AM").should == Time.parse_rfc822("Jun 7, 2010 10:10 AM")
+    end
+
+    it "should handle start time before open hours" do
+      @hours.calculate_deadline(2*60*60, "Jun 7, 2010 8:45 AM").should == Time.parse_rfc822("Jun 7, 2010 11:00 AM")
+    end
+
+    it "should handle start time after open hours" do
+      @hours.calculate_deadline(2*60*60, "Jun 7, 2010 10:45 PM").should == Time.parse_rfc822("Jun 8, 2010 11:00 AM")
+    end
+
+    it "should finish job next day if not enough time left" do
+      @hours.calculate_deadline(2*60*60, "Jun 7, 2010 2:45 PM").should == Time.parse_rfc822("Jun 8, 2010 10:45 AM")
+    end
+
+    it "should process huge job for several days" do
+      @hours.calculate_deadline(20*60*60, "Jun 7, 2010 10:45 AM").should == Time.parse_rfc822("Jun 10, 2010 12:45 PM")
+    end
+
+    it "should flip the edge" do
+      @hours.calculate_deadline(6*60*60, "Jun 7, 2010 9:00 AM").should == Time.parse_rfc822("Jun 8, 2010 9:00 AM")
+    end
+
+    # this is also possible, but I prefer previous variant
+    #
+    # it "should NOT flip the edge" do
+    #   @hours.calculate_deadline(6*60*60, "Jun 7, 2010 9:00 AM").should == Time.parse("Jun 7, 2010 3:00 PM")
+    # end
+
+    context "on dst changes" do
+
+      it "should respect changing to dst" do
+        @hours.calculate_deadline(8*60*60, "March 27, 2010 2:00 PM").should == Time.parse_rfc822("March 29, 2010 10:00 AM")
+      end
+
+      it "should respect changing to dst" do
+        @hours.calculate_deadline(2*60*60, "March 27, 2010 2:00 PM").should == Time.parse_rfc822("March 28, 2010 10:00 AM")
+      end
+
+      it "should respect changing from dst" do
+        @hours.calculate_deadline(8*60*60, "October 31, 2010 2:00 PM").should == Time.parse_rfc822("November 2, 2010 10:00 AM")
+      end
+
+      it "should respect changing from dst" do
+        @hours.calculate_deadline(2*60*60, "October 31, 2010 2:00 PM").should == Time.parse_rfc822("November 1, 2010 10:00 AM")
+      end
+
+    end
+
+  end
+
+  context "schedule with closed weekdays" do
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.closed :sun, :wed
+    end
+
+    it "should skip closed days" do
+      @hours.calculate_deadline(2*60*60, "Jun 5, 2010 2:45 PM").should == Time.parse_rfc822("Jun 7, 2010 10:45 AM")
+    end
+
+    it "should skip closed days even if work scheduled to closed day" do
+      @hours.calculate_deadline(2*60*60, "Jun 6, 2010 11:45 AM").should == Time.parse_rfc822("Jun 7, 2010 11:00 AM")
+    end
+  end
+
+  context "schedule with closed specific days" do
+
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.closed "Dec 25, 2010"
+    end
+
+    it "should skip closed days" do
+      @hours.calculate_deadline(2*60*60, "Dec 24, 2010 2:45 PM").should == Time.parse_rfc822("Dec 26, 2010 10:45 AM")
+    end
+
+    it "should skip closed days even if work scheduled to closed day" do
+      @hours.calculate_deadline(2*60*60, "Dec 25, 2010 11:45 AM").should == Time.parse_rfc822("Dec 26, 2010 11:00 AM")
+    end
+
+  end
+
+  context "schedule with both closed weekdays and specific days" do
+
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.closed :sun, :wed, "Dec 25, 2010"
+    end
+
+    it "should skip closed days" do
+      @hours.calculate_deadline(2*60*60, "Dec 24, 2010 2:45 PM").should == Time.parse_rfc822("Dec 27, 2010 10:45 AM")
+    end
+  end
+
+  context "schedule with different open hours in weekdays" do
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.update :fri, "10:00 AM", "5:00 PM"
+    end
+
+    it "should spend open hours" do
+      @hours.calculate_deadline(14*60*60, "Jun 3, 2010 9:00 AM").should == Time.parse_rfc822("Jun 5, 2010 10:00 AM")
+    end
+
+  end
+
+  context "schedule with different open hours in specific days" do
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.update "Dec 24, 2010", "8:00 AM", "1:00 PM"
+    end
+
+    it "should spend open hours" do
+      @hours.calculate_deadline(12*60*60, "Dec 23, 2010 9:00 AM").should == Time.parse_rfc822("Dec 25, 2010 10:00 AM")
+    end
+
+    it "should spend open hours if started at the day" do
+      @hours.calculate_deadline(6*60*60, "Dec 24, 2010 12:00 PM").should == Time.parse_rfc822("Dec 25, 2010 2:00 PM")
+    end
+
+  end
+
+  context "original tests" do
+
+    before do
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM")
+      @hours.update :fri, "10:00 AM", "5:00 PM"
+      @hours.update "Dec 24, 2010", "8:00 AM", "1:00 PM"
+      @hours.closed :sun, :wed, "Dec 25, 2010"
+    end
+
+    it "should pass test #1" do
+      @hours.calculate_deadline(2*60*60, "Jun 7, 2010 9:10 AM").should == Time.parse_rfc822("Mon Jun 07 11:10:00 2010")
+    end
+
+    it "should pass test #2" do
+      @hours.calculate_deadline(15*60, "Jun 8, 2010 2:48 PM").should == Time.parse_rfc822("Thu Jun 10 09:03:00 2010")
+    end
+
+    it "should pass test #3" do
+      @hours.calculate_deadline(7*60*60, "Dec 24, 2010 6:45 AM").should == Time.parse_rfc822("Mon Dec 27 11:00:00 2010")
+    end
+
+  end
+
+  context "timezone checks" do
+    before do
+      Time.zone = "Moscow"
+      @hours = OpeningHours.new("9:00 AM", "3:00 PM", "Moscow")
+    end
+
+    it "should spend open hours in the right time zone" do
+      @hours.calculate_deadline(2*60*60, "Dec 23, 2010 9:00 AM").should == Time.zone.parse("Dec 23, 2010 11:00 AM").to_formatted_s(:rfc822)
+    end
+
+    it "should spend open hours in the right time zone" do
+      @hours.calculate_deadline(4*60*60, "Dec 23, 2010 8:00 PM -0900").should == Time.zone.parse("Dec 24, 2010 01:00 PM").to_formatted_s(:rfc822)
+    end
+
+    it "should spend open hours in the right time zone" do
+      @hours.calculate_deadline(0, "Dec 23, 2010 08:00 PM +0800").should == Time.zone.parse("Dec 24, 2010 9:00 AM").to_formatted_s(:rfc822)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: opening_hours
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Albert Hild
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opening hours for all kind of businesses
+email:
+- mail@albert-hild.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opening_hours.rb
+- lib/opening_hours/version.rb
+- opening_hours.gemspec
+- spec/opening_hours_spec.rb
+homepage: https://github.com/alberthild/opening_hours
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'Let you apply opening hours, closed periods and holidays to all kind of
+  business including timezone support. Heavily based on: https://gist.github.com/pleax/e9c0da1a6e92dd12cbc7'
+test_files:
+- spec/opening_hours_spec.rb