pg_query 1.0.2 → 2.0.0

data/lib/pg_query/scan.rb

@@ -0,0 +1,23 @@
+module PgQuery
+  class ScanError < ArgumentError
+    attr_reader :location
+    def initialize(message, source_file, source_line, location)
+      super("#{message} (#{source_file}:#{source_line})")
+      @location = location
+    end
+  end
+
+  def self.scan(query)
+    out, stderr = _raw_scan(query)
+
+    result = PgQuery::ScanResult.decode(out)
+
+    warnings = []
+    stderr.each_line do |line|
+      next unless line[/^WARNING/]
+      warnings << line.strip
+    end
+
+    [result, warnings]
+  end
+end

data/lib/pg_query/treewalker.rb

@@ -1,53 +1,37 @@
-class PgQuery
-  private
+module PgQuery
+  class ParserResult
+    private
 
-  def treewalker!(normalized_parsetree)
-    exprs = normalized_parsetree.dup.map { |e| [e, []] }
+    def treewalker!(tree) # rubocop:disable Metrics/CyclomaticComplexity
+      nodes = [[tree.dup, []]]
 
-    loop do
-      expr, parent_location = exprs.shift
+      loop do
+        parent_node, parent_location = nodes.shift
 
-      if expr.is_a?(Hash)
-        expr.each do |k, v|
-          location = parent_location + [k]
+        case parent_node
+        when Google::Protobuf::MessageExts
+          parent_node.to_h.keys.each do |parent_field|
+            node = parent_node[parent_field.to_s]
+            next if node.nil?
+            location = parent_location + [parent_field]
 
-          yield(expr, k, v, location)
+            yield(parent_node, parent_field, node, location) if node.is_a?(Google::Protobuf::MessageExts) || node.is_a?(Google::Protobuf::RepeatedField)
 
-          exprs << [v, location] unless v.nil?
+            nodes << [node, location] unless node.nil?
+          end
+        when Google::Protobuf::RepeatedField
+          nodes += parent_node.map.with_index { |e, idx| [e, parent_location + [idx]] }
         end
-      elsif expr.is_a?(Array)
-        exprs += expr.map.with_index { |e, idx| [e, parent_location + [idx]] }
-      end
-
-      break if exprs.empty?
-    end
-  end
 
-  def find_tree_location(normalized_parsetree, searched_location)
-    treewalker! normalized_parsetree do |expr, k, v, location|
-      next unless location == searched_location
-      yield(expr, k, v)
+        break if nodes.empty?
+      end
     end
-  end
 
-  def transform_nodes!(parsetree)
-    result = deep_dup(parsetree)
-    exprs = result.dup
-
-    loop do
-      expr = exprs.shift
-
-      if expr.is_a?(Hash)
-        yield(expr) if expr.size == 1 && expr.keys[0][/^[A-Z]+/]
-
-        exprs += expr.values.compact
-      elsif expr.is_a?(Array)
-        exprs += expr
+    def find_tree_location(tree, searched_location)
+      treewalker! tree do |parent_node, parent_field, node, location|
+        next unless location == searched_location
+        yield(parent_node, parent_field, node)
       end
-
-      break if exprs.empty?
     end
-
-    result
   end
 end

data/lib/pg_query/truncate.rb

@@ -1,60 +1,81 @@
-class PgQuery
-  PossibleTruncation = Struct.new(:location, :node_type, :length, :is_array)
 
-  A_TRUNCATED = 'A_Truncated'.freeze
+module PgQuery
+  class ParserResult
+    PossibleTruncation = Struct.new(:location, :node_type, :length, :is_array)
 
-  # Truncates the query string to be below the specified length, first trying to
-  # omit less important parts of the query, and only then cutting off the end.
-  def truncate(max_length)
-    output = deparse(@tree)
+    # Truncates the query string to be below the specified length, first trying to
+    # omit less important parts of the query, and only then cutting off the end.
+    def truncate(max_length) # rubocop:disable Metrics/CyclomaticComplexity
+      output = deparse
 
-    # Early exit if we're already below the max length
-    return output if output.size <= max_length
+      # Early exit if we're already below the max length
+      return output if output.size <= max_length
+
+      truncations = find_possible_truncations
 
-    truncations = find_possible_truncations
+      # Truncate the deepest possible truncation that is the longest first
+      truncations.sort_by! { |t| [-t.location.size, -t.length] }
 
-    # Truncate the deepest possible truncation that is the longest first
-    truncations.sort_by! { |t| [-t.location.size, -t.length] }
+      tree = dup_tree
+      truncations.each do |truncation|
+        next if truncation.length < 3
 
-    tree = deep_dup(@tree)
-    truncations.each do |truncation|
-      next if truncation.length < 3
+        find_tree_location(tree, truncation.location) do |node, _k|
+          dummy_column_ref = PgQuery::Node.new(column_ref: PgQuery::ColumnRef.new(fields: [PgQuery::Node.new(string: PgQuery::String.new(str: '…'))]))
+          case truncation.node_type
+          when :target_list
+            node.target_list.replace(
+              [
+                PgQuery::Node.new(res_target: PgQuery::ResTarget.new(val: dummy_column_ref))
+              ]
+            )
+          when :where_clause
+            node.where_clause = dummy_column_ref
+          when :ctequery
+            node.ctequery = PgQuery::Node.new(select_stmt: PgQuery::SelectStmt.new(where_clause: dummy_column_ref, op: :SETOP_NONE))
+          when :cols
+            node.cols.replace([PgQuery::Node.from(PgQuery::ResTarget.new(name: '…'))])
+          else
+            raise ArgumentError, format('Unexpected truncation node type: %s', truncation.node_type)
+          end
+        end
 
-      find_tree_location(tree, truncation.location) do |expr, k|
-        expr[k] = { A_TRUNCATED => nil }
-        expr[k] = [expr[k]] if truncation.is_array
+        output = PgQuery.deparse(tree).gsub('SELECT WHERE "…"', '...').gsub('"…"', '...')
+        return output if output.size <= max_length
       end
 
-      output = deparse(tree)
-      return output if output.size <= max_length
+      # We couldn't do a proper smart truncation, so we need a hard cut-off
+      output[0..max_length - 4] + '...'
     end
 
-    # We couldn't do a proper smart truncation, so we need a hard cut-off
-    output[0..max_length - 4] + '...'
-  end
-
-  private
+    private
 
-  def find_possible_truncations
-    truncations = []
+    def find_possible_truncations
+      truncations = []
 
-    treewalker! @tree do |_expr, k, v, location|
-      case k
-      when TARGET_LIST_FIELD
-        length = deparse([{ SELECT_STMT => { k => v } }]).size - 7 # 'SELECT '.size
-
-        truncations << PossibleTruncation.new(location, TARGET_LIST_FIELD, length, true)
-      when 'whereClause'
-        length = deparse([{ SELECT_STMT => { k => v } }]).size
-
-        truncations << PossibleTruncation.new(location, 'whereClause', length, false)
-      when 'ctequery'
-        truncations << PossibleTruncation.new(location, 'ctequery', deparse([v]).size, false)
-      when 'cols'
-        truncations << PossibleTruncation.new(location, 'cols', deparse(v).size, true)
+      treewalker! @tree do |_expr, k, v, location|
+        case k
+        when :target_list
+          length = PgQuery.deparse_stmt(PgQuery::SelectStmt.new(k => v.to_a, op: :SETOP_NONE)).size - 7 # 'SELECT '.size
+          truncations << PossibleTruncation.new(location, :target_list, length, true)
+        when :where_clause
+          length = PgQuery.deparse_expr(v).size
+          truncations << PossibleTruncation.new(location, :where_clause, length, false)
+        when :ctequery
+          length = PgQuery.deparse_stmt(v[v.node.to_s]).size
+          truncations << PossibleTruncation.new(location, :ctequery, length, false)
+        when :cols
+          length = PgQuery.deparse_stmt(
+            PgQuery::InsertStmt.new(
+              relation: PgQuery::RangeVar.new(relname: 'x', inh: true),
+              cols: v.to_a
+            )
+          ).size - 31 # "INSERT INTO x () DEFAULT VALUES".size
+          truncations << PossibleTruncation.new(location, :cols, length, true)
+        end
       end
-    end
 
-    truncations
+      truncations
+    end
   end
 end

data/lib/pg_query/version.rb

@@ -1,3 +1,3 @@
-class PgQuery
-  VERSION = '1.0.2'.freeze
+module PgQuery
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_query
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Lukas Fittl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.15.1
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.15.5
 description: Parses SQL queries using a copy of the PostgreSQL server query parser
 email: lukas@fittl.com
 executables: []
@@ -80,25 +94,103 @@ files:
 - README.md
 - Rakefile
 - ext/pg_query/extconf.rb
+- ext/pg_query/guc-file.c
+- ext/pg_query/pg_query.c
+- ext/pg_query/pg_query.pb-c.c
+- ext/pg_query/pg_query_deparse.c
+- ext/pg_query/pg_query_fingerprint.c
+- ext/pg_query/pg_query_fingerprint.h
+- ext/pg_query/pg_query_internal.h
+- ext/pg_query/pg_query_json_plpgsql.c
+- ext/pg_query/pg_query_json_plpgsql.h
+- ext/pg_query/pg_query_normalize.c
+- ext/pg_query/pg_query_outfuncs.h
+- ext/pg_query/pg_query_outfuncs_json.c
+- ext/pg_query/pg_query_outfuncs_protobuf.c
+- ext/pg_query/pg_query_parse.c
+- ext/pg_query/pg_query_parse_plpgsql.c
+- ext/pg_query/pg_query_readfuncs.h
+- ext/pg_query/pg_query_readfuncs_protobuf.c
 - ext/pg_query/pg_query_ruby.c
-- ext/pg_query/pg_query_ruby.h
 - ext/pg_query/pg_query_ruby.sym
+- ext/pg_query/pg_query_scan.c
+- ext/pg_query/pg_query_split.c
+- ext/pg_query/protobuf-c.c
+- ext/pg_query/src_backend_catalog_namespace.c
+- ext/pg_query/src_backend_catalog_pg_proc.c
+- ext/pg_query/src_backend_commands_define.c
+- ext/pg_query/src_backend_libpq_pqcomm.c
+- ext/pg_query/src_backend_nodes_bitmapset.c
+- ext/pg_query/src_backend_nodes_copyfuncs.c
+- ext/pg_query/src_backend_nodes_equalfuncs.c
+- ext/pg_query/src_backend_nodes_extensible.c
+- ext/pg_query/src_backend_nodes_list.c
+- ext/pg_query/src_backend_nodes_makefuncs.c
+- ext/pg_query/src_backend_nodes_nodeFuncs.c
+- ext/pg_query/src_backend_nodes_value.c
+- ext/pg_query/src_backend_parser_gram.c
+- ext/pg_query/src_backend_parser_parse_expr.c
+- ext/pg_query/src_backend_parser_parser.c
+- ext/pg_query/src_backend_parser_scan.c
+- ext/pg_query/src_backend_parser_scansup.c
+- ext/pg_query/src_backend_postmaster_postmaster.c
+- ext/pg_query/src_backend_storage_ipc_ipc.c
+- ext/pg_query/src_backend_storage_lmgr_s_lock.c
+- ext/pg_query/src_backend_tcop_postgres.c
+- ext/pg_query/src_backend_utils_adt_datum.c
+- ext/pg_query/src_backend_utils_adt_expandeddatum.c
+- ext/pg_query/src_backend_utils_adt_format_type.c
+- ext/pg_query/src_backend_utils_adt_ruleutils.c
+- ext/pg_query/src_backend_utils_error_assert.c
+- ext/pg_query/src_backend_utils_error_elog.c
+- ext/pg_query/src_backend_utils_fmgr_fmgr.c
+- ext/pg_query/src_backend_utils_hash_dynahash.c
+- ext/pg_query/src_backend_utils_init_globals.c
+- ext/pg_query/src_backend_utils_mb_mbutils.c
+- ext/pg_query/src_backend_utils_misc_guc.c
+- ext/pg_query/src_backend_utils_mmgr_aset.c
+- ext/pg_query/src_backend_utils_mmgr_mcxt.c
+- ext/pg_query/src_common_encnames.c
+- ext/pg_query/src_common_keywords.c
+- ext/pg_query/src_common_kwlist_d.h
+- ext/pg_query/src_common_kwlookup.c
+- ext/pg_query/src_common_psprintf.c
+- ext/pg_query/src_common_string.c
+- ext/pg_query/src_common_stringinfo.c
+- ext/pg_query/src_common_wchar.c
+- ext/pg_query/src_pl_plpgsql_src_pl_comp.c
+- ext/pg_query/src_pl_plpgsql_src_pl_funcs.c
+- ext/pg_query/src_pl_plpgsql_src_pl_gram.c
+- ext/pg_query/src_pl_plpgsql_src_pl_handler.c
+- ext/pg_query/src_pl_plpgsql_src_pl_reserved_kwlist_d.h
+- ext/pg_query/src_pl_plpgsql_src_pl_scanner.c
+- ext/pg_query/src_pl_plpgsql_src_pl_unreserved_kwlist_d.h
+- ext/pg_query/src_port_erand48.c
+- ext/pg_query/src_port_pg_bitutils.c
+- ext/pg_query/src_port_pgsleep.c
+- ext/pg_query/src_port_pgstrcasecmp.c
+- ext/pg_query/src_port_qsort.c
+- ext/pg_query/src_port_random.c
+- ext/pg_query/src_port_snprintf.c
+- ext/pg_query/src_port_strerror.c
+- ext/pg_query/src_port_strnlen.c
+- ext/pg_query/xxhash.c
 - lib/pg_query.rb
-- lib/pg_query/deep_dup.rb
+- lib/pg_query/constants.rb
 - lib/pg_query/deparse.rb
-- lib/pg_query/deparse/alter_table.rb
-- lib/pg_query/deparse/interval.rb
 - lib/pg_query/filter_columns.rb
 - lib/pg_query/fingerprint.rb
-- lib/pg_query/legacy_parsetree.rb
-- lib/pg_query/node_types.rb
+- lib/pg_query/json_field_names.rb
+- lib/pg_query/node.rb
 - lib/pg_query/param_refs.rb
 - lib/pg_query/parse.rb
 - lib/pg_query/parse_error.rb
+- lib/pg_query/pg_query_pb.rb
+- lib/pg_query/scan.rb
 - lib/pg_query/treewalker.rb
 - lib/pg_query/truncate.rb
 - lib/pg_query/version.rb
-homepage: http://github.com/lfittl/pg_query
+homepage: http://github.com/pganalyze/pg_query
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -121,8 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PostgreSQL query parsing and normalization library

data/ext/pg_query/pg_query_ruby.h

@@ -1,10 +0,0 @@
-#ifndef PG_QUERY_RUBY_H
-#define PG_QUERY_RUBY_H
-
-#include "pg_query.h"
-
-#include <ruby.h>
-
-void Init_pg_query(void);
-
-#endif

data/lib/pg_query/deep_dup.rb

@@ -1,16 +0,0 @@
-class PgQuery
-  def deep_dup(obj)
-    case obj
-    when Hash
-      obj.each_with_object(obj.dup) do |(key, value), hash|
-        hash[deep_dup(key)] = deep_dup(value)
-      end
-    when Array
-      obj.map { |it| deep_dup(it) }
-    when NilClass, FalseClass, TrueClass, Symbol, Numeric
-      obj # Can't be duplicated
-    else
-      obj.dup
-    end
-  end
-end

data/lib/pg_query/deparse/alter_table.rb

@@ -1,42 +0,0 @@
-class PgQuery
-  module Deparse
-    module AlterTable
-      # Returns a list of strings of length one or length two. The first string
-      # will be placed before the column name and the second, if present, will be
-      # placed after.
-      #
-      # If node['subtype'] is the integer 4 (AT_DropNotNull),
-      # then return value of this method will be:
-      #
-      #   ['ALTER COLUMN', 'DROP NOT NULL']
-      #
-      # Which will be composed into the SQL as:
-      #
-      #   ALTER COLUMN {column_name} DROP NOT NULL
-      #
-      def self.commands(node)
-        action = ALTER_TABLE_TYPES_MAPPING[node['subtype']] || raise(format("Can't deparse: %s", node.inspect))
-        PgQuery::Deparse.instance_exec(node, &action)
-      end
-
-      ALTER_TABLE_TYPES_MAPPING = {
-        AT_AddColumn                 => ->(_node) { ['ADD COLUMN'] },
-        AT_ColumnDefault             => ->(node) { ['ALTER COLUMN', node['def'] ? 'SET DEFAULT' : 'DROP DEFAULT'] },
-        AT_DropNotNull               => ->(_node) { ['ALTER COLUMN', 'DROP NOT NULL'] },
-        AT_SetNotNull                => ->(_node) { ['ALTER COLUMN', 'SET NOT NULL'] },
-        AT_SetStatistics             => ->(_node) { ['ALTER COLUMN', 'SET STATISTICS'] },
-        AT_SetOptions                => ->(_node) { ['ALTER COLUMN', 'SET'] },
-        AT_ResetOptions              => ->(_node) { ['ALTER COLUMN', 'RESET'] },
-        AT_SetStorage                => ->(_node) { ['ALTER COLUMN', 'SET STORAGE'] },
-        AT_DropColumn                => ->(_node) { ['DROP'] },
-        AT_AddIndex                  => ->(_node) { ['ADD INDEX'] },
-        AT_AddConstraint             => ->(_node) { ['ADD'] },
-        AT_AlterConstraint           => ->(_node) { ['ALTER CONSTRAINT'] },
-        AT_ValidateConstraint        => ->(_node) { ['VALIDATE CONSTRAINT'] },
-        AT_DropConstraint            => ->(_node) { ['DROP CONSTRAINT'] },
-        AT_AlterColumnType           => ->(_node) { ['ALTER COLUMN', 'TYPE'] },
-        AT_AlterColumnGenericOptions => ->(_node) { ['ALTER COLUMN', 'OPTIONS'] }
-      }.freeze
-    end
-  end
-end