3977404970

Build Type

github

Committed by GitHub

Commit Message

Merge bc0cf78f0 into 900a3a039

Pull Request Pull Request #38: Move to xmlbuilder2

Run Details

665 of 740 branches covered (89.86%)

Branch coverage included in aggregate %.

62 of 62 new or added lines in 5 files covered. (100.0%)

9 existing lines in 2 files now uncovered.

3639 of 3848 relevant lines covered (94.57%)

678.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.32

/lib/PDFDriver.js

import Driver from './driver.js'
import PDF from 'pdfkit'
import {Point} from './point.js'

export default class PDFDriver extends Driver {
  /**
   * @param {import('./ast.js').Diagram} diag
   * @param {import('./index.js').DrawOptions} argv
   */
  constructor(diag, argv) {
    super(diag, argv)
    const p = this.props
    this.styles = {
      text: {
        font: p.font,
        fontSize: p.text_size,
        fillColor: p.text_color,
      },
      title: {},
      rung_label: {},
      path: {
        strokeColor: p.line_color,
        lineWidth: p.line_width,
      },
      rung: {
        strokeColor: p.rung_color,
        lineWidth: p.rung_width,
      },
      start: {
        align: 'left',
      },
      end: {
        align: 'right',
      },
      center: {
        font: p.font,
        fontSize: p.text_size,
        fillColor: p.text_color,
        align: 'center',
      },
      open: {
        strokeColor: p.arrow_color,
        lineCap: 'round',
      },
      closed: {
        fillColor: p.arrow_color,
        strokeColor: p.arrow_color,
        drawStyle: 'fillAndStroke',
      },
      dashed: {
        dash: [6, {space: 2}],
      },
      solid: {
        undash: true,
      },
      block: {
        strokeColor: p.block_stroke,
        dash: [2, {space: 1}],
        lineJoin: 'round',
      },
      block_tab: {
        fill: p.block_tab_fill,
        drawStyle: 'fill',
      },
      closed_forward: {},
      open_forward: {},
      closed_back: {},
      open_back: {},
      self: {},
      link: {
        fillColor: 'blue',
        align: 'end',
      },
      version: {
        fillColor: p.text_color,
        align: 'end',
      },
    }

    this.path_count = 0
    this.doc = new PDF({size: [this.width, this.height]})
  }

  /**
   * Apply a css-like set of classes to the current document state
   *
   * @param  {String} klasses Space-separated list of class names
   * @return {object} Extra options that can't be set on doc, to
   *     apply to the draw routine that follows.
   */
  style(klasses) {
    const extras = {}
    if (klasses) {
      klasses.split(' ').forEach(klass => {
        const style = this.styles[klass]
        if (!style) {
          throw new Error(`Unknown class: "${klass}"`)
        }
        Object.keys(style).forEach(key => {
          const val = style[key]
          if (key in this.doc) {
            if (Array.isArray(val)) {
              this.doc[key](...val)
            } else {
              this.doc[key](val)
            }
          } else {
            extras[key] = val
          }
        })
      })
    }
    return extras
  }

  /**
   * @param {import('stream').Writable} outstream
   * @returns {import('stream').Writable}
   */
  draw(outstream) {
    this.doc.pipe(outstream, {end: true})
    super.draw(outstream)
    this.doc.end()
    return outstream
  }

  clear() {
    this.doc.rect(0, 0, this.width, this.height).fill(this.props.background)
  }

  /**
   * @param {import('../package.js')} pjson
   */
  meta(pjson) {
    if (this.diag.title) {
      this.doc.info.Title = this.diag.title
    }
    this.doc.info.Creator = `${pjson.name}: ${pjson.homepage}`
  }

  /**
   * @param {import('../package.js')} pjson
   */
  home_link(pjson) {
    this.doc.save()
    let p = new Point(this.width, this.height).adjust(-5, -5)

    const wh = this.draw_string(p, `v${pjson.version}`, this.style('version'))
    p = p.adjust(-wh[0] - 3, 0)
    const extra = {
      ...this.style('link'),
      link: pjson.homepage,
      underline: 'blue',
      wordCount: 1,
      textWidth: this.doc.widthOfString(pjson.name),
    }
    this.draw_string(p, pjson.name, extra)
    this.doc.restore()
  }

  /**
   * @param {import('./point.js').Point} p Center bottom of the text
   * @param {string} str
   * @param {PDFKit.Mixins.TextOptions} opts
   * @returns {[number, number]} width, height
   */
  draw_string(p, str, opts = {}) {
    const align = opts.align || 'center'
    opts.lineBreak = false

    const w = this.doc.widthOfString(str)
    const h = this.doc.currentLineHeight()
    let dx = 0
    switch (align) {
      case 'center':
        dx = -w / 2
        break
      case 'end':
      case 'right':
        dx = -w
        break
    }
    p = p.adjust(dx, -h)

    this.doc.text(str, p.x, p.y, opts)
    if (opts.underline) {
      this.doc.underline(
        p.x,
        p.y,
        w,
        h,
        // @ts-ignore: go back and rethink PDF option type safety
        {color: opts.underline, ...opts}
      )
    }
    if (opts.link) {
      this.doc.link(p.x, p.y, w, h, opts.link)
    }
    return [w, h]
  }

  /**
   * @param {import('./point.js').Point} p Center
   * @param {string} str
   * @param {string} klasses
   * @param {number} theta
   */
  draw_label(p, str, klasses, theta) {
    if (!str || str.length === 0) {
      return
    }
    const angle = theta * 180 / Math.PI % 360
    this.doc.save()
    if (angle) {
      this.doc.rotate(angle, {origin: [p.x, p.y]})
    }
    this.draw_string(p, str, this.style(`text ${klasses}`))
    this.doc.restore()
  }

  /**
   * @param {number} x
   * @param {number} y
   * @param {number} theta Angle in radians
   * @param {() => void} func All of the things created in the func are
   *   transformed
   */
  transform(x, y, theta, func) {
    this.doc.save()
    if (x || y) {
      this.doc.translate(x, y)
    }
    if (theta) {
      // Clockwise in degrees
      const angle = theta * 180 / Math.PI % 360
      this.doc.rotate(angle, {origin: [0, 0]})
    }
    func.call(this)
    this.doc.restore()
  }

  /**
   * @param {string|(string|import('./point.js').Point)[]} cmds
   * @param {string} klasses
   */
  draw_path(cmds, klasses) {
    const d = super.draw_path(cmds, klasses)

    this.doc.save()
    const extra = this.style(`path ${klasses}`) || {}
    this.doc.path(d)
    switch (extra.drawStyle) {
      case 'fill':
        this.doc.fill()
        break
      case 'fillAndStroke':
        this.doc.fillAndStroke()
        break
      default:
        this.doc.stroke()
        break
    }
    this.doc.restore()
    return ''
  }
}

1	import Driver from './driver.js'	12✔
2	import PDF from 'pdfkit'	12✔
3	import {Point} from './point.js'	12✔
4		12✔
5	export default class PDFDriver extends Driver {	12✔
6	/**	12✔
7	* @param {import('./ast.js').Diagram} diag	12✔
8	* @param {import('./index.js').DrawOptions} argv	12✔
9	*/	12✔
10	constructor(diag, argv) {	12✔
11	super(diag, argv)	4✔
12	const p = this.props	4✔
13	this.styles = {	4✔
14	text: {	4✔
15	font: p.font,	4✔
16	fontSize: p.text_size,	4✔
17	fillColor: p.text_color,	4✔
18	},	4✔
19	title: {},	4✔
20	rung_label: {},	4✔
21	path: {	4✔
22	strokeColor: p.line_color,	4✔
23	lineWidth: p.line_width,	4✔
24	},	4✔
25	rung: {	4✔
26	strokeColor: p.rung_color,	4✔
27	lineWidth: p.rung_width,	4✔
28	},	4✔
29	start: {	4✔
30	align: 'left',	4✔
31	},	4✔
32	end: {	4✔
33	align: 'right',	4✔
34	},	4✔
35	center: {	4✔
36	font: p.font,	4✔
37	fontSize: p.text_size,	4✔
38	fillColor: p.text_color,	4✔
39	align: 'center',	4✔
40	},	4✔
41	open: {	4✔
42	strokeColor: p.arrow_color,	4✔
43	lineCap: 'round',	4✔
44	},	4✔
45	closed: {	4✔
46	fillColor: p.arrow_color,	4✔
47	strokeColor: p.arrow_color,	4✔
48	drawStyle: 'fillAndStroke',	4✔
49	},	4✔
50	dashed: {	4✔
51	dash: [6, {space: 2}],	4✔
52	},	4✔
53	solid: {	4✔
54	undash: true,	4✔
55	},	4✔
56	block: {	4✔
57	strokeColor: p.block_stroke,	4✔
58	dash: [2, {space: 1}],	4✔
59	lineJoin: 'round',	4✔
60	},	4✔
61	block_tab: {	4✔
62	fill: p.block_tab_fill,	4✔
63	drawStyle: 'fill',	4✔
64	},	4✔
65	closed_forward: {},	4✔
66	open_forward: {},	4✔
67	closed_back: {},	4✔
68	open_back: {},	4✔
69	self: {},	4✔
70	link: {	4✔
71	fillColor: 'blue',	4✔
72	align: 'end',	4✔
73	},	4✔
74	version: {	4✔
75	fillColor: p.text_color,	4✔
76	align: 'end',	4✔
77	},	4✔
78	}	4✔
79		4✔
80	this.path_count = 0	4✔
81	this.doc = new PDF({size: [this.width, this.height]})	4✔
82	}	4✔
83		12✔
84	/**	12✔
85	* Apply a css-like set of classes to the current document state	12✔
86	*	12✔
87	* @param {String} klasses Space-separated list of class names	12✔
88	* @return {object} Extra options that can't be set on doc, to	12✔
89	* apply to the draw routine that follows.	12✔
90	*/	12✔
91	style(klasses) {	12✔
92	const extras = {}	728✔
93	if (klasses) {	728✔
94	klasses.split(' ').forEach(klass => {	728✔
95	const style = this.styles[klass]	1,628✔
96	if (!style) {	1,628!
UNCOV 97	throw new Error(`Unknown class: "${klass}"`)	×
98	}	×
99	Object.keys(style).forEach(key => {	1,628✔
100	const val = style[key]	2,964✔
101	if (key in this.doc) {	2,964✔
102	if (Array.isArray(val)) {	2,596✔
103	this.doc[key](...val)	88✔
104	} else {	2,596✔
105	this.doc[key](val)	2,508✔
106	}	2,508✔
107	} else {	2,964✔
108	extras[key] = val	368✔
109	}	368✔
110	})	1,628✔
111	})	728✔
112	}	728✔
113	return extras	728✔
114	}	728✔
115		12✔
116	/**	12✔
117	* @param {import('stream').Writable} outstream	12✔
118	* @returns {import('stream').Writable}	12✔
119	*/	12✔
120	draw(outstream) {	12✔
121	this.doc.pipe(outstream, {end: true})	4✔
122	super.draw(outstream)	4✔
123	this.doc.end()	4✔
124	return outstream	4✔
125	}	4✔
126		12✔
127	clear() {	12✔
128	this.doc.rect(0, 0, this.width, this.height).fill(this.props.background)	4✔
129	}	4✔
130		12✔
131	/**	12✔
132	* @param {import('../package.js')} pjson	12✔
133	*/	12✔
134	meta(pjson) {	12✔
135	if (this.diag.title) {	4✔
136	this.doc.info.Title = this.diag.title	4✔
137	}	4✔
138	this.doc.info.Creator = `${pjson.name}: ${pjson.homepage}`	4✔
139	}	4✔
140		12✔
141	/**	12✔
142	* @param {import('../package.js')} pjson	12✔
143	*/	12✔
144	home_link(pjson) {	12✔
145	this.doc.save()	4✔
146	let p = new Point(this.width, this.height).adjust(-5, -5)	4✔
147		4✔
148	const wh = this.draw_string(p, `v${pjson.version}`, this.style('version'))	4✔
149	p = p.adjust(-wh[0] - 3, 0)	4✔
150	const extra = {	4✔
151	...this.style('link'),	4✔
152	link: pjson.homepage,	4✔
153	underline: 'blue',	4✔
154	wordCount: 1,	4✔
155	textWidth: this.doc.widthOfString(pjson.name),	4✔
156	}	4✔
157	this.draw_string(p, pjson.name, extra)	4✔
158	this.doc.restore()	4✔
159	}	4✔
160		12✔
161	/**	12✔
162	* @param {import('./point.js').Point} p Center bottom of the text	12✔
163	* @param {string} str	12✔
164	* @param {PDFKit.Mixins.TextOptions} opts	12✔
165	* @returns {[number, number]} width, height	12✔
166	*/	12✔
167	draw_string(p, str, opts = {}) {	12✔
168	const align = opts.align \|\| 'center'	268✔
169	opts.lineBreak = false	268✔
170		268✔
171	const w = this.doc.widthOfString(str)	268✔
172	const h = this.doc.currentLineHeight()	268✔
173	let dx = 0	268✔
174	switch (align) {	268✔
175	case 'center':	268✔
176	dx = -w / 2	80✔
177	break	80✔
178	case 'end':	268✔
179	case 'right':	268✔
180	dx = -w	40✔
181	break	40✔
182	}	268✔
183	p = p.adjust(dx, -h)	268✔
184		268✔
185	this.doc.text(str, p.x, p.y, opts)	268✔
186	if (opts.underline) {	268✔
187	this.doc.underline(	4✔
188	p.x,	4✔
189	p.y,	4✔
190	w,	4✔
191	h,	4✔
192	// @ts-ignore: go back and rethink PDF option type safety	4✔
193	{color: opts.underline, ...opts}	4✔
194	)	4✔
195	}	4✔
196	if (opts.link) {	268✔
197	this.doc.link(p.x, p.y, w, h, opts.link)	4✔
198	}	4✔
199	return [w, h]	268✔
200	}	268✔
201		12✔
202	/**	12✔
203	* @param {import('./point.js').Point} p Center	12✔
204	* @param {string} str	12✔
205	* @param {string} klasses	12✔
206	* @param {number} theta	12✔
207	*/	12✔
208	draw_label(p, str, klasses, theta) {	12✔
209	if (!str \|\| str.length === 0) {	260!
UNCOV 210	return	×
211	}	×
212	const angle = theta * 180 / Math.PI % 360	260✔
213	this.doc.save()	260✔
214	if (angle) {	260✔
215	this.doc.rotate(angle, {origin: [p.x, p.y]})	8✔
216	}	8✔
217	this.draw_string(p, str, this.style(`text ${klasses}`))	260✔
218	this.doc.restore()	260✔
219	}	260✔
220		12✔
221	/**	12✔
222	* @param {number} x	12✔
223	* @param {number} y	12✔
224	* @param {number} theta Angle in radians	12✔
225	* @param {() => void} func All of the things created in the func are	12✔
226	* transformed	12✔
227	*/	12✔
228	transform(x, y, theta, func) {	12✔
229	this.doc.save()	184✔
230	if (x \|\| y) {	184!
231	this.doc.translate(x, y)	184✔
232	}	184✔
233	if (theta) {	184✔
234	// Clockwise in degrees	112✔
235	const angle = theta * 180 / Math.PI % 360	112✔
236	this.doc.rotate(angle, {origin: [0, 0]})	112✔
237	}	112✔
238	func.call(this)	184✔
239	this.doc.restore()	184✔
240	}	184✔
241		12✔
242	/**	12✔
243	* @param {string\|(string\|import('./point.js').Point)[]} cmds	12✔
244	* @param {string} klasses	12✔
245	*/	12✔
246	draw_path(cmds, klasses) {	12✔
247	const d = super.draw_path(cmds, klasses)	460✔
248		460✔
249	this.doc.save()	460✔
250	const extra = this.style(`path ${klasses}`) \|\| {}	460!
251	this.doc.path(d)	460✔
252	switch (extra.drawStyle) {	460✔
253	case 'fill':	460✔
254	this.doc.fill()	44✔
255	break	44✔
256	case 'fillAndStroke':	460✔
257	this.doc.fillAndStroke()	100✔
258	break	100✔
259	default:	460✔
260	this.doc.stroke()	316✔
261	break	316✔
262	}	460✔
263	this.doc.restore()	460✔
264	return ''	460✔
265	}	460✔
266	}	12✔

hildjj / quence / 3977404970

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous