victor 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4fb744c40ffdf04d89198bbe192150e73fc6776f2fc92f26bfd246c1f107c98
-  data.tar.gz: 1360dae8be0520d6357ec7300c19cb7a7769cc656081fa1f66dd5bfdbe2895b0
+  metadata.gz: 6cfb9ab7b01c8fe3986d973cf09708e47b05ec61d726f4db2e5c94f5b7697d8b
+  data.tar.gz: 55936a274c2b1f662ad6dfb4aacb8396499fe6f5c7366d33fde7858e082d02d1
 SHA512:
-  metadata.gz: ed68e9abbe74e3abe5c910f24c6dc988365da107317836649c0f9aef22a7876e7b27c7ea7f18c77d07e436951bb092123f9432a1faa3189e4900b8f3fcb217fe
-  data.tar.gz: 313a4bd4034c8ea18d5e111fb22e7f4073d6f9dff7cf3f57ddabd980074ffd113afcfb9313d3d33db39f9fd81ba1be493dae0b2f972fc4197bdfa57c74dfe5af
+  metadata.gz: 59e8f7b5c39d6c156b322eecd4719ecb3e036e51484ba915c4642400c3ec3547b79f057a4717188ff67e7b8aee9f999f1d493552e88cbb344ff2fe9e521ca087
+  data.tar.gz: 560fe1f61b66cce12912073349b33b1ad73c656ad47780be3c713deb735d3d71a1d2bdb896c419447a7a84ad73360bfc080b56bb69113c2874641826c8519fa3

data/README.md

@@ -15,25 +15,6 @@ directly to SVG elements.
 
 ---
 
-## Table of Contents
-
-* [Install](#install)
-* [Examples](#examples)
-* [Usage](#usage)
-* [Features](#features)
-  * [Composite SVG](#composite-svg)
-  * [Saving the Output](#saving-the-output)
-  * [SVG Templates](#svg-templates)
-  * [CSS](#css)
-  * [Tagless Elements](#tagless-elements)
-  * [XML Encoding](#xml-encoding)
-  * [DSL Syntax](#dsl-syntax)
-* [Using with Rails](#using-with-rails)
-* [Related Projects](#related-projects)
-* [Contributing / Support](#contributing--support)
-
----
-
 ## Install
 
 ```
@@ -266,18 +247,13 @@ svg.save 'filename'
 
 ### SVG Templates
 
-The `:default` SVG template is designed to be a full XML document (i.e., 
-a standalone SVG image). If you wish to use the output as an SVG element 
-inside HTML, you can change the SVG template:
-
-```ruby
-svg = Victor::SVG.new template: :html 
-# accepts :html, :minimal, :default or a filename
-```
+Victor renders its content using the [`:default` template][default-template].
 
-You can also point it to any other template file:
+If you wish to use another template, you can either use one of the built-in
+templates (`:default` or `:minimal`), or provide your own:
 
 ```ruby
+svg = Victor::SVG.new template: :minimal
 svg = Victor::SVG.new template: 'path/to/template.svg'
 ```
 
@@ -294,12 +270,10 @@ svg.render template: :minimal
 
 ### CSS
 
-CSS gets a special treatment in `Victor::SVG`, with these objectives in mind:
-
-- Hide implementation details (such as the need for a `CDATA` marker)
-- Provide a DSL-like syntax for CSS rules
+CSS gets a special treatment in `Victor::SVG`, in order to provide a DSL-like
+syntax for CSS rules.
 
-The `Victor::SVG` objects has a `css` property, which can contain either a 
+The `Victor::SVG` object has a `css` property, which can contain either a 
 Hash or a String:
 
 ```ruby
@@ -431,6 +405,24 @@ end
 
 See the [xml encoding example](https://github.com/DannyBen/victor/tree/master/examples#18-xml-encoding).
 
+
+### XML Newlines
+
+By default, the generated SVGs will have a newline glue between the elements.
+You can change this (for example, to an empty string) if the default newlines
+are not appropriate for your use case.
+
+```ruby
+svg = Victor::SVG.new glue: ''
+```
+
+The glue can also be provided when rendering or saving the output:
+
+```ruby
+svg.save 'filename', glue: ''
+svg.render glue: ''
+```
+
 ### DSL Syntax
 
 Victor also supports a DSL-like syntax. To use it, simply `require 'victor/script'`.
@@ -457,11 +449,6 @@ save 'output.svg'
 
 See the [dsl example](https://github.com/DannyBen/victor/tree/master/examples#19-dsl).
 
-## Using with Rails
-
-See the [example_rails](example_rails) folder.
-
-
 ## Related Projects
 
 ### [Victor CLI][victor-cli]
@@ -497,6 +484,7 @@ to contribute, feel free to [open an issue][issues].
 
 [examples]: https://github.com/DannyBen/victor/tree/master/examples#examples
 [templates]: https://github.com/DannyBen/victor/tree/master/lib/victor/templates
+[default-template]: https://github.com/DannyBen/victor/blob/master/lib/victor/templates/default.svg?short_path=c28efa4
 [icodi]: https://github.com/DannyBen/icodi
 [minichart]: https://github.com/DannyBen/minichart
 [victor-opal]: https://kuboon.github.io/victor-opal/

data/lib/victor/attributes.rb

@@ -1,11 +1,10 @@
 module Victor
-
   # Handles conversion from a Hash of attributes, to an XML string or
   # a CSS string.
   class Attributes
     attr_reader :attributes
 
-    def initialize(attributes={})
+    def initialize(attributes = {})
       @attributes = attributes
     end
 
@@ -13,10 +12,11 @@ module Victor
       mapped = attributes.map do |key, value|
         key = key.to_s.tr '_', '-'
 
-        if value.is_a? Hash
+        case value
+        when Hash
           style = Attributes.new(value).to_style
           "#{key}=\"#{style}\""
-        elsif value.is_a? Array
+        when Array
           "#{key}=\"#{value.join ' '}\""
         else
           "#{key}=#{value.to_s.encode(xml: :attr)}"
@@ -42,7 +42,5 @@ module Victor
     def []=(key, value)
       attributes[key] = value
     end
-
   end
-
-end
+end

data/lib/victor/css.rb

@@ -1,5 +1,4 @@
 module Victor
-
   class CSS
     attr_reader :attributes
 
@@ -13,12 +12,13 @@ module Victor
 
     def render
       return '' if attributes.empty?
-      %Q{<style type="text/css">\n<![CDATA[\n#{self}\n]]>\n</style>\n}
+
+      %[<style>\n#{self}\n</style>\n]
     end
 
   protected
 
-    def convert_hash(hash, indent=2)
+    def convert_hash(hash, indent = 2)
       return hash unless hash.is_a? Hash
 
       result = []
@@ -33,13 +33,14 @@ module Victor
     def css_block(key, value, indent)
       result = []
 
-      my_indent = " " * indent
+      my_indent = ' ' * indent
 
-      if value.is_a? Hash
+      case value
+      when Hash
         result.push "#{my_indent}#{key} {"
-        result.push convert_hash(value, indent+2)
+        result.push convert_hash(value, indent + 2)
         result.push "#{my_indent}}"
-      elsif value.is_a? Array
+      when Array
         value.each do |row|
           result.push "#{my_indent}#{key} #{row};"
         end
@@ -50,5 +51,4 @@ module Victor
       result
     end
   end
-
-end
+end

data/lib/victor/marshaling.rb

@@ -0,0 +1,39 @@
+module Victor
+  module Marshaling
+    # YAML serialization methods
+    def encode_with(coder)
+      coder['template'] = @template
+      coder['glue'] = @glue
+      coder['svg_attributes'] = @svg_attributes
+      coder['css'] = @css
+      coder['content'] = @content
+    end
+
+    def init_with(coder)
+      @template = coder['template']
+      @glue = coder['glue']
+      @svg_attributes = coder['svg_attributes']
+      @css = coder['css']
+      @content = coder['content']
+    end
+
+    # Marshal serialization methods
+    def marshal_dump
+      {
+        template:       @template,
+        glue:           @glue,
+        svg_attributes: @svg_attributes,
+        css:            @css,
+        content:        @content,
+      }
+    end
+
+    def marshal_load(data)
+      @template = data[:template]
+      @glue = data[:glue]
+      @svg_attributes = data[:svg_attributes]
+      @css = data[:css]
+      @content = data[:content]
+    end
+  end
+end

data/lib/victor/svg.rb

@@ -1,7 +1,11 @@
 module Victor
   class SVG < SVGBase
-    def method_missing(method_sym, *arguments, &block)
-      element method_sym, *arguments, &block
+    def method_missing(method_sym, ...)
+      element(method_sym, ...)
+    end
+
+    def respond_to_missing?(*)
+      true
     end
   end
-end
+end

data/lib/victor/svg_base.rb

@@ -1,13 +1,15 @@
 module Victor
-
   class SVGBase
-    attr_accessor :template
+    include Marshaling
+
+    attr_accessor :template, :glue
     attr_reader :content, :svg_attributes
+    attr_writer :css
 
     def initialize(attributes = nil, &block)
       setup attributes
       @content = []
-      build &block if block_given?
+      build(&block) if block
     end
 
     def <<(additional_content)
@@ -17,23 +19,23 @@ module Victor
 
     def setup(attributes = nil)
       attributes ||= {}
-      attributes[:width] ||= "100%"
-      attributes[:height] ||= "100%"
+      attributes[:width] ||= '100%'
+      attributes[:height] ||= '100%'
 
-      if attributes[:template]
-        @template = attributes.delete :template
-      elsif !@template
-        @template = :default
-      end
+      @template = attributes[:template] || @template || :default
+      @glue = attributes[:glue] || @glue || "\n"
+
+      attributes.delete :template
+      attributes.delete :glue
 
       @svg_attributes = Attributes.new attributes
     end
 
     def build(&block)
-      self.instance_eval(&block)
+      instance_eval(&block)
     end
 
-    def element(name, value=nil, attributes={}, &_block)
+    def element(name, value = nil, attributes = {})
       if value.is_a? Hash
         attributes = value
         value = nil
@@ -50,14 +52,14 @@ module Victor
       empty_tag = name.to_s == '_'
 
       if block_given? || value
-        content.push "<#{name} #{attributes}".strip + ">" unless empty_tag
+        content.push "#{"<#{name} #{attributes}".strip}>" unless empty_tag
         if value
           content.push(escape ? value.to_s.encode(xml: :text) : value)
         else
           yield
         end
         content.push "</#{name}>" unless empty_tag
-      else      
+      else
         content.push "<#{name} #{attributes}/>"
       end
     end
@@ -68,29 +70,26 @@ module Victor
       @css
     end
 
-    def css=(defs)
-      @css = defs
-    end
-
-    def render(template: nil)
+    def render(template: nil, glue: nil)
       @template = template if template
+      @glue = glue if glue
       css_handler = CSS.new css
 
       svg_template % {
-        css: css_handler,
-        style: css_handler.render,
+        css:        css_handler,
+        style:      css_handler.render,
         attributes: svg_attributes,
-        content: content.join("\n")
+        content:    to_s,
       }
     end
 
     def to_s
-      content.join "\n"
+      content.join glue
     end
 
-    def save(filename, template: nil)
-      filename = "#{filename}.svg" unless filename =~ /\..{2,4}$/
-      File.write filename, render(template: template)
+    def save(filename, template: nil, glue: nil)
+      filename = "#{filename}.svg" unless /\..{2,4}$/.match?(filename)
+      File.write filename, render(template: template, glue: glue)
     end
 
   protected
@@ -107,5 +106,4 @@ module Victor
       end
     end
   end
-
-end
+end

data/lib/victor/templates/default.svg

@@ -1,6 +1,3 @@
-<?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">
-
 <svg %{attributes} 
   xmlns="http://www.w3.org/2000/svg"
   xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -8,4 +5,4 @@
 %{style}
 %{content}
 
-</svg>
+</svg>

data/lib/victor/templates/minimal.svg

@@ -1,4 +1,4 @@
 <svg %{attributes}>
 %{style}
 %{content}
-</svg>
+</svg>

data/lib/victor/version.rb

@@ -1,3 +1,3 @@
 module Victor
-  VERSION = "0.3.3"
-end
+  VERSION = '0.4.0'
+end

data/lib/victor.rb

@@ -1,8 +1,7 @@
 require 'victor/version'
+require 'victor/marshaling'
 require 'victor/svg_base'
 require 'victor/svg'
 require 'victor/attributes'
 require 'victor/css'
 require 'victor/dsl'
-
-require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2024-08-25 00:00:00.000000000 Z
 dependencies: []
 description: Build SVG images with ease
 email: db@dannyben.com
@@ -21,18 +21,22 @@ files:
 - lib/victor/attributes.rb
 - lib/victor/css.rb
 - lib/victor/dsl.rb
+- lib/victor/marshaling.rb
 - lib/victor/script.rb
 - lib/victor/svg.rb
 - lib/victor/svg_base.rb
 - lib/victor/templates/default.svg
-- lib/victor/templates/html.svg
 - lib/victor/templates/minimal.svg
 - lib/victor/version.rb
 homepage: https://github.com/DannyBen/victor
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/victor/issues
+  changelog_uri: https://github.com/DannyBen/victor/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/victor
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -40,15 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: SVG Builder
 test_files: []

data/lib/victor/templates/html.svg

@@ -1,8 +0,0 @@
-<svg %{attributes}
-  xmlns="http://www.w3.org/2000/svg"
-  xmlns:xlink="http://www.w3.org/1999/xlink">
-
-%{style}
-%{content}
-
-</svg>