trie-substring-search 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5923666c4e83e361fcc051b410f1238400ff1c088438118d3f1cf00e82801399
+  data.tar.gz: ccf9b0af6f30c421d71faad210572978f957d40cedeed7e6938bfb4f736b39a2
+SHA512:
+  metadata.gz: 5158ee96b40d03627b098f8be180ef25e9abbb8787c226fa0da5c6d57557d2d2991a487ff8973447380649c382c3296a587b18ddef30ee91793a24cd0fc09fde
+  data.tar.gz: 66c0c9a4a1e22d9f2b543a978fe16cf0f65dfdaf13fe5e0c861ce283db53bdf3a1d17c146e3be040a5c32b242563a2ab798a91ef331c090d961306c73e9beae4

data/.drone.yml

@@ -0,0 +1,27 @@
+kind: pipeline
+name: default
+
+steps:
+  - name: install
+    image: ruby
+    volumes:
+      - name: bundle
+        path: /usr/local/bundle
+    commands:
+      - bundle install --jobs=3 --retry=3
+
+  - name: test
+    image: ruby
+    environment:
+      CODECOV_TOKEN:
+        from_secret: CODECOV_TOKEN
+      CI: true
+    volumes:
+      - name: bundle
+        path: /usr/local/bundle
+    commands:
+      - rake
+
+volumes:
+  - name: bundle
+    temp: {}

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/tss/fixtures/*
+/spec/tss/trie/search_high_load_spec.rb
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

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 tss.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    trie-substring-search (0.1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    benchmark-malloc (0.1.0)
+    benchmark-perf (0.5.0)
+    benchmark-trend (0.3.0)
+    codecov (0.1.14)
+      json
+      simplecov
+      url
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    method_source (0.9.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-benchmark (0.5.0)
+      benchmark-malloc (~> 0.1.0)
+      benchmark-perf (~> 0.5.0)
+      benchmark-trend (~> 0.3.0)
+      rspec (>= 3.0.0, < 4.0.0)
+    rspec-collection_matchers (1.1.3)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    unicode-display_width (1.5.0)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.1)
+  codecov (~> 0.1)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-benchmark (~> 0.5.0)
+  rspec-collection_matchers (~> 1.1.0)
+  rubocop (~> 0.67.0)
+  rubocop-performance (~> 1.1.0)
+  simplecov (~> 0.16.0)
+  simplecov-console (~> 0.4.0)
+  trie-substring-search!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright {yyyy} {name of copyright owner}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,91 @@
+# Trie Substring Search
+
+[![Build Status](https://cloud.drone.io/api/badges/sbezugliy/trie-substring-search/status.svg)](https://cloud.drone.io/sbezugliy/trie-substring-search)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/94c864de2611aedac431/maintainability)](https://codeclimate.com/github/sbezugliy/trie-substring-search/maintainability)
+[![codecov](https://codecov.io/gh/sbezugliy/trie-substring-search/branch/master/graph/badge.svg)](https://codecov.io/gh/sbezugliy/trie-substring-search)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trie-substring-search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trie-substring-search
+
+## Usage
+
+```ruby
+    # Array of words in the dictionary
+    dictionary = %w[he she her his him he they their she]
+    # Initialize trie
+    # types of trie to build :full, :flat(WIP) and :aho_corasick(WIP)
+    tss = TSS::Trie.new(dictionary, :full)
+    # Parse text and receive array of all occurrences of words in texts with indexes of word in dictionary
+    tss.parse('he their them height have then their shelter')
+    # => [{:word=>"he", :indexes=>[0, 5]},
+    #  {:word=>"their", :indexes=>[7]},
+    #  {:word=>"he", :indexes=>[0, 5]},
+    #  {:word=>"he", :indexes=>[0, ''$'\200\274\240\235\357''U'5]},
+    #  {:word=>"he", :indexes=>[0, 5]},
+    #  {:word=>"he", :indexes=>[0, 5]},
+    #  {:word=>"their", :indexes=>[7]},
+    #  {:word=>"he", :indexes=>[0, 5]},
+    #  {:word=>"she", :indexes=>[1, 8]},
+    #  {:word=>"he", :indexes=>[0, 5]}]
+    # Add additional words to the dictionary
+    tss.extend_dictionary(["our", "it", "them"])
+    # Get end vertex of word 'they'
+    vertex = tss.root.get_child('s').get_child('h').get_child('e')
+    # => #<ACT::Vertex:0x000055cabb2399d0
+    #  @char="e",
+    #  @children=[],
+    #  @end_indexes=[1, 8],
+    #  @parent=
+    #   #<ACT::Vertex:0x000055cabb239ac0
+    #    @char="h",
+    #    @children=[#<ACT::Vertex:0x000055cabb2399d0 ...>],
+    #    @end_indexes=[],
+    #    @parent=
+    #     #<ACT::Vertex:0x000055cabb239bb0
+    #      @char="s",
+    #      @children=[#<ACT::Vertex:0x000055cabb239ac0 ...>],
+    # get array of indexes of word
+    vertex.end_indexes
+    # => [1, 8]
+    # Recover word from trie with indexes in dictionary
+    tss.backtrace_to_word(vertex)
+    # => {:word=>"she", :indexes=>[1, 8]}
+```
+
+Index of word in dictionary can be used to get relations with additional array with external data(or collection, or can be easily replaced by foreign key in the future). If dictionary contain duplicates, then you will get few indexes in result.
+
+## Benchmark
+
+    dictionary:                            100000 words
+    number of executions with uniq text:   44555
+    results of benchmark:
+
+    user       system     total       real
+    1.749733   0.116561   1.866294 (  1.876876)
+
+## Development
+
+## Contributing
+
+### TBD Improvements:
+
+    - TODO: Mode providing ability to return whole words, that contain substring from dictionary
+    - TODO: Suffix references is not implemented. Just now it contains full syntax tree, so it is less memory efficient then original Aho-Corasick algorithm.
+    - TODO: Maybe, will be good to implement next features for trie build stage:
+      -  post optimization of vertex connections, creating suffixes
+      -  some parallelism
+      -  pre optimization of a dictionary.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tss/tss'
+require 'tss/tries/full'
+require 'tss/tries/flat'
+require 'tss/tries/ac'
+require 'tss/tries/base'
+require 'tss/trie'
+require 'tss/link'
+require 'tss/vertex'
+
+# 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 'pry'
+Pry.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/lib/tss/link.rb

@@ -0,0 +1,23 @@
+module TSS
+  ##
+  # Class representing links(suffixes) between vertexes
+  class Link
+    ##
+    # Linked vertex
+    attr_accessor :vertex
+    ##
+    # Character to simplify search
+    attr_reader :char
+    ##
+    # Index of word in dictionary if vertex is ending, or nil if vertex is suffix
+    attr_accessor :end_index
+
+    ##
+    # Create new ACT::Link object
+    def initialize(vertex, end_index = nil)
+      @vertex = vertex
+      @char = @vertex.char
+      @end_index = end_index
+    end
+  end
+end

data/lib/tss/trie.rb

@@ -0,0 +1,71 @@
+# TSS module
+module TSS
+  ##
+  # Main class for creating Trie Substring Search from array of words of dictionary
+  class Trie
+    ##
+    # Root vertex
+    attr_reader :root
+    ##
+    # Dictionary attribute
+    attr_reader :dictionary
+    ##
+    # Trie attribute
+    attr_reader :trie
+    ##
+    # Trie class reference switched by type
+    attr_reader :trie_class
+    ##
+    # Trie class instance
+    attr_reader :trie_instance
+    ##
+    # Initialize new trie and fill it with words from dictionary
+    def initialize(dictionary, type = :full)
+      switch_trie_type(type)
+      @root = TSS::Vertex.new
+      @dictionary = dictionary
+      build_trie
+    end
+
+    ##
+    # Executes text analyzis and returns map occurring words with indexes from dictionary
+    def parse(text)
+      @trie_instance.parse(text)
+    end
+
+    ##
+    # Returns hash with word and indexes at dictionary
+    # * Ending vertex of chain should be used as argument, it means that it should
+    #   contain at least one value in the array of end_indexes attribute
+    def backtrace_to_word(vertex)
+      @trie_instance.backtrace_to_word(vertex)
+    end
+
+    ##
+    # Adds additional words(chains of vertexes) to the trie object
+    # * Argument should be array of words
+    # Example:
+    #   >> tss.extend_dictionary(["our", "it", "them"])
+    def extend_dictionary(dict)
+      @trie_instance.extend_dictionary(dict)
+    end
+
+    private
+
+    def build_trie
+      @trie_instance = @trie_class.new(@dictionary, @root)
+    end
+
+    def switch_trie_type(type)
+      @trie_class = TSS::Tries.const_get(trie_symbol(type), @root)
+    end
+
+    def trie_symbol(type)
+      return :Full if type == :full
+      return :AC if type == :aho_corasick
+      return :Flat if type == :flat
+
+      raise ArgumentError, 'Wrong trie type. Possible is: :full, :flat or :aho_corasick'
+    end
+  end
+end

data/lib/tss/tries/ac.rb

@@ -0,0 +1,26 @@
+module TSS
+  module Tries
+    ##
+    # Aho-Corasick trie class
+    class AC < Base
+      ##
+      # Executes text analyze and returns map occurring words with indexes from dictionary
+
+      def parse
+        raise 'WIP'
+      end
+
+      ##
+      # Returns hash with word and indexes at dictionary
+      def backtrace_to_word
+        raise 'WIP'
+      end
+
+      ##
+      # Adds additional words(chains of vertexes) to the trie object
+      def extend_dictionay
+        raise 'WIP'
+      end
+    end
+  end
+end

data/lib/tss/tries/base.rb

@@ -0,0 +1,45 @@
+# TSS module
+module TSS
+  module Tries
+    ##
+    # Main class for creating Aho-Corasick Trie from array of words of dictionary
+    class Base
+      ##
+      # Root vertex
+      attr_reader :root
+      ##
+      # Dictionary attribute
+      attr_reader :dictionary
+      ##
+      # Trie attribute
+      attr_reader :trie
+
+      ##
+      # Initialize new trie and fill it with words from dictionary
+      #
+      # Remarks:
+      # * dictioanry is array of characters
+      # * if indexing is important array should not be sorted
+      # * word from sentence may contain spaces and special characters, so
+      #   one "word" can be the whole sentence
+      # * word can be an integer, but result will be converted to the string
+      #
+      # Example:
+      #   >> TSS.new(["abc", "cde", 8, "ad f", "wer\nm"])
+      #
+      # Arguments:
+      #   dictionary: (Array)
+      def initialize(dictionary, root_vertex)
+        @root = root_vertex
+        @dictionary = dictionary
+        @trie = build_trie
+      end
+
+      private
+
+      def build_trie
+        @root
+      end
+    end
+  end
+end

data/lib/tss/tries/flat.rb

@@ -0,0 +1,27 @@
+# TSS module
+module TSS
+  module Tries
+    ##
+    # Main class for creating Flat Trie from array of words of dictionary
+    class Flat < Base
+      ##
+      # Executes text analyze and returns map occurring words with indexes from dictionary
+
+      def parse(_text)
+        raise 'WIP'
+      end
+
+      ##
+      # Returns hash with word and indexes at dictionary
+      def backtrace_to_word(_vertex)
+        raise 'WIP'
+      end
+
+      ##
+      # Adds additional words(chains of vertexes) to the trie object
+      def extend_dictionary(_dict)
+        raise 'WIP'
+      end
+    end
+  end
+end

data/lib/tss/tries/full.rb

@@ -0,0 +1,130 @@
+# TSS module
+module TSS
+  module Tries
+    ##
+    # Main class for creating Full Trie from array of words of dictionary
+    class Full < Base
+      ##
+      # Executes text analyze and returns map occurring words with indexes from dictionary
+      # Example:
+      #   >> tss.parse('he their them height have then their shelter')
+      #   => [ {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"their", :indexes=>[7]},
+      #        {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"their", :indexes=>[7]},
+      #        {:word=>"he", :indexes=>[0, 5]},
+      #        {:word=>"she", :indexes=>[1, 8]},
+      #        {:word=>"he", :indexes=>[0, 5]}]
+      # Arguments:
+      #   text: (String)
+      def parse(text)
+        text = text.to_s.split('')
+        vm = vertex_map(text) { :vertex }
+        exec_branches(text, vm).flatten.compact
+      end
+
+      ##
+      # Returns hash with vertexes that represents letters of word and indexes of word in dictionary
+      # * Ending vertex of chain should be used as argument, it means that it should
+      #   contain at least one value in the array of end_indexes attribute
+      # Example:
+      #   backtrace_to_word(vertex)
+      # Arguments:
+      #   vertex: (TSS::Vertex) - ending vertex of chain of letters
+      def backtrace_to_word(vertex)
+        if vertex.end_indexes.empty?
+          raise 'Argument should be ending vertex of chain, and contain at'\
+                'least one value in the array of end_indexes attribute'
+        else
+          chain = backtrace(vertex)
+          {
+            word: chain.reduce('') { |acc, v| acc << v.char },
+            indexes: chain.last.end_indexes
+          }
+        end
+      end
+
+      ##
+      # Adds additional words(chains of vertexes) to the trie object
+      # * Argument should be array of words
+      # Example:
+      #   >> tss.extend_dictionary(["our", "it", "them"])
+      def extend_dictionary(dict)
+        build_trie(dict)
+      end
+
+      private
+
+      def exec_branches(text, vertex_map)
+        vertex_map.map do |b|
+          b[:indexes].map do |index|
+            search(b[:key], text[index + 1..-1])
+          end
+        end
+      end
+
+      def search(vertex, text)
+        result = []
+        return result unless vertex
+
+        result << backtrace_to_word(vertex) if end_vertex?(vertex)
+        return result if vertex.children.empty?
+
+        ending = search_rest(vertex, text)
+        !ending.empty? ? (result + ending) : result
+      end
+
+      def search_rest(vertex, text)
+        result = []
+        text.each do |char|
+          current_vertex = vertex.get_child(char)
+          break if current_vertex.nil?
+
+          result << backtrace_to_word(current_vertex) if end_vertex?(current_vertex)
+          break if current_vertex.children.empty?
+
+          vertex = current_vertex
+        end
+        result
+      end
+
+      def vertex_map(text)
+        @trie.children.map do |vertex|
+          {
+            key: vertex.send(yield),
+            indexes: text.collect.with_index { |c, i| i if c == vertex.char }.compact
+          }
+        end
+      end
+
+      def end_vertex?(vertex)
+        !vertex.end_indexes.empty?
+      end
+
+      def backtrace(vertex)
+        result = !vertex.nil? ? [vertex] : []
+        until vertex.parent.nil?
+          result << vertex.parent unless vertex.parent.char.nil?
+          vertex = vertex.parent
+        end
+        result.reverse
+      end
+
+      def build_trie(dict = @dictionary)
+        parent = @root
+        dict.each_with_index do |word, index|
+          word = word.to_s
+          word.to_s.each_char.with_index do |char, char_index|
+            end_index = char_index == (word.length - 1) ? index : nil
+            @vertex = (char_index.zero? ? @root : parent)
+            parent = @vertex.add_child(char, end_index)
+          end
+        end
+        @root
+      end
+    end
+  end
+end

data/lib/tss/tss.rb

@@ -0,0 +1,11 @@
+require 'tss/version'
+require 'tss/trie'
+require 'tss/tries/base'
+require 'tss/tries/full'
+require 'tss/tries/flat'
+require 'tss/tries/ac'
+require 'tss/vertex'
+require 'tss/link'
+##
+# Main module for Trie Substring Search
+module TSS; end

data/lib/tss/version.rb

@@ -0,0 +1,3 @@
+module TSS
+  VERSION = '0.1.0.0'.freeze
+end

data/lib/tss/vertex.rb

@@ -0,0 +1,95 @@
+# TSS module
+module TSS
+  ##
+  # Trie vertex class
+  class Vertex
+    ##
+    # Reference to the root vertex of the trie
+    attr_accessor :root
+    ##
+    # Reference to the parent TSS::Vertex
+    attr_accessor :parent
+    ##
+    # Array of children TSS::Vertex references for nested models(full trie, Aho-Corasick trie)
+    # or as list of nested vertexes of root vertex of flat trie
+    attr_reader :children
+    ##
+    # Array of TSS::Vertex links for flat trie model, also used as suffixes of Aho-Corasick trie
+    attr_reader :links
+    ##
+    # Array of indexes of word in dictionary
+    # Empty if it is intermediate TSS::Vertex in chain
+    attr_accessor :end_indexes
+    ##
+    # Letter representing this vertex
+    attr_accessor :char
+
+    ##
+    # Initializes new vertex
+    # * +parent+ is parent TSS::Vertex
+    # Example:
+    #   >> TSS::Vertex.new(@root_vertex)
+    #   >> TSS::Vertex.new(@root_vertex)
+    # Optional arguments:
+    #   parent: (TSS::Vertex)
+    def initialize(parent = nil)
+      @char = nil
+      @parent = parent
+      @children = []
+      @links = []
+      @end_indexes = []
+      yield(self) if block_given?
+    end
+
+    ##
+    # Initializes new TSS::Vertex and adds it to the parent attribute
+    def add_child(char, end_index)
+      child = get_child(char)
+      if child
+        child.end_indexes << end_index unless end_index.nil?
+        child
+      else
+        init_subchild(char, end_index)
+      end
+    end
+
+    ##
+    # Returns child TSS::Vertex by letter, from children attribute
+    def get_child(char)
+      @children.find { |c| c.char == char }
+    end
+
+    ##
+    # Adds reference to the linked vertexes
+    def add_link(vertex, end_index = nil)
+      @links << TSS::Link.new(vertex, end_index)
+    end
+
+    ##
+    # Returns link by character
+    def get_link(char)
+      @links.find { |l| l.char == char }
+    end
+
+    ##
+    # Returns array of characters from array of children TSS::Vertex
+    def children_chars
+      @children.map(&:char)
+    end
+
+    def vertex
+      self
+    end
+
+    private
+
+    def init_subchild(char, end_index)
+      child = self.class.new(self)
+      child.char = char
+      child.root = @root
+      child.end_indexes << end_index unless end_index.nil?
+      @children << child
+      child
+    end
+  end
+end

data/tss.gemspec

@@ -0,0 +1,56 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/tss/version'
+require './lib/tss/tss'
+require './lib/tss/trie'
+require './lib/tss/tries/base'
+require './lib/tss/tries/ac'
+require './lib/tss/tries/full'
+require './lib/tss/tries/flat'
+require './lib/tss/vertex'
+Gem::Specification.new do |spec|
+  spec.name          = 'trie-substring-search'
+  spec.version       = TSS::VERSION
+  spec.authors       = ['Sergey Bezugliy']
+  spec.email         = ['s.bezugliy@gmail.com']
+  spec.homepage      = 'https://codenv.top/projects/trie-substring-search'
+  spec.summary       = 'Trie based substring search algorithm implementation'
+  spec.license       = 'Apache-2.0'
+  spec.description   = <<-DESCRIPTION
+    This gem provides ruby library with algorithms for trie based
+    substring search.
+  DESCRIPTION
+  # 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'
+
+    spec.metadata['homepage_uri']       = spec.homepage
+    spec.metadata['source_code_uri']    = 'https://github.com/sbezugliy/trie-substring-search'
+    # spec.metadata['changelog_uri']      = 'https://github.com/sbezugliy/trie-substring-search/changelog.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-benchmark', '~> 0.5.0'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1.1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.0'
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: trie-substring-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0.0
+platform: ruby
+authors:
+- Sergey Bezugliy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: |2
+      This gem provides ruby library with algorithms for trie based
+      substring search.
+email:
+- s.bezugliy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tss/link.rb
+- lib/tss/trie.rb
+- lib/tss/tries/ac.rb
+- lib/tss/tries/base.rb
+- lib/tss/tries/flat.rb
+- lib/tss/tries/full.rb
+- lib/tss/tss.rb
+- lib/tss/version.rb
+- lib/tss/vertex.rb
+- tss.gemspec
+homepage: https://codenv.top/projects/trie-substring-search
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://codenv.top/projects/trie-substring-search
+  source_code_uri: https://github.com/sbezugliy/trie-substring-search
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Trie based substring search algorithm implementation
+test_files: []