sevgi 0.95.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a098e5eabd1f185ef25e4d5797d347db21ccf9bddcb0dea480f921115cc129
-  data.tar.gz: 1bc7cac24e7ab2771d670edaaf4e4323a454c7a331a2663e812df3d9a1868a82
+  metadata.gz: 27a50b6890ad4f1ae6f47470e8b79896ad1281e2bdb54b7cfabd8310cd683c45
+  data.tar.gz: 7839ad48af80ceffb800314422b942406cb4bed1b7bb5c13e2774d121d0746ca
 SHA512:
-  metadata.gz: 6e9b877a8a87ab2493b64bd3a4e3bba4b718697e47fe860b3c98bc40db29271d9b1700113657e627cdb6e0810efc109f73b8e23ef1eb582d8976f7ab2ec8889f
-  data.tar.gz: 05d88614f5030aafcf8ce3f8e05f738decf86614ade78eae319c348d9402c4db1d7657a2743cf4f2f84f2b31f21fdf39f7bf9fef6e4078257d90aa24c9b86140
+  metadata.gz: 53837c04457e0ea48aa71642ea1c25a6fc352ba737b09dc073f988b4694d9cab561699695e6e2e6e89248a1704ccc659f4009e8aa4396737f7dc5a4b7b2ff5e3
+  data.tar.gz: 7f1ffa5979ce5af033451baf13c8746002f719782b633a4af16856d6283f828390eefb92bc2d17fdfbfa387f8e8e2675980dec86b992a483d17db35bdd56552d

data/CHANGELOG.md

@@ -3,7 +3,226 @@
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## Unreleased
+## 1.0.0 - 2026-09-16
+
+### Added
+
+- Added Hatch and Orb Showcase examples and displayed both arc lengths in the Arc example.
+
+### Changed
+
+- Matched documentation page widths to the homepage Showcase.
+- Aligned Derender user guidance with UTF-8 normalization and safe subtree selection rules.
+- Clarified the packaged skill's script invocation, subtree copying, and Derender selection and encoding rules.
+- Allowed Canvas and Paper values as the first `SVG` argument when using the default document profile.
+- Made element `dup` and `clone` own independent subtrees while retaining IDs and Ruby copy semantics.
+- Made Segment equality compare length and direction; ordering still compares length only.
+- Limited Tile cell, row, and column queries to the requested geometry and accelerated XML character validation.
+- Simplified the first-run guide and aligned library constructor examples.
+- Updated the packaged skill for canvas origins, alignment, Paper lookup, curved geometry, and export constraints.
+- Revised DSL catalog examples and packaged Sevgi skill guidance to use statement-style calls and show inspection results.
+- Refined Showcase example tabs, made Ruby and XML views fill their panels, and hid executable preambles from Ruby views.
+- Documented non-rendering element data and clarified the related DSL catalog examples.
+- Refined Showcase heading spacing, page-title colors, and DSL catalog cards across light and dark themes.
+- Removed an obsolete ruler example and unused site code.
+- Kept the Squared and Copperplate guidesheet examples together at the end of the Showcase.
+- Updated the packaged skill to avoid duplicate semantic shapes and unnecessary paint passes.
+
+### Fixed
+
+- Kept horizontal scrollbars visible in Showcase example code panels.
+- Read Derender input in its declared XML encoding and normalized generated source, XML declarations, and markup to UTF-8.
+- Preserved open-path endpoints and derived edges independently of display precision.
+- Kept near-axis and near-parallel line equations and intersections independent of angle and slope rounding.
+- Corrected the Showcase social image dimensions.
+- Added SVG namespaces to standalone drawing examples and regenerated their outputs.
+- Made failed Sevgi Rake tasks stop dependent tasks and captured required-library failures in executor results.
+- Removed executor signal-handler replacement so the host and shell retain SIGINT ownership.
+- Escaped late export CSS as XML text and inserted it only at a supported final root closing tag.
+- Preserved Derender processing instructions and rejected custom entity references and unsupported trailing document nodes before inclusion.
+- Included both box origins in `Align`, unified Tile index validation, and isolated custom numeric attribute snapshots.
+- Prevented avoidable overflow and underflow in point distances.
+- Corrected browser source-panel expectations and added executable documentation, YARD, and packaged-skill checks.
+- Rendered inline code in DSL catalog summaries and kept linked task themes visible below the sticky header.
+- Restored Showcase tab icons with embedded Font Awesome SVGs.
+
+## 0.100.0 - 2026-09-09
+
+### Added
+
+- Added `ArcTo` and `ArcBy` for SVG-native elliptical arc paths.
+- Added Geometry `Arc`, `Ellipse`, and `Circle` with bounds, length, predicates, affine transformations, and
+  linear/quadratic intersections. Closed ellipses and circles support sweeps and hatching.
+- Added Geometry `Point.midpoint`, `Element#closed?`, lined `vertices`, open-path traversal, and `Rect#center`.
+- Added Geometry aggregate bounding boxes through `Operation.box`, point collinearity through `Point.collinear?`, and
+  polygon `simple?`, `convex?`, and `concave?` predicates.
+- Added Protractor and Arc examples and documented the drawing and calculation APIs.
+
+### Changed
+
+- Removed redundant parent scans while duplicating element subtrees.
+- Reused source bounds across Tile cells to reduce repeated calculations and object allocations.
+
+### Fixed
+
+- Preserved Showcase card HTML through Markdown rendering so all examples and their tabs remain visible.
+- Preserved XML declarations, pre-root comments, CDATA sections, inline comments, and namespace-only leaves in
+  Derender output and evaluation.
+- Limited PDF stamp recoloring to replaced text and carried graphics state across a page's content streams.
+- Corrected decimal interval fitting and made Grid point queries honor the active numeric precision.
+- Prevented implicit shell interpretation of single executable arguments in `F.sh` and `F.sh!`, including paths with spaces or shell metacharacters.
+- Preserved inherited namespaces on detached Derender nodes in generated source and direct evaluation, including imports through `EvaluateChildren` and `IncludeChildren`.
+- Prevented sweep and Hatch lines from crossing the exterior between two tangent vertices of a concave polygon.
+- Aligned Tile cells with their declared bounds for circles, rotated shapes, and polygons whose first vertex differs from their bounding-box origin.
+- Limited `Load` chains to 128 active sources with `Executor::LoadDepthError`, preserving cycle detection and nested load diagnostics.
+- Rejected nil and false aggregate-box inputs with the documented geometry error.
+- Restored precision-aware rejection of zero-length Triangle sides.
+- Made point-set collinearity independent of input order and removed eager polygon edge-pair storage.
+- Applied the collinearity tolerance to every three-point subset, removing coordinate-axis-dependent baseline selection.
+
+## 0.99.0 - 2026-08-09
+
+### Added
+
+- Added `SVG.Module` for building anonymous callable drawing modules with their contract installed before definition.
+- Added responsive Mermaid diagrams for the Derender round trip and SVG validation lifecycle.
+
+### Changed
+
+- Reorganized the documentation around getting started, usage, composition, documents, layout, output, and examples.
+- Documented how the `igves` and `igsev` command names reflect their conversion directions.
+- Normalized DSL catalog provider labels to lowercase and simplified polyfill-backed editor entries to `inkscape`.
+
+### Fixed
+
+- Allowed A5-on-A4 pdfcpu conversion to replace an existing output file.
+- Pre-rendered Mermaid diagrams as inline SVG instead of parsing them in site visitors' browsers.
+- Removed duplicate provider and context labels from DSL catalog entries.
+
+## 0.98.2 - 2026-07-25
+
+### Fixed
+
+- Restored the `sevgi` CLI's main-object scope so bare toolkit calls remain available inside script helper classes.
+
+## 0.98.1 - 2026-07-20
+
+### Changed
+
+- Changed the `sevgi` CLI to use the executor's isolated scope by default.
+
+### Removed
+
+- Removed the redundant `-n` and `--nomain` CLI options; library consumers can still select `main: true` through
+  `Sevgi.execute` and `Sevgi.execute_file` when needed.
+
+## 0.98.0 - 2026-07-20
+
+### Added
+
+- Added standard-input support to `sevgi`, `igves`, and `igsev`; `sevgi --as NAME` and
+  `Sevgi.execute_file(..., as: NAME)` supply the logical source basename used by implicit SVG, PDF, and PNG
+  destinations without changing physical load identity.
+
+## 0.97.0 - 2026-07-19
+
+### Added
+
+- Added `sevgi-appendix`, containing the Sevgi agent skill and a RuboCop plugin for preserving readable `.sevgi` DSL
+  source alongside rubyfmt-formatted Ruby; the umbrella `sevgi` gem installs the matching Appendix version.
+- Added `sevgi --skill` to report the validated path of the matching packaged agent skill for product-neutral setup.
+- Added `igsev` to the umbrella gem for normalizing an SVG file through a complete SVG-to-Sevgi-to-SVG round trip.
+
+### Changed
+
+- Made Homebrew the recommended complete CLI installation while retaining Bundler and focused component gems for Ruby
+  application dependencies.
+
+## 0.96.0 - 2026-07-18
+
+### Added
+
+- Added exact, subtree-wide attribute omission to Derender content/file conversion, evaluation, and inclusion APIs;
+  `igves --omit` exposes the same behavior from the command line.
+- Added `Sevgi.SVG` as the explicit namespaced form of the top-level SVG document entrypoint.
+- Added the opt-in recursive `SVG::Modules` contract for callable drawing namespaces.
+- Added callable drawing-module `base` blocks, document and paper registry introspection, Canvas structural equality,
+  renderer options on `RenderChildren`, axis translation helpers, and a CC BY RDF helper.
+- Formalized non-rendering `-` metadata and `+` attribute updates as `Attributes::META_PREFIX` and
+  `Attributes::UPDATE_SUFFIX`; repeated Array updates now concatenate into a stable flat value.
+
+### Changed
+
+- Breaking: replaced the `SVG = Sevgi::Graphics` alias with an independent SVG facade. Facade operations now use
+  capitalized names such as `SVG.Canvas` and `SVG.Document`; lowercase component helpers remain on
+  `Sevgi::Graphics`, and the stuttering `SVG.SVG` form was removed.
+- Breaking: made low-level `Executor.execute` and `execute_file` runners private; consumers use
+  `Sevgi.execute` and `Sevgi.execute_file` while retaining the public result and error types.
+- Breaking: removed the abstract `Document::Base` layer from the selectable document-profile registry; `Minimal` and
+  `Default` are now sibling concrete profiles, and custom profile hierarchies should derive from `Base`.
+- Breaking: renamed Parallelogram segment and constraint arguments by geometric role: `base`, `side`, and
+  `constraint` replace axis-implying constructor names.
+- Made degree-based sine and cosine exact at integer quarter turns, eliminating cardinal Geometry residue.
+- Documented complete file-system failure families for file comparison, output, touch, and upward location helpers.
+- Formalized generated Tile ids, positional CSS classes, template placement, and per-use callback signatures.
+- Formalized String and Symbol ids across Derender selection APIs and documented file-read failures consistently.
+- Breaking: made top-level `Decompile`, `Derender`, `Evaluate`, and `EvaluateChildren` consume inline SVG/XML;
+  file inputs now use the corresponding `File`-suffixed entrypoints.
+- Breaking: replaced callable drawing module `call` block registration with argument-independent `base` blocks;
+  inherited bases run parent-first, and modules with one drawing method conventionally name it `call`.
+- Breaking: made bracket and call notation the canonical Geometry constructors. Among Data value types, bracket notation
+  is public only for Point, Segment, LengthAngle, Margin, and Paper; use `.new` for Location and result carriers, and
+  `Stay` for traversal stop tokens.
+- Breaking: aligned Point and Segment comparison with Ruby `Comparable`; malformed or unrelated comparison operands now
+  return nil from `<=>`.
+- Breaking: executor entrypoints now return immutable `Executor::Result` values and expose only `execute` and
+  `execute_file`; inspect `result.error`, `result.stack`, and `result.value` instead of executor scopes or lifecycle state.
+- Breaking: wrapper attributes and callable arguments use distinct channels, `With` rejects parentless receivers, and
+  unsupported direct constructors are private; use the documented factories for Content, concrete Geometry lined
+  elements, and Grid query values.
+- Breaking: Canvas uses `.new` for explicit fields, `.from_paper(paper, **overrides)` for paper conversion, and
+  `.call`/`Graphics.canvas` for dispatch; the misleading keyword-only `.from_paper(width:, height:)` form was removed.
+- Breaking: `Save`, `Write`, `PNG`, `PDF`, and Sundries native export normalize successful destinations to expanded
+  String paths and create missing parent directories; change-aware SVG writes still return nil when unchanged.
+- Breaking: renamed `Derender.evaluate_file_children` to `evaluate_children_file`; decompiled nodes now own immutable
+  public state while parser, strategy, and construction plumbing remain private.
+- Expanded runtime/YARD parity checks and exact contracts for inherited, extended, generated, and dynamic API surfaces,
+  forwarded options, error channels, path ownership, whitespace, namespaces, nil behavior, and return values.
+
+### Fixed
+
+- Rejected directories from default file discovery while preserving custom locator matchers.
+- Kept `Ancestral` context in non-rendering `-context` metadata instead of leaking it into SVG attributes.
+- Preserved source Canvas units and names when deriving fitted Grid canvases.
+- Prevented stale documentation assets from mixing old layouts with new HTML, and moved sidebar navigation into the
+  tablet menu at 1024px and below.
+- Normalized numeric slots owned by path, shape, transform, tile, and Inkscape page helpers to finite SVG number spelling;
+  arbitrary user-supplied attributes remain untouched.
+- Made named callable wrapper and symbol ids stable while omitting defaults for anonymous modules, and indexed every
+  rendered id value, including false and numeric values, through its serialized string.
+- Preserved signed Geometry constraint directions, rejected invalid sweep/export channels through Sevgi error families,
+  and validated raw output paths before expansion or rendering.
+- Made callable module configuration copy-owned and freeze-aware, document subclasses inherit their nearest profile, and
+  false executor boot receivers remain explicit rather than defaulting to an internal scope.
+- Made element trees, attributes, identifiers, locator results, document profiles, Derender nodes, shell results, and
+  executor results retain owned immutable snapshots where their public contracts promise value semantics.
+- Corrected Shell combined-output separators, nil export density errors, document render-option routing, executor source
+  snapshots, selected-node namespace/whitespace documentation, and Standard character-data validation.
+
+### Removed
+
+- Removed public access to pluralization tables and the internal SVG save extension; pluralization rules are now deeply
+  immutable.
+- Removed public documentation and constant access for command-line implementation modules; the `sevgi` and `igves`
+  executables remain unchanged.
+- Removed eager loading and public documentation of private Showcase build/test support; explicit support entrypoints
+  now keep the harness under the Showcase namespace.
+- Removed public access to document profile name normalizers; registry operations retain them as private plumbing.
+- Removed the redundant `Margin.margin` constructor; use canonical bracket notation.
+- Removed public executor orchestration, obsolete callable-module hooks, the old public attribute syntax constants, and
+  direct construction of abstract or internally wired Content, Element, and Grid query types.
+- Removed accidental public access to abstract Lined factories, internal element-name/export maps, result/location
+  bracket constructors, and direct Stop construction.
 
 ## 0.95.0 - 2026-07-11
 
@@ -87,7 +306,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Changed
 
-- Added the checker board example to the documentation showcase flow.
+- Added the checkerboard example to the documentation showcase flow.
 - Consolidated Victor Book attribution for adapted showcase examples into a single documentation note.
 
 ### Fixed

data/README.md

@@ -1,6 +1,6 @@
 # Sevgi
 
-Top-level API and `.sevgi` script runner.
+The `sevgi` gem provides the top-level API and the `.sevgi` script runner.
 
 ## Install
 
@@ -17,20 +17,38 @@ require "sevgi"
 ## Example
 
 ```ruby
-SVG(:minimal) do
-  rect(width: 3, height: 5)
+SVG :minimal do
+  rect width: 3, height: 5
 end.call
 ```
 
-## Executable
+## Executables
 
 ```sh
 sevgi drawing.sevgi
+igsev drawing.svg
 ```
 
+Both commands read standard input when the file is omitted or `-`. For `sevgi`, implicit `Save`, `PDF`, and `PNG`
+destinations use `output` as the input name. Use `--as NAME` to choose another basename:
+
+```sh
+sevgi --as badge < drawing.sevgi
+igsev < drawing.svg > normalized.svg
+```
+
+`NAME` cannot include a directory. An explicit output path or `default:` argument in the script remains authoritative.
+With a file operand, `--as` keeps the file's source directory so relative `Load` calls continue to resolve there.
+
+`sevgi --skill` prints the validated path of the matching packaged agent skill. See the
+[Appendix documentation](https://github.com/roktas/sevgi/tree/main/appendix) for installation guidance.
+
+`igsev` converts an SVG file to Sevgi source, evaluates it with the complete DSL, and prints the resulting normalized
+SVG. Use `igves` from `sevgi-derender` when the generated Sevgi source itself is the desired output.
+
 ## Ruby compatibility
 
-Requires Ruby 3.4.0 or newer. CI verifies Ruby 3.4.0 and the current development Ruby from `.ruby-version`.
+Requires Ruby 3.4.0 or newer. CI verifies the current Ruby 3.4 release and the development Ruby from `.ruby-version`.
 
 ## Native prerequisites
 
@@ -55,7 +73,7 @@ gem install cairo rsvg2 hexapdf
 
 ## Links
 
-- Documentation: https://sevgi.roktas.dev
-- API documentation: https://www.rubydoc.info/gems/sevgi
-- Source: https://github.com/roktas/sevgi/tree/main/toplevel
-- Changelog: https://github.com/roktas/sevgi/blob/main/CHANGELOG.md
+- Documentation: <https://sevgi.roktas.dev>
+- API documentation: <https://www.rubydoc.info/gems/sevgi>
+- Source: <https://github.com/roktas/sevgi/tree/main/toplevel>
+- Changelog: <https://github.com/roktas/sevgi/blob/main/CHANGELOG.md>

data/bin/igsev

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "sevgi/binaries/igsev"
+
+Sevgi.const_get(:Binaries, false)::Igsev.(ARGV)

data/bin/sevgi

@@ -3,4 +3,4 @@
 
 require "sevgi/binaries/sevgi"
 
-Sevgi::Binaries::Sevgi.(ARGV)
+Sevgi.const_get(:Binaries, false)::Sevgi.(ARGV)

data/lib/sevgi/binaries/igsev.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "sevgi"
+
+module Sevgi
+  # Command-line entrypoint implementations shipped with Sevgi.
+  # @api private
+  module Binaries
+    # Implements the `igsev` executable that round-trips SVG files through Sevgi.
+    # @api private
+    module Igsev
+      extend self
+
+      # Executable name used in help output.
+      PROGNAME = "igsev"
+
+      # Error raised for invalid command-line usage.
+      Error = Class.new(::Sevgi::Error)
+
+      FLAGS = {
+        "--exception" => :vomit,
+        "--help" => :help,
+        "--version" => :version,
+        "-h" => :help,
+        "-v" => :version,
+        "-x" => :vomit
+      }.freeze
+      private_constant :FLAGS
+
+      # Parsed command-line options for the `igsev` executable.
+      # @api private
+      Options = Struct.new(:require, :vomit, :help, :version, :omit) do
+        # Parses command-line options and removes them from the argv array.
+        # @param argv [Array<String>] mutable command-line argument array
+        # @return [Sevgi::Binaries::Igsev::Options] parsed options
+        # @raise [Sevgi::Binaries::Igsev::Error] when an option is not recognized or a required value is missing
+        def self.parse(argv)
+          new.tap do |options|
+            until argv.empty? || argv.first == "-" || !argv.first.start_with?("-")
+              if argv.first == "--"
+                argv.shift
+                break
+              end
+
+              option(argv, options)
+            end
+          end
+        end
+
+        class << self
+          private
+
+          def option(argv, options)
+            arg = argv.shift
+            return options[FLAGS[arg]] = true if FLAGS.key?(arg)
+            if ["-r", "--require"].include?(arg)
+              return options.require = argv.shift || Error.("Option requires a library: #{arg}")
+            end
+
+            return (options.omit ||= []) << (argv.shift || Error.("No attribute given for --omit")) if arg == "--omit"
+
+            Error.("Not a valid option: #{arg}")
+          end
+        end
+      end
+
+      private_constant :Options
+
+      # Runs the `igsev` command-line interface.
+      # @param argv [Array<String>, String, nil] command-line arguments
+      # @return [nil]
+      # @raise [StandardError] when `--exception` or `SEVGI_VOMIT` requests raw errors
+      # @raise [SystemExit] when argv does not match `[options...] [--] [file|-]` or conversion aborts
+      def call(argv)
+        dispatch(Array(argv))
+      rescue Binaries::Igsev::Error => e
+        abort("#{e.message}\n\n#{help}")
+      end
+
+      private
+
+      def backtrace(error)
+        return error.load_backtrace if error.respond_to?(:load_backtrace)
+
+        error.backtrace || []
+      end
+
+      def die(error)
+        warn(error.message)
+        warn("")
+        backtrace(error).each { warn("  #{it}") }
+
+        exit(1)
+      end
+
+      def dispatch(argv)
+        options = Options.parse(argv)
+        return puts(help) if options.help
+        return puts(::Sevgi::VERSION) if options.version
+
+        emit(operand(argv), options)
+      rescue Binaries::Igsev::Error
+        raise
+      rescue ::StandardError => e
+        raise if raw_error?(options)
+
+        die(e)
+      end
+
+      def emit(file, options)
+        result = run(file, options)
+        unless result.success?
+          raise result.error if raw_error?(options)
+
+          die(result.error)
+        end
+
+        result.value.Out()
+      end
+
+      def help
+        <<~HELP
+          Usage: #{PROGNAME} [options...] [--] [SVG file|-]
+
+          See documentation for detailed help.
+
+          Options:
+
+              --omit ATTRIBUTE  Omit an attribute (repeatable)
+          -r, --require LIB     Require Ruby LIB while evaluating generated source
+          -x, --exception       Raise exception instead of abort
+              --                Stop option parsing
+
+          -h, --help            Show this help
+          -v, --version         Display version
+        HELP
+      end
+
+      def operand(argv)
+        file = argv.shift
+        Error.("Unexpected argument: #{argv.first}") unless argv.empty?
+
+        file unless file == "-"
+      end
+
+      def raw_error?(options) = options&.vomit || ENV.fetch(ENVVOMIT, nil)
+
+      def run(file, options)
+        source = if file
+          ::Sevgi::Derender.derender_file(file, omit: options.omit)
+        else
+          ::Sevgi::Derender.derender($stdin.read, omit: options.omit)
+        end
+
+        ::Sevgi.execute(source, require: options.require)
+      end
+    end
+  end
+
+  private_constant :Binaries
+end

data/lib/sevgi/binaries/rake.rb

@@ -14,15 +14,20 @@ module FileUtils
   # @param file [String] Sevgi script file, with or without `.sevgi` extension
   # @param args [Array] positional arguments exposed to the script as `ARGA`
   # @param kwargs [Hash] keyword arguments exposed to the script as `ARGH`
-  # @return [Sevgi::Executor::Scope, nil] execution scope, or nil for an empty file
+  # @return [Sevgi::Executor::Result] immutable execution result
   # @raise [Sevgi::ArgumentError] when the script file cannot be found
-  # @see Sevgi::Executor.execute_file
+  # @raise [Sevgi::Executor::Error] when execution fails, so Rake stops dependent tasks
+  # @see Sevgi.execute_file
   def sevgi(file, *args, **kwargs)
-    Sevgi::Executor.execute_file(Sevgi::F.existing!(file, [Sevgi::EXTENSION])) do
+    result = Sevgi::Executor.__send__(:execute_file, Sevgi::F.existing!(file, [Sevgi::EXTENSION])) do
       extend(Sevgi)
 
       const_set(:ARGA, args).freeze
       const_set(:ARGH, kwargs).freeze
     end
+
+    raise result.error if result.error?
+
+    result
   end
 end