hizuke 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21dc88226bf08c961ed63958ab1dc38ca4a9c324ed2259fbfcd5cda208a43247
-  data.tar.gz: 9bb2da3217a6b090b0036e4804d4860d156dd6d996aeff8d1b2705f43c146eda
+  metadata.gz: 0b0d90523e4927c6aeac7e03575aeb0bbb9cc923e6524cf63eacfbcff6115cb8
+  data.tar.gz: b641b880ad5ac8a67a29437702aea3c7f690695d9a560c039b2eead361b4d30f
 SHA512:
-  metadata.gz: 5c8dc6d727568a43564b707858469fa75639fc93b75c49fc299f0de6a08ac88ce316a3aa27e7efbf3d35d7a26e795ba3881a9d3472628749a75b1e4213cde239
-  data.tar.gz: 46bb31b32c3e40b54973757b5e954dbd91841fc7cc09febf50d3f704e6cb312dca3e0f472ae91e2cd876fcdba7aa510fb83a8c5d813e9a524532a1dc2b6049f5
+  metadata.gz: 788e7bcd5b09046f865771f7b9fc3ef55bab5ed6b1374891ef24006d67db8e3759fadaf34d21fd9ed60bce27331ef1ca6545a0fe9cd8c272ac74265b7f97772f
+  data.tar.gz: c8a4b2c5c5d07cf3c8f3d4233121a0f92c379ff2d8caaa05804e021b19da07271deec84af4ffa2061fa98e3cf84419113a09307ae25ee402fa194e874e607f81

data/CHANGELOG.md

@@ -5,7 +5,43 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.0.3] - 2023-05-09
+## [0.1.0] - 2025-05-08
+
+### Added
+- Support for Christmas date parsing:
+  - "christmas" / "xmas" - returns December 25th of the current year
+  - "last christmas" / "lastchristmas" - returns December 25th of the previous year
+  - "next christmas" / "nextchristmas" - returns December 25th of the next year
+
+### Changed
+- Major refactoring of the entire codebase:
+  - Improved code organization and structure
+  - Better error handling and edge case management
+  - Cleaner API design for better developer experience
+
+## [0.0.4] - 2025-04-29
+
+### Added
+- Support for time recognition in text:
+  - "at X" format (e.g., "at 10" for 10:00)
+  - "@ X" alternative syntax
+  - Time with minutes "at X:Y" (e.g., "at 10:30")
+  - Time with seconds "at X:Y:Z" (e.g., "at 10:30:45")
+  - AM/PM format "at Xam/pm" (e.g., "at 10am", "at 7pm")
+- New attributes in Result class:
+  - `time` attribute to access the extracted time
+  - `datetime` method to get a combined Time object of date and time
+- Created a dedicated `TimeOfDay` class for better time handling with cleaner display
+- Support for word-based time expressions:
+  - "at noon" - returns 12:00
+  - "at midnight" - returns 00:00
+  - "in the morning" - returns configurable time (default 08:00)
+  - "in the evening" - returns configurable time (default 20:00)
+- Configuration system to customize times for "morning" and "evening"
+- Comprehensive tests for time parsing functionality
+- Updated documentation with time parsing examples and supported formats
+
+## [0.0.3] - 2025-04-24
 
 ### Added
 - Support for quarterly date references:

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hizuke.gemspec
-gemspec 
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hizuke (0.0.2)
+    hizuke (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Hizuke
 
-Hizuke is a simple Ruby gem that parses text containing date references like "yesterday", "today", and "tomorrow". It extracts the date and returns the clean text without the date reference.
+Hizuke is a simple Ruby gem that parses text containing date references like "yesterday", "today", and "tomorrow". It extracts the date and returns the clean text without the date reference. It can also recognize time references like "at 10" or "at 7pm".
 
 ## Installation
 
@@ -61,10 +61,76 @@ puts result.date  # => <Date: 2024-01-01> (represents the first day of the next
 result = Hizuke.parse("hiking this weekend")
 puts result.text  # => "hiking"
 puts result.date  # => <Date: 2023-04-01> (represents the next Saturday)
+
+# Parse text with time
+result = Hizuke.parse("meeting tomorrow at 10")
+puts result.text  # => "meeting"
+puts result.date  # => <Date: 2023-04-01> (represents tomorrow's date)
+puts result.time  # => 10:00 (represents the time)
+puts result.datetime  # => 2023-04-01 10:00:00 (combines date and time)
+
+# Parse text with time including minutes
+result = Hizuke.parse("call client today at 14:30")
+puts result.text  # => "call client"
+puts result.date  # => <Date: 2023-03-31> (represents today's date)
+puts result.time  # => 14:30 (represents the time)
+puts result.datetime  # => 2023-03-31 14:30:00 (combines date and time)
+
+# Parse text with AM/PM time
+result = Hizuke.parse("lunch meeting tomorrow at 12pm")
+puts result.text  # => "lunch meeting"
+puts result.date  # => <Date: 2023-04-01> (represents tomorrow's date)
+puts result.time  # => 12:00 (represents the time, noon)
+puts result.datetime  # => 2023-04-01 12:00:00 (combines date and time)
+
+# Parse text with word-based time
+result = Hizuke.parse("dinner tomorrow at noon")
+puts result.text  # => "dinner"
+puts result.date  # => <Date: 2023-04-01> (represents tomorrow's date)
+puts result.time  # => 12:00 (represents noon)
+
+result = Hizuke.parse("flight today at midnight")
+puts result.text  # => "flight"
+puts result.date  # => <Date: 2023-03-31> (represents today's date)
+puts result.time  # => 00:00 (represents midnight)
+
+result = Hizuke.parse("breakfast tomorrow in the morning")
+puts result.text  # => "breakfast"
+puts result.date  # => <Date: 2023-04-01> (represents tomorrow's date)
+puts result.time  # => 08:00 (default morning time)
+
+result = Hizuke.parse("dinner today in the evening")
+puts result.text  # => "dinner"
+puts result.date  # => <Date: 2023-03-31> (represents today's date)
+puts result.time  # => 20:00 (default evening time)
 ```
 
 The parser is case-insensitive and can handle date references located anywhere in the text. It also supports date references with or without spaces (e.g., "nextweek" or "next week").
 
+## Configuration
+
+You can configure the time values for "in the morning" and "in the evening" expressions:
+
+```ruby
+Hizuke.configure do |config|
+  # Set morning time to 9:30
+  config.morning_time = { hour: 9, min: 30 }
+  
+  # Set evening time to 7:00 PM
+  config.evening_time = { hour: 19, min: 0 }
+end
+
+# Now when parsing "in the morning", it will return 9:30
+result = Hizuke.parse("breakfast tomorrow in the morning")
+puts result.time  # => 09:30
+
+# And "in the evening" will return 19:00
+result = Hizuke.parse("dinner today in the evening")
+puts result.time  # => 19:00
+```
+
+By default, "in the morning" is set to 8:00 and "in the evening" is set to 20:00.
+
 ## Supported Date Keywords
 
 Currently, the following English date keywords are supported:
@@ -99,6 +165,29 @@ Currently, the following English date keywords are supported:
 - `mid month` / `midmonth` - returns the date of the 15th day of the current month
 - `next quarter` / `nextquarter` - returns the first day of the next quarter
 - `last quarter` / `lastquarter` - returns the first day of the last quarter
+- `christmas` / `xmas` - returns the date of Christmas (December 25th) of the current year (or next year if Christmas has already passed)
+- `next christmas` / `nextchristmas` - returns the date of Christmas (December 25th) of the next year
+- `last christmas` / `lastchristmas` - returns the date of Christmas (December 25th) of the previous year
+
+## Supported Time Formats
+
+The following time formats are supported:
+
+### Numeric time formats
+- `at X` - where X is a number (e.g., "at 10" for 10:00)
+- `@ X` - alternative syntax with @ symbol
+- `at X:Y` - where X is hours and Y is minutes (e.g., "at 10:30")
+- `at X:Y:Z` - where X is hours, Y is minutes, and Z is seconds
+- `at Xam/pm` - with AM/PM indicator (e.g., "at 10am", "at 7pm")
+- `at X:Yam/pm` - with minutes and AM/PM indicator (e.g., "at 10:30am")
+
+### Word-based time formats
+- `at noon` - returns 12:00
+- `at midnight` - returns 00:00
+- `in the morning` - returns configurable time (default 08:00)
+- `in the evening` - returns configurable time (default 20:00)
+
+When time is included, you can access it through the `time` attribute of the result. The time is displayed in the format "HH:MM" or "HH:MM:SS" if seconds are present. Additionally, you can use the `datetime` attribute to get a Time object combining both the date and time information.
 
 ## Development
 
@@ -108,7 +197,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/hizuke.
+Bug reports and pull requests are welcome on GitHub at https://github.com/majur/hizuke.
 
 ## License
 

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-task default: :test 
+task default: :test

data/hizuke.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/hizuke/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'hizuke'
+  spec.version = Hizuke::VERSION
+  spec.authors = ['Juraj Maťaše']
+  spec.email = ['juraj@hey.com']
+
+  spec.summary = 'A simple date parser for natural language time references'
+  spec.description = 'Hizuke is a lightweight utility that extracts dates from text ' \
+                     'by recognizing common time expressions. ' \
+                     'It cleans the original text and returns both the parsed date ' \
+                     'and the text without the date reference.'
+  spec.homepage = 'https://github.com/majur/hizuke'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Add development dependencies here
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+end

data/lib/hizuke/constants.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Hizuke
+  # Module containing constants used throughout Hizuke
+  module Constants
+    # Mapping of day names to their wday values (0-6, Sunday is 0)
+    DAYS_OF_WEEK = {
+      'monday' => 1,
+      'tuesday' => 2,
+      'wednesday' => 3,
+      'thursday' => 4,
+      'friday' => 5,
+      'saturday' => 6,
+      'sunday' => 0
+    }.freeze
+
+    # Date keywords mapping
+    DATE_KEYWORDS = {
+      'yesterday' => -1,
+      'today' => 0,
+      'tomorrow' => 1,
+      'dayaftertomorrow' => 2,
+      'day after tomorrow' => 2,
+      'daybeforeyesterday' => -2,
+      'day before yesterday' => -2,
+      'nextweek' => :next_week,
+      'next week' => :next_week,
+      'lastweek' => :last_week,
+      'last week' => :last_week,
+      'nextmonth' => :next_month,
+      'next month' => :next_month,
+      'lastmonth' => :last_month,
+      'last month' => :last_month,
+      'nextyear' => :next_year,
+      'next year' => :next_year,
+      'lastyear' => :last_year,
+      'last year' => :last_year,
+      'nextquarter' => :next_quarter,
+      'next quarter' => :next_quarter,
+      'lastquarter' => :last_quarter,
+      'last quarter' => :last_quarter,
+      'thisweekend' => :this_weekend,
+      'this weekend' => :this_weekend,
+      'endofweek' => :end_of_week,
+      'end of week' => :end_of_week,
+      'endofmonth' => :end_of_month,
+      'end of month' => :end_of_month,
+      'endofyear' => :end_of_year,
+      'end of year' => :end_of_year,
+      'midweek' => :mid_week,
+      'mid week' => :mid_week,
+      'midmonth' => :mid_month,
+      'mid month' => :mid_month,
+      'christmas' => :christmas,
+      'xmas' => :christmas,
+      'nextchristmas' => :next_christmas,
+      'next christmas' => :next_christmas,
+      'lastchristmas' => :last_christmas,
+      'last christmas' => :last_christmas
+    }.freeze
+
+    # Regex patterns for dynamic date references
+    IN_X_DAYS_PATTERN = /in (\d+) days?/i.freeze
+    X_DAYS_AGO_PATTERN = /(\d+) days? ago/i.freeze
+    IN_X_WEEKS_PATTERN = /in (\d+) weeks?/i.freeze
+    X_WEEKS_AGO_PATTERN = /(\d+) weeks? ago/i.freeze
+    IN_X_MONTHS_PATTERN = /in (\d+) months?/i.freeze
+    X_MONTHS_AGO_PATTERN = /(\d+) months? ago/i.freeze
+    IN_X_YEARS_PATTERN = /in (\d+) years?/i.freeze
+    X_YEARS_AGO_PATTERN = /(\d+) years? ago/i.freeze
+
+    # Regex patterns for specific days of the week
+    THIS_DAY_PATTERN = /this (monday|tuesday|wednesday|thursday|friday|saturday|sunday)/i.freeze
+    NEXT_DAY_PATTERN = /next (monday|tuesday|wednesday|thursday|friday|saturday|sunday)/i.freeze
+    LAST_DAY_PATTERN = /last (monday|tuesday|wednesday|thursday|friday|saturday|sunday)/i.freeze
+
+    # Regex patterns for time references
+    TIME_PATTERN = /(?:at|@)\s*(\d{1,2})(?::(\d{1,2}))?(?::(\d{1,2}))?\s*(am|pm)?/i.freeze
+
+    # Regex patterns for word-based time references
+    NOON_PATTERN = /at\s+noon/i.freeze
+    MIDNIGHT_PATTERN = /at\s+midnight/i.freeze
+    MORNING_PATTERN = /in\s+the\s+morning/i.freeze
+    EVENING_PATTERN = /in\s+the\s+evening/i.freeze
+  end
+end