module Niceql::Prettifier
Constants
- BRACKETS
- COMMENT_CONTENT
- INLINE_VERBS
- NEW_LINE_VERBS
- POSSIBLE_INLINER
- SQL_COMMENTS
- SQL_COMMENTS_CLEARED
only newlined comments will be matched
- STRINGS
- VERBS
Public Class Methods
config()
click to toggle source
# File lib/niceql.rb, line 48 def self.config Niceql.config end
prettify_err(err)
click to toggle source
# File lib/niceql.rb, line 53 def self.prettify_err(err) prettify_pg_err( err.to_s ) end
prettify_multiple( sql_multi, colorize = true )
click to toggle source
# File lib/niceql.rb, line 192 def self.prettify_multiple( sql_multi, colorize = true ) sql_multi.split( /(?>#{SQL_COMMENTS})|(\;)/ ).inject(['']) { |queries, pattern| queries.last << pattern queries << '' if pattern == ';' queries }.map!{ |sql| # we were splitting by comments and ;, so if next sql start with comment we've got a misplaced \n\n sql.match?(/\A\s+\z/) ? nil : prettify_sql( sql, colorize ) }.compact.join("\n\n") end
prettify_pg_err(err, original_sql_query = nil)
click to toggle source
prettify_pg_err
parses ActiveRecord::StatementInvalid string, but you may use it without ActiveRecord either way: prettify_pg_err
( err + ānā + sql ) OR prettify_pg_err
( err, sql ) don't mess with original sql query, or prettify_pg_err
will deliver incorrect results
# File lib/niceql.rb, line 79 def self.prettify_pg_err(err, original_sql_query = nil) return err if err[/LINE \d+/].nil? err_line_num = err[/LINE \d+/][5..-1].to_i # start_sql_line = err.lines[3][/(HINT|DETAIL)/] ? 4 : 3 err_body = start_sql_line < err.lines.length ? err.lines[start_sql_line..-1] : original_sql_query&.lines # this means original query is missing so it's nothing to prettify return err unless err_body err_quote = ( err.lines[1][/\.\.\..+\.\.\./] && err.lines[1][/\.\.\..+\.\.\./][3..-4] ) || ( err.lines[1][/\.\.\..+/] && err.lines[1][/\.\.\..+/][3..-1] ) # line[2] is err carret line i.e.: ' ^' # err.lines[1][/LINE \d+:/].length+1..-1 - is a position from error quote begin err_carret_line = err.lines[2][err.lines[1][/LINE \d+:/].length+1..-1] # err line will be painted in red completely, so we just remembering it and use # to replace after paiting the verbs err_line = err_body[err_line_num-1] # when err line is too long postgres quotes it part in double '...' if err_quote err_quote_carret_offset = err_carret_line.length - err.lines[1].index( '...' ) + 3 err_carret_line = ' ' * ( err_line.index( err_quote ) + err_quote_carret_offset ) + "^\n" end err_carret_line = " " + err_carret_line if err_body[0].start_with?(': ') # if mistake is on last string than err_line.last != \n so we need to prepend \n to carret line err_carret_line = "\n" + err_carret_line unless err_line[-1] == "\n" #colorizing verbs and strings err_body = err_body.join.gsub(/#{VERBS}/ ) { |verb| StringColorize.colorize_verb(verb) } .gsub(STRINGS){ |str| StringColorize.colorize_str(str) } #reassemling error message err_body = err_body.lines err_body[err_line_num-1]= StringColorize.colorize_err( err_line ) err_body.insert( err_line_num, StringColorize.colorize_err( err_carret_line ) ) err.lines[0..start_sql_line-1].join + err_body.join end
prettify_sql( sql, colorize = true )
click to toggle source
# File lib/niceql.rb, line 123 def self.prettify_sql( sql, colorize = true ) indent = 0 parentness = [] sql = sql.split( SQL_COMMENTS ).each_slice(2).map{ | sql_part, comment | # remove additional formatting for sql_parts but leave comment intact [sql_part.gsub(/[\s]+/, ' '), # comment.match?(/\A\s*$/) - SQL_COMMENTS gets all comment content + all whitespaced chars around # so this sql_part.length == 0 || comment.match?(/\A\s*$/) checks does the comment starts from new line comment && ( sql_part.length == 0 || comment.match?(/\A\s*$/) ? "\n#{comment[COMMENT_CONTENT]}\n" : comment[COMMENT_CONTENT] ) ] }.flatten.join(' ') sql.gsub!(/ \n/, "\n") sql.gsub!(STRINGS){ |str| StringColorize.colorize_str(str) } if colorize first_verb = true prev_was_comment = false sql.gsub!( /(#{VERBS}|#{BRACKETS}|#{SQL_COMMENTS_CLEARED})/) do |verb| if 'SELECT' == verb indent += config.indentation_base if !config.open_bracket_is_newliner || parentness.last.nil? || parentness.last[:nested] parentness.last[:nested] = true if parentness.last add_new_line = !first_verb elsif verb == '(' next_closing_bracket = Regexp.last_match.post_match.index(')') # check if brackets contains SELECT statement add_new_line = !!Regexp.last_match.post_match[0..next_closing_bracket][/SELECT/] && config.open_bracket_is_newliner parentness << { nested: add_new_line } elsif verb == ')' # this also covers case when right bracket is used without corresponding left one add_new_line = parentness.last.nil? || parentness.last[:nested] indent -= ( parentness.last.nil? ? 2 * config.indentation_base : (parentness.last[:nested] ? config.indentation_base : 0) ) indent = 0 if indent < 0 parentness.pop elsif verb[POSSIBLE_INLINER] # in postgres ORDER BY can be used in aggregation function this will keep it # inline with its agg function add_new_line = parentness.last.nil? || parentness.last[:nested] else add_new_line = verb[/(#{INLINE_VERBS})/].nil? end # !add_new_line && previous_was_comment means we had newlined comment, and now even # if verb is inline verb we will need to add new line with indentation BUT all # inliners match with a space before so we need to strip it verb.lstrip! if !add_new_line && prev_was_comment add_new_line = prev_was_comment unless add_new_line add_indent = !first_verb && add_new_line if verb[SQL_COMMENTS_CLEARED] verb = verb[COMMENT_CONTENT] prev_was_comment = true else first_verb = false prev_was_comment = false end verb = StringColorize.colorize_verb(verb) if !['(', ')'].include?(verb) && colorize subs = ( add_indent ? indent_multiline(verb, indent) : verb) !first_verb && add_new_line ? "\n" + subs : subs end # clear all spaces before newlines, and all whitespaces before string end sql.tap{ |slf| slf.gsub!( /\s+\n/, "\n" ) }.tap{ |slf| slf.gsub!(/\s+\z/, '') } end
Private Class Methods
indent_multiline( verb, indent )
click to toggle source
# File lib/niceql.rb, line 204 def self.indent_multiline( verb, indent ) # if verb.match?(/.\s*\n\s*./) verb.lines.map!{|ln| "#{' ' * indent}" + ln}.join("\n") else "#{' ' * indent}" + verb.to_s end end