dymo_render 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec9eabf00efe17f05ec96bfed3c9f127c40b01e9296829a226548233bdc2489c
+  data.tar.gz: b3296742b51b8c22375ee3f63a9c6a49a8e1e911caaf0e273ddde5140973a5ec
+SHA512:
+  metadata.gz: 56176fe6afd97113fb882a587723fdd7774831a473118d6b655ad2ac01aac1a6c2f85d8ceceeeb84713dabe4406e39f770a04304eb4f55e78efc21d1be7f522d
+  data.tar.gz: dcce264b213376938ab78495d1d39c1b3b4f5f30165a69813ae2c6059018b3b29122a2fbf81bb2191e6ea8e53006117b6e348fd89f2f3db8b8b1f0edb3b4e63d

data/lib/dymo_render.rb

@@ -0,0 +1,290 @@
+require "dymo_render/version"
+require 'prawn'
+require 'nokogiri'
+require 'barby'
+require 'barby/barcode/code_128'
+require 'barby/barcode/qr_code'
+require 'barby/outputter/prawn_outputter'
+
+class DymoRender
+  FONT_DIRS_MACOS = [
+    "#{ENV["HOME"]}/Library/Fonts",
+    "/Library/Fonts",
+    "/Network/Library/Fonts",
+    "/System/Library/Fonts",
+  ].freeze
+
+  FONT_DIRS_LINUX = ['/usr/share/fonts/truetype/msttcorefonts'].freeze
+
+  FONT_DIRS = (RUBY_PLATFORM =~ /darwin/ ? FONT_DIRS_MACOS : FONT_DIRS_LINUX).freeze
+
+  # 1440 twips per inch (20 per PDF point)
+  TWIP = 1440.0
+
+  # 72 PDF points per inch
+  PDF_POINT = 72.0
+
+  # TODO: add more label sizes here
+  SIZES = {
+    '30252 Address' => [252, 81],
+    '30330 Return Address' => [144.1, 54],
+    '30334 2-1/4 in x 1-1/4 in' => [162, 90],
+  }.freeze
+
+  # This may be needed for some label types. Zero for now.
+  LEFT_MARGIN = 0
+
+  attr_reader :doc, :font_dirs, :pdf
+
+  def initialize(xml:, font_dirs: FONT_DIRS, params: {})
+    @xml = xml
+    @font_dirs = font_dirs
+    @params = params
+    @doc = Nokogiri::XML(xml)
+  end
+
+  def render
+    build_pdf
+    doc.css('ObjectInfo').each do |object|
+      pdf.go_to_page 1
+      render_object(object)
+    end
+    pdf.render
+  end
+
+  def has_graphics?
+    !doc.css('BarcodeObject').empty?
+  end
+
+  def orientation
+    if doc.css('PaperOrientation').first&.text == 'Landscape'
+      'landscape'
+    else
+      'portrait'
+    end
+  end
+
+  def paper_height
+    paper_size[0]
+  end
+
+  def paper_width
+    paper_size[1]
+  end
+
+  def self.font_file_for_family(font_dirs, family)
+    extensions = [".ttf", ".dfont", ".ttc"]
+    names = extensions.map { |ext| [family, ext].join }
+
+    font_dirs.each do |dir|
+      names.each do |filename|
+        file = File.join(dir, filename)
+        return file if File.exists?(file)
+      end
+    end
+    nil # not found
+  end
+
+  private
+
+  def paper_size
+    @paper_size ||= begin
+      elm = doc.css('PaperName').first
+      elm && SIZES[elm.text] || SIZES.values.first
+    end
+  end
+
+  def build_pdf
+    @pdf = Prawn::Document.new(page_size: paper_size, margin: [0, 0, 0, 0])
+  end
+
+  def render_object(object_info)
+    bounds = object_info.css('Bounds').first.attributes
+    x = ((bounds['X'].value.to_i / TWIP) - LEFT_MARGIN) * PDF_POINT
+    y = paper_size.last - (bounds['Y'].value.to_i / TWIP * PDF_POINT)
+    width = ((bounds['Width'].value.to_i / TWIP) - LEFT_MARGIN) * PDF_POINT
+    height = bounds['Height'].value.to_i / TWIP * PDF_POINT
+
+    object = object_info.children.find(&:element?)
+    case object.name
+    when 'TextObject'
+      render_text_object(object, x, y, width, height)
+    when 'ShapeObject'
+      render_shape_object(object, x, y, width, height)
+    when 'BarcodeObject'
+      render_barcode_object(object, x, y, width, height)
+    else
+      puts "unsupported object type: #{object&.name}"
+    end
+  end
+
+  def render_text_object(text_object, x, y, width, height)
+    foreground = text_object.css('ForeColor').first
+    color = color_from_element(foreground)
+    draw_rectangle_from_object(text_object, x, y, width, height)
+    verticalized = text_object.css('Verticalized').first
+    verticalized &&= verticalized.text == 'True'
+    name = text_object.css('Name').first
+    name &&= name.text
+    elements = text_object.css('StyledText Element')
+    return if elements.empty?
+
+    font = elements.first.css('Attributes Font').first
+    font_family = font ? font.attributes['Family'].value : 'Helvetica'
+    size = font.attributes['Size'].value.to_i
+    strings = elements.map do |element|
+      string = @params[name] || element.css('String').first.text
+      string = string.each_char.map { |c| [c, "\n"] }.flatten.join if verticalized
+      string
+    end
+    valign = valign_from_text_object(text_object)
+    begin
+      pdf.fill_color color
+      font_file = self.class.font_file_for_family(font_dirs, font_family)
+      pdf.font(font_file || raise("missing font #{font_family}"))
+      # horizontal padding of 1 point
+      x += 1
+      width -= 2
+      (box, actual_size) = text_box_with_font_size(
+        strings.join,
+        size: size,
+        character_spacing: 0,
+        at: [x, y],
+        width: width,
+        height: height,
+        overflow: overflow_from_text_object(text_object),
+        align: align_from_text_object(text_object),
+        valign: valign,
+        disable_wrap_by_char: true,
+        single_line: !verticalized
+      )
+      # on bottom-aligned boxes, Dymo counts the height of character descenders
+      box.at[1] += box.descender if valign == :bottom
+      box.render
+    rescue Prawn::Errors::CannotFit
+      puts 'cannot fit'
+    end
+  end
+
+  def text_box_with_font_size(text, options = {})
+    box = Prawn::Text::Box.new(text, options.merge(document: pdf))
+    box.render(dry_run: true)
+    size = box.instance_eval { @font_size }
+    [box, size]
+  end
+
+  def draw_rectangle_from_object(text_object, x, y, width, height)
+    background = text_object.css('BackColor').first
+    return unless background
+    alpha = background.attributes['Alpha'].value.to_i
+    return if alpha.zero?
+    pdf.fill_color color_from_element(background)
+    pdf.rectangle [x, y], width, height
+    pdf.fill
+  end
+
+  def color_from_element(element)
+    red   = element.attributes['Red'].value.to_i
+    green = element.attributes['Green'].value.to_i
+    blue  = element.attributes['Blue'].value.to_i
+    Prawn::Graphics::Color.rgb2hex([red, green, blue])
+  end
+
+  VALIGNS = {
+    'Top'    => :top,
+    'Bottom' => :bottom,
+    'Middle' => :center
+  }.freeze
+
+  def valign_from_text_object(text_object)
+    VALIGNS[text_object.css('VerticalAlignment').first.text] || :top
+  end
+
+  ALIGNS = {
+    'Left'   => :left,
+    'Right'  => :right,
+    'Center' => :center
+  }.freeze
+
+  def align_from_text_object(text_object)
+    ALIGNS[text_object.css('HorizontalAlignment').first.text] || :left
+  end
+
+  OVERFLOWS = {
+    'None'        => :truncate,
+    'ShrinkToFit' => :shrink_to_fit
+  }.freeze
+
+  def overflow_from_text_object(text_object)
+    OVERFLOWS[text_object.css('TextFitMode').first.text] || :truncate
+  end
+
+  HORIZONTAL_LINE_VERTICAL_FUDGE_BY = -2.5
+
+  def render_shape_object(shape_object, x, y, width, height)
+    case shape_object.css('ShapeType').first.text
+    when 'HorizontalLine'
+      pdf.line_width height
+      pdf.horizontal_line x, x + width, at: y + HORIZONTAL_LINE_VERTICAL_FUDGE_BY
+      pdf.stroke
+    else
+      puts 'unknown shape type'
+    end
+  end
+
+  def render_barcode_object(barcode_object, x, y, width, height)
+    case barcode_type = barcode_object.css('Type').first.text
+    when 'QRCode'
+      content = barcode_object.css('Text').first.text
+      code = Barby::QrCode.new(content, level: :m)
+      outputter = Barby::PrawnOutputter.new(code)
+      num_dots = outputter.full_width # number of dots in QR
+
+      xdim = width.to_f / num_dots
+      ydim = height.to_f / num_dots
+      dim = [xdim, ydim].min
+
+      # If the resulting size in either dimension is smaller than that
+      # dimension's specified size, adjust so the code is centered in the
+      # bounding box.
+      xadjust = (width - dim * num_dots).to_f / 2
+      yadjust = (height - dim * num_dots).to_f / 2
+
+      xpos = x + xadjust
+      ypos = y - height + yadjust
+
+      outputter.annotate_pdf(pdf, { x: xpos, y: ypos, xdim: dim, ydim: dim });
+    when 'Code128Auto'
+      render_barcode_code128(barcode_object, x, y, width, height, nil)
+    when 'Code128A', 'Code128B', 'Code128C'
+      type = barcode_type.sub('Code128', '')
+      render_barcode_code128(barcode_object, x, y, width, height, type)
+    else
+      puts "unknown barcode type: #{barcode_type}"
+    end
+  end
+
+  def render_barcode_code128(barcode_object, x, y, width, height, type)
+    content = barcode_object.css('Text').first.text
+    code = Barby::Code128.new(content, type)
+    outputter = Barby::PrawnOutputter.new(code)
+
+    num_dots_x = outputter.full_width
+    xdim = width.to_f / num_dots_x
+    center_x = x + width.to_f / 2
+
+    # ensure mandatory 10 module widths of space on left and right of barcode:
+    # https://en.wikipedia.org/wiki/Code_128#Quiet_zone
+    max_code_width = width - 20 * xdim
+    if (num_dots_x * xdim) > max_code_width
+      width = max_code_width
+      xdim = max_code_width / num_dots_x
+    end
+
+    # center in the x direction
+    xpos = center_x - width.to_f / 2
+    ypos = y - height
+
+    outputter.annotate_pdf(pdf, { x: xpos, y: ypos, xdim: xdim, height: height });
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: dymo_render
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Blake Gentry
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: barby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: Render PDFs using the XML format from the DYMO Label Maker app
+email: blakesgentry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dymo_render.rb
+homepage: http://github.com/bgentry/dymo_render
+licenses:
+- BSD-2-Clause
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Render PDFs using DYMO XML
+test_files: []