prql-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8fc9167afeb1580aa484896e1b83417f058ecf7b6b0bd88de35e585f461d4db
+  data.tar.gz: e284f825ac898a37c10d0d441fc0d9d26f8ad1522e2284c3dfe382c535396131
+SHA512:
+  metadata.gz: 5a87ee2963ab7d4bc81c27a6469c5529e87bf0e0c75246bdee8e7775ba0fdf3331f1fa6d68297d610efad3a0985a34800c7c94dd01f4977926df1bcf5ca2b52a
+  data.tar.gz: f5413dbce65691d81f424ff0bf1cd906d23d1d226238651aa053afbb5a42fa9683ace267201d17ffcd7c53d0dca91c00dc367f19d95c9d0cde87580ed917f2a5

data/LICENSE

@@ -0,0 +1,3 @@
+This project is licensed under the GNU Affero General Public License version 3
+or any later version. See the repository-level LICENSE file for the complete
+license text.

data/README.md

@@ -0,0 +1,57 @@
+# prql-rb
+
+Ruby bindings for the [PRQL compiler](https://prql-lang.org) (`prqlc`), a
+Rust implementation of the PRQL pipelined query language.
+
+```ruby
+require "prql-rb"
+
+PrqlRb.compile(<<~PRQL)
+  from transactions
+  filter amount > 100
+  select { id, amount }
+PRQL
+# => SELECT * FROM transactions WHERE amount > 100 ... (SQL)
+```
+
+The default target dialect is PostgreSQL. Compilation failures raise
+`PrqlRb::CompileError`. No SQL is ever executed.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "prql-rb"
+```
+
+Precompiled platform gems are published for `aarch64-linux`,
+`x86_64-linux`, `arm64-darwin` and `x86_64-darwin`, so `bundle install`
+works without a Rust toolchain on those platforms. Other platforms
+build from source (requires Ruby 3.2+, Rust 1.85+).
+
+## API
+
+- `PrqlRb.compile(source, target:, format:, signature_comment:)` —
+  compile PRQL source to a SQL string.
+  - `target` — SQL dialect, e.g. `"sql.postgres"` (default),
+    `"sql.sqlite"`, `"sql.ansi"`.
+  - `format` — pretty-print the output SQL (default `true`).
+  - `signature_comment` — append the compiler signature as a comment
+    (default `false`).
+- `PrqlRb.compiler_version` — the bundled prqlc version.
+
+## Development
+
+```sh
+bin/setup   # bundle install + compile the extension
+rake        # clobber + compile + test
+```
+
+To release: tag a commit `vX.Y.Z` and push — CI builds the platform
+gems, attaches them to the GitHub release, and pushes everything to
+RubyGems.org.
+
+## License
+
+AGPL-3.0-or-later

data/bin/compile

@@ -0,0 +1,18 @@
+require "fileutils"
+require "rbconfig"
+
+gem_root = File.expand_path("..", __dir__)
+extension_dir = File.join(gem_root, "ext", "prql_rb")
+lib_dir = File.join(gem_root, "lib")
+
+Dir.chdir(extension_dir) do
+  system RbConfig.ruby, "extconf.rb", exception: true
+  system ENV.fetch("MAKE", "make"), exception: true
+end
+
+destination_dir = File.join(lib_dir, "prql_rb")
+FileUtils.mkdir_p(destination_dir)
+FileUtils.cp(
+  File.join(extension_dir, "prql_rb.#{RbConfig::CONFIG.fetch("DLEXT")}"),
+  destination_dir
+)

data/bin/setup

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args, exception: true)
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Installing dependencies =="
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Compiling native extension =="
+  system!("bundle exec ruby bin/compile")
+
+  puts "\n== Running tests =="
+  system!("bundle exec rake test")
+end