Class Barby::SvgOutputter
In: lib/barby/outputter/svg_outputter.rb
Parent: Outputter
EAN13 Bookland EAN8 Barcode1D Code128 Code25 Code93 Code39 Barcode Barcode2D QrCode Pdf417 Code128A Code128B Code128C GS1128 Outputter CairoOutputter PngOutputter ASCIIOutputter PDFWriterOutputter RmagickOutputter PrawnOutputter SvgOutputter Code25IATA Code25Interleaved lib/barby/barcode/gs1_128.rb lib/barby/outputter/png_outputter.rb lib/barby/outputter/svg_outputter.rb lib/barby/outputter/rmagick_outputter.rb lib/barby/barcode.rb lib/barby/outputter/ascii_outputter.rb lib/barby/outputter.rb lib/barby/barcode/code_128.rb lib/barby/barcode/code_39.rb lib/barby/outputter/pdfwriter_outputter.rb lib/barby/barcode/code_93.rb lib/barby/outputter/prawn_outputter.rb lib/barby/barcode/pdf_417.rb lib/barby/barcode/ean_8.rb lib/barby/barcode/code_25_iata.rb lib/barby/outputter/cairo_outputter.rb lib/barby/barcode/ean_13.rb lib/barby/barcode/code_25.rb lib/barby/barcode/code_25_interleaved.rb lib/barby/barcode/qr_code.rb lib/barby/barcode/bookland.rb VERSION Barby dot/m_22_0.png

Renders the barcode to a simple SVG image using pure ruby

Registers the to_svg, bars_to_path, and bars_to_rects method

Bars can be rendered as a stroked path or as filled rectangles. Path generally yields smaller files, but this doesn‘t render cleanly in Firefox 3 for odd xdims. My guess is that the renderer tries to put half a pixel on one side of the path and half on the other, leading to fuzzy dithering instead of sharp, clean b&w.

Therefore, default behavior is to use a path for even xdims, and rectangles for odd. This can be overridden by calling with explicit :use => ‘rects’ or :use => ‘path’ options.

Methods

_margin   _xmargin   _ymargin   bars_to_path   bars_to_path_data   bars_to_rects   bmargin   escape   full_height   full_width   height   length   lmargin   margin   rmargin   svg_height   svg_width   title   tmargin   to_svg   transform   width   xdim   xmargin   ydim   ymargin  

Attributes

bmargin  [W] 
height  [W] 
lmargin  [W] 
margin  [W] 
rmargin  [W] 
title  [W] 
tmargin  [W] 
xdim  [W] 
xmargin  [W] 
ydim  [W] 
ymargin  [W] 

Public Instance methods

bars_to_path(opts={})

[Source]

    # File lib/barby/outputter/svg_outputter.rb, line 85
85:     def bars_to_path(opts={})
86:       with_options opts do
87:         %Q|<path stroke="black" stroke-width="#{xdim}" d="#{bars_to_path_data(opts)}" />|
88:       end
89:     end
bars_to_path_data(opts={})

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 92
 92:     def bars_to_path_data(opts={})
 93:       path_data = ''
 94:       with_options opts do
 95:         x, y = lmargin+(xdim/2), tmargin
 96: 
 97:         if barcode.two_dimensional?
 98:           booleans.each do |line|
 99:             line.each do |bar|
100:               if bar
101:                 path_data << "M#{x} #{y}V #{y+ydim}"
102:               end
103:               x += xdim
104:             end
105:             y += ydim
106:             x = lmargin+(xdim/2)
107:           end
108: 
109:         else
110:           booleans.each do |bar|
111:             if bar
112:               path_data << "M#{x} #{y}V#{y+height}"
113:             end
114:             x += xdim
115:           end
116: 
117:         end
118:       end # with_options
119: 
120:       path_data
121:     end
bars_to_rects(opts={})

[Source]

    # File lib/barby/outputter/svg_outputter.rb, line 51
51:     def bars_to_rects(opts={})
52:       rects = ''
53:       with_options opts do
54:         x, y = lmargin, tmargin
55: 
56:         if barcode.two_dimensional?
57:           boolean_groups.each do |line|
58:             line.each do |bar, amount|
59:               bar_width = xdim * amount
60:               if bar
61:                 rects << %Q|<rect x="#{x}" y="#{y}" width="#{bar_width}px" height="#{ydim}px" />\n|
62:               end
63:               x += bar_width
64:             end
65:             y += ydim
66:             x = lmargin
67:           end
68: 
69:         else
70:           boolean_groups.each do |bar, amount|
71:             bar_width = xdim * amount
72:             if bar
73:               rects << %Q|<rect x="#{x}" y="#{y}" width="#{bar_width}px" height="#{height}px" />\n|
74:             end
75:             x += bar_width
76:           end
77: 
78:         end
79:       end # with_options
80: 
81:       rects
82:     end
bmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 165
165:     def bmargin
166:       @bmargin || _ymargin
167:     end
full_height()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 141
141:     def full_height
142:       height + tmargin + bmargin
143:     end
full_width()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 137
137:     def full_width
138:       width + lmargin + rmargin
139:     end
height()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 133
133:     def height
134:       barcode.two_dimensional? ? (ydim * encoding.length) : (@height || 100)
135:     end
length()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 184
184:     def length
185:       barcode.two_dimensional? ? encoding.first.length : encoding.length
186:     end
lmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 153
153:     def lmargin
154:       @lmargin || _xmargin
155:     end
margin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 179
179:     def margin
180:       return nil if @ymargin || @xmargin || @tmargin || @bmargin || @lmargin || @rmargin
181:       _margin
182:     end
rmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 157
157:     def rmargin
158:       @rmargin || _xmargin
159:     end
svg_height(opts={})

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 193
193:     def svg_height(opts={})
194:       opts[:rot] ? full_width : full_height
195:     end
svg_width(opts={})

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 189
189:     def svg_width(opts={})
190:       opts[:rot] ? full_height : full_width
191:     end
title()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 124
124:     def title
125:       @title || barcode.to_s
126:     end
tmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 161
161:     def tmargin
162:       @tmargin || _ymargin
163:     end
to_svg(opts={})

[Source]

    # File lib/barby/outputter/svg_outputter.rb, line 25
25:     def to_svg(opts={})
26:       with_options opts do
27:         case opts[:use]
28:           when 'rects' then bars = bars_to_rects
29:           when 'path'  then bars = bars_to_path
30:         else
31:           xdim_odd = (xdim % 2 == 1)
32:           bars = xdim_odd ? bars_to_rects : bars_to_path
33:         end
34: 
35:         "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"\#{svg_width(opts)}px\" height=\"\#{svg_height(opts)}px\" viewBox=\"0 0 \#{svg_width(opts)} \#{svg_height(opts)}\" version=\"1.1\">\n<title>\#{escape title}</title>\n<g id=\"canvas\" \#{transform(opts)}>\n<rect x=\"0\" y=\"0\" width=\"\#{full_width}px\" height=\"\#{full_height}px\" fill=\"white\" />\n<g id=\"barcode\" fill=\"black\">\n\#{bars}\n</g></g>\n</svg>\n"
36:       end
37:     end
transform(opts={})

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 198
198:     def transform(opts={})
199:       opts[:rot] ? %Q|transform="rotate(-90) translate(-#{full_width}, 0)"| : nil
200:     end
width()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 129
129:     def width
130:       length * xdim
131:     end
xdim()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 145
145:     def xdim
146:       @xdim || 1
147:     end
xmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 169
169:     def xmargin
170:       return nil if @lmargin || @rmargin
171:       _margin
172:     end
ydim()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 149
149:     def ydim
150:       @ydim || xdim
151:     end
ymargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 174
174:     def ymargin
175:       return nil if @tmargin || @bmargin
176:       _margin
177:     end

Private Instance methods

_margin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 213
213:     def _margin
214:       @margin || 10
215:     end
_xmargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 205
205:     def _xmargin
206:       @xmargin || _margin
207:     end
_ymargin()

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 209
209:     def _ymargin
210:       @ymargin || _margin
211:     end
escape(str)

Escape XML special characters <, & and >

[Source]

     # File lib/barby/outputter/svg_outputter.rb, line 218
218:     def escape(str)
219:       str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
220:     end

[Validate]