native_btree 0.1.0.alpha2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc39abeab06b5ed3984afa9cda174d12556523df6926db05e2889274c0157305
-  data.tar.gz: 596a2b8af36be3da1ac5ebc2c64749f52e7ed5cb83d12280f11aa584f93e3fab
+  metadata.gz: 398bae312c489bfe71fdee2f82499005e655097606a5537c38cfb122980b9f48
+  data.tar.gz: 492df9b7fc0585e0615da770a6c3fd3e2d02323d33c1d3cfecae46b882b881a3
 SHA512:
-  metadata.gz: 87faa333af87558b8a7600e680daf5367dce6f5393e524d467321409b0f1e5285aeedb2cfc6d2c3044c8a978f84d5b6135a628b6a3736df7b040b5312f04bd5c
-  data.tar.gz: 3aac04b9a2c1b14bff0db483c3075e164b6f7fe6fb9a9a45d4275fc9a66aa6a1cfa4f555a74c4680b821d12d8818985b0d10a2ca45fc69cd40a1f658c6401ab3
+  metadata.gz: 634ac5f2eab6a8f9ebf9ed577d5cd2fcdca75fdb8e61f285b3e83e244204976bdef93981320ea101a621b2845cb9346099d61a94193eb5872d0f1480ad363f09
+  data.tar.gz: cf5f853401bdcab2d12088fe11c23cbde946e5a3542620d905e1acb59ede62522cbd293f65c7b10ca54f4a00737c9fe5485519c72358f185840fa8efbe81719b

data/CHANGELOG.md

@@ -1,5 +1,34 @@
+# 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]
 
-## [0.1.0.alpha1] - 2022-08-20
+* filter()
+* filter!()
+* each_key()
+* each_value()
+* select()
+* select!
+
+## [0.2.1] - 2022-09-08
+
+### Changed
+
+* Legacy CMake versions support
+
+## [0.2.0] - 2022-09-07
+
+### Changed
+
+* Small refactoring
+
+### Added
 
-- Initial release
+* to_a()
+* to_h()
+* clear()
+* include?()

data/CMakeLists.txt

@@ -1,11 +1,12 @@
-cmake_minimum_required(VERSION 3.18.0)
+cmake_minimum_required(VERSION 3.5)
 
 project(ruby-native-btree
 	LANGUAGES C
-	VERSION 0.1.0
-  	HOMEPAGE_URL https://github.com/unixs/ruby-native-btree)
+	VERSION 0.2.1)
 
-set(REQUIRED_RUBY_VERSION 2.7.0)
+include(CheckSymbolExists)
+
+set(REQUIRED_RUBY_VERSION 2.6.0)
 
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_EXTENSIONS ON)
@@ -15,6 +16,9 @@ set(CMAKE_C_FLAGS_DEBUG " -O0 -ggdb3 -Wall -Wextra -Wpedantic -Wno-unused-parame
 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()
@@ -32,11 +36,20 @@ 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("Find Ruby deps.")
+if(CMAKE_VERSION VERSION_GREATER "3.17.100")
+	include_directories(${Ruby_INCLUDE_DIRS})
+	link_libraries(${Ruby_LIBRARIES})
+	message(STATUS "Ruby_INCLUDE_DIRS: ${Ruby_INCLUDE_DIRS}")
+else()
+	message(WARNING "Old CMake. Legacy FindRuby macro is used.")
+	include_directories(${RUBY_INCLUDE_DIRS})
+	link_libraries(${RUBY_LIBRARIES})
+	message(STATUS "RUBY_INCLUDE_DIRS: ${RUBY_INCLUDE_DIRS}")
+endif()
+
+message(STATUS "Find Ruby deps.")
+
 # Find jemalloc
 pkg_check_modules(JEMALLOC jemalloc)
 if(JEMALLOC_FOUND)

data/Gemfile

@@ -4,3 +4,15 @@ 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/README.md

@@ -1,26 +1,49 @@
-# Native Balanced binary tree for Ruby
+# GLib Balanced binary tree (GTree) bindings for Ruby
 
-Ruby bindings to [GTree - balanced binary tree from GLib library](https://developer.gnome.org/glib/stable/glib-Balanced-Binary-Trees.html) .
+[![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)
 
-In most cases it is behave same as Hash, but keys will be ordered by passed comparator.
 
-Basic usage:
+[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 = NativeBtree::Btree.new { |a, b|  a - b }
 
-tree[:a1] = '111'
-tree[:c3] = '333'
-tree[:b2] = '222'
+tree[1] = '111'
+tree[3] = '333'
+tree[2] = '222'
 
 tree.each { |k, v| puts "#{k} => #{v}" }
 
-# a1 => 111
-# b2 => 222
-# c3 => 333
+# 1 => 111
+# 2 => 222
+# 3 => 333
 # nil
 
 tree.size
@@ -30,5 +53,19 @@ tree.height
 # 2
 ```
 
-Trees is may comparable by `==` or `.eql?` operator.
-Trees will be equal if all keys and all value is equal in both.
+## API ref
+
+You must provide your own comparator for keys in `new` class method block.
+
+### Methods
+
+* `[]= (alias: set)`
+* `[] (alias: get)`
+* `delete`
+* `size`
+* `height`
+* `each`
+* `include?`
+* `clear`
+* `to_h`
+* `to_a`

data/Rakefile

@@ -1,27 +1,35 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  warn "RSpec rake tasks was not loaded"
+end
 
-RuboCop::RakeTask.new
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  warn "Rubocop rake tasks was not loaded"
+end
 
-task default: %i[rubocop spec]
+task default: %i[cmake:build]
 
 BUILD_DIR = "build"
 
 namespace :cmake do
   desc "Remove build directory"
   task :rmbuild do
-    sh "rm -rvf #{BUILD_DIR}"
+    sh "rm -rf #{BUILD_DIR}"
   end
 
   desc "Configure ext CMake project"
-  task configure: %i[cmake:rmbuild] do
-    sh "cmake . -B #{BUILD_DIR}"
+  task :configure do
+    sh "mkdir #{BUILD_DIR} || true"
+    sh "cd #{BUILD_DIR} && cmake .."
   end
 
   desc "Build ext CMake project"

data/ext/native_btree/CMakeLists.txt

@@ -1,21 +1,43 @@
 set(EXT_NAME "native_btree")
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib/${EXT_NAME})
 
-include_directories(include)
-
-message("Find ext deps.")
+message(STATUS "Find ext deps.")
 
 pkg_check_modules(GLIB2 REQUIRED glib-2.0)
 
-# include_directories(include ${GLIB2_INCLUDE_DIRS})
+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(${EXT_NAME}
 	SHARED
 	native_btree.c)
 
-#set_target_properties(${EXT_NAME} PROPERTIES BUNDLE TRUE)
-
-
-#target_link_libraries(${EXT_NAME}
-#	PRIVATE
-#	${GLIB2_LDFLAGS})
+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(native_btree_interface
+	STATIC
+	$<TARGET_OBJECTS:conversion>
+	$<TARGET_OBJECTS:iterators>
+	$<TARGET_OBJECTS:comparator>
+	$<TARGET_OBJECTS:instance>
+	$<TARGET_OBJECTS:constructor>
+	$<TARGET_OBJECTS:rbtree_type>)
+
+target_link_libraries(${EXT_NAME}
+	PRIVATE
+	native_btree_interface
+	${GLIB2_LDFLAGS})