eventuale 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85ab77a3a97e7307b74eb8d11c38940bf57cb3f8ed291631d5919ca5fcd30391
+  data.tar.gz: e85009280853829b859f8e6c013f57867a606ee8dd63f38091c8f48e53383a56
+SHA512:
+  metadata.gz: cb765edefa9e13eace6608de79faa8e4689e7bb215b785c70d06328360d1a054a6a93e8bba21a2cb1b02f01870b640f00252875fb6f976b49f0e497a2695cff7
+  data.tar.gz: 4d67fa6f008bb63a2c6dbc1f4b338bd1f70afa05ab2d92190218dedab9efdc1d7727bc11449bd3ef6c8d627e373b04b70c64d12e951dbf1a8fc6f3fe4545b044

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-08-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"eventuale" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["giuseppe.bertini@gmail.com"](mailto:"giuseppe.bertini@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Giuseppe
+
+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,68 @@
+# Eventuale
+
+Eventuale manages simple, independent daily calendars for Active Record models.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```ruby
+gem "eventuale"
+```
+
+## Usage
+
+The model needs `start:datetime`, `duration:integer` (minutes), and
+`position:integer`. Declare any additional calendar scope just as you would
+with `positioning`:
+
+If the model does not have those columns yet, generate a migration first:
+
+```sh
+bin/rails generate eventuale:install Appointment
+```
+
+```ruby
+class Appointment < ApplicationRecord
+  belongs_to :doctor
+  eventualmente on: :doctor
+end
+```
+
+Each doctor's events are positioned and timed independently for each calendar
+date. The basic API is `advance`, `postpone`, `advance_by(int)`,
+`postpone_by(int)`, `move_to(position_or_datetime)`,
+`reschedule(start:, duration:)`, `append(attributes)`, and
+`prepend(attributes)`. Scheduling operations recalculate positions and
+contiguous start times together, so position order always matches the
+timeline.
+
+Use `reschedule` when changing an event's `start` and/or `duration`:
+
+```ruby
+appointment.reschedule(start: new_start, duration: 30)
+```
+
+Use the dedicated scheduling methods instead of updating `start`, `duration`,
+or `position` directly through Active Record. Ordinary model attributes can
+still be updated normally.
+
+Eventuale deliberately does not define multi-day event behavior yet.
+
+## 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 the created tag, 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/[USERNAME]/eventuale. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/eventuale/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Eventuale project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/eventuale/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/eventuale/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Eventuale
+  VERSION = "0.1.0"
+end

data/lib/eventuale.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative "eventuale/version"
+require "active_support/concern"
+require "active_support/core_ext/date_and_time/calculations"
+require "active_support/time"
+require "positioning"
+
+module Eventuale
+  class Error < StandardError; end
+
+  # Daily scheduling behavior added to Active Record models.
+  # rubocop:disable Metrics/ModuleLength
+  module Calendar
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Declares independent calendars for every combination of +on+ values.
+      def eventualmente(on: [])
+        @eventuale_calendar_scope = Array(on).map(&:to_sym)
+      end
+
+      def eventuale_calendar_scope
+        @eventuale_calendar_scope || []
+      end
+    end
+
+    def advance(slots = 1)
+      advance_by(slots)
+    end
+
+    def advance_by(slots)
+      move_to(position - integer_slots!(slots))
+    end
+
+    def postpone(slots = 1)
+      postpone_by(slots)
+    end
+
+    def postpone_by(slots)
+      move_to(position + integer_slots!(slots))
+    end
+
+    def reschedule(start: self.start, duration: self.duration)
+      ensure_persisted!
+      self.duration = duration
+
+      if start == self.start
+        self.class.transaction do
+          save!
+          normalize_current_day!
+        end
+        reload
+      else
+        move_to(start)
+      end
+    end
+
+    # Moves to a one-based position or inserts at a time on a day.
+    def move_to(destination)
+      case destination
+      when Integer
+        move_to_position(destination, calendar_day)
+      when Time, DateTime, ActiveSupport::TimeWithZone
+        move_to_time(destination)
+      else
+        raise ArgumentError, "destination must be an Integer or a datetime"
+      end
+    end
+
+    def append(attributes = {})
+      values = attributes.merge(start: start + duration_in_seconds, position: position + 1).compact
+      self.class.create!(values).tap do |record|
+        record.move_to(record.position)
+      end
+    end
+
+    def prepend(attributes = {})
+      self.class.create!(attributes.merge(start: start, position: position).compact).tap do |record|
+        record.move_to(record.position)
+      end
+    end
+
+    private
+
+    def integer_slots!(slots)
+      Integer(slots).tap { |value| raise ArgumentError, "slots must be positive" unless value.positive? }
+    rescue ArgumentError, TypeError
+      raise ArgumentError, "slots must be a positive integer"
+    end
+
+    def move_to_time(time)
+      day = time.to_date
+      target = calendar_records(day).where.not(id: id).where("start >= ?", time).order(:start, :position).first
+      move_to_position(target ? target.position : calendar_records(day).count + 1, day, start_time: time)
+    end
+
+    def move_to_position(target_position, day, start_time: nil)
+      ensure_persisted!
+      self.class.transaction { reposition!(target_position, day, start_time:) }
+      reload
+    end
+
+    def ensure_persisted!
+      raise Error, "event must be persisted" unless persisted?
+    end
+
+    def reposition!(target_position, day, start_time: nil)
+      old_day, records, anchor = repositioning_context(day)
+      insert_self(records, target_position)
+      truncate_preceding_record(records, start_time)
+      save_at_day(day) if old_day != day
+      save!
+      normalize_day!(records, anchor)
+      normalize_previous_day(old_day) if old_day != day
+    end
+
+    def truncate_preceding_record(records, start_time)
+      return unless start_time
+
+      preceding = records[records.index(self) - 1]
+      return unless preceding && preceding.start < start_time
+
+      elapsed_minutes = ((start_time - preceding.start) / 60).to_i
+      return unless elapsed_minutes.positive? && elapsed_minutes < preceding.duration.to_i
+
+      preceding.update_columns(duration: elapsed_minutes)
+    end
+
+    def repositioning_context(day)
+      old_day = calendar_day
+      records = calendar_records(day).lock.order(:position, :id).to_a
+      anchor = records.map(&:start).min || (old_day == day ? start : day.beginning_of_day)
+      [old_day, records, anchor]
+    end
+
+    def save_at_day(day)
+      self.start = day.beginning_of_day
+    end
+
+    def insert_self(records, target_position)
+      records.delete_if { |record| record.id == id }
+      target = [[Integer(target_position), 1].max, records.length + 1].min
+      records.insert(target - 1, self)
+    end
+
+    def normalize_previous_day(day)
+      records = calendar_records(day).lock.order(:position, :id).to_a
+      normalize_day!(records, records.map(&:start).min) unless records.empty?
+    end
+
+    def normalize_current_day!
+      records = calendar_records(calendar_day).lock.order(:position, :id).to_a
+      normalize_day!(records, records.map(&:start).min) unless records.empty?
+    end
+
+    def normalize_day!(records, anchor)
+      return if records.empty?
+
+      cursor = anchor
+      records.each_with_index do |record, index|
+        record.update_columns(position: index + 1, start: cursor)
+        cursor += record.duration.to_i * 60
+      end
+    end
+
+    def calendar_records(day)
+      scope = self.class.where(start: day.beginning_of_day...day.next_day.beginning_of_day)
+      calendar_scope_values.each { |column, value| scope = scope.where(column => value) }
+      scope
+    end
+
+    def calendar_scope_values
+      self.class.eventuale_calendar_scope.to_h do |name|
+        reflection = self.class.reflect_on_association(name)
+        reflection ? [reflection.foreign_key, public_send(reflection.foreign_key)] : [name, public_send(name)]
+      end
+    end
+
+    def calendar_day = start.to_date
+    def duration_in_seconds = duration.to_i * 60
+  end
+  # rubocop:enable Metrics/ModuleLength
+end
+
+ActiveSupport.on_load(:active_record) { include Eventuale::Calendar }

data/lib/generators/eventuale/install_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Eventuale
+  # Adds Eventuale's required columns to a model.
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    desc "Creates a migration with the columns Eventuale needs"
+
+    argument :model, type: :string, required: true, banner: "ModelName"
+
+    def create_migration
+      migration_template "add_eventuale_to_model.rb.erb", "db/migrate/add_eventuale_to_#{table_name}.rb"
+    end
+
+    private
+
+    def table_name
+      model.underscore.pluralize
+    end
+
+    def migration_class_name
+      "AddEventualeTo#{model.camelize.pluralize}"
+    end
+
+  end
+end

data/lib/generators/eventuale/templates/add_eventuale_to_model.rb.erb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= Rails::VERSION::STRING.to_f %>]
+  def change
+    change_table :<%= table_name %>, bulk: true do |table|
+      table.datetime :start, null: false
+      table.integer :duration, null: false
+      table.integer :position, null: false
+    end
+  end
+end

data/sig/eventuale.rbs

@@ -0,0 +1,4 @@
+module Eventuale
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: eventuale
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giuseppe Bertini
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: positioning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Keeps positioned Active Record records sequenced in independent daily
+  calendars.
+email:
+- giuseppe.bertini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/eventuale.rb
+- lib/eventuale/version.rb
+- lib/generators/eventuale/install_generator.rb
+- lib/generators/eventuale/templates/add_eventuale_to_model.rb.erb
+- sig/eventuale.rbs
+homepage: https://github.com/giuseppe/eventuale
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/giuseppe/eventuale
+  source_code_uri: https://github.com/giuseppe/eventuale
+  changelog_uri: https://github.com/giuseppe/eventuale/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: Daily calendars for Active Record models
+test_files: []