victor 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c9b02320dd3fe0061bf8d703b4a50b9c5ef1928
-  data.tar.gz: 6ab896856bff9033cb81b0593520c02fc508cd3c
+SHA256:
+  metadata.gz: 8084c65a136f58070a350341405ef047bc7b3dfd282fec474223598ee7889f12
+  data.tar.gz: 2112d671dadbe7c6e7f1f4a78adad9c6cd24512ba3bdddcd641574e2fd218ad4
 SHA512:
-  metadata.gz: bbb2d3dbb6567ccdf49e5aefe3719c44f2ebb347ada557b9ae3ef39a3621a8b6dfffbe533879b4d2556d44e28aad038905c940452b67f507e9f72ed134eb2cde
-  data.tar.gz: c611c5b2923a98c731c08371358cda94559fbea12e290dc38a2368d864ada2813e3b434df305f0bbd650f0ebfff54edd8f692bfcf16f14b1e4bc8794321ace9c
+  metadata.gz: 7c3dc90b9f50060eeb447d1bbe5d54badcf5fff046ee91cea74cc487e0c58f37420e208d1d41b307bc80c4b67a3719f490012417a2deef76d02ba71f144599ab
+  data.tar.gz: 6665e0d722a7c4ffb70497ea884cf83223a5327fe3e68b498b1ea086b0fd9145377f41f7584a62c351886a6e2dfd4c1e834b68cc0243e5af71c24fbca7037318

data/README.md

@@ -1,16 +1,32 @@
 Victor - Ruby SVG Image Builder
 ==================================================
 
-[![Gem](https://img.shields.io/gem/v/victor.svg?style=flat-square)](https://rubygems.org/gems/victor)
-[![Travis](https://img.shields.io/travis/DannyBen/victor.svg?style=flat-square)](https://travis-ci.org/DannyBen/victor)
-[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/victor.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/victor)
-[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/victor.svg?style=flat-square)](https://gemnasium.com/DannyBen/victor)
+[![Gem Version](https://badge.fury.io/rb/victor.svg)](https://badge.fury.io/rb/victor)
+[![Build Status](https://travis-ci.com/DannyBen/victor.svg?branch=master)](https://travis-ci.com/DannyBen/victor)
+[![Code Quality](https://api.codacy.com/project/badge/Grade/a502c262875643eabb01a43f7f5131ff)](https://www.codacy.com/app/db/victor?utm_source=github.com&utm_medium=referral&utm_content=DannyBen/victor&utm_campaign=Badge_Grade)
+[![Maintainability](https://api.codeclimate.com/v1/badges/85cc05c219d6d233ab78/maintainability)](https://codeclimate.com/github/DannyBen/victor/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/85cc05c219d6d233ab78/test_coverage)](https://codeclimate.com/github/DannyBen/victor/test_coverage)
 
 ---
 
 Victor is a direct Ruby-to-SVG builder. All method calls are converted
 directly to SVG elements.
 
+![Demo](/animated.gif)
+
+---
+
+Table of Contents
+--------------------------------------------------
+
+* [Install](#install)
+* [Examples](#examples)
+* [Usage](#usage)
+* [Composite SVG](#composite-svg)
+* [Saving the Output](#saving-the-output)
+* [SVG Templates](#svg-templates)
+* [CSS](#css)
+
 ---
 
 Install
@@ -155,6 +171,47 @@ svg.text "Victor", x: 40, y: 50, font_family: 'arial', font_weight: 'bold', font
 #    </text>
 ```
 
+Composite SVG
+--------------------------------------------------
+Victor also supports the abiliy to combine several smaller SVG objects into 
+one using the `<<` operator. This operator expects to receive any object
+that responds to `#to_s` (can be another `SVG` object).
+
+```ruby
+require 'victor'
+include Victor
+
+# Create a reusable SVG object
+frame = SVG.new
+frame.rect x: 0, y: 0, width: 100, height: 100, fill: '#336'
+frame.rect x: 10, y: 10, width: 80, height: 80, fill: '#fff'
+
+# ... and another
+troll = SVG.new
+troll.circle cx: 50, cy: 60, r: 24, fill: 'yellow'
+troll.polygon points: %w[24,50 50,14 76,54], fill: 'red'
+
+# Combine objects into a single image
+svg = SVG.new viewBox: '0 0 100 100'
+svg << frame
+svg << troll
+
+# ... and save it
+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)
+
+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)
+for more details.
+
+
 Saving the Output
 --------------------------------------------------
 
@@ -248,7 +305,7 @@ 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.
 
-See the [custom fonts example](https://github.com/DannyBen/victor/tree/master/examples#12-custom-fonts)
+See the [custom fonts example](https://github.com/DannyBen/victor/tree/master/examples#12-custom-fonts).
 
 
 ---

data/lib/victor/attributes.rb

@@ -1,48 +1,48 @@
-
-
-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 = key.to_s.tr '_', '-'
-        "#{key}:#{value}"
-      end
-
-      mapped.join '; '
-    end
-
-    def [](key)
-      attributes[key]
-    end
-
-    def []=(key, value)
-      attributes[key] = value
-    end
-
-  end
-
+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={})
+      @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 = key.to_s.tr '_', '-'
+        "#{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

@@ -1,39 +1,50 @@
-module Victor
-
-  class CSS
-    attr_reader :attributes
-
-    def initialize(attributes={})
-      @attributes = attributes
-    end
-
-    def to_s
-      convert_hash attributes
-    end
-
-    private 
-
-    def convert_hash(hash, indent=2)
-      return hash unless hash.is_a? Hash
-
-      result = []
-      hash.each do |key, value|
-        key = key.to_s.tr '_', '-'
-        if value.is_a? Hash
-          result.push " " * indent + "#{key} {"
-          result.push convert_hash(value, indent+2)
-          result.push " " * indent + "}"
-        elsif value.is_a? Array
-          value.each do |row|
-            result.push " " * indent + "#{key} #{row};"
-          end
-        else
-          result.push " " * indent + "#{key}: #{value};"
-        end
-      end
-
-      result.join "\n"
-    end
-  end
-
+module Victor
+
+  # Converts a Hash to a CSS string
+  class CSS
+    attr_reader :attributes
+
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    def to_s
+      convert_hash attributes
+    end
+
+    private
+
+    def convert_hash(hash, indent=2)
+      return hash unless hash.is_a? Hash
+
+      result = []
+      hash.each do |key, value|
+        key = key.to_s.tr '_', '-'
+        result += css_block(key, value, indent)
+      end
+
+      result.join "\n"
+    end
+
+    def css_block(key, value, indent)
+      result = []
+
+      my_indent = " " * indent
+
+      if value.is_a? Hash
+        result.push "#{my_indent}#{key} {"
+        result.push convert_hash(value, indent+2)
+        result.push "#{my_indent}}"
+      elsif value.is_a? Array
+        value.each do |row|
+          result.push "#{my_indent}#{key} #{row};"
+        end
+      else
+        result.push "#{my_indent}#{key}: #{value};"
+      end
+
+      result
+    end
+  end
+
 end

data/lib/victor/svg.rb

@@ -1,73 +1,79 @@
-module Victor
-
-  class SVG
-    attr_accessor :template, :css
-    attr_reader :content, :svg_attributes
-
-    def initialize(attributes={})
-      @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)
-      element method_sym, *arguments, &block
-    end
-
-    def build(&block)
-      self.instance_eval(&block)
-    end
-
-    def element(name, value=nil, attributes={}, &_block)
-      if value.is_a? Hash
-        attributes = value
-        value = nil
-      end
-
-      attributes = Attributes.new attributes
-
-      if block_given? || value
-        content.push "<#{name} #{attributes}".strip + ">"
-        value ? content.push(value) : yield
-        content.push "</#{name}>"
-      else
-        content.push "<#{name} #{attributes}/>"
-      end
-    end
-
-    def render
-      svg_template % { 
-        css: CSS.new(css),
-        attributes: svg_attributes, 
-        content: content.join("\n")
-      }
-    end
-
-    def to_s
-      content.join "\n"
-    end
-
-    def save(filename)
-      filename = "#{filename}.svg" unless filename =~ /\..{2,4}$/
-      File.write filename, render
-    end
-
-    private
-
-    def svg_template
-      File.read template_path
-    end
-
-    def template_path
-      if template.is_a? Symbol
-        File.join File.dirname(__FILE__), 'templates', "#{template}.svg"
-      else
-        template
-      end
-    end
-  end
-
+module Victor
+
+  # This is the primary Victor class. It handles all the conversion from
+  # ruby to SVG using {#method_missing}
+  class SVG
+    attr_accessor :template, :css
+    attr_reader :content, :svg_attributes
+
+    def initialize(attributes={})
+      @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)
+      element method_sym, *arguments, &block
+    end
+
+    def <<(additional_content)
+      content.push additional_content.to_s
+    end
+
+    def build(&block)
+      self.instance_eval(&block)
+    end
+
+    def element(name, value=nil, attributes={}, &_block)
+      if value.is_a? Hash
+        attributes = value
+        value = nil
+      end
+
+      attributes = Attributes.new attributes
+
+      if block_given? || value
+        content.push "<#{name} #{attributes}".strip + ">"
+        value ? content.push(value) : yield
+        content.push "</#{name}>"
+      else
+        content.push "<#{name} #{attributes}/>"
+      end
+    end
+
+    def render
+      svg_template % {
+        css: CSS.new(css),
+        attributes: svg_attributes,
+        content: content.join("\n")
+      }
+    end
+
+    def to_s
+      content.join "\n"
+    end
+
+    def save(filename)
+      filename = "#{filename}.svg" unless filename =~ /\..{2,4}$/
+      File.write filename, render
+    end
+
+    private
+
+    def svg_template
+      File.read template_path
+    end
+
+    def template_path
+      if template.is_a? Symbol
+        File.join File.dirname(__FILE__), 'templates', "#{template}.svg"
+      else
+        template
+      end
+    end
+  end
+
 end

data/lib/victor/version.rb

@@ -1,3 +1,3 @@
 module Victor
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: runfile-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 description: Build SVG images with ease
 email: db@dannyben.com
 executables: []
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SVG Builder