victor 0.2.8 → 0.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b819817dc11fa725b667d3aadd3eb3a66dc2b7ab9f270fc33fda29ef93c46a86
-  data.tar.gz: ab063e0c9fb41c7d87ab0b18cb397b509b7a43bc441cf10649997ede67c52942
+  metadata.gz: 78e6037610dec3a931d3ef7609c4ff1c926a43e074ffec4bbc9b70bf8072ac42
+  data.tar.gz: 6411438f9c4a8f793f8a82acb3420d25447289b71327e68a12687c3bd1921c87
 SHA512:
-  metadata.gz: 723688dd6bdd524fe2576218a6e634a7aecc6a7b44c59368f6cfa631a7eb6a032ab6974c7a45353baf911152a19e6be2347de93ea4740b66610f32e9a05e6f71
-  data.tar.gz: 3a8f921fc4475b882a6626009acd6cb13322180e305e8f1e16a47654d4f6125ae33870fa161aaa8da0ad40756d8823355dc94ae0961e46b26ff98383bd4341fb
+  metadata.gz: d4e1e64a1078a877a56acc22019b34f209354c085f6d527b96f334c510575ed8ecad8d2d6faca570c04324f898370722d7b72458aaefafa3ea7ec46e4344582f
+  data.tar.gz: d7f2105b59660a86f181df83641875407086308714f052d7b7edaef4084fd1bf0a72e06d4301976cb9efd23c599a1f56636b3a9d782aad64e8c8d41fcdfba9ab

data/README.md

@@ -1,11 +1,9 @@
 ![Victor](/examples//15_victor_logo.svg)
 
-Victor - Ruby SVG Image Builder
-==================================================
+# Victor - Ruby SVG Image Builder
 
 [![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)
+[![Build Status](https://github.com/DannyBen/victor/workflows/Test/badge.svg)](https://github.com/DannyBen/victor/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/85cc05c219d6d233ab78/maintainability)](https://codeclimate.com/github/DannyBen/victor/maintainability)
 
 ---
@@ -17,25 +15,26 @@ directly to SVG elements.
 
 ---
 
-Table of Contents
---------------------------------------------------
+## 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)
-* [Tagless Elements](#tagless-elements)
-* [XML Encoding](#xml-encoding)
+* [Features](#features)
+  * [Composite SVG](#composite-svg)
+  * [Saving the Output](#saving-the-output)
+  * [SVG Templates](#svg-templates)
+  * [CSS](#css)
+  * [Tagless Elements](#tagless-elements)
+  * [XML Encoding](#xml-encoding)
+  * [DSL Syntax](#dsl-syntax)
 * [Using with Rails](#using-with-rails)
 * [Related Projects](#related-projects)
+* [Contributing / Support](#contributing--support)
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install victor
@@ -47,8 +46,7 @@ Or with bundler:
 gem 'victor'
 ```
 
-Examples
---------------------------------------------------
+## Examples
 
 ```ruby
 require 'victor'
@@ -79,8 +77,7 @@ Output:
 See the [examples] folder for several ruby scripts and their SVG output.
 
 
-Usage
---------------------------------------------------
+## Usage
 
 Initialize your SVG image:
 
@@ -99,6 +96,14 @@ svg = Victor::SVG.new width: '100%', height: '100%'
 svg = Victor::SVG.new width: '100%', height: '100%', viewBox: "0 0 200 100"
 ```
 
+As an alternative, you can set the root SVG attributes using the `setup` method:
+
+```ruby
+require 'victor'
+svg = Victor::SVG.new
+svg.setup width: 200, height: 150
+```
+
 Victor uses a single method (`element`) to generate all SVG elements:
 
 ```ruby
@@ -176,8 +181,10 @@ svg.text "Victor", x: 40, y: 50, font_family: 'arial', font_weight: 'bold', font
 #    </text>
 ```
 
-Composite SVG
---------------------------------------------------
+## Features
+
+### Composite SVG
+
 Victor also supports the abiliy to combine several smaller SVG objects into 
 one using the `<<` operator or the `#append` method. 
 
@@ -225,8 +232,7 @@ or the [subclassing example](https://github.com/DannyBen/victor/tree/master/exam
 for more details.
 
 
-Saving the Output
---------------------------------------------------
+### Saving the Output
 
 Generate the full SVG to a string with `render`:
 
@@ -241,8 +247,7 @@ svg.save 'filename'
 # the '.svg' extension is optional
 ```
 
-SVG Templates
---------------------------------------------------
+### 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 
@@ -263,8 +268,7 @@ See the [templates] folder for an understanding of how templates are
 structured.
 
 
-CSS
---------------------------------------------------
+### CSS
 
 To add a CSS to your SVG, simply use the `css` command inside your `build` 
 block, like this:
@@ -321,8 +325,7 @@ will result in two `@import url(...)` rows.
 See the [custom fonts example](https://github.com/DannyBen/victor/tree/master/examples#12-custom-fonts).
 
 
-Tagless Elements
---------------------------------------------------
+### Tagless Elements
 
 Using underscore (`_`) as the element name will simply add the value to the 
 generated SVG, without any surrounding element. This is designed to allow
@@ -351,8 +354,7 @@ end
 See the [targless elements example](https://github.com/DannyBen/victor/tree/master/examples#16-tagless-elements).
 
 
-XML Encoding
---------------------------------------------------
+### XML Encoding
 
 Plain text values are encoded automatically:
 
@@ -374,24 +376,65 @@ end
 
 See the [xml encoding example](https://github.com/DannyBen/victor/tree/master/examples#17-xml-encoding).
 
+### DSL Syntax
+
+Victor supports another a cleaner DSL-like syntax. To use it, simply `require 'victor/script'`.
 
+Once required, you have access to:
 
-Using with Rails
---------------------------------------------------
+- `svg` - returns an instance of `Victor::SVG`
+- All the methods that are available on the `SVG` object, are included at the root level.
+
+For example:
+
+```ruby
+require 'victor/script'
+
+setup width: 100, height: 100
+
+build do
+  circle cx: 50, cy: 50, r: 30, fill: "yellow"
+end
+
+puts render
+save 'output.svg'
+```
+
+See the [dsl example](https://github.com/DannyBen/victor/tree/master/examples#18-dsl).
+
+## Using with Rails
 
 See the [example_rails](example_rails) folder.
 
 
-Related Projects
---------------------------------------------------
+## Related Projects
+
+### [victor-cli]
+
+A command line utility that generates Victor Ruby code from SVG code.
 
-[Icodi] is a Ruby gem that uses Victor to generate consistent random icon 
+### [victor-opal]
+
+A Victor playground that works in the browser.
+
+### [Icodi]
+
+A Ruby gem that uses Victor to generate consistent random icon 
 images, similar to GitHub's identicon.
 
 [![Icodi](assets/icodi.svg)][icodi]
 
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+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
+[icodi]: https://github.com/DannyBen/icodi
+[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.rb

@@ -3,3 +3,4 @@ require 'victor/svg_base'
 require 'victor/svg'
 require 'victor/attributes'
 require 'victor/css'
+require 'victor/dsl'

data/lib/victor/dsl.rb

@@ -0,0 +1,12 @@
+require 'forwardable'
+
+module Victor
+  module DSL
+    extend Forwardable
+    def_delegators :svg, :setup, :build, :save, :render, :append, :element
+
+    def svg
+      @svg ||= Victor::SVG.new
+    end
+  end
+end

data/lib/victor/script.rb

@@ -0,0 +1,3 @@
+require 'victor'
+include Victor
+include Victor::DSL

data/lib/victor/svg_base.rb

@@ -4,11 +4,8 @@ module Victor
     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%"
+    def initialize(attributes = nil)
+      setup attributes
       @content = []
       @css = {}
     end
@@ -18,6 +15,20 @@ module Victor
     end
     alias append <<
 
+    def setup(attributes = nil)
+      attributes ||= {}
+      attributes[:width] ||= "100%"
+      attributes[:height] ||= "100%"
+
+      if attributes[:template]
+        @template = attributes.delete :template
+      elsif !@template
+        @template = :default
+      end
+
+      @svg_attributes = Attributes.new attributes
+    end
+
     def build(&block)
       self.instance_eval(&block)
     end
@@ -53,6 +64,7 @@ module Victor
 
     def render
       css_string = CSS.new css
+
       svg_template % {
         css: css_string,
         style: css_string.render,

data/lib/victor/version.rb

@@ -1,3 +1,3 @@
 module Victor
-  VERSION = "0.2.8"
+  VERSION = "0.3.0.rc1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: victor
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0.rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies: []
 description: Build SVG images with ease
 email: db@dannyben.com
@@ -20,6 +20,8 @@ files:
 - lib/victor.rb
 - lib/victor/attributes.rb
 - lib/victor/css.rb
+- lib/victor/dsl.rb
+- lib/victor/script.rb
 - lib/victor/svg.rb
 - lib/victor/svg_base.rb
 - lib/victor/templates/default.svg
@@ -41,11 +43,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: SVG Builder