inkscape_merge 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Laas Toom
+
+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/README.rdoc

@@ -0,0 +1,66 @@
+= inkscape_merge
+
+Script to merge SVG files with CSV data-files using Inkscape, to produce
+one outputfile (e.g. PDF) per data-row.
+
+Script inspired by and based on Aurélio A. Heckert excellent
+InkscapeGenerator (http://wiki.colivre.net/Aurium/InkscapeGenerator)
+
+Heckert's original script unfortunately broke for me several times and 
+I took the opportunity to rewrite it and make it more extendable for future.
+
+= Requirements
+
+* Inkscape (preferably in PATH)
+
+= USAGE
+
+== Install the gem
+
+  gem install inkscape_merge
+
+== Create files
+
+Create CSV data file with first row as a header. The values from this row are
+used as keys in the SVG file substitution.
+
+Create SVG file that contains some variables in the form:
+
+  %VAR_name%
+
+Where `name` is the name of a column in the CSV file created previously.
+These variables can be anywhere inside the SVG, from plain text nodes to color values.
+This script just brute-forcedly `gsubs` these values as text w/o any thought.
+
+== Run the script
+
+The script requires at least three arguments:
+* the input SVG file
+* the input CSV file
+* and the output file `pattern`
+
+Note: output pattern undergoes the same substitutions as the SVG file, so to create easily unique file names.
+Additionally the output pattern can contain `%d` which is replaced with current row number.
+
+Example:
+  inkscape_merge -f postcard.svg -d names.csv -o postcards/card_%d.pdf
+  
+This produces files like:
+* postcards/
+  * card_1.pdf
+  * card_2.pdf
+
+== Contributing to inkscape_merge
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Laas Toom. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "inkscape_merge"
+  gem.homepage = "http://github.com/borgand/inkscape_merge"
+  gem.license = "MIT"
+  gem.summary = %Q{Merge SVG files with CSV file using Inkscape}
+  gem.description = %Q{Script to merge SVG files with CSV data-files using Inkscape, to produce
+  one outputfile (e.g. PDF) per data-row.}
+  gem.email = "laas.toom@gmail.com"
+  gem.authors = ["Laas Toom"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "inkscape_merge #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/inkscape_merge

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'inkscape_merge'
+require 'optparse'
+
+
+processor = Inkscape::Merge::Processor.new
+options = processor.options
+
+# Parse command line arguments
+OptionParser.new do |opts|
+  opts.banner = "Usage: inkscape_csv_merge.rb [options]"
+  opts.separator ""
+  opts.separator "REQUIRED options"
+  opts.on("-d", "--data-file [DATA_FILE]", "Data-file to take values from.") {|d| options.data_file = d}
+  opts.on("-f", "--svg-file [SVG_FILE]", "SVG file to be used as template. Default: none") {|f| options.svg_file = f}
+  opts.on('-o', '--output_pattern PAT', 'Pattern to produce output file names. Undergoes the same substitutions as the SVG file and additionally %d can be used for current row number. Default: none') {|p|
+    options.output = p
+  }
+  
+  opts.separator ""
+  opts.separator "Optional"
+  opts.on('-i', '--inkscape INKSCAPE_BIN', "Where Inkscape binary can be found") {|i| options.inkscape = i}
+  opts.on('--format FMT', "Output format. Must be supported export format of Inkscape. Default: #{options.format}"){|f| options.format = f}
+  opts.on("--dpi DPI", Integer, "Specify output DPI. Default: #{options.dpi}") {|d| options.dpi = d}
+  opts.on("-v", "--[no-]verbose", "Run verbosely") {|v| options.verbose = v}
+  opts.on("-l", "--limit [LIMIT]", Integer, "Only process LIMIT rows. 0 means no limit. Default: #{options.limit}") {|l|
+    options.limit = l
+  }
+  
+  opts.separator ""
+  opts.separator "CSV parser options"
+  opts.on("--csv_col_sep SEP", "CSV column separator. Default: #{options.csv_options[:col_sep]}") {|v| opts.csv_options[:col_sep] = v}
+  opts.on("--csv_encoding ENC", "CSV file encoding. Default: #{options.csv_options[:encoding]}") {|e| opts.csv_options[:encoding] = e}
+  
+  opts.separator ""
+
+  opts.on_tail("-h", "--help", "Show this help") { puts opts; exit }
+end.parse!
+
+# Run the processor
+begin
+  processor.run
+rescue => e
+  $stderr.puts "ERROR: #{e}"
+  exit 1
+end

data/inkscape_merge.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{inkscape_merge}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Laas Toom"]
+  s.date = %q{2011-08-10}
+  s.default_executable = %q{inkscape_merge}
+  s.description = %q{Script to merge SVG files with CSV data-files using Inkscape, to produce
+  one outputfile (e.g. PDF) per data-row.}
+  s.email = %q{laas.toom@gmail.com}
+  s.executables = ["inkscape_merge"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/inkscape_merge",
+    "inkscape_merge.gemspec",
+    "lib/inkscape_merge.rb",
+    "lib/inkscape_merge/data_parsers.rb",
+    "lib/inkscape_merge/processor.rb",
+    "test/helper.rb",
+    "test/test_inkscape_merge.rb"
+  ]
+  s.homepage = %q{http://github.com/borgand/inkscape_merge}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Merge SVG files with CSV file using Inkscape}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/inkscape_merge.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'inkscape_merge/processor'
+
+

data/lib/inkscape_merge/data_parsers.rb

@@ -0,0 +1,41 @@
+require 'csv'
+
+
+# Module to detect and wrap data-files
+module Inkscape # :nodoc:
+  module Merge # :nodoc:
+    module DataParser
+  
+      # Detect, which parser to use for given input file
+      def self.detect(options)
+        case options.data_file
+        when /.csv$/i
+          return ::Inkscape::Merge::DataParser::CSV.new(options.data_file, options.csv_options)
+        end
+      end
+
+      # CSV file parser
+      # Though Ruby's CSV would suffice, we explicitly wrap it in an API
+      # Other parsers must comply to this API
+      class CSV
+        include Enumerable
+    
+        # Read file into memory
+        def initialize(data_file, csv_options)
+          opts = csv_options
+          @data = ::CSV.read data_file, opts
+        end
+    
+        # Return headers as an array
+        def headers
+          @data.headers
+        end
+    
+        # Wraps CSV#each for enumerable support
+        def each(&block)
+          @data.each &block
+        end
+      end
+    end
+  end
+end

data/lib/inkscape_merge/processor.rb

@@ -0,0 +1,113 @@
+require 'ostruct'
+require 'tempfile'
+require 'fileutils'
+require 'inkscape_merge/data_parsers'
+
+module Inkscape # :nodoc:
+  module Merge # :nodoc:    
+    # Main class to initialize processing
+    class Processor
+      attr_reader :options
+      
+      # Initialize the processor, setting files and options
+      def initialize
+        @options = OpenStruct.new
+        # Default options
+        @options.format = "pdf"
+        @options.csv_options = {:headers => true, :col_sep => ',', :encoding => 'utf-8'}
+        @options.limit = 0
+        @options.dpi = 300
+        @options.inkscape = %x(which inkscape)
+        # If no Inkscape in PATH, try to guess from platform
+        if options.inkscape.empty?
+          options.inkscape = case RUBY_PLATFORM
+            when /darwin/
+              "/Applications/Inkscape.app/Contents/Resources/bin/inkscape"
+            end
+        end
+        
+      end  
+      
+      # Iterate over all data rows and generate output files
+      # Optionally stop when LIMIT is reached
+      def run
+        validate_options
+        
+        # Open the files
+        @svg = File.read options.svg_file
+        @data_file = DataParser.detect(options)
+        
+        count = 0
+        headers = @data_file.headers
+        pattern = /%VAR_(#{headers.map(&:to_s).join("|")})%/
+        @data_file.each{|row|
+          break if @options.limit > 0 && count >= @options.limit
+          count += 1
+          puts "Row: #{count}"
+          tmp_file = Tempfile.new('inkscape_merge')
+          begin
+            (outfile,merged_svg) = [@options.output,@svg].map{|s|
+                s.gsub(pattern){|m|
+                  puts $1 if @options.verbose
+                  # return corresponding value from current row
+                  row[$1]
+              }
+            }
+            
+            # Write merged SVG out
+            tmp_file.puts merged_svg
+            tmp_file.close
+            
+            # Sprintf outfile with current row number
+            outfile %= count
+            
+            # Generate output path
+            FileUtils.mkdir_p(File.dirname outfile)
+            
+            # Generate the file itself
+            ink_generate tmp_file.path, outfile, @options.format, @options.dpi
+          rescue => e
+            $stderr.puts "ERROR: #{e}"
+            $stderr.puts e.backtrace if @options.verbose
+          ensure
+            tmp_file.unlink
+          end
+        }
+      end
+      
+      private
+      
+      # Validate options and give error if something is missing
+      def validate_options
+        # TODO: replace with
+        
+        # If inkscape can not be found or run, bail out
+        unless File.executable? @options.inkscape
+          raise ArgumentError, "Inkscape not found or not executable"
+        end
+
+        unless @options.svg_file
+          raise ArgumentError, "SVG file must be given"
+        end
+
+        unless @options.data_file
+          raise ArgumentError, "Data-file must be given"
+        end
+
+        unless @options.output
+          raise ArgumentError, "Output pattern must be given"
+        end
+      end
+      
+      # Run Inkscape to generate files
+      def ink_generate(in_file, out_file, format='pdf', dpi="300")
+        cmd = %(#{@options.inkscape} --without-gui --export-#{format}=#{out_file} --export-dpi=#{dpi} #{in_file})
+        puts "INKSCAPE CMD: #{cmd}" if @options.verbose
+        ink_error = `#{cmd} 2>&1`
+        unless $?.success?
+          $stderr.puts "Inkscape ERROR (#{$?}): #{ink_error}"
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'inkscape_merge'
+
+class Test::Unit::TestCase
+end

data/test/test_inkscape_merge.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestInkscapeMerge < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: inkscape_merge
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Laas Toom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-10 00:00:00 +03:00
+default_executable: inkscape_merge
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: |-
+  Script to merge SVG files with CSV data-files using Inkscape, to produce
+    one outputfile (e.g. PDF) per data-row.
+email: laas.toom@gmail.com
+executables: 
+- inkscape_merge
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/inkscape_merge
+- inkscape_merge.gemspec
+- lib/inkscape_merge.rb
+- lib/inkscape_merge/data_parsers.rb
+- lib/inkscape_merge/processor.rb
+- test/helper.rb
+- test/test_inkscape_merge.rb
+has_rdoc: true
+homepage: http://github.com/borgand/inkscape_merge
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4265623212388845729
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Merge SVG files with CSV file using Inkscape
+test_files: []
+