niceql 0.1.18 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b31c9be70eddb5f04784ebbf6fab44e3bb1cc85
-  data.tar.gz: 96f8941c36a0cad00359bfedf8ec6d4cca4ec4f9
+  metadata.gz: 321c779b1a04b51acd414e9187733f8b50a7ab3d
+  data.tar.gz: 076c67bbf5825fc79df1c49fc99cf75c3e0a4a23
 SHA512:
-  metadata.gz: b98310cb79e34175268cf09e966c27abdb76ecf8ab4e7ad5e66751f7198d397bdae7df8c667181f196ebb04f1046c288b5b8a83e2c5426ce43edb5a5a14e87f7
-  data.tar.gz: e1fc4c8d3277c1961b13e85c14181b7cca4e326909bcb289953156156bb2f3202a343c05937c23102f0aade9b96bb5381cd5b786b48f13054e01bd672f80c337
+  metadata.gz: 8bf9b7cc77e345ea167f2e5bc72ca9628f880641d01cf99f3f18d97ef030f3be1e74112763523ec1699527be2513ad763e043c634c5528a13850e6bf15fec1d1
+  data.tar.gz: 8921f764d6ce823ac4e08143ce45e6c3b1b039163b4adb14e6f809694f10e6e20c089fde455619d6db3c56fe6bcf59ee7e2c949ebf3685c8f4ed273926ce6500

data/.travis.yml

@@ -3,3 +3,4 @@ language: ruby
 rvm:
   - 2.4.4
   - 2.5.1
+  - 2.3.7

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.1.20
+ * Add respect for SQL comments single lined, multi lined, and inline
+ 
+# 0.1.19
+ * add prettify_pg_errors to config - now pg errors prettified output is configurable, 
+   default is true if ActiveRecord::Base defined and db adapter is pg 
+ 
+ * tests for error prettifying 
+
 # 0.1.18
  * add color to logger output
  

data/README.md

@@ -50,9 +50,13 @@ Niceql.configure do |c|
   # c.pg_adapter_with_nicesql = Rails.env.development?
   
   # uncomment next string if you want to log prettified SQL inside ActiveRecord logging. 
-  # Default = false
+  # default: false
   # c.prettify_active_record_log_output = true
   
+  # now error prettifying is configurable
+  # default: defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+  # c.prettify_pg_errors = defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+  
   # spaces count for one indentation
   c.indentation_base = 2
   
@@ -97,10 +101,11 @@ end
    #=>  SELECT * 
    #=>  FROM ( VALUES(1), (2) ) AS tmp
 
-   # rails combines err with query, so don't forget to do it yourself 
-   # to get real nice result you should executeprettified version (i.e. execute( prettified_sql ) !) of query on your DB! 
-   # otherwise you will not get such a nice output
+   # rails combines err with query, so don't forget to do it yourself:
+   puts Niceql::Prettifier.prettify_pg_err( "#{pg_err_output}\n#{sql_query}" )
    
+   # to get real nice result you should execute prettified version (i.e. execute( prettified_sql ) !) of query on your DB! 
+   # otherwise you will not get such a nice output
    puts Niceql::Prettifier.prettify_pg_err(<<-ERR )
 ERROR:  VALUES in FROM must have an alias
 LINE 2:  FROM ( VALUES(1), (2) )

data/lib/niceql/version.rb

@@ -1,3 +1,3 @@
 module Niceql
-  VERSION = "0.1.18"
+  VERSION = "0.1.20"
 end

data/lib/niceql.rb

@@ -39,7 +39,10 @@ module Niceql
     VERBS = "#{NEW_LINE_VERBS}|#{INLINE_VERBS}"
     STRINGS = /("[^"]+")|('[^']+')/
     BRACKETS = '[\(\)]'
-
+    SQL_COMMENTS = /(\s*?--.+\s*)|(\s*?\/\*[^\/\*]*\*\/\s*)/
+    # only newlined comments will be matched
+    SQL_COMMENTS_CLEARED = /(\s*?--.+\s{1})|(\s*$\s*\/\*[^\/\*]*\*\/\s{1})/
+    COMMENT_CONTENT = /[\S]+[\s\S]*[\S]+/
 
     def self.config
       Niceql.config
@@ -51,34 +54,62 @@ module Niceql
     end
 
 
-    def self.prettify_pg_err(err)
+    # Postgres error output:
+    # ERROR:  VALUES in FROM must have an alias
+    # LINE 2: FROM ( VALUES(1), (2) );
+    #              ^
+    # HINT:  For example, FROM (VALUES ...) [AS] foo.
+
+    # May go without HINT or DETAIL:
+    # ERROR:  column "usr" does not exist
+    # LINE 1: SELECT usr FROM users ORDER BY 1
+    #                ^
+
+    # ActiveRecord::StatementInvalid will add original SQL query to the bottom like this:
+    # ActiveRecord::StatementInvalid: PG::UndefinedColumn: ERROR:  column "usr" does not exist
+    # LINE 1: SELECT usr FROM users ORDER BY 1
+    #                ^
+    #: SELECT usr FROM users ORDER BY 1
+
+    # 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
+    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 = err.lines[start_sql_line..-1]
+      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
+      # 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 painted red completly, so we just remembering it and use
+      # 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 doble ...
+      # 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.last == "\n"
+      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) }
-      err_body = err_body.gsub(STRINGS){ |str| StringColorize.colorize_str(str) }
+                     .gsub(STRINGS){ |str| StringColorize.colorize_str(str) }
 
       #reassemling error message
       err_body = err_body.lines
@@ -92,16 +123,21 @@ module Niceql
       indent = 0
       parentness = []
 
-      #it's better to remove all new lines because it will break formatting
-      sql = sql.gsub("\n", ' ')
-      # remove any additional formatting
-      sql = sql.gsub(/[\s]+/, ' ')
+      #it's better to remove all new lines because it will break formatting + remove any additional formatting with many spaces
+      # second map! is add newlines at start and begining for all comments started with new line
+      sql = sql.split( SQL_COMMENTS ).each_slice(2).map{ | crmb, cmmnt |
+        [crmb.gsub(/[\s]+/, ' '),
+         cmmnt && ( cmmnt&.match?(/\A\s*$/) ? "\n" + cmmnt[/[\S]+[\s\S]*[\S]+/] + "\n" : cmmnt[/[\S]+[\s\S]*[\S]+/] ) ]
+      }.flatten.join(' ')
+
+      sql.gsub!(/ \n/, "\n")
+
+      sql.gsub!(STRINGS){ |str| StringColorize.colorize_str(str) } if colorize
 
-      sql = sql.gsub(STRINGS){ |str| StringColorize.colorize_str(str) } if colorize
       first_verb  = true
+      previous_was_comment = false
 
-      sql.gsub( /(#{VERBS}|#{BRACKETS})/).with_index do |verb, index|
-        add_new_line = 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
@@ -124,8 +160,25 @@ module Niceql
           add_new_line = verb[/(#{INLINE_VERBS})/].nil?
         end
         first_verb = false
+
+        verb = verb[COMMENT_CONTENT] if verb[SQL_COMMENTS_CLEARED]
+        # !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
+        # newliners match with a space before so we need to strip it
+        verb.lstrip! if !add_new_line && previous_was_comment
         verb = StringColorize.colorize_verb(verb) if !['(', ')'].include?(verb) && colorize
-        add_new_line ? "\n#{' ' * indent}" + verb : verb
+        (previous_was_comment || add_new_line ? indent_multiline(verb, indent) : verb).tap{ previous_was_comment = !verb.to_s[SQL_COMMENTS_CLEARED].nil? }
+      end
+      sql.gsub( /\s+\n/, "\n" ).gsub(/\s+\z/, '')
+    end
+
+    private
+    def self.indent_multiline( verb, indent )
+      # byebug
+      if verb.match?(/.\n./)
+        verb.lines.map!{|ln| "\n#{' ' * indent}" + ln}.join
+      else
+        "\n#{' ' * indent}" + verb.to_s
       end
     end
   end
@@ -140,7 +193,7 @@ module Niceql
   module AbstractAdapterLogPrettifier
     def log( sql, *args, &block )
       # \n need to be placed because AR log will start with action description + time info.
-      # rescue sql - just to be sure Prettifier didn't break production
+      # rescue sql - just to be sure Prettifier wouldn't break production
       formatted_sql = "\n" + Prettifier.prettify_sql(sql) rescue sql
       super( formatted_sql, *args, &block )
     end
@@ -148,8 +201,8 @@ module Niceql
 
   module ErrorExt
     def to_s
-      if ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
-        Prettifier.prettify_err( super )
+      if Niceql.config.prettify_pg_errors && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+        Prettifier.prettify_err(super)
       else
         super
       end
@@ -160,13 +213,16 @@ module Niceql
     attr_accessor :pg_adapter_with_nicesql,
                   :indentation_base,
                   :open_bracket_is_newliner,
-                  :prettify_active_record_log_output
+                  :prettify_active_record_log_output,
+                  :prettify_pg_errors
+
 
     def initialize
       self.pg_adapter_with_nicesql = false
       self.indentation_base = 2
       self.open_bracket_is_newliner = false
       self.prettify_active_record_log_output = false
+      self.prettify_pg_errors = defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
     end
   end
 
@@ -179,7 +235,11 @@ module Niceql
     end
 
     if config.prettify_active_record_log_output
-      ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(AbstractAdapterLogPrettifier)
+      ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier )
+    end
+
+    if config.prettify_pg_errors
+      ::ActiveRecord::StatementInvalid.include( Niceql::ErrorExt )
     end
   end
 
@@ -187,9 +247,7 @@ module Niceql
     @config ||= NiceQLConfig.new
   end
 
-
   if defined? ::ActiveRecord::Base
-    ActiveRecord::StatementInvalid.include( Niceql::ErrorExt )
     ::ActiveRecord::Base.extend ArExtentions
     [::ActiveRecord::Relation, ::ActiveRecord::Associations::CollectionProxy].each { |klass| klass.send(:include, ArExtentions) }
   end

data/niceql.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
-  spec.add_development_dependency 'differ'
+  spec.add_development_dependency "differ"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niceql
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.20
 platform: ruby
 authors:
 - alekseyl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'This is simple and nice sql prettifier, it splits, indent and colorize
   SQL query and PG error if any '
 email: