jekyll-svg-plugin 1.0.0

data/History.rdoc

@@ -0,0 +1,2 @@
+=== 1.0.0 (2010-8-14)
+* Initial release.

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/jekyll-svg-plugin/base.rb
+lib/jekyll-svg-plugin.rb

data/README.rdoc

@@ -0,0 +1,66 @@
+= jekyll-svg-plugin
+
+* http://github.com/dekellum/jekyll-svg-plugin
+
+== Description
+
+A plugin for adding an SVG liquid tag to Jekyll. This tag expands and
+SVG reference to object with dimensions obtains from an associated PNG
+file.
+
+== Usage
+
+Add the following to the file _plugin/svg.rb in your Jekyll site tree:
+
+  require 'jekyll-svg-plugin'
+
+Then you can include an SVG reference HTML object via liquid tag:
+
+  {% svg svg/mygraph.svg %}
+
+Note that both an *.svg and *.png are expected at the specified
+location. The later is used as a fallback and also to obtain
+dimensions (via imagesize gem, pure ruby) from the png file.
+
+I typically use Graphviz dot to generate my SVG/PNG graphs, with a Rakefile like this:
+
+  directory 'svg'
+
+  FileList[ '_dot/*.dot' ].each do |dot|
+    svg = dot.sub( /(\.dot)$/, '.svg' ).sub( /^(_dot)/, 'svg' )
+    png = dot.sub( /(\.dot)$/, '.png' ).sub( /^(_dot)/, 'svg' )
+
+    file svg => [ dot, 'svg' ] do
+      sh "dot -Tsvg -o #{svg} #{dot}"
+    end
+
+    file png => [ dot, 'svg' ] do
+      sh "dot -Tpng -o #{png} #{dot}"
+    end
+
+    task :dot => [ svg, png ]
+  end
+
+== License
+
+Copyright (c) 2010 David Kellum
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+
+$LOAD_PATH << './lib'
+require 'jekyll-svg-plugin/base'
+
+require 'rubygems'
+gem     'rjack-tarpit', '~> 1.2.2'
+require 'rjack-tarpit'
+
+t = RJack::TarPit.new( 'jekyll-svg-plugin', JekyllSVGPlugin::VERSION )
+
+t.specify do |h|
+  h.developer( 'David Kellum', 'dek-oss@gravitext.com' )
+  h.extra_deps << [ 'imagesize', '>= 0.1.1' ]
+end
+
+task :check_history_version do
+  t.test_line_match( 'History.rdoc', /^==/, / #{ t.version } / )
+end
+task :check_history_date do
+  t.test_line_match( 'History.rdoc', /^==/, /\([0-9\-]+\)$/ )
+end
+
+task :gem  => [ :check_history_version, ]
+task :tag  => [ :check_history_version, :check_history_date ]
+task :push => [ :check_history_version, :check_history_date ]
+
+task :test #noop
+
+t.define_tasks

data/lib/jekyll-svg-plugin.rb

@@ -0,0 +1,57 @@
+#--
+# Copyright (c) 2010 David Kellum
+# All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'jekyll-svg-plugin/base'
+
+# FIXME: Should create a bug to get this added to jekyll
+require 'webrick'
+mime_types = WEBrick::HTTPUtils::DefaultMimeTypes
+mime_types.store 'svg', 'image/svg+xml'
+
+require 'image_size'
+module Jekyll
+
+  class SvgTag < Liquid::Tag
+    def initialize( tag_name, svg, tokens )
+      super
+      @svg = svg.strip
+    end
+
+    def render(context)
+      png = @svg.sub( /(\.svg)$/, '.png' )
+      w,h = open( png, 'rb' ) do |fpng|
+        ImageSize.new( fpng.read ).get_size
+      end
+      <<END
+<div class="svg-object">
+  <object data="#{@svg}" type="image/svg+xml" width="#{w}" height="#{h}">
+    <img src="#{png}" width="#{w}" height="#{h}">
+  </object>
+</div>
+END
+    end
+  end
+end
+
+Liquid::Template.register_tag('svg', Jekyll::SvgTag)

data/lib/jekyll-svg-plugin/base.rb

@@ -0,0 +1,27 @@
+#--
+# Copyright (c) 2010 David Kellum
+# All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module JekyllSVGPlugin
+  VERSION='1.0.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: jekyll-svg-plugin
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Kellum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: imagesize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rjack-tarpit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 2
+        - 2
+        version: 1.2.2
+  type: :development
+  version_requirements: *id002
+description: |-
+  A plugin for adding an SVG liquid tag to Jekyll. This tag expands and
+  SVG reference to object with dimensions obtains from an associated PNG
+  file.
+email: 
+- dek-oss@gravitext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- History.rdoc
+- README.rdoc
+files: 
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/jekyll-svg-plugin/base.rb
+- lib/jekyll-svg-plugin.rb
+has_rdoc: true
+homepage: http://github.com/dekellum/jekyll-svg-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jekyll-svg-plugin
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A plugin for adding an SVG liquid tag to Jekyll
+test_files: []
+