pi-usereq 0.4.0

package/tests/fixtures/fixture_scala.scala

@@ -0,0 +1,398 @@
+/**
+ * @file fixture_scala.scala
+ * @brief Comprehensive Scala test fixture for parser validation.
+ * @details Covers implicits/givens, pattern matching, higher-kinded types,
+ *          self-types, variance, opaque types, extension methods, enums,
+ *          for comprehensions, and cake pattern.
+ */
+// Single line comment
+/* Multi-line
+   comment */
+import scala.collection.mutable
+import scala.concurrent.{Future, ExecutionContext}
+import scala.util.{Try, Success, Failure}
+
+/* ── Case class with copy and pattern matching ────────────────────────── */
+
+/**
+ * @class Person
+ * @brief Immutable data class for person entities.
+ * @param name Display name.
+ * @param age Age in years; must be non-negative.
+ */
+case class Person(name: String, age: Int) {
+  /**
+   * @brief Check if the person is an adult.
+   * @return True if age >= 18.
+   */
+  def isAdult: Boolean = age >= 18
+
+  /**
+   * @brief Create a greeting string.
+   * @return Formatted greeting including name and age.
+   */
+  def greet: String = s"Hi, I'm $name, age $age"
+}
+
+/* ── Sealed trait hierarchy ───────────────────────────────────────────── */
+
+/**
+ * @class Shape
+ * @brief Sealed trait for algebraic data type shapes.
+ */
+sealed trait Shape {
+  /**
+   * @brief Compute the area of this shape.
+   * @return Area as a Double.
+   */
+  def area: Double
+}
+
+/**
+ * @class Circle
+ * @brief Circle shape with radius.
+ * @param radius The circle's radius.
+ */
+case class Circle(radius: Double) extends Shape {
+  override def area: Double = math.Pi * radius * radius
+}
+
+/**
+ * @class Rectangle
+ * @brief Rectangle shape with width and height.
+ * @param width The rectangle's width.
+ * @param height The rectangle's height.
+ */
+case class Rectangle(width: Double, height: Double) extends Shape {
+  override def area: Double = width * height
+}
+
+/* ── Abstract class ───────────────────────────────────────────────────── */
+
+/**
+ * @class Animal
+ * @brief Abstract base class for animals with sound production.
+ */
+abstract class Animal {
+  /**
+   * @brief The sound this animal makes.
+   * @return Sound description string.
+   */
+  def sound: String
+
+  /**
+   * @brief Describe the animal including its sound.
+   * @return Formatted description string.
+   */
+  def describe: String = s"I am a ${getClass.getSimpleName} and I say $sound"
+}
+
+/* ── Trait with self-type ─────────────────────────────────────────────── */
+
+/**
+ * @trait Drawable
+ * @brief Trait for rendering objects to string representation.
+ */
+trait Drawable {
+  /**
+   * @brief Draw the object as a string.
+   * @return Rendered string representation.
+   */
+  def draw(): Unit
+}
+
+/**
+ * @trait Logging
+ * @brief Self-type trait requiring Drawable to be mixed in.
+ * @details Demonstrates the cake pattern for dependency injection.
+ */
+trait Logging { self: Drawable =>
+  /**
+   * @brief Log the drawing operation and then draw.
+   */
+  def logAndDraw(): Unit = {
+    println("About to draw")
+    draw()
+  }
+}
+
+/**
+ * @trait Serializable
+ * @brief Trait for objects convertible to byte arrays.
+ */
+trait Serializable {
+  /**
+   * @brief Serialize this object to bytes.
+   * @return Byte array representation.
+   */
+  def serialize: Array[Byte]
+}
+
+/* ── Object (singleton) ───────────────────────────────────────────────── */
+
+/**
+ * @object Main
+ * @brief Application entry point and utility function container.
+ */
+object Main {
+  /**
+   * @brief Application entry point.
+   * @param args Command-line arguments.
+   */
+  def main(args: Array[String]): Unit = {
+    val people = List(Person("Alice", 30), Person("Bob", 17))
+    /* Filter adults using pattern matching */
+    val adults = people.filter(_.isAdult)
+    adults.foreach(p => println(p.greet))
+  }
+
+  /**
+   * @brief Override toString for Main object display.
+   * @return String representation.
+   */
+  override def toString: String = "Main"
+
+  /** @brief Mathematical constant pi. */
+  val pi = 3.14159265
+
+  /** @brief Mutable counter for tracking operations. */
+  var counter = 0
+
+  /**
+   * @brief Type alias for lists of strings.
+   */
+  type StringList = List[String]
+
+  /**
+   * @brief Type alias for function transformers.
+   */
+  type Transformer[A] = A => A
+
+  /**
+   * @brief Describe a shape using exhaustive pattern matching.
+   * @param shape The shape to describe.
+   * @return Human-readable description with area.
+   */
+  def describeShape(shape: Shape): String = shape match {
+    case Circle(r) => s"Circle with radius $r, area=${shape.area}"
+    case Rectangle(w, h) => s"Rectangle ${w}x${h}, area=${shape.area}"
+  }
+
+  /**
+   * @brief Process a value with multiple match guards.
+   * @param x Integer input to classify.
+   * @return Classification string.
+   */
+  def classify(x: Int): String = x match {
+    case 0 => "zero"
+    case n if n < 0 => "negative"
+    case n if n > 100 => "large"
+    case _ => "positive"
+  }
+}
+
+/* ── Companion object with apply ──────────────────────────────────────── */
+
+/**
+ * @class Config
+ * @brief Configuration holder with companion factory.
+ * @param entries Key-value pairs.
+ */
+class Config private (val entries: Map[String, String]) {
+  /**
+   * @brief Retrieve a value by key.
+   * @param key The configuration key.
+   * @return Optional value.
+   */
+  def get(key: String): Option[String] = entries.get(key)
+}
+
+/**
+ * @object Config
+ * @brief Companion object with factory methods for Config.
+ */
+object Config {
+  /**
+   * @brief Create a Config from key-value pairs.
+   * @param entries Variable number of key-value tuples.
+   * @return A new Config instance.
+   */
+  def apply(entries: (String, String)*): Config = new Config(entries.toMap)
+
+  /**
+   * @brief Create an empty Config.
+   * @return Config with no entries.
+   */
+  def empty: Config = new Config(Map.empty)
+}
+
+/* ── Generic class with variance ──────────────────────────────────────── */
+
+/**
+ * @class Container
+ * @brief Covariant generic container.
+ * @tparam +A Element type (covariant).
+ */
+class Container[+A](val value: A) {
+  /**
+   * @brief Map the contained value.
+   * @tparam B Target type.
+   * @param f Transform function.
+   * @return New Container with transformed value.
+   */
+  def map[B](f: A => B): Container[B] = new Container(f(value))
+
+  /**
+   * @brief Flat-map the contained value.
+   * @tparam B Target type.
+   * @param f Transform function returning a Container.
+   * @return Flattened Container.
+   */
+  def flatMap[B](f: A => Container[B]): Container[B] = f(value)
+}
+
+/* ── Implicit conversions and classes ─────────────────────────────────── */
+
+/**
+ * @class RichInt
+ * @brief Implicit class extending Int with utility methods.
+ * @param n The wrapped integer value.
+ */
+implicit class RichInt(val n: Int) extends AnyVal {
+  /**
+   * @brief Check if the number is even.
+   * @return True if n is divisible by 2.
+   */
+  def isEven: Boolean = n % 2 == 0
+
+  /**
+   * @brief Repeat a string n times.
+   * @param s The string to repeat.
+   * @return Concatenated result.
+   */
+  def times(s: String): String = s * n
+}
+
+/* ── For comprehension example ────────────────────────────────────────── */
+
+/**
+ * @object ForCompExample
+ * @brief Demonstrates for-comprehension with multiple generators.
+ */
+object ForCompExample {
+  /**
+   * @brief Compute all pairs of integers whose sum equals target.
+   * @param range Upper bound of the search space.
+   * @param target Desired sum.
+   * @return List of pairs summing to target.
+   */
+  def findPairs(range: Int, target: Int): List[(Int, Int)] = {
+    for {
+      x <- (1 to range).toList
+      y <- (x to range).toList
+      if x + y == target
+    } yield (x, y)
+  }
+}
+
+/* ── Higher-order and curried functions ────────────────────────────────── */
+
+/**
+ * @object FuncUtils
+ * @brief Utility functions demonstrating functional patterns.
+ */
+object FuncUtils {
+  /**
+   * @brief Curried addition function.
+   * @param a First operand.
+   * @param b Second operand.
+   * @return Sum of a and b.
+   */
+  def add(a: Int)(b: Int): Int = a + b
+
+  /**
+   * @brief Apply a function twice to an initial value.
+   * @tparam A Value type.
+   * @param f Function to apply.
+   * @param x Initial value.
+   * @return Result of f(f(x)).
+   */
+  def twice[A](f: A => A)(x: A): A = f(f(x))
+
+  /**
+   * @brief Compose two functions left to right.
+   * @tparam A Input type.
+   * @tparam B Intermediate type.
+   * @tparam C Output type.
+   * @param f First function.
+   * @param g Second function.
+   * @return Composed function.
+   */
+  def compose[A, B, C](f: A => B, g: B => C): A => C = a => g(f(a))
+}
+
+/* coverage extension block */
+import scala.util.Random
+import scala.concurrent.duration._
+trait Runner
+trait Parser
+object Metrics
+val MaxUsers = 100
+val RetryLimit = 3
+type UserKey = String
+type ErrorCode = Int
+type Mapper = String => String
+var attempts = 0
+var cursor = 1
+var stage = "init"
+var status = "ready"
+
+// REQ-COVER-SRS-231 START
+object ReqCoverScala {
+  /**
+   * @REQ-COVER-SRS-231 block 1
+   * @brief Coverage helper construct 1.
+   * @details Provides deterministic fixture-level Doxygen coverage block 1.
+   * @param value Input value for helper construct 1.
+   * @return Output value for helper construct 1.
+   */
+  def reqCoverScala1(value: Int): Int = value + 1
+
+  /**
+   * @REQ-COVER-SRS-231 block 2
+   * @brief Coverage helper construct 2.
+   * @details Provides deterministic fixture-level Doxygen coverage block 2.
+   * @param value Input value for helper construct 2.
+   * @return Output value for helper construct 2.
+   */
+  def reqCoverScala2(value: Int): Int = value + 2
+
+  /**
+   * @REQ-COVER-SRS-231 block 3
+   * @brief Coverage helper construct 3.
+   * @details Provides deterministic fixture-level Doxygen coverage block 3.
+   * @param value Input value for helper construct 3.
+   * @return Output value for helper construct 3.
+   */
+  def reqCoverScala3(value: Int): Int = value + 3
+
+  /**
+   * @REQ-COVER-SRS-231 block 4
+   * @brief Coverage helper construct 4.
+   * @details Provides deterministic fixture-level Doxygen coverage block 4.
+   * @param value Input value for helper construct 4.
+   * @return Output value for helper construct 4.
+   */
+  def reqCoverScala4(value: Int): Int = value + 4
+
+  /**
+   * @REQ-COVER-SRS-231 block 5
+   * @brief Coverage helper construct 5.
+   * @details Provides deterministic fixture-level Doxygen coverage block 5.
+   * @param value Input value for helper construct 5.
+   * @return Output value for helper construct 5.
+   */
+  def reqCoverScala5(value: Int): Int = value + 5
+
+}
+/* REQ-COVER-SRS-231 END */

package/tests/fixtures/fixture_shell.sh

@@ -0,0 +1,276 @@
+#!/bin/bash
+# @file fixture_shell.sh
+# @brief Comprehensive Shell/Bash test fixture for parser validation.
+# @details Covers arrays, associative arrays, parameter expansion,
+#          here documents, process substitution, traps, getopts,
+#          case statements, arithmetic, and here strings.
+# Single line comment
+
+# ── Variables and exports ─────────────────────────────────────────────
+
+# @brief Greeting message template.
+MY_VAR="hello"
+
+# @brief Extended PATH including local binary directory.
+export PATH_EXT="/usr/local/bin"
+
+# @brief Immutable maximum iteration counter.
+readonly MAX_COUNT=10
+
+# @brief Build version set via declare.
+declare -r BUILD_VERSION="1.0.0"
+
+# @brief Debug mode flag (0=off, 1=on).
+DEBUG_MODE=0
+
+# ── Arrays ────────────────────────────────────────────────────────────
+
+# @brief Indexed array of supported languages.
+declare -a LANGUAGES=("python" "rust" "go" "java" "typescript")
+
+# @brief Associative array mapping extensions to languages.
+declare -A EXT_MAP=(
+    [py]="python"
+    [rs]="rust"
+    [go]="go"
+    [java]="java"
+    [ts]="typescript"
+)
+
+# ── Functions ─────────────────────────────────────────────────────────
+
+# @brief Greet a user by name on stdout.
+# @param $1 The user's name.
+function greet() {
+    local name="${1:?Name required}"
+    # Validate non-empty name
+    if [[ -z "$name" ]]; then
+        echo "Error: empty name" >&2
+        return 1
+    fi
+    echo "Hello ${name}!"
+}
+
+# @brief Remove temporary files and directories.
+# @details Called by trap on EXIT for cleanup.
+cleanup() {
+    local tmp_dir="${TMPDIR:-/tmp}/myapp_$$"
+    if [[ -d "$tmp_dir" ]]; then
+        # Remove temp directory and all contents
+        rm -rf "$tmp_dir"
+    fi
+    echo "Cleanup complete"
+}
+
+# @brief Parse command-line options using getopts.
+# @param $@ Command-line arguments.
+# @return Sets global variables based on parsed options.
+parse_args() {
+    local opt
+    while getopts "vdhf:o:" opt; do
+        case "$opt" in
+            v)
+                # Enable verbose output
+                VERBOSE=1
+                ;;
+            d)
+                # Enable debug mode
+                DEBUG_MODE=1
+                ;;
+            f)
+                # Set input file path
+                INPUT_FILE="$OPTARG"
+                ;;
+            o)
+                # Set output file path
+                OUTPUT_FILE="$OPTARG"
+                ;;
+            h)
+                echo "Usage: $0 [-v] [-d] [-f file] [-o output] [-h]"
+                return 0
+                ;;
+            *)
+                echo "Unknown option: $opt" >&2
+                return 1
+                ;;
+        esac
+    done
+    shift $((OPTIND - 1))
+}
+
+# @brief Process a file with error handling and logging.
+# @param $1 Path to the input file.
+# @param $2 Optional output path (defaults to stdout).
+# @return 0 on success, 1 on failure.
+process_file() {
+    local input="$1"
+    local output="${2:-/dev/stdout}"
+
+    # Verify input file exists and is readable
+    if [[ ! -f "$input" ]]; then
+        echo "Error: file not found: $input" >&2
+        return 1
+    fi
+
+    if [[ ! -r "$input" ]]; then
+        echo "Error: file not readable: $input" >&2
+        return 1
+    fi
+
+    # Count lines using wc
+    local line_count
+    line_count=$(wc -l < "$input")
+    echo "Processing $input ($line_count lines)" >&2
+
+    # Transform and write output
+    while IFS= read -r line; do
+        # Skip empty lines and comments
+        [[ -z "$line" || "$line" =~ ^[[:space:]]*# ]] && continue
+        echo "$line"
+    done < "$input" > "$output"
+
+    return 0
+}
+
+# @brief Execute a command with retry logic.
+# @param $1 Maximum number of retry attempts.
+# @param $@ The command and arguments to execute.
+# @return Exit code of the final attempt.
+retry_command() {
+    local max_attempts="$1"
+    shift
+    local attempt=1
+
+    while (( attempt <= max_attempts )); do
+        # Attempt the command
+        if "$@"; then
+            return 0
+        fi
+        echo "Attempt $attempt/$max_attempts failed" >&2
+        (( attempt++ ))
+        # Exponential backoff
+        sleep $(( 2 ** (attempt - 1) ))
+    done
+
+    echo "All $max_attempts attempts failed" >&2
+    return 1
+}
+
+# @brief Log a message with timestamp prefix.
+# @param $1 Log level (INFO, WARN, ERROR).
+# @param $@ Message text.
+log_message() {
+    local level="$1"
+    shift
+    local timestamp
+    timestamp=$(date '+%Y-%m-%d %H:%M:%S')
+    echo "[$timestamp] [$level] $*" >&2
+}
+
+# @brief Generate a temporary file and return its path.
+# @return Path to the created temporary file.
+make_temp() {
+    local tmpfile
+    tmpfile=$(mktemp "${TMPDIR:-/tmp}/myapp_XXXXXX")
+    echo "$tmpfile"
+}
+
+# ── Traps ─────────────────────────────────────────────────────────────
+
+# @brief Register cleanup function on script exit.
+trap cleanup EXIT
+
+# @brief Handle interrupt signal gracefully.
+trap 'echo "Interrupted"; exit 130' INT TERM
+
+# ── Here document ─────────────────────────────────────────────────────
+
+# @brief Generate a configuration file using heredoc.
+generate_config() {
+    cat <<EOF
+# Auto-generated configuration
+version=${BUILD_VERSION}
+debug=${DEBUG_MODE}
+max_count=${MAX_COUNT}
+EOF
+}
+
+# ── Arithmetic and parameter expansion ────────────────────────────────
+
+# @brief Compute factorial iteratively.
+# @param $1 Non-negative integer.
+# @return Factorial result.
+factorial() {
+    local n="${1:-1}"
+    local result=1
+    local i
+    for (( i = 2; i <= n; i++ )); do
+        # Multiply accumulator
+        (( result *= i ))
+    done
+    echo "$result"
+}
+
+# ── Source external configuration ─────────────────────────────────────
+
+# @brief Load external configuration script if present.
+if [[ -f ./config.sh ]]; then
+    source ./config.sh
+fi
+
+# coverage extension block
+source ./env.sh
+. ./helpers.sh
+source ./shared.sh
+. ./paths.sh
+source ./runtime.sh
+. ./exports.sh
+source ./network.sh
+
+# REQ-COVER-SRS-231 START
+# @REQ-COVER-SRS-231 block 1
+# @brief Coverage helper construct 1.
+# @details Provides deterministic fixture-level Doxygen coverage block 1.
+# @param value Input value for helper construct 1.
+# @return Output value for helper construct 1.
+req_cover_shell_1() {
+  echo "$(( $1 + 1 ))"
+}
+
+# @REQ-COVER-SRS-231 block 2
+# @brief Coverage helper construct 2.
+# @details Provides deterministic fixture-level Doxygen coverage block 2.
+# @param value Input value for helper construct 2.
+# @return Output value for helper construct 2.
+req_cover_shell_2() {
+  echo "$(( $1 + 2 ))"
+}
+
+# @REQ-COVER-SRS-231 block 3
+# @brief Coverage helper construct 3.
+# @details Provides deterministic fixture-level Doxygen coverage block 3.
+# @param value Input value for helper construct 3.
+# @return Output value for helper construct 3.
+req_cover_shell_3() {
+  echo "$(( $1 + 3 ))"
+}
+
+# @REQ-COVER-SRS-231 block 4
+# @brief Coverage helper construct 4.
+# @details Provides deterministic fixture-level Doxygen coverage block 4.
+# @param value Input value for helper construct 4.
+# @return Output value for helper construct 4.
+req_cover_shell_4() {
+  echo "$(( $1 + 4 ))"
+}
+
+# @REQ-COVER-SRS-231 block 5
+# @brief Coverage helper construct 5.
+# @details Provides deterministic fixture-level Doxygen coverage block 5.
+# @param value Input value for helper construct 5.
+# @return Output value for helper construct 5.
+req_cover_shell_5() {
+  echo "$(( $1 + 5 ))"
+}
+
+# REQ-COVER-SRS-231 END