michel 0.1.0

data/SECURITY.md

@@ -0,0 +1,2 @@
+<!-- START /templates/security.md -->
+<!-- END /templates/security.md -->

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "michel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/michel/install/install_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/base"
+require "scenic"
+module Michel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializer
+        copy_file "michel.rb", "config/initializers/michel.rb"
+      end
+    end
+  end
+end

data/lib/generators/michel/install/templates/michel.rb

@@ -0,0 +1,5 @@
+Michel.setup do |config|
+  config.resource_class_name = "Resource"
+  config.booking_class_name = "Booking"
+  config.availability_class_name = "Availability"
+end

data/lib/generators/michel/view/templates/belongs_to_associations.erb

@@ -0,0 +1,6 @@
+  belongs_to :<%=Michel.availability_class_symbol%>
+  belongs_to :<%=Michel.resource_class_symbol%>
+
+  def self.refresh
+    Scenic.database.refresh_materialized_view(table_name, concurrently: false, cascade: false)
+  end

data/lib/generators/michel/view/templates/has_many_associations.erb

@@ -0,0 +1,2 @@
+
+  has_many :available_time_slots

data/lib/generators/michel/view/templates/index_migration.erb

@@ -0,0 +1,15 @@
+
+    reversible do |direction|
+      direction.up do
+        execute <<-SQL
+          CREATE EXTENSION IF NOT EXISTS btree_gist;
+          CREATE INDEX on <%=Michel.booking_class_table_name%> using gist (<%=Michel.resource_class_foreign_id%>, tsrange(start_time, start_time + interval '1 minute' * duration, '()'));
+        SQL
+      end
+      direction.down do
+        execute <<-SQL
+          DROP INDEX <%=Michel.booking_class_table_name%>_<%=Michel.resource_class_foreign_id%>_tsrange_idx;
+          DROP EXTENSION IF EXISTS btree_gist;
+        SQL
+      end
+    end

data/lib/generators/michel/view/templates/view.erb

@@ -0,0 +1,95 @@
+WITH RECURSIVE time_slots AS (
+  -- Generate a series of dates for the next year, starting from tomorrow
+  SELECT
+    p.id AS <%=Michel.availability_class_foreign_id%>,
+    p.<%=Michel.resource_class_foreign_id%>,
+    -- what is DATE_TRUNC?
+    -- DATE_TRUNC('week', CURRENT_DATE) returns the first day of the week
+    (DATE_TRUNC('week', CURRENT_DATE) + (p.weekday - 1 || ' days')::interval) AS start_date,
+    CURRENT_DATE + INTERVAL '6 months' AS end_date,
+    p.start_time,
+    p.end_time,
+    p.timezone
+  FROM
+    <%=Michel.availability_class_table_name%> p
+  UNION ALL
+  -- Recursively generate dates for all instances of the given weekday
+  SELECT
+    ts.<%=Michel.availability_class_foreign_id%>,
+    ts.<%=Michel.resource_class_foreign_id%>,
+    ts.start_date + INTERVAL '1 week' AS start_date,  -- Explicitly alias the column
+    ts.end_date,
+    ts.start_time,
+    ts.end_time,
+    ts.timezone
+  FROM
+    time_slots ts
+  WHERE
+    ts.start_date + INTERVAL '1 week' <= ts.end_date
+),
+-- Generate time slots for each day, every 15 minutes
+slot_intervals AS (
+  SELECT
+    ts.<%=Michel.availability_class_foreign_id%>,
+    ts.<%=Michel.resource_class_foreign_id%>,
+    ts.start_date,
+
+    -- Create proper timestamps for start and end times with timezone handling
+    (make_timestamptz(
+      date_part('year', ts.start_date)::integer,
+      date_part('month', ts.start_date)::integer,
+      date_part('day', ts.start_date)::integer,
+      split_part(ts.start_time, ':', 1)::int,
+      split_part(ts.start_time, ':', 2)::int,
+      0,
+      ts.timezone
+    )) AT TIME ZONE 'UTC' AS slot_start_time,
+
+    (make_timestamptz(
+      date_part('year', ts.start_date)::integer,
+      date_part('month', ts.start_date)::integer,
+      date_part('day', ts.start_date)::integer,
+      split_part(ts.end_time, ':', 1)::int,
+      split_part(ts.end_time, ':', 2)::int,
+      0,
+      ts.timezone
+    )) AT TIME ZONE 'UTC' AS slot_end_time
+  FROM
+    time_slots ts
+),
+time_slots_every_15_min AS (
+  SELECT
+    si.<%=Michel.availability_class_foreign_id%>,
+    si.<%=Michel.resource_class_foreign_id%>,
+    si.start_date,
+
+    -- Generate the series for time slots every 15 minutes
+    generate_series(
+      GREATEST(si.slot_start_time, CURRENT_DATE + INTERVAL '1 day'),
+      -- Ensure it starts from tomorrow
+      si.slot_end_time - INTERVAL '30 minutes',
+      INTERVAL '15 minutes'
+    ) AS slot_start_time
+  FROM
+    slot_intervals si
+)
+SELECT
+  concat(<%=Michel.availability_class_foreign_id%>, slot_start_time) AS id,
+  <%=Michel.availability_class_foreign_id%>,
+  <%=Michel.resource_class_foreign_id%>,
+  slot_start_time as start_time,
+  slot_start_time + INTERVAL '30 minutes' AS end_time
+FROM
+  time_slots_every_15_min
+EXCEPT
+            SELECT
+              concat(<%=Michel.availability_class_foreign_id%>, slot_start_time) AS id,
+              time_slots_every_15_min.<%=Michel.availability_class_foreign_id%>,
+              time_slots_every_15_min.<%=Michel.resource_class_foreign_id%>,
+              time_slots_every_15_min.slot_start_time as start_time,
+              time_slots_every_15_min.slot_start_time + INTERVAL '30 minutes' AS end_time
+            FROM       time_slots_every_15_min
+            CROSS JOIN <%=Michel.booking_class_table_name%>
+            WHERE      tsrange(<%=Michel.booking_class_table_name%>.start_time, <%=Michel.booking_class_table_name%>.start_time + interval '1 minute' * <%=Michel.booking_class_table_name%>.duration, '()')
+                      && tsrange(time_slots_every_15_min.slot_start_time, time_slots_every_15_min.slot_start_time + INTERVAL '30 minutes', '()')
+            AND <%=Michel.booking_class_table_name%>.<%=Michel.resource_class_foreign_id%> = time_slots_every_15_min.<%=Michel.resource_class_foreign_id%>

data/lib/generators/michel/view/templates/view_migration.rb

@@ -0,0 +1,8 @@
+  unless defined?(Scenic)
+    raise "Scenic gem must be included in the Gemfile to run this migration"
+  end
+  def down
+    drop_view :available_time_slots, materialized: true
+  end
+
+  

data/lib/generators/michel/view/view_generator.rb

@@ -0,0 +1,59 @@
+require "rails/generators"
+require "scenic"
+module Michel
+  module Generators
+    class ViewGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      include Scenic
+
+      def create_index_in_migration
+        self.destination_root = Rails.root
+
+        puts "Generating #{Michel.booking_class_table_name} index migration"
+        invoke "migration", ["add_index_to_#{Michel.booking_class_table_name}"]
+        index_migration_content = template_content("index_migration.erb")
+        Dir.glob(Rails.root.join("db/migrate/*add_index_to_#{Michel.booking_class_table_name}.rb")).each do |file|
+          inject_into_file file, index_migration_content, after: "def change"
+        end
+      end
+
+      def create_scenic_model
+        self.destination_root = Rails.root
+        puts "Creating scenic model available_time_slot"
+
+        invoke "scenic:model", ["available_time_slots"], {"materialized" => true, "test_framework" => false}
+
+        Dir.glob(Rails.root.join("db/migrate/*create_available_time_slots.rb")).each do |file|
+          gsub_file file, /change/, "up"
+          inject_into_class file, "CreateAvailableTimeSlots", template_content("view_migration.rb")
+        end
+      end
+
+      def create_sql_file
+        puts "Creating materialized view SQL at db/views/available_time_slots_v01.sql"
+        template "view.erb", "db/views/available_time_slots_v01.sql", {force: true}
+      end
+
+      def add_associations_to_models
+        has_many_associations = template_content("has_many_associations.erb")
+
+        inject_into_class "app/models/#{Michel.availability_class_underscore}.rb", Michel.availability_class_name,
+          has_many_associations
+        inject_into_class "app/models/#{Michel.resource_class_underscore}.rb", Michel.resource_class_name,
+          has_many_associations
+        belongs_to_associations = template_content("belongs_to_associations.erb")
+        case behavior
+        when :invoke
+          inject_into_class "app/models/available_time_slot.rb", "AvailableTimeSlot", belongs_to_associations
+        end
+      end
+
+      private
+
+      def template_content(filename)
+        template = File.read(File.join(self.class.source_root, filename))
+        ERB.new(template).result(binding)
+      end
+    end
+  end
+end

data/lib/michel/version.rb

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

data/lib/michel.rb

@@ -0,0 +1,60 @@
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
+module Michel
+  class Error < StandardError; end
+
+  mattr_accessor :resource_class_name
+  mattr_accessor :booking_class_name
+  mattr_accessor :availability_class_name
+
+  def self.setup
+    yield self
+  end
+
+  def self.resource_class_symbol
+    @@resource_class_name.underscore.to_sym
+  end
+
+  def self.resource_class_foreign_id
+    @@resource_class_name.foreign_key
+  end
+
+  def self.resource_class_underscore
+    @@resource_class_name.underscore
+  end
+
+  def self.booking_class_symbol
+    @@booking_class_name.underscore.to_sym
+  end
+
+  def self.booking_class_table_name
+    @@booking_class_name.tableize
+  end
+
+  def self.booking_class_foreign_id
+    @@booking_class_name.foreign_key
+  end
+
+  def self.booking_class_underscore
+    @@booking_class_name.underscore
+  end
+
+  def self.availability_class_symbol
+    @@availability_class_name.underscore.to_sym
+  end
+
+  def self.availability_class_table_name
+    @@availability_class_name.tableize
+  end
+
+  def self.availability_class_foreign_id
+    @@availability_class_name.foreign_key
+  end
+
+  def self.availability_class_underscore
+    @@availability_class_name.underscore
+  end
+end

data/michel.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/michel/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "michel"
+  spec.version = Michel::VERSION
+  spec.authors = ["Sally Hall", "Aji Slater"]
+  spec.email = ["sally@thoughtbot.com", "aji.slater@gmail.com"]
+
+  spec.summary = "Generator to help with appointment scheduling"
+  spec.homepage = "https://github.com/thoughtbot/michel/"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 = `git ls-files`.split("\n")
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activerecord", ">= 7.0.0"
+  spec.add_dependency "pg", "~> 1.0"
+  spec.add_dependency "scenic", "~>1.9"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/michel.rbs

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

data/spec/example-app/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.5

data/spec/example-app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/example-app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/spec/example-app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/spec/example-app/app/models/appointment.rb

@@ -0,0 +1,3 @@
+class Appointment < ApplicationRecord
+  belongs_to :physician
+end

data/spec/example-app/app/models/physician.rb

@@ -0,0 +1,4 @@
+class Physician < ApplicationRecord
+  has_many :physician_availabilities
+  has_many :appointments
+end

data/spec/example-app/app/models/physician_availability.rb

@@ -0,0 +1,3 @@
+class PhysicianAvailability < ApplicationRecord
+  belongs_to :physician
+end

data/spec/example-app/bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/o
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/o
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/spec/example-app/bin/dev

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+exec "./bin/rails", "server", *ARGV

data/spec/example-app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/example-app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/example-app/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args, exception: true)
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  unless ARGV.include?("--skip-server")
+    puts "\n== Starting development server =="
+    $stdout.flush # flush the output before exec(2) so that it displays
+    exec "bin/dev"
+  end
+end

data/spec/example-app/config/application.rb

@@ -0,0 +1,44 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module ExampleApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 8.0
+
+    # Please, add to the `ignore` list any other `lib` subdirectories that do
+    # not contain `.rb` files, or that should not be reloaded or eager loaded.
+    # Common ones are `templates`, `generators`, or `middleware`, for example.
+    config.autoload_lib(ignore: %w[assets tasks])
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+
+    # Only loads a smaller set of middleware suitable for API only apps.
+    # Middleware like session, flash, cookies can be added back manually.
+    # Skip views, helpers and assets when generating a new resource.
+    config.api_only = true
+  end
+end

data/spec/example-app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.

data/spec/example-app/config/credentials.yml.enc

@@ -0,0 +1 @@
+bPcLj+RUYOcXjiYTK/tVFqiUjCdvnCrBcVyybZ8age2+5F5tTftPfpHy+As4XBK2AiVooOQHs8lcm2PNAsRUOoTOMG9Y+edynBb1Af0TsYfMq0vKJwJz1D/1TT6Ddf+MCvbxUqA6NvJQpQy4x5pNP2tAX29YeWKr2XsggtvwZJ4C78DMhoL8fqgich+iIsBF86QXU7XBj64L2cEsVIpm/s4KFqeig0s6XGl0m0/euy8NKysMj3jBw4LrokvYbG7BsN3meBjVupFkeI+BGxpH8+2LXeevVtTDKq+bx+rfe8n5FMXH7DPMwQMZt/6ggRlMFvW/JUxGwZt8l24Rmw6yXZelw7pGqG0MxbPOe6MIL5gxAjM7Oyk+Sb3Km6ilW0D2ZKAnXUKw5rj3Xo8l4xn2ZUf51P6/JhnYy53rFiIP1ByMUEBq6ON1GqQ+pkGJYAHCCcDifLZUuIaNULcVkizrfJKOOtz0h0y5NZWLB/yT+EkfmyjiYrD5uS/o--IUEzH9/T2+Rx416h--1A4772sIfBvMfSKf9NL7wQ==