sqlean 0.2.0-x86_64-linux-gnu

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25fe0d40ea1024689127ec0481bbd9fd561796b11d8a29d78dfa3ca5cca73992
+  data.tar.gz: 73a0912742c7d7a6e5ce528abe00368dcd8907f75878f3819ebdb092e4e9a295
+SHA512:
+  metadata.gz: 05a7d280fb707c3b5137602fbc0393f64b0364a7a1928a775adca5e971b5c4f6e3c59e206bd23640309861c6864731831ad988fad6d03b0c4a4a69cdd6d84f0b
+  data.tar.gz: be8299114f37a9ca9ddec632f51f2c765960b6a8629a71942d4ffc0b151043fa7a7be33bd777c18a4f1fd25448e6159e39b56d51c6cb56ab3783dea2aadfa8b3

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# SQLean for Ruby Changelog
+
+## v0.2.0 / 2024-11-24
+
+- Support for x86_64-linux-musl with self-built extensions.
+- Explicitly state no-support for aarch64-linux-musl.
+
+
+## v0.1.0 / 2024-11-24
+
+- Initial experimental release

data/LICENSE-DEPENDENCIES.txt

@@ -0,0 +1,25 @@
+The SQLean ruby gem ships with a third party dependency, SQLean, whose license is included below.
+
+The original license can be found at https://github.com/nalgeon/sqlean/blob/main/LICENSE
+
+    MIT License
+
+    Copyright (c) 2021+ Anton Zhiyanov <https://github.com/nalgeon/sqlean>
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mike Dalessio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# SQLean Ruby
+
+Precompiled [SQLean](https://github.com/nalgeon/sqlean) extensions for SQLite, packaged for the Ruby ecosystem. Compatible with SQLite3, Extralite, and any other sqlite-based library that exposes [`sqlite3_load_extension`](https://www.sqlite.org/c3ref/load_extension.html).
+
+
+## Usage
+
+Please read the upstream documentation at https://antonz.org/sqlean/ or https://github.com/nalgeon/sqlean for details on what is provided by the SQLean extensions.
+
+The available extensions are:
+
+- [SQLean::Crypto](https://github.com/nalgeon/sqlean/blob/main/docs/crypto.md): Hashing, encoding and decoding data
+- [SQLean::Define](https://github.com/nalgeon/sqlean/blob/main/docs/define.md): User-defined functions and dynamic SQL
+- [SQLean::FileIO](https://github.com/nalgeon/sqlean/blob/main/docs/fileio.md): Reading and writing files
+- [SQLean::Fuzzy](https://github.com/nalgeon/sqlean/blob/main/docs/fuzzy.md): Fuzzy string matching and phonetics
+- [SQLean::IPAddr](https://github.com/nalgeon/sqlean/blob/main/docs/ipaddr.md): IP address manipulation (not supported on Windows)
+- [SQLean::Math](https://github.com/nalgeon/sqlean/blob/main/docs/math.md): Math functions
+- [SQLean::Regexp](https://github.com/nalgeon/sqlean/blob/main/docs/regexp.md): Regular expressions
+- [SQLean::Stats](https://github.com/nalgeon/sqlean/blob/main/docs/stats.md): Math statistics
+- [SQLean::Text](https://github.com/nalgeon/sqlean/blob/main/docs/text.md): String functions
+- [SQLean::Unicode](https://github.com/nalgeon/sqlean/blob/main/docs/unicode.md): Unicode support
+- [SQLean::UUID](https://github.com/nalgeon/sqlean/blob/main/docs/uuid.md): Universally Unique IDentifiers
+- [SQLean::VSV](https://github.com/nalgeon/sqlean/blob/main/docs/vsv.md): CSV files as virtual tables
+
+
+### with SQLite3
+
+Extend a SQLite3 database with SQLean extensions:
+
+``` ruby
+require "sqlite3"
+require "sqlean"
+
+db = SQLite3::Database.new("path/to/db.sqlite")
+db.enable_load_extension(true)
+
+db.load_extension(SQLean.sqlite_extension_path) # load every extension in SQLean
+db.load_extension(SQLean::Crypto.sqlite_extension_path) # or load individual extensions
+```
+
+<!-- not available yet!
+or, if using sqlite3 gem >= 2.4.0:
+
+```
+db.load_extension(SQLean) # load every extension in SQLean
+db.load_extension(SQLean::Crypto) # or load individual extensions
+```
+-->
+
+<!-- also not available yet!
+### with SQLite3 in Rails
+
+When using SQLite3 v2.4.0+ and Rails 8.1.0+:
+
+``` yaml
+# config/database.yml
+
+development:
+  adapter: sqlite3
+  extensions:
+    - SQLean # load every extension in SQLean
+    - SQLean::Crypto # or load individual extensions
+```
+-->
+
+### with Extralite
+
+Extend an Extralite database with SQLean extensions:
+
+``` ruby
+require "extralite"
+require "sqlean"
+
+db = Extralite::Database.new("path/to/db.sqlite")
+
+db.load_extension(SQLean.sqlite_extension_path) # load every extension in SQLean
+db.load_extension(SQLean::Crypto.sqlite_extension_path) # or load individual extensions
+```
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add sqlean
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install sqlean
+```
+
+Note that right now, the only platforms supported are:
+
+- MacOS / Darwin:
+  - x86_64
+  - arm64
+- Linux
+  - x86_64 gnu
+  - x86_64 musl
+  - aarch64 gnu
+- Windows
+  - mingw (64-bit)
+
+Specifically what's missing is support for:
+
+- Linux aarch64 musl
+- Windows mingw32 (32-bit)
+
+If you need support for one of these platforms, please open an issue. I would also gladly welcome folks who are willing to help add support.
+
+
+## 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.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/sqlean-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/flavorjones/sqlean-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in the sqlean-ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/flavorjones/sqlean-ruby/blob/main/CODE_OF_CONDUCT.md).

data/lib/sqlean/upstream.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SQLean
+  module Upstream
+    # The version of upstream sqlean extensions used.
+    VERSION = "0.27.1"
+
+    # rubygems platform name => upstream release filename fragment
+    NATIVE_PLATFORMS = {
+      "aarch64-linux-gnu" => "linux-arm64",
+      "x86_64-linux-gnu" => "linux-x86",
+      "x86_64-linux-musl" => "linux-x86-musl",
+
+      "arm64-darwin" => "macos-arm64",
+      "x86_64-darwin" => "macos-x86",
+
+      "x64-mingw" => "win-x64"
+    }
+  end
+end

data/lib/sqlean/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SQLean
+  # The version of the SQLean gem.
+  VERSION = "0.2.0"
+end

data/lib/sqlean.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative "sqlean/version"
+require_relative "sqlean/upstream"
+
+# https://github.com/nalgeon/sqlean/blob/main/README.md
+module SQLean
+  class UnsupportedPlatform < StandardError; end
+
+  GEM_NAME = "sqlean"
+
+  # Returns an absolute path to the SQLean bundle, containing all the SQLean extensions.
+  def self.sqlite_extension_path
+    SQLean.file_path("sqlean")
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/crypto.md
+  module Crypto
+    # Returns an absolute path to the SQLean crypto extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("crypto")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/define.md
+  module Define
+    # Returns an absolute path to the SQLean define extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("define")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/fileio.md
+  module FileIO
+    # Returns an absolute path to the SQLean fileio extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("fileio")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/fuzzy.md
+  module Fuzzy
+    # Returns an absolute path to the SQLean fuzzy extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("fuzzy")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/ipaddr.md
+  module IPAddr
+    # Returns an absolute path to the SQLean ipaddr extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("ipaddr")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/math.md
+  module Math
+    # Returns an absolute path to the SQLean math extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("math")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/regexp.md
+  module Regexp
+    # Returns an absolute path to the SQLean regexp extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("regexp")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/stats.md
+  module Stats
+    # Returns an absolute path to the SQLean stats extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("stats")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/text.md
+  module Text
+    # Returns an absolute path to the SQLean text extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("text")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/time.md
+  module Time
+    # Returns an absolute path to the SQLean text extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("time")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/unicode.md
+  module Unicode
+    # Returns an absolute path to the SQLean unicode extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("unicode")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/uuid.md
+  module UUID
+    # Returns an absolute path to the SQLean uuid extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("uuid")
+    end
+  end
+
+  # https://github.com/nalgeon/sqlean/blob/main/docs/vsv.md
+  module VSV
+    # Returns an absolute path to the SQLean vsv extension.
+    def self.sqlite_extension_path
+      SQLean.file_path("vsv")
+    end
+  end
+
+  #
+  #  "private" methods
+  #
+  def self.file_path(name) # :nodoc:
+    File.join(SQLean.file_dir, name)
+  end
+
+  def self.file_dir # :nodoc:
+    @file_arch ||= begin
+      check_arch
+
+      Dir.glob(File.join(__dir__, "sqlean", "dist", "*")).find do |f|
+        Gem::Platform.match_gem?(Gem::Platform.new(File.basename(f)), GEM_NAME)
+      end
+    end
+  end
+
+  def self.check_arch # :nodoc:
+    if SQLean::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
+      raise UnsupportedPlatform, "#{GEM_NAME} does not support the #{platform} platform."
+    end
+  end
+
+  # here mostly for testing purposes (to stub)
+  def self.platform # :nodoc:
+    RUBY_PLATFORM
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sqlean
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: x86_64-linux-gnu
+authors:
+- Mike Dalessio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-24 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Precompiled SQLean extensions for SQLite, packaged for the Ruby ecosystem. Compatible with
+  SQLite3, Extralite, and any other sqlite-based library that exposes sqlite3_load_extension.
+email:
+- mike.dalessio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE-DEPENDENCIES.txt
+- LICENSE.txt
+- README.md
+- lib/sqlean.rb
+- lib/sqlean/dist/x86_64-linux-gnu/crypto.so
+- lib/sqlean/dist/x86_64-linux-gnu/define.so
+- lib/sqlean/dist/x86_64-linux-gnu/fileio.so
+- lib/sqlean/dist/x86_64-linux-gnu/fuzzy.so
+- lib/sqlean/dist/x86_64-linux-gnu/ipaddr.so
+- lib/sqlean/dist/x86_64-linux-gnu/math.so
+- lib/sqlean/dist/x86_64-linux-gnu/regexp.so
+- lib/sqlean/dist/x86_64-linux-gnu/sqlean.so
+- lib/sqlean/dist/x86_64-linux-gnu/stats.so
+- lib/sqlean/dist/x86_64-linux-gnu/text.so
+- lib/sqlean/dist/x86_64-linux-gnu/time.so
+- lib/sqlean/dist/x86_64-linux-gnu/unicode.so
+- lib/sqlean/dist/x86_64-linux-gnu/uuid.so
+- lib/sqlean/dist/x86_64-linux-gnu/vsv.so
+- lib/sqlean/upstream.rb
+- lib/sqlean/version.rb
+homepage: https://github.com/flavorjones/sqlean-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flavorjones/sqlean-ruby
+  source_code_uri: https://github.com/flavorjones/sqlean-ruby
+  changelog_uri: https://github.com/flavorjones/sqlean-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Precompiled SQLean extensions for SQLite, packaged for the Ruby ecosystem.
+test_files: []