pg_query 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648434f9fd8c17f87a1797af0a71295d9fe7a2bf
-  data.tar.gz: a4c16fed44f8930d6c1218e964372d37e79ff5ff
+  metadata.gz: f75ea93d3521a2b9f912943357d6b16e3598bbea
+  data.tar.gz: f320d5689ceda9ba637d751bf10e4f09d8dddaae
 SHA512:
-  metadata.gz: 0c31153f12613c9e90db0ff1fa4024c073d6f4b0f24cbd0194b35c8d00706e3622d46c913239c94990eab7649c753c2427cbff252baa0afe3dda1f62c75fa690
-  data.tar.gz: 2a83a4e86349133ba7760ba2d7a546bff22b431798326021aa94ec287c7b0871fed0b51a8dd9188917ae9d709e23025406074bec90043e0750994b5b2d4f7f21
+  metadata.gz: 2007ca5cea466541823b11818ba6ba9b86cdf447e3f449024a790b8ebfbf8a9762dfefc82e0e9abb6e96c42e5a3602c4c7bf7ed479aa431666f078f503911a7f
+  data.tar.gz: 687b67153015d9e3e36053a6ffc4e7c558cec3f4ca7eac3860188c0d88a72b41a38d57dcae0e02deb11535f3b8e2f499789fc1ad9281e1da8365c7d9a421e308

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.6.4    UNRELEASED
+
+* ...
+
+
+## 0.6.3    2015-08-20
+
+* Deparsing
+  * COUNT(*) [@JackDanger](https://github.com/JackDanger)
+  * Window clauses [Chris Martin](https://github.com/cmrtn)
+  * CREATE TABLE/VIEW/FUNCTION [@JackDanger](https://github.com/JackDanger)
+* Return exact location for parser errors [@JackDanger](https://github.com/JackDanger)
+
+
 ## 0.6.2    2015-08-06
 
 * Speed up gem install by not generating rdoc/ri for the Postgres source

data/README.md

@@ -1,4 +1,4 @@
-# pg_query [ ![](https://img.shields.io/gem/v/pg_query.svg)](https://rubygems.org/gems/pg_query) [ ![](https://img.shields.io/gem/dt/pg_query.svg)](https://rubygems.org/gems/pg_query) [ ![Codeship Status for lfittl/dblint](https://img.shields.io/codeship/584524e0-ed17-0131-838b-4216c01ccc74.svg)](https://codeship.com/projects/26651)
+# pg_query [ ![](https://img.shields.io/gem/v/pg_query.svg)](https://rubygems.org/gems/pg_query) [ ![](https://img.shields.io/gem/dt/pg_query.svg)](https://rubygems.org/gems/pg_query) [ ![](https://travis-ci.org/lfittl/pg_query.svg?branch=master)](https://travis-ci.org/lfittl/pg_query)
 
 This Ruby extension uses the actual PostgreSQL server source to parse SQL queries and return the internal PostgreSQL parsetree.
 
@@ -157,6 +157,7 @@ PgQuery.parse("SELECT 2; --- comment").fingerprint
 **This gem uses a [patched version of the latest PostgreSQL stable](https://github.com/pganalyze/postgres/compare/REL9_4_STABLE...pg_query).**
 
 Changes:
+
 * **scan.l/gram.y:** Modified to support parsing normalized queries
  * Known regression: Removed support for custom operators containing "?" (doesn't affect hstore/JSON/geometric operators)
 * **outfuncs_json.c:** Auto-generated outfuncs that outputs a parsetree as JSON (called through nodeToJSONString)
@@ -164,11 +165,16 @@ Changes:
 Unit tests for these patches are inside this library - the tests will break if run against upstream.
 
 
-## Authors
+## Original Author
 
 - [Lukas Fittl](mailto:lukas@fittl.com)
 
 
+## Special Thanks to
+
+- [Jack Danger Canty](https://github.com/JackDanger), for significantly improving deparsing
+
+
 ## License
 
 Copyright (c) 2015, pganalyze Team <team@pganalyze.com><br>

data/ext/pg_query/pg_query_parse.c

@@ -10,15 +10,21 @@
 VALUE new_parse_error(ErrorData* error)
 {
 	VALUE cPgQuery, cParseError;
-	VALUE args[2];
+	VALUE args[4];
 
 	cPgQuery = rb_const_get(rb_cObject, rb_intern("PgQuery"));
 	cParseError = rb_const_get_at(cPgQuery, rb_intern("ParseError"));
 
+	// exception message
 	args[0] = rb_str_new2(error->message);
-	args[1] = INT2NUM(error->cursorpos);
-
-	return rb_class_new_instance(2, args, cParseError);
+	// source of exception (e.g. parse.l)
+	args[1] = rb_str_new2(error->filename);
+	// source of exception (e.g. 104)
+	args[2] = INT2NUM(error->lineno);
+	// char in query at which exception occurred
+	args[3] = INT2NUM(error->cursorpos);
+
+	return rb_class_new_instance(4, args, cParseError);
 }
 
 VALUE pg_query_raw_parse(VALUE self, VALUE input)

data/lib/pg_query/deparse.rb

@@ -22,80 +22,96 @@ class PgQuery
       node = item.values[0]
 
       case type
-      when 'RANGEVAR'
-        deparse_rangevar(node)
+      when 'AEXPR AND'
+        deparse_aexpr_and(node)
+      when 'AEXPR ANY'
+        deparse_aexpr_any(node)
+      when 'AEXPR IN'
+        deparse_aexpr_in(node)
+      when 'AEXPR NOT'
+        deparse_aexpr_not(node)
+      when 'AEXPR OR'
+        deparse_aexpr_or(node)
       when 'AEXPR'
         deparse_aexpr(node)
-      when 'COLUMNREF'
-        deparse_columnref(node)
+      when 'ALIAS'
+        deparse_alias(node)
       when 'A_ARRAYEXPR'
         deparse_a_arrayexp(node)
       when 'A_CONST'
         deparse_a_const(node)
-      when 'A_STAR'
-        deparse_a_star(node)
-      when 'A_INDIRECTION'
-        deparse_a_indirection(node)
       when 'A_INDICES'
         deparse_a_indices(node)
-      when 'ALIAS'
-        deparse_alias(node)
-      when 'PARAMREF'
-        deparse_paramref(node)
-      when 'RESTARGET'
-        deparse_restarget(node, context)
+      when 'A_INDIRECTION'
+        deparse_a_indirection(node)
+      when 'A_STAR'
+        deparse_a_star(node)
+      when 'A_TRUNCATED'
+        '...' # pg_query internal
+      when 'CASE'
+        deparse_case(node)
+      when 'COALESCE'
+        deparse_coalesce(node)
+      when 'COLUMNDEF'
+        deparse_columndef(node)
+      when 'COLUMNREF'
+        deparse_columnref(node)
+      when 'COMMONTABLEEXPR'
+        deparse_cte(node)
+      when 'CONSTRAINT'
+        deparse_constraint(node)
+      when 'CREATEFUNCTIONSTMT'
+        deparse_create_function(node)
+      when 'CREATESTMT'
+        deparse_create_table(node)
+      when 'DEFELEM'
+        deparse_defelem(node)
+      when 'DELETE FROM'
+        deparse_delete_from(node)
       when 'FUNCCALL'
         deparse_funccall(node)
-      when 'RANGEFUNCTION'
-        deparse_range_function(node)
-      when 'AEXPR AND'
-        deparse_aexpr_and(node)
+      when 'FUNCTIONPARAMETER'
+        deparse_functionparameter(node)
+      when 'INSERT INTO'
+        deparse_insert_into(node)
       when 'JOINEXPR'
         deparse_joinexpr(node)
-      when 'SORTBY'
-        deparse_sortby(node)
+      when 'NULLTEST'
+        deparse_nulltest(node)
+      when 'PARAMREF'
+        deparse_paramref(node)
+      when 'RANGEFUNCTION'
+        deparse_range_function(node)
+      when 'RANGESUBSELECT'
+        deparse_rangesubselect(node)
+      when 'RANGEVAR'
+        deparse_rangevar(node)
+      when 'RESTARGET'
+        deparse_restarget(node, context)
+      when 'ROW'
+        deparse_row(node)
       when 'SELECT'
         deparse_select(node)
-      when 'WITHCLAUSE'
-        deparse_with_clause(node)
-      when 'COMMONTABLEEXPR'
-        deparse_cte(node)
-      when 'INSERT INTO'
-        deparse_insert_into(node)
-      when 'UPDATE'
-        deparse_update(node)
+      when 'SORTBY'
+        deparse_sortby(node)
+      when 'SUBLINK'
+        deparse_sublink(node)
+      when 'TRANSACTION'
+        deparse_transaction(node)
       when 'TYPECAST'
         deparse_typecast(node)
       when 'TYPENAME'
         deparse_typename(node)
-      when 'CASE'
-        deparse_case(node)
+      when 'UPDATE'
+        deparse_update(node)
       when 'WHEN'
         deparse_when(node)
-      when 'SUBLINK'
-        deparse_sublink(node)
-      when 'RANGESUBSELECT'
-        deparse_rangesubselect(node)
-      when 'ROW'
-        deparse_row(node)
-      when 'AEXPR IN'
-        deparse_aexpr_in(node)
-      when 'AEXPR NOT'
-        deparse_aexpr_not(node)
-      when 'AEXPR OR'
-        deparse_aexpr_or(node)
-      when 'AEXPR ANY'
-        deparse_aexpr_any(node)
-      when 'NULLTEST'
-        deparse_nulltest(node)
-      when 'TRANSACTION'
-        deparse_transaction(node)
-      when 'COALESCE'
-        deparse_coalesce(node)
-      when 'DELETE FROM'
-        deparse_delete_from(node)
-      when 'A_TRUNCATED'
-        '...' # pg_query internal
+      when 'WINDOWDEF'
+        deparse_windowdef(node)
+      when 'WITHCLAUSE'
+        deparse_with_clause(node)
+      when 'VIEWSTMT'
+        deparse_viewstmt(node)
       else
         fail format("Can't deparse: %s: %s", type, node.inspect)
       end
@@ -122,7 +138,7 @@ class PgQuery
     end
 
     def deparse_a_const(node)
-      node['val'].inspect.gsub('"', '\'')
+      node['val'].inspect.gsub("'", "''").gsub('"', "'")
     end
 
     def deparse_a_star(_node)
@@ -142,7 +158,12 @@ class PgQuery
     end
 
     def deparse_alias(node)
-      node['aliasname']
+      name = node['aliasname']
+      if node['colnames']
+        name + '(' + node['colnames'].join(', ') + ')'
+      else
+        name
+      end
     end
 
     def deparse_paramref(node)
@@ -166,8 +187,41 @@ class PgQuery
     end
 
     def deparse_funccall(node)
+      output = []
+
+      # SUM(a, b)
       args = Array(node['args']).map { |arg| deparse_item(arg) }
-      format('%s(%s)', node['funcname'].join('.'), args.join(', '))
+      # COUNT(*)
+      args << '*' if node['agg_star']
+
+      output << format('%s(%s)', node['funcname'].join('.'), args.join(', '))
+      output << format('OVER (%s)', deparse_item(node['over'])) if node['over']
+
+      output.join(' ')
+    end
+
+    def deparse_windowdef(node)
+      output = []
+
+      if node['partitionClause']
+        output << 'PARTITION BY'
+        output << node['partitionClause'].map do |item|
+          deparse_item(item)
+        end.join(', ')
+      end
+
+      if node['orderClause']
+        output << 'ORDER BY'
+        output << node['orderClause'].map do |item|
+          deparse_item(item)
+        end.join(', ')
+      end
+
+      output.join(' ')
+    end
+
+    def deparse_functionparameter(node)
+      deparse_item(node['argType'])
     end
 
     def deparse_aexpr_in(node)
@@ -234,6 +288,7 @@ class PgQuery
       output = []
       output << deparse_item(node['node'])
       output << 'ASC' if node['sortby_dir'] == 1
+      output << 'DESC' if node['sortby_dir'] == 2
       output.join(' ')
     end
 
@@ -246,12 +301,36 @@ class PgQuery
       output.join(' ')
     end
 
+    def deparse_viewstmt(node)
+      output = []
+      output << 'CREATE'
+      output << 'OR REPLACE' if node['replace']
+
+      persistence = relpersistence(node['view'])
+      output << persistence if persistence
+
+      output << 'VIEW'
+      output << node['view']['RANGEVAR']['relname']
+      output << format('(%s)', node['aliases'].join(', ')) if node['aliases']
+
+      output << 'AS'
+      output << deparse_item(node['query'])
+
+      case node['withCheckOption']
+      when 1
+        output << 'WITH CHECK OPTION'
+      when 2
+        output << 'WITH CASCADED CHECK OPTION'
+      end
+      output.join(' ')
+    end
+
     def deparse_cte(node)
-      output = ''
-      output += node['ctename']
-      output += format('(%s)', node['aliascolnames'].join(', ')) if node['aliascolnames']
-      output += format(' AS (%s)', deparse_item(node['ctequery']))
-      output
+      output = []
+      output << node['ctename']
+      output << format('(%s)', node['aliascolnames'].join(', ')) if node['aliascolnames']
+      output << format('AS (%s)', deparse_item(node['ctequery']))
+      output.join(' ')
     end
 
     def deparse_case(node)
@@ -265,6 +344,65 @@ class PgQuery
       output.join(' ')
     end
 
+    def deparse_columndef(node)
+      output = [node['colname']]
+      output << deparse_item(node['typeName'])
+      if node['constraints']
+        output += node['constraints'].map do |item|
+          deparse_item(item)
+        end
+      end
+      output.join(' ')
+    end
+
+    def deparse_constraint(node)
+      output = []
+      # NOT_NULL -> NOT NULL
+      output << node['contype'].gsub('_', ' ')
+      output << deparse_item(node['raw_expr']) if node['raw_expr']
+      output.join(' ')
+    end
+
+    def deparse_create_function(node)
+      output = []
+      output << 'CREATE FUNCTION'
+
+      arguments = node['parameters'].map { |item| deparse_item(item) }.join(', ')
+
+      output << node['funcname'].first + '(' + arguments + ')'
+
+      output << 'RETURNS'
+      output << deparse_item(node['returnType'])
+      output += node['options'].map { |item| deparse_item(item) }
+
+      output.join(' ')
+    end
+
+    def deparse_create_table(node)
+      output = []
+      output << 'CREATE'
+
+      persistence = relpersistence(node['relation'])
+      output << persistence if persistence
+
+      output << 'TABLE'
+
+      output << deparse_item(node['relation'])
+
+      output << '(' + node['tableElts'].map do |item|
+        deparse_item(item)
+      end.join(', ') + ')'
+
+      if node['inhRelations']
+        output << 'INHERITS'
+        output << '(' + node['inhRelations'].map do |relation|
+          deparse_item(relation)
+        end.join(', ') + ')'
+      end
+
+      output.join(' ')
+    end
+
     def deparse_when(node)
       output = ['WHEN']
       output << deparse_item(node['expr'])
@@ -284,11 +422,12 @@ class PgQuery
     end
 
     def deparse_rangesubselect(node)
-      output = '('
-      output += deparse_item(node['subquery'])
-      output += ')'
-      output += ' ' + node['alias']['ALIAS']['aliasname'] if node['alias']
-      output
+      output = '(' + deparse_item(node['subquery']) + ')'
+      if node['alias']
+        output + ' ' + deparse_item(node['alias'])
+      else
+        output
+      end
     end
 
     def deparse_row(node)
@@ -400,7 +539,7 @@ class PgQuery
     end
 
     def deparse_typecast(node)
-      if deparse_item(node['typeName']) == :boolean
+      if deparse_item(node['typeName']) == 'boolean'
         deparse_item(node['arg']) == "'t'" ? 'true' : 'false'
       else
         deparse_item(node['arg']) + '::' + deparse_typename(node['typeName']['TYPENAME'])
@@ -408,10 +547,50 @@ class PgQuery
     end
 
     def deparse_typename(node)
-      if node['names'] == %w(pg_catalog bool)
-        :boolean
+      output = []
+      output << 'SETOF' if node['setof']
+
+      if node['typmods']
+        arguments = node['typmods'].map do |item|
+          deparse_item(item)
+        end.join(', ')
+      end
+
+      output << deparse_typename_cast(node['names'], arguments)
+
+      output.join(' ')
+    end
+
+    def deparse_typename_cast(names, arguments) # rubocop:disable Metrics/CyclomaticComplexity
+      catalog, type = names
+      # Just pass along any custom types.
+      # (The pg_catalog types are built-in Postgres system types and are
+      #  handled in the case statement below)
+      return names.join('.') if catalog != 'pg_catalog'
+
+      case type
+      when 'bpchar'
+        # char(2) or char(9)
+        "char(#{arguments})"
+      when 'varchar'
+        "varchar(#{arguments})"
+      when 'numeric'
+        # numeric(3, 5)
+        "numeric(#{arguments})"
+      when 'bool'
+        'boolean'
+      when 'int2'
+        'smallint'
+      when 'int4'
+        'int'
+      when 'int8'
+        'bigint'
+      when 'real', 'float4'
+        'real'
+      when 'float8'
+        'double'
       else
-        node['names'].join('.')
+        fail format("Can't deparse type: %s", type)
       end
     end
 
@@ -437,8 +616,8 @@ class PgQuery
       output = []
       output << TRANSACTION_CMDS[node['kind']] || fail(format("Can't deparse TRANSACTION %s", node.inspect))
 
-      if node['options'] && node['options'][0]['DEFELEM']
-        output << node['options'][0]['DEFELEM']['arg']
+      if node['options']
+        output += node['options'].map { |item| deparse_item(item) }
       end
 
       output.join(' ')
@@ -448,6 +627,17 @@ class PgQuery
       format('COALESCE(%s)', node['args'].map { |a| deparse_item(a) }.join(', '))
     end
 
+    def deparse_defelem(node)
+      case node['defname']
+      when 'as'
+        "AS $$#{node['arg'].join("\n")}$$"
+      when 'language'
+        "language #{node['arg']}"
+      else
+        node['arg']
+      end
+    end
+
     def deparse_delete_from(node)
       output = []
       output << deparse_item(node['withClause']) if node['withClause']
@@ -477,5 +667,15 @@ class PgQuery
 
       output.join(' ')
     end
+
+    # The PG parser adds several pieces of view data onto the RANGEVAR
+    # that need to be printed before deparse_rangevar is called.
+    def relpersistence(rangevar)
+      if rangevar['RANGEVAR']['relpersistence'] == 't'
+        'TEMPORARY'
+      elsif rangevar['RANGEVAR']['relpersistence'] == 'u'
+        'UNLOGGED'
+      end
+    end
   end
 end

data/lib/pg_query/parse.rb

@@ -7,7 +7,7 @@ class PgQuery
     begin
       parsetree = JSON.parse(parsetree, max_nesting: 1000)
     rescue JSON::ParserError
-      raise ParseError.new('Failed to parse JSON', -1)
+      raise ParseError.new('Failed to parse JSON', __FILE__, __LINE__, -1)
     end
 
     warnings = []

data/lib/pg_query/parse_error.rb

@@ -1,8 +1,8 @@
 class PgQuery
   class ParseError < ArgumentError
     attr_reader :location
-    def initialize(message, location)
-      super(message)
+    def initialize(message, source_file, source_line, location)
+      super("#{message} (#{source_file}:#{source_line})")
       @location = location
     end
   end

data/lib/pg_query/version.rb

@@ -1,3 +1,3 @@
 class PgQuery
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_query
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Lukas Fittl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler