breadkit-render 0.1.0 → 0.2.0

data/lib/breadkit/render/svg_template.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+
+module Breadkit
+  module Render
+    class SvgTemplate
+      ELEMENTS = %w[g circle ellipse rect line path polygon polyline text title].freeze
+      ATTRIBUTES = %w[x y x1 y1 x2 y2 cx cy r rx ry width height points d transform fill stroke stroke-width
+                      stroke-linecap stroke-linejoin fill-opacity stroke-opacity opacity font-size font-weight text-anchor].freeze
+      NUMERIC = %w[x y x1 y1 x2 y2 cx cy r rx ry width height stroke-width fill-opacity stroke-opacity opacity font-size].freeze
+      PAINT = %w[fill stroke].freeze
+      VARIABLES = %w[ref value fill stroke text_color].freeze
+
+      def initialize(source)
+        raise Error, "part SVG template exceeds 16 KiB" if source.bytesize > 16 * 1024
+        raise Error, "part SVG template contains unsupported markup" if source.include?("<!") || source.include?("<?")
+
+        @source = source
+      end
+
+      def render(values)
+        expanded = @source.gsub(/\{\{(.*?)\}\}/m) do
+          key = Regexp.last_match(1)
+          raise Error, "unknown part SVG template variable: #{key}" unless VARIABLES.include?(key)
+
+          CGI.escapeHTML(values.fetch(key).to_s)
+        end
+        raise Error, "invalid part SVG template variable" if expanded.include?("{{") || expanded.include?("}}")
+        raise Error, "expanded part SVG template exceeds 32 KiB" if expanded.bytesize > 32 * 1024
+
+        root = REXML::Document.new("<root>#{expanded}</root>").root
+        @nodes = 0
+        root.children.map { |child| serialize(child, 0) }.join
+      rescue REXML::ParseException => e
+        raise Error, "invalid part SVG template: #{e.message.lines.first.to_s.strip}"
+      end
+
+      private
+
+      def serialize(node, depth)
+        raise Error, "part SVG template is too deeply nested" if depth > 8
+        @nodes += 1
+        raise Error, "part SVG template has too many nodes" if @nodes > 128
+        if node.is_a?(REXML::Text)
+          return CGI.escapeHTML(node.value)
+        end
+        raise Error, "unsupported part SVG template node" unless node.is_a?(REXML::Element)
+        raise Error, "unsupported part SVG template element: #{node.name}" unless ELEMENTS.include?(node.name)
+
+        attrs = node.attributes.map do |key, value|
+          raise Error, "unsupported part SVG template attribute: #{key}" unless ATTRIBUTES.include?(key)
+          validate_attribute(key, value)
+          %(#{key}="#{CGI.escapeHTML(value)}")
+        end
+        content = node.children.map { |child| serialize(child, depth + 1) }.join
+        "<#{node.name}#{attrs.empty? ? '' : ' ' + attrs.join(' ')}>#{content}</#{node.name}>"
+      end
+
+      def validate_attribute(key, value)
+        if PAINT.include?(key)
+          raise Error, "invalid part SVG template paint: #{value}" unless value == "none" || Breadkit::Color.valid?(value)
+        elsif NUMERIC.include?(key)
+          valid = /\A[-+]?(?:\d+(?:\.\d*)?|\.\d+)\z/.match?(value) && value.to_f.abs <= 10_000
+          raise Error, "invalid part SVG template number: #{value}" unless valid
+        elsif key == "d"
+          raise Error, "invalid part SVG template path" unless value.bytesize <= 4096 && /\A[\d\s,\.\-+MmLlHhVvCcSsQqTtAaZz]*\z/.match?(value)
+        elsif key == "points"
+          raise Error, "invalid part SVG template points" unless /\A[\d\s,\.\-+]*\z/.match?(value)
+        elsif key == "transform"
+          raise Error, "invalid part SVG template transform" unless value.match?(/\A(?:\s*(?:translate|rotate|scale|matrix)\([\d\s,\.\-+]+\)\s*)+\z/)
+        elsif key == "stroke-linecap"
+          raise Error, "invalid part SVG template line cap" unless %w[butt round square].include?(value)
+        elsif key == "stroke-linejoin"
+          raise Error, "invalid part SVG template line join" unless %w[miter round bevel].include?(value)
+        elsif key == "text-anchor"
+          raise Error, "invalid part SVG template text anchor" unless %w[start middle end].include?(value)
+        elsif key == "font-weight"
+          raise Error, "invalid part SVG template font weight" unless %w[normal bold 100 200 300 400 500 600 700 800 900].include?(value)
+        end
+      end
+    end
+  end
+end

data/lib/breadkit/render/theme.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Breadkit
+  module Render
+    module Theme
+      FONT_FORMATS = { ".ttf" => ["font/ttf", "\x00\x01\x00\x00".b], ".otf" => ["font/otf", "OTTO"],
+                       ".woff" => ["font/woff", "wOFF"], ".woff2" => ["font/woff2", "wOF2"] }.freeze
+      MAX_FONT_SIZE = 5 * 1024 * 1024
+
+      module_function
+
+      def load(path)
+        data = JSON.parse(File.read(path, encoding: "UTF-8"))
+        raise Error, "theme must be a JSON object" unless data.is_a?(Hash)
+        unknown = data.keys - %w[base colors]
+        raise Error, "unknown theme option: #{unknown.join(', ')}" unless unknown.empty?
+
+        base = data.fetch("base", "light")
+        raise Error, "unknown base theme: #{base}" unless SvgRenderer::COLORS.key?(base)
+
+        colors = data.fetch("colors", {})
+        raise Error, "theme colors must be an object" unless colors.is_a?(Hash)
+        colors.each do |key, value|
+          raise Error, "unknown theme color: #{key}" unless SvgRenderer::COLORS.fetch(base).key?(key.to_sym)
+          raise Error, "invalid theme color for #{key}: use #RRGGBB" unless value.is_a?(String) && value.match?(/\A#[0-9a-fA-F]{6}\z/)
+        end
+        { base: base, colors: colors.transform_keys(&:to_sym) }
+      rescue JSON::ParserError => e
+        raise Error, "invalid theme JSON: #{e.message}"
+      end
+
+      def font(path)
+        format = FONT_FORMATS[File.extname(path).downcase]
+        raise Error, "unsupported font format: use TTF, OTF, WOFF, or WOFF2" unless format
+        raise Error, "font file is too large (limit: 5 MiB)" if File.size(path) > MAX_FONT_SIZE
+
+        bytes = File.binread(path)
+        raise Error, "invalid font signature" unless bytes.start_with?(format.last)
+
+        "@font-face{font-family:BreadkitEmbedded;src:url(data:#{format.first};base64,#{[bytes].pack('m0')})}"
+      end
+    end
+  end
+end

data/lib/breadkit/render/version.rb

@@ -2,6 +2,6 @@
 
 module Breadkit
   module Render
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/breadkit/render.rb

@@ -5,7 +5,14 @@ require "cgi/escape"
 require "open3"
 require_relative "render/version"
 require_relative "render/svg_renderer"
+require_relative "render/state_selection"
+require_relative "render/svg_template"
+require_relative "render/orthogonal_router"
+require_relative "render/theme"
+require_relative "render/netlist_renderer"
+require_relative "render/schematic_renderer"
 require_relative "render/rasterizer"
+require_relative "render/apng_encoder"
 require_relative "render/cli"
 
 module Breadkit

data/scripts/check-contrast.mjs

@@ -0,0 +1,28 @@
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+
+const css = readFileSync(new URL("../site/styles.css", import.meta.url), "utf8");
+const colors = Object.fromEntries(
+  [...css.matchAll(/--color-([a-z]+):\s*(#[0-9a-f]{6})\s*;/gi)].map(([, name, value]) => [name, value])
+);
+
+function luminance(hex) {
+  return [1, 3, 5].reduce((sum, offset, index) => {
+    const channel = Number.parseInt(hex.slice(offset, offset + 2), 16) / 255;
+    const linear = channel <= 0.04045 ? channel / 12.92 : ((channel + 0.055) / 1.055) ** 2.4;
+    return sum + linear * [0.2126, 0.7152, 0.0722][index];
+  }, 0);
+}
+
+for (const [foreground, background] of [
+  ["paper", "ink"], ["paper", "board"],
+  ["muted", "ink"], ["muted", "board"],
+  ["copper", "ink"], ["copper", "board"],
+  ["ink", "copper"]
+]) {
+  assert.ok(colors[foreground] && colors[background], `Missing ${foreground}/${background} color`);
+  const values = [luminance(colors[foreground]), luminance(colors[background])].sort((a, b) => b - a);
+  const ratio = (values[0] + 0.05) / (values[1] + 0.05);
+  assert.ok(ratio >= 4.5, `${foreground}/${background} contrast ${ratio.toFixed(2)} is below 4.5`);
+  console.log(`${foreground}/${background}: ${ratio.toFixed(2)}`);
+}

data/sig/breadkit/render.rbs

@@ -16,10 +16,28 @@ module Breadkit
         ?color_by: String,
         ?annotations: Array[Hash[String, untyped]],
         ?rail_pattern: String?,
-        ?interactive_layers: bool
+        ?interactive_layers: bool,
+        ?state: Breadkit::State?,
+        ?active_layer: String?,
+        ?focus: String?,
+        ?highlight_net: String?,
+        ?label_density: String,
+        ?diff_wires: Hash[String, String],
+        ?theme_colors: Hash[Symbol, String],
+        ?font_css: String?,
+        ?wire_routing: String,
+        ?wire_style: String
       ) -> String
     end
 
+    class NetlistRenderer
+      def render: (Breadkit::Circuit circuit, ?theme: String, ?state: Breadkit::State?) -> String
+    end
+
+    class SchematicRenderer
+      def render: (Breadkit::Circuit circuit, ?theme: String, ?state: Breadkit::State?) -> String
+    end
+
     class Rasterizer
       def rasterize: (
         String svg,
@@ -27,10 +45,15 @@ module Breadkit
         ?scale: Float,
         ?background: String,
         ?quality: Integer,
-        ?backend: String
+        ?backend: String,
+        ?timeout: Float | Integer
       ) -> String
     end
 
+    class ApngEncoder
+      def encode: (Array[String] images, ?delay_ms: Integer) -> String
+    end
+
     class CLI
       def run: (Array[String] argv) -> Integer
     end