dsv7-parser 7.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46a266cb139c92c4211efbec9a9675f72615b37a0a93bda512193e307f2965c4
+  data.tar.gz: c53949825909b9261ba0a2f49a462bc55a2223feb8829e220d33c5c2251de243
+SHA512:
+  metadata.gz: d2e86049d2d517aa43733f222bd81c76938f8175022d8377c79cb1df74dc71a6eaad192a5b1bc8a979f9b3eb4f9bdfa4d80d7a92632681f704860f6b0f755fd3
+  data.tar.gz: a3d348801f8ba8c4a95be3e707ff5199399f3b626b2b8084fa8c33efa419f3597ff83a172bc9f2f3ee8dcfff4591f91b2244e929e7e4df7306fe7b92796f0d32

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,22 @@
+# Starter RuboCop configuration
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/*'
+    - 'pkg/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - 'test/**/*'
+
+# Keep docs optional for small gems and tests
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.6

data/AGENTS.md

@@ -0,0 +1,255 @@
+# Agent Guide for dsv7-parser
+
+This repo contains a Ruby gem for parsing and validating DSV7 files (German Swimming Federation, “Format 7”). It already includes a high-level validator and a growing specification captured in Markdown.
+
+## Repo Layout
+
+- `lib/dsv7/validator.rb` — public entrypoint `Dsv7::Validator.validate(...)`
+- `lib/dsv7/validator/core.rb` — core stream pipeline (BOM/encoding, line parsing)
+- `lib/dsv7/validator/result.rb` — result container (`errors`, `warnings`, `valid?`)
+- `lib/dsv7/parser.rb` — parser namespace and version loader
+- `specification/dsv7/dsv7_specification.md` — cleaned, structured spec text
+- `test/dsv7/*_test.rb` — Minitest suite covering validator behavior
+- `Rakefile` — `rake` (default: tests + rubocop), `rake ci`, `rake rubocop`
+- `lib/dsv7/stream.rb` — IO helpers (BOM, UTF‑8, CR/LF handling)
+- `lib/dsv7/lex.rb` — lexical helpers (FORMAT, element split)
+- `lib/dsv7/validator/line_analyzer.rb` — streaming line analyzer + orchestration
+- `lib/dsv7/validator/line_analyzer_common.rb` — list‑specific analyzer mixins
+- `lib/dsv7/validator/schemas/*.rb` — per‑list attribute schemas
+- `lib/dsv7/validator/types/*.rb` — datatype and enum checks
+- `lib/dsv7/parser/engine.rb` — streaming parser implementation
+- `lib/dsv7/parser/io_util.rb` — parser IO utilities
+
+## Dev Quick Start
+
+- Install deps: `bundle install`
+- Run tests: `bundle exec rake` (or `bundle exec rake test`)
+- Run RuboCop: `bundle exec rake rubocop`
+
+## Spec: “Allgemeines” (Key Rules)
+
+From `specification/dsv7/dsv7_specification.md` → section “Allgemeines” and the general rules that impact top‑level validation:
+
+- Scope and version
+  - Standard for exchanging meet entries and results.
+  - Current format is version `7`, effective from 2023‑01‑01; format 6 valid only until 2023‑07‑31.
+- Encoding and separators
+  - UTF‑8 without BOM.
+  - Attribute delimiter is `;`.
+  - No line breaks inside a single element.
+- Comments
+  - Syntax: `(* ... *)` (intended to be single‑line; inline allowed).
+- File envelope
+  - First effective line must be `FORMAT:<Listentyp>;7;`.
+  - Last element is `DATEIENDE`.
+- Allowed list types
+  - `Wettkampfdefinitionsliste`, `Vereinsmeldeliste`, `Wettkampfergebnisliste`, `Vereinsergebnisliste`.
+- Filenames
+  - Pattern: `JJJJ-MM-TT-Ort-Zusatz.DSV7`.
+  - `Ort`: remove spaces/hyphens; map umlauts `ä→ae`, `ö→oe`, `ü→ue`, `ß→ss`; max 8 chars.
+  - `Zusatz`: `…-Me` (Vereinsmeldeliste), `…-Pr` (Vereinsergebnisliste), `Pr` (Wettkampfergebnisliste), `Wk` (Wettkampfdefinitionsliste).
+- Datatypes (future schema validation)
+  - ZK (string), Zeichen (char), Zahl (int), Zeit (`HH:MM:SS,hh`), Datum (`TT.MM.JJJJ`), Uhrzeit (`HH:MM`), Betrag (`x,yy`), JGAK variants.
+
+## Current Validator Coverage (implemented)
+
+- FORMAT line parsing and validation
+  - Must be first effective line; exact syntax `FORMAT:<Listentyp>;7;`.
+  - List type must be one of the four allowed types.
+  - Version must be `7`.
+- Terminator
+  - `DATEIENDE` must be present; no effective content after it.
+- Encoding and line endings
+  - Detects UTF‑8 BOM (errors); validates UTF‑8 and scrubs invalid input (reports error).
+  - Detects CRLF present anywhere (adds a warning) — still considered valid.
+- Comments and delimiters
+  - Inline comments `(* ... *)` are stripped for checks.
+  - Unbalanced comment delimiters on any single line are errors.
+  - Every non‑empty, non‑comment data line after FORMAT must contain at least one `;`.
+- Filenames
+  - When validating by path, warns if the filename does not match `^\d{4}-\d{2}-\d{2}-[^.]+\.DSV7$`.
+
+- Element schemas and datatypes
+  - Per‑list element schemas enforce exact attribute counts and required/optional positions.
+  - Datatype checks implemented: `ZK`, `Zahl`, `Betrag`, `Zeit`, `Datum`, `Uhrzeit`, plus many enums
+    (e.g., `Technik`, `Ausübung`, `Geschlecht`, `Wettkampfart`, `Wertungstyp`, `JG/AK`).
+  - Cross‑field rule example: `MELDEGELD` with `WKMELDEGELD` requires Wettkampfnr (attr 3).
+  - Accepts synonymous element names where found in the wild (e.g., `STAFFELERGEBNIS`/`STERGEBNIS`).
+- Cardinality checks
+  - Enforces required presence and max occurrences per list type (WKDL, VML, ERG, VRL).
+
+What is not implemented yet (or partial): normalization of `Ort`/`Zusatz` beyond filename pattern; full
+cross‑element ordering/refs (beyond cardinalities); some rarely used elements (e.g., PFLICHTZEIT) are
+intentionally deferred pending clearer examples.
+
+## Minimal Valid Example
+
+```
+FORMAT:Wettkampfdefinitionsliste;7;
+DATA;ok
+DATEIENDE
+```
+
+Notes:
+- Leading/trailing spaces around `FORMAT`/`DATEIENDE` are tolerated.
+- Inline comments are allowed, e.g. `FORMAT:... (* note *)`.
+
+## Tests Overview and Conventions
+
+- Location: `test/dsv7/` using Minitest.
+- Common helpers in tests:
+  - `format_line(type = 'Wettkampfdefinitionsliste', version = '7')`
+  - `validate_string(content)` → `Dsv7::Validator.validate(content)`
+- Existing coverage slices (examples):
+  - Validator envelope and syntax: `validator_test.rb`, `validator_format_syntax_test.rb`,
+    `validator_comments_test.rb`, `validator_encoding_test.rb`, `validator_filename_test.rb`,
+    `validator_whitespace_test.rb`.
+  - Element schemas and datatypes: `validator_schema_base_test.rb`, `validator_wkdl_attributes_test.rb`.
+  - List‑specific suites: `validator_vereinsmeldeliste_*_test.rb`, `validator_wettkampfergebnisliste_*_test.rb`,
+    `validator_vereinsergebnisliste_*_test.rb`.
+  - Parser: `parser_*_test.rb` (including end‑to‑end `e2e_*_test.rb`).
+
+## Suggested Next Steps
+
+- Extend schemas to remaining/rare elements (e.g., `PFLICHTZEIT`) once examples are clarified.
+- Add cross‑element reference/order checks (e.g., section and event numbering consistency).
+- Expand filename normalization checks (umlaut mappings, max length, numeric suffixes like `Ort1`).
+- Harden parser/validator against additional real‑world quirks (document with tests).
+- Update README with Parser streaming examples and advanced validation usage.
+
+# Coding Guidelines for dsv7-parser
+
+Concise conventions for contributing code and tests to this repo. Focus is on a small, dependency‑light Ruby library with a streaming validator and Minitest suite.
+
+## Language & Versions
+
+- Ruby version: `2.7.0` in `.ruby-version`; gem supports `>= 2.7` (see `dsv7-parser.gemspec`).
+- Add `# frozen_string_literal: true` to the top of Ruby files.
+- Avoid non‑portable syntax not available in Ruby 2.7.
+
+## Style & Linting
+
+- Use RuboCop; run `bundle exec rake rubocop`.
+- Write both library code and tests in a RuboCop‑compliant way; fix all offenses before submitting.
+- Do not change `.rubocop.yml` to satisfy offenses; fix the code instead.
+- Avoid inline `# rubocop:disable` comments; refactor to comply where possible.
+- New cops enabled; line length max `100` (see `.rubocop.yml`).
+- `Metrics/BlockLength` is relaxed for `Rakefile` and `test/**/*`.
+- `Style/Documentation` disabled (no mandatory class/module docs).
+- String literals: prefer single quotes; use double quotes when interpolation/escapes are needed.
+- Keep methods small and cohesive; favor clear names over brevity.
+ - Names: prefer full words for variables and methods; avoid abbreviations (e.g., use `line_number` not `line_no`, `add_error` not `add_err`).
+
+## Structure & Namespacing
+
+- Place code under `lib/dsv7/` and namespace under `Dsv7`.
+- Keep validator pipeline pieces encapsulated:
+  - `Dsv7::Validator` (public API, orchestration)
+  - `Dsv7::Validator::Core` (streaming + encoding + lines)
+  - `Dsv7::Validator::Result` (errors/warnings container)
+- Keep responsibilities narrow; prefer small classes/modules over large monoliths.
+
+## Public API Expectations
+
+- Validator: `Dsv7::Validator.validate(input)` supports IO, file path, or content String.
+- Parser: `Dsv7::Parser.parse(input)`, plus list‑specific `parse_*` helpers, yield events
+  `[:format|:element|:end, payload, line_number]` and can be used as enumerators or with blocks.
+- Raise `ArgumentError` for unsupported input types; never print to stdout/stderr in library code.
+
+## Errors, Warnings, Messages
+
+- Use precise, user‑actionable wording; match existing phrasing where possible.
+- Errors go to `result.errors`; warnings to `result.warnings`.
+- Include context when helpful (e.g., line numbers); keep format stable for tests.
+
+## IO & Encoding
+
+- Stream inputs (avoid loading entire files); set `io.binmode`.
+- Detect and report UTF‑8 BOM; enforce UTF‑8 with `force_encoding` and `valid_encoding?`.
+- Preserve processing order; support both LF and CRLF, adding a single warning for CRLF presence.
+
+## Performance & Memory
+
+- Use streaming and incremental processing wherever possible (enumerate by line).
+- Optimize for low memory usage (avoid reading whole files or accumulating large arrays).
+- Prefer single‑pass algorithms; keep per‑line state minimal and discard intermediate buffers.
+
+## Comments and Parsing Rules
+
+- Treat `(* ... *)` as inline comments and strip before structural checks.
+- Ensure balanced comment delimiters on each line.
+- For non‑empty, non‑comment data lines (after `FORMAT`), require at least one `;` delimiter.
+
+## Testing Conventions
+
+- Framework: Minitest; tests live under `test/dsv7/` with `_test.rb` suffix.
+- Helpers used commonly:
+  - `format_line(type = 'Wettkampfdefinitionsliste', version = '7')`
+  - `validate_string(content)` → `Dsv7::Validator.validate(content)`
+- Use tmp files for filename tests; clean them in `ensure` blocks.
+- Assertions: prefer `assert_includes`, `assert_empty`, and `assert result.valid?` for clarity.
+
+## Tooling
+
+- Install deps: `bundle install`
+- Run tests: `bundle exec rake` (default task)
+- Lint: `bundle exec rake rubocop`
+
+## Finish Checklist
+
+- Run tests: `rake test` (or `bundle exec rake test`).
+- Auto-correct style: `rubocop -A .` (or `bundle exec rubocop -A .`).
+- Fix any remaining RuboCop items; re-run `rake test` and `rubocop` until green.
+- If you add a new feature or public API, update `README.md` with usage and examples.
+
+## Repo Quick Reference (Appendix)
+
+- `lib/dsv7/validator.rb` — public entrypoint `Dsv7::Validator.validate(...)`
+- `lib/dsv7/validator/core.rb` — core stream pipeline (BOM/encoding, line parsing)
+- `lib/dsv7/validator/line_analyzer.rb` — per‑line orchestration and finish checks
+- `lib/dsv7/validator/result.rb` — result container (`errors`, `warnings`, `valid?`)
+- `lib/dsv7/parser.rb` — parser namespace and version loader
+- `lib/dsv7/parser/engine.rb` — streaming parser core
+- `specification/dsv7/dsv7_specification.md` — structured spec text
+- `test/dsv7/*_test.rb` — Minitest suite
+- `Rakefile` — `rake` (default: tests + rubocop), `rake ci`, `rake rubocop`
+
+Spec notes driving current behavior: require `FORMAT:<Listentyp>;7;`, final `DATEIENDE`, UTF‑8 without BOM,
+inline comment handling, semicolon on data lines, allowed list types, filename pattern warnings, and
+element/datatype enforcement per list type.
+
+## Patch Discipline
+
+- Keep diffs minimal and targeted; avoid unrelated refactors.
+- Do not reformat whole files; only touch necessary lines.
+- Don’t add license headers or banners.
+- Avoid inline code comments unless explicitly requested.
+- Use descriptive names; avoid one‑letter variables.
+- Prefer full-length, intent-revealing variable names; avoid abbreviations (e.g., `line_number` not `line_no`).
+
+## Error/Warning Policy
+
+- Errors invalidate the file; warnings do not affect `valid?`.
+- Include line numbers when relevant; keep message text stable.
+- Prefer new checks as additional messages over changing existing texts.
+- For non‑normative guidance, favor warnings instead of errors.
+
+## Dependency Policy
+
+- Keep runtime dependencies at zero; prefer stdlib.
+- Discuss before adding any new gem (including dev‑only).
+- Maintain streaming design and dependency‑light footprint.
+
+## API Stability
+
+- Do not change `Dsv7::Validator.validate` signature or return type.
+- `Result#valid?` is based solely on presence of errors.
+- Expose new information via additional fields/methods with tests.
+
+## Test Matrix Expectations
+
+- Add both accept and reject tests for each new rule.
+- Cover LF and CRLF, whitespace quirks, comments, UTF‑8 edge cases.
+- Test both string and file‑path inputs (use `tmp` and cleanup in `ensure`).
+- Prefer precise assertions (`assert_includes`, `assert_empty`, `assert result.valid?`).
+- Keep tests independent, small, and fast.

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'minitest', '>= 5.18'
+  gem 'rake', '>= 13.0'
+  gem 'simplecov', require: false
+end
+
+group :development do
+  gem 'rubocop', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    dsv7-parser (7.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    docile (1.4.1)
+    json (2.15.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.11.3)
+    rubocop (1.81.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  dsv7-parser!
+  minitest (>= 5.18)
+  rake (>= 13.0)
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.7.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 bigcurl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.