sqlpkg 0.2.3.1-x86_64-darwin → 0.2.3.2-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f5759873bba0eabdc6214ff30b1eeb2f65bf32d45bc28fba222d509620cd59
-  data.tar.gz: eda6aded179023cd46659e86c3f2593bf964610b4dd93b967034d2c35a0a2b4f
+  metadata.gz: ecf0a8b23e859d0fdd3dc9bddbaf06da2e84a3ba3915bb834162cd24bb15edb3
+  data.tar.gz: bb6e69caab5d62c931c4306b645520accbb68e4e8d885450b88147a69f848316
 SHA512:
-  metadata.gz: a3476c50bb2bc17e7a3c9e4eba43c8bdd479b97b85c5fbb2a78467d32a7471d2f883383d61d5d1f9cbf305a6c6549041e9175a059efaa5a3c27221999754eaf9
-  data.tar.gz: 3c18d0278e414255ffee70320ed734426e38722cf2253f85ba03a857727cfa840c0d723a49adc71477da045f1301e234fadd1cb1cd7ede286abad8a483ce2a20
+  metadata.gz: 88c89a39fb35e24e904bcdc5b0d6a08f0fd69817c0fb98733955d391bed047686f1d9ebcb9ca59683f9d5f54c5d410e49366ae7dfd0118aaa0b18cd893b2a3bd
+  data.tar.gz: c3ba9ff44ea7527724caa2e42842b382098579ca493b22bfee9859f7882b4a1a02b34e585c64f37347ecbc477349c1a94eef727fe95793108666f36cb4e3f488

data/README.md

@@ -5,16 +5,19 @@
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add sqlpkg
+```shell
+bundle add sqlpkg
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install sqlpkg
+```shell
+gem install sqlpkg
+```
 
 After installing the gem, run the installer:
-
-    $ rails generate sqlpkg:install
+```shell
+rails generate sqlpkg:install
+```
 
 The installer does three things:
 
@@ -23,8 +26,9 @@ The installer does three things:
 3. creates an initializer file at `config/initializers/sqlpkg.rb` which will patch the `SQLite3Adapter` to automatically load the extensions installed in the `.sqlpkg/` directory whenever the database is opened
 
 Once properly integrated into your Rails application, you can install any extension listed on [the `sqlpkg` registry](https://sqlpkg.org/all/) by executing:
-
-    $ bundle exec sqlpkg install PACKAGE_IDENTIFIER
+```shell
+bundle exec sqlpkg install PACKAGE_IDENTIFIER
+```
 
 When exploring the [the `sqlpkg` registry](https://sqlpkg.org/all/), the `PACKAGE_IDENTIFIER` needed to install an extension is the title found in the cards, always in `owner/name` format.
 
@@ -56,7 +60,7 @@ SQLPKG_INSTALL_DIR=.bin
 ## Usage
 
 ```shell
-$ bundle exec sqlpkg help
+bundle exec sqlpkg help
 ┌────────────────────────────────────────────────┐
 │ sqlpkg is an SQLite package manager.           │
 │ Use it to install or update SQLite extensions. │
@@ -74,6 +78,42 @@ $ bundle exec sqlpkg help
 └────────────────────────────────────────────────┘
 ```
 
+You can get the path to an installed extension using the `Sqlpkg.path_for` method, e.g.:
+
+```ruby
+Sqlpkg.path_for("nalgeon/uuid")
+# => "./.sqlpkg/nalgeon/uuid/uuid.dylib"
+```
+
+You can also use the shorter `.[]` alias:
+
+```ruby
+Sqlpkg["nalgeon/uuid"]
+# => "./.sqlpkg/nalgeon/uuid/uuid.dylib"
+```
+
+If you try to access an extension that hasn't been installed, a `Sqlpkg::ExtensionNotInstalledError` will be raised:
+
+```ruby
+Sqlpkg["nalgeon/ulid"]
+# raises Sqlpkg::ExtensionNotInstalledError
+```
+
+This feature is particulary useful for the [new Rails feature](https://github.com/rails/rails/pull/53827) and [`sqlite3-ruby` feature](https://github.com/sparklemotion/sqlite3-ruby/pull/586) that allows automatically loading extensions via the `extensions` keyword defined in the Rails `config/database.yml` or the `SQLite3::Database.new` method call. You can now use either:
+
+```yaml
+development:
+  adapter: sqlite3
+  extensions:
+    - <%= Sqlpkg.path_for("asg017/ulid") %>
+```
+
+or if you are using `SQLite3::Database` directly:
+
+```ruby
+db = SQLite3::Database.new(":memory:", extensions: [Sqlpkg.path_for("asg017/ulid")])
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/sqlpkg/version.rb

@@ -1,3 +1,3 @@
 module Sqlpkg
-  VERSION = "0.2.3.1"
+  VERSION = "0.2.3.2"
 end

data/lib/sqlpkg.rb

@@ -1,6 +1,35 @@
 # frozen_string_literal: true
 
 module Sqlpkg
+  DIR = ".sqlpkg"
+  FILE_PATTERN = "*.{dylib,so,dll}"
+
+  Error = Class.new(StandardError)
+  ExtensionNotInstalledError = Class.new(Error)
+
+  class << self
+    # File path for identified extension
+    # => "./.sqlpkg/nalgeon/uuid/uuid.dylib"
+    def path_for(identifier)
+      path_glob = File.join(file_dir, identifier, FILE_PATTERN)
+      path = Dir.glob(path_glob).first
+
+      path || raise(ExtensionNotInstalledError, "No extension found for identifier: #{identifier}")
+    end
+    alias_method :[], :path_for
+
+    # The directory where `sqlpkg` stores installed extensions
+    # => "./.sqlpkg"
+    def file_dir
+      File.join(__dir__, DIR)
+    end
+
+    # List of file paths for all installed extensions
+    # => ["./.sqlpkg/asg017/ulid/ulid0.dylib", "./.sqlpkg/nalgeon/uuid/uuid.dylib"]
+    def installed_extension_paths
+      Dir.glob File.join(file_dir, "**", FILE_PATTERN)
+    end
+  end
 end
 
 require_relative "sqlpkg/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlpkg
 version: !ruby/object:Gem::Version
-  version: 0.2.3.1
+  version: 0.2.3.2
 platform: x86_64-darwin
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-05 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Integrate sqlpkg with the RubyGems infrastructure.