readme_test.go

package main

import (
	"os"
	"strings"
	"testing"
)

func TestREADMEHeader(t *testing.T) {
	// Read the README.md file
	content, err := os.ReadFile("README.md")
	if err != nil {
		t.Fatalf("Failed to read README.md: %v", err)
	}

	readmeContent := string(content)

	// Test 1: Project name "ZIM Reader" is displayed prominently
	if !strings.Contains(readmeContent, "# ZIM Reader") {
		t.Error("README.md does not contain project name 'ZIM Reader' prominently at top")
	}

	// Test 2: Contains a one-paragraph project description
	descriptionFound := false
	for _, line := range strings.Split(readmeContent, "\n") {
		trimmedLine := strings.TrimSpace(line)
		if trimmedLine != "" && !strings.HasPrefix(trimmedLine, "#") && !strings.Contains(trimmedLine, "![") {
			// Found a non-empty line that's not a header and not a badge
			descriptionFound = true
			break
		}
	}
	if !descriptionFound {
		t.Error("README.md does not contain a one-paragraph project description")
	}

	// Test 3: Contains the tagged install command.
	if !strings.Contains(readmeContent, "go install github.com/dotcommander/zim@v0.1.3") {
		t.Error("README.md does not contain the tagged install command")
	}
	if strings.Contains(readmeContent, "[![License]") {
		t.Error("README.md must not contain a license badge")
	}
}

func TestREADMEFeatures(t *testing.T) {
	// Read the README.md file
	content, err := os.ReadFile("README.md")
	if err != nil {
		t.Fatalf("Failed to read README.md: %v", err)
	}

	readmeContent := string(content)

	// Test 1: Features section exists
	if !strings.Contains(readmeContent, "## Features") {
		t.Fatal("README.md does not contain a '## Features' section")
	}

	// Extract features section
	inFeaturesSection := false
	featureBullets := []string{}

	for _, line := range strings.Split(readmeContent, "\n") {
		trimmedLine := strings.TrimSpace(line)

		if strings.HasPrefix(trimmedLine, "## Features") {
			inFeaturesSection = true
			continue
		}

		if inFeaturesSection && strings.HasPrefix(trimmedLine, "## ") {
			// Reached next section, stop collecting
			break
		}

		if inFeaturesSection && strings.HasPrefix(trimmedLine, "- ") {
			featureBullets = append(featureBullets, trimmedLine)
		}
	}

	// Test 2: At least 6 feature bullet points
	if len(featureBullets) < 6 {
		t.Errorf("README.md features section has only %d bullet points, expected at least 6", len(featureBullets))
	}

	// Test 3: Each feature is described in one concise sentence
	for i, feature := range featureBullets {
		// Remove markdown formatting
		cleanFeature := strings.ReplaceAll(feature, "**", "")
		cleanFeature = strings.TrimPrefix(cleanFeature, "- ")

		// Check for reasonable length (not too long) - primary conciseness check
		if len(cleanFeature) > 150 {
			t.Errorf("Feature %d is too long (%d chars), should be more concise", i+1, len(cleanFeature))
		}

		// Check that it reads like a single sentence (has a subject and predicate)
		// Split by colon to get feature name and description
		parts := strings.SplitN(cleanFeature, ":", 2)
		if len(parts) != 2 {
			t.Errorf("Feature %d should be in format 'feature: description'", i+1)
			continue
		}

		description := strings.TrimSpace(parts[1])

		// Description should end with a period
		if !strings.HasSuffix(description, ".") {
			t.Errorf("Feature %d description should end with a period", i+1)
		}

		// Check for obvious multiple sentences (looking for mid-sentence periods)
		// Count periods in the middle of the description (not at the end)
		midDescription := strings.TrimSuffix(description, ".")
		midPeriodCount := strings.Count(midDescription, ".")

		// Allow periods in abbreviations, file paths, etc.
		// We'll be lenient since the length check ensures conciseness
		if midPeriodCount > 2 {
			t.Errorf("Feature %d may have multiple sentences (%d mid-sentence periods)", i+1, midPeriodCount)
		}
	}

	// Test 4: Features include required categories
	requiredKeywords := []string{"read", "search", "serve", "index", "library"}
	featureText := strings.ToLower(strings.Join(featureBullets, " "))

	for _, keyword := range requiredKeywords {
		if !strings.Contains(featureText, keyword) {
			t.Errorf("Features section does not mention '%s' capability", keyword)
		}
	}
}

func TestREADMELicense(t *testing.T) {
	content, err := os.ReadFile("README.md")
	if err != nil {
		t.Fatalf("Failed to read README.md: %v", err)
	}

	readmeContent := string(content)

	// Test 1: License section exists and links to the repository license.
	if !strings.Contains(readmeContent, "## License") {
		t.Fatal("README.md does not contain a '## License' section")
	}

	// Extract license section
	inLicenseSection := false
	licenseContent := ""

	for _, line := range strings.Split(readmeContent, "\n") {
		trimmedLine := strings.TrimSpace(line)

		if strings.HasPrefix(trimmedLine, "## License") {
			inLicenseSection = true
			continue
		}

		if inLicenseSection && strings.HasPrefix(trimmedLine, "## ") {
			// Reached next section, stop collecting
			break
		}

		if inLicenseSection {
			licenseContent += trimmedLine + "\n"
		}
	}

	licenseLower := strings.ToLower(licenseContent)
	if !strings.Contains(licenseLower, "mit license") || !strings.Contains(licenseContent, "[MIT License](LICENSE)") {
		t.Error("License section must link to the MIT LICENSE file")
	}

	// Test 2: LICENSE contains the expected MIT grant and copyright owner.
	license, err := os.ReadFile("LICENSE")
	if err != nil {
		t.Fatal(err)
	}
	for _, want := range []string{
		"MIT License",
		"Copyright (c) 2026 Gary Blankenship",
		"Permission is hereby granted, free of charge",
		`THE SOFTWARE IS PROVIDED "AS IS"`,
	} {
		if !strings.Contains(string(license), want) {
			t.Errorf("LICENSE missing %q", want)
		}
	}
}