sqlpkg 0.1.1-arm64-linux → 0.2.0-arm64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e166f7f9f9f3e163a538f3e41b10ae34072e4aee98df764d261da20d3289722
-  data.tar.gz: b81065bf57e645828e568b9ac15e7033433470f265755a6e81afe05869f39939
+  metadata.gz: 49f444c0a4b8ee6cb510442fa43da928593173fa1feb943038c4f334e8c47a00
+  data.tar.gz: 2385f3ee46c596c0b82fe06b3bd7675c5bfe1917e055c05dd00333a43d150bf0
 SHA512:
-  metadata.gz: d557a5052790f70a0fb27332fdf196b6a30cd9a47427e9eb8502e949fea3aad5a61032067fd173ab3429fc3625c0287d4c855e33e16d9a5b91aa6625a7c23772
-  data.tar.gz: 4b363edc6a64ad7d8f78419d6ec0f97b1868cbd9d0f4f89d66cb7b3396172eefb4e6ce9860ad1e2397ba22a77236a53fb64a831c0bf72fbdc17f60947c9ffd53
+  metadata.gz: 849c9cd6393852ab5e848281e4f4d85d6edb89479f9b103e5b89d3fcee6bde85b61b315bb702a0e40a8197c197830a6d1296751acce72fa90025047740e31aa0
+  data.tar.gz: b4527c38cc37338bf61d869e0feca158637c41905dc17dc5420058bb667773d13cc6da2d559276e96de71ec3f3b4302e0804fb544ce583c8be7b5e28517775bd

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.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqlpkg
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: arm64-linux
 authors:
 - Stephen Margheim
@@ -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