mem_db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0576e79f06874cadbf804ca183629fbe4aaa5bb11f5f428aab5e306a3d713b9
+  data.tar.gz: f8409a01d2cc4f2e906366dd7743c53b6612b2e8e28db633f883de1c5dd47375
+SHA512:
+  metadata.gz: b70381b36c4d60d7f807a064c1f368f55d3febdca24ea7d291f33765089197f401b816165d608d467b37327f23c570f80342e4b9d6e390e4a1d380290fc49b46
+  data.tar.gz: b8ea9ca471be55b1c7c9b695299c03b155f262de90d158442a916430b28d1f961b33678b562770bd3d312e1ed62b4b2c1adc6a2521e139e06cd993708099b8a9

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.5
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.5
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/WordArray:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mem_db.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.7"
+gem "ruby-prof", "~> 1.4"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dmitry Bochkarev
+
+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,105 @@
+# MemDb
+
+Embedded database with support of composite indices and complex document matching.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mem_db'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mem_db
+
+## Usage
+
+```ruby
+# Define how fields will be matched
+fields = MemDB::Fields.new([
+  MemDB::Field::Enum.new(:category),
+  MemDB::Field::Enum.new(:"!category").query(:category).negative,
+
+  MemDB::Field::Regexp.new(:text),
+  MemDB::Field::Regexp.new(:"!text").query(:text).negative,
+
+  MemDB::Field::Pattern.new(:breadcrumbs),
+  MemDB::Field::Pattern.new(:"!breadcrumbs").query(:breadcrumbs).negative,
+].map!(&:may_missing))
+
+# Specify index
+
+index = MemDB::Index.compose([
+  MemDB::Index::Enum::Bucket.new(
+    idx: MemDB::Idx::Itself.new(:category).default_any
+  ).accept_any,
+  MemDB::Index::PatternMatch::Bucket.new(
+    idx: MemDB::Idx::Pattern.new(:breadcrumbs).default_any
+  ).accept_any,
+])
+
+# Create database instance
+
+db = MemDB.new(fields, index)
+
+# Indexate
+
+indexation = db.new_indexation
+
+indexation.add(
+  {
+    category: "food",
+    text: ".*fish.*",
+    breadcrumbs: "*/retail/*"
+  },
+  :food_fish
+)
+indexation.add(
+  {
+    "!category": "food",
+    text: ".*fish.*",
+    breadcrumbs: "*/retail/*"
+  },
+  :not_food_fish
+)
+
+# Query
+
+MemDB::Query.new({
+  category: "toy",
+  text: "animated fish",
+  breadcrumbs: "/shops/retail/123"
+}).using(database)
+# => [:not_food_fish]
+
+MemDB::Query.new({
+  category: "food",
+  text: "delicious fish",
+  breadcrumbs: "/shops/retail/123"
+}).using(database)
+# => [:food_fish]
+```
+
+## 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 the created tag, 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/DmitryBochkarev/mem_db.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+```
+
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mem_db"
+
+# 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/lib/mem_db.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "mem_db/version"
+require "set"
+
+class MemDB
+  class Error < StandardError; end
+
+  class Entries
+    class Entry
+      attr_reader :id, :matching, :value
+
+      def initialize(id, matching, value)
+        @id = id
+        @matching = matching
+        @value = value
+      end
+    end
+
+    def initialize
+      @entries = []
+    end
+
+    def [](id)
+      @entries[id]
+    end
+
+    def add(matching, value)
+      id = @entries.length
+
+      entry = Entry.new(id, matching, value)
+      @entries.push(entry)
+
+      id
+    end
+  end
+
+  def initialize(fields, index)
+    @fields = fields
+    @index = index
+    @entries = Entries.new
+  end
+
+  def new_indexation
+    MemDB::Indexation.new(self)
+  end
+
+  def add(obj, value)
+    matching = @fields.new_matching(obj)
+    entry_id = @entries.add(matching, value)
+
+    @index.add(obj, entry_id)
+  end
+
+  def query(query)
+    checked = Set.new
+    found = []
+
+    @index.query(query).each do |entry_id|
+      next if checked.include?(entry_id)
+
+      checked.add(entry_id)
+
+      entry = @entries[entry_id]
+
+      found.push(entry.value) if entry.matching.match?(query)
+    end
+
+    found
+  end
+end
+
+require_relative "mem_db/out"
+require_relative "mem_db/idx"
+require_relative "mem_db/query"
+require_relative "mem_db/indexing_object"
+require_relative "mem_db/indexation"
+require_relative "mem_db/index"
+require_relative "mem_db/fields"
+require_relative "mem_db/field"
+
+require_relative "mem_db/idx/bytes"
+require_relative "mem_db/idx/chars"
+require_relative "mem_db/idx/itself"
+require_relative "mem_db/idx/reverse"
+require_relative "mem_db/idx/uniq"
+require_relative "mem_db/idx/pattern"
+require_relative "mem_db/idx/default"
+
+require_relative "mem_db/index/bucket"
+require_relative "mem_db/index/any"
+require_relative "mem_db/index/enum"
+require_relative "mem_db/index/prefix_tree"
+require_relative "mem_db/index/sequence_match"
+require_relative "mem_db/index/pattern_match"
+
+require_relative "mem_db/field/matching"
+require_relative "mem_db/field/may_missing"
+require_relative "mem_db/field/negative"
+require_relative "mem_db/field/enum"
+require_relative "mem_db/field/pattern"
+require_relative "mem_db/field/regexp"

data/lib/mem_db/bucket.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class MemDB
+  class Bucket
+    def initialize
+      @values = []
+    end
+
+    def add(_obj, value)
+      @values.push(value)
+    end
+
+    def query(_query, out:)
+      out.add(@values)
+    end
+  end
+end

data/lib/mem_db/field.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class MemDB
+  module Field
+    def may_missing
+      MemDB::Field::MayMissing.new(self)
+    end
+
+    def negative
+      MemDB::Field::Negative.new(self)
+    end
+
+    def field
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    def query(query_field)
+      @query_field = query_field
+      self
+    end
+
+    def query_field
+      @query_field || field
+    end
+
+    def new_matching(_obj)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    def query_value(query)
+      query[query_field]
+    end
+  end
+end

data/lib/mem_db/field/enum.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "mem_db/field"
+require "mem_db/field/matching"
+
+class MemDB
+  module Field
+    class Enum
+      include MemDB::Field
+
+      class MultiMatching
+        include MemDB::Field::Matching
+
+        def initialize(enum, arr)
+          @enum = enum
+          @arr = arr
+        end
+
+        def match?(query)
+          @enum.query_value(query).any? do |el|
+            @arr.include?(el)
+          end
+        end
+      end
+
+      class SingleMatching
+        include MemDB::Field::Matching
+
+        def initialize(enum, el)
+          @enum = enum
+          @el = el
+        end
+
+        def match?(query)
+          @enum.query_value(query).include?(@el)
+        end
+      end
+
+      attr_reader :field
+
+      def initialize(field)
+        @field = field
+      end
+
+      def new_matching(obj)
+        val = obj[field]
+
+        if val.is_a?(Array)
+          MultiMatching.new(self, val)
+        else
+          SingleMatching.new(self, val)
+        end
+      end
+    end
+  end
+end