pglite 0.0.2-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 782ee720f8e6e45609d8760090f0d4ddcb4ed86f53564cd6b99fcc9d3a9d0bf8
+  data.tar.gz: fae0ec2a5c165631c2af2ff7388cf7aeb23ea62d4536d9481a3efc8f8985e114
+SHA512:
+  metadata.gz: 637b3b3e2d1d63a0f9546cb5a0af4c28a5c25bf8d0fd8e2b1842d8bd06cfeb7f93b8e2c6f0f633e31c4e0c7b3102326cea2e3684dcebf293c094b624b1bf6d35
+  data.tar.gz: e7619bee19a3ecb64fd54a7f2efdd9a33dc36278a3a7869c42bf62987173b6c050de79aa09734dd9cb1a8bf8a2235d78c346485657912e0d5e169373e2628e95

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change log
+
+## master

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2025 Vladimir Dementyev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,54 @@
+[![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 and Rails
+
+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
+
+Add the gem to your Gemfile and run `bundle install`:
+
+```ruby
+# Gemfile
+gem "pglite"
+```
+
+### Supported Ruby/Rails versions
+
+- Ruby (MRI) >= 3.4
+- Rails >= 7.2
+
+## Usage
+
+A minimal example:
+
+```ruby
+# 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"]
+```
+
+### Active Record integration
+
+Specify the `pglite` adapter in your `database.yml`. Done.
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/pglite-rb](https://github.com/palkan/pglite-rb).
+
+## Credits
+
+This gem is generated via [`newgem` template](https://github.com/palkan/newgem) by [@palkan](https://github.com/palkan).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

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

data/lib/pglite.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PGlite
+  # Main PGlite module
+end
+
+require "pglite/version"
+
+begin
+  require "pglite_rb"
+rescue LoadError
+  # Extension not available
+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

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pglite
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: x86_64-linux
+authors:
+- Vladimir Dementyev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: PGlite for Ruby and Rails
+email:
+- Vladimir Dementyev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- 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
+- lib/pglite_rb.so
+homepage: https://github.com/palkan/pglite-rb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/palkan/pglite-rb/issues
+  changelog_uri: https://github.com/palkan/pglite-rb/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/palkan/pglite-rb
+  homepage_uri: https://github.com/palkan/pglite-rb
+  source_code_uri: https://github.com/palkan/pglite-rb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: PGlite for Ruby and Rails
+test_files: []