victor 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2d91fe91857b10d35b9762dcbec3ee26ac3028c5522b7bdb33f73570a53422
-  data.tar.gz: b1fce99903fcf5cc4d1b024b48d8382046e4426c57bb7a621265abb3db187008
+  metadata.gz: 4f308143350a9236bbdf1c046de94a94728ecd90051004482e78cf9734484ef6
+  data.tar.gz: 36b35af10ea11a1bc39063384c6a23e247c257d0364edb24b5914cfd73029a88
 SHA512:
-  metadata.gz: 25eac4f567fa4b492bc9bded59d2194f2ac4c89283f71b748db2c8ccc3245793cdea7535131058282dace0fd366aa15f4e676414c2a2c823ea37d9f7777b01e4
-  data.tar.gz: 694d7f6ff8b2264aec64d3d2955751b9b375a0e25cc4b1aa35c6328de97ee6ce6996ff8744bc86bb5b50cb9ed712644c25431f2a7213b68a8ba05e5b1fdb9802
+  metadata.gz: 353fd957d007ad7dd020f84a8866634a799e39ae94ba2ea65edf4eb09b6e8a354aa09961492a6cac0a530bcee5e904738df13bffc68c3b00f983348844adc074
+  data.tar.gz: 3993f70f671cb4097e83279bc4b5b68d510aa74a40ae320960d56b4a6b1aa537270893975c473cbf66a263496cea39398cd742b217af6b327b595edef84ea36b

data/README.md

@@ -1,4 +1,4 @@
-![Victor](/examples//15_victor_logo.svg)
+![Victor](/examples/16_victor_logo.svg)
 
 # Victor - Ruby SVG Image Builder
 
@@ -27,6 +27,7 @@ directly to SVG elements.
   * [CSS](#css)
   * [Tagless Elements](#tagless-elements)
   * [XML Encoding](#xml-encoding)
+  * [XML Newlines](#xml-newlines)
   * [DSL Syntax](#dsl-syntax)
 * [Using with Rails](#using-with-rails)
 * [Related Projects](#related-projects)
@@ -71,7 +72,7 @@ svg.save 'pacman'
 
 Output:
 
-[![pacman](https://cdn.rawgit.com/DannyBen/victor/master/examples/09_pacman.svg)](https://github.com/DannyBen/victor/blob/master/examples/09_pacman.rb)
+[![pacman](https://cdn.rawgit.com/DannyBen/victor/master/examples/10_pacman.svg)](https://github.com/DannyBen/victor/blob/master/examples/10_pacman.rb)
 
 
 See the [examples] folder for several ruby scripts and their SVG output.
@@ -148,7 +149,7 @@ space delimited string:
 
 ```ruby
 svg.path d: ['M', 150, 0, 'L', 75, 200, 'L', 225, 200, 'Z']
-# => <path d="M 159 9 L 75 200 L 225 200 Z"/>
+# => <path d="M 150 0 L 75 200 L 225 200 Z"/>
 ```
 
 For SVG elements that have an inner content - such as text - simply pass it as 
@@ -185,7 +186,7 @@ svg.text "Victor", x: 40, y: 50, font_family: 'arial', font_weight: 'bold', font
 
 ### Composite SVG
 
-Victor also supports the abiliy to combine several smaller SVG objects into 
+Victor also supports the ability to combine several smaller SVG objects into
 one using the `<<` operator or the `#append` method. 
 
 This operator expects to receive any object that responds to `#to_s` (can be another `SVG` object).
@@ -215,7 +216,7 @@ svg.save 'framed-troll'
 
 Output:
 
-[![troll](https://cdn.rawgit.com/DannyBen/victor/master/examples/13_composite_svg.svg)](https://cdn.rawgit.com/DannyBen/victor/master/examples/13_composite_svg.svg)
+[![troll](https://cdn.rawgit.com/DannyBen/victor/master/examples/14_composite_svg.svg)](https://cdn.rawgit.com/DannyBen/victor/master/examples/14_composite_svg.svg)
 
 These two calls are identical:
 
@@ -244,8 +245,8 @@ end
 Another approach to a more modular SVG composition, would be to subclass 
 `Victor::SVG`.
 
-See the [composite svg example](https://github.com/DannyBen/victor/tree/master/examples#13-composite-svg)
-or the [subclassing example](https://github.com/DannyBen/victor/tree/master/examples#14-subclassing)
+See the [composite svg example](https://github.com/DannyBen/victor/tree/master/examples#14-composite-svg)
+or the [subclassing example](https://github.com/DannyBen/victor/tree/master/examples#15-subclassing)
 for more details.
 
 
@@ -284,11 +285,40 @@ svg = Victor::SVG.new template: 'path/to/template.svg'
 See the [templates] folder for an understanding of how templates are 
 structured.
 
+Templates can also be provided when rendering or saving the output:
+
+```ruby
+svg.save 'filename', template: :minimal
+svg.render template: :minimal
+```
+
 
 ### CSS
 
-To add a CSS to your SVG, simply use the `css` command inside your `build` 
-block, like this:
+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
+
+The `Victor::SVG` objects has a `css` property, which can contain either a 
+Hash or a String:
+
+```ruby
+svg = Victor::SVG.new
+
+svg.css = css_hash_or_string
+# or without the equal sign:
+svg.css css_hash_or_string
+
+svg.build do
+  # ...
+end
+```
+
+This flexibility allows you to apply CSS in multiple ways. Below are some
+examples.
+
+#### Assigning CSS rules using the hash syntax
 
 ```ruby
 svg = Victor::SVG.new
@@ -304,7 +334,7 @@ svg.build do
 end
 ```
 
-You can also set CSS by providing a hash:
+#### Assigning a full hash to the CSS property
 
 ```ruby
 svg.css = {
@@ -325,6 +355,13 @@ svg.css = {
 Underscore characters will be converted to dashes (`stroke_width` becomes 
 `stroke-width`).
 
+#### Importing CSS from an external file
+
+```ruby
+svg.css = File.read 'styles.css'
+```
+
+#### CSS `@import` directives
 
 If you need to add CSS statements , like `@import`, use the following syntax:
 
@@ -335,11 +372,13 @@ css['@import'] = [
 ]
 ```
 
-When the value of the CSS attribute is an array, Victor will simply use
-the values of the array and prefix each of them with the key, so the above 
-will result in two `@import url(...)` rows.
+This is achieved thanks to the fact that when Victor encounters an array
+in the CSS hash, it will prefix each of the array elements with the hash
+key, so the above will result in two `@import url(...)` rows.
 
-See the [custom fonts example](https://github.com/DannyBen/victor/tree/master/examples#12-custom-fonts).
+See the [css example](https://github.com/DannyBen/victor/tree/master/examples#08-css),
+[css string example](https://github.com/DannyBen/victor/tree/master/examples#09-css-string),
+or the [custom fonts example](https://github.com/DannyBen/victor/tree/master/examples#13-custom-fonts).
 
 
 ### Tagless Elements
@@ -368,7 +407,7 @@ svg.build do
 end
 ```
 
-See the [targless elements example](https://github.com/DannyBen/victor/tree/master/examples#16-tagless-elements).
+See the [tagless elements example](https://github.com/DannyBen/victor/tree/master/examples#17-tagless-elements).
 
 
 ### XML Encoding
@@ -391,7 +430,25 @@ end
 # <text>Ben & Jerry's</text>
 ```
 
-See the [xml encoding example](https://github.com/DannyBen/victor/tree/master/examples#17-xml-encoding).
+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
 
@@ -417,7 +474,7 @@ puts render
 save 'output.svg'
 ```
 
-See the [dsl example](https://github.com/DannyBen/victor/tree/master/examples#18-dsl).
+See the [dsl example](https://github.com/DannyBen/victor/tree/master/examples#19-dsl).
 
 ## Using with Rails
 
@@ -435,6 +492,13 @@ Victor Ruby scripts.
 
 A Victor playground that works in the browser.
 
+### [Minichart][minichart]
+
+A Ruby gem that uses Victor to generate SVG charts
+
+[![Minichart](assets/minichart.svg)][minichart]
+
+
 ### [Icodi][icodi]
 
 A Ruby gem that uses Victor to generate consistent random icon 
@@ -453,6 +517,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
 [icodi]: https://github.com/DannyBen/icodi
+[minichart]: https://github.com/DannyBen/minichart
 [victor-opal]: https://kuboon.github.io/victor-opal/
 [victor-cli]:  https://github.com/DannyBen/victor-cli
 [issues]: https://github.com/DannyBen/victor/issues

data/lib/victor/dsl.rb

@@ -3,7 +3,7 @@ require 'forwardable'
 module Victor
   module DSL
     extend Forwardable
-    def_delegators :svg, :setup, :build, :save, :render, :append, :element
+    def_delegators :svg, :setup, :build, :save, :render, :append, :element, :css
 
     def svg
       @svg ||= Victor::SVG.new

data/lib/victor/svg_base.rb

@@ -1,13 +1,12 @@
 module Victor
 
   class SVGBase
-    attr_accessor :template, :css
+    attr_accessor :template, :glue
     attr_reader :content, :svg_attributes
 
     def initialize(attributes = nil, &block)
       setup attributes
       @content = []
-      @css = {}
       build &block if block_given?
     end
 
@@ -21,11 +20,11 @@ module Victor
       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
@@ -63,24 +62,36 @@ module Victor
       end
     end
 
-    def render
-      css_string = CSS.new css
+    def css(defs = nil)
+      @css ||= {}
+      @css = defs if defs
+      @css
+    end
+
+    def css=(defs)
+      @css = defs
+    end
+
+    def render(template: nil, glue: nil)
+      @template = template if template
+      @glue = glue if glue
+      css_handler = CSS.new css
 
       svg_template % {
-        css: css_string,
-        style: css_string.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)
+    def save(filename, template: nil, glue: nil)
       filename = "#{filename}.svg" unless filename =~ /\..{2,4}$/
-      File.write filename, render
+      File.write filename, render(template: template, glue: glue)
     end
 
   protected

data/lib/victor/version.rb

@@ -1,3 +1,3 @@
 module Victor
-  VERSION = "0.3.1"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies: []
 description: Build SVG images with ease
 email: db@dannyben.com
@@ -40,14 +40,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: SVG Builder