All files / dsv/base/parse/lib/states skip.js

23.91% Statements 55/230
100% Branches 1/1
0% Functions 0/1
23.91% Lines 55/230

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 2311x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                                                                                                                                                                                                                                                                                               1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2022 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
/* eslint-disable no-underscore-dangle, max-len */
 
'use strict';
 
// MODULES //
 
var logger = require( 'debug' );
var state2enum = require( './state2enum.js' );
 
 
// VARIABLES //
 
var debug = logger( 'state:skip' );
 
// Possible transition states...
var INIT = state2enum[ 'init' ];
var SKIP = state2enum[ 'skip' ];
var SKIPPED_COMMENT = state2enum[ 'skipped_comment' ];
var SKIPPED_FIELD = state2enum[ 'skipped_field' ];
var SKIPPED_ESCAPE = state2enum[ 'skipped_escape' ];
var SKIPPED_QUOTED_FIELD = state2enum[ 'skipped_quoted_field' ];
 
 
// MAIN //
 
/**
* Returns a function for processing a skipped line.
*
* @private
* @param {Parser} parser - parser instance
* @returns {Function} processing function
*/
function processor( parser ) {
	var delimiterLastIndex;
	var newlineLastIndex;
	var commentLastIndex;
	var escapeLastIndex;
	var quoteLastIndex;
	var skipLastIndex;
	var delimiter;
	var newline;
	var comment;
	var quoting;
	var escape;
	var strict;
	var quote;
	var skip;

	commentLastIndex = parser._commentLastIndex;
	comment = parser._comment;

	skipLastIndex = parser._skipLastIndex;
	skip = parser._skip;

	escapeLastIndex = parser._escapeLastIndex;
	escape = parser._escape;

	quoteLastIndex = parser._quoteLastIndex;
	quote = parser._quote;

	delimiterLastIndex = parser._delimiterLastIndex;
	delimiter = parser._delimiter;

	newlineLastIndex = parser._newlineLastIndex;
	newline = parser._newline;

	quoting = parser._quoting;
	strict = parser._strict;

	return next;

	/**
	* Processes a character.
	*
	* @private
	* @param {string} ch - character
	* @returns {void}
	*/
	function next( ch ) {
		var idx = parser._cursor + 1;

		debug( 'Char: %s', ch );

		/*
		* Check for the start of a commented line.
		*
		* ## Notes
		*
		* -   In order for a row to be considered a commented line, the comment sequence must be the first character(s) of the field.
		*/
		if (
			comment &&                                // user specified a comment character sequence, so should check for comments
			idx-commentLastIndex === 0 &&             // only search the first character(s) of the first field
			ch === comment[ commentLastIndex ] &&     // we have a potential comment match
			parser._scan( comment, commentLastIndex ) // we found a match
		) {
			debug( 'Comment.' );
			parser._push( ch )._changeState( SKIPPED_COMMENT );
			return;
		}
		/*
		* Check for the start of a skipped line.
		*
		* ## Notes
		*
		* -   In order for a row to be considered a skipped line, the skip sequence must be the first character(s) of the field.
		*/
		if (
			skip &&                                // user specified a skip character sequence, so should check for skipped lines
			idx-skipLastIndex === 0 &&             // only search the first character(s) of the first field
			ch === skip[ skipLastIndex ] &&        // we have a potential match
			parser._scan( skip, skipLastIndex )    // we found a match
		) {
			debug( 'Skip.' );
			parser._push( ch )._changeState( SKIP );
			return;
		}
		/*
		* Check for an escape character sequence.
		*
		* ## Notes
		*
		* -   An escape sequence escapes the delimiter, newline, and escape sequences in **non-quoted** fields.
		* -   An escape sequence escapes comment and skip sequences in **non-quoted** fields when an escape sequence occurs at the beginning of a record.
		* -   When `doublequote` is `false`, the escape sequence escapes quote sequences within **quoted** fields.
		* -   If not immediately followed by a special character sequence, then the escape sequence has no special meaning.
		*/
		if (
			ch === escape[ escapeLastIndex ] &&     // we have a potential match
			parser._scan( escape, escapeLastIndex ) // we found a match
		) {
			debug( 'Escape.' );
			parser._push( ch )._changeState( SKIPPED_ESCAPE );
			return;
		}
		/*
		* Check for a quote character sequence.
		*
		* ## Notes
		*
		* -   When `quoting` is `true`, in order for a field to be quoted, the quote sequence must be the first character(s) of the field.
		* -   When `quoting` is `false`, quote sequences do **not** have any special meaning, and we process quote sequences as normal field text.
		*/
		if (
			idx-quoteLastIndex === 0 &&           // only search the first character(s) of the field
			ch === quote[ quoteLastIndex ] &&     // we have a potential match
			parser._scan( quote, quoteLastIndex ) // we found a match
		) {
			if ( quoting ) {
				debug( 'Quote.' );
				parser._push( ch )._changeState( SKIPPED_QUOTED_FIELD );
				return;
			}
			// Continue processing until we can transition to a new state:
			parser._push( ch );
			return;
		}
		/**
		* Check for a quote character sequence (non-strict mode).
		*
		* ## Notes
		*
		* -   In non-strict mode, a quote character sequence is allowed to start after whitespace (e.g., `a,  "b",  c`).
		* -   When `quoting` is `true`, in order for a field to be quoted, the quote sequence must be the first character(s) of the field.
		* -   When `quoting` is `false`, quote sequences do **not** have any special meaning, and we process quote sequences as normal field text.
		*/
		if (
			strict === false &&                   // non-strict mode
			ch === quote[ quoteLastIndex ] &&     // we have a potential match
			parser._scan( quote, quoteLastIndex ) // we found a match
		) {
			if ( quoting && parser._isWhitespace( 0, parser._cursor-quoteLastIndex ) ) {
				debug( 'Quote.' );
				parser._push( ch )._changeState( SKIPPED_QUOTED_FIELD );
				return;
			}
			// Continue processing until we can transition to a new state:
			parser._push( ch );
			return;
		}
		/*
		* Check for a field delimiter.
		*/
		if (
			ch === delimiter[ delimiterLastIndex ] &&
			parser._scan( delimiter, delimiterLastIndex )
		) {
			debug( 'Delimiter.' );
			parser._push( ch )._changeState( SKIPPED_FIELD );
			return;
		}
		/*
		* Check for a row separator.
		*/
		if (
			ch === newline[ newlineLastIndex ] &&
			parser._scan( newline, newlineLastIndex )
		) {
			// Rewind the cursor to point to the last character before the newline character sequence:
			debug( 'Newline.' );
			parser._rewind( newlineLastIndex )._changeState( INIT );
			return;
		}
		// Continue processing until we can transition to a new state:
		parser._push( ch );
	}
}
 
 
// EXPORTS //
 
module.exports = processor;