open_hours 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6f8f536435f8ad892773bfd9fe96de0143f8441
+  data.tar.gz: 35f3c93fc1d76be1b0e1bd4be1200caaf15e733d
+SHA512:
+  metadata.gz: 6ed6fd97c3ea35c1868e0db631b8a97454994d269352a0e9d328f2b45bec12124288cab690ee8112b6a3911c17633e85d1a81f2799682f3de2961890f3a5b291
+  data.tar.gz: db19438117d15fb5feeb0b995579077b0174d7894105dad38ee5f5ae4a6c39f12affab298b9039cbd8589b322c9889974c5680f60e772908b253185c29924d4d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle

data/Gemfile

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

data/README.md

@@ -0,0 +1,77 @@
+# OpenHours
+
+Library that parses date ranges in the openingHours format https://schema.org/openingHours.
+
+The main use for this is to take a set of openingHours rules and then find out if the place is open at a specific time.
+
+## 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
+
+### With just one openingHours rule
+
+```ruby
+one_day = "Mo 08:00-16:30"
+op = OpeningHours.parse(one_day)
+
+op.class #=> OpeningHours::OpenHours
+
+time = DateTime.parse("Monday, June 14 2014 08:00")
+op.open_at?(time) #=> true
+
+time = DateTime.parse("Tuesday, June 14 2014 08:00")
+op.open_at?(time) #=> false
+```
+
+### With a range of openingHours rules
+
+```ruby
+multi_day = ["Mo-Th 08:00-16:30", "Fr 08:00-16:00"]
+op = OpeningHours.parse(multi_day)
+
+op.class #=> OpeningHours::OpenHours
+
+time = DateTime.parse("Monday, June 14 2014 08:00")
+op.open_at?(time) #=> true
+
+time = DateTime.parse("Monday, June 14 2014 07:59")
+op.open_at?(time) #=> false
+
+time = DateTime.parse("Monday, June 14 2014 16:30")
+op.open_at?(time) #=> true
+
+time = DateTime.parse("Monday, June 14 2014 16:31")
+op.open_at?(time) #=> false
+
+time = DateTime.parse("Saturday, June 19 2014 08:30")
+op.open_at?(time) #=> false
+```
+
+## Limitations
+
+This gem is in early days. There are parts of the openingHours spec it doesn't handle. Such as,
+
+- Comma-separated days (ex: "Mo,Th")
+- The shorthand "Mo-Su" to define being open 24 hours a day, 7 days a week
+- Hours for a specific day that override the normal hours for that day.
+  - This functionality is part of [openingHoursSpecfication](http://schema.org/OpeningHoursSpecification), so may not ever be implemented in this gem.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/opening_hours/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

data/Rakefile

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

data/lib/open_hours/version.rb

@@ -0,0 +1,3 @@
+module OpenHours
+  VERSION = "0.0.2"
+end

data/lib/open_hours.rb

@@ -0,0 +1,106 @@
+require "open_hours/version"
+require "ostruct"
+
+module OpeningHours
+  def self.parse(params)
+    OpenHours.new(params)
+  end
+
+  class OpenHours
+    def initialize(params)
+      params = Array(params)
+      check_params(params)
+
+      params.each do |param|
+        param_values = parse_param(param)
+        param_values.days.each do |day|
+          open_time = time_parse(param_values.times[0])
+          close_time = time_parse(param_values.times[1])
+          open_hours[valid_days.index(day)] << (open_time..close_time)
+        end
+      end
+      self
+    end
+
+    def open_at?(date_time)
+      dt = date_time.to_datetime
+      day = dt.wday
+      time = dt.strftime("%H:%M")
+      time = time_parse(time)
+      if open_hours[day]
+        open_hours[day].any? {|x| x.cover?(time) }
+      else
+        false
+      end
+    end
+
+    private
+
+    def check_params(params)
+      params.each do |param|
+        day_and_time = param.split(' ')
+        raise ArgumentError unless day_and_time.count == 2
+
+        day_range = day_and_time[0]
+        time_range = day_and_time[1]
+
+        days = day_range.split('-')
+
+        raise ArgumentError unless (1..2).cover?(days.count)
+
+        days.each do |day|
+          raise ArgumentError unless valid_days.include?(day)
+        end
+
+        times = time_range.split('-')
+
+        raise ArgumentError unless times.count == 2
+
+        times.each do |time|
+          raise ArgumentError unless time.match(/\d\d:\d\d/)
+        end
+
+      end
+    end
+
+    def parse_param(param)
+      day_and_time = param.split(' ')
+      day_range = day_and_time[0]
+      time_range = day_and_time[1]
+
+      days = day_range.split('-')
+
+      if day_range.include?('-') && days.count == 2
+        start_day = valid_days.index(days[0])
+        end_day = valid_days.index(days[1])
+        days = valid_days[start_day..end_day]
+      end
+
+      days.each do |day|
+        unless open_hours[valid_days.index(day)]
+          open_hours[valid_days.index(day)] = []
+        end
+      end
+
+      times = time_range.split('-')
+      x = OpenStruct.new
+      x.times = times
+      x.days = days
+      x
+    end
+
+
+    def open_hours
+      @open_hours ||= {}
+    end
+
+    def time_parse(t)
+      t = Time.parse(t)
+      (t.hour * 60) + t.min
+    end
+
+    def valid_days
+      %w(Su Mo Tu We Th Fr Sa)
+    end
+  end
+end

data/open_hours.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_hours/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_hours"
+  spec.version       = OpenHours::VERSION
+  spec.authors       = ["Ian Whitney"]
+  spec.email         = ["whit0694@umn.edu"]
+  spec.summary       = %q{Parser for the OpeningHours schema from schema.org.}
+  spec.description   = %q{Library that parses date ranges in the openingHours format https://schema.org/openingHours.}
+  spec.homepage      = "https://github.com/umn-asr/open_hours"
+  spec.license       = ""
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/open_hours_spec.rb

@@ -0,0 +1,114 @@
+require "rspec/core"
+require_relative "../lib/open_hours"
+
+describe OpeningHours::OpenHours do
+  let(:good_param_examples) {[
+    ["Mo-Th 08:00-16:30", "Fr 08:00-16:00"],
+    "Mo-Th 08:00-16:30",
+  ]}
+
+  describe "parse" do
+    describe "with good params" do
+      it "returns an instance of OpenHours" do
+        good_param_examples.each do |good_params|
+          it = OpeningHours.parse(good_params)
+          expect(it).to be_a OpeningHours::OpenHours
+        end
+      end
+    end
+
+    describe "with no params" do
+      it "raises an ArgumentError" do
+        expect {OpeningHours.parse()}.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "with params that don't conform to the openingHours schema" do
+      let(:bad_param_examples) {[
+        "Mon 08:00-16:00",
+        "08:00-16:00",
+        "Mo 0800-16:00",
+        "Mo 08:00-1600",
+        "Mo 08:0016:00",
+        "No 08:00-16:00",
+        "Mo08:00-16:00",
+        "Mo-Thu 08:00-16:00",
+        "MoTh 08:00-16:00",
+        "Mo-Th08:00-16:00"
+      ]}
+
+      it "raises an ArgumentError" do
+        bad_param_examples.each do |bad_params|
+          expect {OpeningHours.parse(bad_params)}.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+
+  describe "open_at?" do
+    describe "params" do
+      it "requires something that can be parsed with strftime" do
+        param = DateTime.now
+        expect(param).to receive(:to_datetime) { DateTime.now }
+        it = OpeningHours.parse(good_param_examples.sample)
+        it.open_at?(param)
+      end
+    end
+
+    describe "date/time within opening hours" do
+      before do
+        @it = OpeningHours.parse(["Mo-Th 08:00-16:30", "Fr 08:00-16:00"])
+      end
+
+      it "returns true if date and time is the first mintue of open hours" do
+        time = DateTime.parse("Monday, June 16 2014 08:00")
+        expect(@it.open_at?(time)).to be_truthy
+      end
+
+      it "returns true if date and time is the last minute of open hours" do
+        time = DateTime.parse("Monday, June 16 2014 16:30")
+        expect(@it.open_at?(time)).to be_truthy
+      end
+
+      it "returns true for a time for each day in range" do
+        %w(Tuesday Wednesday Thursday).each do |day|
+          time = DateTime.parse("#{day}, June 16 2014 16:30")
+          expect(@it.open_at?(time)).to be_truthy
+        end
+      end
+
+      it "returns true for a time for a single day" do
+        time = DateTime.parse("Friday, June 16 2014 12:30")
+        expect(@it.open_at?(time)).to be_truthy
+      end
+    end
+
+    describe "date/time outside opening hours" do
+      before do
+        @it = OpeningHours.parse(["Mo-Th 08:00-16:30", "Fr 08:00-16:00"])
+      end
+
+      it "returns false if the time is before open hours" do
+        time = DateTime.parse("Monday, June 16 2014 07:59")
+        expect(@it.open_at?(time)).to be_falsey
+      end
+
+      it "returns false if the time is after open hours" do
+        time = DateTime.parse("Monday, June 16 2014 16:31")
+        expect(@it.open_at?(time)).to be_falsey
+      end
+
+      it "returns false if the time is in open hours, but on an unspecified day" do
+        time = DateTime.parse("Saturday, June 21 2014 12:30")
+        expect(@it.open_at?(time)).to be_falsey
+        time = DateTime.parse("Sunday, June 22 2014 12:30")
+        expect(@it.open_at?(time)).to be_falsey
+      end
+
+      it "returns false if the time is in open hours for a different day, but not this day" do
+        time = DateTime.parse("Friday, June 20 2014 16:01")
+        expect(@it.open_at?(time)).to be_falsey
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: open_hours
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ian Whitney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+description: Library that parses date ranges in the openingHours format https://schema.org/openingHours.
+email:
+- whit0694@umn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_hours.rb
+- lib/open_hours/version.rb
+- open_hours.gemspec
+- spec/open_hours_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/umn-asr/open_hours
+licenses:
+- ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Parser for the OpeningHours schema from schema.org.
+test_files:
+- spec/open_hours_spec.rb
+- spec/spec_helper.rb