libsql_ruby 0.1.0

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/libsql"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Haile Lagi
+
+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,48 @@
+# LibSQL Ruby
+
+A low-level ruby driver for libSQL/SQLite3.
+
+## Example
+
+```ruby
+require "libsql_ruby"
+
+db = LibSQL::Database.new "test.db"
+
+rows = db.execute <<-SQL
+  create table user (
+    name varchar(30),
+    age int
+  );
+SQL
+```
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/libsql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "rb_sys/extensiontask"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+GEMSPEC = Gem::Specification.load("libsql.gemspec")
+
+RbSys::ExtensionTask.new("libsql", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/libsql"
+end
+
+begin
+  require "ruby_memcheck"
+  require "ruby_memcheck/rspec/rake_task"
+
+  namespace :spec do
+    RubyMemcheck::RSpec::RakeTask.new(:valgrind)
+  end
+rescue LoadError => e
+  warn("ruby memcheck not available, cannot run valgrind #{e}")
+end
+
+desc "Compile the extension with debug symbols"
+task "compile:debug" do
+  ENV["RB_SYS_CARGO_PROFILE"] = "dev"
+  Rake::Task["compile"].invoke
+end
+
+task build: :compile
+task default: %i[compile spec rubocop]

data/ext/libsql/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "libsql"
+version = "0.1.0"
+description = "ruby interface for libSQL"
+edition = "2021"
+authors = ["Haile Lagi <52631736+hailelagi@users.noreply.github.com>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dev-dependencies]
+rb-sys-env = { version = "0.1" }
+rb-sys-test-helpers = { version = "0.2" }
+
+[dependencies]
+bytes = "1.5.0"
+lazy_static = "1.4.0"
+tokio = { version = "1.29.1", features = [ "rt-multi-thread" ] }
+magnus = { version = "0.7.1", features = ["rb-sys"] }
+rb-sys = { version = "0.9.98", features = ["global-allocator"] }
+hyper-rustls = { version = "0.25", features = ["webpki-roots"]}
+tracing-subscriber = { version = "0.3", features = ["env-filter"] } 
+libsql = { version = "0.3.5", features = ["remote", "replication", "core", "encryption"] }
+once_cell = "1.19.0"
+serde = { version = "1.0.199", features = ["derive"]}
+serde_json = "1.0.116"
+uuid = "1.8.0"
+
+[profile.release]
+debug = false
+strip = true
+panic = "abort"
+

data/ext/libsql/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("libsql/libsql")

data/ext/libsql/src/database.rs

@@ -0,0 +1,23 @@
+//! Database.rs 
+//! 
+//! 
+
+#[cfg(test)]
+mod tests {
+    use rb_sys_test_helpers::ruby_test;
+    use rb_sys::{rb_num2fix, rb_int2big, FIXNUM_P};
+
+    #[ruby_test]
+    fn test_something() {
+        // Your test code here will have a valid Ruby VM (hint: this works with
+        // the `magnus` crate, too!)
+        //
+        // ...
+
+        let int = unsafe { rb_num2fix(1) };
+        let big = unsafe { rb_int2big(9999999) };
+
+        assert!(FIXNUM_P(int));
+        assert!(!FIXNUM_P(big));
+    }
+}

data/ext/libsql/src/lib.rs

@@ -0,0 +1,14 @@
+use magnus::{function, prelude::*, Error, Ruby};
+
+mod database;
+
+fn hello(subject: String) -> String {
+    format!("Hello from Rust, {subject}!")
+}
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("LibSQL")?;
+    module.define_singleton_method("hello", function!(hello, 1))?;
+    Ok(())
+}

data/lib/libsql/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LibSQL
+  VERSION = "0.1.0"
+  SQLITE3_VERSION = "0.0.0"
+end

data/lib/libsql.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "libsql/version"
+require_relative "libsql/libsql"
+
+module LibSQL
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/libsql.rbs

@@ -0,0 +1,4 @@
+module LibSQL
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: libsql_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Haile Lagi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+description:
+email:
+- 52631736+hailelagi@users.noreply.github.com
+executables: []
+extensions:
+- ext/libsql/Cargo.toml
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/libsql/Cargo.toml
+- ext/libsql/extconf.rb
+- ext/libsql/src/database.rs
+- ext/libsql/src/lib.rs
+- lib/libsql.rb
+- lib/libsql/version.rb
+- sig/libsql.rbs
+homepage: https://github.com/hailelagi/libsql_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hailelagi/libsql_ruby
+  source_code_uri: https://github.com/hailelagi/libsql_ruby
+  changelog_uri: https://github.com/hailelagi/libsql_ruby/CHANGELOG.md
+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: 3.3.11
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: Ruby driver for libSQL.
+test_files: []