native_btree 0.1.0.alpha1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4350c3868f788f61a124316be8b5585fdaeff625d68146132400dc35d8c11c65
-  data.tar.gz: 6d8d0ab48fd80fe1495fc467e94aab3697f3a6f268b3922c192de766d5ce97ca
+  metadata.gz: 6e2df9fa087346ceb88e3352b81707085432b0f2b55cb6315175236bcdfb5167
+  data.tar.gz: 5ce010f70cfafe99d7a89ffe1517330da355bde7a52bc3255711dc56e159b14e
 SHA512:
-  metadata.gz: e75a27871d722cd11d5453d980ef55698cc9de9c25fc1dd825a0e824189171f6ebb827def85616659ff778ad30739df84579bc02b9639f2c64cd1803ee301d57
-  data.tar.gz: cfab277fb1f5c2265a94f588aaf27a1002c210fb1c70aea5d6311e1b5f39de9f356e5b0b89c9ff0f5ab8441ca9731576b824bfe975a719b0ef60403ece9f2545
+  metadata.gz: 5a071792ca329c65f44f04ab4609dce810136fe96d2250d785bdce5d26008adc8c81c03b36a7bc1afd5a7000932ce069af74d368fa4f504afad5fdca5d828efb
+  data.tar.gz: 5790f7446d3390d004101d25c8b7f716c19cdc79cbec64e8f4741667aee281fb8d72ef3b9dca28aef4382d0c52b678a626220cd673ac32e8e8e1f4f3b41cb0b6

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* filter()
+* filter!()
+* each_key()
+* each_value()
+* select()
+* select!
+
+## [0.2.0] - 2022-09-07
+
+### Changed
+
+* Small refactoring
+
+### Added
+
+* to_a()
+* to_h()
+* clear()
+* includes?()

data/CMakeLists.txt

@@ -0,0 +1,54 @@
+cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR)
+
+project(ruby-native-btree
+	LANGUAGES C
+	VERSION 0.2.0
+  	HOMEPAGE_URL https://github.com/unixs/ruby-native-btree)
+
+include(CheckSymbolExists)
+
+set(REQUIRED_RUBY_VERSION 2.6.0)
+
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_EXTENSIONS ON)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+
+set(CMAKE_C_FLAGS_DEBUG " -O0 -ggdb3 -Wall -Wextra -Wpedantic -Wno-unused-parameter")
+set(CMAKE_C_FLAGS_RELEASE "-O3")
+set(CMAKE_C_FLAGS "-pipe -march=native")
+
+# Force -fPIC
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+if(NOT CMAKE_BUILD_TYPE)
+	set(CMAKE_BUILD_TYPE "Release")
+endif()
+message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
+
+set(CMAKE_SHARED_LIBRARY_PREFIX "")
+
+if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
+	set(CMAKE_SHARED_LIBRARY_SUFFIX ".bundle")
+	set(CMAKE_FIND_FRAMEWORK LAST)
+	message(STATUS "CMAKE_FIND_FRAMEWORK='${CMAKE_FIND_FRAMEWORK}'")
+endif()
+
+find_package(PkgConfig REQUIRED)
+
+# Find Ruby
+find_package(Ruby ${REQUIRED_RUBY_VERSION} REQUIRED)
+include_directories(${Ruby_INCLUDE_DIRS})
+link_libraries(${Ruby_LIBRARIES})
+message("Ruby_INCLUDE_DIRS: ${Ruby_INCLUDE_DIRS}")
+
+message(STATUS "Find Ruby deps.")
+
+# Find jemalloc
+pkg_check_modules(JEMALLOC jemalloc)
+if(JEMALLOC_FOUND)
+	include_directories(${JEMALLOC_INCLUDE_DIRS})
+	# link_libraries(${JEMALLOC_LIBRARIES})
+endif()
+
+# Attach extension dir
+add_subdirectory("ext/native_btree")

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_btree.gemspec
+gemspec
+
+group :development do
+  gem 'awesome_print', '~> 1.9'
+  gem 'debase', '~> 0.2', platforms: [:mri_26, :mri_27]
+  gem 'pry', '~> 0.14'
+  gem 'rubocop', '~> 1.35.0'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 2.12.1'
+  gem 'rspec', '~> 3.11.0'
+  gem 'ruby-debug-ide', '~> 0.7'
+  gem 'solargraph', '~> 0.46'
+end

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,67 @@
+# GLib Balanced binary tree (GTree) bindings for Ruby
+
+[![Ruby](https://github.com/unixs/ruby-native-btree/actions/workflows/main.yml/badge.svg)](https://github.com/unixs/ruby-native-btree/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/native_btree.svg)](https://badge.fury.io/rb/native_btree)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+
+[GTree - balanced binary tree from GLib library](https://docs.gtk.org/glib/struct.Tree.html)
+
+In most cases it will behave same as Hash, but keys will be ordered by passed comparator.
+
+## Requirements
+
+* **CMake** build tool version **>= 3.14.0**
+* `pkg-config` tool
+* **GLib** library
+  * On Ubuntu run:
+  ```bash
+  sudo apt-get install pkg-config cmake libglib2.0-dev
+  ```
+  * On MacOS run:
+  ```
+  brew install pkg-config cmake glib
+  ```
+  * On FreeBSD use pkg or ports.
+  * On windows use Google. I don't really know how it can work at this moment... But i think it's possible
+
+**Check CMake tool version!**
+
+## Basic usage
+
+```ruby
+require 'native_btree'
+
+# Pass comparator for keys as block
+tree = NativeBtree::Btree.new { |a, b|  a - b }
+
+tree[1] = '111'
+tree[3] = '333'
+tree[2] = '222'
+
+tree.each { |k, v| puts "#{k} => #{v}" }
+
+# 1 => 111
+# 2 => 222
+# 3 => 333
+# nil
+
+tree.size
+# 3
+
+tree.height
+# 2
+```
+
+## API ref
+
+You must provide your own comparator for keys in `new` class method block.
+
+### Methods
+
+* `[]= (alias: set)`
+* `[] (alias: get)`
+* `delete`
+* `size`
+* `height`
+* `each`

data/Rakefile

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  warn "RSpec rake tasks was not loaded"
+end
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  warn "Rubocop rake tasks was not loaded"
+end
+
+task default: %i[cmake:build]
+
+BUILD_DIR = "build"
+
+namespace :cmake do
+  desc "Remove build directory"
+  task :rmbuild do
+    sh "rm -rf #{BUILD_DIR}"
+  end
+
+  desc "Configure ext CMake project"
+  task :configure do
+    sh "cmake -S . -B #{BUILD_DIR}"
+  end
+
+  desc "Build ext CMake project"
+  task build: %i[cmake:configure] do
+    sh "cmake --build #{BUILD_DIR}"
+  end
+
+  desc "`Rebuild ext CMake project"
+  task rebuild: %i[cmake:configure] do
+    sh "cmake --build #{BUILD_DIR} --clean-first"
+  end
+
+  desc "Clean ext CMake project"
+  task :clean do
+    sh "cmake --build #{BUILD_DIR} --target clean"
+  end
+end

data/ext/native_btree/CMakeLists.txt

@@ -0,0 +1,38 @@
+set(EXT_NAME "native_btree")
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib/${EXT_NAME})
+
+message(STATUS "Find ext deps.")
+
+pkg_check_modules(GLIB2 REQUIRED glib-2.0)
+
+include_directories(include ${GLIB2_INCLUDE_DIRS})
+
+list(APPEND CMAKE_REQUIRED_LIBRARIES ${GLIB2_LDFLAGS})
+list(APPEND CMAKE_REQUIRED_INCLUDES ${GLIB2_INCLUDE_DIRS})
+check_symbol_exists(g_tree_remove_all "glib.h" HAVE_GTREE_REMOVE_ALL)
+
+if(HAVE_GTREE_REMOVE_ALL)
+	add_compile_definitions(HAVE_GTREE_REMOVE_ALL)
+endif()
+
+add_library(rbtree_type OBJECT rbtree_type.c)
+add_library(constructor OBJECT constructor.c)
+add_library(instance OBJECT instance.c)
+add_library(comparator OBJECT comparator.c)
+add_library(iterators OBJECT iterators.c)
+add_library(conversion OBJECT conversion.c)
+
+add_library(${EXT_NAME}
+	SHARED
+	native_btree.c)
+
+target_link_libraries(${EXT_NAME}
+	PRIVATE
+	conversion
+	iterators
+	rbtree_type
+	constructor
+	instance
+	comparator
+	${GLIB2_LDFLAGS})
+	#set_target_properties(${EXT_NAME} PROPERTIES BUNDLE TRUE)

data/ext/native_btree/comparator.c

@@ -0,0 +1,13 @@
+#include <comparator.h>
+
+gint
+rbtree_native_comparator(gconstpointer a, gconstpointer b, gpointer data)
+{
+  RBTree *rbtree = (RBTree *) data;
+
+  VALUE result = rb_funcall(rbtree->comparator, rb_intern("call"), 2, (VALUE) a, (VALUE) b);
+
+  gint compare_result = NUM2INT(result);
+
+  return compare_result;
+}

data/ext/native_btree/constructor.c

@@ -0,0 +1,19 @@
+#include <constructor.h>
+#include <comparator.h>
+#include <rbtree_type.h>
+
+VALUE
+rbtree_initialize(VALUE self)
+{
+  EXTRACT_RBTREE_SELF(rbtree);
+
+  rbtree->gtree = g_tree_new_with_data(
+    rbtree_native_comparator,
+    rbtree
+  );
+
+  rb_need_block();
+  rbtree->comparator = rb_block_proc();
+
+  return self;
+}

data/ext/native_btree/conversion.c

@@ -0,0 +1,54 @@
+#include <conversion.h>
+
+static gboolean
+rbtree_to_h_callback(gpointer key, gpointer value, gpointer data)
+{
+  VALUE hash = (VALUE) data;
+
+  rb_hash_aset(hash, (VALUE) key, (VALUE) value);
+
+  return FALSE;
+}
+
+
+static gboolean
+rbtree_to_a_callback(gpointer key, gpointer value, gpointer data)
+{
+  VALUE array = (VALUE) data;
+  VALUE array2 = rb_ary_new2(2);
+
+  rb_ary_push(array2, (VALUE) key);
+  rb_ary_push(array2, (VALUE) value);
+
+  rb_ary_push(array, array2);
+
+  return FALSE;
+}
+
+
+VALUE
+rbtree_to_h(VALUE self)
+{
+  EXTRACT_RBTREE_SELF(rbtree);
+
+  VALUE hash = rb_hash_new();
+
+  g_tree_foreach(rbtree->gtree, rbtree_to_h_callback, (gpointer) hash);
+
+  return hash;
+}
+
+
+VALUE
+rbtree_to_a(VALUE self)
+{
+  EXTRACT_RBTREE_SELF(rbtree);
+
+  gint tree_size = g_tree_nnodes(rbtree->gtree);
+
+  VALUE array = rb_ary_new2(tree_size);
+
+  g_tree_foreach(rbtree->gtree, rbtree_to_a_callback, (gpointer) array);
+
+  return array;
+}

data/ext/native_btree/extconf_cmake.rb

@@ -0,0 +1,15 @@
+require "mkmf"
+require "rake"
+
+abort "CMake build tool not found" unless find_executable('cmake')
+
+File.open("Makefile", "wb") do |f|
+  dummy_makefile(".").each do |line|
+    f.puts(line)
+  end
+end
+
+app = Rake.application
+app.init
+app.load_rakefile
+app['cmake:rebuild'].invoke

data/ext/native_btree/include/common.h

@@ -0,0 +1,21 @@
+#include <ruby.h>
+#include <glib.h>
+
+#ifndef _NATIVE_BTREE_COMMON_
+#define _NATIVE_BTREE_COMMON_
+
+#include <rbtree_type.h>
+
+#define NATIVE_BTREE_MODULE "NativeBtree"
+#define NATIVE_BTREE_CLASS "Btree"
+
+#define EXTRACT_RBTREE(from, to)                                               \
+  RBTree *to;                                                                  \
+  TypedData_Get_Struct(from, RBTree, &rbtree_type, rbtree)
+
+#define EXTRACT_RBTREE_SELF(to) EXTRACT_RBTREE(self, to)
+
+extern VALUE rbtree_class;
+extern VALUE rbtree_module;
+
+#endif //_NATIVE_BTREE_COMMON_

data/ext/native_btree/include/comparator.h

@@ -0,0 +1,4 @@
+#include <common.h>
+
+gint
+rbtree_native_comparator(gconstpointer a, gconstpointer b, gpointer data);

data/ext/native_btree/include/constructor.h

@@ -0,0 +1,11 @@
+#include <common.h>
+
+#ifndef _NATIVE_BTREE_CONSTRUCTOR_
+#define _NATIVE_BTREE_CONSTRUCTOR_
+
+
+
+VALUE rbtree_alloc(VALUE self);
+VALUE rbtree_initialize(VALUE self);
+
+#endif //_NATIVE_BTREE_COMMON_H_

data/ext/native_btree/include/conversion.h

@@ -0,0 +1,8 @@
+#include <common.h>
+
+
+VALUE
+rbtree_to_h(VALUE self);
+
+VALUE
+rbtree_to_a(VALUE self);

data/ext/native_btree/include/instance.h

@@ -0,0 +1,22 @@
+#include <common.h>
+
+VALUE
+rbtree_set(VALUE self, VALUE key, VALUE value);
+
+VALUE
+rbtree_get(VALUE self, VALUE key);
+
+VALUE
+rbtree_delete(VALUE self, VALUE key);
+
+VALUE
+rbtree_size(VALUE self);
+
+VALUE
+rbtree_height(VALUE self);
+
+VALUE
+rbtree_clear(VALUE self);
+
+VALUE
+rbtree_is_include(VALUE self, VALUE key);

data/ext/native_btree/include/iterators.h

@@ -0,0 +1,5 @@
+#include <common.h>
+
+
+VALUE
+rbtree_each(VALUE self);

data/ext/native_btree/include/native_btree.h

@@ -1,51 +1,9 @@
 #ifndef _NATIVE_BTREE_
-#include <ruby.h>
 
-#if defined(__cplusplus)
-extern "C" {
-#endif
-
-extern VALUE btree_class;
-extern VALUE btree_module;
-
-VALUE
-btree_new(VALUE klass);
-
-VALUE
-btree_init(VALUE self);
-
-VALUE
-btree_size(VALUE self);
-
-VALUE
-btree_height(VALUE self);
-
-VALUE
-btree_set(VALUE self, VALUE key, VALUE value);
-
-VALUE
-btree_get(VALUE self, VALUE key);
-
-VALUE
-btree_delete(VALUE self, VALUE key);
-
-VALUE
-btree_clear(VALUE self);
-
-VALUE
-btree_has(VALUE self, VALUE key);
-
-VALUE
-btree_each(VALUE self);
-
-VALUE
-btree_cmp(VALUE self, VALUE tree2);
-
-VALUE
-btree_equal(VALUE self, VALUE tree2);
-
-#if defined(__cplusplus)
-}
-#endif
+#include <common.h>
+#include <constructor.h>
+#include <instance.h>
+#include <iterators.h>
+#include <conversion.h>
 
 #endif // _NATIVE_BTREE_