victor 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6540ebf1d8dba779d9da76d9755fb2fc65e6eb7f9119c0cc904fc3ad5d2f9cf
-  data.tar.gz: 332cb3428d65f3095f580229ed6ce5180de3b57fd41bc79d23c45f5ed72c7abd
+  metadata.gz: f4fb744c40ffdf04d89198bbe192150e73fc6776f2fc92f26bfd246c1f107c98
+  data.tar.gz: 1360dae8be0520d6357ec7300c19cb7a7769cc656081fa1f66dd5bfdbe2895b0
 SHA512:
-  metadata.gz: 5cf0bc30d5201b6f2d2ec271b67d9e8ebf5ae18b4f3bba9324a655b22b3f20f19d259188a174ae40cf2ef41674a2f4c1cbc35953e2ad499cf1122702138bda3f
-  data.tar.gz: 81811e7d304675e2f5585b4debe09867c8a771b131f9f228fad15b7785d0754191b72f44306ce9acbcf5a686d9bb7c56a653d02ef2349821b695bb41ce887888
+  metadata.gz: ed68e9abbe74e3abe5c910f24c6dc988365da107317836649c0f9aef22a7876e7b27c7ea7f18c77d07e436951bb092123f9432a1faa3189e4900b8f3fcb217fe
+  data.tar.gz: 313a4bd4034c8ea18d5e111fb22e7f4073d6f9dff7cf3f57ddabd980074ffd113afcfb9313d3d33db39f9fd81ba1be493dae0b2f972fc4197bdfa57c74dfe5af

data/README.md

@@ -1,4 +1,4 @@
-![Victor](/examples//15_victor_logo.svg)
+![Victor](/examples/16_victor_logo.svg)
 
 # Victor - Ruby SVG Image Builder
 
@@ -71,7 +71,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 +148,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 +185,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 +215,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 +244,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.
 
 
@@ -294,8 +294,30 @@ 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
@@ -311,7 +333,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 = {
@@ -332,6 +354,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:
 
@@ -342,11 +371,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
@@ -375,7 +406,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
@@ -398,7 +429,7 @@ 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).
 
 ### DSL Syntax
 
@@ -424,7 +455,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
 
@@ -442,6 +473,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 
@@ -460,6 +498,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
     attr_reader :content, :svg_attributes
 
     def initialize(attributes = nil, &block)
       setup attributes
       @content = []
-      @css = {}
       build &block if block_given?
     end
 
@@ -63,13 +62,23 @@ module Victor
       end
     end
 
+    def css(defs = nil)
+      @css ||= {}
+      @css = defs if defs
+      @css
+    end
+
+    def css=(defs)
+      @css = defs
+    end
+
     def render(template: nil)
       @template = template if template
-      css_string = CSS.new css
+      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")
       }

data/lib/victor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies: []
 description: Build SVG images with ease
 email: db@dannyben.com
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: SVG Builder