thermal 0.1.0 → 0.2.0

data/lib/thermal/starprnt/buffer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Thermal
+module Starprnt
+  class Buffer
+    COMMANDS = %i[ printRawText
+                   printRasterReceipt
+                   printImage
+                   printBase64Image
+                   print ].freeze
+
+    # print is a special command that takes an an array of subcommands
+    def print(array)
+      commands.push(print: []) if last_command != :print
+      commands.last[:print] += Array.wrap(array)
+    end
+
+    # other commands take a single object
+    (COMMANDS - [:print]).each do |cmd|
+      define_method(::Thermal::Util.underscore(cmd)) do |object|
+        commands.push(cmd => object)
+      end
+    end
+
+    def flush
+      tmp = commands
+      @commands = []
+      tmp
+    end
+
+    def to_a
+      commands.deep_dup
+    end
+
+    protected
+
+    def commands
+      @commands ||= []
+    end
+
+    def last_command
+      commands.last&.keys&.first
+    end
+  end
+end
+end

data/lib/thermal/starprnt/writer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Thermal
+module Starprnt
+  class Writer < ::Thermal::WriterBase
+    DEFAULT_QR_CODE_CELL_SIZE = 4
+
+    def print(flush: true, output: nil)
+      set_utf8_encoding
+      super
+      feed(5)
+      cut
+      flush ? buffer.flush : buffer.to_a
+    end
+
+    def self.format
+      'starprnt'
+    end
+
+    def text(str, feed: true, replace: nil, **_kwargs)
+      str = ::Thermal::Util.normalize_utf8(str, replace: replace)
+      str = "#{str}\n" if feed
+      write(str) if str
+    end
+
+    def hr(style = nil, width: col_width)
+      write("#{hr_char(style) * width}\n")
+    end
+
+    def write_bold!
+      buffer.print(enableEmphasis: !!@bold)
+    end
+
+    def write_underline!
+      buffer.print(enableUnderline: !!@underline)
+    end
+
+    def write_align!
+      cmd = case @align
+            when :right
+              'Right'
+            when :center
+              'Center'
+            else
+              'Left'
+            end
+      buffer.print(appendAlignment: cmd)
+    end
+
+    def feed(lines = 1)
+      buffer.print(appendLineFeed: lines)
+    end
+
+    def image(path, opts = {})
+      buffer.print_base64_image(::Escpos::Image.new(path, opts).to_escpos)
+    end
+
+    def qr_code(url, cell_size = DEFAULT_QR_CODE_CELL_SIZE)
+      buffer.print(appendQrCode: url, alignment: 'Center', cell: cell_size)
+    end
+
+    def cut
+      buffer.print(appendCutPaper: 'PartialCut')
+    end
+
+    protected
+
+    def write(str)
+      buffer.print(append: str)
+    end
+
+    def set_utf8_encoding
+      buffer.print(appendEncoding: 'UTF-8')
+    end
+
+    def buffer
+      @buffer ||= ::Thermal::Starprnt::Buffer.new
+    end
+  end
+end
+end

data/lib/thermal/util.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Thermal
+  # Some methods in this class are lovingly borrowed from ActiveSupport
+  module Util
+    extend self
+
+    def normalize_utf8(text, replace: nil, unf: :nfc)
+      return if !text || text.empty?
+
+      replace ||= ::Thermal.replace_char
+      text = text.encode('UTF-8', invalid: :replace, undef: :replace, replace: replace)
+      text.delete!("\r") # not ever used
+      text = text.unicode_normalize(unf) if unf
+      text unless text.empty?
+    end
+
+    def underscore(word)
+      word = word.to_s
+      return word unless /[A-Z-]/.match?(word)
+
+      word = word.dup
+      word.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) { (Regexp.last_match(1) || Regexp.last_match(2)) << '_' }
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+
+    def index_by(enumerable)
+      if block_given?
+        result = {}
+        enumerable.each { |elem| result[yield(elem)] = elem }
+        result
+      else
+        enumerable.to_enum(:index_by) { size if respond_to?(:size) }
+      end
+    end
+
+    def index_with(enumerable, default = (no_default = true))
+      if block_given?
+        result = {}
+        enumerable.each { |elem| result[elem] = yield(elem) }
+        result
+      elsif no_default
+        enumerable.to_enum(:index_with) { size if respond_to?(:size) }
+      else
+        result = {}
+        enumerable.each { |elem| result[elem] = default }
+        result
+      end
+    end
+
+    def deep_freeze!(object)
+      case object
+      when Hash
+        object.each_value { |v| deep_freeze!(v) }
+      when Array
+        object.each { |j| deep_freeze!(j) }
+      end
+      object.freeze
+    end
+
+    def self.deep_dup(object)
+      case object
+      when Hash
+        object.transform_values { |v| deep_dup(v) }
+      when Array
+        object.map { |j| deep_dup(j) }
+      else
+        object.dup
+      end
+    end
+  end
+end

data/lib/thermal/version.rb

@@ -1,3 +1,5 @@
-module Thermal
-  VERSION = "0.1.0"
-end
+# frozen_string_literal: true
+
+module Thermal
+  VERSION = '0.2.0'
+end

data/lib/thermal/writer_base.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Thermal
+  class WriterBase
+    extend Forwardable
+
+    ALIGNMENTS = %i[left center right].freeze
+
+    def initialize(profile)
+      @profile = profile
+      @bold = false
+      @underline = false
+      @align = :left
+    end
+
+    def format
+      self.class.format if self.class.respond_to?(:format)
+    end
+
+    def print(**_kwargs)
+      yield
+    end
+
+    def text(str, feed: true, replace: nil)
+      # do nothing
+    end
+
+    def hr
+      # do nothing
+    end
+
+    def align(alignment = nil, &)
+      alignment = alignment.downcase.to_sym if alignment.is_a?(String)
+      alignment ||= :left
+      raise "Invalid align #{alignment.inspect}" unless ALIGNMENTS.include?(alignment)
+
+      write_style(align: alignment, &)
+    end
+
+    def bold(enabled = true, &) # rubocop:disable Style/OptionalBooleanParameter
+      write_style(bold: !!enabled, &)
+    end
+
+    def underline(enabled = true, weight: nil, &block) # rubocop:disable Style/OptionalBooleanParameter
+      underline = weight || enabled
+      underline = false if !underline || underline == 0
+      write_style(underline: underline, &block)
+    end
+
+    def feed
+      # do nothing
+    end
+
+    def cut
+      # do nothing
+    end
+
+    def image
+      # do nothing
+    end
+
+    def qr_code
+      # do nothing
+    end
+
+    def_delegators :@profile,
+                   :supports?,
+                   :col_width
+
+    protected
+
+    def hr_char(style = nil)
+      # rubocop:disable Lint/DuplicateBranch
+      case style
+      when :bold then '▄'
+      when :double then '═'
+      when :underline then '_'
+      when :half_lower then '▄'
+      when :half_upper then '▀'
+      when :full then '█'
+      else '─'
+      end
+      # rubocop:enable Lint/DuplicateBranch
+    end
+
+    def write_style(align: nil, bold: nil, underline: nil)
+      prev_align     = @align
+      prev_bold      = @bold
+      prev_underline = @underline
+      @align     = align     unless align.nil?
+      @bold      = bold      unless bold.nil?
+      @underline = underline unless underline.nil?
+      write_align!     unless @align     == prev_align
+      write_bold!      unless @bold      == prev_bold
+      write_underline! unless @underline == prev_underline
+      return unless block_given?
+
+      yield
+      inner_align     = @align
+      inner_bold      = @bold
+      inner_underline = @underline
+      @align     = prev_align
+      @bold      = prev_bold
+      @underline = prev_underline
+      write_align!     unless @align     == inner_align
+      write_bold!      unless @bold      == inner_bold
+      write_underline! unless @underline == inner_underline
+    end
+
+    def write_align!
+      # do nothing
+    end
+
+    def write_bold!
+      # do nothing
+    end
+
+    def write_underline!
+      # do nothing
+    end
+  end
+end

data/lib/thermal.rb

@@ -1,6 +1,81 @@
-require 'thermal/version'
-require 'thermal/printer'
-require 'thermal/parser'
-
-require 'devices/html'
-require 'devices/btpr880'
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'yaml'
+require 'fileutils'
+require 'pathname'
+require 'base64'
+
+require 'escpos' # TODO: get rid of this
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'thermal/version'
+require 'thermal/util'
+require 'thermal/writer_base'
+require 'thermal/byte_buffer'
+require 'thermal/db/data'
+require 'thermal/db/loader'
+require 'thermal/db/charset'
+require 'thermal/db/cjk_encoding'
+require 'thermal/db/device'
+require 'thermal/db/encoding'
+require 'thermal/db'
+require 'thermal/escpos/cmd'
+require 'thermal/escpos/buffer'
+require 'thermal/escpos/writer'
+require 'thermal/escpos_star/buffer'
+require 'thermal/escpos_star/writer'
+require 'thermal/stargraphic/capped_byte_buffer'
+# require 'thermal/stargraphic/chunked_byte_buffer'
+require 'thermal/stargraphic/writer'
+require 'thermal/starprnt/buffer'
+require 'thermal/starprnt/writer'
+require 'thermal/profile'
+require 'thermal/printer'
+require 'thermal/dsl'
+
+module Thermal
+  class << self
+    DEFAULT_REPLACE_CHAR = ' '
+    DEFAULT_TMP_DIR = 'tmp/thermal'
+
+    attr_reader :tmp_dir
+
+    def replace_char
+      @replace_char ||= DEFAULT_REPLACE_CHAR
+    end
+
+    def replace_char=(value)
+      @replace_char = value || ''
+    end
+
+    def tmp_path(filename)
+      raise 'Must set Thermal.tmp_dir' unless tmp_dir || app_root
+
+      path = tmp_dir ? Pathname.new(tmp_dir) : app_root.join(DEFAULT_TMP_DIR)
+      path = path.join(filename)
+      FileUtils.mkdir_p(File.dirname(path))
+      path
+    end
+
+    def tmp_dir=(value)
+      unless value
+        @tmp_dir = nil
+        return
+      end
+
+      value = Pathname.new(value)
+      raise ArgumentError.new('Thermal.tmp_dir must be an absolute path') unless value.absolute?
+
+      @tmp_dir = value
+    end
+
+    def app_root
+      Rails.root if defined?(::Rails)
+    end
+
+    def gem_root
+      Pathname.new(File.expand_path('..', __dir__))
+    end
+  end
+end

metadata

@@ -1,63 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: thermal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
-- Tyler Kellen
-autorequire: 
+- Johnny Shields
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
-dependencies: []
-description: ''
-email: tyler@sleekcode.net
+date: 2025-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escpos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: escpos-image
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Thermal printer support for Ruby. Used to print receipts, chits, tickets,
+  labels, etc.
+email:
+- johnny.shields@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- Gemfile
 - LICENSE
 - README.md
-- lib/devices/btpr880.rb
-- lib/devices/html.rb
+- data/db.yml
+- data/original.yml
 - lib/thermal.rb
-- lib/thermal/parser.rb
+- lib/thermal/byte_buffer.rb
+- lib/thermal/db.rb
+- lib/thermal/db/charset.rb
+- lib/thermal/db/cjk_encoding.rb
+- lib/thermal/db/data.rb
+- lib/thermal/db/device.rb
+- lib/thermal/db/encoding.rb
+- lib/thermal/db/loader.rb
+- lib/thermal/dsl.rb
+- lib/thermal/escpos/buffer.rb
+- lib/thermal/escpos/cmd.rb
+- lib/thermal/escpos/writer.rb
+- lib/thermal/escpos_star/buffer.rb
+- lib/thermal/escpos_star/writer.rb
 - lib/thermal/printer.rb
+- lib/thermal/profile.rb
+- lib/thermal/stargraphic/capped_byte_buffer.rb
+- lib/thermal/stargraphic/chunked_byte_buffer.rb
+- lib/thermal/stargraphic/writer.rb
+- lib/thermal/starprnt/buffer.rb
+- lib/thermal/starprnt/writer.rb
+- lib/thermal/util.rb
 - lib/thermal/version.rb
-- spec/btpr880_spec.rb
-- spec/fixtures/receipt.html
-- spec/parser_spec.rb
-- spec/printer_spec.rb
-- spec/spec_helper.rb
-- spec/thermal_spec.rb
-- thermal.gemspec
-homepage: https://github.com/tkellen/ruby-thermal/
+- lib/thermal/writer_base.rb
+homepage: https://github.com/tablecheck/thermal
 licenses: []
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
-summary: Convert basic HTML into thermal printer escape codes.
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Thermal printer support for Ruby
 test_files: []

data/.gitignore

@@ -1,3 +0,0 @@
-coverage
-*.gem
-Gemfile.lock

data/.rspec

@@ -1,2 +0,0 @@
---color
---fail-fast

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-script: rspec

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/lib/devices/btpr880.rb

@@ -1,25 +0,0 @@
-require 'socket'
-
-class BTPR880 < Thermal::Printer
-
-  ESC = "\033"
-  CODES = {
-    :bold => ESC+"E",
-    :underline => ESC+"-"
-  }
-  TRANSLATE = {
-    :strong => [CODES[:bold]+"1", CODES[:bold]+"0"],
-    :u => [CODES[:underline]+"1", CODES[:underline]+"0"],
-  }
-
-  def self.translate
-    TRANSLATE
-  end
-
-  def self.print(ip, port=9001, &block)
-    sock = TCPSocket.new(ip, port)
-    yield sock if block_given?
-    sock.close
-  end
-
-end

data/lib/devices/html.rb

@@ -1,12 +0,0 @@
-class HTML < Thermal::Printer
-
-  TRANSLATE = {
-    :strong => ["<strong>", "</strong>"],
-    :underline => ["<u>", "</u>"],
-  }
-
-  def self.translate
-    TRANSLATE
-  end
-
-end

data/lib/thermal/parser.rb

@@ -1,30 +0,0 @@
-require 'nokogiri'
-
-module Thermal
-  class Parser
-    attr_accessor :device
-
-    def initialize(device)
-      @device = device
-    end
-
-    def process(str)
-      fragment = Nokogiri::HTML.fragment(str).children
-      traverse(fragment)
-    end
-
-    def traverse(fragment)
-      fragment.map do |node|
-        output = ""
-        if node.class == Nokogiri::XML::Text
-          output << node.content
-        elsif node.class == Nokogiri::XML::Element
-          output << @device.startCode(node.name)
-          output << traverse(node.children)
-          output << @device.endCode(node.name)
-        end
-        output
-      end.join('')
-    end
-  end
-end

data/spec/btpr880_spec.rb

@@ -1,36 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe BTPR880 do
-
-  describe "#startCode" do
-    it "should translate <strong>" do
-      BTPR880.startCode(:strong).should eq "\033E1"
-    end
-    it "should translate <u>" do
-      BTPR880.startCode(:u).should eq "\033-1"
-    end
-  end
-
-  describe "#endCode" do
-    it "should translate </strong>" do
-      BTPR880.endCode(:strong).should eq "\033E0"
-    end
-    it "should translate </u>" do
-      BTPR880.endCode(:u).should eq "\033-0"
-    end
-  end
-
-end
-
-describe "BTPR880 Parser" do
-
-  before(:each) do
-    @parser = Thermal::Parser.new(BTPR880)
-  end
-
-  it "should translate html to BTPR880 valid print codes" do
-    translated = @parser.process("<strong>bold<u>underline</u></strong>")
-    translated.should eq "\033E1bold\033-1underline\033-0\033E0"
-  end
-
-end