business_hours 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e44aea9efb82d12de3027199cbab0a350208b3d6
+  data.tar.gz: 04d9092b23ef31966f447e945f907a1b14216d6d
+SHA512:
+  metadata.gz: 39ac0bf45a06e90e443b3c12e8e47c7b3c53dd82510a0a12ff84981f380e31be7ff682654368f9e8a80f028894f3266f25b0fbf02aeb1c99532248897e4e7564
+  data.tar.gz: 3a93ced6470b42334f2a63a1dc849ecd2b744839b6ff55ccc10bc6d91d23acc224f026dcb71f53add00fe835fbed1040c3e95be1762da8f529fbe71314893953

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 business_hours.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivan Kryak
+
+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 @@
+# BusinessHours
+
+This gem provides simple DSL to describe working hours for business place.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'business_hours'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install business_hours
+
+## Usage
+
+Create new business week for particular time zone:
+
+    business_hours = BusinessHours::Week.new('Europe/Moscow')
+
+Then add some working days:
+
+    business_hours.day(1) do
+        open_at '10:00'
+        close_at '20:00'
+        has_break '13:00', '14:00'
+    end
+
+or you can use abbreviation for day name:
+
+    business_hours.day(:mon)
+
+If there is no information about a day, then we assume that it's closed. Or you can mark day as closed with:
+
+    business_hours.days(1) do
+        closed!
+    end
+
+Then you can easily check if business place is opened now:
+
+    business_hours.now_open?
+
+See test folder for more information
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/business_hours.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'business_hours/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "business_hours"
+  spec.version       = BusinessHours::VERSION
+  spec.authors       = ["Ivan Kryak"]
+  spec.email         = ["kryak.iv@gmail.com"]
+  spec.description   = %q{Allows easily handle opening hours without take care of time zones}
+  spec.summary       = %q{Allows easily handle opening hours without take care of time zones}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "timecop"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "tzinfo"
+end

data/lib/business_hours/day.rb

@@ -0,0 +1,87 @@
+require 'delegate'
+
+module BusinessHours
+  class Day
+    class DayDelegator < SimpleDelegator
+      def open_at(time)
+        self.open_at = Time.zone.parse(time)
+      end
+
+      def close_at(time)
+        self.close_at = Time.zone.parse(time)
+      end
+
+      def has_break(from, to)
+        self.break = { from: Time.zone.parse(from), to: Time.zone.parse(to) }
+      end
+
+      def closed!
+        self.closed = true
+      end
+    end
+
+    attr_accessor :open_at, :close_at, :closed, :break
+
+    class << self
+      def build(&block)
+        day = new
+        day.build(&block)
+        day
+      end
+    end
+
+    def build(&block)
+      delegator = DayDelegator.new(self)
+      delegator.instance_eval(&block)
+      self
+    end
+
+    def initialize(day_of_week)
+      @day_of_week = day_of_week
+
+      @open_at = nil
+      @close_at = nil
+      @closed = false
+      @break = { from: nil, to: nil }
+    end
+
+    def closed?
+      @closed or [@open_at, @close_at].any?(&:nil?)
+    end
+
+    def today?
+      @day_of_week == Date.today.wday
+    end
+
+    def has_breaks?
+      @break.values_at(:from, :to).compact.any?
+    end
+
+    def closed_at?(time)
+      return true if closed?
+
+      open = @open_at.change(day: time.day, month: time.month, year: time.year)
+      close = @close_at.change(day: time.day, month: time.month, year: time.year)
+
+      result = !time.between?(open, close)
+
+      if has_breaks?
+        break_start = @break[:from].change(day: time.day, month: time.month, year: time.year)
+        break_end = @break[:to].change(day: time.day, month: time.month, year: time.year)
+
+        result = result and time.between?(break_start, break_end)
+      end
+
+      result
+    end
+
+    def to_s(format = :short)
+      case format
+      when :short
+        Date::ABBR_DAYNAMES[@day_of_week]
+      else
+        Date::DAYNAMES[@day_of_week]
+      end  
+    end
+  end
+end

data/lib/business_hours/version.rb

@@ -0,0 +1,3 @@
+module BusinessHours
+  VERSION = '0.0.1'
+end

data/lib/business_hours/week.rb

@@ -0,0 +1,36 @@
+module BusinessHours
+  class Week
+    def initialize(time_zone = UTC_TIME_ZONE)
+      @time_zone = time_zone
+      @days = Array.new(7).each_with_index.map { |n, i| Day.new(i) }
+    end
+
+    def day(day_name, &block)
+      Time.use_zone(@time_zone) do
+        day_index = if day_name.is_a? Fixnum
+                      day_name
+                    elsif day_name.respond_to? :to_s
+                      Date::ABBR_DAYNAMES.index(day_name.to_s.capitalize)
+                    end
+        @days[day_index].tap { |day| day.build(&block) }
+      end
+    end
+
+    def closed?
+      current_day = @days[Date.today.wday]
+
+      return true if current_day.nil? or current_day.closed?  # if there is no data for current day, assume that it's closed all day
+
+      current_time = Time.now
+      current_day.closed_at?(current_time)
+    end
+
+    def now_open?
+      !closed?
+    end
+
+    def days
+      @days
+    end
+  end
+end

data/lib/business_hours.rb

@@ -0,0 +1,10 @@
+require 'business_hours/version'
+
+require 'active_support/time'
+
+require 'business_hours/day'
+require 'business_hours/week'
+
+module BusinessHours
+  UTC_TIME_ZONE = 'Etc/UTC'
+end

data/test/test_business_hours.rb

@@ -0,0 +1,87 @@
+require 'test/unit'
+require 'business_hours'
+require 'timecop'
+
+class TestBusinessHours < Test::Unit::TestCase
+  def initialize(*args)
+    super
+    Time.zone = 'Etc/UTC'
+  end
+
+  def test_initialization
+    week = BusinessHours::Week.new
+
+    week.day('mon') do
+      open_at '10:00'
+      close_at '20:00'
+      has_break '13:00', '13:30'
+    end
+
+    week.day('tue') do
+      closed!
+    end
+
+    assert_not_nil week
+  end
+
+  def test_closed_today
+    hours = BusinessHours::Week.new
+    hours.day(Date.today.wday) do
+      closed!
+    end
+
+    assert_equal hours.closed?, true
+  end
+
+  def test_open_today
+    hours = BusinessHours::Week.new
+
+    hours.day(Date.today.wday) do
+      open_at '10:00'
+      close_at '20:00'
+    end
+
+    Timecop.travel(Time.zone.now.change(hour: 11)) { assert_equal hours.closed?, false }
+    Timecop.travel(Time.zone.now.change(hour: 9)) { assert_equal hours.closed?, true }
+  end
+
+  def test_different_timezone
+    Time.zone = 'Europe/Moscow'
+    hours = BusinessHours::Week.new('Europe/Berlin')
+    hours.day(Date.today.wday) do
+      open_at '10:00'
+      close_at '20:00'
+    end
+
+    Timecop.travel(Time.zone.now.change(hour: 11)) { assert_equal hours.closed?, true }
+    Timecop.travel(Time.zone.now.change(hour: 9)) { assert_equal hours.closed?, true }
+    Timecop.travel(Time.zone.now.change(hour: 14)) { assert_equal hours.closed?, false }
+    Timecop.travel(Time.zone.now.change(hour: 15)) { assert_equal hours.closed?, false }
+    Timecop.travel(Time.zone.now.change(hour: 23)) { assert_equal hours.closed?, true }
+  end
+
+  def test_with_breaks
+    hours = BusinessHours::Week.new('Europe/Berlin')
+    day = hours.day(Date.today.wday) do
+      open_at '10:00'
+      close_at '20:00'
+      has_break '13:30', '14:00'
+    end
+
+    assert_equal day.has_breaks?, true
+    Timecop.travel(Time.now.change(hour: 13, minutes: 40)) { assert_equal hours.closed?, true }
+  end
+
+  def test_initialization_with_dayname
+    hours = BusinessHours::Week.new('Europe/Berlin')
+    day = hours.day(Date::ABBR_DAYNAMES[Date.today.wday]) do
+      open_at '10:00'
+      close_at '20:00'
+    end
+
+    assert_equal day.today?, true
+  end
+
+  def test_default_values
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: business_hours
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Kryak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: timecop
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows easily handle opening hours without take care of time zones
+email:
+- kryak.iv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- business_hours.gemspec
+- lib/business_hours.rb
+- lib/business_hours/day.rb
+- lib/business_hours/version.rb
+- lib/business_hours/week.rb
+- test/test_business_hours.rb
+homepage: ''
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Allows easily handle opening hours without take care of time zones
+test_files:
+- test/test_business_hours.rb