sevgi 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b971f6463976ab416c5c4f28eefdb1ee3e328bb55f5f45bf657cbd98d6a16ca
-  data.tar.gz: ad9ae5335d726e61f46a56c1a197a2e63099c99379353f564aceede7fb8db4d5
+  metadata.gz: d10f877d0767cd2b04ac1165e6485601e85ba444486c0f9a304cf46bdcd9291b
+  data.tar.gz: 0bcbdaaf6df270a83a184de931bb70958447b0f446339fcf51daa74c2b76cc59
 SHA512:
-  metadata.gz: f109c41b30c16a773a90c01559fa0468c7802b98929bb82c1d1b93a290c32c8a499af2d50a8f5ee54da3676748f70134e0b365384b43ab4ca7962c77371a65a8
-  data.tar.gz: '09cac74bd7e21e347d6a89453ada53a36f1144466507e59cde71947b07a514b2be5a0e0c81fb5e4162b8f0e68dfde612d653c3497903759bd9c9c29afc881343'
+  metadata.gz: d08ecea5e16f48d8f950cd3245a5fa497913b68f0e6d9fa1303a8c7b3515a4d24af55c4bef2fb8c4b23e2d0d0d0ec8fd3ea6fcef78b899c0e857802eb64b1be9
+  data.tar.gz: 181d34db462e84b100194e33542243ee090e15933a5a37b14efdcf8c164b2d751b4231736826f3c51a7e37111902c82b97b67338cfcf57faada244f8108cf1e7

data/README.md

@@ -1,15 +1,35 @@
 [![test status](https://github.com/roktas/sevgi/workflows/Test/badge.svg)](https://github.com/roktas/sevgi/actions?query=workflow%3ATest)
-[![code quality](https://codebeat.co/badges/f2de3389-dd66-4d7a-b7fb-452330d62176)](https://codebeat.co/projects/github-com-roktas-sevgi-dev)
+[![code quality](https://codebeat.co/badges/b7c41452-51ba-417d-9cea-b29782993147)](https://codebeat.co/projects/github-com-roktas-sevgi-dev)
 
-# Sevgi
+# SEVGI
+
+**SEVGI** is a toolkit for creating SVG content programmatically with Ruby as demonstrated below[^1]. You can use it to
+create pixel-perfect graphics without using a vector graphics editor in certain scenarios. Thanks to a mixin based
+design, you can easily add custom features and use a rich set of methods, especially for tiling, hatching and various
+geometric operations.
 
 <p align="center"><img src="srv/static/assets/light/logo.svg#gh-light-mode-only"/></p>
 <p align="center"><img src="srv/static/assets/dark/logo.svg#gh-dark-mode-only"/></p>
 
 <p align="center"><img src="srv/static/assets/light/pacman-animation.png"/></p>
 
-Inspired by [Victor](https://github.com/DannyBen/victor), which might be a better choice for those seeking something
-simpler. Please note that a fair amount of the examples used for demonstration purposes come from this project (thanks
-to the author).
-
 ### Roadmap
+
+**The project is currently in pre-alpha stage. So many things might not work and many things can change.**
+
+Alpha stage
+
+- [ ] Stabilize API.
+- [ ] Complete unit tests for all critical code paths.
+- [ ] Populate examples while adding integration tests.
+- [ ] Write entry-level user documentation.
+
+Beta stage
+
+- [ ] Complete Geometry library.
+- [ ] Complete user documentation.
+- [ ] Start documenting API.
+
+[^1]: Inspired by [Victor](https://github.com/DannyBen/victor), which might be a better choice for those seeking
+      something simpler. Please note that a fair amount of the examples used for demonstration purposes come from this
+      project (thanks to the author).

data/lib/sevgi/function.rb

@@ -3,15 +3,15 @@
 module Sevgi
   module Function
     module External
-      EXTENSIONS  = ["sevgi", "rb"].freeze
-      DIRECTORIES = ["lib", "library"].freeze
+      EXTENSIONS  = [ "sevgi", "rb" ].freeze
+      DIRECTORIES = [ "lib", "library" ].freeze
 
       def Lib(name)
         start = ::File.dirname(caller_locations(1..1).first.path)
 
         paths = F.variations(name, DIRECTORIES, EXTENSIONS)
 
-        raise Error, "No library found matching: #{name}" unless (location = Locate.(paths, start))
+        raise(Error, "No library found matching: #{name}") unless (location = Locate.(paths, start))
 
         Kernel.load(location.file)
       end

data/lib/sevgi/geometry/elements/rect.rb

@@ -17,7 +17,7 @@ module Sevgi
               top_left:     position,
               top_right:    position.translate(dx: rect.width),
               bottom_right: position.translate(dx: rect.width, dy: rect.height),
-              bottom_left:  position.translate(dy: rect.height),
+              bottom_left:  position.translate(dy: rect.height)
             )
           end
         end
@@ -33,7 +33,7 @@ module Sevgi
               top:    Segment[corner.top_left,    corner.top_right],
               right:  Segment[corner.top_right,   corner.bottom_right],
               bottom: Segment[corner.bottom_left, corner.bottom_right],
-              left:   Segment[corner.top_left,    corner.bottom_left],
+              left:   Segment[corner.top_left,    corner.bottom_left]
             )
           end
         end

data/lib/sevgi/geometry/elements/segment.rb

@@ -45,7 +45,7 @@ module Sevgi
       end
 
       def infinite?
-        [position, ending].any(&:infinite?)
+        [ position, ending ].any(&:infinite?)
       end
 
       def length
@@ -82,7 +82,7 @@ module Sevgi
         end
 
         def forward(p, q = nil)
-          new(position: (points = [p, q || p]).sort!.shift, ending: points.shift)
+          new(position: (points = [ p, q || p ]).sort!.shift, ending: points.shift)
         end
 
         def directed(position: Point.origin, length:, direction:)

data/lib/sevgi/geometry/equation/line/diagonal.rb

@@ -18,26 +18,20 @@ module Sevgi
           end
 
           def eql?(other)
-            self.class == other.class && [slope, intercept] == [other.slope, other.intercept]
+            self.class == other.class && [ slope, intercept ] == [ other.slope, other.intercept ]
           end
 
           alias_method :==, :eql?
 
           def hash
-            [self.class, slope, intercept].hash
+            [ self.class, slope, intercept ].hash
           end
 
           def intersection(other)
             case other
-            when Diagonal
-              x = (other.intercept - intercept) / (slope - other.slope)
-              y = y(x)
-            when Horizontal
-              y = other.y
-              x = x(y)
-            when Vertical
-              x = other.x
-              y = y(x)
+            when Diagonal   then y = y(x = (other.intercept - intercept) / (slope - other.slope))
+            when Horizontal then x = x(y = other.y)
+            when Vertical   then y = y(x = other.x)
             end
 
             Point[x, y]

data/lib/sevgi/geometry/operation/sweep.rb

@@ -13,7 +13,7 @@ module Sevgi
 
           [
             *unisweep(element, line.shift(-step), -step, limit:).reverse,
-            *unisweep(element, line, step, limit:),
+            *unisweep(element, line, step, limit:)
           ].tap do |segments|
             yield(segments) if block
           end

data/lib/sevgi/geometry/point.rb

@@ -26,11 +26,11 @@ module Sevgi
       end
 
       def infinite?
-        [x, y].any?(&:infinite?)
+        [ x, y ].any?(&:infinite?)
       end
 
       def nan?
-        [x, y].any?(&:nan?)
+        [ x, y ].any?(&:nan?)
       end
 
       def to_s
@@ -42,7 +42,7 @@ module Sevgi
       end
 
       def unordered_between?(p, q)
-        nan? ? false : between?([p, q].min, [p, q].max)
+        nan? ? false : between?([ p, q ].min, [ p, q ].max)
       end
 
       def <=>(other)

data/lib/sevgi/graphics/attribute.rb

@@ -33,7 +33,7 @@ module Sevgi
 
         def import(attributes)
           hash = attributes.compact.to_a.map do |key, value|
-            [key.to_sym, value.is_a?(::Hash) ? value.transform_keys!(&:to_sym) : value]
+            [ key.to_sym, value.is_a?(::Hash) ? value.transform_keys!(&:to_sym) : value ]
           end.to_h
 
           @store.merge!(hash)
@@ -91,10 +91,10 @@ module Sevgi
         private
 
         UPDATER = {
-          ::String => proc { |old_value, new_value| [old_value, new_value].reject(&:empty?).join(" ") },
-          ::Symbol => proc { |old_value, new_value| [old_value, new_value].reject(&:empty?).join(" ").to_sym },
-          ::Array  => proc { |old_value, new_value| [old_value, new_value] },
-          ::Hash   => proc { |old_value, new_value| merge(old_value, new_value.transform_keys(&:to_sym)) },
+          ::String => proc { |old_value, new_value| [ old_value, new_value ].reject(&:empty?).join(" ") },
+          ::Symbol => proc { |old_value, new_value| [ old_value, new_value ].reject(&:empty?).join(" ").to_sym },
+          ::Array  => proc { |old_value, new_value| [ old_value, new_value ] },
+          ::Hash   => proc { |old_value, new_value| merge(old_value, new_value.transform_keys(&:to_sym)) }
         }.freeze
 
         def update(id, new_value)
@@ -105,16 +105,16 @@ module Sevgi
           ArgumentError.("Incompatible values: #{new_value} vs #{old_value}") unless new_value.is_a?(old_value.class)
           ArgumentError.("Unsupported value for update: #{new_value}")        unless UPDATER.key?(new_value.class)
 
-          [old_value, new_value]
+          [ old_value, new_value ]
         end
 
         private_constant :UPDATER
 
         def to_xml(id, value)
           case value
-          when ::Hash  then %[#{id}="#{value.map { "#{_1}:#{_2}" }.join("; ")}"]
-          when ::Array then %[#{id}="#{value.join(" ")}"]
-          else              %[#{id}=#{value.to_s.encode(xml: :attr)}]
+          when ::Hash  then %(#{id}="#{value.map { "#{_1}:#{_2}" }.join("; ")}")
+          when ::Array then %(#{id}="#{value.join(" ")}")
+          else              %(#{id}=#{value.to_s.encode(xml: :attr)})
           end
         end
       end

data/lib/sevgi/graphics/content.rb

@@ -7,7 +7,7 @@ module Sevgi
 
       def initialize(content)     = @content = content
 
-      def render(renderer, depth) = raise NotImplementedError
+      def render(renderer, depth) = raise(NotImplementedError)
 
       def to_s                    = content.to_s
 
@@ -28,7 +28,7 @@ module Sevgi
           super
         end
 
-        def render(renderer, depth)
+        def render(renderer, depth) # rubocop:disable Metrics/MethodLength
           depth += 1
 
           renderer.append(depth, "<![CDATA[")

data/lib/sevgi/graphics/document/default.rb

@@ -7,11 +7,11 @@ module Sevgi
         document :default,
           attributes: {
             "xmlns":       "http://www.w3.org/2000/svg",
-            "xmlns:xlink": "http://www.w3.org/1999/xlink",
+            "xmlns:xlink": "http://www.w3.org/1999/xlink"
           },
-          preambles: [
+          preambles:  [
             '<?xml version="1.0" standalone="no"?>',
-            '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">',
+            '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">'
           ]
       end
     end

data/lib/sevgi/graphics/document/inkscape.rb

@@ -4,10 +4,11 @@ module Sevgi
   module Graphics
     module Document
       class Inkscape < Default
-        document :inkscape, attributes: {
+        document :inkscape,
+attributes: {
           "xmlns:inkscape":  "http://www.inkscape.org/slugs/inkscape",
           "xmlns:sodipodi":  "http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd",
-          "shape-rendering": "crispEdges",
+          "shape-rendering": "crispEdges"
         }
 
         mixture Mixtures::Inkscape

data/lib/sevgi/graphics/mixtures/hatch.rb

@@ -5,13 +5,13 @@ module Sevgi
     module Mixtures
       module Hatch
         module InstanceMethods
-          def Draw(segments, **)
-            segments.each { |segment| segment.draw(self, **) }
+          def Draw(segments, **kwargs)
+            segments.each { |segment| segment.draw(self, **kwargs) }
           end
 
-          def Hatch(canvas, direction:, step:, **)
+          def Hatch(canvas, direction:, step:, **kwargs)
             Geometry::Operation.sweep!(rect = canvas.rect, initial: rect.position, direction:, step:).tap do |segments|
-              Draw(segments, **)
+              Draw(segments, **kwargs)
             end
           end
         end

data/lib/sevgi/graphics/mixtures/identify.rb

@@ -31,7 +31,7 @@ module Sevgi
                 next unless (id = element[:id])
 
                 if @namespace.key?(id)
-                  (@collision[id] ||= [@namespace[id]]) << element
+                  (@collision[id] ||= [ @namespace[id] ]) << element
                 else
                   @namespace[id] = element
                 end
@@ -59,7 +59,9 @@ module Sevgi
           SEPARATOR = "-"
 
           IdentifyAs = Data.define(:id) do
-            def label(*indexes) = (id and [id, *indexes].map(&:to_s).join(SEPARATOR))
+            def label(*indexes)
+              id and [ id, *indexes ].map(&:to_s).join(SEPARATOR)
+            end
           end
 
           IdentifyAsList = Class.new(IdentifyAs) do

data/lib/sevgi/graphics/mixtures/render.rb

@@ -56,7 +56,7 @@ module Sevgi
 
             root.Traverse(
               0,
-              proc { |element, depth| render_leave(element, depth) },
+              proc { |element, depth| render_leave(element, depth) }
             )      { |element, depth| render_enter(element, depth) }
 
             output.join("\n")
@@ -99,7 +99,7 @@ module Sevgi
           end
 
           def attributes_inline(element, depth, lines)
-            line = "<#{[element.name, *lines].join(" ")}"
+            line = "<#{[ element.name, *lines ].join(" ")}"
 
             append(depth, (childless?(element) ? "#{line}/>".tap { closed } : "#{line}>"))
           end

data/lib/sevgi/graphics/mixtures/replicate.rb

@@ -5,6 +5,7 @@ module Sevgi
     module Mixtures
       module Replicate
         module InstanceMethods
+          # rubocop:disable Metrics/MethodLength
           def Replicate(nx: Undefined, dx: Undefined, ix: nil, ny: Undefined, dy: Undefined, iy: nil, id: nil, &block)
             Ensure.without_block(block, nx:, dx:, ny:, dy:)
 
@@ -32,9 +33,7 @@ module Sevgi
 
             With do |base|
               layer(id:) do
-                (n - 1).times do |time|
-                  base.DuplicateH((time + 1) * d, parent: self)
-                end
+                (n - 1).times { |time| base.DuplicateH((time + 1) * d, parent: self) }
               end.tap do |element|
                 base.AdoptFirst(element)
                 IdentifyAsList(element.children, i)
@@ -47,9 +46,7 @@ module Sevgi
 
             With do |base|
               layer(id:) do
-                (n - 1).times do |time|
-                  base.DuplicateV((time + 1) * d, parent: self)
-                end
+                (n - 1).times { |time| base.DuplicateV((time + 1) * d, parent: self) }
               end.tap do |element|
                 base.AdoptFirst(element)
                 IdentifyAsList(element.children, i)
@@ -89,7 +86,7 @@ module Sevgi
             ny:     proc { |name, value| "Argument '#{name}' must be a positive integer" unless value.positive?        },
             d:      proc { |name, value| "Argument '#{name}' must be a number"           unless value.is_a?(::Numeric) },
             dx:     proc { |name, value| "Argument '#{name}' must be a number"           unless value.is_a?(::Numeric) },
-            dy:     proc { |name, value| "Argument '#{name}' must be a number"           unless value.is_a?(::Numeric) },
+            dy:     proc { |name, value| "Argument '#{name}' must be a number"           unless value.is_a?(::Numeric) }
           }.freeze
 
           def with_block(block, **)

data/lib/sevgi/graphics/mixtures/transform.rb

@@ -9,7 +9,7 @@ module Sevgi
             tap do
               next if x.to_f == 0.0 && (y.nil? || y.to_f == 0.0)
 
-              attributes[:"transform+"] = "translate(#{(y ? [x, y] : [x]).join(" ")})"
+              attributes[:"transform+"] = "translate(#{(y ? [ x, y ] : [ x ]).join(" ")})"
             end
           end
 
@@ -17,7 +17,7 @@ module Sevgi
             tap do
               next if x.to_f == 0.0 && (y.nil? || y.to_f == 0.0)
 
-              attributes[:"transform+"] = "scale(#{(y ? [x, y] : [x]).join(", ")})"
+              attributes[:"transform+"] = "scale(#{(y ? [ x, y ] : [ x ]).join(", ")})"
             end
           end
 
@@ -49,7 +49,7 @@ module Sevgi
 
               next if a.to_f == 0.0
 
-              attributes[:"transform+"] = "rotate(#{[a, *origin].join(", ")})"
+              attributes[:"transform+"] = "rotate(#{[ a, *origin ].join(", ")})"
             end
           end
 

data/lib/sevgi/internal/locate.rb

@@ -20,9 +20,7 @@ module Sevgi
       here = Dir.pwd
       until (found = match(&block))
         Dir.chdir("..")
-        return if Dir.pwd == here
-
-        here = Dir.pwd
+        Dir.pwd == here ? return : here = Dir.pwd
       end
 
       Location[::File.expand_path(found, here), found, here]

data/lib/sevgi/internal/margin.rb

@@ -3,7 +3,7 @@
 module Sevgi
   Margin = Data.define(:top, :right, :bottom, :left) do
     def initialize(top: nil, right: nil, bottom: nil, left: nil)
-      case [top, right, bottom, left]
+      case [ top, right, bottom, left ]
       in Numeric,  Numeric,  Numeric,  Numeric  then # nop
       in Numeric,  Numeric,  Numeric,  NilClass then left                     = right
       in Numeric,  Numeric,  NilClass, NilClass then bottom, left             = top, right

data/lib/sevgi/internal/minitest/script.rb

@@ -34,7 +34,7 @@ module Sevgi
 
       def run_passive(*)
         warn("  ==> #{file}")
-        Shell.run("sevgi", "-l", "/dev/stdin", file, *) { puts INTERCEPTOR }
+        Shell.run("sevgi", "-l", "/dev/stdin", file, *) { puts(INTERCEPTOR) }
       end
 
       private

data/lib/sevgi/internal/minitest/shell.rb

@@ -45,14 +45,14 @@ module Sevgi
           out = stdout.readlines.map(&:chomp)
           err = stderr.readlines.map(&:chomp)
 
-          [out, err, thread.value]
+          [ out, err, thread.value ]
         end
 
         def handle_sigint(pid)
           message, signal = if @coathooks > 1
-            ["SIGINT received again. Force quitting...", "KILL"]
+            [ "SIGINT received again. Force quitting...", "KILL" ]
           else
-            ["SIGINT received.", "TERM"]
+            [ "SIGINT received.", "TERM" ]
           end
 
           warn("\n#{message}")

data/lib/sevgi/internal/minitest/suite.rb

@@ -15,7 +15,7 @@ module Sevgi
         @suites ||= @scripts.map(&:suite).uniq
       end
 
-      NON_VALIDS = ["gotcha"]
+      NON_VALIDS = [ "gotcha" ]
 
       def non_valids
         NON_VALIDS.map { self[_1] }.flatten

data/lib/sevgi/internal/paper.rb

@@ -17,7 +17,7 @@ module Sevgi
     pocket:    Dim[90.0,  140.0],
     travelers: Dim[110.0, 210.0],
     us:        Dim[215.9, 279.4],
-    xlarge:    Dim[190.0, 250.0],
+    xlarge:    Dim[190.0, 250.0]
   }.tap do
     def _1.default_proc = proc { |_, key| ArgumentError.("No such paper: #{key}") }
 

data/lib/sevgi/standard/data/attribute.rb

@@ -4,7 +4,7 @@ module Sevgi
   module Standard
     module Attribute
       import(
-        Animation: %i[
+        Animation:                %i[
           accelerate
           accumulate
           additive
@@ -33,7 +33,7 @@ module Sevgi
           values
         ],
 
-        AnimationAddition: %i[
+        AnimationAddition:        %i[
           accumulate
           additive
         ],
@@ -43,7 +43,7 @@ module Sevgi
           attributeType
         ],
 
-        AnimationValue: %i[
+        AnimationValue:           %i[
           accelerate
           autoReverse
           by
@@ -56,7 +56,7 @@ module Sevgi
           values
         ],
 
-        AnimationTiming: %i[
+        AnimationTiming:          %i[
           begin
           dur
           end
@@ -68,7 +68,7 @@ module Sevgi
           restart
         ],
 
-        Aria: %i[
+        Aria:                     %i[
           aria-activedescendant
           aria-atomic
           aria-autocomplete
@@ -119,13 +119,13 @@ module Sevgi
           aria-valuetext
         ],
 
-        ConditionalProcessing: %i[
+        ConditionalProcessing:    %i[
           requiredExtensions
           requiredFeatures
           systemLanguage
         ],
 
-        Core: %i[
+        Core:                     %i[
           autofocus
           id
           lang
@@ -135,13 +135,13 @@ module Sevgi
           xml:space
         ],
 
-        EventAnimation: %i[
+        EventAnimation:           %i[
           onbegin
           onend
           onrepeat
         ],
 
-        EventDocument: %i[
+        EventDocument:            %i[
           onabort
           onerror
           onresize
@@ -149,13 +149,13 @@ module Sevgi
           onunload
         ],
 
-        EventDocumentElement: %i[
+        EventDocumentElement:     %i[
           oncopy
           oncut
           onpaste
         ],
 
-        EventGlobal: %i[
+        EventGlobal:              %i[
           oncancel
           oncanplay
           oncanplaythrough
@@ -214,13 +214,13 @@ module Sevgi
           onwaiting
         ],
 
-        EventGraphical: %i[
+        EventGraphical:           %i[
           onactivate
           onfocusin
           onfocusout
         ],
 
-        FilterPrimitive: %i[
+        FilterPrimitive:          %i[
           height
           result
           width
@@ -228,7 +228,7 @@ module Sevgi
           y
         ],
 
-        FilterTransferFunction: %i[
+        FilterTransferFunction:   %i[
           amplitude
           exponent
           intercept
@@ -238,7 +238,7 @@ module Sevgi
           type
         ],
 
-        Presentation: %i[
+        Presentation:             %i[
           alignment-baseline
           baseline-shift
           clip
@@ -303,12 +303,12 @@ module Sevgi
           writing-mode
         ],
 
-        Style: %i[
+        Style:                    %i[
           class
           style
         ],
 
-        Xlink: %i[
+        Xlink:                    %i[
           xlink:actuate
           xlink:arcrole
           xlink:href
@@ -320,7 +320,7 @@ module Sevgi
 
         # Uncategorized attributes (for the sake of completeness)
 
-        Uncategorized: %i[
+        Uncategorized:            %i[
           accent-height
           alphabetic
           arabic-form
@@ -480,7 +480,7 @@ module Sevgi
 
         # Deprecated attributes
 
-        Deprecated: %i[
+        Deprecated:               %i[
           accent-height
           alphabetic
           amplitude
@@ -489,7 +489,7 @@ module Sevgi
           attributeType
           baseProfile
           bbox
-        ],
+        ]
       )
     end
   end