particle-calendar 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ce49a6213f463b1903aada3e6bdf5bcc28a0563617934738603e14e8d83e2c
-  data.tar.gz: f27791d9393c905ca3e29d46709866100de32a3033fc9aef326f2e48f6c0dda9
+  metadata.gz: e9dccada98e81f51f44f33a7b403e3a1c1822784af127acd3ebb882942cbb3ee
+  data.tar.gz: cc94bd0ffe53aec20a7569524c4741d4a2b6a2a9a9d8a2dbdc294b622757c16b
 SHA512:
-  metadata.gz: 4b1abcf266c1caf0d698a9817506d81d10eb44f23bd7c640e2cf763e9e8e597b8ebfbd3398b70db5411174d1dc5a647ae8c4022189e213ee96bb83f228155c98
-  data.tar.gz: 006ab70996c606074c88668426be2ad0d185f2dc4c63d1cf389cfd758d4831a76cdfd922b11a0071b8c5a5a7e7e6a2081409e5a26cb148e0e186f6f0c7177e3e
+  metadata.gz: 63208f59ada5e3f59be029d064588dfea533061a18d34139a0063fb26cc5725baf5af301b49da4a14e7b1b9e68206234352814f68f47750ab3ccce9519f12e96
+  data.tar.gz: bb7143dcf7636bfe0eaa802b61c43b4787ab9ada41c2db7d5ea8c2dcb6fc010b52fe28479b6f7df07fa1be1e4275c0cf9f94c65b884aa57ff581857446e3a483

data/README.md

@@ -53,7 +53,7 @@ Create a starter configuration, an Nginx server-block sample, and the static out
 particle setup
 ```
 
-By default this writes `particle.yml` with mode `0600`, `particle.nginx.conf`, and `public/` in the current directory. It generates a long random URL path for the Nginx sample and refuses to replace either setup file if it already exists.
+By default this writes `particle.yml` with mode `0600`, `particle.nginx.conf`, `public/`, and `log/` in the current directory. It generates a long random URL path for the Nginx sample and refuses to replace either setup file if it already exists.
 
 Customize every destination when needed:
 
@@ -78,6 +78,7 @@ calendar_urls:
 
 days_to_show: 28
 minimum_slot_minutes: 60
+first_day_of_week: monday
 
 event_buffer:
   before_minutes: 30
@@ -151,6 +152,14 @@ availability:
     unavailable: true
 ```
 
+### Calendar week start
+
+`first_day_of_week` controls the first column of the rendered calendar and its week labels. It defaults to `monday`; use any lowercase weekday name, for example:
+
+```yaml
+first_day_of_week: sunday
+```
+
 ### Minimum slots and event buffers
 
 `minimum_slot_minutes` removes shorter free fragments after subtraction. The default is `0`.
@@ -235,7 +244,6 @@ Create a dedicated account or deploy as an unprivileged service user, install Ru
 ```bash
 gem install particle-calendar
 cd /opt/particle
-mkdir -p log
 particle setup --server-name calendar.example.com
 # Edit particle.yml and replace the example calendar placeholders.
 particle generate --config /opt/particle/particle.yml --output /opt/particle/public
@@ -297,6 +305,7 @@ The repository includes a [`deploy/availability.logrotate`](deploy/availability.
 - **Calendar exceeded a safe limit:** reduce an unusually large displayed range or inspect the feed privately for excessive event counts or dense recurrence rules. The generator intentionally fails before publishing rather than risking resource exhaustion.
 - **Old update timestamp:** inspect cron logs. A stale page usually means a later run failed safely.
 - **Permission denied while publishing:** the generator needs write permission on `public/`; Nginx needs read permission only.
+- **Nginx reports that `index.htmlindex.html` is not a directory:** replace the installed page locations with the current `particle.nginx.conf` example, then validate and reload Nginx. Older examples pointed a trailing-slash location directly at the file, causing Nginx's index module to append `index.html` twice.
 
 ## Known limits
 

data/config/availability.example.yml

@@ -10,6 +10,9 @@ calendar_urls:
 days_to_show: 28
 minimum_slot_minutes: 60
 
+# The calendar grid starts on Monday by default. Any lowercase weekday is accepted.
+first_day_of_week: monday
+
 event_buffer:
   before_minutes: 0
   after_minutes: 0

data/lib/availability/application.rb

@@ -68,7 +68,8 @@ module Availability
         timezone: config.timezone,
         enabled: config.enabled,
         today: today,
-        days_to_show: config.days_to_show
+        days_to_show: config.days_to_show,
+        first_day_of_week: config.first_day_of_week
       )
     end
 

data/lib/availability/cli.rb

@@ -113,6 +113,7 @@ module Availability
         config_path: File.join(@working_directory, 'particle.yml'),
         nginx_path: File.join(@working_directory, 'particle.nginx.conf'),
         output_dir: File.join(@working_directory, 'public'),
+        log_dir: File.join(@working_directory, 'log'),
         server_name: 'example.com',
         url_path: "/#{@random_path.call}/"
       }
@@ -150,6 +151,7 @@ module Availability
       @output.puts("Created #{setup.config_path} (mode 0600)")
       @output.puts("Created #{setup.nginx_path}")
       @output.puts("Created output directory #{setup.output_dir}")
+      @output.puts("Created log directory #{setup.log_dir}")
       @output.puts('Next: edit the config, run particle generate, then review and install the Nginx file.')
     end
 

data/lib/availability/config.rb

@@ -14,7 +14,7 @@ module Availability
     include ConfigValueParser
 
     TOP_LEVEL_KEYS = %w[
-      enabled timezone calendar_urls days_to_show minimum_slot_minutes event_buffer availability
+      enabled timezone calendar_urls days_to_show minimum_slot_minutes event_buffer availability first_day_of_week
     ].freeze
     EVENT_BUFFER_KEYS = %w[before_minutes after_minutes].freeze
     WEEKDAYS = %w[sunday monday tuesday wednesday thursday friday saturday].freeze
@@ -24,7 +24,7 @@ module Availability
     MAX_CALENDAR_URLS = 20
 
     attr_reader :enabled, :timezone, :calendar_urls, :days_to_show,
-                :minimum_slot_minutes, :buffer_before_minutes, :buffer_after_minutes
+                :minimum_slot_minutes, :buffer_before_minutes, :buffer_after_minutes, :first_day_of_week
 
     def self.load(path, env: ENV)
       raise ConfigError, "configuration file not found: #{path}" unless File.file?(path)
@@ -41,10 +41,7 @@ module Availability
       @raw = stringify_keys(raw)
       @env = env
       validate_known_keys(@raw, TOP_LEVEL_KEYS, 'configuration')
-      @enabled = boolean('enabled', default: true)
-      @timezone = parse_timezone
-      @days_to_show = bounded_positive_integer('days_to_show', default: 28, maximum: MAX_DAYS_TO_SHOW)
-      @minimum_slot_minutes = nonnegative_integer('minimum_slot_minutes', default: 0)
+      parse_general_settings
       parse_buffers
       @availability = parse_availability
       @calendar_urls = parse_calendar_urls
@@ -56,6 +53,14 @@ module Availability
 
     private
 
+    def parse_general_settings
+      @enabled = boolean('enabled', default: true)
+      @timezone = parse_timezone
+      @days_to_show = bounded_positive_integer('days_to_show', default: 28, maximum: MAX_DAYS_TO_SHOW)
+      @minimum_slot_minutes = nonnegative_integer('minimum_slot_minutes', default: 0)
+      @first_day_of_week = parse_first_day_of_week
+    end
+
     def stringify_keys(value)
       if value.is_a?(Hash)
         return value.each_with_object({}) do |(key, item), hash|
@@ -76,6 +81,15 @@ module Availability
       raise ConfigError, "timezone is unknown: #{name}"
     end
 
+    def parse_first_day_of_week
+      day = @raw.fetch('first_day_of_week', 'monday')
+      unless day.is_a?(String) && WEEKDAYS.include?(day)
+        raise ConfigError, "first_day_of_week must be one of: #{WEEKDAYS.join(', ')}"
+      end
+
+      day
+    end
+
     def parse_buffers
       buffer = @raw.fetch('event_buffer', {})
       raise ConfigError, 'event_buffer must be a mapping' unless buffer.is_a?(Hash)

data/lib/availability/renderer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'cgi'
+require 'date'
 require 'erb'
 
 module Availability
@@ -12,14 +13,15 @@ module Availability
       @template = ERB.new(File.read(template_path), trim_mode: '-')
     end
 
-    def render(days:, generated_at:, timezone:, enabled:, today:, days_to_show:)
+    def render(days:, generated_at:, timezone:, enabled:, today:, days_to_show:, first_day_of_week:)
       view = View.new(
         days: days,
         generated_at: generated_at,
         timezone: timezone,
         enabled: enabled,
         today: today,
-        days_to_show: days_to_show
+        days_to_show: days_to_show,
+        first_day_of_week: first_day_of_week
       )
       @template.result(view.template_binding)
     end
@@ -30,13 +32,14 @@ module Availability
 
       attr_reader :enabled, :today
 
-      def initialize(days:, generated_at:, timezone:, enabled:, today:, days_to_show:)
+      def initialize(days:, generated_at:, timezone:, enabled:, today:, days_to_show:, first_day_of_week:)
         @days = days
         @generated_at = generated_at
         @timezone = timezone
         @enabled = enabled
         @today = today
         @days_to_show = days_to_show
+        @first_day_of_week = first_day_of_week
       end
 
       def template_binding
@@ -57,8 +60,8 @@ module Availability
 
       def format_week_label(week)
         first_date = week.compact.first.date
-        monday = first_date - (first_date.cwday - 1)
-        "Week of #{monday.day} #{monday.strftime('%B %Y')}"
+        week_start = first_date - weekday_offset(first_date)
+        "Week of #{week_start.day} #{week_start.strftime('%B %Y')}"
       end
 
       def format_time(time)
@@ -68,13 +71,13 @@ module Availability
       def weeks
         return [] if @days.empty?
 
-        padded_days = Array.new(@days.first.date.cwday - 1) + @days
+        padded_days = Array.new(weekday_offset(@days.first.date)) + @days
         padded_days.concat(Array.new((7 - padded_days.length) % 7))
         padded_days.each_slice(7).to_a
       end
 
       def weekdays
-        WEEKDAYS
+        WEEKDAYS.rotate(WEEKDAYS.index(@first_day_of_week))
       end
 
       def updated_at
@@ -97,6 +100,12 @@ module Availability
 
         "#{@today.strftime('%-d %b')}–#{final_with_year}"
       end
+
+      private
+
+      def weekday_offset(date)
+        (date.wday - Date::DAYNAMES.index(@first_day_of_week.capitalize)) % 7
+      end
     end
   end
 end

data/lib/availability/setup.rb

@@ -9,21 +9,23 @@ module Availability
     SERVER_NAME_PATTERN = /\A[a-zA-Z0-9.-]+\z/
     URL_PATH_PATTERN = %r{\A/[a-zA-Z0-9_-]+/\z}
 
-    def initialize(config_path:, nginx_path:, output_dir:, server_name:, url_path:)
+    def initialize(config_path:, nginx_path:, output_dir:, log_dir:, server_name:, url_path:)
       @config_path = File.expand_path(config_path)
       @nginx_path = File.expand_path(nginx_path)
       @output_dir = File.expand_path(output_dir)
+      @log_dir = File.expand_path(log_dir)
       @server_name = server_name
       @url_path = url_path
     end
 
-    attr_reader :config_path, :nginx_path, :output_dir
+    attr_reader :config_path, :nginx_path, :output_dir, :log_dir
 
     def run
       validate!
       ensure_targets_are_available!
       create_files
       FileUtils.mkdir_p(output_dir)
+      FileUtils.mkdir_p(log_dir)
       true
     rescue SystemCallError => e
       cleanup_created_files

data/lib/availability/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Availability
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/templates/nginx.conf.erb

@@ -19,7 +19,8 @@ server {
     }
 
     location = <%= @url_path %> {
-        alias "<%= escaped_output_dir %>/index.html";
+        alias "<%= escaped_output_dir %>/";
+        index index.html;
         default_type text/html;
 
         # For enforced privacy, create this file with `htpasswd` and uncomment:
@@ -27,6 +28,13 @@ server {
         # auth_basic_user_file /etc/nginx/particle.htpasswd;
     }
 
+    # The index module redirects internally here after verifying that the file exists.
+    location = <%= @url_path %>index.html {
+        internal;
+        alias "<%= escaped_output_dir %>/index.html";
+        default_type text/html;
+    }
+
     location = <%= @url_path %>favicon.svg {
         alias "<%= escaped_output_dir %>/favicon.svg";
         default_type image/svg+xml;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: particle-calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Timur