fasti 1.0.0 → 1.0.1

data/RELEASING.md

@@ -1,202 +0,0 @@
-# Releasing
-
-This document describes the release process for Ruby gems used in this project, which is fully automated through GitHub Actions workflows.
-
-## Overview
-
-The release process consists of three automated workflows:
-
-1. **Release Preparation** - Creates a release branch with version updates
-2. **Release Validation** - Validates the release branch on PR creation
-3. **Release Publish** - Publishes the gem after PR merge
-
-## Prerequisites
-
-Before initiating a release, ensure:
-
-- [ ] All desired features and fixes are merged to `main`
-- [ ] CI is passing on `main` branch
-- [ ] `CHANGELOG.md` has entries under `## [Unreleased]` section
-- [ ] `RUBYGEMS_API_KEY` secret is configured in repository settings
-
-## Release Process
-
-### Step 1: Initiate Release
-
-1. Go to the [Actions tab](../../actions) in the GitHub repository
-2. Select "Release Preparation" workflow
-3. Click "Run workflow"
-4. Enter the version number (e.g., `1.0.0`)
-5. Click "Run workflow"
-
-The workflow will automatically:
-- Create a new branch `release-v{version}`
-- Update `lib/[gem_name]/version.rb` with the new version
-- Update `CHANGELOG.md`:
-  - Replace `## [Unreleased]` with `## [{version}] - {date}`
-  - Add a new `## [Unreleased]` section for future changes
-- Create a git tag `v{version}` on the release branch
-- Push the branch and tag to GitHub
-- Create a Pull Request to `main`
-
-### Step 2: Review and Merge
-
-Once the PR is created, the Release Validation workflow automatically:
-- Validates version format (must be `x.y.z`)
-- Verifies version consistency between branch name and `version.rb`
-- Checks that the git tag doesn't already exist (or can be updated)
-- Confirms the version isn't already published on RubyGems
-- Verifies `RUBYGEMS_API_KEY` secret is configured
-- Validates `CHANGELOG.md` has an entry for this version
-
-**Note**: Quality checks (tests and RuboCop) are handled by the CI workflow to avoid duplication.
-
-**Important**: If you push additional commits to the release PR (e.g., bug fixes, workflow updates, documentation changes):
-- The validation workflow automatically moves the release tag to the latest commit
-- This ensures the tag always points to the final reviewed code
-- No manual intervention required
-- All changes will be included in the final release
-
-If all checks pass, merge the PR.
-
-### Step 3: Automatic Publishing
-
-After the PR is merged, the Release Publish workflow automatically:
-- Checks out the exact git tag created on the release branch
-- Builds the gem from the tagged commit
-- Publishes the gem to RubyGems
-- Creates a GitHub Release with:
-  - Release notes extracted from `CHANGELOG.md`
-  - The built gem file as an attachment
-- Cleans up the release branch
-
-## Workflow Architecture
-
-### Key Design Decisions
-
-#### Tag-Based Deployment
-
-The release workflow uses a **tag-based deployment strategy** to ensure the released gem contains exactly the code that was reviewed and approved in the release PR, without any subsequent changes from `main`.
-
-```mermaid
-graph LR
-    A[main branch] -->|Create release branch| B[release-v1.0.0]
-    B -->|Update version & tag| C[Tagged: v1.0.0]
-    B -->|Create PR| D[Pull Request]
-    A -->|Other PRs merged| E[main with new commits]
-    D -->|Merge PR| E
-    C -->|Checkout tag| F[Build & Publish gem]
-    F -->|Contains only| G[Code from release branch]
-```
-
-#### Automatic Tag Movement
-
-When additional commits are pushed to a release PR, the tag automatically moves to the latest commit:
-
-```mermaid
-graph LR
-    A[Initial commit] -->|Tag v1.0.0| B[Tagged commit]
-    B -->|Fix typo| C[New commit]
-    C -->|Auto-move tag| D[Tag v1.0.0 on latest]
-    D -->|Final review| E[Ready to merge]
-```
-
-This ensures:
-- The tag always points to the final reviewed code
-- No manual tag management required
-- The published gem matches exactly what was approved
-
-## Manual Release (Emergency Only)
-
-If automation fails, you can release manually using our tag-based strategy:
-
-```bash
-# 1. Create release branch
-git checkout -b release-v1.0.0
-
-# 2. Update version
-vim lib/[gem_name]/version.rb
-
-# 3. Update CHANGELOG (move content from [Unreleased] to [1.0.0])
-vim CHANGELOG.md
-
-# 4. Commit changes and create tag
-git add -A
-git commit -m ":bookmark: Release v1.0.0"
-git tag -a v1.0.0 -m "Release v1.0.0"
-
-# 5. Push release branch and tag
-git push origin release-v1.0.0
-git push origin v1.0.0
-
-# 6. Create PR and merge after review
-gh pr create --title "Release v1.0.0" --body "Release v1.0.0"
-# (Review and merge PR)
-
-# 7. Checkout the tag and build gem
-git checkout v1.0.0
-bundle exec rake build
-
-# 8. Push to RubyGems
-gem push pkg/[gem_name]-1.0.0.gem
-
-# 9. Create GitHub release
-gh release create v1.0.0 --title "[gem_name] v1.0.0" --generate-notes pkg/[gem_name]-1.0.0.gem
-```
-
-## Troubleshooting
-
-### Release Validation Fails
-
-**Version already exists on RubyGems**
-- Solution: Increment the version number and try again
-
-**RUBYGEMS_API_KEY not configured**
-1. Generate an API key at https://rubygems.org/profile/edit
-2. Go to repository Settings → Secrets and variables → Actions
-3. Add new secret: `RUBYGEMS_API_KEY` with your API key
-
-**Tests or RuboCop failing**
-- These are checked by the CI workflow, not in release validation
-- Fix the issues on the release branch or `main` as appropriate
-- Release validation focuses on version consistency and format
-
-### Release Publish Fails
-
-**Tag not found**
-- The release preparation workflow may have failed to create the tag
-- Check if the tag exists: `git tag | grep v1.0.0`
-- If missing, the release validation workflow will recreate it on PR updates
-- For manual fix: create tag on release branch with `git tag -a v1.0.0 -m "Release v1.0.0"`
-
-**Gem push fails**
-- Verify RubyGems API key is valid
-- Check if you have push permissions for the gem
-- Ensure the version doesn't already exist on RubyGems
-
-## Version Numbering
-
-Follow [Semantic Versioning](https://semver.org/):
-
-- **MAJOR** version for incompatible API changes
-- **MINOR** version for backwards-compatible functionality additions  
-- **PATCH** version for backwards-compatible bug fixes
-
-Examples:
-- `0.1.0` → `0.1.1`: Bug fixes only
-- `0.1.1` → `0.2.0`: New features added
-- `0.2.0` → `1.0.0`: Breaking changes or stable release
-
-## Workflow Files
-
-The release automation is implemented in:
-
-- `.github/workflows/release-preparation.yml` - Creates release branch and PR
-- `.github/workflows/release-validation.yml` - Validates release PR
-- `.github/workflows/release-publish.yml` - Publishes gem after merge
-
-## Security Notes
-
-- The `RUBYGEMS_API_KEY` secret is only accessible to workflows running on the default branch
-- Release branches are automatically deleted after successful release
-- All releases are tagged for audit trail and rollback capability

data/Rakefile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-require "rake/clean"
-CLEAN.include("coverage", ".rspec_status", ".yardoc")
-CLOBBER.include("docs/api", "pkg")
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-require "gemoji"
-require "yard"
-YARD::Rake::YardocTask.new(:doc)
-Rake::Task[:doc].enhance do
-  # Convert GitHub emoji shortcodes to actual emojis in generated HTML
-  Dir["docs/api/**/*.html"].each do |file|
-    content = File.read(file)
-
-    # Replace :emoji_name: patterns with actual unicode emojis
-    content.gsub!(/:([a-z0-9+\-_]+):/) do |match|
-      alias_name = $1
-      emoji = Emoji.find_by_alias(alias_name)
-      emoji ? emoji.raw : match # Keep original if emoji not found
-    end
-
-    File.write(file, content)
-  end
-end
-
-task default: %i[spec rubocop]

data/TODO.md

@@ -1,11 +0,0 @@
-# TODO
-
-**Tasks were previously managed in this file, but have been migrated to GitHub Issues for better tracking and collaboration.**
-
-## Quick Links
-- [Open Issues](https://github.com/sakuro/fasti/issues)
-- [Current Milestone](https://github.com/sakuro/fasti/milestones)
-- [All Milestones](https://github.com/sakuro/fasti/milestones?state=closed)
-- [Project Board](https://github.com/sakuro/fasti/projects) (planned)
-
-For ongoing maintenance guidelines, see the [AI Development Guide](CLAUDE.md).

data/benchmark/holiday_cache_benchmark.rb

@@ -1,111 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "benchmark"
-require "bundler/setup"
-require "fasti"
-
-# Temporary class to simulate old behavior without caching
-class LegacyCalendar < Fasti::Calendar
-  # Override to disable caching for benchmark comparison
-  def holiday?(day)
-    date = to_date(day)
-    return false unless date
-
-    begin
-      Holidays.on(date, country).any?
-    rescue Holidays::InvalidRegion, StandardError
-      false
-    end
-  end
-end
-
-# Benchmarks month display performance by checking holidays for all days in a month
-def benchmark_month_display(calendar_class, year, month, country, iterations=100)
-  calendar = calendar_class.new(year, month, country:)
-
-  Benchmark.realtime do
-    iterations.times do
-      # Simulate checking all days in the month (like formatter does)
-      (1..calendar.days_in_month).each do |day|
-        calendar.holiday?(day)
-      end
-    end
-  end
-end
-
-# Benchmarks year display performance by checking holidays for all days in all months
-def benchmark_year_display(calendar_class, year, country, iterations=10)
-  Benchmark.realtime do
-    iterations.times do
-      (1..12).each do |month|
-        calendar = calendar_class.new(year, month, country:)
-        (1..calendar.days_in_month).each do |day|
-          calendar.holiday?(day)
-        end
-      end
-    end
-  end
-end
-
-# Formats benchmark time results in appropriate units (μs/ms/s)
-def format_time(seconds)
-  if seconds < 0.001
-    "#{(seconds * 1_000_000).round(2)}μs"
-  elsif seconds < 1
-    "#{(seconds * 1000).round(2)}ms"
-  else
-    "#{seconds.round(3)}s"
-  end
-end
-
-# Calculates and formats performance improvement ratio between two benchmark times
-def format_speedup(old_time, new_time)
-  return "N/A" if new_time.zero?
-
-  speedup = old_time / new_time
-  "#{speedup.round(2)}x faster"
-end
-
-puts "Fasti Holiday Cache Performance Benchmark"
-puts "=" * 50
-puts
-
-# Test parameters
-YEAR = 2024
-COUNTRIES = %i[us jp gb].freeze
-MONTH_ITERATIONS = 100
-YEAR_ITERATIONS = 10
-
-COUNTRIES.each do |country|
-  puts "Country: #{country.upcase}"
-  puts "-" * 20
-
-  # Month display benchmark
-  puts "Month Display (July #{YEAR}, #{MONTH_ITERATIONS} iterations):"
-
-  legacy_month_time = benchmark_month_display(LegacyCalendar, YEAR, 7, country, MONTH_ITERATIONS)
-  cached_month_time = benchmark_month_display(Fasti::Calendar, YEAR, 7, country, MONTH_ITERATIONS)
-
-  puts "  Legacy (no cache): #{format_time(legacy_month_time)}"
-  puts "  Cached:            #{format_time(cached_month_time)}"
-  puts "  Improvement:       #{format_speedup(legacy_month_time, cached_month_time)}"
-  puts
-
-  # Year display benchmark
-  puts "Year Display (#{YEAR}, #{YEAR_ITERATIONS} iterations):"
-
-  legacy_year_time = benchmark_year_display(LegacyCalendar, YEAR, country, YEAR_ITERATIONS)
-  cached_year_time = benchmark_year_display(Fasti::Calendar, YEAR, country, YEAR_ITERATIONS)
-
-  puts "  Legacy (no cache): #{format_time(legacy_year_time)}"
-  puts "  Cached:            #{format_time(cached_year_time)}"
-  puts "  Improvement:       #{format_speedup(legacy_year_time, cached_year_time)}"
-  puts
-  puts
-end
-
-puts "Benchmark completed!"
-puts
-puts "Note: Results may vary based on network latency to holiday data sources"
-puts "and system performance. Run multiple times for consistent results."

data/benchmark/memory_benchmark.rb

@@ -1,86 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "fasti"
-
-# Simple memory measurement helper
-def measure_memory_usage
-  # Force garbage collection to get accurate measurements
-  GC.start
-  GC.compact if GC.respond_to?(:compact)
-
-  before = GC.stat[:heap_live_slots]
-  yield
-  GC.start
-  after = GC.stat[:heap_live_slots]
-
-  after - before
-end
-
-# Formats memory usage in human-readable units (slots/K slots/M slots)
-def format_memory(slots)
-  # Rough estimation: each object slot ≈ 40 bytes on 64-bit systems
-  bytes = slots * 40
-  if bytes < 1024
-    "#{bytes}B"
-  elsif bytes < 1024 * 1024
-    "#{(bytes / 1024.0).round(2)}KB"
-  else
-    "#{(bytes / (1024.0 * 1024)).round(2)}MB"
-  end
-end
-
-puts "Fasti Memory Usage Benchmark"
-puts "=" * 40
-puts
-
-# Test creating calendars and checking holidays
-YEAR = 2024
-COUNTRIES = %i[us jp gb].freeze
-
-COUNTRIES.each do |country|
-  puts "Country: #{country.upcase}"
-  puts "-" * 15
-
-  # Single month calendar
-  month_memory = measure_memory_usage {
-    calendar = Fasti::Calendar.new(YEAR, 7, country:)
-    (1..calendar.days_in_month).each {|day| calendar.holiday?(day) }
-  }
-
-  # Year worth of calendars (simulating year view)
-  year_memory = measure_memory_usage {
-    (1..12).each do |month|
-      calendar = Fasti::Calendar.new(YEAR, month, country:)
-      (1..calendar.days_in_month).each {|day| calendar.holiday?(day) }
-    end
-  }
-
-  puts "  Single month: #{format_memory(month_memory)}"
-  puts "  Full year:    #{format_memory(year_memory)}"
-  puts
-end
-
-# Test cache behavior - multiple accesses to same month
-puts "Cache Efficiency Test"
-puts "-" * 20
-
-cache_memory = measure_memory_usage {
-  calendar = Fasti::Calendar.new(YEAR, 7, country: :us)
-
-  # First pass - cache gets populated
-  (1..calendar.days_in_month).each {|day|
-    calendar.holiday?(day)
-    # Second pass - should use cache
-    calendar.holiday?(day)
-
-    # Third pass - still using cache
-    calendar.holiday?(day)
-  }
-}
-
-puts "Triple access (cache test): #{format_memory(cache_memory)}"
-puts
-puts "Note: Memory measurements are approximate and may vary"
-puts "based on Ruby version and system configuration."