lex-postgres 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67cba7d98266b32731852fc25ff2345aa68c857fb24d5d5ce04cb5a25169b53e
+  data.tar.gz: 567a545528468fd54336b5326357881fb3f8908cf6dab6c2a3f5a1ca2a3e5a5b
+SHA512:
+  metadata.gz: 32d7921ab206bce10ecfe9506c7185453cb21e7ee04059c211a03a4e88c95015766fd8a46305b5ea5a8c5ae4a2c4c45f44813eedd5736bb7465a9a6701274a98
+  data.tar.gz: 2aeaa970e7849185c9a81148917b0d58d3af1f0002d94d3cd1a99ab6071a9a330f0c6b7192ebe95103f81c28412df5e6238cb9e003d09db4b1abc96566dff282

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  push:
+    branches: [origin]
+  pull_request:
+
+jobs:
+  ci:
+    uses: LegionIO/.github/.github/workflows/ci.yml@main
+
+  release:
+    needs: ci
+    if: github.event_name == 'push' && github.ref == 'refs/heads/origin'
+    uses: LegionIO/.github/.github/workflows/release.yml@main
+    secrets:
+      rubygems-api-key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,12 @@
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 160
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/ModuleLength:
+  Max: 1500
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 17
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.0] - 2026-03-21
+
+### Added
+- Initial release
+- `Helpers::Client` module with `.connection` method wrapping `PG::Connection`
+- `Runners::Queries` with `execute` (arbitrary SQL) and `execute_params` (parameterized SQL with `$1`/`$2` placeholders)
+- `Runners::Tables` with `list_tables`, `describe_table`, and `table_size` using `information_schema` and `pg_total_relation_size`
+- Standalone `Client` class including all runner modules
+- Full RSpec test suite (15 specs across 3 spec files)

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler', '>= 2'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/README.md

@@ -0,0 +1,76 @@
+# lex-postgres
+
+A LegionIO extension (LEX) that connects LegionIO to PostgreSQL databases via the `pg` gem.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'lex-postgres'
+```
+
+## Standalone Usage
+
+```ruby
+require 'lex-postgres'
+
+client = Legion::Extensions::Postgres::Client.new(
+  host:     'db.example.com',
+  port:     5432,
+  dbname:   'myapp',
+  user:     'jane.doe',
+  password: 'secret'
+)
+
+# Execute arbitrary SQL
+client.execute(sql: 'SELECT version()')
+# => { result: [{ version: "PostgreSQL 16.0 ..." }] }
+
+# Parameterized query
+client.execute_params(sql: 'SELECT * FROM users WHERE id = $1', params: [42])
+# => { result: [{ id: "42", name: "Jane Doe", email: "jane.doe@example.com" }] }
+
+# List tables in a schema
+client.list_tables(schema: 'public')
+# => { result: ["orders", "products", "users"] }
+
+# Describe a table's columns
+client.describe_table(table: 'users')
+# => { result: [{ column_name: "id", data_type: "integer", ... }, ...] }
+
+# Total on-disk size of a table (bytes)
+client.table_size(table: 'orders')
+# => { result: 8192 }
+```
+
+## Runner Methods
+
+### Queries
+
+| Method | Description |
+|--------|-------------|
+| `execute(sql:)` | Run arbitrary SQL, returns rows as array of symbol-keyed hashes |
+| `execute_params(sql:, params: [])` | Parameterized query with `$1`, `$2` placeholders |
+
+### Tables
+
+| Method | Description |
+|--------|-------------|
+| `list_tables(schema: 'public')` | List table names in the given schema |
+| `describe_table(table:, schema: 'public')` | Column definitions from `information_schema.columns` |
+| `table_size(table:)` | Total relation size in bytes via `pg_total_relation_size` |
+
+## Connection Defaults
+
+| Option | Default |
+|--------|---------|
+| `host` | `127.0.0.1` |
+| `port` | `5432` |
+| `dbname` | `postgres` |
+| `user` | `postgres` |
+| `password` | `nil` (omitted if not set) |
+
+## License
+
+MIT

data/lex-postgres.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/extensions/postgres/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-postgres'
+  spec.version       = Legion::Extensions::Postgres::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::postgres'
+  spec.description   = 'Connects LegionIO to PostgreSQL databases'
+  spec.homepage      = 'https://github.com/LegionIO/lex-postgres'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.4'
+
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = 'https://github.com/LegionIO/lex-postgres'
+  spec.metadata['documentation_uri']     = 'https://github.com/LegionIO/lex-postgres'
+  spec.metadata['changelog_uri']         = 'https://github.com/LegionIO/lex-postgres'
+  spec.metadata['bug_tracker_uri']       = 'https://github.com/LegionIO/lex-postgres/issues'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pg', '~> 1.5'
+end

data/lib/legion/extensions/postgres/client.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/client'
+require_relative 'runners/queries'
+require_relative 'runners/tables'
+
+module Legion
+  module Extensions
+    module Postgres
+      class Client
+        include Runners::Queries
+        include Runners::Tables
+
+        attr_reader :opts
+
+        def initialize(**opts)
+          @opts = Helpers::Client::DEFAULTS.merge(opts)
+        end
+
+        def connection(**override)
+          Helpers::Client.connection(**@opts, **override)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/postgres/helpers/client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'pg'
+
+module Legion
+  module Extensions
+    module Postgres
+      module Helpers
+        module Client
+          DEFAULTS = { host: '127.0.0.1', port: 5432, dbname: 'postgres', user: 'postgres' }.freeze
+
+          def self.connection(**opts)
+            merged = DEFAULTS.merge(opts)
+            connect_hash = merged.slice(:host, :port, :dbname, :user)
+            connect_hash[:password] = merged[:password] if merged[:password]
+            ::PG::Connection.new(**connect_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/postgres/runners/queries.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/postgres/helpers/client'
+
+module Legion
+  module Extensions
+    module Postgres
+      module Runners
+        module Queries
+          def execute(sql:, **)
+            result = connection(**).exec(sql)
+            { result: result.map { |row| row.transform_keys(&:to_sym) } }
+          end
+
+          def execute_params(sql:, params: [], **)
+            result = connection(**).exec_params(sql, params)
+            { result: result.map { |row| row.transform_keys(&:to_sym) } }
+          end
+
+          extend Legion::Extensions::Postgres::Helpers::Client
+          include Legion::Extensions::Helpers::Lex if defined?(Legion::Extensions::Helpers::Lex)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/postgres/runners/tables.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/postgres/helpers/client'
+
+module Legion
+  module Extensions
+    module Postgres
+      module Runners
+        module Tables
+          def list_tables(schema: 'public', **)
+            sql = 'SELECT table_name FROM information_schema.tables WHERE table_schema = $1 ORDER BY table_name'
+            result = connection(**).exec_params(sql, [schema])
+            { result: result.map { |row| row['table_name'] } }
+          end
+
+          def describe_table(table:, schema: 'public', **)
+            sql = <<~SQL
+              SELECT column_name, data_type, character_maximum_length, is_nullable, column_default
+              FROM information_schema.columns
+              WHERE table_schema = $1 AND table_name = $2
+              ORDER BY ordinal_position
+            SQL
+            result = connection(**).exec_params(sql, [schema, table])
+            { result: result.map { |row| row.transform_keys(&:to_sym) } }
+          end
+
+          def table_size(table:, **)
+            sql = 'SELECT pg_total_relation_size($1) AS size'
+            result = connection(**).exec_params(sql, [table])
+            { result: result.first['size'].to_i }
+          end
+
+          extend Legion::Extensions::Postgres::Helpers::Client
+          include Legion::Extensions::Helpers::Lex if defined?(Legion::Extensions::Helpers::Lex)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/postgres/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Postgres
+      VERSION = '0.1.1'
+    end
+  end
+end

data/lib/legion/extensions/postgres.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/postgres/version'
+require 'legion/extensions/postgres/helpers/client'
+require 'legion/extensions/postgres/runners/queries'
+require 'legion/extensions/postgres/runners/tables'
+require 'legion/extensions/postgres/client'
+
+module Legion
+  module Extensions
+    module Postgres
+      extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: lex-postgres
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Esity
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Connects LegionIO to PostgreSQL databases
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- lex-postgres.gemspec
+- lib/legion/extensions/postgres.rb
+- lib/legion/extensions/postgres/client.rb
+- lib/legion/extensions/postgres/helpers/client.rb
+- lib/legion/extensions/postgres/runners/queries.rb
+- lib/legion/extensions/postgres/runners/tables.rb
+- lib/legion/extensions/postgres/version.rb
+homepage: https://github.com/LegionIO/lex-postgres
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LegionIO/lex-postgres
+  source_code_uri: https://github.com/LegionIO/lex-postgres
+  documentation_uri: https://github.com/LegionIO/lex-postgres
+  changelog_uri: https://github.com/LegionIO/lex-postgres
+  bug_tracker_uri: https://github.com/LegionIO/lex-postgres/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: LEX::postgres
+test_files: []