michel 0.1.0

data/spec/example-app/config/database.yml

@@ -0,0 +1,85 @@
+# PostgreSQL. Versions 9.3 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On macOS with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem "pg"
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # https://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+
+development:
+  <<: *default
+  database: example_app_development
+
+  # The specified database role being used to connect to PostgreSQL.
+  # To create additional roles in PostgreSQL see `$ createuser --help`.
+  # When left blank, PostgreSQL will use the default role. This is
+  # the same name as the operating system user running Rails.
+  #username: example_app
+
+  # The password associated with the PostgreSQL role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: example_app_test
+
+# As with config/credentials.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password or a full connection URL as an environment
+# variable when you boot the app. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# If the connection URL is provided in the special DATABASE_URL environment
+# variable, Rails will automatically merge its configuration values on top of
+# the values provided in this file. Alternatively, you can specify a connection
+# URL environment variable explicitly:
+#
+#   production:
+#     url: <%= ENV["MY_APP_DATABASE_URL"] %>
+#
+# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full overview on how database connection configuration can be specified.
+#
+production:
+  <<: *default
+  database: example_app_production
+  username: example_app
+  password: <%= ENV["EXAMPLE_APP_DATABASE_PASSWORD"] %>

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

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/example-app/config/environments/development.rb

@@ -0,0 +1,49 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Make code changes take effect immediately without server restart.
+  config.enable_reloading = true
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing.
+  config.server_timing = true
+
+  # Enable/disable Action Controller caching. By default Action Controller caching is disabled.
+  # Run rails dev:cache to toggle Action Controller caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.public_file_server.headers = {"cache-control" => "public, max-age=#{2.days.to_i}"}
+  else
+    config.action_controller.perform_caching = false
+  end
+
+  # Change to :null_store to avoid any caching.
+  config.cache_store = :memory_store
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Append comments with runtime information tags to SQL queries in logs.
+  config.active_record.query_log_tags_enabled = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Raise error when a before_action's only/except options reference missing actions.
+  config.action_controller.raise_on_missing_callback_actions = true
+end

data/spec/example-app/config/environments/production.rb

@@ -0,0 +1,64 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.enable_reloading = false
+
+  # Eager load code on boot for better performance and memory savings (ignored by Rake tasks).
+  config.eager_load = true
+
+  # Full error reports are disabled.
+  config.consider_all_requests_local = false
+
+  # Cache assets for far-future expiry since they are all digest stamped.
+  config.public_file_server.headers = {"cache-control" => "public, max-age=#{1.year.to_i}"}
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = "http://assets.example.com"
+
+  # Assume all access to the app is happening through a SSL-terminating reverse proxy.
+  config.assume_ssl = true
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  config.force_ssl = true
+
+  # Skip http-to-https redirect for the default health check endpoint.
+  # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } }
+
+  # Log to STDOUT with the current request id as a default log tag.
+  config.log_tags = [:request_id]
+  config.logger = ActiveSupport::TaggedLogging.logger($stdout)
+
+  # Change to "debug" to log everything (including potentially personally-identifiable information!)
+  config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
+
+  # Prevent health checks from clogging up the logs.
+  config.silence_healthcheck_path = "/up"
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Replace the default in-process memory cache store with a durable alternative.
+  # config.cache_store = :mem_cache_store
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+
+  # Only use :id for inspections in production.
+  config.active_record.attributes_for_inspect = [:id]
+
+  # Enable DNS rebinding protection and other `Host` header attacks.
+  # config.hosts = [
+  #   "example.com",     # Allow requests from example.com
+  #   /.*\.example\.com/ # Allow requests from subdomains like `www.example.com`
+  # ]
+  #
+  # Skip DNS rebinding protection for the default health check endpoint.
+  # config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
+end

data/spec/example-app/config/environments/test.rb

@@ -0,0 +1,42 @@
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # While tests run files are not watched, reloading is not necessary.
+  config.enable_reloading = true
+
+  # Eager loading loads your entire application. When running a single test locally,
+  # this is usually not necessary, and can slow down your test suite. However, it's
+  # recommended that you enable it in continuous integration systems to ensure eager
+  # loading is working properly before deploying your code.
+  config.eager_load = ENV["CI"].present?
+
+  # Configure public file server for tests with cache-control for performance.
+  config.public_file_server.headers = {"cache-control" => "public, max-age=3600"}
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+  config.cache_store = :null_store
+
+  # Render exception templates for rescuable exceptions and raise for other exceptions.
+  config.action_dispatch.show_exceptions = :rescuable
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Raise error when a before_action's only/except options reference missing actions.
+  config.action_controller.raise_on_missing_callback_actions = true
+end

data/spec/example-app/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin Ajax requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins "example.com"
+#
+#     resource "*",
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/spec/example-app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file.
+# Use this to limit dissemination of sensitive information.
+# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors.
+Rails.application.config.filter_parameters += [
+  :passw, :email, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn, :cvv, :cvc
+]

data/spec/example-app/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/spec/example-app/config/locales/en.yml

@@ -0,0 +1,31 @@
+# Files in the config/locales directory are used for internationalization and
+# are automatically loaded by Rails. If you want to use locales other than
+# English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more about the API, please read the Rails Internationalization guide
+# at https://guides.rubyonrails.org/i18n.html.
+#
+# Be aware that YAML interprets the following case-insensitive strings as
+# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings
+# must be quoted to be interpreted as strings. For example:
+#
+#     en:
+#       "yes": yup
+#       enabled: "ON"
+
+en:
+  hello: "Hello world"

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

@@ -0,0 +1,38 @@
+# This configuration file will be evaluated by Puma. The top-level methods that
+# are invoked here are part of Puma's configuration DSL. For more information
+# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
+#
+# Puma starts a configurable number of processes (workers) and each process
+# serves each request in a thread from an internal thread pool.
+#
+# You can control the number of workers using ENV["WEB_CONCURRENCY"]. You
+# should only set this value when you want to run 2 or more workers. The
+# default is already 1.
+#
+# The ideal number of threads per worker depends both on how much time the
+# application spends waiting for IO operations and on how much you wish to
+# prioritize throughput over latency.
+#
+# As a rule of thumb, increasing the number of threads will increase how much
+# traffic a given process can handle (throughput), but due to CRuby's
+# Global VM Lock (GVL) it has diminishing returns and will degrade the
+# response time (latency) of the application.
+#
+# The default is set to 3 threads as it's deemed a decent compromise between
+# throughput and latency for the average Rails application.
+#
+# Any libraries that use a connection pool or another resource pool should
+# be configured to provide at least as many connections as the number of
+# threads. This includes Active Record's `pool` parameter in `database.yml`.
+threads_count = ENV.fetch("RAILS_MAX_THREADS", 3)
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+port ENV.fetch("PORT", 3000)
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart
+
+# Specify the PID file. Defaults to tmp/pids/server.pid in development.
+# In other environments, only set the PID file if requested.
+pidfile ENV["PIDFILE"] if ENV["PIDFILE"]

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

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the app is live.
+  get "up" => "rails/health#show", :as => :rails_health_check
+
+  # Defines the root path route ("/")
+  # root "posts#index"
+end

data/spec/example-app/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/spec/example-app/db/migrate/20250829205200_create_physicians.rb

@@ -0,0 +1,8 @@
+class CreatePhysicians < ActiveRecord::Migration[8.0]
+  def change
+    create_table :physicians do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/spec/example-app/db/migrate/20250829205205_create_appointments.rb

@@ -0,0 +1,10 @@
+class CreateAppointments < ActiveRecord::Migration[8.0]
+  def change
+    create_table :appointments do |t|
+      t.references :physician
+      t.datetime :start_time, null: false
+      t.integer :duration, null: false         # minutes
+      t.timestamps
+    end
+  end
+end

data/spec/example-app/db/migrate/20250829205257_create_availabilities.rb

@@ -0,0 +1,12 @@
+class CreateAvailabilities < ActiveRecord::Migration[8.0]
+  def change
+    create_table :physician_availabilities do |t|
+      t.references :physician
+      t.integer :weekday, null: false          # 1 = Monday, etc
+      t.string :start_time, null: false       # '09:00'
+      t.string :end_time, null: false         # '17:00'
+      t.string :timezone, null: false         # e.g. 'UTC'
+      t.timestamps
+    end
+  end
+end

data/spec/example-app/db/schema.rb

@@ -0,0 +1,42 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[8.0].define(version: 2025_08_29_205257) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "pg_catalog.plpgsql"
+
+  create_table "appointments", force: :cascade do |t|
+    t.bigint "physician_id"
+    t.datetime "start_time", null: false
+    t.integer "duration", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["physician_id"], name: "index_appointments_on_physician_id"
+  end
+
+  create_table "physician_availabilities", force: :cascade do |t|
+    t.bigint "physician_id"
+    t.integer "weekday", null: false
+    t.string "start_time", null: false
+    t.string "end_time", null: false
+    t.string "timezone", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["physician_id"], name: "index_physician_availabilities_on_physician_id"
+  end
+
+  create_table "physicians", force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+end

data/spec/example-app/db/seeds.rb

@@ -0,0 +1,9 @@
+# This file should ensure the existence of records required to run the application in every environment (production,
+# development, test). The code here should be idempotent so that it can be executed at any point in every environment.
+# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
+#
+# Example:
+#
+#   ["Action", "Comedy", "Drama", "Horror"].each do |genre_name|
+#     MovieGenre.find_or_create_by!(name: genre_name)
+#   end

data/spec/example-app/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/spec/generators/michel/install/install_generator_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+require "generators/michel/install/install_generator"
+
+RSpec.describe Michel::Generators::InstallGenerator, :generator do
+  it "generates initializer file" do
+    destination File.expand_path("../../../../../tmp", __FILE__)
+    prepare_destination
+
+    run_generator
+    initializer = file("config/initializers/michel.rb")
+
+    # is_expected_to contain - verifies the file's contents
+    expect(initializer).to contain(/Michel.setup do |config|/)
+    expect(initializer).to contain(/config.resource_class_name = "Resource"/)
+    expect(initializer).to contain(/config.booking_class_name = "Booking"/)
+    expect(initializer).to contain(/config.availability_class_name = "Availability"/)
+  end
+end

data/spec/generators/michel/view/view_generator_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "generators/michel/view/view_generator"
+
+RSpec.describe Michel::Generators::ViewGenerator, :generator do
+  before(:all) do
+    Michel.setup do |config|
+      config.resource_class_name = "Physician"
+      config.booking_class_name = "Appointment"
+      config.availability_class_name = "PhysicianAvailability"
+    end
+    Rails::Generators.invoke("michel:view")
+
+    ActiveRecord::MigrationContext.new(Rails.root.join("db/migrate")).migrate
+    Rails.autoloaders.main.reload
+  end
+
+  after(:all) do
+    ActiveRecord::MigrationContext.new(Rails.root.join("db/migrate")).rollback(2)
+    Rails::Generators.invoke("michel:view", [], behavior: :revoke)
+  end
+
+  it "generates available time slots" do
+    doctor = Physician.create!(name: "Dr. Seuss")
+
+    PhysicianAvailability.create!(
+      physician: doctor,
+      weekday: Date.tomorrow.wday, # ensures it aligns with tomorrow
+      start_time: "09:00",
+      end_time: "10:00",
+      timezone: "UTC"
+    )
+
+    AvailableTimeSlot.refresh
+    slots = AvailableTimeSlot.all
+
+    expect(slots).not_to be_empty
+    expect(slots.first.start_time.hour).to eq(9)
+  end
+
+  it "excludes slots that overlap with a booking" do
+    doctor = Physician.create!(name: "Dr. Seuss")
+    PhysicianAvailability.create!(
+      physician: doctor,
+      weekday: Date.tomorrow.wday, # ensures it aligns with tomorrow
+      start_time: "09:00",
+      end_time: "10:00",
+      timezone: "UTC"
+    )
+
+    # Book a 30min slot at 9:00
+    Appointment.create!(
+      physician: doctor,
+      start_time: Date.tomorrow.beginning_of_day + 9.hours,
+      duration: 30
+    )
+
+    AvailableTimeSlot.refresh
+
+    # Now the 9:00 slot should not be available
+    slot_times = AvailableTimeSlot.pluck(:start_time)
+    expect(slot_times).not_to include(Date.tomorrow.beginning_of_day + 9.hours)
+  end
+end

data/spec/lib/michel_spec.rb

@@ -0,0 +1,60 @@
+require "michel"
+RSpec.describe Michel do
+  before do
+    Michel.setup do |config|
+      config.resource_class_name = "Physician"
+      config.booking_class_name = "Appointment"
+      config.availability_class_name = "PhysicianAvailability"
+    end
+  end
+
+  describe "resource helpers" do
+    it "returns correct symbol" do
+      expect(Michel.resource_class_symbol).to eq(:physician)
+    end
+
+    it "returns correct foreign key" do
+      expect(Michel.resource_class_foreign_id).to eq("physician_id")
+    end
+
+    it "returns correct underscored name" do
+      expect(Michel.resource_class_underscore).to eq("physician")
+    end
+  end
+
+  describe "booking helpers" do
+    it "returns correct symbol" do
+      expect(Michel.booking_class_symbol).to eq(:appointment)
+    end
+
+    it "returns correct table name" do
+      expect(Michel.booking_class_table_name).to eq("appointments")
+    end
+
+    it "returns correct foreign key" do
+      expect(Michel.booking_class_foreign_id).to eq("appointment_id")
+    end
+
+    it "returns correct underscored name" do
+      expect(Michel.booking_class_underscore).to eq("appointment")
+    end
+  end
+
+  describe "availability helpers" do
+    it "returns correct symbol" do
+      expect(Michel.availability_class_symbol).to eq(:physician_availability)
+    end
+
+    it "returns correct table name" do
+      expect(Michel.availability_class_table_name).to eq("physician_availabilities")
+    end
+
+    it "returns correct foreign key" do
+      expect(Michel.availability_class_foreign_id).to eq("physician_availability_id")
+    end
+
+    it "returns correct underscored name" do
+      expect(Michel.availability_class_underscore).to eq("physician_availability")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Dir.glob("#{__dir__}/support/**/*.rb").each { |f| require f }
+require File.expand_path("../../spec/example-app/config/environment", __FILE__)
+require "michel"
+require "scenic"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.around(:each) do |example|
+    ActiveRecord::SchemaMigration
+      .new(ActiveRecord::Tasks::DatabaseTasks.migration_connection_pool)
+      .create_table
+
+    DatabaseCleaner.start
+    example.run
+    DatabaseCleaner.clean
+  end
+end