pglite 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd89d41511dc03df457fb82af88ba097268b63aefbeabf4d92d62bad6a08db72
-  data.tar.gz: e23f6078cb1943262b7c2eade317712900b8b3a9c76afc7fa290771c71be7875
+  metadata.gz: 92b24a6ef1d8a46262cebcd4f9e037ff6c4b1a66d0380595e5652552548863d9
+  data.tar.gz: 20fcd558fc528712767d3a9d83792fd61cb1622796f868c4f2cfb3410fcb68cb
 SHA512:
-  metadata.gz: b0cf8e3e332546c80f6341553e8ce3fcad9adb5807747205e37a4cc80cc9f514f8dae983e4316b73f9653730282522b8b40b064cf659c7110b588378573abe3b
-  data.tar.gz: ec223bc30ec7617e9d5bdb79083a0e4d2f024a5d8f7fca9ba2d13ac2997edc1dfbf574988e775a9924c6031eeb58745964a21e3b3c0c9a4ca24f160c402146fc
+  metadata.gz: 8f25e87e147d5c238b6a4ee96f3635dbdd3d57c54c89222b954261c9294bfa840c75639cc3d77b3dbb8bfd759e99c8319f857c39bbc4bc98b9c0100e8a36039a
+  data.tar.gz: 8a49d44dfadd426fcd931e2ee8ba8f05f31790203674f3287b98a37b80bc7dbd8fc9f72524eeb12dc50aaae785fda32f47a56cad6da43adbb3ec665fdd70c8fe

data/CHANGELOG.md

@@ -1,3 +1,7 @@
 # Change log
 
 ## master
+
+## 0.1.0 (2025-12-12)
+
+- Initial version.

data/README.md

@@ -1,37 +1,49 @@
 [![Gem Version](https://badge.fury.io/rb/pglite-rb.svg)](https://rubygems.org/gems/pglite-rb)
 [![Build](https://github.com/palkan/pglite-rb/workflows/Build/badge.svg)](https://github.com/palkan/pglite-rb/actions)
 
-# PGlite for Ruby
+# PGlite for Ruby and Rails
 
-Let's bring [PGlite](https://pglite.dev/) to Ruby!
+Let's bring [PGlite](https://pglite.dev/) to Ruby and Rails! Enjoy using PostgreSQL without dealing with databases and native libraries—great for development and testing!
 
 ## Installation
 
-Adding to a gem:
+Add the gem to your Gemfile and run `bundle install`:
 
 ```ruby
-# my-cool-gem.gemspec
-Gem::Specification.new do |spec|
-  # ...
-  spec.add_dependency "pglite-rb"
-  # ...
-end
+# Gemfile
+gem "pglite"
 ```
 
-Or adding to your project:
+### Supported Ruby/Rails versions
+
+- Ruby (MRI) >= 3.4
+- Rails >= 7.2
+
+## Usage
+
+A minimal example:
 
 ```ruby
-# Gemfile
-gem "pglite-rb"
+# First, you must provision the database (creates a bunch of PostgreSQL files in your file system)
+PGlite.install!("tmp/pglite")
+
+# Now you can perform queries!
+result = PGLite.exec_query("SELECT 2 + 2 as answer")
+
+result.row_count #=> 1
+result.rows #=> [[4]]
+result.columns.map(&:name) #=> ["answer"]
 ```
 
-### Supported Ruby versions
+### Active Record integration
 
-- Ruby (MRI) >= 3.0
+Specify the `pglite` adapter in your `database.yml`. Done.
 
-## Usage
+The database would be provisioned the first time a connection is initialized (in the `tmp/pglite` directory or in the `mount_path` if one is specified in the configuration). Alternatively, you can manually call `PGlite.install!(path)` on the application boot.
+
+## Configuration
 
-TBD
+You can enable PostgreSQL logs (stdout/stderr) by set the `PGLITE_WASI_STDIO=1` environment variable.
 
 ## Contributing
 

data/ext/pglite-rb/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "pglite_rb"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+magnus = { version = "0.8", features = ["rb-sys"] }
+rb-sys = "0.9"
+pglite-oxide = { git = "https://github.com/palkan/pglite-oxide.git" }
+bytes = "1.0"
+hex = "0.4"

data/ext/{extconf.rb → pglite-rb/extconf.rb}

@@ -3,4 +3,4 @@
 require "mkmf"
 require "rb_sys/mkmf"
 
-create_rust_makefile("pglite-rb/pglite_rb_ext")
+create_rust_makefile("pglite-rb/pglite_rb")

data/ext/pglite-rb/src/lib.rs

@@ -0,0 +1,11 @@
+use magnus::{Error, Ruby};
+mod types;
+mod implementation;
+mod ruby_api;
+
+rb_sys::set_global_tracking_allocator!();
+
+#[magnus::init]
+pub fn init(ruby: &Ruby) -> Result<(), Error> {
+    ruby_api::init(ruby)
+}

data/lib/active_record/connection_adapters/pglite_adapter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+begin
+  require "pg"
+rescue LoadError
+  # Patch #gem to ignore 'pg' checks
+  Kernel.prepend(Module.new do
+    def gem(dep, *)
+      return if dep == "pg"
+      super
+    end
+  end)
+
+  # Update the $LOAD_PATH to include the pg stub
+  $LOAD_PATH.unshift(File.expand_path(File.join(__dir__, "pglite_shims")))
+end
+
+require "active_record/connection_adapters/postgresql_adapter"
+
+module ActiveRecord
+  module ConnectionHandling # :nodoc:
+    def pglite_adapter_class
+      ConnectionAdapters::PGliteAdapter
+    end
+
+    def pglite_connection(config)
+      pglite_adapter_class.new(config)
+    end
+  end
+
+  module ConnectionAdapters
+    class PGliteAdapter < PostgreSQLAdapter
+      class << self
+        def database_exists?(config)
+          true
+        end
+
+        def new_client(...) = PGlite::Connection.new(...)
+      end
+
+      def initialize(...)
+        super
+        # Prepared statements are not currently supported
+        @prepared_statements = false
+      end
+
+      # Stub encoders/decoders
+      def add_pg_encoders = nil
+
+      def add_pg_decoders = nil
+
+      unless method_defined?(:query_rows)
+        alias_method :query_rows, :query
+      end
+
+      # TODO: col_description is not supported ???
+      def column_definitions(table_name)
+        query_rows(<<~SQL, "SCHEMA")
+          SELECT a.attname, format_type(a.atttypid, a.atttypmod),
+                  pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
+                  c.collname, '' AS comment,
+                  #{supports_identity_columns? ? "attidentity" : quote("")} AS identity,
+                  #{supports_virtual_columns? ? "attgenerated" : quote("")} as attgenerated
+            FROM pg_attribute a
+            LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
+            LEFT JOIN pg_type t ON a.atttypid = t.oid
+            LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation
+            WHERE a.attrelid = #{quote(quote_table_name(table_name))}::regclass
+              AND a.attnum > 0 AND NOT a.attisdropped
+            ORDER BY a.attnum
+        SQL
+      end
+
+      ::ActiveRecord::Type.add_modifier({array: true}, PostgreSQL::OID::Array, adapter: :pglite)
+      ::ActiveRecord::Type.add_modifier({range: true}, PostgreSQL::OID::Range, adapter: :pglite)
+      ::ActiveRecord::Type.register(:bit, PostgreSQL::OID::Bit, adapter: :pglite)
+      ::ActiveRecord::Type.register(:bit_varying, PostgreSQL::OID::BitVarying, adapter: :pglite)
+      ::ActiveRecord::Type.register(:binary, PostgreSQL::OID::Bytea, adapter: :pglite)
+      ::ActiveRecord::Type.register(:cidr, PostgreSQL::OID::Cidr, adapter: :pglite)
+      ::ActiveRecord::Type.register(:date, PostgreSQL::OID::Date, adapter: :pglite)
+      ::ActiveRecord::Type.register(:datetime, PostgreSQL::OID::DateTime, adapter: :pglite)
+      ::ActiveRecord::Type.register(:decimal, PostgreSQL::OID::Decimal, adapter: :pglite)
+      ::ActiveRecord::Type.register(:enum, PostgreSQL::OID::Enum, adapter: :pglite)
+      ::ActiveRecord::Type.register(:hstore, PostgreSQL::OID::Hstore, adapter: :pglite)
+      ::ActiveRecord::Type.register(:inet, PostgreSQL::OID::Inet, adapter: :pglite)
+      ::ActiveRecord::Type.register(:interval, PostgreSQL::OID::Interval, adapter: :pglite)
+      ::ActiveRecord::Type.register(:jsonb, PostgreSQL::OID::Jsonb, adapter: :pglite)
+      ::ActiveRecord::Type.register(:money, PostgreSQL::OID::Money, adapter: :pglite)
+      ::ActiveRecord::Type.register(:point, PostgreSQL::OID::Point, adapter: :pglite)
+      ::ActiveRecord::Type.register(:legacy_point, PostgreSQL::OID::LegacyPoint, adapter: :pglite)
+      ::ActiveRecord::Type.register(:uuid, PostgreSQL::OID::Uuid, adapter: :pglite)
+      ::ActiveRecord::Type.register(:vector, PostgreSQL::OID::Vector, adapter: :pglite)
+      ::ActiveRecord::Type.register(:xml, PostgreSQL::OID::Xml, adapter: :pglite)
+    end
+  end
+end

data/lib/active_record/connection_adapters/pglite_shims/pg.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "pglite/pg"

data/lib/pglite/connection.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "pglite/pg"
+require "pglite/result"
+
+module PGlite
+  class Connection
+    attr_reader :mount_path
+
+    def initialize(conn_params = {})
+      @mount_path = conn_params[:mount_path] || File.join(Dir.pwd, "tmp", "pglite")
+      @prepared_statements_map = {}
+      PGlite.install!(mount_path)
+    rescue => e
+      raise PG::Error, e.message
+    end
+
+    def set_client_encoding(_)
+      # make no-op for now
+    end
+
+    def finished? = true
+
+    def transaction_status
+      PG::PQTRANS_IDLE
+    end
+
+    def escape(str) = str
+
+    def raw_query(sql, params)
+      # FIXME: we need to add support for prepared statements at the extension level
+      if params.present?
+        raise ArgumentError, "Prepared statements are not supported in pglite"
+      end
+
+      raw_res = PGlite.exec_query(sql)
+      result = Result.new(raw_res)
+      @last_result = result
+      result
+    rescue => e
+      raise PG::Error, e.message
+    end
+
+    def exec(sql)
+      raw_query(sql, [])
+    end
+
+    alias_method :query, :exec
+    alias_method :async_exec, :exec
+    alias_method :async_query, :exec
+
+    def exec_params(sql, params)
+      if params.empty?
+        return exec(sql)
+      end
+      raw_query(sql, params)
+    end
+
+    def exec_prepared(name, params)
+      sql = @prepared_statements_map[name]
+      exec_params(sql, params)
+    end
+
+    def prepare(name, sql, param_types = nil)
+      @prepared_statements_map[name] = sql
+    end
+
+    def get_last_result
+      @last_result
+    end
+
+    def reset
+      @prepared_statements_map = {}
+    end
+
+    def server_version
+      # The result is formed by multiplying the server's major version number by 10000 and adding the minor version number.
+      # For example, version 10.1 will be returned as 100001, and version 11.0 will be returned as 110000.
+      PGlite.database_version.match(/PostgreSQL\s(\d+)\.(\d+)/)&.then do
+        _1[1].to_i * 10_000 + _1[2].to_i
+      end
+    end
+  end
+end

data/lib/pglite/pg.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+begin
+  require "pg"
+  return
+rescue LoadError
+end
+
+# Define minumum PG interface
+module PG
+  PQTRANS_IDLE = 0 # (connection idle)
+  PQTRANS_ACTIVE = 1 # (command in progress)
+  PQTRANS_INTRANS = 2 # (idle, within transaction block)
+  PQTRANS_INERROR = 3 # (idle, within failed transaction)
+  PQTRANS_UNKNOWN = 4 # (cannot determine status)
+
+  class Error < StandardError; end
+  class ConnectionBad < Error; end
+  class FeatureNotSupported < Error; end
+
+  class Connection
+    class << self
+      # TODO: can we support some configuration?
+      def conndefaults_hash = {}
+
+      def quote_ident(str)
+        str = str.to_s
+        return '""' if str.empty?
+        if str =~ /[^a-zA-Z_0-9]/ || str =~ /^[0-9]/
+          '"' + str.gsub('"', '""') + '"'
+        else
+          str
+        end
+      end
+    end
+  end
+
+  # Just a stub for now
+  class SimpleDecoder
+  end
+end

data/lib/pglite/result.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PGlite
+  class Result
+    attr_reader :res
+
+    # A wrapper for a result object from Oxide
+    def initialize(res)
+      @res = res
+    end
+
+    def map_types!(map)
+      self
+    end
+
+    def values = res.rows
+
+    def fields = res.columns.map(&:name)
+
+    def ftype(index) = res.columns[index].oid
+
+    def fmod(index) = res.columns[index].type_modifier
+
+    def cmd_tuples = res.row_count
+
+    def ntuples = res.row_count
+
+    def clear
+    end
+
+    include Enumerable
+
+    def each
+      return to_enum(:each) unless block_given?
+
+      columns = fields
+      res.rows.each do |res_row|
+        row = {}
+        columns.each.with_index do |col, i|
+          value = res_row[i]
+          row[col] = value
+        end
+        yield row
+      end
+    end
+  end
+end

data/lib/pglite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PGlite # :nodoc:
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/pglite.rb

@@ -7,7 +7,14 @@ end
 require "pglite/version"
 
 begin
-  require "pglite_rb_ext"
+  /(?<ruby_version>\d+\.\d+)/ =~ RUBY_VERSION
+  require_relative "#{ruby_version}/pglite_rb"
 rescue LoadError
-  # Extension not available
+  require_relative "pglite_rb"
+end
+
+require "pglite/connection"
+
+if defined?(ActiveRecord::ConnectionAdapters) && ActiveRecord::ConnectionAdapters.respond_to?(:register)
+  ActiveRecord::ConnectionAdapters.register("pglite", "ActiveRecord::ConnectionAdapters::PGliteAdapter", "active_record/connection_adapters/pglite_adapter")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pglite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.39
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.39
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,22 +107,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Example description
+description: PGlite for Ruby and Rails
 email:
 - Vladimir Dementyev
 executables: []
 extensions:
-- ext/extconf.rb
+- ext/pglite-rb/extconf.rb
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- ext/Cargo.lock
-- ext/Cargo.toml
-- ext/extconf.rb
-- ext/src/lib.rs
+- ext/pglite-rb/Cargo.toml
+- ext/pglite-rb/extconf.rb
+- ext/pglite-rb/src/lib.rs
+- lib/active_record/connection_adapters/pglite_adapter.rb
+- lib/active_record/connection_adapters/pglite_shims/pg.rb
 - lib/pglite.rb
+- lib/pglite/connection.rb
+- lib/pglite/pg.rb
+- lib/pglite/result.rb
 - lib/pglite/version.rb
 homepage: https://github.com/palkan/pglite-rb
 licenses:
@@ -135,5 +153,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Example description
+summary: PGlite for Ruby and Rails
 test_files: []