dartsclone 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f885b4746eda49bbcdf7dd447acf1f5249f41fd3f259b9b5a0c4aefdb166a53
-  data.tar.gz: 1526d141d3e0671be8b7bf80ea192477a6f2795fbfc627050a1a7edb9e37f7f7
+  metadata.gz: 0de9241630b790fea0794afe5ec48d7ac7335faae7c9d563ce42cdfe47670f43
+  data.tar.gz: 66dd871d41f3ba849c949093c02b6ac4613541e8ad81e062255a771955ec0988
 SHA512:
-  metadata.gz: a3edde3163b959f31f61bed40d031bbeb6f86ca4774d9b110af4dd3d5e787210cef5fab01d87ba342def771ee52d28c133c643bd7179df8c42c6e2cc8e53c731
-  data.tar.gz: e292bcd0444398425b931a6bf92217b06cf1f45eedc85af841aeb82cbbcb4bd1caaab5f57f43e54aa8e59a5e8b833570c269d699c71a2bd0d7f4e15482197a62
+  metadata.gz: 3f696063913884d67ebdd20b51b4d49363537650c831b28d9a987d808d9cb3e239eeec95e2e0b4fed67ab94925ca37649383b4ff956e37141f9c12b3cd79ef33
+  data.tar.gz: f5ffe5cc13ee5560e258ecbb0ead2a14b0b96b09d7f286317d1514f5b01eb1dcca12fa1bd15dedb594bd5393eaa51c9e49ddc28ac2b4f87eba599fc8f181f505

data/.github/workflows/build.yml

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

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.3.1
+- Add dummy constructor call at memory allocation of binding class to prevent occuring segment fault on GC when initialize method is failed.
+
+## 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.

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

@@ -2,9 +2,9 @@
 
 [![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).
+Darts-clone.rb provides Ruby bindings for the [Darts-clone](https://github.com/s-yata/darts-clone).
 
 ## Installation
 
@@ -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

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['yoshoku']
   spec.email         = ['yoshoku@outlook.com']
 
-  spec.summary       = 'Ruby binding for the Darts-clone.'
-  spec.description   = 'Darts-clone.rb is a Ruby binding for the Darts-clone.'
+  spec.summary       = 'Ruby bindings for the Darts-clone.'
+  spec.description   = 'Darts-clone.rb provides Ruby bindings for the Darts-clone.'
   spec.homepage      = 'https://github.com/yoshoku/darts-clone.rb'
   spec.license       = 'BSD-2-Clause'
 

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,6 +11,7 @@ class RbDoubleArray
   public:
     static VALUE double_array_alloc(VALUE self) {
       Darts::DoubleArray* ptr = (Darts::DoubleArray*)ruby_xmalloc(sizeof(Darts::DoubleArray));
+      new (ptr) Darts::DoubleArray(); // dummy call to constructor for GC.
       return TypedData_Wrap_Struct(self, &double_array_type, ptr);
     };
 
@@ -68,22 +71,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;
     }
 
@@ -97,13 +104,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]);
+      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;
     };
 
@@ -117,12 +127,15 @@ 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]);
+      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;
     };
 
@@ -137,6 +150,7 @@ class RbDoubleArray
       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;
     };
 
@@ -160,6 +174,7 @@ class RbDoubleArray
 
       Darts::DoubleArray::value_type value;
       get_double_array(self)->exactMatchSearch(key, value, length, node_pos);
+      RB_GC_GUARD(_key);
       return INT2NUM(value);
     };
 
@@ -200,6 +215,7 @@ class RbDoubleArray
         rb_ary_push(ret, values);
       }
       ruby_xfree(results);
+      RB_GC_GUARD(_key);
       return ret;
     };
 
@@ -223,6 +239,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;
     };
 

data/ext/dartsclone/dummy.rb

@@ -0,0 +1,93 @@
+# This class is for yard.
+
+# Darts-clone.rb is a Ruby binding for the Darts-clone.
+module DartsClone
+  # The version of Darts-clone.rb you are using.
+  VERSION = '0.2.2'
+
+  # The version of Darts-clone that this gem is binding to.
+  DARTS_CLONE_VERSION = '0.32'
+
+  # DoubleArray is a class that implements double-array trie.
+  #
+  # @example
+  #   require 'dartsclone'
+  #
+  #   da = DartsClone::DoubleArray.new
+  #
+  #   keys = ['abc', 'abcd', 'abcde', 'bcd', 'cde']
+  #   da.build(keys)
+  #
+  #   p da.common_prefix_search('abcde')
+  #   # => [["abc", "abcd", "abcde"], [0, 1, 2]]
+  #
+  class DoubleArray
+    # Create a new double-array trie.
+    def initialize; end
+
+    # Build index of double-array trie
+    #
+    # @param keys [Array<String>]
+    # @param values [Array<Integer>]
+    # @return [Boolean]
+    def build(keys, values: nil); end
+
+    # Open saved index.
+    #
+    # @param filename [String]
+    # @return [Boolean]
+    def open(filename); end
+
+    # Save index.
+    #
+    # @param filename [String]
+    # @param mode [String]
+    # @param offset [Integer]
+    # @return [Boolean]
+    def save(filename, mode: 'wb', offset: 0); end
+
+    # Dump array data.
+    #
+    # @return [String]
+    def get_array(); end
+
+    # Load array data.
+    #
+    # @param str [String]
+    def set_array(str); end
+
+    # Search with exact match
+    #
+    # @param key [String]
+    # @param length [Integer]
+    # @param node_pos [Integer]
+    def exact_match_search(key, length: 0, node_pos: 0); end
+
+    # Common prefix search.
+    #
+    # @param key [String]
+    def common_prefix_search(key, max_num_results: nil, length: 0, node_pos: 0); end
+
+    # Traverse trie.
+    #
+    # @param key [String]
+    def traverse(key, node_pos: nil, key_pos: nil, length: nil); end
+
+    # size
+    # @return [Integer]
+    def unit_size(); end
+
+    # unit size
+    # @return [Integer]
+    def size(); end
+
+    # total size
+    # @return [Integer]
+    def total_size(); end
+
+    # clear trie
+    # @return [Nil]
+    def clear(); end
+  end
+end
+

data/lib/dartsclone/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module DartsClone
-  VERSION = '0.2.1'
+  VERSION = '0.3.1'
   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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: dartsclone
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies: []
-description: Darts-clone.rb is a Ruby binding for the Darts-clone.
+description: Darts-clone.rb provides Ruby bindings for the Darts-clone.
 email:
 - yoshoku@outlook.com
 executables: []
@@ -27,14 +27,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - dartsclone.gemspec
 - ext/dartsclone/dartscloneext.cpp
 - ext/dartsclone/dartscloneext.hpp
+- ext/dartsclone/dummy.rb
 - ext/dartsclone/extconf.rb
 - ext/dartsclone/src/COPYING.md
 - 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
@@ -58,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Ruby binding for the Darts-clone.
+summary: Ruby bindings for the Darts-clone.
 test_files: []