dartsclone 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd79764c75c8fd8c2b7dc55b5f80c3875a0641420f05a9d1e07d701ffc15a17
-  data.tar.gz: 70799ddcdb885b78fa338a36b28063df1ae41a0f87d3be6a1aad8faec8b939a7
+  metadata.gz: 1da00e4a34b27cfb6c92d84becee7272ae1750435162fc54569ac56eac480e3a
+  data.tar.gz: b4eef44bc5a1bed3e90a2feb672583042c06c663546753867281f470f16a8295
 SHA512:
-  metadata.gz: af070c15bc7b53a58d06200a2a8da7ce931161c470248f43a80365af3323122db200fa467bce0fe738d5ecfbd1dde8865733c37a27dcf7d00f5c8947341feeef
-  data.tar.gz: d4bad89bbbb9b2a7c8aa0defb663e56db7cbdae2a934308ebb86c8ad4ddc24a8d659722186b1ce9de4ce1f4faeaefb17821f1564ec54865e668813ca06617994
+  metadata.gz: 1a56790440c9bbd25ade6b59b5998d5201e119e92750afc659bc673c652e127d2edb19700de238ab6f03edc9e7272c300a7a995b49157ca952347c7ed1017e8b
+  data.tar.gz: 542dc9c97512fc29b2cfb54366370aca0105c724aa6f1a230071615a07667e1e2956089b966241fc936cfafa1faf6e1d6defe105c788e4fe1e30ead7a77993d4

data/.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install --no-document bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.gitignore

@@ -15,6 +15,7 @@ mkmf.log
 tags
 .DS_Store
 .ruby-version
+spec/foo.dat
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,2 +1,18 @@
+## 0.3.0
+- Add type declaration file: sig/dartsclone.rbs
+
+## 0.2.3
+- Fix some codes and configulation files.
+
+## 0.2.2
+- Refactor native extension codes considering garbage collection.
+
+## 0.2.1
+- Replace Data_ functions to TypedData_ functions.
+- Fix some config files.
+
+## 0.2.0
+- Add get_array and set_array methods to dump and load array data.
+
 ## 0.1.0
 - First release.

data/Gemfile

@@ -3,6 +3,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in darts.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rake-compiler"
 gem "rspec", "~> 3.0"
+gem "rbs", "~> 1.2"
+gem "steep", "~> 0.44"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Atsushi Tatsuma
+Copyright (c) 2020-2021 Atsushi Tatsuma
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,8 +1,8 @@
 # Darts-clone.rb
 
-[![Build Status](https://travis-ci.org/yoshoku/darts-clone.rb.svg?branch=master)](https://travis-ci.org/yoshoku/darts-clone.rb)
+[![Build Status](https://github.com/yoshoku/darts-clone.rb/workflows/build/badge.svg)](https://github.com/yoshoku/darts-clone.rb/actions?query=workflow%3Abuild)
 [![Gem Version](https://badge.fury.io/rb/dartsclone.svg)](https://badge.fury.io/rb/dartsclone)
-[![BSD 2-Clause License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/yoshoku/darts-clone.rb/blob/master/LICENSE.txt)
+[![BSD 2-Clause License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/yoshoku/darts-clone.rb/blob/main/LICENSE.txt)
 
 Darts-clone.rb is a Ruby binding for the [Darts-clone](https://github.com/s-yata/darts-clone).
 
@@ -51,14 +51,14 @@ da.open('foo.dat')
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/darts-clone.rb.
-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/yoshoku/darts-clone.rb/blob/master/CODE_OF_CONDUCT.md).
+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/yoshoku/darts-clone.rb/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [BSD 2-clause License](https://opensource.org/licenses/BSD-2-Clause).
 Moreover, the gem includes the source code of Darts-clone.
-The License of Darts-clone can be found in [COPYING.md](https://github.com/yoshoku/darts-clone.rb/blob/master/ext/dartsclone/src/COPYING.md).
+The License of Darts-clone can be found in [COPYING.md](https://github.com/yoshoku/darts-clone.rb/blob/main/ext/dartsclone/src/COPYING.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Darts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/darts-clone.rb/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Darts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/darts-clone.rb/blob/main/CODE_OF_CONDUCT.md).

data/Steepfile

@@ -0,0 +1,20 @@
+target :lib do
+  signature "sig"
+#
+  check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

data/dartsclone.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/darts-clone.rb/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://github.com/yoshoku/darts-clone.rb#usage'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/ext/dartsclone/dartscloneext.hpp

@@ -1,6 +1,8 @@
 #ifndef DARTSCLONEEXT_HPP
 #define DARTSCLONEEXT_HPP 1
 
+#include <cstring>
+
 #include <ruby.h>
 #include <darts.h>
 
@@ -9,17 +11,21 @@ class RbDoubleArray
   public:
     static VALUE double_array_alloc(VALUE self) {
       Darts::DoubleArray* ptr = (Darts::DoubleArray*)ruby_xmalloc(sizeof(Darts::DoubleArray));
-      return Data_Wrap_Struct(self, NULL, double_array_free, ptr);
+      return TypedData_Wrap_Struct(self, &double_array_type, ptr);
     };
 
-    static void double_array_free(Darts::DoubleArray* ptr) {
-      ptr->~DoubleArrayImpl();
+    static void double_array_free(void* ptr) {
+      ((Darts::DoubleArray*)ptr)->~DoubleArrayImpl();
       ruby_xfree(ptr);
     };
 
+    static size_t double_array_size(const void* ptr) {
+      return sizeof(*((Darts::DoubleArray*)ptr));
+    };
+
     static Darts::DoubleArray* get_double_array(VALUE self) {
       Darts::DoubleArray* ptr;
-      Data_Get_Struct(self, Darts::DoubleArray, ptr);
+      TypedData_Get_Struct(self, Darts::DoubleArray, &double_array_type, ptr);
       return ptr;
     };
 
@@ -30,6 +36,8 @@ class RbDoubleArray
       rb_define_method(rb_cDoubleArray, "build", RUBY_METHOD_FUNC(_double_array_build), -1);
       rb_define_method(rb_cDoubleArray, "open", RUBY_METHOD_FUNC(_double_array_open), -1);
       rb_define_method(rb_cDoubleArray, "save", RUBY_METHOD_FUNC(_double_array_save), -1);
+      rb_define_method(rb_cDoubleArray, "get_array", RUBY_METHOD_FUNC(_double_array_get_array), 0);
+      rb_define_method(rb_cDoubleArray, "set_array", RUBY_METHOD_FUNC(_double_array_set_array), 1);
       rb_define_method(rb_cDoubleArray, "exact_match_search", RUBY_METHOD_FUNC(_double_array_exact_match_search), -1);
       rb_define_method(rb_cDoubleArray, "common_prefix_search", RUBY_METHOD_FUNC(_double_array_common_prefix_search), -1);
       rb_define_method(rb_cDoubleArray, "traverse", RUBY_METHOD_FUNC(_double_array_traverse), -1);
@@ -41,6 +49,8 @@ class RbDoubleArray
     };
 
   private:
+    static const rb_data_type_t double_array_type;
+
     static VALUE _double_array_init(VALUE self) {
       Darts::DoubleArray* ptr = get_double_array(self);
       new (ptr) Darts::DoubleArray();
@@ -60,22 +70,26 @@ class RbDoubleArray
       const int n_keys = RARRAY_LEN(_keys);
       char** keys = (char**)ruby_xmalloc(n_keys * sizeof(char*));
       int* values = _values == Qundef ? NULL : (int*)ruby_xmalloc(n_keys * sizeof(int));
+      VALUE key_str;
       for (int i = 0; i < n_keys; i++) {
-        VALUE key_str = rb_ary_entry(_keys, i);
-        keys[i] = StringValueCStr(key_str);
+        key_str = rb_ary_entry(_keys, i);
+        keys[i] = strcpy((char*)ruby_xmalloc((RSTRING_LEN(key_str) + 1) * sizeof(char)), StringValueCStr(key_str));
         if (_values != Qundef) values[i] = NUM2INT(rb_ary_entry(_values, i));
       }
 
       try {
         get_double_array(self)->build(n_keys, keys, NULL, values);
       } catch (Darts::Details::Exception e) {
+        for (int i = 0; i < n_keys; i++) ruby_xfree(keys[i]);
         ruby_xfree(keys);
         if (_values != Qundef) ruby_xfree(values);
         rb_raise(rb_eRuntimeError, "%s", e.what());
         return Qfalse;
       }
+      for (int i = 0; i < n_keys; i++) ruby_xfree(keys[i]);
       ruby_xfree(keys);
       if (_values != Qundef) ruby_xfree(values);
+      RB_GC_GUARD(key_str);
       return Qtrue;
     }
 
@@ -89,13 +103,16 @@ class RbDoubleArray
       rb_get_kwargs(kwargs, kwtable, 0, 3, kwvalues);
 
       const char* filename = StringValueCStr(_filename);
-      const char* mode = kwvalues[0] == Qundef ? "rb" : StringValueCStr(kwvalues[0]);
-      const size_t offset = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
-      const size_t size = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+      VALUE _mode = kwvalues[0];
+      const char* mode = kwvalues[0] == Qundef ? "rb" : StringValueCStr(_mode);
+      const size_t offset = kwvalues[1] == Qundef ? 0 : NUM2SIZET(kwvalues[1]);
+      const size_t size = kwvalues[2] == Qundef ? 0 : NUM2SIZET(kwvalues[2]);
 
       if (get_double_array(self)->open(filename, mode, offset, size) != 0) {
         return Qfalse;
       }
+      RB_GC_GUARD(_filename);
+      RB_GC_GUARD(_mode);
       return Qtrue;
     };
 
@@ -109,15 +126,33 @@ class RbDoubleArray
       rb_get_kwargs(kwargs, kwtable, 0, 2, kwvalues);
 
       const char* filename = StringValueCStr(_filename);
-      const char* mode = kwvalues[0] == Qundef ? "wb" : StringValueCStr(kwvalues[0]);
-      const size_t offset = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+      VALUE _mode = kwvalues[0];
+      const char* mode = kwvalues[0] == Qundef ? "wb" : StringValueCStr(_mode);
+      const size_t offset = kwvalues[1] == Qundef ? 0 : NUM2SIZET(kwvalues[1]);
 
       if (get_double_array(self)->save(filename, mode, offset) != 0) {
         return Qfalse;
       }
+      RB_GC_GUARD(_filename);
+      RB_GC_GUARD(_mode);
       return Qtrue;
     };
 
+    static VALUE _double_array_get_array(VALUE self) {
+      const char* arr = (char*)get_double_array(self)->array();
+      const size_t sz = get_double_array(self)->total_size();
+      return rb_str_new(arr, sz);
+    };
+
+    static VALUE _double_array_set_array(VALUE self, VALUE bytes) {
+      const size_t sz = NUM2SIZET(rb_funcall(bytes, rb_intern("size"), 0));
+      const size_t total_sz = sz / get_double_array(self)->unit_size();
+      char* arr = StringValuePtr(bytes);
+      get_double_array(self)->set_array(arr, total_sz);
+      RB_GC_GUARD(bytes);
+      return Qnil;
+    };
+
     static VALUE _double_array_exact_match_search(int argc, VALUE* argv, VALUE self) {
       VALUE _key = Qnil;
       VALUE kwargs = Qnil;
@@ -133,11 +168,12 @@ class RbDoubleArray
       }
 
       const char* key = StringValueCStr(_key);
-      const size_t length = kwvalues[0] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[0]);
-      const size_t node_pos = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+      const size_t length = kwvalues[0] == Qundef ? 0 : NUM2SIZET(kwvalues[0]);
+      const size_t node_pos = kwvalues[1] == Qundef ? 0 : NUM2SIZET(kwvalues[1]);
 
       Darts::DoubleArray::value_type value;
       get_double_array(self)->exactMatchSearch(key, value, length, node_pos);
+      RB_GC_GUARD(_key);
       return INT2NUM(value);
     };
 
@@ -156,9 +192,9 @@ class RbDoubleArray
       }
 
       const char* key = StringValueCStr(_key);
-      const size_t max_num_results = kwvalues[0] == Qundef ? (size_t)NUM2INT(rb_funcall(_key, rb_intern("size"), 0)) : (size_t)NUM2INT(kwvalues[0]);
-      const size_t length = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
-      const size_t node_pos = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+      const size_t max_num_results = kwvalues[0] == Qundef ? NUM2SIZET(rb_funcall(_key, rb_intern("size"), 0)) : NUM2SIZET(kwvalues[0]);
+      const size_t length = kwvalues[1] == Qundef ? 0 : NUM2SIZET(kwvalues[1]);
+      const size_t node_pos = kwvalues[2] == Qundef ? 0 : NUM2SIZET(kwvalues[2]);
 
       Darts::DoubleArray::result_pair_type* results =
         (Darts::DoubleArray::result_pair_type*)ruby_xmalloc(max_num_results * sizeof(Darts::DoubleArray::result_pair_type));
@@ -178,6 +214,7 @@ class RbDoubleArray
         rb_ary_push(ret, values);
       }
       ruby_xfree(results);
+      RB_GC_GUARD(_key);
       return ret;
     };
 
@@ -191,9 +228,9 @@ class RbDoubleArray
       rb_get_kwargs(kwargs, kwtable, 2, 1, kwvalues);
 
       const char* key = StringValueCStr(_key);
-      size_t node_pos = (size_t)NUM2INT(kwvalues[0]);
-      size_t key_pos = (size_t)NUM2INT(kwvalues[1]);
-      const size_t length = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+      size_t node_pos = NUM2SIZET(kwvalues[0]);
+      size_t key_pos = NUM2SIZET(kwvalues[1]);
+      const size_t length = kwvalues[2] == Qundef ? 0 : NUM2SIZET(kwvalues[2]);
 
       Darts::DoubleArray::value_type value = get_double_array(self)->traverse(key, node_pos, key_pos, length);
 
@@ -201,6 +238,7 @@ class RbDoubleArray
       rb_hash_aset(ret, ID2SYM(rb_intern("value")), INT2NUM(value));
       rb_hash_aset(ret, ID2SYM(rb_intern("node_pos")), INT2NUM((int)node_pos));
       rb_hash_aset(ret, ID2SYM(rb_intern("key_pos")), INT2NUM((int)key_pos));
+      RB_GC_GUARD(_key);
       return ret;
     };
 
@@ -226,4 +264,16 @@ class RbDoubleArray
     };
 };
 
+const rb_data_type_t RbDoubleArray::double_array_type = {
+  "RbDoubleArray",
+  {
+    NULL,
+    RbDoubleArray::double_array_free,
+    RbDoubleArray::double_array_size
+  },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
 #endif /* DARTSCLONEEXT_HPP */

data/lib/dartsclone/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module DartsClone
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
   DARTS_CLONE_VERSION = '0.32'
 end

data/sig/dartsclone.rbs

@@ -0,0 +1,20 @@
+module DartsClone
+  VERSION: String
+  DARTS_CLONE_VERSION: String
+
+  class DoubleArray
+    def initialize: () -> void
+    def build: (Array[String] keys, ?values: Array[Integer]? values) -> bool
+    def open: (String filename) -> bool
+    def save: (String filename, ?mode: String mode, ?offset: Integer offset) -> bool
+    def get_array: () -> String
+    def set_array: (String str) -> nil
+    def exact_match_search: (String key, ?length: Integer length, ?node_pos: Integer node_pos) -> Integer
+    def common_prefix_search: (String key, ?max_num_results: Integer? max_num_results, ?length: Integer length, ?node_pos: Integer node_pos) -> [Array[String], Array[Integer]]
+    def traverse: (String key, ?node_pos: Integer? node_pos, ?key_pos: Integer? key_pos, ?length: Integer? length) -> { value: Integer, node_pos: Integer, key_pos: Integer }
+    def unit_size: () -> Integer
+    def size: () -> Integer
+    def total_size: () -> Integer
+    def clear: () -> nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dartsclone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies: []
 description: Darts-clone.rb is a Ruby binding for the Darts-clone.
 email:
@@ -18,15 +18,16 @@ extensions:
 - ext/dartsclone/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - dartsclone.gemspec
 - ext/dartsclone/dartscloneext.cpp
 - ext/dartsclone/dartscloneext.hpp
@@ -35,6 +36,7 @@ files:
 - ext/dartsclone/src/darts.h
 - lib/dartsclone.rb
 - lib/dartsclone/version.rb
+- sig/dartsclone.rbs
 homepage: https://github.com/yoshoku/darts-clone.rb
 licenses:
 - BSD-2-Clause
@@ -42,7 +44,8 @@ metadata:
   homepage_uri: https://github.com/yoshoku/darts-clone.rb
   source_code_uri: https://github.com/yoshoku/darts-clone.rb
   changelog_uri: https://github.com/yoshoku/darts-clone.rb/blob/master/CHANGELOG.md
-post_install_message:
+  documentation_uri: https://github.com/yoshoku/darts-clone.rb#usage
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -57,8 +60,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Ruby binding for the Darts-clone.
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
----
-os: linux
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-  - '2.5'
-  - '2.6'
-  - '2.7'
-
-before_install: gem install bundler -v 2.1.2