teton 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ae26f8067acdb56f89e1df1754b9e91e89ff3d96c6f6b30c3d46e3c0f7651f3
+  data.tar.gz: d6858d2075ec88c423bb463406f8adeef82b51ab796f76da3aeb021c60993a93
+SHA512:
+  metadata.gz: 2d3fddc1585ea06a7323b7d146942db50c0cdfd224aa5dd6faa088b4735d0fc1b84ff3db9e7a90fb202f0b09b9033946bed31afabfabc995f9ac504321117f17
+  data.tar.gz: 8d5e24cb57f502f37db40e90adcf439100c5c9547fe9296344c088b28cd0eb2b59c308a388e5c0cccff9530d42c170e3925dbadd26d066fb67082df6ddb5037e

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.github/workflows/rubygem.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Lint
+      run: bin/rubocop
+    - name: Test
+      run: bin/rspec spec --format documentation
+    - name: Dependency Audit
+      run: bin/bundler-audit check --update

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - bin/*
+    - vendor/bundle/**/*
+    - '*.gemspec'
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 25
+
+RSpec/ExampleLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 150

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.6

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+#### 0.0.1 - TBD
+
+* Initial proof-of-concept release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# 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. 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,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,5 @@
+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,170 @@
+# Teton
+
+[![Gem Version](https://badge.fury.io/rb/teton.svg)](https://badge.fury.io/rb/teton) [![Ruby Gem CI](https://github.com/mattruggio/teton/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/teton/actions/workflows/rubygem.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/787a5d512223e85efd69/maintainability)](https://codeclimate.com/github/mattruggio/teton/maintainability) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+#### Hierarchical key-value object store interface
+
+---
+
+Store key-value pair-based objects in a key-based hierarchy.  Provides a pluggable interface for multiple back-ends.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install teton
+````
+
+You can also add this to your Gemfile using:
+
+````
+bundle add teton
+````
+
+## Examples
+
+The main API is made up of these instance methods:
+
+Method              | Description
+------------------- | -----------
+`Db#set(key, data)` | Set an entries data to the passed in values.
+`Db#get(key)`       | Get the entry if it exists or nil if it does not.  If the key is a resource then it will always return an array.
+`Db#del(key)`       | Delete the key and all children of the key from the store.
+`Db#count(key)`     | The number of entries directly under a key if the key is a resource.  If they key is an entry then 1 if the entry exists and 0 if it does not exist.
+
+#### Setting Up Database
+
+````ruby
+db = Teton::Db.new
+````
+
+#### Setting Objects
+
+````ruby
+bozo_key             = 'users/1'
+inception_key        = "#{bozo_key}/movies/1"      # => users/1/movies/1
+inception_actors_key = "#{inception_key}/actors"   # => users/1/movies/1/actors
+leo_key              = "#{inception_actors_key}/1" # => users/1/movies/1/actors/1
+tom_key              = "#{inception_actors_key}/2" # => users/1/movies/1/actors/2
+
+db.set(bozo_key, first: 'bozo', last: 'clown')
+  .set(inception_key, title: 'Inception', year: 2010)
+  .set(leo_key, first: 'Leonardo', last: 'DiCaprio', star: true)
+  .set(tom_key, first: 'Tom', last: 'Hardy', star: true)
+````
+
+Note(s):
+
+* `#set` returns self.
+* If an inner key within the key does not exist then it will be added to the hierarchy.
+
+#### Retrieving Objects
+
+````ruby
+bozo             = db.get(bozo_key)             # => Teton::Entry
+inception        = db.get(inception_key)        # => Teton::Entry
+leo              = db.get(leo_key)              # => Teton::Entry
+tom              = db.get(tom_key)              # => Teton::Entry
+inception_actors = db.get(inception_actors_key) # => [Teton::Entry]
+````
+
+Note(s):
+
+* If a key does not exist then nil will be returned.
+* If a key is for a resource then it will return an array.
+
+#### Deleting Objects
+
+````ruby
+db.del(leo_key)
+  .get(inception_key)
+  .del(bozo_key)
+````
+
+Note(s):
+
+* `#del` returns self.
+* If an inner key is deleted then all child keys in the hierarchy are deleted.
+
+#### Backends
+
+The back-end: `Teton::Stores::Memory` will be used by default.  You can also pass in another back-end if one exists:
+
+````ruby
+store = Teton::Stores::MySQL.new(host: '127.0.0.1', db: 'teton_entries')
+db    = Teton::Db.new(store: store)
+````
+
+Note(s):
+
+* Each back-end may require specific configuration so it is up to you to check the desired back-end's documentation.
+* Currently `Teton::Stores::MySQL` does not exist as an implementation but any store (i.e. MySQL, PostgeSQL, Redis, S3, traditional file systems) should all be possible.
+
+Each back-end provides its own persistence mechanics.  For example, `Teton::Stores::Memory` provides persistence/serialization methods:
+
+Method              | Description
+------------------- | -----------
+`#load!(path(`      | Load from a file on disk
+`#save!(path)`      | Save to a file on disk
+`#from_json!`       | Deserialize a passed in JSON string
+`#to_json`          | Return a serialized JSON string
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check teton.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:mattruggio/teton.git)
+4. Navigate to the root folder (cd teton)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````zsh
+bin/rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````zsh
+bin/guard
+````
+
+Also, do not forget to run Rubocop:
+
+````zsh
+bin/rubocop
+````
+
+And auditing the dependencies:
+
+````zsh
+bin/bundler-audit check --update
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into main
+2. Update `version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push main to remote and ensure CI builds main successfully
+6. 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).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattruggio/teton/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

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

data/bin/bundle-audit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle-audit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler-audit", "bundle-audit")

data/bin/bundler-audit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler-audit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler-audit", "bundler-audit")

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'teton'
+require 'pry'
+
+Pry.start

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/teton/db.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'entry'
+require_relative 'key'
+require_relative 'stores/memory'
+
+module Teton
+  # The main interface for any store backend.
+  class Db
+    DEFAULT_SEPARATOR = '/'
+
+    attr_reader :separator, :store
+
+    def initialize(separator: DEFAULT_SEPARATOR, store: Stores::Memory.new)
+      raise ArgumentError, 'separator is required' if separator.to_s.empty?
+
+      @separator = separator.to_s
+      @store     = store
+
+      freeze
+    end
+
+    def set(key, data)
+      key = key(key)
+
+      raise ArgumentError, "key: #{key} does not point to an entry" unless key.entry?
+
+      store.set(key, string_keys_and_values(data))
+
+      self
+    end
+
+    def get(key)
+      store.get(key(key))
+    end
+
+    def del(key)
+      tap { store.del(key(key)) }
+    end
+
+    def count(key)
+      store.count(key(key))
+    end
+
+    private
+
+    def key(key)
+      key.is_a?(Key) ? key : Key.new(key, separator: separator)
+    end
+
+    def string_keys_and_values(hash)
+      (hash || {}).to_h { |k, v| [k.to_s, v.to_s] }
+    end
+  end
+end

data/lib/teton/entry.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Teton
+  # Describe what data should be returned when requested.
+  class Entry
+    attr_reader :key, :data, :created_at, :updated_at
+
+    def initialize(key, data: {}, created_at: Time.now.utc, updated_at: Time.now.utc)
+      @key        = key.to_s
+      @data       = (data || {}).transform_keys(&:to_s)
+      @created_at = created_at || Time.now.utc
+      @updated_at = updated_at || Time.now.utc
+
+      freeze
+    end
+
+    def [](data_key)
+      data[data_key]
+    end
+
+    def to_s
+      "[#{key} |> #{created_at} | #{updated_at}] #{data.map { |k, v| "#{k}: #{v}" }.join(', ')}"
+    end
+  end
+end

data/lib/teton/key.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Teton
+  # Understands a fully-qualified path to a resource or resources.
+  class Key
+    attr_reader :path, :parts, :separator
+
+    def initialize(path, separator:)
+      raise ArgumentError, 'separator is required' if separator.to_s.empty?
+      raise ArgumentError, 'path is required'      if path.to_s.empty?
+
+      @path      = path.to_s
+      @parts     = path.to_s.split(separator)
+      @separator = separator.to_s
+
+      freeze
+    end
+
+    def to_s(suffix_keys = [])
+      suffix_keys = Array(suffix_keys)
+
+      (parts + suffix_keys).join(separator)
+    end
+
+    def traverse(&block)
+      parts.each_with_index(&block)
+    end
+
+    def entry?
+      parts.length.even?
+    end
+
+    def resource?
+      parts.length.odd?
+    end
+  end
+end

data/lib/teton/stores/memory.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Teton
+  module Stores
+    # Plugs in a light-weight store that can be used for modeling other stores.
+    class Memory
+      CREATED_AT_KEY = 'created_at'
+      IDS_KEY        = 'ids'
+      INDICES_KEY    = 'indices'
+      META_KEY       = 'meta'
+      DATA_KEY       = 'data'
+      UPDATED_AT_KEY = 'updated_at'
+
+      attr_reader :store
+
+      def initialize(store = {})
+        @store = store || {}
+      end
+
+      # Main Object API
+
+      def set(key, data)
+        pointer = store
+
+        key.traverse do |part, index|
+          if index < key.parts.length - 1
+            pointer = insert_traverse(index, pointer, part)
+          else
+            # last id
+            upsert(pointer, part, data)
+          end
+        end
+
+        self
+      end
+
+      def get(key)
+        pointer = store
+
+        key.traverse do |part, index|
+          break unless pointer
+
+          pointer =
+            if index < key.parts.length - 1
+              # not last part
+              traverse(index, pointer, part)
+            elsif key.resource?
+              # last part
+              entries(key, pointer, part)
+            else
+              # id
+              entry(key, pointer, part)
+            end
+        end
+
+        pointer
+      end
+
+      def del(key)
+        pointer = store
+
+        key.traverse do |part, index|
+          break unless pointer
+
+          if index < key.parts.length - 1
+            # not last part
+            pointer = traverse(index, pointer, part)
+          else
+            # last part
+            pointer.delete(part)
+          end
+        end
+
+        self
+      end
+
+      def count(key)
+        count   = 0
+        pointer = store
+
+        key.traverse do |part, index|
+          break unless pointer
+
+          if index < key.parts.length - 1
+            # not last part
+            pointer = traverse(index, pointer, part)
+          elsif key.resource?
+            # last part
+            count = (pointer.dig(part, IDS_KEY) || {}).keys.length
+          else
+            # id
+            count = pointer.dig(part, DATA_KEY) ? 1 : 0
+          end
+        end
+
+        count
+      end
+
+      # Persistence API
+
+      def load!(path)
+        from_json!(File.read(path))
+      end
+
+      def save!(path)
+        dir = File.dirname(path)
+
+        FileUtils.mkdir_p(dir)
+
+        File.write(path, to_json)
+
+        self
+      end
+
+      def from_json!(json)
+        @store = JSON.parse(json)
+
+        self
+      end
+
+      def to_json(*_args)
+        store.to_json
+      end
+
+      private
+
+      def upsert(pointer, part, data)
+        pointer[part] = record_prototype unless pointer.key?(part)
+
+        pointer[part][DATA_KEY]                 = data
+        pointer[part][META_KEY][UPDATED_AT_KEY] = Time.now.utc
+
+        nil
+      end
+
+      def insert_traverse(index, pointer, part)
+        if index.even?
+          # index
+          pointer[part] = { IDS_KEY => {} } unless pointer.key?(part)
+
+          pointer[part][IDS_KEY]
+        else
+          # id
+          pointer[part] = record_prototype unless pointer.key?(part)
+
+          pointer[part][INDICES_KEY]
+        end
+      end
+
+      def traverse(index, pointer, part)
+        if index.even?
+          # index
+          pointer.dig(part, IDS_KEY)
+        else
+          # id
+          pointer.dig(part, INDICES_KEY)
+        end
+      end
+
+      def entry(key, pointer, part)
+        data = pointer.dig(part, DATA_KEY)
+        meta = pointer.dig(part, META_KEY)
+
+        return unless data
+
+        Entry.new(
+          key.to_s,
+          data: data,
+          created_at: meta[CREATED_AT_KEY],
+          updated_at: meta[UPDATED_AT_KEY]
+        )
+      end
+
+      def entries(key, pointer, part)
+        pointer = pointer.dig(part, IDS_KEY)
+
+        return [] unless pointer
+
+        pointer.map do |inner_part, value|
+          Entry.new(
+            key.to_s(inner_part),
+            data: value[DATA_KEY],
+            created_at: value[META_KEY][CREATED_AT_KEY],
+            updated_at: value[META_KEY][UPDATED_AT_KEY]
+          )
+        end
+      end
+
+      def record_prototype
+        {
+          DATA_KEY => {},
+          INDICES_KEY => {},
+          META_KEY => {
+            CREATED_AT_KEY => Time.now.utc,
+            UPDATED_AT_KEY => Time.now.utc
+          }
+        }
+      end
+    end
+  end
+end

data/lib/teton/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Teton
+  VERSION = '0.0.1'
+end

data/lib/teton.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'time'
+
+require_relative 'teton/db'

data/teton.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require './lib/teton/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'teton'
+  s.version     = Teton::VERSION
+  s.summary     = 'Hierarchical key-value object store interface.'
+
+  s.description = 'Store key-value pair objects in a discoverable hierarchy.  Provides a pluggable interface for multiple back-ends.'
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mattruggio@icloud.com']
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir      = 'exe'
+  s.executables = %w[]
+  s.homepage    = 'https://github.com/mattruggio/teton'
+  s.license     = 'MIT'
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/mattruggio/teton/issues',
+    'changelog_uri' => 'https://github.com/mattruggio/teton/blob/main/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/teton',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.required_ruby_version = '>= 2.7.6'
+
+  s.add_development_dependency('bundler-audit')
+  s.add_development_dependency('guard-rspec')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop')
+  s.add_development_dependency('rubocop-rake')
+  s.add_development_dependency('rubocop-rspec')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('simplecov-console')
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: teton
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store key-value pair objects in a discoverable hierarchy.  Provides a
+  pluggable interface for multiple back-ends.
+email:
+- mattruggio@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/rubygem.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/bundle-audit
+- bin/bundler-audit
+- bin/console
+- bin/guard
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- lib/teton.rb
+- lib/teton/db.rb
+- lib/teton/entry.rb
+- lib/teton/key.rb
+- lib/teton/stores/memory.rb
+- lib/teton/version.rb
+- teton.gemspec
+homepage: https://github.com/mattruggio/teton
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/mattruggio/teton/issues
+  changelog_uri: https://github.com/mattruggio/teton/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/teton
+  homepage_uri: https://github.com/mattruggio/teton
+  source_code_uri: https://github.com/mattruggio/teton
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Hierarchical key-value object store interface.
+test_files: []