time_range_extractor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e17089d12415100a06670d2ba9ceb8b47427a5e62130dc5eb10731a2848ffa8
+  data.tar.gz: b042513dea3c4f1e90b160455fb3952e716815d473aa39e40fabb6ed749d95b7
+SHA512:
+  metadata.gz: 81a5b69e52bd8ee93dd5f5e16e5646bb5b209cf1da30b88723e9b0bdf41ed56d28b63f5e77535bfe35f44543563041ac161a42e4ae9db588c5a99eceae4e8af1
+  data.tar.gz: 71bae72527430763653b3f8d6f32b3caea965bb403db4c574c75b2c4af07506678e11138da4106e0c86c4b4dd99d127afc06ecab372b1589583f3256780ebab8

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    time_range_extractor (0.1.0)
+      activesupport (> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  time_range_extractor!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jeremy Baker
+
+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,76 @@
+# Time Range Extractor
+
+This gem makes it easy to extract a time range from some text. The goal is to be able to pull out start and end times from a body of text so that you can give more context to the information.
+
+For example:
+
+```ruby
+result = TimeRangeExtractor.call("Meet with Jessie from 4-5pm")
+result.begin
+#=> 2019-06-20 16:00:00 -0700
+result.end
+#=> 2019-06-20 17:00:00 -0700
+```
+
+A few caveats:
+
+- Only reads out the first time it can find
+- If only one time is found, that becomes the start time
+- Only the last time zone is taken into account
+- Doesn't support 24 hour clocks yet
+- Likely no support for international times
+- Check the test suite for supported cases
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_range_extractor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_range_extractor
+
+## Usage
+
+```ruby
+result = TimeRangeExtractor.call("Meet with Jessie from 4-5pm")
+result.begin
+#=> 2019-06-24 16:00:00 -0700
+result.end
+#=> 2019-06-24 17:00:00 -0700
+
+result = TimeRangeExtractor.call("Meet with Jessie at 4pm EDT", date: 4.days.ago.to_date)
+result.begin
+#=> 2019-06-20 16:00:00 -0400
+result.end
+#=> 2019-06-20 16:00:00 -0400
+
+Time.zone = 'America/Vancouver'
+
+result = TimeRangeExtractor.call("Meet with Jessie at 4pm EDT", date: 4.days.ago.to_date)
+result.begin
+#=> Thu, 20 Jun 2019 13:00:00 PDT -07:00
+result.end
+#=> Thu, 20 Jun 2019 13:00:00 PDT -07:00
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/retailzipline/time_range_extractor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "time_range_extractor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/time_range_extractor.rb

@@ -0,0 +1,15 @@
+require "time"
+require "date"
+require "active_support/time"
+
+require "time_range_extractor/match_result"
+require "time_range_extractor/parser"
+require "time_range_extractor/version"
+
+module TimeRangeExtractor
+  class Error < StandardError; end
+
+  def self.call(text, date: Date.current)
+    Parser.new(text, date: date).call
+  end
+end

data/lib/time_range_extractor/match_result.rb

@@ -0,0 +1,56 @@
+class MatchResult
+  def initialize(match_data)
+    @match_data = match_data
+  end
+
+  def start_time
+    match_data[:start_time]
+  end
+
+  def start_period
+    @start_period ||= match_data[:start_period].presence || begin
+      start_t = start_time.to_i
+      end_t = end_time.to_i
+
+      if end_period.casecmp("pm") == 0 && (start_t > end_t || (end_t == 12 && start_t < end_t))
+        "am"
+      else
+        "pm"
+      end
+    end
+  end
+
+  def end_time
+    match_data[:end_time]
+  end
+
+  def end_period
+    match_data[:end_period]
+  end
+
+  def time_zone
+    match_data[:time_zone]
+  end
+
+  def start_time_string
+    if range?
+      [start_time, start_period, time_zone].compact.join(' ')
+    else
+      end_time && [end_time, end_period, time_zone].compact.join(' ')
+    end
+  end
+
+  def end_time_string
+    return start_time_string unless range?
+
+    [end_time, end_period, time_zone].compact.join(' ')
+  end
+
+  private
+
+  def range?
+    start_time.present? && end_time.present?
+  end
+
+  attr_reader :match_data
+end

data/lib/time_range_extractor/parser.rb

@@ -0,0 +1,33 @@
+class Parser
+  PATTERN = Regexp.new(
+    '(?i)((?<start_time>[0-9]{1,2}:?[0-9]{0,2}?)\s?(?<start_period>am|pm)?\s?(-|until)\s?)?(?<end_time>[0-9]{1,2}:?[0-9]{0,2})?\s?(?<end_period>am|pm)\s?(?<time_zone>[a-z][sd]t)?\b',
+    Regexp::IGNORECASE
+  ).freeze
+
+  def initialize(text, date: Date.current)
+    @text = text
+    @date = date
+  end
+
+  def call
+    result = PATTERN.match(@text)
+    return nil unless result
+
+    match_result = MatchResult.new(result)
+
+    start_time = time_from_string(match_result.start_time_string)
+    end_time = time_from_string(match_result.end_time_string)
+
+    start_time..end_time
+  end
+
+  private
+
+  def time_from_string(string)
+    time_parser.parse("#{@date.to_s(:db)} #{string}")
+  end
+
+  def time_parser
+    ::Time.zone ? ::Time.zone : ::Time
+  end
+end

data/lib/time_range_extractor/version.rb

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

data/time_range_extractor.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "time_range_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_range_extractor"
+  spec.version       = TimeRangeExtractor::VERSION
+  spec.authors       = ["Jeremy Baker"]
+  spec.email         = ["jhubert@gmail.com"]
+
+  spec.summary       = %q{Extract a time range from a block of text.}
+  spec.homepage      = "https://github.com/retailzipline/time_range_extractor"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/retailzipline/time_range_extractor"
+  spec.metadata["changelog_uri"] = "https://github.com/retailzipline/time_range_extractor/CHANGELOG"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: time_range_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Baker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jhubert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/time_range_extractor.rb
+- lib/time_range_extractor/match_result.rb
+- lib/time_range_extractor/parser.rb
+- lib/time_range_extractor/version.rb
+- time_range_extractor.gemspec
+homepage: https://github.com/retailzipline/time_range_extractor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/retailzipline/time_range_extractor
+  source_code_uri: https://github.com/retailzipline/time_range_extractor
+  changelog_uri: https://github.com/retailzipline/time_range_extractor/CHANGELOG
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Extract a time range from a block of text.
+test_files: []