toilet_tracker 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64738532b1c80623a41ce64ead3709e4802702b03f87c593ccbc7edbeb1ab7a6
-  data.tar.gz: 18c6967a7280153c7e8b0022bb4e8d42e2a422870e3d0af92e5a5b57c23f57eb
+  metadata.gz: 4e179c9943225797758be0ca803a1dcde9ee9f7b98ee7466d74cb208a49040b8
+  data.tar.gz: ea5b5ab8fb0e4da1ca4a8e7e48575bc72a9a967769c375e52e11dcfab3dd4801
 SHA512:
-  metadata.gz: 1e45b15dc41c8d141284bd94abb2d650052722b02344830f8b06fcb264d7e2e0cb320ac2c845d11280eb3e1faa1cfa12ff2b670a65df4b5535f7b1b563517723
-  data.tar.gz: 86504e632326c8f0c21a6ee3b7845bc129a809e1573c6efc2796232eed6dacffd02037a718c556db233b7e64aee1ab6cbc69efa701b4a657a7429eba492eeb94
+  metadata.gz: 33081c85110a522542ae3c50209cbe5a1d302bb34bb513bc4c6118daaabf0093673e37695a7200818ed77d5e37bd725e22074a7898cd82f63df9518c105beaf9
+  data.tar.gz: 0ebf346d3c2afde44224885c4879bad74e1d29203c7c2f567fc573fbc989e48eee71f613257707df3e4b4359a861356111cd1e2395f9035d573259de6d0579c8

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025-12-18
+
+### Changed
+- Update activesupport to 8.1.1 (from 8.0.2.1)
+- Update rubyzip to 3.2.2 (from 3.0.1)
+- Update rake to 13.3.1 (from 13.3.0)
+- Update rspec to 3.13.2 (from 3.13.1)
+- Update overcommit to 0.68.0 (from 0.67.1)
+- Relax version constraints for activesupport and rubyzip
+
+## [0.2.0] - 2025-12-18
+
+### Added
+- Metadata emoji support for both 💩 and 🚽 commands
+- Format: `[command emoji] [metadata emojis...] [shift/timezone] [time]`
+- Metadata stored as array of individual emoji strings
+- New `metadata` field on `PoopEventResult` and `ToiletShiftResult`
+- `BaseParser#parse_metadata` and `#metadata_emoji?` helper methods
+- Comprehensive test suite for metadata parsing (28 new tests)
+
+### Changed
+- All regex patterns updated to capture optional metadata group
+- Result objects now include `metadata: []` by default (backward compatible)
+
 ## [0.1.1] - 2025-12-18
 
 ### Added

data/PARSING_SPEC.md

@@ -20,6 +20,24 @@ All WhatsApp messages follow this format:
 - **Functional Shifts**: Applied to event timestamps (patterns 1, 2, 5)
 - **Decorative Shifts**: For statistics only, do not affect timestamps (patterns 7, 9)
 
+### Metadata Emojis
+Both 💩 and 🚽 commands support optional metadata emojis placed between the command emoji and the time/shift specifications. Metadata emojis are stored as an array and can be used for additional categorization or tagging of events.
+
+**Format**: `[command emoji] [metadata emojis...] [shift/timezone] [time]`
+
+**Examples**:
+- `💩 🩸` → Event with metadata `["🩸"]`
+- `💩 🩸💧🔥` → Event with metadata `["🩸", "💧", "🔥"]`
+- `💩 🩸 +2` → Event with metadata `["🩸"]` and shift `+2`
+- `🚽 ✈️🌍 +5:30` → Setting with metadata `["✈️", "🌍"]` and shift `+5:30`
+
+**Behavior**:
+- Metadata is any emoji placed after the command emoji but before time specs
+- Emojis are extracted as individual grapheme clusters (supports complex emojis)
+- Command emojis (💩, 🚽) are excluded from metadata
+- Stored as an array of strings in result objects
+- Does not affect parsing of shifts, timezones, or times
+
 ## Supported Parsing Patterns
 
 ### WhatsApp Message Format
@@ -262,8 +280,9 @@ When timezone shifts are set retroactively:
   type: :shift_set | :shift_set_at_time | :timezone_set,
   status: :ok | :alert | :error,
   message: Core::Message,
-  shift: Integer,
+  shift: Integer | Float,
   effective_time: Time,
+  metadata: Array<String>,
   error_details: String | nil
 }
 ```
@@ -275,9 +294,10 @@ When timezone shifts are set retroactively:
         :event_in_timezone | :event_in_timezone_at_time,
   status: :ok | :alert | :error,
   message: Core::Message,
-  shift: Integer | nil,
+  shift: Integer | Float | nil,
   poop_time: Time,
   timezone: String | nil,
+  metadata: Array<String>,
   error_details: String | nil
 }
 ```
@@ -342,6 +362,16 @@ When timezone shifts are set retroactively:
 [02/01/25, 15:00:00] Bob: 💩 PST 2025-01-02 12:00:00
 ```
 
+### Valid Examples with Metadata
+```
+[01/01/25, 08:30:00] Alice: 💩 🩸                    # metadata: ["🩸"]
+[01/01/25, 10:00:00] Alice: 💩 🩸💧 +2               # metadata: ["🩸", "💧"], shift: 2
+[01/01/25, 12:00:00] Alice: 💩 🧱 14:30              # metadata: ["🧱"], time: 14:30
+[01/01/25, 14:00:00] Alice: 💩 🔥 +2 2025-01-01 13:00  # metadata + shift + time
+[02/01/25, 09:00:00] Bob: 🚽 ✈️ +5:30                # metadata: ["✈️"], shift: 5.5
+[02/01/25, 10:00:00] Bob: 🚽 🏠✈️ Europe/Rome        # metadata: ["🏠", "✈️"], timezone
+```
+
 ### Invalid Examples
 ```
 [01/01/25, 10:00:00] Alice: 🚽 +25        # Exceeds max_shift_hours

data/lib/toilet_tracker/configuration.rb

@@ -9,37 +9,38 @@ module ToiletTracker
     def initialize
       @default_timezone = "UTC"
       @max_shift_hours = 12
+      # Capture group 1 is always metadata emojis, subsequent groups are pattern-specific
       @message_patterns = {
-        # 💩 14:30
-        event_at_time_only: /💩\s*(\d{1,2}:\d{2})$/,
-        # 💩 +5 14:30, 💩 +5:30 14:30
-        event_at_time_only_shifted: /💩\s*([+-]?\d+(?::\d{2})?)\s+(\d{1,2}:\d{2})$/,
-        # 💩 Asia/Kolkata 14:30
-        event_in_timezone_at_time_only: %r{💩\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{1,2}:\d{2})$},
-        # 🚽 +5 14:30, 🚽 +5:30 14:30
-        shift_set_at_time_only: /🚽\s*([+-]?\d+(?::\d{2})?)\s+(\d{1,2}:\d{2})$/,
-        # 🚽 Asia/Kolkata 14:30
-        timezone_set_at_time_only: %r{🚽\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{1,2}:\d{2})$},
-        # 🚽 +2, 🚽 -3, 🚽 +5:30
-        shift_set: /🚽\s*([+-]?\d+(?::\d{2})?)$/,
-        # 🚽 +2 2025-01-15 14:30, 🚽 +5:30 2025-01-15 14:30
-        shift_set_at_time: %r{🚽\s*([+-]?\d+(?::\d{2})?)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
-        # 🚽 Europe/Rome, 🚽 PST
-        timezone_set: %r{🚽\s*([A-Za-z_/][A-Za-z0-9_/+-]*)$},
-        # 🚽 Asia/Kolkata 2025-01-15 14:30
-        timezone_set_at_time: %r{🚽\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
-        # 💩
-        event_now: /💩$/,
-        # 💩 +2, 💩 -1, 💩 +5:30
-        event_now_shifted: /💩\s*([+-]?\d+(?::\d{2})?)$/,
-        # 💩 2025-01-15 14:30
-        event_at_time: %r{💩\s*(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
-        # 💩 +2 2025-01-15 14:30, 💩 +5:30 2025-01-15 14:30
-        event_at_time_shifted: %r{💩\s*([+-]?\d+(?::\d{2})?)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
-        # 💩 Europe/Rome, 💩 PST
-        event_in_timezone: %r{💩\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s*$},
-        # 💩 Asia/Kolkata 2025-01-15 14:30
-        event_in_timezone_at_time: %r{💩\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$}
+        # 💩 🩸 14:30
+        event_at_time_only: /💩\s*([^+\-\dA-Za-z\s]*)\s*(\d{1,2}:\d{2})$/,
+        # 💩 🩸 +5 14:30, 💩 🩸 +5:30 14:30
+        event_at_time_only_shifted: /💩\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)\s+(\d{1,2}:\d{2})$/,
+        # 💩 🩸 Asia/Kolkata 14:30
+        event_in_timezone_at_time_only: %r{💩\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{1,2}:\d{2})$},
+        # 🚽 📍 +5 14:30, 🚽 📍 +5:30 14:30
+        shift_set_at_time_only: /🚽\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)\s+(\d{1,2}:\d{2})$/,
+        # 🚽 📍 Asia/Kolkata 14:30
+        timezone_set_at_time_only: %r{🚽\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{1,2}:\d{2})$},
+        # 🚽 📍 +2, 🚽 📍 -3, 🚽 📍 +5:30
+        shift_set: /🚽\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)$/,
+        # 🚽 📍 +2 2025-01-15 14:30, 🚽 📍 +5:30 2025-01-15 14:30
+        shift_set_at_time: %r{🚽\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
+        # 🚽 📍 Europe/Rome, 🚽 📍 PST
+        timezone_set: %r{🚽\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)$},
+        # 🚽 📍 Asia/Kolkata 2025-01-15 14:30
+        timezone_set_at_time: %r{🚽\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
+        # 💩, 💩 🩸
+        event_now: /💩\s*([^+\-\dA-Za-z\s]*)$/,
+        # 💩 🩸 +2, 💩 🩸 -1, 💩 🩸 +5:30
+        event_now_shifted: /💩\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)$/,
+        # 💩 🩸 2025-01-15 14:30
+        event_at_time: %r{💩\s*([^+\-\dA-Za-z\s]*)\s*(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
+        # 💩 🩸 +2 2025-01-15 14:30, 💩 🩸 +5:30 2025-01-15 14:30
+        event_at_time_shifted: %r{💩\s*([^+\-\dA-Za-z\s]*)\s*([+-]?\d+(?::\d{2})?)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$},
+        # 💩 🩸 Europe/Rome, 💩 🩸 PST
+        event_in_timezone: %r{💩\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s*$},
+        # 💩 🩸 Asia/Kolkata 2025-01-15 14:30
+        event_in_timezone_at_time: %r{💩\s*([^+\-\dA-Za-z\s]*)\s*([A-Za-z_/][A-Za-z0-9_/+-]*)\s+(\d{4}[-/]\d{1,2}[-/]\d{1,2}\s+\d{1,2}:\d{1,2}(?::\d{1,2})?)$}
       }
       @date_formats = [
         "%Y-%m-%d %H:%M:%S",

data/lib/toilet_tracker/core/parse_result.rb

@@ -22,15 +22,15 @@ module ToiletTracker
     end
 
     # Result for toilet shift settings
-    ToiletShiftResult = Data.define(:type, :status, :message, :shift, :effective_time, :error_details) do
-      def initialize(type:, status:, message:, shift: nil, effective_time: nil, error_details: nil)
+    ToiletShiftResult = Data.define(:type, :status, :message, :shift, :effective_time, :metadata, :error_details) do
+      def initialize(type:, status:, message:, shift: nil, effective_time: nil, metadata: [], error_details: nil)
         super
       end
     end
 
     # Result for poop events
-    PoopEventResult = Data.define(:type, :status, :message, :shift, :poop_time, :timezone, :error_details) do
-      def initialize(type:, status:, message:, shift: nil, poop_time: nil, timezone: nil, error_details: nil)
+    PoopEventResult = Data.define(:type, :status, :message, :shift, :poop_time, :timezone, :metadata, :error_details) do
+      def initialize(type:, status:, message:, shift: nil, poop_time: nil, timezone: nil, metadata: [], error_details: nil)
         super
       end
     end

data/lib/toilet_tracker/parsers/base_parser.rb

@@ -98,6 +98,21 @@ module ToiletTracker
         time_diff = (message_time - event_time).abs
         (time_diff > 30.days) ? :alert : :ok
       end
+
+      def parse_metadata(metadata_string)
+        return [] if metadata_string.nil? || metadata_string.strip.empty?
+
+        metadata_string.grapheme_clusters
+          .reject { |char| char.match?(/\s/) }
+          .select { |char| metadata_emoji?(char) }
+      end
+
+      def metadata_emoji?(char)
+        return false if char.match?(/\A[\p{ASCII}]\z/)
+        return false if %w[💩 🚽].include?(char)
+
+        char.match?(/\p{Emoji}/) && !char.match?(/\A\d\z/)
+      end
     end
   end
 end

data/lib/toilet_tracker/parsers/message_parser.rb

@@ -96,7 +96,7 @@ module ToiletTracker
       def parse_poop_type(type, match, message)
         case type
         when :event_now
-          parse_poop_live(message)
+          parse_poop_live(match, message)
         when :event_now_shifted
           parse_poop_live_shift(match, message)
         when :event_at_time
@@ -111,20 +111,23 @@ module ToiletTracker
       end
 
       def parse_toilet_shift(match, message)
-        shift = parse_shift(match[1])
+        metadata = parse_metadata(match[1])
+        shift = parse_shift(match[2])
 
         Core::ToiletShiftResult.new(
           type: :shift_set,
           status: :ok,
           message: message,
           shift: shift,
-          effective_time: message.timestamp
+          effective_time: message.timestamp,
+          metadata: metadata
         )
       end
 
       def parse_toilet_shift_with_time(match, message)
-        shift = parse_shift(match[1])
-        effective_time = parse_datetime(match[2], @current_message)
+        metadata = parse_metadata(match[1])
+        shift = parse_shift(match[2])
+        effective_time = parse_datetime(match[3], @current_message)
 
         status = determine_status(effective_time, message.timestamp)
 
@@ -133,12 +136,14 @@ module ToiletTracker
           status: status,
           message: message,
           shift: shift,
-          effective_time: effective_time
+          effective_time: effective_time,
+          metadata: metadata
         )
       end
 
       def parse_toilet_timezone(match, message)
-        timezone_str = match[1]
+        metadata = parse_metadata(match[1])
+        timezone_str = match[2]
         shift = calculate_shift_from_timezone(timezone_str)
 
         Core::ToiletShiftResult.new(
@@ -146,13 +151,15 @@ module ToiletTracker
           status: :ok,
           message: message,
           shift: shift,
-          effective_time: message.timestamp
+          effective_time: message.timestamp,
+          metadata: metadata
         )
       end
 
       def parse_toilet_timezone_with_time(match, message)
-        timezone_str = match[1]
-        datetime_str = match[2]
+        metadata = parse_metadata(match[1])
+        timezone_str = match[2]
+        datetime_str = match[3]
 
         effective_time = parse_datetime(datetime_str, @current_message)
         status = determine_status(effective_time, message.timestamp)
@@ -163,7 +170,8 @@ module ToiletTracker
           status: status,
           message: message,
           shift: shift,
-          effective_time: effective_time
+          effective_time: effective_time,
+          metadata: metadata
         )
       end
 
@@ -176,30 +184,36 @@ module ToiletTracker
         (shift == shift.to_i) ? shift.to_i : shift
       end
 
-      def parse_poop_live(message)
+      def parse_poop_live(match, message)
+        metadata = parse_metadata(match[1])
+
         Core::PoopEventResult.new(
           type: :event_now,
           status: :ok,
           message: message,
           shift: 0,
-          poop_time: message.timestamp
+          poop_time: message.timestamp,
+          metadata: metadata
         )
       end
 
       def parse_poop_live_shift(match, message)
-        shift = parse_shift(match[1])
+        metadata = parse_metadata(match[1])
+        shift = parse_shift(match[2])
 
         Core::PoopEventResult.new(
           type: :event_now_shifted,
           status: :ok,
           message: message,
           shift: shift,
-          poop_time: message.timestamp
+          poop_time: message.timestamp,
+          metadata: metadata
         )
       end
 
       def parse_poop_past(match, message)
-        poop_time = parse_datetime(match[1], @current_message)
+        metadata = parse_metadata(match[1])
+        poop_time = parse_datetime(match[2], @current_message)
         status = determine_status(poop_time, message.timestamp)
 
         Core::PoopEventResult.new(
@@ -207,13 +221,15 @@ module ToiletTracker
           status: status,
           message: message,
           shift: 0,
-          poop_time: poop_time
+          poop_time: poop_time,
+          metadata: metadata
         )
       end
 
       def parse_poop_past_with_shift(match, message)
-        shift = parse_shift(match[1])
-        poop_time = parse_datetime(match[2], @current_message)
+        metadata = parse_metadata(match[1])
+        shift = parse_shift(match[2])
+        poop_time = parse_datetime(match[3], @current_message)
         status = determine_status(poop_time, message.timestamp)
 
         Core::PoopEventResult.new(
@@ -221,25 +237,29 @@ module ToiletTracker
           status: status,
           message: message,
           shift: shift,
-          poop_time: poop_time
+          poop_time: poop_time,
+          metadata: metadata
         )
       end
 
       def parse_poop_timezone(match, message)
-        timezone_str = match[1]
+        metadata = parse_metadata(match[1])
+        timezone_str = match[2]
 
         Core::PoopEventResult.new(
           type: :event_in_timezone,
           status: :ok,
           message: message,
           poop_time: message.timestamp,
-          timezone: timezone_str
+          timezone: timezone_str,
+          metadata: metadata
         )
       end
 
       def parse_poop_timezone_with_time(match, message)
-        timezone_str = match[1]
-        poop_time = parse_datetime(match[2], @current_message)
+        metadata = parse_metadata(match[1])
+        timezone_str = match[2]
+        poop_time = parse_datetime(match[3], @current_message)
         status = determine_status(poop_time, message.timestamp)
 
         Core::PoopEventResult.new(
@@ -247,7 +267,8 @@ module ToiletTracker
           status: status,
           message: message,
           poop_time: poop_time,
-          timezone: timezone_str
+          timezone: timezone_str,
+          metadata: metadata
         )
       end
     end

data/lib/toilet_tracker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ToiletTracker
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toilet_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - NetherSoul
@@ -13,16 +13,22 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 8.0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 8.0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.2.0
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -41,16 +47,22 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement