plume 0.1.0 → 0.2.0

data/lib/plume.rb

@@ -1,8 +1,148 @@
 # frozen_string_literal: true
 
-require_relative "plume/version"
+require "plume/version"
+require "literal"
+require "plume/union"
 
 module Plume
-  class Error < StandardError; end
-  # Your code goes here...
+	extend Literal::Types
+	extend Union::Types
+
+	autoload :Lexer, "plume/lexer"
+	autoload :Parser, "plume/parser"
+	autoload :Token, "plume/ast/token"
+	autoload :SQLiteGrammar, "plume/sqlite_grammar"
+	autoload :Catalog, "plume/catalog"
+	autoload :Printer, "plume/printer"
+	autoload :Analysis, "plume/analysis"
+
+	autoload :BinaryExpression, "plume/ast/binary_expression"
+	autoload :ParentheticalExpression, "plume/ast/parenthetical_expression"
+	autoload :CaseCondition, "plume/ast/case_condition"
+	autoload :CaseExpression, "plume/ast/case_expression"
+	autoload :CastExpression, "plume/ast/cast_expression"
+	autoload :CheckColumnConstraint, "plume/ast/check_column_constraint"
+	autoload :CheckTableConstraint, "plume/ast/check_table_constraint"
+	autoload :CollateColumnConstraint, "plume/ast/collate_column_constraint"
+	autoload :CollationExpression, "plume/ast/collation_expression"
+	autoload :ColumnConstraint, "plume/ast/column_constraint"
+	autoload :ColumnDefinition, "plume/ast/column_definition"
+	autoload :ColumnName, "plume/ast/column_name"
+	autoload :ColumnType, "plume/ast/column_type"
+	autoload :ConflictClause, "plume/ast/conflict_clause"
+	autoload :CreateTableStatement, "plume/ast/create_table_statement"
+	autoload :CreateViewStatement, "plume/ast/create_view_statement"
+	autoload :DefaultColumnConstraint, "plume/ast/default_column_constraint"
+	autoload :EmptyFunctionArgument, "plume/ast/empty_function_argument"
+	autoload :Expression, "plume/ast/expression"
+	autoload :ForeignKeyAction, "plume/ast/foreign_key_action"
+	autoload :ForeignKeyClause, "plume/ast/foreign_key_clause"
+	autoload :ForeignKeyColumnConstraint, "plume/ast/foreign_key_column_constraint"
+	autoload :ForeignKeyTableConstraint, "plume/ast/foreign_key_table_constraint"
+	autoload :FrameBoundary, "plume/ast/frame_boundary"
+	autoload :FrameSpec, "plume/ast/frame_spec"
+	autoload :FunctionArguments, "plume/ast/function_arguments"
+	autoload :FunctionReference, "plume/ast/function_reference"
+	autoload :GeneratedAsColumnConstraint, "plume/ast/generated_as_column_constraint"
+	autoload :IndexedColumn, "plume/ast/indexed_column"
+	autoload :JoinOnConstraint, "plume/ast/join_on_constraint"
+	autoload :JoinUsingConstraint, "plume/ast/join_using_constraint"
+	autoload :LikeExpression, "plume/ast/like_expression"
+	autoload :LiteralFalse, "plume/ast/literal_false"
+	autoload :LiteralNil, "plume/ast/literal_nil"
+	autoload :LiteralValue, "plume/ast/literal_value"
+	autoload :MatchClause, "plume/ast/match_clause"
+	autoload :NoOpColumnConstraint, "plume/ast/noop_column_constraint"
+	autoload :NoOpTableConstraint, "plume/ast/noop_table_constraint"
+	autoload :Node, "plume/ast/node"
+	autoload :NotLikeExpression, "plume/ast/not_like_expression"
+	autoload :NotNullColumnConstraint, "plume/ast/not_null_column_constraint"
+	autoload :NullColumnConstraint, "plume/ast/null_column_constraint"
+	autoload :OrderingTerm, "plume/ast/ordering_term"
+	autoload :OverClause, "plume/ast/over_clause"
+	autoload :PrimaryKeyColumnConstraint, "plume/ast/primary_key_column_constraint"
+	autoload :PrimaryKeyTableConstraint, "plume/ast/primary_key_table_constraint"
+	autoload :RaiseExpression, "plume/ast/raise_expression"
+	autoload :ResultColumn, "plume/ast/result_column"
+	autoload :SelectStatement, "plume/ast/select_statement"
+	autoload :StarFunctionArgument, "plume/ast/star_function_argument"
+	autoload :StarResultColumn, "plume/ast/star_result_column"
+	autoload :StrictTableOption, "plume/ast/strict_table_option"
+	autoload :TableConstraint, "plume/ast/table_constraint"
+	autoload :TableName, "plume/ast/table_name"
+	autoload :TableOption, "plume/ast/table_option"
+	autoload :TernaryExpression, "plume/ast/ternary_expression"
+	autoload :UnaryExpression, "plume/ast/unary_expression"
+	autoload :UniqueColumnConstraint, "plume/ast/unique_column_constraint"
+	autoload :UniqueTableConstraint, "plume/ast/unique_table_constraint"
+	autoload :LiteralExpression, "plume/ast/literal_expression"
+	autoload :Variable, "plume/ast/variable"
+	autoload :WithoutRowidTableOption, "plume/ast/without_rowid_table_option"
+	autoload :AlterTableStatement, "plume/ast/alter_table_statement"
+	autoload :AnalyzeStatement, "plume/ast/analyze_statement"
+	autoload :AttachStatement, "plume/ast/attach_statement"
+	autoload :BeginStatement, "plume/ast/begin_statement"
+	autoload :CommitStatement, "plume/ast/commit_statement"
+	autoload :CreateIndexStatement, "plume/ast/create_index_statement"
+	autoload :CreateTriggerStatement, "plume/ast/create_trigger_statement"
+	autoload :CreateVirtualTableStatement, "plume/ast/create_virtual_table_statement"
+	autoload :DetachStatement, "plume/ast/detach_statement"
+	autoload :DropStatement, "plume/ast/drop_statement"
+	autoload :ExplainStatement, "plume/ast/explain_statement"
+	autoload :PragmaStatement, "plume/ast/pragma_statement"
+	autoload :ReindexStatement, "plume/ast/reindex_statement"
+	autoload :ReleaseStatement, "plume/ast/release_statement"
+	autoload :RollbackStatement, "plume/ast/rollback_statement"
+	autoload :SavepointStatement, "plume/ast/savepoint_statement"
+	autoload :VacuumStatement, "plume/ast/vacuum_statement"
+	autoload :Assignment, "plume/ast/assignment"
+	autoload :ConflictResolution, "plume/ast/conflict_resolution"
+	autoload :DeleteStatement, "plume/ast/delete_statement"
+	autoload :InsertStatement, "plume/ast/insert_statement"
+	autoload :ReturningClause, "plume/ast/returning_clause"
+	autoload :UpdateStatement, "plume/ast/update_statement"
+	autoload :UpsertClause, "plume/ast/upsert_clause"
+	autoload :CommonTableExpression, "plume/ast/common_table_expression"
+	autoload :CompoundSelect, "plume/ast/compound_select"
+	autoload :ExistsExpression, "plume/ast/exists_expression"
+	autoload :Join, "plume/ast/join"
+	autoload :JoinClause, "plume/ast/join_clause"
+	autoload :JoinOperator, "plume/ast/join_operator"
+	autoload :ParentheticalSource, "plume/ast/parenthetical_source"
+	autoload :SelectCore, "plume/ast/select_core"
+	autoload :SubqueryExpression, "plume/ast/subquery_expression"
+	autoload :SubquerySource, "plume/ast/subquery_source"
+	autoload :TableFunction, "plume/ast/table_function"
+	autoload :ValuesClause, "plume/ast/values_clause"
+	autoload :ValuesRow, "plume/ast/values_row"
+	autoload :WindowDefinition, "plume/ast/window_definition"
+	autoload :WithClause, "plume/ast/with_clause"
+
+	SyntaxError = Class.new(StandardError)
+
+	def self.tokenize(str, with_values: false, skip_spaces: true)
+		lex = Lexer.new(str, skip_spaces: skip_spaces)
+		[].tap do |tokens|
+			while (token = lex.next_token)
+				tokens << (with_values ? [token, lex.value] : token)
+			end
+		end
+	end
+
+	def self.parse(sql)
+		Parser.new(sql).parse
+	end
+
+	# The line of `sql` holding bytes `beg...fin`, with a caret underneath them
+	def self.excerpt(sql, beg, fin)
+		src = sql.b # positions are byte offsets
+		line_start = (beg.zero? ? nil : src.rindex("\n", beg - 1))&.+(1) || 0
+		line_end = src.index("\n", beg) || src.bytesize
+		line = src.byteslice(line_start, line_end - line_start).force_encoding(Encoding::UTF_8)
+		caret = (" " * (beg - line_start)) + ("^" * [fin - beg, 1].max)
+		"  #{line}\n  #{caret}"
+	end
+
+	def self.reads(...) = Analysis.reads(...)
+	def self.access(...) = Analysis.access(...)
 end

metadata

@@ -1,18 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: plume
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen Margheim
+- Joel Drapper
 bindir: bin
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
-dependencies: []
-description: Plume is a Ruby library that allows you to write SQLite's dialect of
-  SQL with structured Ruby.
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: quickdraw
+  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: Plume parses any statement in SQLite's grammar into a syntax tree you
+  can walk, change and print back to SQL, and tells you which tables and columns a
+  statement reads and writes.
 email:
 - stephen.margheim@gmail.com
+- joel@drapper.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -20,14 +65,124 @@ files:
 - LICENSE.txt
 - README.md
 - lib/plume.rb
+- lib/plume/analysis.rb
+- lib/plume/analysis/resolver.rb
+- lib/plume/ast/alter_table_statement.rb
+- lib/plume/ast/analyze_statement.rb
+- lib/plume/ast/assignment.rb
+- lib/plume/ast/attach_statement.rb
+- lib/plume/ast/begin_statement.rb
+- lib/plume/ast/binary_expression.rb
+- lib/plume/ast/case_condition.rb
+- lib/plume/ast/case_expression.rb
+- lib/plume/ast/cast_expression.rb
+- lib/plume/ast/check_column_constraint.rb
+- lib/plume/ast/check_table_constraint.rb
+- lib/plume/ast/collate_column_constraint.rb
+- lib/plume/ast/collation_expression.rb
+- lib/plume/ast/column_constraint.rb
+- lib/plume/ast/column_definition.rb
+- lib/plume/ast/column_name.rb
+- lib/plume/ast/column_type.rb
+- lib/plume/ast/commit_statement.rb
+- lib/plume/ast/common_table_expression.rb
+- lib/plume/ast/compound_select.rb
+- lib/plume/ast/conflict_clause.rb
+- lib/plume/ast/conflict_resolution.rb
+- lib/plume/ast/create_index_statement.rb
+- lib/plume/ast/create_table_statement.rb
+- lib/plume/ast/create_trigger_statement.rb
+- lib/plume/ast/create_view_statement.rb
+- lib/plume/ast/create_virtual_table_statement.rb
+- lib/plume/ast/default_column_constraint.rb
+- lib/plume/ast/delete_statement.rb
+- lib/plume/ast/detach_statement.rb
+- lib/plume/ast/drop_statement.rb
+- lib/plume/ast/empty_function_argument.rb
+- lib/plume/ast/exists_expression.rb
+- lib/plume/ast/explain_statement.rb
+- lib/plume/ast/expression.rb
+- lib/plume/ast/foreign_key_action.rb
+- lib/plume/ast/foreign_key_clause.rb
+- lib/plume/ast/foreign_key_column_constraint.rb
+- lib/plume/ast/foreign_key_table_constraint.rb
+- lib/plume/ast/frame_boundary.rb
+- lib/plume/ast/frame_spec.rb
+- lib/plume/ast/function_arguments.rb
+- lib/plume/ast/function_reference.rb
+- lib/plume/ast/generated_as_column_constraint.rb
+- lib/plume/ast/indexed_column.rb
+- lib/plume/ast/insert_statement.rb
+- lib/plume/ast/join.rb
+- lib/plume/ast/join_clause.rb
+- lib/plume/ast/join_on_constraint.rb
+- lib/plume/ast/join_operator.rb
+- lib/plume/ast/join_using_constraint.rb
+- lib/plume/ast/like_expression.rb
+- lib/plume/ast/literal_expression.rb
+- lib/plume/ast/literal_false.rb
+- lib/plume/ast/literal_nil.rb
+- lib/plume/ast/literal_value.rb
+- lib/plume/ast/match_clause.rb
+- lib/plume/ast/node.rb
+- lib/plume/ast/noop_column_constraint.rb
+- lib/plume/ast/noop_table_constraint.rb
+- lib/plume/ast/not_like_expression.rb
+- lib/plume/ast/not_null_column_constraint.rb
+- lib/plume/ast/null_column_constraint.rb
+- lib/plume/ast/ordering_term.rb
+- lib/plume/ast/over_clause.rb
+- lib/plume/ast/parenthetical_expression.rb
+- lib/plume/ast/parenthetical_source.rb
+- lib/plume/ast/pragma_statement.rb
+- lib/plume/ast/primary_key_column_constraint.rb
+- lib/plume/ast/primary_key_table_constraint.rb
+- lib/plume/ast/raise_expression.rb
+- lib/plume/ast/reindex_statement.rb
+- lib/plume/ast/release_statement.rb
+- lib/plume/ast/result_column.rb
+- lib/plume/ast/returning_clause.rb
+- lib/plume/ast/rollback_statement.rb
+- lib/plume/ast/savepoint_statement.rb
+- lib/plume/ast/select_core.rb
+- lib/plume/ast/select_statement.rb
+- lib/plume/ast/star_function_argument.rb
+- lib/plume/ast/star_result_column.rb
+- lib/plume/ast/strict_table_option.rb
+- lib/plume/ast/subquery_expression.rb
+- lib/plume/ast/subquery_source.rb
+- lib/plume/ast/table_constraint.rb
+- lib/plume/ast/table_function.rb
+- lib/plume/ast/table_name.rb
+- lib/plume/ast/table_option.rb
+- lib/plume/ast/ternary_expression.rb
+- lib/plume/ast/token.rb
+- lib/plume/ast/unary_expression.rb
+- lib/plume/ast/unique_column_constraint.rb
+- lib/plume/ast/unique_table_constraint.rb
+- lib/plume/ast/update_statement.rb
+- lib/plume/ast/upsert_clause.rb
+- lib/plume/ast/vacuum_statement.rb
+- lib/plume/ast/values_clause.rb
+- lib/plume/ast/values_row.rb
+- lib/plume/ast/variable.rb
+- lib/plume/ast/window_definition.rb
+- lib/plume/ast/with_clause.rb
+- lib/plume/ast/without_rowid_table_option.rb
+- lib/plume/catalog.rb
+- lib/plume/lexer.rb
+- lib/plume/parser.rb
+- lib/plume/printer.rb
+- lib/plume/sqlite_grammar.rb
+- lib/plume/union.rb
 - lib/plume/version.rb
-homepage: https://github.com/fractaledmind/plume
+homepage: https://github.com/yippee-fun/plume
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/fractaledmind/plume
-  source_code_uri: https://github.com/fractaledmind/plume
-  changelog_uri: https://github.com/fractaledmind/plume/releases
+  homepage_uri: https://github.com/yippee-fun/plume
+  source_code_uri: https://github.com/yippee-fun/plume
+  changelog_uri: https://github.com/yippee-fun/plume/blob/main/CHANGELOG.md
   funding_uri: https://github.com/sponsors/fractaledmind
 rdoc_options: []
 require_paths:
@@ -36,14 +191,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Write SQLite's dialect of SQL with elegance.
+summary: Parse, analyze and print SQLite's dialect of SQL
 test_files: []