rescpos 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rspec/instafail
+--format RSpec::Instafail

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@rescpos

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+group :test do
+  gem 'rspec-instafail'
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'guard-bundler'
+  gem 'guard-cucumber'
+  gem 'guard-rspec'
+end
+
+# Specify your gem's dependencies in rescpos.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rescpos (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    cucumber (1.0.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.4.16)
+      json (>= 1.4.6)
+    guard (0.6.2)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-cucumber (0.6.1)
+      cucumber (>= 0.10)
+      guard (>= 0.4.0)
+    guard-rspec (0.4.3)
+      guard (>= 0.4.0)
+    json (1.5.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.8)
+    rspec-mocks (2.6.0)
+    term-ansicolor (1.0.6)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  guard-bundler
+  guard-cucumber
+  guard-rspec
+  rescpos!
+  rspec
+  rspec-instafail

data/Guardfile

@@ -0,0 +1,17 @@
+group 'rescpos' do
+  guard 'bundler' do
+    watch('Gemfile')
+  end
+
+  guard 'cucumber' do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$})          { 'features' }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  end
+
+  guard 'rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { "spec" }
+  end
+end

data/README.textile

@@ -0,0 +1,75 @@
+h1. Intro
+
+A ruby implementation of the Line Thermal Printer ESC/POS Command Specifications.
+
+h1. Install
+
+gem install rescpos
+
+h1. Usage
+
+See "examples":https://github.com/towerhe/rescpos/tree/develop/examples
+
+Specify the template path:
+
+bc. Rescpos.configure do |config|
+  config.template_path = "path/to/your/escpos/templates"
+end
+
+For rails application, the default template path is set to app/escposes. So you should create the templates under app/escposes directory. But if you want to save the templates into another place, you should config the template path in a rails initializer.
+
+h2. Reports
+
+Reports manage the objects that will be used in the templates. You should subclass the Rescpos::Report class to define your own reports. For example:
+
+<pre>
+class SimpleTitledReport < Rescpos::Report
+  attr_reader :title
+
+  def initialize(title = '')
+    @title = title
+  end
+end
+</pre>
+
+To render the report, you just need to call the render method of the report.
+
+bc. report = SimpleTitledReport.new('A report with a title')
+report.render(:template => "<%= @title %>")
+# A report with a title
+
+You can also create a pre-defined template for the report. 
+
+bc. report.render(:file => 'path/to/the/template')
+
+Rescpos will search for the template with the underscore name of the report under the template path if you do not provide any params when rendering the report.
+
+bc. report.render
+
+This will cause rescpos to search for a template named simple_titled.escpos.erb under app/escposes.
+
+h2. Templates
+
+Rescpos use erb to define the templates. So any valid erb templates are valid rescpos templates.
+
+Template's extension name is set to 'escpos.erb'.
+
+bc. # dish_item.escpos.erb
+<%= text(@dish[:dish_category], :font_size => FONT_BIG) %>
+<%= text(key_value("餐桌", @bill[:table]), :font_size => FONT_BIG) %> 
+<%= text(key_value("人数", @bill[:num_of_people]), :font_size => FONT_BIG) %>
+<%= single_splitline %>
+<%= text(key_value("菜品", @dish[:name]), :font_size => FONT_BIG) %>
+<%= text(key_value("数量", "#{@dish[:quantity]} [根]"), :font_size => FONT_BIG) %>
+<%= single_splitline %>
+<%= text(key_value("单号", @bill[:id])) %>
+<%= text(key_value("操作员", @bill[:waiter])) %>
+<%= text(key_value("下单时间", @bill[:created_at])) %>
+
+h2. Printers
+
+In order to print the report, you should create a Rescpos::Printer object and then print the report.
+
+bc. printer = Rescpos::Printer.open('192.168.1.250', 9100)
+printer.print(report)
+printer.close

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/examples/escposes/dish_item.escpos.erb

@@ -0,0 +1,10 @@
+<%= text(@dish[:dish_category], :font_size => FONT_BIG) %>
+<%= text(key_value("餐桌", @bill[:table]), :font_size => FONT_BIG) %> 
+<%= text(key_value("人数", @bill[:num_of_people]), :font_size => FONT_BIG) %>
+<%= single_splitline %>
+<%= text(key_value("菜品", @dish[:name]), :font_size => FONT_BIG) %>
+<%= text(key_value("数量", "#{@dish[:quantity]} [根]"), :font_size => FONT_BIG) %>
+<%= single_splitline %>
+<%= text(key_value("单号", @bill[:id])) %>
+<%= text(key_value("操作员", @bill[:waiter])) %>
+<%= text(key_value("下单时间", @bill[:created_at])) %>

data/examples/print.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+$:.unshift(File.join(File.dirname(__FILE__)))
+
+require 'rescpos'
+require 'reports/dish_item_report'
+
+Rescpos.configure do |config|
+  config.template_path = File.expand_path(File.join(File.dirname(__FILE__), 'escposes'))
+end
+
+report = DishItemReport.new
+
+printer = Rescpos::Printer.open("192.168.1.3", 9100)
+printer.print_report(report, :encoding => 'GBK')
+printer.close

data/examples/reports/dish_item_report.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), "../../lib"))
+
+require 'rescpos'
+
+class DishItemReport < Rescpos::Report
+  attr_reader :bill, :dish
+
+  def initialize
+    @bill = {
+      :id => "20110819000002",
+      :waiter => '000',
+      :created_at => '2011-08-18 13:11:03',
+      :table => '01B[大堂]',
+      :num_of_people => 2
+    }
+
+    @dish = {
+      :name => '广式靓油条',
+      :quantity => 1,
+      :dish_category => '面组'
+    }
+  end
+end

data/features/printer.feature

@@ -0,0 +1,4 @@
+Feature: Printer
+  Scenario: Connect and disconnect printer
+    Given I have a printer with ip "192.168.1.3" and port "9100"
+    When I connect the printer

data/features/render_report.feature

@@ -0,0 +1,38 @@
+Feature: Render a well-formatted report
+  In order to print a well-formatted report through WINPOS WP-800 printer
+  I want to render the report with erb templates
+
+  Scenario: create a titled report
+    Given a ESC/POS template:
+    """
+    <%= @title %>
+    """
+    And a titled report:
+    """
+    class TitledReport < Rescpos::Report
+      attr_reader :title, :str_template
+
+      def initialize(title = '')
+        @title = title
+      end
+    end
+    @report = TitledReport.new('A report with a title')
+    """
+    When I render the titled report with the given template
+    Then I will see "A report with a title"
+
+  Scenario: render a titled report with a template
+    Given "spec/reports" is a template directory
+    And a titled report:
+    """
+    class TitledReport < Rescpos::Report
+      attr_reader :title, :str_template
+
+      def initialize(title = '')
+        @title = title
+      end
+    end
+    @report = TitledReport.new('A report with a title')
+    """
+    When I render the report
+    Then I will see "A report with a title"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,3 @@
+Given /^a file named "([^"]*)" with:$/ do |file_name, file_content|
+  write_file(file_name, file_content)
+end

data/features/step_definitions/printer_steps.rb

@@ -0,0 +1,7 @@
+Given /^I have a printer with ip "([^"]*)" and port "([^"]*)"$/ do |ip, port|
+  @printer = Rescpos::Printer.new(ip, port)
+end
+
+When /^I connect the printer$/ do
+  @client = @printer.connect()
+end

data/features/step_definitions/report_steps.rb

@@ -0,0 +1,25 @@
+Given /^a ESC\/POS template:$/ do |string|
+  @str_template = string
+end
+
+Given /^a titled report:$/ do |string|
+  eval string
+end
+
+When /^I render the titled report with the given template$/ do
+  @output = @report.render(:template => @str_template)
+end
+
+Then /^I will see "([^"]*)"$/ do |title|
+  @output.should == title
+end
+
+Given /^"([^"]*)" is a template directory$/ do |path|
+  Rescpos.configure do |config|
+    config.template_path = path
+  end
+end
+
+When /^I render the report$/ do
+  @output = @report.render
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'rescpos'

data/lib/core_ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  def underscore
+    word = self.to_s.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/rescpos/configuration.rb

@@ -0,0 +1,11 @@
+module Rescpos
+  class Configuration
+    attr_accessor :template_path
+
+    def initialize
+      if Object.const_defined?(:Rails)
+        @template_path = File.join(Rails.root, "app/escposes")
+      end
+    end
+  end
+end

data/lib/rescpos/printer.rb

@@ -0,0 +1,40 @@
+module Rescpos
+  class Printer
+    attr_reader :socket
+
+    def initialize(ip, port)
+      @socket = TCPSocket.open(ip, port)
+      @socket.send("\x1b\x40", Socket::MSG_OOB)
+    end
+
+    def self.open(ip, port)
+      printer = new(ip, port)
+    end
+
+    def close
+      @socket.close
+    end
+
+    def print(content, opts={})
+      if opts[:encoding]
+        content = Iconv.iconv("#{opts[:encoding]}//IGNORE","UTF-8//IGNORE", content)[0]
+      end
+      @socket.send(content, Socket::MSG_OOB)
+      cut
+    end
+
+    def print_report(report, opts={})
+      print(report.render, opts)
+    end
+
+    private
+    def send_command(command)
+      @socket.send(command, Socket::MSG_OOB)
+    end
+    
+    def cut
+      #TODO
+      send_command("\n\n\n\n\x1b\x69")
+    end
+  end
+end

data/lib/rescpos/report.rb

@@ -0,0 +1,16 @@
+module Rescpos
+  class Report
+    include ERB::Util
+    include ReportUtil
+
+    def render(opts = {})
+      template = opts[:file] ? File.read(opts[:file]) : opts[:template]
+      unless template
+        template_filename = self.class.to_s.gsub(/Report/, '').underscore
+        template = File.read(File.join(Rescpos.configuration.template_path, "#{template_filename}.escpos.erb"))
+      end
+      erb = ERB.new(template, 0)
+      erb.result(binding)
+    end
+  end
+end

data/lib/rescpos/report_util.rb

@@ -0,0 +1,69 @@
+module Rescpos
+  module ReportUtil
+    FONT_NORMAL = "\x00"
+    FONT_BIG = "\x11"
+
+    def single_splitline
+      text("-" * 42, :font_size => FONT_NORMAL)
+    end
+
+    def double_splitline
+      text("=" * 42, :font_size => FONT_NORMAL)
+    end
+
+    def underline(number)
+      text("_" * number, :font_size => FONT_NORMAL)
+    end
+
+    def chinese(chinese)
+      text = Iconv.iconv("GBK//IGNORE","UTF-8//IGNORE",chinese)
+      text[0]
+    end
+
+    def text(txt, options = {}) 
+      font_size = options[:font_size] || FONT_NORMAL
+      formatted_text = ''
+      formatted_text << fontsize(font_size)
+      formatted_text << grayscale(options[:gray]) if options[:gray]
+      formatted_text << txt if txt
+    end
+    
+    def fontsize(size)
+      "\x1d\x21" << size.to_s
+    end
+
+    def grayscale(value)
+      "\x1b\x6d" << ascii(value)
+    end
+
+    def key_value(label, value)
+      "#{label}: #{value}"
+    end
+
+    def align(format)
+      if format == 'C'
+        return "\x1b\x61\x01"
+      elsif format == 'L'
+        return "\x1b\x61\x00"
+      elsif format == 'R'
+        return "\x1b\x61\x02"
+      end
+    end
+    
+    def table(positions)
+      command = "\x1b\x44"
+      for position in positions
+        command << ascii(position)
+      end
+      command << "\x00"
+    end
+
+    def horizontal_tab
+      "\x09"
+    end
+    
+    def ascii(value)
+      value.to_s.unpack('U')[0].to_s(16)
+    end
+  end
+end

data/lib/rescpos/version.rb

@@ -0,0 +1,3 @@
+module Rescpos
+  VERSION = "0.0.1"
+end

data/lib/rescpos.rb

@@ -0,0 +1,21 @@
+require "erb"
+require "socket"
+
+require "core_ext/string"
+
+require "rescpos/version"
+require "rescpos/printer"
+require "rescpos/report_util"
+require "iconv"
+require "rescpos/configuration"
+require "rescpos/report"
+
+module Rescpos
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/rescpos.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rescpos/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rescpos"
+  s.version     = Rescpos::VERSION
+  s.authors     = ["Tower He"]
+  s.email       = ["towerhe@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A ruby implementation of the Line Thermal Printer ESC/POS Command Specifications.}
+  s.description = %q{Print formatted docs with Winpos WP-800}
+
+  s.rubyforge_project = "rescpos"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/lib/core_ext/string_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe String do
+  it 'underscores the camelized string' do
+    "SimpleTitled".underscore.should == 'simple_titled'
+  end
+end

data/spec/lib/rescpos/configuration_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+class Rails
+  def self.root
+    '/path/to/rails'
+  end
+end
+
+describe Rescpos::Configuration do
+  it "has a default template path app/escposes" do
+    Rescpos.configuration.template_path.should == File.join(Rails.root, "app/escposes")
+  end
+
+  it "could set the path of templates" do
+    Rescpos.configure do |config|
+      config.template_path = "templates"
+    end
+
+    Rescpos.configuration.template_path.should == "templates"
+  end
+end

data/spec/lib/rescpos/printer_spec.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+require 'spec_helper'
+
+class TitledReport < Rescpos::Report
+  attr_reader :title
+
+  def initialize(title = "")
+    @title = title
+  end
+end
+
+module Rescpos
+  describe Printer do
+    before(:each) do
+      TCPSocket.should_receive(:open).with("192.168.1.3", 9100).and_return(socket)
+      socket.should_receive(:send).with("\x1b\x40", Socket::MSG_OOB)
+    end
+
+    let(:socket) { Object.new }
+
+    it "connects to the printer server" do
+      Printer.open("192.168.1.3", 9100)
+    end
+
+    it "prints the a rendered report" do
+      printer = Printer.open("192.168.1.3", 9100)
+
+      socket.should_receive(:send).with("A title", Socket::MSG_OOB)
+      printer.should_receive(:cut)
+      printer.print(TitledReport.new("A title").render(:template => "<%= @title %>"))
+    end
+
+    it "prints the report" do
+      Rescpos.configure do |config|
+        config.template_path = File.join(File.dirname(__FILE__), "../../reports")
+      end
+      printer = Printer.open("192.168.1.3", 9100)
+
+      socket.should_receive(:send).with("A title\n", Socket::MSG_OOB)
+      printer.should_receive(:cut)
+      printer.print_report(TitledReport.new("A title"))
+    end
+  end
+end

data/spec/lib/rescpos/report_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+class TitledReport < Rescpos::Report
+  attr_reader :title
+
+  def initialize(title = '')
+    @title = title
+  end
+end
+
+describe Rescpos::Report do
+  before(:all) do
+    Rescpos.configure do |config|
+      config.template_path = File.join(File.dirname(__FILE__), "../../reports")
+    end
+  end
+
+  after(:all) do
+    Rescpos.instance_variable_set(:@configuration, nil)
+  end
+
+  let(:report) { report = TitledReport.new('A title') }
+
+  it 'renders the report with a string template' do
+    report.render(:template => '<%= @title %>').should == 'A title'
+  end
+
+  it 'renders the report using default template file' do
+    report.render.should == "A title\n"
+  end
+end

data/spec/lib/rescpos/report_util_spec.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+require 'spec_helper'
+
+class ReportUtilTest
+  include Rescpos::ReportUtil
+end
+
+describe ReportUtilTest do
+  before :each do
+    @report_util = ReportUtilTest.new
+  end
+  it "should return a single split line" do
+    @report_util.single_splitline.should == "\x1d\x21\x00" +  "-" * 42
+  end
+
+  it "should return a doubleline" do
+    @report_util.double_splitline.should == "\x1d\x21\x00" + "=" * 42
+  end
+
+  it "should print underline" do
+    @report_util.underline(13).should == "\x1d\x21\x00" + "_" * 13
+  end
+
+  it "should return chinese" do
+    # TODO
+    # @report_util.chinese('菜').should == '\\x{B2CB}'
+  end
+  
+  it "should return a ascii" do 
+    @report_util.ascii(4).should == "34"
+  end
+
+  it "should return a font size" do
+    @report_util.fontsize(ReportUtilTest::FONT_NORMAL).should == "\x1d\x21\x00"
+  end
+
+  it "should return a gray scale" do
+    @report_util.grayscale(4).should == "\x1b\x6d34"
+  end
+
+  it "should return a formmat text" do
+    @report_util.text('abc', {:font_size => ReportUtilTest::FONT_BIG, :gray => 4}).should == "\x1d\x21\x11\x1b\x6d34abc"
+  end
+
+  it "should return a formatted key and value pair" do
+    @report_util.key_value('ab', 4).should == "ab: 4"
+  end
+
+  it "should return a align" do
+    @report_util.align('C').should == "\x1b\x61\x01"
+    @report_util.align('L').should == "\x1b\x61\x00"
+    @report_util.align('R').should == "\x1b\x61\x02"
+  end
+end

data/spec/reports/titled.escpos.erb

@@ -0,0 +1 @@
+<%= @title %>

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'rescpos'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rescpos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tower He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-28 00:00:00.000000000Z
+dependencies: []
+description: Print formatted docs with Winpos WP-800
+email:
+- towerhe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.textile
+- Rakefile
+- examples/escposes/dish_item.escpos.erb
+- examples/print.rb
+- examples/reports/dish_item_report.rb
+- features/printer.feature
+- features/render_report.feature
+- features/step_definitions/.gitkeep
+- features/step_definitions/common_steps.rb
+- features/step_definitions/printer_steps.rb
+- features/step_definitions/report_steps.rb
+- features/support/env.rb
+- lib/core_ext/string.rb
+- lib/rescpos.rb
+- lib/rescpos/configuration.rb
+- lib/rescpos/printer.rb
+- lib/rescpos/report.rb
+- lib/rescpos/report_util.rb
+- lib/rescpos/version.rb
+- rescpos.gemspec
+- spec/lib/core_ext/string_spec.rb
+- spec/lib/rescpos/.gitkeep
+- spec/lib/rescpos/configuration_spec.rb
+- spec/lib/rescpos/printer_spec.rb
+- spec/lib/rescpos/report_spec.rb
+- spec/lib/rescpos/report_util_spec.rb
+- spec/reports/titled.escpos.erb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rescpos
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A ruby implementation of the Line Thermal Printer ESC/POS Command Specifications.
+test_files: []