victor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6169e5a528a272be07b50c054454828a59877a57
-  data.tar.gz: 5f51076c9346ca40dfd470a9be139d0a588d2fcd
+  metadata.gz: 54f32fa0b60b2a0c70bb9a6d52ad88757d6e4701
+  data.tar.gz: 3c1b19ee5f21bf29966f10ffefc9a13344490956
 SHA512:
-  metadata.gz: e0511f7103e0046dc0620776cc21e422321a7f5f996c59131c42df071db9d5c56c121bfefaffb4efc683c4662424f5255dab73b6888a9eaaf0968e8d6080cb75
-  data.tar.gz: ca6e5eca44dce8b644df23a6107822157644235662a1ed4f13695b9abf1ca6c52f3e000551f7ab8e65d9588fe00d9f9d4757c7d35613b39b6fb9223b4730b10a
+  metadata.gz: f2ae86c7705f26d3f1945eae9c263b94aae563de16b4e597f41a9e5a055e27784cfa0806599a68d5778f514cc9d087277ad5db774116b86e98b1b3a5a89c4792
+  data.tar.gz: ed055f13b4aeff0a56db603e067704555eca6f6f1a29f9440571d42cd56f0667bba0c43294edc4876388de3d9a0c5990d31665a635131c2fc285ee2e635fafdf

data/README.md

@@ -8,7 +8,7 @@ Victor - Ruby SVG Image Builder
 
 ---
 
-Victor is a direct Ruby to SVG builder. All method calls are converted
+Victor is a direct Ruby-to-SVG builder. All method calls are converted
 directly to SVG elements.
 
 ---
@@ -29,18 +29,32 @@ gem 'victor'
 Examples
 --------------------------------------------------
 
-See the examples folder for several ruby scripts and their SVG output.
+See the [examples] folder for several ruby scripts and their SVG output.
 
 
 Usage
 --------------------------------------------------
 
-Victor uses a single method (`element`) to generate all SVG elements:
+Initialize your SVG image:
 
 ```ruby
 require 'victor'
 svg = SVG.new
+```
+
+Any option you provide to `SVG.new` will be added as an attribute to the
+main `<svg>` element. By default, `height` and `width` are set to 100%.
+
+```ruby
+svg = SVG.new width: '100%', height: '100%'
+# same as just SVG.new
+
+svg = SVG.new width: '100%', height: '100%', viewBox: "0 0 200 100"
+```
 
+Victor uses a single method (`element`) to generate all SVG elements:
+
+```ruby
 svg.element :rect, x: 2, y: 2, width: 200, height: 200
 # => <rect x="2" y="2" width="200" height="200"/>
 ```
@@ -49,7 +63,6 @@ But you can omit it. Calls to any other method, will be delegated to the
 `element` method, so normal usage looks more like this:
 
 ```ruby
-# this will generate the exact same result
 svg.rect x: 2, y: 2, width: 200, height: 200
 # => <rect x="2" y="2" width="200" height="200"/>
 ```
@@ -58,12 +71,40 @@ You can use the `build` method, to generate the SVG with a block
 
 ```ruby
 svg.build do 
-  rect x: 0, y: 0, width: 100, height: 100, style: { fill: '#ccc' }
-  rect x: 20, y: 20, width: 60, height: 60, style: { fill: '#f99' }
+  rect x: 0, y: 0, width: 100, height: 100, fill: '#ccc'
+  rect x: 20, y: 20, width: 60, height: 60, fill: '#f99'
 end
 ```
 
-Generate the SVG to a string with `render`:
+If the value of an attribute is a hash, it will be converted to a 
+style-compatible string:
+
+```ruby
+svg.rect x: 0, y: 0, width: 100, height: 100, style: { stroke: '#ccc', fill: 'red' }
+# => <rect x=0 y=0 width=100 height=100 style="stroke:#ccc; fill:red"/>
+```
+
+For SVG elements that have an inner content - such as text - simply pass it as 
+the first argument:
+
+```ruby
+svg.text "Victor", x: 40, y: 50
+# => <text x="40" y="50">Victor</text>
+```
+
+Underscores in attribute names are converted to dashes:
+
+```ruby
+svg.text "Victor", x: 40, y: 50, font_family: 'arial', font_weight: 'bold', font_size: 40
+# => <text x="40" y="50" font-family="arial" font-weight="bold" font-size="40">
+#      Victor
+#    </text>
+```
+
+Saving the Output
+--------------------------------------------------
+
+Generate the full SVG to a string with `render`:
 
 ```ruby
 result = svg.render
@@ -72,5 +113,11 @@ result = svg.render
 Or, save it to a file with `save`:
 
 ```ruby
-svg.save 'filename' # the '.svg' extension is optional
+svg.save 'filename'
+# the '.svg' extension is optional
 ```
+
+
+---
+
+[examples]: https://github.com/DannyBen/victor/tree/master/examples#examples

data/lib/victor/svg.rb

@@ -3,32 +3,43 @@
 module Victor
 
   class SVG
-    attr_accessor :height, :width
+    attr_accessor :attributes
     attr_reader :content
 
-    def initialize(opts={})
-      @height = opts[:height] || "100%"
-      @width  = opts[:width] || "100%"
+    def initialize(attributes={})
+      @attributes = attributes
+      attributes[:width] ||= "100%"
+      attributes[:height] ||= "100%"
       @content = []
     end
 
     def method_missing(method_sym, *arguments, &block)
-      element method_sym, *arguments
+      element method_sym, *arguments, &block
     end
 
     def build(&block)
-      self.instance_eval &block
+      self.instance_eval(&block)
     end
 
-    def element(name, attributes={}, &block)
+    def element(name, value=nil, attributes={}, &_block)
+      if value.is_a? Hash
+        attributes = value
+        value = nil
+      end
+
       xml_attributes = expand attributes
-      elem = "<#{name} #{xml_attributes}/>"
-      content.push elem
-      elem
+
+      if block_given? || value
+        content.push "<#{name} #{xml_attributes}".strip + ">"
+        value ? content.push(value) : yield
+        content.push "</#{name}>"
+      else
+        content.push "<#{name} #{xml_attributes}/>"
+      end
     end
 
     def render
-      template % { height: height, width: width, content: content.join("\n") }
+      template % { attributes: expand(attributes), content: content.join("\n") }
     end
 
     def save(filename)
@@ -40,18 +51,19 @@ module Victor
 
     def expand(attributes={})
       mapped = attributes.map do |key, value|
+        key = key.to_s.tr '_', '-'
         value.is_a?(Hash) ? inner_expand(key, value) : "#{key}=\"#{value}\""
       end
 
       mapped.join ' '
     end
 
-    def inner_expand(key, attributes)
+    def inner_expand(name, attributes)
       mapped = attributes.map do |key, value|
         "#{key}:#{value}"
       end
 
-      "#{key}=\"#{mapped.join '; '}\""
+      "#{name}=\"#{mapped.join '; '}\""
     end
 
     def template
@@ -59,11 +71,11 @@ module Victor
     end
 
     def template_path
-      File.join File.dirname(__FILE__), template_file
+      File.join File.dirname(__FILE__), 'templates', template_file
     end
 
     def template_file
-      'template.svg'
+      'default.svg'
     end
   end
 

data/lib/victor/{template.svg → templates/default.svg}

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

data/lib/victor/version.rb

@@ -1,3 +1,3 @@
 module Victor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -89,7 +89,7 @@ files:
 - README.md
 - lib/victor.rb
 - lib/victor/svg.rb
-- lib/victor/template.svg
+- lib/victor/templates/default.svg
 - lib/victor/version.rb
 homepage: https://github.com/DannyBen/victor
 licenses: