sqlpkg 0.1.1-arm64-linux → 0.2.1-arm64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e166f7f9f9f3e163a538f3e41b10ae34072e4aee98df764d261da20d3289722
-  data.tar.gz: b81065bf57e645828e568b9ac15e7033433470f265755a6e81afe05869f39939
+  metadata.gz: 907fcf704962c23ac6aba40436b345bcba63faa16dc71200b53143b6b7dc7a64
+  data.tar.gz: 2ebdb6fd768de6ab1784c907e72d02e033fd13f3afa13b7d9b91f1354b86364f
 SHA512:
-  metadata.gz: d557a5052790f70a0fb27332fdf196b6a30cd9a47427e9eb8502e949fea3aad5a61032067fd173ab3429fc3625c0287d4c855e33e16d9a5b91aa6625a7c23772
-  data.tar.gz: 4b363edc6a64ad7d8f78419d6ec0f97b1868cbd9d0f4f89d66cb7b3396172eefb4e6ce9860ad1e2397ba22a77236a53fb64a831c0bf72fbdc17f60947c9ffd53
+  metadata.gz: af6fd6c3aa1fea6ad77fc9cc5cf0ed5206e9c51326fd143474feeb8876da67533eb5ffe1610fa05d6533e2c2a4375f9d7c92bae721f6698ff4349d9aecfb88ed
+  data.tar.gz: c42676e2cf0cfeeb29b06ac2324788c7affd70760b0b03f70bcae68fc42d267e7610e90f5741ffa8bc4f913270cf59c45c76e911d3897acd2d1ec1edc6aa30cd

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: arm64-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/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