aho-corasick-trie-search 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a644e1e23eca78c17a99cb5f2bbe13fe33592f113a9f5495acc08e61178142e
-  data.tar.gz: d000ba6f6f948daf099e524d10b5f413b1005839a45816a042d2c5e20006d3b0
+  metadata.gz: 5ac7e696e9b47775234152068ae73617f23b496023f5a2c948be65584485dc2e
+  data.tar.gz: 9262c17cf16a8e9b18f3042ebc5e07ea87ec1353380389c748fc23cedc82508c
 SHA512:
-  metadata.gz: df6067ef38f5f07714fa88ec8a3b219a6148549148cf8fbc049b360e62cc699602cbb0627861348745261d7ebb9c7bfd62b0210ad5c55f3bea513820860303c2
-  data.tar.gz: c11478922a4efa1e0d27043f697923f5f86e232060511b9ea3c040b6b773e8b893a4c5583c54f640e1bb32575dcebcd57fb0ca299a8c379c77f5bccf50ab8f87
+  metadata.gz: d026551b1ab56e0147b388b14ce0a689df62e22efdfa7e5f21c4f0633a987a5cfbb9108bd67778c7cad9a09f5cc41985eab0531e94e2c4fd18dbe4d126b78ecf
+  data.tar.gz: 07ffd8d0c284cd9c4c942d6f28a19eb59c5afce54a37654eaed60e1f71dd57a027816f31513ef4b222367aced24aa67fc96260cd66e1dd308de96003b5540562

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/lib/act/trie.rb

@@ -14,7 +14,7 @@ module ACT
     ##
     # Trie attribute
     attr_reader :trie
-    
+
     ##
     # Initialize new trie and fill it with words from dictionary
     #
@@ -24,6 +24,12 @@ module ACT
     # * 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:
+    #   >> ACT.new(["abc", "cde", 8, "ad f", "wer\nm"])
+    #
+    # Arguments:
+    #   dictionary: (Array)
     def initialize(dictionary)
       @root = ACT::Vertex.new
       @dictionary = dictionary
@@ -32,6 +38,20 @@ module ACT
 
     ##
     # Executes text analyze and returns map occurring words with indexes from dictionary
+    # Example:
+    #   >> act.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 }
@@ -42,6 +62,24 @@ module ACT
     # 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
+    # Example:
+    #   >> vertex = act.trie.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 ...>],
+    #                 ...
+    # Arguments:
+    #   vertes: (ACT::Vertex)
     def backtrace_to_word(vertex)
       if vertex.end_indexes.empty?
         raise 'Argument should be ending vertex of chain, and contain at'\
@@ -58,6 +96,8 @@ module ACT
     ##
     # Adds additional words(chains of vertexes) to the trie object
     # * Argument should be array of words
+    # Example:
+    #   >> act.extend_dictionary(["our", "it", "them"])
     def extend_dictionay(dict)
       build_trie(dict)
     end

data/lib/act/version.rb

@@ -1,3 +1,3 @@
 module ACT
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/act/vertex.rb

@@ -20,6 +20,11 @@ module ACT
     ##
     # Initializes new vertex
     # * +parent+ is parent ACT::Vertex
+    # Example:
+    #   >> ACT::Vertex.new(@root_vertex)
+    #   >> ACT::Vertex.new(@root_vertex)
+    # Optional arguments:
+    #   parent: (ACT::Vertex)
     def initialize(parent = nil)
       @char = nil
       @parent = parent

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aho-corasick-trie-search
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergey Bezugliy
@@ -179,6 +179,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - act.gemspec