ilios 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 035cde2f726822e26aa111fc8998c14f68849cd2ad5ac90c738d0b4fde8fa87c
-  data.tar.gz: e565f45883e0056d4b009790ca260dffbe3b42b2afc507d0cdd4bf30b765fab4
+  metadata.gz: b5dee1fc3383cb4e1c7ee917e6b582456b02ef3e1121ca62b65ad5f94e827706
+  data.tar.gz: c6f7a9a6ae097cc74a644ec2d1d4d1b8fadcfc09697db4a537ab6e500ed8e6ef
 SHA512:
-  metadata.gz: 577089ba568337c8482f137df676d50959aca02a17e02b0978bafd3dd8fb9063c344f466a19e8c17f8e950e390f8513249b8f1c1862ad42d4917cd4ffba17978
-  data.tar.gz: ecbf6f1f31990c9cc04a466ddd615725320157d91b1513417c3719830aad2b47909201626b1f73b504bfd1a2ef29fac8a012db060e327e3cef2cbaa870d82429
+  metadata.gz: 372a423c84b1a61457f2be6f7a7f639664d5854a0b274cb77936052e0ea2da29c5af61c36202d9363c9e7c1f4e39258480ecfe81e875f32bc3fad6c70b072b69
+  data.tar.gz: fa5a1d64b04fc51b1a831204af7d82154c72631f0276fee2ebfcf0641af3b82940664793c995365551312c5d8ad56ccc16fc640dbb9577410d8671c7c3d17d09

data/README.md

@@ -16,12 +16,22 @@ If bundler is not being used to manage dependencies, install the gem by executin
 $ gem install ilios
 ```
 
+## Requirements
+
+- cmake (in order to build the DataStax C/C++ Driver and libuv)
+
+## Supported
+
+- Ruby 3.0 or later
+- Cassandra 3.0 or later
+- Linux and macOS platform
+
 ## Example
 ### Basic usage
 
 Create the keyspace in advance using the `cqlsh` command.
 
-```sh
+```cql
 CREATE KEYSPACE IF NOT EXISTS ilios
 WITH REPLICATION = {
   'class' : 'SimpleStrategy',
@@ -73,6 +83,7 @@ end
 statement = Ilios::Cassandra.session.prepare(<<~CQL)
   SELECT * FROM ilios.example
 CQL
+statement.idempotent = true
 statement.page_size = 25
 result = Ilios::Cassandra.session.execute(statement)
 result.each do |row|

data/ext/ilios/cassandra.c

@@ -14,7 +14,6 @@ static VALUE cassandra_connect(VALUE self)
     VALUE config;
     VALUE hosts;
     VALUE keyspace;
-    char last_error[4096] = { 0 };
 
     cassandra_session_obj = CREATE_SESSION(cassandra_session);
 
@@ -39,29 +38,24 @@ static VALUE cassandra_connect(VALUE self)
 
     for (int i = 0; i < RARRAY_LEN(hosts); i++) {
         VALUE host = RARRAY_AREF(hosts, i);
-
-        cass_cluster_set_contact_points(cassandra_session->cluster, ""); // Clear previous contact points
         cass_cluster_set_contact_points(cassandra_session->cluster, StringValueCStr(host));
-        cassandra_session->session = cass_session_new();
-        cassandra_session->connect_future =  cass_session_connect_keyspace(cassandra_session->session, cassandra_session->cluster, StringValueCStr(keyspace));
-        nogvl_future_wait(cassandra_session->connect_future);
+    }
+    cassandra_session->session = cass_session_new();
+    cassandra_session->connect_future =  cass_session_connect_keyspace(cassandra_session->session, cassandra_session->cluster, StringValueCStr(keyspace));
+    nogvl_future_wait(cassandra_session->connect_future);
 
-        if (cass_future_error_code(cassandra_session->connect_future) == CASS_OK) {
-            return cassandra_session_obj;
-        }
+    if (cass_future_error_code(cassandra_session->connect_future) != CASS_OK) {
+        char error[4096] = { 0 };
 
-        strncpy(last_error, cass_error_desc(cass_future_error_code(cassandra_session->connect_future)), sizeof(last_error) - 1);
+        strncpy(error, cass_error_desc(cass_future_error_code(cassandra_session->connect_future)), sizeof(error) - 1);
         cass_future_free(cassandra_session->connect_future);
         cass_session_free(cassandra_session->session);
-        cassandra_session->connect_future = NULL;
-        cassandra_session->session = NULL;
+        cass_cluster_free(cassandra_session->cluster);
+        rb_raise(eConnectError, "Unable to connect: %s", error);
+        return Qnil;
     }
 
-    cass_cluster_free(cassandra_session->cluster);
-    cassandra_session->cluster = NULL;
-
-    rb_raise(eConnectError, "Unable to connect: %s", last_error);
-    return Qnil;
+    return cassandra_session_obj;
 }
 
 void Init_cassandra(void)

data/ext/ilios/extconf.rb

@@ -11,6 +11,20 @@ have_func('malloc_size')
 CASSANDRA_CPP_DRIVER_INSTALL_PATH = File.expand_path('cpp-driver')
 LIBUV_INSTALL_PATH = File.expand_path('libuv')
 
+def num_cpu_cores
+  cores =
+    begin
+      if RUBY_PLATFORM.include?('darwin')
+        Integer(`sysctl -n hw.ncpu`, 10) - 1
+      else
+        Integer(`nproc`, 10) - 1
+      end
+    rescue StandardError
+      2
+    end
+  cores.positive? ? cores : 1
+end
+
 unless find_executable('cmake')
   puts '--------------------------------------------------'
   puts 'Error: cmake is required to build this gem'
@@ -25,7 +39,7 @@ unless File.exist?(LIBUV_INSTALL_PATH)
     end
   end
 
-  libuv_recipe = LibuvRecipe.new('libuv', Ilios::LIBUV_VERSION, make_command: 'make -j 3')
+  libuv_recipe = LibuvRecipe.new('libuv', Ilios::LIBUV_VERSION, make_command: "make -j #{num_cpu_cores}")
   libuv_recipe.files << {
     url: "https://github.com/libuv/libuv/archive/v#{Ilios::LIBUV_VERSION}.tar.gz"
   }
@@ -53,7 +67,7 @@ unless File.exist?(CASSANDRA_CPP_DRIVER_INSTALL_PATH)
     end
   end
 
-  cassandra_recipe = CassandraRecipe.new('cpp-driver', Ilios::CASSANDRA_CPP_DRIVER_VERSION, make_command: 'make -j 3')
+  cassandra_recipe = CassandraRecipe.new('cpp-driver', Ilios::CASSANDRA_CPP_DRIVER_VERSION, make_command: "make -j #{num_cpu_cores}")
   cassandra_recipe.files << {
     url: "https://github.com/datastax/cpp-driver/archive/#{Ilios::CASSANDRA_CPP_DRIVER_VERSION}.tar.gz"
   }

data/ext/ilios/future.c

@@ -212,6 +212,15 @@ static VALUE future_on_success(VALUE self)
 
     cassandra_future->on_success_block = rb_block_proc();
 
+    if (cass_future_ready(cassandra_future->future)) {
+        rb_mutex_unlock(cassandra_future->proc_mutex);
+        uv_sem_post(&cassandra_future->sem);
+        if (cass_future_error_code(cassandra_future->future) == CASS_OK) {
+            future_result_success_yield(cassandra_future);
+        }
+        return self;
+    }
+
     if (wakeup_thread) {
         future_queue_push(future_thread_pool_get(cassandra_future), self);
     }
@@ -250,6 +259,15 @@ static VALUE future_on_failure(VALUE self)
 
     cassandra_future->on_failure_block = rb_block_proc();
 
+    if (cass_future_ready(cassandra_future->future)) {
+        rb_mutex_unlock(cassandra_future->proc_mutex);
+        uv_sem_post(&cassandra_future->sem);
+        if (cass_future_error_code(cassandra_future->future) != CASS_OK) {
+            future_result_failure_yield(cassandra_future);
+        }
+        return self;
+    }
+
     if (wakeup_thread) {
         future_queue_push(future_thread_pool_get(cassandra_future), self);
     }

data/ext/ilios/ilios.h

@@ -7,6 +7,7 @@
 #include <uv.h>
 #include "ruby.h"
 #include "ruby/thread.h"
+#include "ruby/encoding.h"
 
 #define GET_SESSION(obj, var)   TypedData_Get_Struct(obj, CassandraSession, &cassandra_session_data_type, var)
 #define GET_STATEMENT(obj, var) TypedData_Get_Struct(obj, CassandraStatement, &cassandra_statement_data_type, var)

data/ext/ilios/result.c

@@ -80,7 +80,7 @@ static VALUE result_convert_row(const CassResult *result, const CassRow *row, si
         const CassValueType type = cass_value_type(value);
 
         cass_result_column_name(result, i, &name, &name_length);
-        key = rb_str_new(name, name_length);
+        key = rb_enc_interned_str(name, name_length, rb_utf8_encoding());
 
         if (cass_value_is_null(value)) {
             rb_hash_aset(hash, key, Qnil);

data/ext/ilios/statement.c

@@ -21,6 +21,7 @@ void statement_default_config(CassandraStatement *cassandra_statement)
 {
     VALUE config = rb_cvar_get(mCassandra, id_cvar_config);
 
+    cass_statement_set_request_timeout(cassandra_statement->statement, NUM2INT(rb_hash_aref(config, sym_timeout_ms)));
     cass_statement_set_paging_size(cassandra_statement->statement, NUM2INT(rb_hash_aref(config, sym_page_size)));
 }
 
@@ -186,6 +187,23 @@ static VALUE statement_page_size(VALUE self, VALUE page_size)
     return self;
 }
 
+/**
+ * Sets whether the statement is idempotent. Idempotent statements are able to be
+ * automatically retried after timeouts/errors and can be speculatively executed.
+ * The default is +false+.
+ *
+ * @param idempotent [Boolean] Whether the statement is idempotent.
+ * @return [Cassandra::Statement] self.
+ */
+static VALUE statement_idempotent(VALUE self, VALUE idempotent)
+{
+    CassandraStatement *cassandra_statement;
+
+    GET_STATEMENT(self, cassandra_statement);
+    cass_statement_set_is_idempotent(cassandra_statement->statement, RTEST(idempotent) ? cass_true : cass_false);
+    return self;
+}
+
 static void statement_mark(void *ptr)
 {
     CassandraStatement *cassandra_statement = (CassandraStatement *)ptr;
@@ -224,4 +242,5 @@ void Init_statement(void)
 
     rb_define_method(cStatement, "bind", statement_bind, 1);
     rb_define_method(cStatement, "page_size=", statement_page_size, 1);
+    rb_define_method(cStatement, "idempotent=", statement_idempotent, 1);
 }

data/ilios.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/Watson1978/ilios'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/Watson1978/ilios/issues'
+  spec.metadata['documentation_uri'] = "https://www.rubydoc.info/gems/ilios/#{Ilios::VERSION}"
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
   spec.metadata['rubygems_mfa_required'] = 'true'
 

data/lib/ilios/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Ilios
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
   public_constant :VERSION
 
   CASSANDRA_CPP_DRIVER_VERSION = '2.17.1'

data/sig/ilios.rbs

@@ -1,4 +1,40 @@
 module Ilios
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  module Cassandra
+    def self.config=: (Hash[Symbol, untyped]) -> void
+    def self.session: () -> Ilios::Cassandra::Session
+    def self.connect: () -> Ilios::Cassandra::Session
+
+    class Session
+      def prepare_async: (String) -> Ilios::Cassandra::Future
+      def prepare: (String) -> Ilios::Cassandra::Statement
+
+      def execute_async: (Ilios::Cassandra::Statement) -> Ilios::Cassandra::Future
+      def execute: (Ilios::Cassandra::Statement) -> Ilios::Cassandra::Result
+    end
+
+    class Statement
+      def bind: (Hash[Symbol, untyped] | Hash[String, untyped]) -> self
+      def page_size=: (Integer) -> self
+      def idempotent=: (true | false) -> self
+    end
+
+    class Future
+      def on_success: () { (Ilios::Cassandra::Result) -> void } -> self
+      def on_failure: () { () -> void } -> self
+      def await: () -> Ilios::Cassandra::Future
+    end
+
+    class Result
+      type row_type = Hash[String, untyped]
+
+      include Enumerable[row_type]
+
+      def each:  () { (row_type) -> void } -> void |
+                 () -> ::Enumerator[row_type, self]
+      def next_page: () -> Ilios::Cassandra::Result |
+                     () -> nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ilios
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Watson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -57,6 +57,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Watson1978/ilios
   source_code_uri: https://github.com/Watson1978/ilios
+  bug_tracker_uri: https://github.com/Watson1978/ilios/issues
+  documentation_uri: https://www.rubydoc.info/gems/ilios/0.3.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []