sevgi 0.94.0 → 0.98.2

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 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,11 +14,11 @@ 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
+  # @see Sevgi.execute_file
   def sevgi(file, *args, **kwargs)
-    Sevgi::Executor.execute_file(Sevgi::F.existing!(file, [Sevgi::EXTENSION])) do
+    Sevgi::Executor.__send__(:execute_file, Sevgi::F.existing!(file, [Sevgi::EXTENSION])) do
       extend(Sevgi)
 
       const_set(:ARGA, args).freeze

data/lib/sevgi/binaries/sevgi.rb

@@ -1,30 +1,53 @@
 # frozen_string_literal: true
 
 require "sevgi"
+require "sevgi/skill"
 
 module Sevgi
   # Command-line entrypoint implementations shipped with Sevgi.
+  # @api private
   module Binaries
     # Implements the `sevgi` executable.
+    # @api private
     module Sevgi
       extend self
 
       # Executable name used in help output.
       PROGNAME = "sevgi"
 
+      # Logical source name used for standard input.
+      STDIN_NAME = "output.sevgi"
+
       # Error raised for invalid command-line usage.
       Error = Class.new(::Sevgi::Error)
 
+      FLAGS = {
+        "-x" => :vomit,
+        "--exception" => :vomit,
+        "-h" => :help,
+        "--help" => :help,
+        "--skill" => :skill,
+        "-v" => :version,
+        "--version" => :version
+      }.freeze
+
       # Parsed command-line options for the `sevgi` executable.
       # @api private
-      Options = Struct.new(:require, :nomain, :vomit, :help, :version) do
+      Options = Struct.new(:require, :vomit, :help, :skill, :version, :as) do
         # Parses command-line options and removes them from the argv array.
         # @param argv [Array<String>] mutable command-line argument array
         # @return [Sevgi::Binaries::Sevgi::Options] parsed options
-        # @raise [Sevgi::Binaries::Sevgi::Error] when an option is not recognized
+        # @raise [Sevgi::Binaries::Sevgi::Error] when an option is not recognized or a required value is missing
         def self.parse(argv)
           new.tap do |options|
-            argv.first.start_with?("-") ? option(argv, options) : break until argv.empty?
+            until argv.empty? || argv.first == "-" || !argv.first.start_with?("-")
+              if argv.first == "--"
+                argv.shift
+                break
+              end
+
+              option(argv, options)
+            end
           end
         end
 
@@ -32,18 +55,14 @@ module Sevgi
           private
 
           def option(argv, options)
-            case (arg = argv.shift)
-            when "-r", "--require"
-              options.require = argv.shift
-            when "-n", "--nomain"
-              options.nomain = true
-            when "-x", "--exception"
-              options.vomit = true
-
-            when "-h", "--help"
-              options.help = true
-            when "-v", "--version"
-              options.version = true
+            arg = argv.shift
+            if (flag = FLAGS[arg])
+              options[flag] = true
+            elsif ["-r", "--require"].include?(arg)
+              options.require = argv.shift || Error.("Option requires a library: #{arg}")
+            elsif arg == "--as"
+              options.as = argv.shift
+              Error.("Option requires a name: --as") if options.as.nil? || options.as.empty?
             else
               Error.("Not a valid option: #{arg}")
             end
@@ -51,61 +70,87 @@ module Sevgi
         end
       end
 
-      private_constant :Options
+      private_constant :FLAGS, :Options, :STDIN_NAME
 
       # Runs the `sevgi` command-line interface.
       # @param argv [Array<String>, String, nil] command-line arguments
       # @return [nil]
       # @raise [Sevgi::Executor::Error] when `--exception` or `SEVGI_VOMIT` requests raw executor errors
-      # @raise [SystemExit] when command-line usage or script execution aborts
+      # @raise [SystemExit] when argv does not match `[options...] [--] [file|-]` or script execution aborts
       def call(argv)
         return puts(help) if (options = Options.parse(argv = Array(argv))).help
+        return puts(Skill.path) if options.skill
         return puts(::Sevgi::VERSION) if options.version
 
-        result = run(file = argv.shift, options)
-
-        if result.error?
-          raise result.error if options.vomit || ENV[ENVVOMIT]
-
-          die(result.error, file)
-        end
+        file = operand(argv)
+        handle(run(file, options), file, options)
 
-      rescue Binaries::Sevgi::Error => e
+      rescue Skill::Error => e
         abort(e.message)
+      rescue Binaries::Sevgi::Error => e
+        abort("#{e.message}\n\n#{help}")
       end
 
       private
 
       def die(error, _file)
-        warn(error.message)
-        warn("")
-        error.backtrace!.each { warn("  #{it}") }
-
+        warn(error.message, "", *error.load_backtrace.map { "  #{it}" })
         exit(1)
       end
 
+      def handle(result, file, options)
+        return unless result&.error?
+
+        raise result.error if options.vomit || ENV[ENVVOMIT]
+
+        die(result.error, file)
+      end
+
       def help
         <<~HELP
-          Usage: #{PROGNAME} [options...] <Sevgi file>
+          Usage: #{PROGNAME} [options...] [--] [Sevgi file|-]
 
           See documentation for detailed help.
 
           Options:
 
-          -n, --nomain          Do not modify main object
+              --as NAME         Evaluate input as NAME for implicit output names
           -r, --require LIB     Require Ruby LIB
+              --skill           Display the packaged agent skill path
           -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 execute_file(file, options)
+        name = source_name(options.as) if options.as
+        ::Sevgi.execute_file(file, as: name, require: options.require, main: true)
+      end
+
       def run(file, options)
-        Error.("No sevgi file given.") unless file
+        return execute_file(file, options) if file
 
-        ::Sevgi.execute_file(file, require: options.require, receiver: options.nomain ? nil : TOPLEVEL_BINDING.receiver)
+        ::Sevgi.execute($stdin.read, file: source_name(options.as), require: options.require, main: true)
+      end
+
+      def source_name(name)
+        return STDIN_NAME unless name
+
+        Error.("Option requires a name, not a path: --as") unless ::File.basename(name) == name
+        F.subext(".sevgi", name)
       end
     end
   end
+
+  private_constant :Binaries
 end

data/lib/sevgi/executor/error.rb

@@ -2,43 +2,41 @@
 
 module Sevgi
   class Executor
-    # Wraps an exception raised while executing Sevgi script source.
-    class Error < ::Sevgi::Error
-      # @!attribute [r] error
-      #   @return [Exception] original exception raised by script execution
-      # @!attribute [r] scope
-      #   @return [Sevgi::Executor::Scope] executor scope active when the error was captured
-      attr_reader :error, :scope
+    # Raised when a source attempts to load another source already active in the same scope.
+    # @see https://sevgi.roktas.dev/execution/ Execution guide
+    class CycleError < ::Sevgi::Error
+    end
 
+    # Wraps an exception raised while executing Sevgi script source. Its visited source snapshot records every source in
+    # load order; it is not the active load stack at the instant of failure.
+    # @see https://sevgi.roktas.dev/execution/ Execution guide
+    class Error < ::Sevgi::Error
       # Builds an executor error wrapper.
       # @param error [Exception] original exception
-      # @param scope [Sevgi::Executor::Scope] executor scope active at failure time
+      # @param stack [Array<String>] source file keys visited in load order; the Array and its String entries are copied
+      #   and frozen
       # @return [void]
-      def initialize(error, scope)
-        @error = error
-        @scope = scope
+      def initialize(error, stack)
+        @cause = error
+        @stack = stack.map { it.dup.freeze }.freeze
 
         super(error.message)
       end
 
-      # Returns backtrace entries that belong to the Sevgi load stack.
-      # @return [Array<String>] filtered backtrace lines relative to the current directory
-      def backtrace!
-        sources = stack.map { ::File.expand_path(it) }
+      # Returns backtrace entries that belong to the visited Sevgi source set.
+      # @return [Array<String>] filtered backtrace lines relative to the current directory, or an empty Array when the
+      #   original exception has no backtrace
+      def load_backtrace
+        sources = @stack.map { ::File.expand_path(it) }
 
-        error
-          .backtrace
+        Array(cause.backtrace)
           .select { sources.include?(::File.expand_path(it.split(":", 2).first)) }
           .map { |line| line.delete_prefix("#{::Dir.pwd}/") }
       end
 
       # Returns the original exception as the wrapped cause.
       # @return [Exception]
-      def cause = error
-
-      # Returns the script load stack active at failure time.
-      # @return [Array<String>] script file names in load order
-      def stack = scope.stack
+      attr_reader :cause
     end
   end
 end

data/lib/sevgi/executor/result.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Sevgi
+  class Executor
+    # Describes the outcome of one executor invocation.
+    #
+    # A successful result has a value and no error. A captured script, file, or
+    # library failure has an {Executor::Error} and may retain a value produced
+    # before the failure. The source stack is an immutable snapshot in load
+    # order; it is never shared with the executor's internal mutable state.
+    #
+    # @example Inspect successful execution
+    #   result = Sevgi.execute("6 * 7")
+    #   result.success? #=> true
+    #   result.value    #=> 42
+    #
+    # @example Inspect a captured failure
+    #   result = Sevgi.execute("missing", file: "drawing.sevgi")
+    #   result.error?       #=> true
+    #   result.error.cause  #=> #<NameError ...>
+    #   result.stack        #=> ["drawing.sevgi"]
+    #
+    # @see Sevgi.execute
+    # @see Sevgi.execute_file
+    # @see https://sevgi.roktas.dev/execution/ Execution guide
+    Result = Data.define(:value, :error, :stack) do
+      # @!attribute [r] value
+      #   @return [Object, nil] last value produced, or nil when no value was produced
+      # @!attribute [r] error
+      #   @return [Sevgi::Executor::Error, nil] captured failure, or nil after successful execution
+      # @!attribute [r] stack
+      #   @return [Array<String>] frozen owned source-path snapshot in load order
+
+      # Creates an execution result.
+      # @param value [Object, nil] last value produced before execution finished
+      # @param error [Sevgi::Executor::Error, nil] captured execution failure
+      # @param stack [Array<String>] source files visited in load order
+      # @return [void]
+      def initialize(value:, error:, stack:)
+        super(value:, error:, stack: Array(stack).map { it.dup.freeze }.freeze)
+      end
+
+      private_class_method :[]
+
+      # Reports whether execution completed without a captured error.
+      # @return [Boolean] true when execution succeeded
+      def success? = error.nil?
+
+      # Reports whether execution captured an error.
+      # @return [Boolean] true when execution failed
+      def error? = !success?
+    end
+  end
+end

data/lib/sevgi/executor/scope.rb

@@ -6,13 +6,14 @@ module Sevgi
     #
     # Scope objects belong to one executor run and are pushed onto the current
     # fiber's executor stack. They are not shared between concurrent executions.
+    # @api private
     class Scope
       # @!attribute [r] scope
       #   @return [Module] isolated module where script source is evaluated
       # @!attribute [r] recent
       #   @return [Object, nil] last expression result from the executed source
       # @!attribute [r] error
-      #   @return [Sevgi::Executor::Error, nil] captured execution error
+      #   @return [Exception, nil] captured execution error
       attr_reader :scope, :recent, :error
 
       # Creates a script execution scope.
@@ -25,6 +26,7 @@ module Sevgi
         @recent = nil
         @error = nil
         @stack = {}
+        @active = {}
       end
 
       # Reports whether execution captured an error.
@@ -33,24 +35,16 @@ module Sevgi
 
       # Executes one source object in this scope.
       # @param source [Sevgi::Executor::Source] source to evaluate
-      # @param receiver [Object, nil] receiver used while booting the DSL
+      # @param receiver [Object, nil] explicit boot receiver, or nil to use the isolated scope module
       # @yield optional boot block that installs DSL methods before evaluation
       # @yieldreturn [void]
       # @return [Sevgi::Executor::Scope] self, with recent or error populated
       # @api private
       def call(source, receiver = nil, &boot)
         push(source)
+        execute(source, receiver, &boot)
 
-        tap do
-          @recent = run(source, receiver, &boot)
-
-          # rubocop:disable Lint/RescueException
-        rescue Exception => e
-          @error = Executor::Error.new(e, self)
-
-          throw(:result, self)
-          # rubocop:enable Lint/RescueException
-        end
+        self
       end
 
       # Captures a preprocessing failure for this scope.
@@ -60,7 +54,7 @@ module Sevgi
       # @api private
       def capture(source, error)
         push(source)
-        @error = Executor::Error.new(error, self)
+        @error = error
         self
       end
 
@@ -83,6 +77,16 @@ module Sevgi
       # @note The stack is owned by this scope and is not shared with concurrent executions.
       def stack = @stack.keys
 
+      # Builds the immutable public result for this scope.
+      # @return [Sevgi::Executor::Result] execution result snapshot
+      # @api private
+      def result
+        sources = stack.freeze
+        error = Executor::Error.new(@error, sources) if @error
+
+        Result.new(value: recent, error:, stack: sources)
+      end
+
       # Returns the most recently pushed source.
       # @return [Sevgi::Executor::Source, nil] most recent source object
       # @api private
@@ -93,7 +97,8 @@ module Sevgi
       def boot(receiver, &boot)
         return unless boot
 
-        (receiver ||= scope).public_send(receiver.is_a?(::Module) ? :module_exec : :instance_exec, &boot)
+        receiver = scope if receiver.nil?
+        receiver.public_send(receiver.is_a?(::Module) ? :module_exec : :instance_exec, &boot)
       end
 
       def evaluate(source)
@@ -109,6 +114,33 @@ module Sevgi
         tap { @stack[source.key] = source }
       end
 
+      def enter(source)
+        if @active.key?(source.identity)
+          raise Executor::CycleError, "Recursive Sevgi load: #{source.file}"
+        end
+
+        @active[source.identity] = source
+        source
+      end
+
+      def leave(source)
+        return unless source
+
+        @active.delete(source.identity) if @active[source.identity].equal?(source)
+      end
+
+      def execute(source, receiver, &boot)
+        active = enter(source)
+        @recent = run(source, receiver, &boot)
+        # rubocop:disable Lint/RescueException
+      rescue Exception => e
+        @error = e
+        throw(:result, self)
+        # rubocop:enable Lint/RescueException
+      ensure
+        leave(active)
+      end
+
       def run(source, receiver, &boot)
         boot(receiver, &boot)
         evaluate(source)