Recurring natural input

Author: eelcoj

app/controllers/events_controller.rb

@@ -16,6 +16,6 @@ def create
   private
 
   def event_params
-    params.expect(event: [:title, :starts_at, :ends_at, :recurring_type, :recurring_day, :recurring_interval, :recurring_until])
+    params.expect(event: [:title, :starts_at, :ends_at, :recurring_rule, :recurring_until])
   end
 end

app/javascript/controllers/recurring_controller.js

@@ -0,0 +1,26 @@
+import { Controller } from "@hotwired/stimulus"
+import { RecurringParser } from "src/recurring_parser"
+
+export default class extends Controller {
+  static targets = ["input", "feedback"]
+
+  parse(event) {
+    const result = this.#parser.parse(event.currentTarget.value)
+
+    if (result.valid) {
+      this.feedbackTarget.textContent = "✓"
+
+      this.inputTarget.value = JSON.stringify(result.rule)
+    } else {
+      this.feedbackTarget.textContent = "Don't know wht you mean…"
+
+      this.inputTarget.value = ""
+    }
+  }
+
+  // private
+
+  get #parser() {
+    return new RecurringParser({ backend: "iceCube" })
+  }
+}

app/javascript/src/date_helpers.js

@@ -0,0 +1,39 @@
+export const DAYS = {
+  mon: "monday",
+  tue: "tuesday",
+  wed: "wednesday",
+  thu: "thursday",
+  fri: "friday",
+  sat: "saturday",
+  sun: "sunday"
+}
+
+export const MONTHS = {
+  jan: "january",
+  feb: "february",
+  mar: "march",
+  apr: "april",
+  may: "may",
+  jun: "june",
+  jul: "july",
+  aug: "august",
+  sep: "september",
+  oct: "october",
+  nov: "november",
+  dec: "december"
+}
+
+export const dayPattern = `(${Object.keys(DAYS).join("|")}|${Object.values(DAYS).join("|")})`
+export const monthPattern = `(${Object.keys(MONTHS).join("|")}|${Object.values(MONTHS).join("|")})`
+
+export function dayToNumber(day) {
+  const normalizedDay = DAYS[day.toLowerCase()] || day.toLowerCase()
+
+  return Object.values(DAYS).indexOf(normalizedDay)
+}
+
+export function monthToNumber(month) {
+  const normalizedMonth = MONTHS[month.toLowerCase()] || month.toLowerCase()
+
+  return Object.values(MONTHS).indexOf(normalizedMonth) + 1
+}

app/javascript/src/recurring_parser.js

@@ -0,0 +1,29 @@
+import { iceCube } from "src/recurring_parser/backends/ice_cube"
+import { patterns } from "src/recurring_parser/patterns"
+
+export class RecurringParser {
+  static backends = { iceCube }
+
+  constructor(options = {}) {
+    this.backend = RecurringParser.backends[options.backend || "iceCube"]
+  }
+
+  parse(input) {
+    if (!input?.trim()) return { valid: false }
+
+    let result = { valid: false }
+
+    Object.values(patterns).forEach(pattern => {
+      const matches = input.match(pattern.regex)
+
+      if (!matches) return
+
+      result = {
+        valid: true,
+        rule: pattern.parse(matches, this.backend)
+      }
+    })
+
+    return result
+  }
+}

app/javascript/src/recurring_parser/backends/ice_cube.js

@@ -0,0 +1,35 @@
+export const iceCube = {
+  daily: () => ({
+    rule_type: "IceCube::DailyRule",
+    validations: {},
+    interval: 1
+  }),
+
+  weekly: (day) => ({
+    rule_type: "IceCube::WeeklyRule",
+    validations: { day: [day] },
+    interval: 1
+  }),
+
+  biweekly: (day) => ({
+    rule_type: "IceCube::WeeklyRule",
+    validations: { day: [day] },
+    interval: 2
+  }),
+
+  monthly_day: (dayNum) => ({
+    rule_type: "IceCube::MonthlyRule",
+    validations: { day_of_month: [dayNum] },
+    interval: 1
+  }),
+
+  yearly_on: (month, day) => ({
+    rule_type: "IceCube::YearlyRule",
+    validations: {
+      month_of_year: [month],
+      day_of_month: [day]
+    },
+
+    interval: 1
+  })
+}

app/javascript/src/recurring_parser/patterns.js

@@ -0,0 +1,54 @@
+import {
+  dayPattern,
+  monthPattern,
+  dayToNumber,
+  monthToNumber
+} from "src/date_helpers"
+
+export const patterns = {
+  daily: {
+    regex: /^every\s+day|daily$/i,
+    parse: (_, backend) => backend.daily()
+  },
+
+  weekly: {
+    regex: new RegExp(`^(?:every\\s+week|weekly)(?:\\s+on\\s+${dayPattern})?$`, "i"),
+    parse: (matches, backend) => {
+      const currentDay = new Date().getDay()
+      const day = matches[1] ? dayToNumber(matches[1]) : currentDay
+
+      return backend.weekly(day)
+    }
+  },
+
+  biweekly: {
+    regex: new RegExp(`^(?:every\\s+2\\s+weeks?|bi-?weekly)(?:\\s+on\\s+${dayPattern})?$`, "i"),
+    parse: (matches, backend) => {
+      const currentDay = new Date().getDay()
+      const day = matches[1] ? dayToNumber(matches[1]) : currentDay
+
+      return backend.biweekly(day)
+    }
+  },
+
+  monthly: {
+    regex: /^(?:every\s+month|monthly)(?:\s+on\s+(the\s+)?(\d{1,2})(?:st|nd|rd|th)?)?$/i,
+    parse: (matches, backend) => {
+      const currentDay = new Date().getDate()
+      const dayNum = matches[2] ? parseInt(matches[2]) : currentDay
+
+      return backend.monthly_day(dayNum)
+    }
+  },
+
+  yearly: {
+    regex: new RegExp(`^(?:every\\s+year|yearly)(?:\\s+on\\s+${monthPattern}(?:\\s+(\\d{1,2})(?:st|nd|rd|th)?)?)?$`, "i"),
+    parse: (matches, backend) => {
+      const currentDate = new Date()
+      const month = matches[1] ? monthToNumber(matches[1]) : currentDate.getMonth() + 1
+      const day = matches[2] ? parseInt(matches[2]) : currentDate.getDate()
+
+      return backend.yearly_on(month, day)
+    }
+  }
+}

app/models/event.rb

@@ -1,4 +1,4 @@
 class Event < ApplicationRecord
   include Recurrence
-  include Recurrence::Builder
+  # include Recurrence::Builder
 end

app/views/events/_form.html.erb

@@ -14,14 +14,12 @@
     <%= form.datetime_field :ends_at, required: true %>
   </div>
 
-  <div>
-    <%= form.label :recurring_type, "Repeats" %>
-    <%= form.select :recurring_type, [
-      ["Daily", "daily"],
-      ["Weekly", "weekly"],
-      ["Every 2 weeks", "biweekly"],
-      ["Monthly", "monthly"]
-    ], { include_blank: "No recurrence" } %>
+  <div data-controller="recurring">
+    <%= form.label :natural_recurring %>
+    <%= form.text_field :natural_recurring, data: {action: "recurring#parse"} %>
+    <%= form.hidden_field :recurring_rule, data: {recurring_target: "input"} %>
+
+    <small data-recurring-target="feedback"></small>
   </div>
 
   <div>

config/importmap.rb

@@ -4,4 +4,7 @@
 pin "@hotwired/turbo-rails", to: "turbo.min.js"
 pin "@hotwired/stimulus", to: "stimulus.min.js"
 pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
+
+pin_all_from "app/javascript/src", under: "src", to: "src"
+
 pin_all_from "app/javascript/controllers", under: "controllers"