ffi-radix_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b552a559de9350d73c2c847b2aa4f0157fed12a8
+  data.tar.gz: f25f0dc4ad08766c3f805b8f75cba8c6fbda5a3d
+SHA512:
+  metadata.gz: 63fc44026e11a67bdef49b7c7fd2c1fe3c5c1a34ef7ae3ae26823c52d77a0b278b43e506114dda67baf10f7cfb160e855c5bcef05005102e320ff3ae2395e9eb
+  data.tar.gz: 8facbab3ba214d8c382f2c176d6284c9743de7d34e1368e558ed550fa8e4d2b06c988bd29cef5cf01e3286287b9398628a913707284d8f6652960f647ebb8ebf

data/.gitignore

@@ -0,0 +1,16 @@
+*.ruby-*
+*.so
+CMakeCache.txt
+/vendor/radixtree/CMakeFiles
+/vendor/radixtree/CMakeFiles/**/*
+/vendor/radixtree/Makefile
+cmake_install.cmake
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ffi-radix_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brandon Dewitt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Ffi::RadixTree
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ffi/radix_tree`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ffi-radix_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffi-radix_tree
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ffi-radix_tree.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+import "ext/ffi/radixtree/Rakefile"
+
+namespace :radixtree do
+  desc "build radixtree"
+  task :compile do
+    Rake::Task[:compile_radixtree].invoke
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+Rake::Task[:test].prerequisites << "radixtree:compile"
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffi/radix_tree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/ffi/radixtree/Rakefile

@@ -0,0 +1,62 @@
+require "rubygems"
+require "fileutils"
+require "ffi"
+
+# Copied fom mkmf
+def find_executable(bin, path = nil)
+  executable_file = proc do |name|
+    begin
+      stat = File.stat(name)
+    rescue SystemCallError
+    else
+      next name if stat.file? and stat.executable?
+    end
+  end
+
+  if File.expand_path(bin) == bin
+    return bin if executable_file.call(bin)
+    return nil
+  end
+  if path ||= ENV['PATH']
+    path = path.split(File::PATH_SEPARATOR)
+  else
+    path = %w[/usr/local/bin /usr/ucb /usr/bin /bin]
+  end
+  file = nil
+  path.each do |dir|
+    return file if executable_file.call(file = File.join(dir, bin))
+  end
+  nil
+end
+
+def sys(cmd)
+  puts " -- #{cmd}"
+  unless ret = system(cmd)
+    raise "ERROR: '#{cmd}' failed"
+  end
+  ret
+end
+
+desc "Build the radixtree shared lib"
+task :compile_radixtree do
+  # Do not attempt to install if we want to use the system radixtree lib
+  next if ENV.key?("RADIX_TREE_USE_SYSTEM_LIB")
+
+  if !find_executable("cmake")
+    abort "ERROR: CMake is required to build ffi-radix_tree"
+  end
+
+  CWD = ::File.expand_path(::File.dirname(__FILE__))
+  RADIXTREE_DIR = ::File.join(CWD, "..", "..", "..", "vendor", "radixtree")
+
+  ::Dir.chdir(RADIXTREE_DIR) do
+    sys("cmake CMakeLists.txt")
+    sys("make")
+  end
+
+  unless ::File.exist?(::File.join(RADIXTREE_DIR, "libradixtree.#{::FFI::Platform::LIBSUFFIX}"))
+    abort "ERROR: Failed to build radixtree"
+  end
+end
+
+task :default => :compile_radixtree

data/ffi-radix_tree.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ffi/radix_tree/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffi-radix_tree"
+  spec.version       = FFI::RadixTree::VERSION
+  spec.authors       = ["Brandon Dewitt"]
+  spec.email         = ["brandonsdewitt@gmail.com"]
+
+  spec.summary       = %q{ radix tree implementation in c++ with FFI bindings }
+  spec.description   = %q{ radix tree implementation in c++ with FFI bindings }
+  spec.homepage      = "https://www.github.com/abrandoned/ffi-radix_tree"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.extensions    = "ext/ffi/radixtree/Rakefile"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "msgpack"
+  spec.add_dependency "ffi"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/ffi/radix_tree.rb

@@ -0,0 +1,129 @@
+require "ffi"
+require "msgpack"
+require "ffi/radix_tree/version"
+
+module FFI
+  module RadixTree
+    extend FFI::Library
+    ffi_lib_flags :now, :global
+
+    ##
+    # ffi-rzmq-core for reference
+    #
+    # https://github.com/chuckremes/ffi-rzmq-core/blob/master/lib/ffi-rzmq-core/libzmq.rb
+    #
+    begin
+      # bias the library discovery to a path inside the gem first, then
+      # to the usual system paths
+      gem_base = ::File.join(::File.dirname(__FILE__), '..', '..', '..')
+      inside_gem = ::File.join(gem_base, 'ext')
+      local_path = ::FFI::Platform::IS_WINDOWS ? ENV['PATH'].split(';') : ENV['PATH'].split(':')
+      env_path = [ ENV['RADIX_TREE_LIB_PATH'] ].compact
+      rbconfig_path = ::RbConfig::CONFIG["libdir"]
+      homebrew_path = nil
+
+      # RUBYOPT set by RVM breaks 'brew' so we need to unset it.
+      rubyopt = ENV.delete('RUBYOPT')
+
+      begin
+        stdout, stderr, status = ::Open3.capture3("brew", "--prefix")
+        homebrew_path  = if status.success?
+                           "#{stdout.chomp}/lib"
+                         else
+                           '/usr/local/homebrew/lib'
+                         end
+      rescue
+        # Homebrew doesn't exist
+      end
+
+      # Restore RUBYOPT after executing 'brew' above.
+      ENV['RUBYOPT'] = rubyopt
+
+      # Search for libradixtree in the following order...
+      radixtree_lib_paths =
+        if ENV.key?("RADIX_TREE_USE_SYSTEM_LIB")
+          [inside_gem] + env_path + local_path + [rbconfig_path] + [
+           '/usr/local/lib', '/opt/local/lib', homebrew_path, '/usr/lib64'
+          ]
+        else
+          [::File.join(gem_base, "vendor/radixtree/build/src")]
+        end
+
+      RADIX_TREE_LIB_PATHS = radixtree_lib_paths.
+        compact.map{|path| "#{path}/libradixtree.#{::FFI::Platform::LIBSUFFIX}"}
+
+      ffi_lib(RADIX_TREE_LIB_PATHS + %w{libradixtree})
+    rescue LoadError => error
+      if RADIX_TREE_LIB_PATHS.any? {|path| ::File.file?(::File.join(path)) }
+        warn "Unable to load this gem. The libradixtree library exists, but cannot be loaded."
+        warn "Set RADIX_TREE_LIB_PATH if custom load path is desired"
+        warn "If this is Windows:"
+        warn "-  Check that you have MSVC runtime installed or statically linked"
+        warn "-  Check that your DLL is compiled for #{FFI::Platform::ADDRESS_SIZE} bit"
+      else
+        warn "Unable to load this gem. The libradixtree library (or DLL) could not be found."
+        warn "Set RADIX_TREE_LIB_PATH if custom load path is desired"
+        warn "If this is a Windows platform, make sure libradixtree.dll is on the PATH."
+        warn "If the DLL was built with mingw, make sure the other two dependent DLLs,"
+        warn "libgcc_s_sjlj-1.dll and libstdc++6.dll, are also on the PATH."
+        warn "For non-Windows platforms, make sure libradixtree is located in this search path:"
+        warn RADIX_TREE_LIB_PATHS.inspect
+      end
+      raise error
+    end
+
+    attach_function :create, [], :pointer
+    attach_function :destroy, [:pointer], :void
+    attach_function :erase, [:string], :void
+    attach_function :fetch, [:pointer, :string, :pointer], :pointer
+    attach_function :insert, [:pointer, :string, :pointer, :size_t], :void
+    attach_function :longest_prefix, [:pointer, :string], :string
+    attach_function :longest_prefix_value, [:pointer, :string, :pointer], :pointer
+    attach_function :match_free, [:pointer], :void
+    attach_function :has_key, [:pointer, :string], :bool
+  end
+
+  class Tree
+    DESTROY_METHOD = ::RadixTree.method(:destroy)
+    FREE_METHOD = ::RadixTree.method(:match_free)
+
+    def initialize
+      @ptr = ::FFI::AutoPointer.new(::FFI::RadixTree.create, DESTROY_METHOD)
+    end
+
+    def has_key?(key)
+      ::FFI::RadixTree.has_key(@ptr, key)
+    end
+
+    def push(key, value)
+      storage_data = ::MessagePack.pack(value)
+      bytesize = storage_data.bytesize
+      memory_buffer = ::FFI::MemoryPointer.new(:char, bytesize, true)
+      memory_buffer.put_bytes(0, storage_data)
+      ::FFI::RadixTree.insert(@ptr, key, memory_buffer, bytesize)
+    end
+
+    def get(key)
+      byte_length = ::FFI::MemoryPointer.new(:int)
+      byte_pointer = ::FFI::AutoPointer.new(::FFI::RadixTree.fetch(@ptr, key, byte_length), FREE_METHOD)
+      bytesize = byte_length.read_int
+      return nil if bytesize <= 0
+      ::MessagePack.unpack(byte_pointer.get_bytes(0, bytesize))
+    end
+
+    def longest_prefix(string)
+      value, p_out = ::FFI::RadixTree.longest_prefix(@ptr, string)
+      p_out = ::FFI::AutoPointer.new(p_out, FREE_METHOD) unless p_out.nil?
+      value.force_encoding("UTF-8") unless value.nil?
+      value
+    end
+
+    def longest_prefix_value(string)
+      byte_length = ::FFI::MemoryPointer.new(:int)
+      byte_pointer = ::FFI::AutoPointer.new(::FFI::RadixTree.longest_prefix_value(@ptr, string, byte_length), FREE_METHOD)
+      bytesize = byte_length.read_int
+      return nil if bytesize <= 0
+      ::MessagePack.unpack(byte_pointer.get_bytes(0, bytesize))
+    end
+  end
+end

data/lib/ffi/radix_tree/version.rb

@@ -0,0 +1,5 @@
+module FFI
+  module RadixTree
+    VERSION = "0.1.0"
+  end
+end

data/vendor/radixtree/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 2.8)
+
+project (radixtree)
+set(CMAKE_CXX_FLAGS "-Wall -Wextra")
+set(CMAKE_CXX_FLAGS_DEBUG "-g")
+set(CMAKE_CXX_FLAGS_RELEASE "-O3")
+set(CMAKE_BUILD_TYPE Release)
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+add_library(radixtree SHARED ffi_radix_tree.cpp)

data/vendor/radixtree/COPYING

@@ -0,0 +1,21 @@
+Copyright (c) 2010, Yuuki Takano <ytakanoster@gmail.com>, All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/vendor/radixtree/ffi_radix_tree.cpp

@@ -0,0 +1,101 @@
+#include <algorithm>
+#include <iostream>
+#include <cstring>
+#include <string>
+#include <vector>
+
+#include "radix_tree.hpp"
+
+#ifdef __cplusplus
+#define EXTERN_C       extern "C"
+#define EXTERN_C_BEGIN extern "C" {
+#define EXTERN_C_END   }
+#else
+#define EXTERN_C       /* Nothing */
+#define EXTERN_C_BEGIN /* Nothing */
+#define EXTERN_C_END   /* Nothing */
+#endif
+
+EXTERN_C_BEGIN
+radix_tree<std::string, std::vector<char>>* create() {
+  radix_tree<std::string, std::vector<char>>* map_pointer = new radix_tree<std::string, std::vector<char>>();
+
+  return map_pointer;
+}
+
+void erase(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key) {
+  map_pointer->erase(std::string(key));
+}
+
+bool has_key(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key) {
+  return map_pointer->find(std::string(key)) != map_pointer->end();
+}
+
+void match_free(const char* match) {
+  if (match != NULL) {
+    delete[] match;
+  }
+}
+
+const char* longest_prefix(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key) {
+  std::string string_key(key);
+  auto iter = map_pointer->longest_match(string_key);
+
+  if (iter != map_pointer->end()) {
+    char *val  = new char[iter->first.size() + 1]{0};
+    val[iter->first.size()] = '\0';
+    memcpy(val, iter->first.c_str(), iter->first.size());
+
+    return val;
+  }
+  
+  return NULL;
+}
+
+const char* longest_prefix_value(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key, int* read_size) {
+  std::string string_key(key);
+  auto iter = map_pointer->longest_match(string_key);
+  long counter = 0;
+
+  if (iter != map_pointer->end()) {
+    char *return_val  = new char[iter->second.size()]{0};
+    for( auto& val : iter->second ) {
+      return_val[counter] = val;
+      counter++;
+    }
+
+    *read_size = iter->second.size();
+    return return_val;
+  }
+  
+  *read_size = 0;
+  return NULL;
+}
+
+const char* fetch(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key, int* read_size) {
+  auto iter = map_pointer->find(std::string(key));
+  long counter = 0;
+
+  if (iter != map_pointer->end()) {
+    char *return_val  = new char[iter->second.size()]{0};
+    for( auto& val : iter->second ) {
+      return_val[counter] = val;
+      counter++;
+    }
+
+    *read_size = iter->second.size();
+    return return_val;
+  }
+
+  *read_size = 0;
+  return NULL;
+}
+
+void insert(radix_tree<std::string, std::vector<char>>* map_pointer, const char* key, char* value, size_t size) {
+  map_pointer->insert({std::string(key), std::vector<char>(value, value + size)});
+}
+
+void destroy(radix_tree<std::string, std::vector<char>>* map_pointer) {
+  delete map_pointer;
+}
+EXTERN_C_END