niceql 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27f3ce5a573a6fa12858d8ab31254dc1f230a12f
-  data.tar.gz: ea0392deadddf634888a663e7770da9ed89e47b5
+  metadata.gz: 340c6606042dc38f152d064b26ca01be534bf454
+  data.tar.gz: 39f96a56add99895bcadc8491918d8dca0491e7a
 SHA512:
-  metadata.gz: 3018c15653659c8a2bebe7c853c671633194e2be0bb24f5fd7e486b784b227998aa5f95d118821183080912197adf9c10bd22d454d8c54b1c5846d099118a026
-  data.tar.gz: 931f9a384176b17e941c5f802705adb62a0889c645d30c7e3deb1bde2d583bf1d9faa0fe96e57deb7b41909abb3218b94f2aff0cf6f0ae153c18ecf432013c61
+  metadata.gz: 82768c5e9b46831390e44e0eacf75d3121ca0b6c809526e63ffa32299a0968fea3295e5d0b446a407768f46415a908468db0119f429d0098b9bcfc41ae144f27
+  data.tar.gz: d303f5804a27a2ada8d922186ae834c956e9a5bfcdb9a27427e3eecdd79a3ec401e56bba7238eb4bca5934904a9e914e39591c7c940462e969908cc17b541ca7

data/README.md

@@ -34,6 +34,39 @@ Or install it yourself as:
 
     $ gem install niceql
 
+## Configuration
+
+```ruby
+Niceql.configure do |c|
+  # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
+  # before executing them, this will lead to better SQL-query debugging and much more clearer error messages 
+  # if you are using Postgresql as a data source.  
+  # You can adjust pg_adapter in prooduction but do it at your own risk!
+  # If you need to debug SQL queries in production use exec_niceql
+  # default: false
+  # uncomment next string to enable in development
+  # c.pg_adapter_with_nicesql = Rails.env.development?
+  
+  # spaces count for one indentation
+  c.indentation_base = 2
+  
+  # setting open_bracket_is_newliner to true will start opening brackets '(' with nested subqueries from new line 
+  # i.e. SELECT * FROM ( SELECT * FROM tags ) tags; will transform to: 
+  # SELECT * 
+  # FROM 
+  # ( 
+ #    SELECT * FROM tags 
+ #  ) tags; 
+ # when open_bracket_is_newliner is false: 
+  # SELECT * 
+  # FROM ( 
+ #   SELECT * FROM tags 
+ # ) tags; 
+ # default: false
+  c.open_bracket_is_newliner = false
+end
+```
+
 ## Usage
 
 ### With ActiveRecord
@@ -42,13 +75,11 @@ Or install it yourself as:
   # puts colorized ( or not if you are willing so ) to_niceql ( you need to call puts otherwise to_niceql looks ugly  )
   Model.scope.niceql
   
-  # only formatting without colorization can run as a SQL query in connection.execute  
+  # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
   Model.scope.to_niceql
   
-  # prettify PG errors 
+  # prettify PG errors if scope runs with any 
   Model.scope_with_err.exec_niceql 
-  
-  
 ```
 
 ### Without ActiveRecord
@@ -85,13 +116,16 @@ ERR
 #     ORDER BY 1
 
 ```
-## Limitations
-
-Right now gem detects only uppercased form of verbs with very simple indentation and parsing options. 
 
 ## Customizing colors
 If your console support more colors or different schemes, or if you prefer different colorization, then you can override ColorizeString methods. Current colors are selected with dark and white console themes in mind, so a niceql colorization works good for dark, and good enough for white.
 
+## Limitations
+
+Right now gem detects only uppercased form of verbs with simple indentation and parsing options. 
+
+## 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/niceql.

data/lib/generators/templates/niceql_initializer.rb

@@ -3,4 +3,6 @@ Niceql.configure do |c|
   # If you need it in production use exec_niceql
   # default: false
   # c.pg_adapter_with_nicesql = Rails.env.development?
+  # c.indentation_base = 2
+  # c.open_bracket_is_newliner = false
 end

data/lib/niceql/version.rb

@@ -1,3 +1,3 @@
 module Niceql
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/lib/niceql.rb

@@ -19,11 +19,7 @@ module Niceql
 
   module ArExtentions
     def exec_niceql
-      begin
-        connection.execute( to_niceql )
-      rescue StandardError => e
-        raise e.class.new( Prettifier.prettify_err(e ) )
-      end
+      connection.execute( to_niceql )
     end
 
     def to_niceql
@@ -33,21 +29,25 @@ module Niceql
     def niceql( colorize = true )
       puts Prettifier.prettify_sql( to_sql, colorize )
     end
+
   end
 
   module Prettifier
-    INLINE_VERBS = %w(ASC IN AS WHEN THEN ELSE END AND UNION ALL WITH ON DISTINCT INTERSECT EXCEPT EXISTS NOT COUNT).join('| ')
-    NEW_LINE_VERBS = 'SELECT|FROM|WHERE|CASE|ORDER BY|LIMIT|GROUP BY|WITH|LEFT JOIN|RIGHT JOIN|JOIN|HAVING|OFFSET'
+    INLINE_VERBS = %w(WITH ASC IN COALESCE AS WHEN THEN ELSE END AND UNION ALL WITH ON DISTINCT INTERSECT EXCEPT EXISTS NOT COUNT ROUND CAST).join('| ')
+    NEW_LINE_VERBS = 'SELECT|FROM|WHERE|CASE|ORDER BY|LIMIT|GROUP BY|LEFT JOIN|RIGHT JOIN|JOIN|HAVING|OFFSET|UPDATE'
+    POSSIBLE_INLINER = /(ORDER BY|CASE)/
     VERBS = "#{INLINE_VERBS}|#{NEW_LINE_VERBS}"
     STRINGS = /("[^"]+")|('[^']+')/
     BRACKETS = '[\(\)]'
 
+
+    def self.config
+      Niceql.config
+    end
+
+
     def self.prettify_err(err)
-      if ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
-        prettify_pg_err( err.to_s )
-      else
-        err
-      end
+      prettify_pg_err( err.to_s )
     end
 
 
@@ -59,8 +59,8 @@ module Niceql
       err_quote = ( err.lines[1][/\.\.\..+\.\.\./] && err.lines[1][/\.\.\..+\.\.\./][3..-4] ) ||
           ( err.lines[1][/\.\.\..+/] && err.lines[1][/\.\.\..+/][3..-1] )
 
-
       # line 2 is err carret line
+      # 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
       # to replace after paiting the verbs
@@ -69,11 +69,11 @@ module Niceql
       # when err line is too long postgres quotes it part in doble ...
       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 )
+        err_carret_line =  ' ' * ( err_line.index( err_quote ) + err_quote_carret_offset ) + "^\n"
       end
 
       # if mistake is on last string than err_line.last != \n so we need to prepend \n to carret line
-      err_line = ( err_line.last == "\n" ? err_line + "\n" : "\n" + err_line )
+      err_carret_line = "\n" + err_carret_line unless err_line.last == "\n"
 
       #colorizing verbs and strings
       err_body = err_body.join.gsub(/#{VERBS}/ ) { |verb| StringColorize.colorize_verb(verb) }
@@ -91,32 +91,38 @@ 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(/[ ]+/, ' ')
+
       sql = sql.gsub(STRINGS){ |str| StringColorize.colorize_str(str) } if colorize
       first_verb  = true
 
-      sql.gsub( /(#{VERBS}|#{BRACKETS})/) do |verb|
+      sql.gsub( /(#{VERBS}|#{BRACKETS})/).with_index do |verb, index|
         add_new_line = false
         if 'SELECT' == verb
-          indent += 1
+          indent += config.indentation_base if parentness.last.nil? || parentness.last[:nested]
           parentness.last[:nested] = true if parentness.last
           add_new_line = !first_verb
-          first_verb = false
         elsif verb == '('
-          parentness << { nested: false }
-          indent += 1
+          next_closing_bracket = Regexp.last_match.post_match.index(')')
+          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 -= add_new_line ? 2 : 1
+          indent -= ( parentness.last.nil? ? 2 * config.indentation_base : (parentness.last[:nested] ? config.indentation_base : 0) )
           indent = 0 if indent < 0
           parentness.pop
-        elsif verb == 'ORDER BY'
+        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
+        first_verb = false
         verb = StringColorize.colorize_verb(verb) if !['(', ')'].include?(verb) && colorize
         add_new_line ? "\n#{' ' * indent}" + verb : verb
       end
@@ -125,35 +131,51 @@ module Niceql
 
   module PostgresAdapterNiceQL
     def exec_query(sql, name = "SQL", binds = [], prepare: false)
-      begin
-        # replacing sql with prettified sql, thats all
-        super( Prettifier.prettify_sql(sql, false), name, binds, prepare: prepare )
-      rescue StandardError => e
-        raise e.class.new( Prettifier.prettify_err(e ) )
+      # replacing sql with prettified sql, thats all
+      super( Prettifier.prettify_sql(sql, false), name, binds, prepare: prepare )
+    end
+  end
+
+  module ErrorExt
+    def to_s
+      if ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+        Prettifier.prettify_err( super )
+      else
+        super
       end
     end
   end
 
   class NiceQLConfig
     attr_accessor :pg_adapter_with_nicesql
+
+    attr_accessor :indentation_base
+
+    attr_accessor :open_bracket_is_new_liner
+
     def initialize
       self.pg_adapter_with_nicesql = false
+      self.indentation_base = 2
+      self.open_bracket_is_new_liner = false
     end
   end
 
 
   def self.configure
-    @config ||= NiceQLConfig.new
-
-    yield( @config )
+    yield( config )
 
-    if @config.pg_adapter_with_nicesql
+    if config.pg_adapter_with_nicesql
       ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL)
     end
   end
 
+  def self.config
+    @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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niceql
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - alekseyl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler