svg_template_to_pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94286bb0289f93f94bfd32ebe980024f62b6a1eb
+  data.tar.gz: decca2a8e5a877d1ac93491ea6b4d2c009d5fbaf
+SHA512:
+  metadata.gz: 24b8b0792da79465a34e76fb6a980c7f927667c6fded1a8425e3c4e55faf83352938af5b0bdd03158a75f406339bd7fb8cef0252e4d7e8f62aa0beaf4d4ebdc6
+  data.tar.gz: d416e946065c5c49783e7eaacf8f2bb7440fba367b622e0ffdadd3a647299de52d94a83ec08a3f1b8d5950eab6144f06bda3d18f74feac1b4925dd78df7f0903

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sakalfil@fit.cvut.cz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in svg_template_to_pdf.gemspec
+gemspec
+gem 'csv', '~> 0.0.1'
+gem 'svg2pdf', '~> 0.2.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 phil
+
+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.md

@@ -0,0 +1,53 @@
+# SvgTemplateToPdf
+
+This gem takes picture in SVG format with defined variables and CSV data file
+ and produce generated PDF files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'svg_template_to_pdf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install svg_template_to_pdf
+    
+This gem also uses some other gems, such as csv, svg2pdf.
+
+## Usage
+
+Two input files are needed and you should prepare them before you start:
+- SVG file which contains variables in format: %VAR_variable1%, %VAR_variable2%, ... 
+    - Tip: You can use a visual editor (Inkscape, ...). 
+- CSV file which contains variable1, variable2, ... as header and other data 
+in these columns
+
+Then you can run: 
+```ruby
+s = SvgTemplateToPdf.new(svg_path, csv_path, output_folder = "~", pdf_filename = "output")
+s.process
+```
+
+You can also get an array of variables, which are contained in the SVG file:
+```ruby
+s.variables
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sakalfil/svg_template_to_pdf. 
+This project is intended to be a safe, welcoming space for collaboration, and 
+contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "svg_template_to_pdf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/svg_template_to_pdf/version.rb

@@ -0,0 +1,3 @@
+class SvgTemplateToPdf
+  VERSION = "0.1.0"
+end

data/lib/svg_template_to_pdf.rb

@@ -0,0 +1,47 @@
+require "svg_template_to_pdf/version"
+require 'csv'
+require 'svg2pdf'
+require 'securerandom'
+
+class SvgTemplateToPdf
+
+  def initialize(svg_filename, csv_filename, output_folder = "~", pdf_filename = nil)
+    @svg_input     = File.read(svg_filename)
+    @csv_filename  = csv_filename
+    @output_folder = output_folder
+    @pdf_filename  = pdf_filename
+  end
+
+  # Get header names from svg
+  def variables
+    result     = @input.scan(/%VAR_(\w+)%/).flatten
+    duplicates = get_duplicates(result)
+    raise StandardError, "More than 1 use of variables #{duplicates.join(", ")} in the SVG file." if duplicates.size != 0
+    result
+  end
+
+  def process
+    output_files = []
+    CSV.read(@csv_filename, headers: true).each_with_index do |row, i| # for each row produce pdf with data
+      content = @input.dup
+      variables.each { |col| content.sub!("%VAR_#{col}%", row[col].to_s) }
+      output_files << Svg2pdf.convert_from_data(content, :pdf, working_dir: @output_folder, output_name: "#{@pdf_filename}#{i}")
+    end
+    output_files
+  end
+
+  private
+
+  def get_duplicates(ary)
+    ary.group_by { |v| v }.select { |k, v| v.count > 1 }.keys
+  end
+end
+
+# Update output file naming options
+class Svg2pdf::Processor
+  private
+  def setup_options(options)
+    @options               = options
+    @options[:output_file] = File.join(@options[:working_dir], @options[:output_name] + '.' + @mode.to_s)
+  end
+end

data/svg_template_to_pdf.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svg_template_to_pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "svg_template_to_pdf"
+  spec.version       = SvgTemplateToPdf::VERSION
+  spec.authors       = ["Filip Sakala"]
+  spec.email         = ["fil.sakala@gmail.com"]
+
+  spec.summary       = %q{This gem takes picture in SVG format with defined variables and CSV data file and produce generated PDF files.}
+  spec.description   = %q{This gem takes picture in SVG format with defined variables and CSV data file and produce generated PDF files.}
+  spec.homepage      = "https://github.com/sakalfil/svg_template_to_pdf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "svg2pdf", '~> 0.2.0'
+  spec.add_development_dependency "csv", '~> 0.0.1'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: svg_template_to_pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Filip Sakala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: svg2pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: This gem takes picture in SVG format with defined variables and CSV data
+  file and produce generated PDF files.
+email:
+- fil.sakala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/svg_template_to_pdf.rb
+- lib/svg_template_to_pdf/version.rb
+- svg_template_to_pdf.gemspec
+homepage: https://github.com/sakalfil/svg_template_to_pdf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: This gem takes picture in SVG format with defined variables and CSV data
+  file and produce generated PDF files.
+test_files: []