sqlpkg 0.1.1-arm64-darwin → 0.2.0-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73667f21ad1cb0d3eda1089fd9c690cee13013d5c3477018fbf377c15597b129
-  data.tar.gz: 9cf3b36a153fc2b9ac2efd038f0fdfa4618a1a7c807add60a79f13deb4cbce73
+  metadata.gz: 4b73f78b45641183ffd47147581f393170053aa646826113dd9f097765d7f693
+  data.tar.gz: 8137648a54b09b7d4e739b341a078ed05fff1018cb9be5096916e88036364090
 SHA512:
-  metadata.gz: 842b1b4d97e02d773386a2f770c5f1d11a350720f33763f7581f9b997f2af42ed586d2ea363e906a84361b80bfd95818a734c53aaa0e8441f0c75726a46f6491
-  data.tar.gz: 55230daa05e08a82090384d643064a19005d17db9ecca483a83be3ed9e941ac3e5d84d79c1ae8e5591e8398448b6440dacb6913dc9a992d585bde7ffc9969f4a
+  metadata.gz: d18783851d8c9a174894cbd7440d478e6fa8053ab819c1c34f54bda5814c0be0d3e35a776b69ef01322ded9cc0efca4d9f696804527cb0b5f62096cef333d865
+  data.tar.gz: 30a933bce57ca714fd600118e8470dc575875ed981579cf9b87a69997b7f2123057c78db71089b128dda41e8153b0680dbf8be5184e02af369d9a47b574a8ce5

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-darwin
 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