prefix-machine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ba301f0538645c4e2dac72ed28b63f98444f6e199be9c4cd5ff6c18ad8aa427
+  data.tar.gz: 81fc79eb245505fe29305568dbc2d9b15cde2d22b6619919aca903723805e00a
+SHA512:
+  metadata.gz: 85fb7380ae8915832d6c70198385ecfaa498adbc56bb02125689545ee2dcb4f8ae493f15e796a7d5a58ff1f7213e01bbcbe99762c0b2f002ebcf35ffa7a8c629
+  data.tar.gz: 671bce8dd2b8f991b171bcf247d7bfe705522614aff0649308cb36030f66bc5680eceb7bf7a475a4a3dd5db014c493caeef9bc222aa3c4928f0a79454a387f9a

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+*.so

data/.vscode/c_cpp_properties.json

@@ -0,0 +1,18 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "/home/delton/.rvm/src/ruby-2.7.1/include",
+                "/home/delton/.rvm/rubies/ruby-2.7.1/include/ruby-2.7.0/x86_64-linux/"
+            ],
+            "defines": [],
+            "compilerPath": "/usr/bin/gcc",
+            "cStandard": "c11",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "clang-x64"
+        }
+    ],
+    "version": 4
+}

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in evt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Delton Ding
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+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/README.md

@@ -0,0 +1,15 @@
+# prefix-machine
+A High Performance Prefix Match Machine for Ruby
+
+```ruby
+require 'prefix-machine'
+
+machine = PrefixMachine.new
+machine << 'hello.'
+machine << 'fork.ai.'
+machine << 'fork.human.'
+machine.match('hello.world') # => 'hello.'
+machine.match('fork.ai.sdk') # => 'fork.ai.'
+machine.match('fork.human.resources') # => 'fork.human.'
+machine.match('refute') # => nil
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+spec = Gem::Specification.load('prefix-machine.gemspec')
+Rake::ExtensionTask.new('prefix_machine_ext', spec) do |ext|
+  ext.ext_dir = "ext/prefix_machine"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/ext/prefix_machine/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+extension_name = 'prefix_machine_ext'
+dir_config(extension_name)
+
+create_header
+create_makefile(extension_name)

data/ext/prefix_machine/prefix_machine.c

@@ -0,0 +1,136 @@
+#include "prefix_machine.h"
+
+void Init_prefix_machine_ext() {
+  kPrefixMachine = rb_define_class("PrefixMachine", rb_cObject);
+  kPrefixMachineTrie = rb_define_class("PrefixMachineTrie", rb_cObject);
+
+  rb_define_method(kPrefixMachine, "initialize", method_prefix_machine_initialize, 0);
+  rb_define_private_method(kPrefixMachine, "trie_insert", method_private_prefix_machine_insert_trie, 1);
+  rb_define_private_method(kPrefixMachine, "trie_match", method_private_prefix_machine_match, 1);
+}
+
+VALUE method_prefix_machine_initialize(VALUE self) {
+  struct trie* trie = xmalloc(sizeof(struct trie));
+  char* empty_str = xmalloc(sizeof(char));
+  empty_str[0] = '\0';
+  trie->trace = empty_str;
+  trie->matched = FALSE;
+
+  for (size_t i = 0; i < TOKENS; i++) {
+    trie->children[i] = NULL;
+  }
+
+  VALUE rules = TypedData_Wrap_Struct(kPrefixMachineTrie, &type_trie, trie);
+  rb_iv_set(self, "@rules", rules);
+  rb_iv_set(self, "@count", SIZET2NUM(0));
+
+  return self;
+}
+
+VALUE method_private_prefix_machine_insert_trie(VALUE self, VALUE prefix) {
+  struct trie* root = internal_trie_get(rb_iv_get(self, "@rules"));
+  char* prefix_str = StringValueCStr(prefix);
+  size_t len = strlen(prefix_str);
+  internal_prefix_machine_insert_trie(root, prefix_str, len, 0);
+  rb_iv_set(self, "@count", SIZET2NUM(NUM2SIZET(rb_iv_get(self, "@count")) + 1));
+  return Qnil;
+}
+
+VALUE method_private_prefix_machine_match(VALUE self, VALUE str) {
+  struct trie* root = internal_trie_get(rb_iv_get(self, "@rules"));
+  char* str_ptr = StringValueCStr(str);
+  size_t len = strlen(str_ptr);
+  char* result = internal_prefix_machine_match(root, str_ptr, len, 0);
+
+  if (result == NULL) {
+    return Qnil;
+  }
+
+  return rb_str_new2(result);
+}
+
+size_t internal_compact_tokens(char c) {
+  if (c >= '0' && c <= '9') {
+    return c - '0';
+  }
+  
+  if (c >= 'a' && c <= 'z') {
+    return c - 'a' + 11;
+  }
+  
+  if (c == '.') {
+    return 36;
+  }
+  
+  rb_raise(rb_eNoMatchingPatternError, "Pattern Not Supported.");
+}
+
+void internal_prefix_machine_insert_trie(struct trie* node, char* rule, size_t len, size_t offset) {
+  // Check boundary first
+  if (len == offset) {
+    node->matched = TRUE;
+    return;
+  }
+
+  char c = rule[offset];
+  size_t index = internal_compact_tokens(c);
+  if (node->children[index] != NULL) {
+    return internal_prefix_machine_insert_trie(node->children[index], rule, len, offset + 1);
+  }
+
+  // Create the node
+  struct trie* new_node = xmalloc(sizeof(struct trie));
+  char* trace = xmalloc(sizeof(char) * (offset + 2));
+  memcpy(trace, rule, offset);
+  trace[offset] = c;
+  trace[offset + 1] = '\0'; // NUL-terminated
+  new_node->trace = trace;
+  new_node->matched = FALSE;
+
+  for (size_t i = 0; i < TOKENS; i++) {
+    new_node->children[i] = NULL;
+  }
+
+  node->children[index] = new_node;
+
+  return internal_prefix_machine_insert_trie(new_node, rule, len, offset + 1);
+}
+
+char* internal_prefix_machine_match(struct trie* node, char* str, size_t len, size_t offset) {
+  if (node->matched == TRUE) {
+    return node->trace;
+  }
+
+  if (len == offset) {
+    return NULL;
+  }
+
+  size_t index = internal_compact_tokens(str[offset]);
+  
+  if (node->children[index] == NULL) {
+    return NULL;
+  }
+
+  return internal_prefix_machine_match(node->children[index], str, len, offset + 1);
+}
+
+struct trie* internal_trie_get(VALUE wrapped) {
+  struct trie* ptr;
+  TypedData_Get_Struct(wrapped, struct trie, &type_trie, ptr);
+  return ptr;
+}
+
+void internal_trie_free(void* ptr) {
+  struct trie* root = (struct trie*) ptr;
+  for (size_t i = 0; i < TOKENS; i++) {
+    if (root->children[i] != NULL) {
+      internal_trie_free(root->children[i]);
+    }
+  }
+  xfree(root->trace);
+  xfree(root);
+}
+
+size_t internal_trie_size(const void* ptr) {
+  return 0; // Fetch size with O(n) algorithm is too costly.
+}

data/ext/prefix_machine/prefix_machine.h

@@ -0,0 +1,41 @@
+#include <ruby.h>
+
+#define TOKENS 37 // 26 alphabets + 10 numbers + dot symbol
+#define TRUE 1
+#define FALSE 0
+
+struct trie {
+  int matched;
+  char* trace;
+  struct trie* children[TOKENS];
+};
+
+VALUE kPrefixMachine = Qnil;
+VALUE kPrefixMachineTrie = Qnil;
+
+void Init_prefix_machine_ext();
+VALUE method_prefix_machine_initialize(VALUE self);
+
+// private methods
+VALUE method_private_prefix_machine_insert_trie(VALUE self, VALUE prefix);
+VALUE method_private_prefix_machine_match(VALUE self, VALUE str);
+
+// internal methods
+size_t internal_compact_tokens(char c);
+void internal_prefix_machine_insert_trie(struct trie* node, char* rule, size_t len, size_t offset);
+char* internal_prefix_machine_match(struct trie* node, char* str, size_t len, size_t offset);
+
+struct trie* internal_trie_get(VALUE wrapped);
+void internal_trie_free(void* ptr);
+size_t internal_trie_size(const void* ptr);
+
+static const rb_data_type_t type_trie = {
+  .wrap_struct_name = "trie",
+  .function = {
+    .dmark = NULL,
+    .dfree = internal_trie_free,
+    .dsize = internal_trie_size,
+  },
+  .data = NULL,
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};

data/lib/prefix-machine.rb

@@ -0,0 +1,24 @@
+require 'prefix_machine_ext'
+require './prefix-machine/version'
+
+class PrefixMachine
+  attr_reader :count
+
+  def guard!(str)
+    raise NoMatchingPatternError.new('No Such Patterns') unless str =~ /[0-9a-z.]*/
+  end
+
+  def insert(rule)
+    s = rule.downcase
+    guard!(s)
+    trie_insert(s)
+  end
+
+  def match(str)
+    s = str.downcase
+    guard!(s)
+    trie_match(s)
+  end
+
+  alias_method :<<, :insert
+end

data/lib/prefix-machine/version.rb

@@ -0,0 +1,3 @@
+class PrefixMachine
+  VERSION = '0.0.1'
+end

data/prefix-machine.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/prefix-machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prefix-machine"
+  spec.version       = PrefixMachine::VERSION
+  spec.authors       = ["Delton Ding"]
+  spec.email         = ["dsh0416@gmail.com"]
+
+  spec.summary       = "The gem to match class prefixes."
+  spec.description   = "The gem to match class prefixes."
+  spec.homepage      = "https://github.com/dsh0416/prefix-machine"
+  spec.license       = 'BSD-3-Clause'
+  spec.required_ruby_version = '>= 2.7.1'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dsh0416/prefix-machine"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.extensions = ['ext/prefix_machine/extconf.rb']
+
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: prefix-machine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Delton Ding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The gem to match class prefixes.
+email:
+- dsh0416@gmail.com
+executables: []
+extensions:
+- ext/prefix_machine/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".vscode/c_cpp_properties.json"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ext/prefix_machine/extconf.rb
+- ext/prefix_machine/prefix_machine.c
+- ext/prefix_machine/prefix_machine.h
+- lib/prefix-machine.rb
+- lib/prefix-machine/version.rb
+- prefix-machine.gemspec
+homepage: https://github.com/dsh0416/prefix-machine
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/dsh0416/prefix-machine
+  source_code_uri: https://github.com/dsh0416/prefix-machine
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The gem to match class prefixes.
+test_files: []