time_range_extractor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae3fd0114820e0c7e12998845f431cc773db52560cd687b96d7d77cfd69fdb5
-  data.tar.gz: 6886b6b01041131120e3eb1255f0bcf3276b3c8b261b4063eb733347eddea671
+  metadata.gz: bf2c1d9136b7a6848c9d825270247db561b0ba192053d073e54082be4c9de551
+  data.tar.gz: 2e0e4ceea8c4d6c859f8250e531180b6d673751c711b4aca6cda97e0b6be4096
 SHA512:
-  metadata.gz: 331bd280feae421065c43a354f23c827093ecb6b947848a88e1802d1ea5fdc60277399127edb5673c4b9c344178db6b2897401f08e0aad1b14f305f5b953ea8a
-  data.tar.gz: ab0785859f3f17a665124698a47c85463aa40d76592c7b365e84b1fafe7351ad0535df45c61b7c325e4e90c46e7918f9f27f90e50857ce016006ef649d29ee1f
+  metadata.gz: b31febd8ac057bf97106c33ab121ec42fa82ff5e67717130927ffd18437f5b45f9f0a6a87b0a8fcee94f6065a766962af647978cdadfe1921b24f2dec3999cce
+  data.tar.gz: d3dab6a41d87700bd62353c52af31e439fd4d4e63bf0fbb4bc21e9b9d65a49b06f3e96359e1bb4ecd0adba551cbf18f9714c3a638860f92e352d458a766835c5

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.5.3
+  Exclude:
+    - bin/*
+    - tmp/**/*
+    - Rakefile
+    - Gemfile
+    - '*.gemspec'
+    - Guardfile
+
+# Prefer x > 0 vs x.positive?
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+# Raise vs Fail seems to be an on-going debate with no significant impact.
+# Fixing our style to raise.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Small enough project that documentation can just be in the README
+Style/Documentation:
+  Enabled: false
+
+# Prefer two line empty methods
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_range_extractor (0.1.0)
+    time_range_extractor (0.1.2)
       activesupport (> 2.0)
 
 GEM
@@ -12,20 +12,105 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.1.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    guard-reek (1.2.0)
+      guard-compat (~> 1.1)
+      reek
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.3)
+    kwalify (0.7.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
     minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    reek (5.4.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  guard (>= 2)
+  guard-minitest (>= 2.4)
+  guard-reek (>= 1.2.0)
+  guard-rubocop (>= 1.3.0)
   minitest (~> 5.0)
   rake (~> 10.0)
   time_range_extractor!

data/Guardfile

@@ -0,0 +1,15 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { 'test/time_range_extractor_test.rb' }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end
+
+guard :rubocop, keep_failed: false do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard 'reek' do
+  watch(%r{.+\.rb$})
+  watch('.reek')
+end

data/lib/time_range_extractor/match_result.rb

@@ -1,22 +1,21 @@
+# frozen_string_literal: true
+
 class MatchResult
   def initialize(match_data)
     @match_data = match_data
   end
 
+  def valid?
+    @match_data && (start_time.present? || end_time.present?)
+  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
-        end_period
-      end
+      force_start_period_to_am? ? 'am' : end_period
     end
   end
 
@@ -52,5 +51,13 @@ class MatchResult
     start_time.present? && end_time.present?
   end
 
+  def force_start_period_to_am?
+    start_t = start_time.to_i
+    end_t = end_time.to_i
+
+    end_period.casecmp('pm') == 0 &&
+      (start_t > end_t || (end_t == 12 && start_t < end_t))
+  end
+
   attr_reader :match_data
 end

data/lib/time_range_extractor/parser.rb

@@ -1,8 +1,25 @@
+# frozen_string_literal: true
+
+# Parse out time values from a string of text. Uses the provided date as the
+# basis for the DateTime generation.
 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
+  PATTERN = /
+    (\A|\s|\() # space or round bracket, to support: "Call Jim (8-9pm)"
+    (
+      (?<start_time>[1-2]?[0-9]:?[0-9]{2}?)\s?
+      (?<start_period>am|pm)?\s?
+      (to|-|until)\s?
+    )?
+    (?<end_time>[1-2]?[0-9]:?[0-9]{2}?)?\s?
+    (?<end_period>am|pm)\s?
+    (?<time_zone>(
+      [ABCDEFGHIJKLMNOPRSTUVWY]
+      [A-Z]
+      [ACDEGHKLMNORSTUVW]?
+      [CDNSTW]?
+      [T]?
+    ))?\b
+  /xi.freeze
 
   def initialize(text, date: Date.current)
     @text = text
@@ -10,11 +27,16 @@ class Parser
   end
 
   def call
-    result = PATTERN.match(@text)
-    return nil unless result
+    match = PATTERN.match(@text)
+    result = MatchResult.new(match)
+    return nil unless result.valid?
+
+    time_range_from(result)
+  end
 
-    match_result = MatchResult.new(result)
+  private
 
+  def time_range_from(match_result)
     start_time = time_from_string(match_result.start_time_string)
     end_time = time_from_string(match_result.end_time_string)
 
@@ -23,15 +45,16 @@ class Parser
     elsif start_time > end_time
       start_time..(end_time + 1.day)
     end
+  rescue ArgumentError
+    nil
   end
 
-  private
-
   def time_from_string(string)
-    time_parser.parse("#{@date.to_s(:db)} #{string}")
+    time_parser.parse(string, @date.to_time)
   end
 
+  # :reek:UtilityFunction so that we can optionally include ActiveSupport
   def time_parser
-    ::Time.zone ? ::Time.zone : ::Time
+    ::Time.zone || ::Time
   end
 end

data/lib/time_range_extractor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TimeRangeExtractor
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/time_range_extractor.rb

@@ -1,10 +1,12 @@
-require "time"
-require "date"
-require "active_support/time"
+# frozen_string_literal: true
 
-require "time_range_extractor/match_result"
-require "time_range_extractor/parser"
-require "time_range_extractor/version"
+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

data/time_range_extractor.gemspec

@@ -30,4 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "guard", ">= 2"
+  spec.add_development_dependency "guard-minitest", ">= 2.4"
+  spec.add_development_dependency "guard-reek", ">= 1.2.0"
+  spec.add_development_dependency "guard-rubocop", ">= 1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_range_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeremy Baker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: 
 email:
 - jhubert@gmail.com
@@ -74,9 +130,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile