sqlpkg 0.1.1-x86_64-linux → 0.2.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72469641de420cedc2cda5f13efa63919512c94f5848df77edbc82c4b7e1b98c
-  data.tar.gz: 47d388db8bb2d40e9e25d970acd01d7b1075d730891af9caae34a97cf876b3a0
+  metadata.gz: b50c25e12a5b29109cf0829c7561af05c5d7877641f52f1404dcd81682e1c0fe
+  data.tar.gz: c7e1be3b1b9b28bcd3bff1babd041414fb0f86560b37ea1bad623a6f1464b008
 SHA512:
-  metadata.gz: f9ef11983c64193061a7c27f608208e71bed0fc96e82ed2c4dbe39a9ae73d186f59e6c3772b4066659c5881a3434d1f264d956205ec1a1aebfd47e41f358d904
-  data.tar.gz: 7d970fdd91a9f24f052a573ba6cbd5f1bd9d6fcd65c0523929b48660e6946645b5e20065ce2bcdeb53b525b4209062e5f3526efd0de92b196d1bb784121e5358
+  metadata.gz: 4db35128494a68ccafab1a2c99ad3ae0ede1aa6a0845f617464fa1527da4d63719e2e77e3c38757d7e50ea268e83e50bdd53998394413ac2bd0be7fe823bc003
+  data.tar.gz: '08d6c8a5fce8f1dfc82da6fbed35c2a1aea87e0ef2c2317841312b4dbd751ec583544cb77c2c23e1139a26db1d2cf0c9f2082a17be5a26f06f076a9606d6266b'

data/README.md

@@ -12,6 +12,22 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install sqlpkg
 
+After installing the gem, run the installer:
+
+    $ rails generate sqlpkg:install
+
+The installer does three things:
+
+1. creates an empty `.sqlpkg/` directory, which ensures that `sqlpkg` will run in "project scope" and not "global scope" (see [the `sqlpkg-cli` README](https://github.com/nalgeon/sqlpkg-cli#project-vs-global-scope) for more information)
+2. creates an empty `sqlpkg.lock` file, which `sqlpkg` will use to store information about the installed packages (see [the `sqlpkg-cli` README](https://github.com/nalgeon/sqlpkg-cli#lockfile) for more information)
+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
+
+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.
+
 This gem wraps the standalone executable version of the [sqlpkg-cli](https://github.com/nalgeon/sqlpkg-cli#download-and-install-preferred-method). These executables are platform specific, so there are actually separate underlying gems per platform, but the correct gem will automatically be picked for your platform.
 
 Supported platforms are:

data/lib/sqlpkg/generators/sqlpkg/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Sqlpkg
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def ensure_sqlpkg_project_scope_directory
+        empty_directory ".sqlpkg"
+      end
+
+      def create_empty_sqlpkg_lockfile
+        create_file "sqlpkg.lock"
+      end
+
+      def copy_initializer_file
+        template "initializer.rb", "config/initializers/sqlpkg.rb"
+      end
+    end
+  end
+end

data/lib/sqlpkg/generators/sqlpkg/templates/initializer.rb

@@ -0,0 +1,15 @@
+module SqlpkgLoader
+  def configure_connection
+    super
+
+    @raw_connection.enable_load_extension(true)
+    Dir.glob(".sqlpkg/**/*.{dll,so,dylib}") do |extension_path|
+      @raw_connection.load_extension(extension_path)
+    end
+    @raw_connection.enable_load_extension(false)
+  end
+end
+
+ActiveSupport.on_load(:active_record_sqlite3adapter) do
+  prepend SqlpkgLoader
+end

data/lib/sqlpkg/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Sqlpkg
+  class Railtie < ::Rails::Railtie
+    # Load the `sqlpkg:install` generator into the host Rails app
+    generators do
+      require_relative "generators/sqlpkg/install_generator"
+    end
+  end
+end

data/lib/sqlpkg/version.rb

@@ -1,3 +1,3 @@
 module Sqlpkg
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/sqlpkg.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "sqlpkg/version"
-require_relative "sqlpkg/upstream"
-
 module Sqlpkg
 end
+
+require_relative "sqlpkg/version"
+require_relative "sqlpkg/upstream"
+require_relative "sqlpkg/commands"
+require_relative "sqlpkg/railtie" if defined?(::Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlpkg
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: x86_64-linux
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-23 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - stephen.margheim@gmail.com
@@ -40,6 +68,9 @@ files:
 - exe/x86_64-linux/sqlpkg
 - lib/sqlpkg.rb
 - lib/sqlpkg/commands.rb
+- lib/sqlpkg/generators/sqlpkg/install_generator.rb
+- lib/sqlpkg/generators/sqlpkg/templates/initializer.rb
+- lib/sqlpkg/railtie.rb
 - lib/sqlpkg/upstream.rb
 - lib/sqlpkg/version.rb
 homepage: https://github.com/fractaledmind/sqlpkg-ruby