sqlpkg 0.2.3.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78bb33046cc04d98264ccaaa0c18faeeeda57be75ec72124da77f72a4a7cfa1d
-  data.tar.gz: aff9b55b8734492e8d65af130d12ef0f90fe79d17994e670aaa257b0616b1435
+  metadata.gz: 3131c063c4d2bc767ff4f1d56ff992fbdd4fd2d9f0bcb114a231fee8f1558df8
+  data.tar.gz: 1ea975cc4eff3301c4d908d7832dc93ef4ad85185ddfec919a78b4d3ef9966b7
 SHA512:
-  metadata.gz: 9aed7b9656ca5a5b8983ad19f49aeb50d657df7b91a80dcdef49216768aaf9c937aa6dbe9655a721f39bc5de0d3f8af5cca8eb2d19a64bb4e1f6d97f01e1f731
-  data.tar.gz: c66e09ea0ad120f75f5f12f1ddcf12b0e7dec06b959ab42ef07789930005c039878ade6f3bf54808b1b3e682130e12546069651115c8e59a8e21c7dfc1665310
+  metadata.gz: 914dca28b67247c8577c7286d07ccd44aa9ea4bc89311b26056955f67d6dd42cd30f8f3770b873f0667a1f0f9a6a026ec2c2175a33216d225e0eeeb4ee602df3
+  data.tar.gz: 8dc094a3227f069c312e4e8ca7e9a3761b2b68ed13c421a3255dd0e39f35c8fdf6f600b816d71cb08f764a64a3b34e6920dbb80f8a652121a0063075a06043e0

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/generators/sqlpkg/install_generator.rb

@@ -11,6 +11,13 @@ module Sqlpkg
         empty_directory ".sqlpkg"
       end
 
+      def create_gitignore_in_sqlpkg_project_scope_directory
+        create_file ".sqlpkg/.gitignore", <<~CONTENT
+          *
+          !.gitignore
+        CONTENT
+      end
+
       def create_empty_sqlpkg_lockfile
         create_file "sqlpkg.lock", <<~CONTENT
           {

data/lib/sqlpkg/upstream.rb

@@ -1,7 +1,7 @@
 module Sqlpkg
-  # constants describing the upstream tailwindcss project
+  # constants describing the upstream sqlpkg-cli project
   module Upstream
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
 
     # rubygems platform name => upstream release filename
     NATIVE_PLATFORMS = {

data/lib/sqlpkg/version.rb

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

data/lib/sqlpkg.rb

@@ -1,6 +1,39 @@
 # 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
+    # => "#{Rails.root}/.sqlpkg" or "./.sqlpkg"
+    def file_dir
+      if defined?(Rails) && Rails.respond_to?(:root) && Dir.exist?(Rails.root.join(DIR))
+        Rails.root.join(DIR)
+      else
+        File.join(__dir__, DIR)
+      end
+    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,13 @@
 --- !ruby/object:Gem::Specification
 name: sqlpkg
 version: !ruby/object:Gem::Version
-  version: 0.2.3.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Margheim
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-05 00:00:00.000000000 Z
+date: 2025-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -52,7 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - stephen.margheim@gmail.com
 executables:
@@ -79,7 +77,6 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/fractaledmind/sqlpkg-ruby
   changelog_uri: https://github.com/fractaledmind/sqlpkg-ruby/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Integrate sqlpkg with the RubyGems infrastructure.
 test_files: []