svg_drawer 1.0.0

data/lib/svg_drawer/text_box.rb

@@ -0,0 +1,153 @@
+module SvgDrawer
+  class TextBox < Base
+    defaults font: 'Courier New',
+             font_style: [],
+             font_weight: 400,
+             font_size: 12,
+             font_color: 'black',
+             text_align: 'left',
+             text_valign: 'bottom',
+             line_height: 1,
+             wrap_policy: 'normal',
+             word_pattern: /[[:word:]]+[^[:word:]]\s?(?![^[:word:]])|[[:word:]]+|[^[:word:]]/,
+             overflow: false,
+             truncate: false,
+             truncate_with: '...',
+             text_padding: { top: 0, bottom: 0, left: 0, right: 0 }
+
+    def initialize(text, params = {})
+      super(params)
+      @text = text.to_s.strip.gsub(/\s+/, ' ')
+      fonts_config = SvgDrawer.configuration
+      @config = fonts_config['default'].merge(fonts_config[param(:font)] || {})
+    end
+
+    def width
+      return @width if @width
+      ensure_complete!
+      @width = param(:width, calculate_width).to_d
+    end
+
+    # If overflow is true, but we don't have any explicit height set,
+    # report the calculated height.
+    def height
+      return @height if @height
+      ensure_complete!
+      @height = param(:overflow) ?
+        param(:height, calculate_height).to_d :
+        [param(:height, 0), calculate_height].max.to_d
+    end
+
+    def incomplete
+      false
+    end
+
+    private
+
+    def _draw(parent)
+      # need symbol keys due to a bug in Rasem::SVGTag#write_styles
+      style = {}
+      style[:fill] = param(:font_color)
+      style[:'font-family'] = param(:font)
+      style[:'text-anchor'] = align_to_anchor(param(:text_align))
+      style[:'font-weight'] = param(:font_style).include?('bold') ? 'bold' : param(:font_weight)
+      style[:'font-style'] = 'italic' if param(:font_style).include?('italic')
+      style[:'font-size'] = param(:font_size).is_a?(Numeric) ?
+        "#{param(:font_size)}pt" :
+        param(:font_size)
+
+      svg_params = { x: 0, y: 0, style: style }
+
+      case param(:text_align)
+      when 'left' then svg_params[:x] += param(:text_padding)[:left]
+      when 'right' then svg_params[:x] += width - param(:text_padding)[:right]
+      when 'center' then svg_params[:x] += width.to_d / 2
+      end
+
+      y_deltas = calculate_y_deltas
+
+      Utils::RasemWrapper.group(parent, class: param(:class)) do |text_box_group|
+        root_y = svg_params[:y]
+
+        draw_border(text_box_group)
+        lines.zip(y_deltas).each do |line, delta_y|
+          svg_params[:y] = root_y + delta_y
+          escaped = line.encode(xml: :text)
+          Utils::RasemWrapper.text(text_box_group, svg_params) { |txt| txt.raw(escaped) }
+        end
+      end
+    end
+
+    def align_to_anchor(align)
+      case align
+      when 'left' then 'start'
+      when 'right' then 'end'
+      when 'center' then 'middle'
+      else raise "Bad text_align: #{align}. Valid are: [left, right, center]"
+      end
+    end
+
+    def font_width_px
+      @config['width']
+    end
+
+    def font_height_px
+      @config['height']
+    end
+
+    def calculate_line_height_px
+      font_height_px * param(:font_size) * param(:line_height)
+    end
+
+    def calculate_y_offset_px
+      font_height_px * param(:font_size) * @config['y_offset']
+    end
+
+    def lines
+      return [@text] if param(:overflow)
+      txt = param(:truncate) ?
+        Utils::Text.truncate(@text, chars_per_line, param(:truncate_with)) :
+        @text
+
+      Utils::Text.word_wrap(txt, chars_per_line, param(:word_pattern))
+      # Text.word_wrap(txt, chars_per_line, /\b/)
+    end
+
+    def chars_per_line
+      font_width = font_width_px.to_d * param(:font_size)
+      font_wrap_policy = @config['wrap_policies']
+      wrap_coeff = font_wrap_policy[param(:wrap_policy)]
+      adj_font_width = font_width * wrap_coeff
+      xpad = param(:text_padding)[:left] + param(:text_padding)[:right]
+      ((width - xpad) / adj_font_width).to_i
+    end
+
+    def calculate_width
+      font_width = font_width_px * param(:font_size)
+      @text.length * font_width
+    end
+
+    def calculate_height
+      return 0 if @text.empty?
+      ypad = param(:text_padding)[:top] + param(:text_padding)[:bottom]
+      ypad + lines.size * calculate_line_height_px
+    end
+
+    def calculate_y_deltas
+      lheight = calculate_line_height_px
+      yoffset = calculate_y_offset_px
+      base_deltas = 1.upto(lines.size).map { |lineno| lineno * lheight - yoffset }
+      remaining_height = height - calculate_height
+
+      case param(:text_valign)
+      when 'top'
+        base_deltas.map { |bd| bd + param(:text_padding)[:top] }
+      when 'bottom'
+        base_deltas.map { |bd| bd + remaining_height }
+      when 'middle'
+        base_deltas.map { |bd| bd + remaining_height / 2 }
+      else raise "Bad text_valign: #{param(:text_valign)}. Valid are: [top, bottom, middle]"
+      end
+    end
+  end
+end

data/lib/svg_drawer/utils/parameter_merger.rb

@@ -0,0 +1,37 @@
+module SvgDrawer
+  module Utils
+    class ParameterMerger
+      ParameterNotFound = Class.new(StandardError)
+
+      def initialize(*sources)
+        @sources = sources
+      end
+
+      # At least one of the sources must contain some value for the param
+      # (even a nil value)
+      def param(name)
+        source = @sources.find { |s| s.key?(name) }
+        raise ParameterNotFound, "No such param: #{name}" unless source
+        val = source[name]
+
+        val.is_a?(Hash) ? default_hash(name, val) : val
+      end
+
+      def param?(name)
+        !!param(name)
+      rescue ParameterNotFound
+        false
+      end
+
+      private
+
+      # When the value is the hash, populate its missing keys (if any)
+      # with default values
+      def default_hash(name, value)
+        @sources.reduce(value) do |hash, source|
+          source[name] ? source[name].merge(hash) : hash
+        end
+      end
+    end
+  end
+end

data/lib/svg_drawer/utils/rasem_wrapper.rb

@@ -0,0 +1,14 @@
+module SvgDrawer
+  module Utils
+    module RasemWrapper
+      module_function
+
+      %i[group rect text].each do |n|
+        define_method(n) do |svg_ctx, params = {}, &b|
+          compact_params = params.reject { |_k, v| v.nil? }
+          svg_ctx.public_send(n, compact_params) { b.call(self) if b }
+        end
+      end
+    end
+  end
+end

data/lib/svg_drawer/utils/text.rb

@@ -0,0 +1,48 @@
+module SvgDrawer
+  module Utils
+    module Text
+      module_function
+
+      DEFAULT_WORD_PATTERN = /
+        [[:word:]]+         # chars
+        [^[:word:]]         # delimiter
+        \s?                 # optional space
+        (?![^[:word:]])     # not followed by delimiter
+        |
+        [[:word:]]+         # chars
+        |
+        [^[:word:]]         # delimiter
+      /x
+
+      def truncate(text, maxlen, trailer = '...')
+        return text unless text.length > maxlen
+        raise if maxlen < trailer.length
+        text.slice(0, maxlen - trailer.length).concat(trailer)
+      end
+
+      #
+      # Wrap on any word delimiter, but consider a word followed
+      # by a single delimiter and a space as unwrappable (e.g. end of sentence)
+      #
+      # If word itself is longer than max line length, force-wrap it
+      # on any char (effectively slicing it at maxlen)
+      #
+      def word_wrap(txt, maxlen, word_pattern = DEFAULT_WORD_PATTERN)
+        words = txt.scan(word_pattern)
+
+        words.each_with_object(['']) do |word, lines|
+          last = lines.last
+          wordlen = word.rstrip.length
+
+          if wordlen > maxlen
+            lines.concat(word.scan(/.{1,#{maxlen}}/))
+          elsif last != '' && last.length + wordlen > maxlen
+            lines << word
+          else
+            lines.last << word
+          end
+        end.delete_if(&:empty?).each(&:strip!)
+      end
+    end
+  end
+end

data/lib/svg_drawer/version.rb

@@ -0,0 +1,3 @@
+module SvgDrawer
+  VERSION = '1.0.0'
+end

data/lib/svg_drawer.rb

@@ -0,0 +1,31 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'rasem'
+require 'yaml'
+
+module SvgDrawer
+  class << self
+    attr_reader :configuration
+  end
+
+  config_file = File.join(File.dirname(__FILE__), 'fonts.yml')
+  @configuration = YAML.load_file(config_file)
+end
+
+require 'svg_drawer/version'
+require 'svg_drawer/utils/text'
+require 'svg_drawer/utils/parameter_merger'
+require 'svg_drawer/utils/rasem_wrapper'
+require 'svg_drawer/base'
+require 'svg_drawer/text_box'
+require 'svg_drawer/polyline'
+require 'svg_drawer/multipolyline'
+require 'svg_drawer/line'
+require 'svg_drawer/path'
+require 'svg_drawer/circle'
+require 'svg_drawer/table/cell'
+require 'svg_drawer/table/blank_row'
+require 'svg_drawer/table/row'
+require 'svg_drawer/table/table'
+require 'svg_drawer/table/border'
+

data/svg_drawer.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "svg_drawer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'svg_drawer'
+  spec.version       = SvgDrawer::VERSION
+  spec.authors       = ['Simeon Manolov']
+  spec.email         = ['s.manolloff@gmail.com']
+  spec.summary       = 'A ruby gem for building table-based SVG layouts'
+  spec.homepage      = 'https://github.com/smanolloff/svg_drawer'
+  spec.license       = 'MIT'
+
+  spec.require_paths = ['lib']
+  spec.files = Dir.glob('lib/**/*') + %w[LICENSE.txt svg_drawer.gemspec]
+
+  spec.add_dependency 'rasem', '~> 0.7'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: svg_drawer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Simeon Manolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rasem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- s.manolloff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/fonts.yml
+- lib/svg_drawer.rb
+- lib/svg_drawer/base.rb
+- lib/svg_drawer/circle.rb
+- lib/svg_drawer/line.rb
+- lib/svg_drawer/multipolyline.rb
+- lib/svg_drawer/path.rb
+- lib/svg_drawer/polyline.rb
+- lib/svg_drawer/table/blank_row.rb
+- lib/svg_drawer/table/border.rb
+- lib/svg_drawer/table/cell.rb
+- lib/svg_drawer/table/row.rb
+- lib/svg_drawer/table/table.rb
+- lib/svg_drawer/text_box.rb
+- lib/svg_drawer/utils/parameter_merger.rb
+- lib/svg_drawer/utils/rasem_wrapper.rb
+- lib/svg_drawer/utils/text.rb
+- lib/svg_drawer/version.rb
+- svg_drawer.gemspec
+homepage: https://github.com/smanolloff/svg_drawer
+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.3
+signing_key: 
+specification_version: 4
+summary: A ruby gem for building table-based SVG layouts
+test_files: []