svgplot 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c34bf4dae7c76286d0c33dcd17be373d8bd786fe
-  data.tar.gz: dc246aa266b423d779bea78b735995cfc0c21cc8
+  metadata.gz: f32bc9623d7681312a258c6e9b2d0d44e0570668
+  data.tar.gz: e26356a75dae5566315c4d3ac64c29c7134cbafe
 SHA512:
-  metadata.gz: 6164dafb06d5e99a8c8bfd93dc7ce0f2891f9a65375ec466e8fec25011e8581318b5571d77b28199a3f5157067498cb245a08d68511c85827310cbfc15f5c44c
-  data.tar.gz: 05b792cd73ad32864c3a97dd417d7f9b612cf1908189abdc9d557d4099311fbe68fbf3b5373e11a8684746ba12b1ad93841813c28df86de6578e8cb29bb52c18
+  metadata.gz: 3da5deef4fb30b076469c3da597b73f04d199ef373fac1b47b83cf6b0983c90f4bdcef0966f622ba09a555e2a1e52f76e085645292b1670bf73d867ef45d73b3
+  data.tar.gz: f2f38af1aa3c60f20c4d7149b141cb91b8ed7975bf10b7f2821fcb101054c520f64e706e5016ba543af550a4cc5e7bc35a6bbf98e42cd4c641b152c2623064e1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 1.0.0 / 2015-01-19
+
+* [ENHANCEMENT] Stabilized API
+

data/README.md

@@ -3,15 +3,61 @@ svgplot
 
 [![Gem Version](https://img.shields.io/gem/v/svgplot.svg)](https://rubygems.org/gems/svgplot)
 [![Dependency Status](https://img.shields.io/gemnasium/akerl/svgplot.svg)](https://gemnasium.com/akerl/svgplot)
-[![Code Climate](https://img.shields.io/codeclimate/github/akerl/svgplot.svg)](https://codeclimate.com/github/akerl/svgplot)
-[![Coverage Status](https://img.shields.io/coveralls/akerl/svgplot.svg)](https://coveralls.io/r/akerl/svgplot)
-[![Build Status](https://img.shields.io/travis/akerl/svgplot.svg)](https://travis-ci.org/akerl/svgplot)
+[![Build Status](https://img.shields.io/circleci/project/akerl/svgplot.svg)](https://circleci.com/gh/akerl/svgplot)
+[![Coverage Status](https://img.shields.io/codecov/c/github/akerl/svgplot.svg)](https://codecov.io/github/akerl/svgplot)
+[![Code Quality](https://img.shields.io/codacy/a4ad68dc9c4940b58f9b78ec1996f533.svg)](https://www.codacy.com/app/akerl/svgplot)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
 SVG creation library forked from [xytis's Rasem fork](https://github.com/xytis/rasem).
 
 ## Usage
 
+Create an SVG object by initializing it with a size:
+
+```
+plot = SVGPlot.new(width: 100, height: 100)
+```
+
+SVGPlot is based directly on the SVG spec. Add children by calling their methods on the plot:
+
+```
+# Add the text 'foo' at position (1, 2)
+plot.text(1, 2) { 'foo' }
+```
+
+```
+# Add a rectangle
+plot.rectangle(1, 1, 10, 10)
+```
+
+A good example of the SVG library in practice is [GithubChart](https://github.com/akerl/githubchart/blob/master/lib/githubchart/svg.rb)
+
+### Transformations
+
+To do an SVG transform on an object, just call the desired transform method on it:
+
+```
+plot = SVGPlot.new(width: 100, height: 100)
+plot.text(1, 1) { 'foobar' }.translate(5, 5)
+```
+
+You can call transforms after the fact as well:
+
+```
+plot = SVGPlot.new(width: 100, height: 100)
+text = plot.text(1, 1) { 'foobar' }
+text.scale(2)
+```
+
+The list of available transforms:
+
+* translate(x, y = 0)
+* scale(x, y = 1)
+* rotate(angle, x = nil, y = nil)
+* skew_x(angle)
+* skew_y(angle)
+* matrix(a, b, c, d, e, f)
+
 ## Installation
 
     gem install svgplot

data/circle.yml

@@ -0,0 +1,12 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle install'
+    - 'rvm-exec 2.0.0-p645 bundle install'
+    - 'rvm-exec 2.1.6 bundle install'
+    - 'rvm-exec 2.2.2 bundle install'
+test:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle exec rake'
+    - 'rvm-exec 2.0.0-p645 bundle exec rake'
+    - 'rvm-exec 2.1.6 bundle exec rake'
+    - 'rvm-exec 2.2.2 bundle exec rake'

data/lib/svgplot.rb

@@ -16,7 +16,6 @@ require 'svgplot/application'
 require 'svgplot/meta'
 require 'svgplot/parsers'
 require 'svgplot/transform'
-require 'svgplot/defaults'
 require 'svgplot/tag'
 require 'svgplot/path'
 require 'svgplot/gradient'

data/lib/svgplot/gradient.rb

@@ -7,13 +7,15 @@ module SVGPlot
     end
 
     def stop(offset, color, opacity)
-      append_child(ChildTag.new(
-        @img,
-        'stop',
-        'offset' => offset,
-        'stop-color' => color,
-        'stop-opacity' => opacity
-      ))
+      append_child(
+        ChildTag.new(
+          @img,
+          'stop',
+          'offset' => offset,
+          'stop-color' => color,
+          'stop-opacity' => opacity
+        )
+      )
     end
   end
 

data/lib/svgplot/parsers.rb

@@ -43,7 +43,7 @@ module SVGPlot
       def parse_transforms(transforms)
         return nil unless transforms && valid_attribute?(:transform)
         transforms.each_with_object('') do |(attr, value), str|
-          str << "#{attr}(#{value.is_a?(Array) ? value.join(',') : value }) "
+          str << "#{attr}(#{value.is_a?(Array) ? value.join(',') : value}) "
         end
       end
 

data/lib/svgplot/plot.rb

@@ -5,7 +5,7 @@ module SVGPlot
     DEFAULTS = {
       version: 1.1,
       xmlns: 'http://www.w3.org/2000/svg',
-      :'xmlns:xlink' => 'http://www.w3.org/1999/xlink'
+      :'xmlns:xlink' => 'http://www.w3.org/1999/xlink' # rubocop:disable Style/HashSyntax, Metrics/LineLength, Lint/UnneededDisable
     }
 
     def initialize(params = {}, output = nil, &block)
@@ -17,6 +17,7 @@ module SVGPlot
 
     def add_def(id, child, if_exists = :skip, &block)
       @defs ||= ChildTag.new(@img, 'defs')
+      @defs_ids ||= {}
       old_id = check_conflicts(id, if_exists) if @defs_ids.key? id
       return old_id if old_id
 

data/lib/svgplot/tag.rb

@@ -4,10 +4,10 @@ module SVGPlot
   class Tag
     include Parsers::Tag
     include Transform
-    include Defaults
     include Expansion
 
     attr_reader :tag, :attributes, :children
+    attr_writer :defaults
 
     def initialize(tag, attributes = {}, &block)
       @tag = parse_tag tag
@@ -25,6 +25,10 @@ module SVGPlot
       append_child Path.new(@img, attributes, &block)
     end
 
+    def defaults
+      @defaults ||= {}
+    end
+
     def use(id, attributes = {})
       id = id.attributes[:id] if id.is_a? Tag
       attributes.merge!('xlink:href' => "##{id}")

data/lib/svgplot/transform.rb

@@ -13,7 +13,7 @@ module SVGPlot
     end
 
     def rotate(angle, cx = nil, cy = nil)
-      string = [cx, cy].any?(&:nil?) ?  "#{angle}" : "#{angle}, #{cx}, #{cy}"
+      string = [cx, cy].any?(&:nil?) ? "#{angle}" : "#{angle}, #{cx}, #{cy}"
       add_transform(:rotate, string)
       self
     end
@@ -39,6 +39,7 @@ module SVGPlot
     def add_transform(type, params)
       validate_attribute(:transform)
       @attributes[:transform] ||= ''
+      @attributes[:transform] << ' ' if @attributes[:transform].size > 0
       @attributes[:transform] << "#{type}(#{params})"
     end
   end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-SimpleCov.start do
-  add_filter '/spec/'
+if ENV['CI'] == 'true'
+  require 'simplecov'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
 end
 
 require 'rspec'

data/spec/svgplot/application_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/gradients_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/meta_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/parsers_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/path_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/plot_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/spec_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot do
+end

data/spec/svgplot/tag_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe SVGPlot::Tag do
+end

data/spec/svgplot/transform_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe SVGPlot::Transform do
+  let(:subject) do
+    SVGPlot.new(width: 10, height: 10).text(1, 1) { 'test' }
+  end
+
+  it 'can translate on x plane' do
+    subject.translate(1)
+    expect(subject.attributes[:transform]).to eql 'translate(1, 0)'
+  end
+
+  it 'can translate on y and y planes' do
+    subject.translate(1, 10)
+    expect(subject.attributes[:transform]).to eql 'translate(1, 10)'
+  end
+
+  it 'can scale on x plane' do
+    subject.scale(2)
+    expect(subject.attributes[:transform]).to eql 'scale(2, 1)'
+  end
+
+  it 'can scale on y and y planes' do
+    subject.scale(1, 10)
+    expect(subject.attributes[:transform]).to eql 'scale(1, 10)'
+  end
+
+  it 'can rotate to an angle' do
+    subject.rotate(10)
+    expect(subject.attributes[:transform]).to eql 'rotate(10)'
+  end
+
+  it 'can rotate to an angle and offset' do
+    subject.rotate(10, 5, 6)
+    expect(subject.attributes[:transform]).to eql 'rotate(10, 5, 6)'
+  end
+
+  it 'can skew to an x angle' do
+    subject.skew_x(10)
+    expect(subject.attributes[:transform]).to eql 'skewX(10)'
+  end
+
+  it 'can skew to a y angle' do
+    subject.skew_y(10)
+    expect(subject.attributes[:transform]).to eql 'skewY(10)'
+  end
+
+  it 'can do a matrix transform' do
+    subject.matrix(1, 2, 3, 4, 5, 6)
+    expect(subject.attributes[:transform]).to eql 'matrix(1, 2, 3, 4, 5, 6)'
+  end
+
+  it 'validates matrix args' do
+    expect { subject.matrix(1, 2) }.to raise_error RuntimeError
+  end
+
+  it 'can chain transforms' do
+    subject.skew_x(5).scale(1, 2)
+    expect(subject.attributes[:transform]).to eql 'skewX(5) scale(1, 2)'
+  end
+end

data/spec/svgplot_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe SVGPlot do
-  it 'works' do
-    expect(true).to be true
+  describe '#new' do
+    it 'creates a Plot object' do
+      expect(SVGPlot.new).to be_an_instance_of SVGPlot::Plot
+    end
   end
 end

data/svgplot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'svgplot'
-  s.version     = '0.2.0'
+  s.version     = '1.0.0'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'SVG Generation Library'
@@ -19,10 +19,10 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['svgplot']
 
-  s.add_development_dependency 'rubocop', '~> 0.28.0'
+  s.add_development_dependency 'rubocop', '~> 0.34.0'
   s.add_development_dependency 'rake', '~> 10.4.0'
-  s.add_development_dependency 'coveralls', '~> 0.7.1'
-  s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'codecov', '~> 0.1.1'
+  s.add_development_dependency 'rspec', '~> 3.3.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
   s.add_development_dependency 'nokogiri', '~> 1.6.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svgplot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Les Aker
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.34.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.34.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,33 +42,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 10.4.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -107,16 +107,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/svgplot
+- circle.yml
 - dev/update_spec.rb
 - lib/svgplot.rb
 - lib/svgplot/application.rb
-- lib/svgplot/defaults.rb
 - lib/svgplot/gradient.rb
 - lib/svgplot/meta.rb
 - lib/svgplot/parsers.rb
@@ -126,6 +126,15 @@ files:
 - lib/svgplot/tag.rb
 - lib/svgplot/transform.rb
 - spec/spec_helper.rb
+- spec/svgplot/application_spec.rb
+- spec/svgplot/gradients_spec.rb
+- spec/svgplot/meta_spec.rb
+- spec/svgplot/parsers_spec.rb
+- spec/svgplot/path_spec.rb
+- spec/svgplot/plot_spec.rb
+- spec/svgplot/spec_spec.rb
+- spec/svgplot/tag_spec.rb
+- spec/svgplot/transform_spec.rb
 - spec/svgplot_spec.rb
 - svgplot.gemspec
 homepage: https://github.com/AUTHOR_NAME/REPO_NAME
@@ -148,10 +157,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: SVG Generation Library
 test_files:
 - spec/spec_helper.rb
+- spec/svgplot/application_spec.rb
+- spec/svgplot/gradients_spec.rb
+- spec/svgplot/meta_spec.rb
+- spec/svgplot/parsers_spec.rb
+- spec/svgplot/path_spec.rb
+- spec/svgplot/plot_spec.rb
+- spec/svgplot/spec_spec.rb
+- spec/svgplot/tag_spec.rb
+- spec/svgplot/transform_spec.rb
 - spec/svgplot_spec.rb

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-- 2.1.2
-- 2.1.1
-- 2.1.0
-- 2.0.0
-- 1.9.3
-notifications:
-  email: false
-  irc:
-    template:
-    - "%{repository}/%{branch}/%{build_number}: %{message} -- %{build_url}"
-    channels:
-      secure: abJmnLwEbJFJyI2hS+LS8kbdVw1be33W3ubjizV7/8z5jmqyYn6hWivOOIh88nquxPmtWvI2SZvWqnrse5MUAdn48vW04JWJSFLRewzkq7Scz4N+RgOT8ZvaVQBJnwJTTdBohOuiVASeRnigCgozS2MjJtnyqhUGgOhAjXCtnb0=

data/lib/svgplot/defaults.rb

@@ -1,17 +0,0 @@
-module SVGPlot
-  ##
-  # Adds default attributes helpers for Tags
-  module Defaults
-    attr_writer :defaults
-
-    def defaults
-      @defaults ||= {}
-    end
-
-    def with(defaults, &block)
-      @defaults = defaults
-      instance_exec(&block)
-      @defaults = {}
-    end
-  end
-end