mini_search 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acd453c483524bd3ab16323edf2d237a6c037ac6aac48d365f395c80a343a606
+  data.tar.gz: '0681c134db08c7b354ef53ef6670aa7d984de43fbb959175cf94f0efc7d0d86c'
+SHA512:
+  metadata.gz: 726b0e4d969f9040d1b18ec9967dbf0cf28fc473b36377279f03b5ee782f8e619c9ee0e89087a540ac61a7a27fc8757113f15c7acd3153bc6b6e5fd427174fc7
+  data.tar.gz: 816d97d2bb91349bbe9b134d5d1b8425910fa1507c76db0743e5d9921bf74c1446e5939a50b34b1116bf0712a279af5766587ec771557ba66f29527f2f719b92

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/data/
+
+# 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.5.0
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrewaguiar6@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/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 mini_search.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mini_search (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mini_search!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew S Aguiar
+
+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,267 @@
+# MiniSearch
+
+A simple and naive mini search engine in memory using BM25 algorithm.
+
+MiniSearch implements a inverted index (basically a hashmap where terms are keys and values are documents that contains that key.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_search
+
+## Inverted Index
+
+MiniSearch implements a inverted index (basically a hashmap where terms are keys and values are documents that contains that key.
+
+Lets take two small documents as examples:
+
+```
+doc1 = 'The domestic dog is a member of the genus Canis, which forms part of the wolf-like canids'
+doc2 = 'The cat is a small carnivorous mammal. It is the only domesticated species in the family Felidae and often referred to as the domestic cat.
+```
+
+To create an inverted index we start with an empty hashmap:
+
+```
+ii = {}
+```
+
+Now for a given document we transform its text in tokens (words):
+
+```
+doc1 = ["The", "domestic", "dog", "is", "a", "member", "of", "the", "genus", "Canis,", "which", "forms", "part", "of", "the", "wolf-like", "canids"]
+doc2 = ["The", "cat", "is", "a", "small", "carnivorous", "mammal.", "It", "is", "the", "only", "domesticated", "species", "in", "the", "family", "Felidae", "and", "often", "referred", "to", "as", "the", "domestic", "cat."]
+```
+
+We take each term and create use it as a key in are hashmap `ii` and the value will be a list with all documents containing that term.
+
+```
+def index(doc_id, doc, ii)
+  # 1 - tokenizer
+  tokens = doc.split(' ')
+
+  tokens.each { |token| ii[token] ||= []; ii[token] << doc_id }
+end
+
+ii = {}
+
+index(:doc1, doc1, ii)
+index(:doc2, doc2, ii)
+
+puts ii
+
+# {
+#   'The'          => [:doc1, :doc2],
+#   'domestic'     => [:doc1, :doc2],
+#   'dog'          => [:doc1],
+#   'is'           => [:doc1, :doc2],
+#   'a'            => [:doc1, :doc2],
+#   'member'       => [:doc1],
+#   'of'           => [:doc1, :doc1],
+#   'the'          => [:doc1, :doc2],
+#   'genus'        => [:doc1],
+#   'Canis,'       => [:doc1],
+#   'which'        => [:doc1],
+#   'forms'        => [:doc1],
+#   'part'         => [:doc1],
+#   'wolf-like'    => [:doc1],
+#   'canids'       => [:doc1],
+#   'cat'          => [:doc2],
+#   'small'        => [:doc2],
+#   'carnivorous'  => [:doc2],
+#   'mammal.'      => [:doc2],
+#   'It'           => [:doc2],
+#   'only'         => [:doc2],
+#   'domesticated' => [:doc2],
+#   'species'      => [:doc2],
+#   'in'           => [:doc2],
+#   'family'       => [:doc2],
+#   'Felidae'      => [:doc2],
+#   'and'          => [:doc2],
+#   'often'        => [:doc2],
+#   'referred'     => [:doc2],
+#   'to'           => [:doc2],
+#   'as'           => [:doc2],
+#   'cat.'         => [:doc2]
+# }
+```
+
+Now it is ease to perform any search, if we want to get all documents about `cat` we could simply take the term cat and see the list o documents
+in it `'cat' => [:doc2]`, if we want to search for 2 or more terms we can do the same `small cat` = `'cat' => [:doc2] and 'small' => [:doc2]`.
+
+Clearly we can improve our index performing some transformations in the tokens before indexing them. For instance we can see we have `cat` and `cat.`
+tokens, we have `The` and `the`. lets clean the data before indexing.
+
+Lets change our define an index pipeline that will be called everytime a document is indexed
+
+```
+def index(doc_id, doc, ii)
+  # 1 - tokenizer
+  tokens = doc.split(' ')
+
+  # 2 - trim
+  tokens = tokens.map(&:strip)
+
+  # 3 - downcase all tokens
+  tokens = tokens.map(&:downcase)
+
+  # 4 - remove punctuation
+  tokens = tokens.map { |token| token.tr(',.!;:', '') }
+
+  tokens.each { |token| ii[token] ||= []; ii[token] << doc_id }
+
+  # ... index
+end
+```
+
+With this changes our index would be:
+
+```
+{
+  'the' => [:doc1, :doc2],
+  'domestic' => [:doc1, :doc2],
+  'dog' => [:doc1],
+  'is' => [:doc1, :doc2],
+  'a' => [:doc1, :doc2],
+  'member' => [:doc1],
+  'of' => [:doc1],
+  'genus' => [:doc1],
+  'canis' => [:doc1],
+  'which' => [:doc1],
+  'forms' => [:doc1],
+  'part' => [:doc1],
+  'wolf-like' => [:doc1],
+  'canids' => [:doc1],
+  'cat' => [:doc2],
+  'small' => [:doc2],
+  'carnivorous' => [:doc2],
+  'mammal' => [:doc2],
+  'it' => [:doc2],
+  'only' => [:doc2],
+  'domesticated' => [:doc2],
+  'species' => [:doc2],
+  'in' => [:doc2],
+  'family' => [:doc2],
+  'felidae' => [:doc2],
+  'and' => [:doc2],
+  'often' => [:doc2],
+  'referred' => [:doc2],
+  'to' => [:doc2],
+  'as' => [:doc2]
+}
+```
+
+Pretty better now, we could apply other steps like removing some words that are irrelevant for us (stop words),
+add synonyms for some words but this other changes are specifics from languages.
+
+TODO
+
+## Language support (stop words, stemmers)
+
+TODO
+
+## BM25 (from wikipedia)
+
+BM25 is a bag-of-words retrieval function that ranks a set of documents based on the query terms appearing in each document, regardless 
+of their proximity within the document. It is a family of scoring functions with slightly different components and parameters.
+One of the most prominent instantiations of the function is as follows.
+
+Given a query Q, containing keywords `q1....qn` the BM25 score of a document `D` is:
+
+![BM25 Formula](formula1.svg)
+
+where `f(qi, D)` is qi's term frequency (tf) in the document `D`, `|D|` is the length of the document `D` in words, and avgdl is the 
+average document length in the text collection from which documents are drawn. `k1` and `b` are free parameters, usually chosen, in absence of
+an advanced optimization, as `k1 in |1.2,2.0|` and `b = 0.75`. `IDF(qi)` is the IDF (inverse document frequency) weight of the query term
+`qi`. It is usually computed as:
+
+![IDF Formula](formula2.svg)
+
+where `N` is the total number of documents in the collection, and `n(q)` is the number of documents containing `qi`.
+
+There are several interpretations for IDF and slight variations on its formula. In the original BM25 derivation,
+the IDF component is derived from the Binary Independence Model.
+
+The above formula for IDF has drawbacks for terms appearing in more than half of the corpus documents. These terms' IDF is negative,
+so for any two almost-identical documents, one which contains the term may be ranked lower than one which does not. This is often an
+undesirable behavior, so many applications adjust the IDF formula in various ways:
+
+Each summand can be given a floor of 0, to trim out common terms;
+The IDF function can be given a floor of a constant `e`, to avoid common terms being ignored at all;
+The IDF function can be replaced with a similarly shaped one which is non-negative, or strictly positive to avoid terms being ignored at all.
+
+## Usage
+
+First we create an inverted Index
+
+```ruby
+  idx = MiniSearch.new_index
+
+  # Then we index some documents (a document is a simple Hash with :id and :indexed_field in it)
+
+  idx.index(id: 1, indexed_field: 'red duck')
+  idx.index(id: 2, indexed_field: 'yellow big dog')
+  idx.index(id: 3, indexed_field: 'small cat')
+  idx.index(id: 4, indexed_field: 'red monkey noisy')
+  idx.index(id: 5, indexed_field: 'small horse')
+  idx.index(id: 6, indexed_field: 'purple turtle')
+  idx.index(id: 7, indexed_field: 'tiny red spider')
+  idx.index(id: 8, indexed_field: 'big blue whale')
+  idx.index(id: 9, indexed_field: 'huge elephant')
+  idx.index(id: 10, indexed_field: 'red big cat')
+
+  # Then we can search for our documents
+
+  result = idx.search('RED  cat ')
+
+  # The result will be something like:
+
+  puts result
+
+  # {
+  #   documents: [
+  #     { document: { id: 10, indexed_field: 'red big cat' }, score: 2.726770362793935 },
+  #     { document: { id: 3, indexed_field: 'small cat' }, score: 1.860138656065616 },
+  #     { document: { id: 4, indexed_field: 'red monkey noisy' }, score: 0.630035123281377 },
+  #     { document: { id: 7, indexed_field: 'tiny red spider' }, score: 0.630035123281377 },
+  #     { document: { id: 1, indexed_field: 'red duck' }, score: 0.5589416657904823 }
+  #   ],
+  #   idfs: {
+  #     'cat' => 1.2237754316221157,
+  #     'red' => 0.36772478012531734
+  #   },
+  #   processed_terms: ['red', 'cat']
+  # }
+```
+
+We can see results are sorted by score, notice that the document we index can have any other 
+fields like name, price and etc. But only `:id` and `:indexed_field` are required
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/mini_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MiniSearch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mini_search/blob/master/CODE_OF_CONDUCT.md).