victor 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f32fa0b60b2a0c70bb9a6d52ad88757d6e4701
-  data.tar.gz: 3c1b19ee5f21bf29966f10ffefc9a13344490956
+  metadata.gz: 6e578183630315066cfac8073fe7a95df4b200a2
+  data.tar.gz: 12cd33f3ad1dbbf877f7fd84c56bc26c05c15024
 SHA512:
-  metadata.gz: f2ae86c7705f26d3f1945eae9c263b94aae563de16b4e597f41a9e5a055e27784cfa0806599a68d5778f514cc9d087277ad5db774116b86e98b1b3a5a89c4792
-  data.tar.gz: ed055f13b4aeff0a56db603e067704555eca6f6f1a29f9440571d42cd56f0667bba0c43294edc4876388de3d9a0c5990d31665a635131c2fc285ee2e635fafdf
+  metadata.gz: 16ff14fb0e35c9d866d3ceb69750aa2220cfc4c3ceb28760c44da377003b8e8ba8667818582a375a2a7c8dbff08527e0db0e71d8f38d39e43b596a6b57e3c535
+  data.tar.gz: 96f4949a8103de5e5f535530b43e033fc8cc29088bc7f967baa8e4e15c45ac1a2a17396122280ebf4e59f3c0ae0c3e3ed9449195bdbc57d37ef0f247418322c9

data/README.md

@@ -84,6 +84,15 @@ svg.rect x: 0, y: 0, width: 100, height: 100, style: { stroke: '#ccc', fill: 're
 # => <rect x=0 y=0 width=100 height=100 style="stroke:#ccc; fill:red"/>
 ```
 
+If the value of an attribute is an array, it will be converted to a 
+space delimited string:
+
+```ruby
+svg.path ['M', 150, 0, 'L', 75, 200, 'L', 225, 200, 'Z']
+# => <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:
 
@@ -117,7 +126,52 @@ svg.save 'filename'
 # the '.svg' extension is optional
 ```
 
+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 = SVG.new template: :html 
+# accepts :html, :default or a filename
+```
+
+You can also point it to any other template file:
+
+```ruby
+svg = SVG.new template: 'path/to/template.svg'
+```
+
+See the [templates] folder for an understanding of how templates are 
+structured.
+
+
+CSS
+--------------------------------------------------
+
+To add a CSS to your SVG, simply use the `css` command inside your `build` 
+block, like this:
+
+```ruby
+svg = SVG.new
+
+svg.build do 
+  css['.main'] = {
+    stroke: "green", 
+    stroke_width: 2,
+    fill: "yellow"
+  }
+
+  circle cx: 35, cy: 35, r: 20, class: 'main'
+end
+```
+
+Underscore characters will be converted to dashes (`stroke_width` becomes 
+`stroke-width`).
 
 ---
 
 [examples]: https://github.com/DannyBen/victor/tree/master/examples#examples
+[templates]: https://github.com/DannyBen/victor/tree/master/lib/victor/templates

data/lib/victor.rb

@@ -1,4 +1,6 @@
 require 'victor/version'
 require 'victor/svg'
+require 'victor/attributes'
+require 'victor/css'
 
 include Victor

data/lib/victor/attributes.rb

@@ -0,0 +1,47 @@
+
+
+module Victor
+
+  class Attributes
+    attr_reader :attributes
+
+    def initialize(attributes={})
+      @attributes = attributes        
+    end
+
+    def to_s
+      mapped = attributes.map do |key, value|
+        key = key.to_s.tr '_', '-'
+        
+        if value.is_a? Hash
+          style = Attributes.new(value).to_style
+          "#{key}=\"#{style}\"" 
+        elsif value.is_a? Array
+          "#{key}=\"#{value.join ' '}\"" 
+        else
+          "#{key}=\"#{value}\""
+        end
+      end
+
+      mapped.join ' '
+    end
+
+    def to_style
+      mapped = attributes.map do |key, value|
+        "#{key}:#{value}"
+      end
+
+      mapped.join '; '
+    end
+
+    def [](key)
+      attributes[key]
+    end
+
+    def []=(key, value)
+      attributes[key] = value
+    end
+
+  end
+
+end

data/lib/victor/css.rb

@@ -0,0 +1,27 @@
+
+
+module Victor
+
+  class CSS
+    attr_reader :attributes
+
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    def to_s
+      result = []
+      attributes.each do |selector, styles|
+        result.push "  #{selector} {"
+        styles.each do |key, value|
+          key = key.to_s.tr '_', '-'
+          result.push "    #{key}: #{value};"
+        end
+        result.push "  }"
+      end
+
+      result.join "\n"
+    end
+  end
+
+end

data/lib/victor/svg.rb

@@ -3,14 +3,16 @@
 module Victor
 
   class SVG
-    attr_accessor :attributes
-    attr_reader :content
+    attr_accessor :template, :css
+    attr_reader :content, :svg_attributes
 
     def initialize(attributes={})
-      @attributes = attributes
-      attributes[:width] ||= "100%"
-      attributes[:height] ||= "100%"
+      @template = attributes.delete(:template) || :default
+      @svg_attributes = Attributes.new attributes
+      svg_attributes[:width] ||= "100%"
+      svg_attributes[:height] ||= "100%"
       @content = []
+      @css = {}
     end
 
     def method_missing(method_sym, *arguments, &block)
@@ -27,19 +29,23 @@ module Victor
         value = nil
       end
 
-      xml_attributes = expand attributes
+      attributes = Attributes.new attributes
 
       if block_given? || value
-        content.push "<#{name} #{xml_attributes}".strip + ">"
+        content.push "<#{name} #{attributes}".strip + ">"
         value ? content.push(value) : yield
         content.push "</#{name}>"
       else
-        content.push "<#{name} #{xml_attributes}/>"
+        content.push "<#{name} #{attributes}/>"
       end
     end
 
     def render
-      template % { attributes: expand(attributes), content: content.join("\n") }
+      svg_template % { 
+        css: CSS.new(css),
+        attributes: svg_attributes, 
+        content: content.join("\n") 
+      }
     end
 
     def save(filename)
@@ -49,33 +55,16 @@ module Victor
 
     private
 
-    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(name, attributes)
-      mapped = attributes.map do |key, value|
-        "#{key}:#{value}"
-      end
-
-      "#{name}=\"#{mapped.join '; '}\""
-    end
-
-    def template
+    def svg_template
       File.read template_path
     end
 
     def template_path
-      File.join File.dirname(__FILE__), 'templates', template_file
-    end
-
-    def template_file
-      'default.svg'
+      if template.is_a? Symbol
+        File.join File.dirname(__FILE__), 'templates', "#{template}.svg"
+      else
+        template
+      end
     end
   end
 

data/lib/victor/templates/default.svg

@@ -2,5 +2,13 @@
 <!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">
+
+<style type="text/css">
+<![CDATA[
+%{css}
+]]>
+</style>
+
 %{content}
+
 </svg>

data/lib/victor/templates/html.svg

@@ -0,0 +1,10 @@
+<svg %{attributes}>
+
+<style type="text/css" scoped>
+<![CDATA[
+%{css}
+]]>
+</style>
+
+%{content}
+</svg>

data/lib/victor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -88,8 +88,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/victor.rb
+- lib/victor/attributes.rb
+- lib/victor/css.rb
 - lib/victor/svg.rb
 - lib/victor/templates/default.svg
+- lib/victor/templates/html.svg
 - lib/victor/version.rb
 homepage: https://github.com/DannyBen/victor
 licenses: