teton 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ae17f69664066dc41b866710d796b0191718219cd2b8d8ebd46e7ee513e4c4
-  data.tar.gz: fd29fdac420cd364cf8ef98101f8ac52e2c8a44d569e347c62691e756f226fa3
+  metadata.gz: 84509199f54853bad7c82f951f2a83e2bfc1965058f3055f03449234d434ac3d
+  data.tar.gz: be10440a0380bf6e2a9df385f4a6bfec59da3d337c2991632d4bd13364e80136
 SHA512:
-  metadata.gz: 5562f125e730627254377f95049b5bf636b05423322291fd4a9349075c6b084b0d125c4c9095469e8945a04779c49284fbf0d1937b583331606224acd47968f6
-  data.tar.gz: 055c6914b343d7288de36d63d3e8ca35b2a2fbe2694d852ce4763438518e90aa6850f8fce1926ad014c95f96a25eafcd823b99c545b8fbf9cc7eb0fce4be02e6
+  metadata.gz: 8b85202b1785bce00ff27aaba9e615b6d00db61cdde2eec3a9af2fa661538536d06ab7c9f8e109b3b413577a156f35a3cc54f4772d512ee99c7d2e54a133d925
+  data.tar.gz: 231fd68d9615505527dbc2e774b8a5fa7f78418a77296c2670bce272fe5a4c7cc42a4c1051d9b66d02e1b84e5647b6a0e4df103173e7dc3dddcb3efc18271a8c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+#### 0.0.3 - Monday, Sept. 5th, 2022
+
+* Paging mechanics added: Db#get now supports `skip` and `limit` optional keyword arguments.
 
 #### 0.0.2 - Monday, Sept. 5th, 2022
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![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
+#### Hierarchical key-value object store
 
 ---
 
@@ -26,12 +26,16 @@ bundle add teton
 
 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.
+Method                                 | Description
+---------------------------------------| --------------------------------------------------------------
+`Db#set(key, data = {})`               | Set an entries data to the passed in values.
+`Db#get(key, limit: nil, skip: nil)`   | 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.
+
+Note(s):
+
+* limit and skip are optional and only apply to resource keys, not entry keys.
 
 #### Setting Up Database
 

data/lib/teton/db.rb

@@ -30,8 +30,12 @@ module Teton
       self
     end
 
-    def get(key)
-      store.get(key(key))
+    def get(key, limit: nil, skip: nil)
+      store.get(
+        key(key),
+        limit: zero_floor_or_nil(limit),
+        skip: zero_floor_or_nil(skip)
+      )
     end
 
     def del(key)
@@ -44,6 +48,12 @@ module Teton
 
     private
 
+    def zero_floor_or_nil(value)
+      return unless value
+
+      value ? [value, 0].max : nil
+    end
+
     def key(key)
       key.is_a?(Key) ? key : Key.new(key, separator: separator)
     end

data/lib/teton/entry.rb

@@ -15,7 +15,7 @@ module Teton
     end
 
     def [](data_key)
-      data[data_key]
+      data[data_key.to_s]
     end
 
     def to_s

data/lib/teton/stores/memory.rb

@@ -27,13 +27,13 @@ module Teton
         self
       end
 
-      def get(key)
+      def get(key, limit: nil, skip: nil)
         store_pointer = traverse_to_last(key)
 
         return unless store_pointer
 
         if key.resource?
-          entries(key, store_pointer, key.last_part)
+          entries(key, store_pointer, key.last_part, limit: limit, skip: skip)
         else
           entry(key, store_pointer, key.last_part)
         end
@@ -158,14 +158,20 @@ module Teton
         )
       end
 
-      def entries(key, pointer, part)
+      def entries(key, pointer, part, limit: nil, skip: nil)
         pointer = pointer.dig(part, IDS_KEY)
 
         return [] unless pointer
 
-        pointer.map do |inner_part, value|
+        start_index   = skip || 0
+        end_index     = limit ? (start_index + limit - 1) : -1
+        selected_keys = pointer.keys[start_index..end_index] || []
+
+        selected_keys.map do |selected_key|
+          value = pointer[selected_key]
+
           Entry.new(
-            key.to_s(inner_part),
+            key.to_s(selected_key),
             data: value[DATA_KEY],
             created_at: value[META_KEY][CREATED_AT_KEY],
             updated_at: value[META_KEY][UPDATED_AT_KEY]

data/lib/teton/version.rb

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

data/teton.gemspec

@@ -5,7 +5,7 @@ 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.summary     = 'Hierarchical key-value object store.'
 
   s.description = 'Store key-value pair objects in a discoverable hierarchy.  Provides a pluggable interface for multiple back-ends.'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teton
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -214,5 +214,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Hierarchical key-value object store interface.
+summary: Hierarchical key-value object store.
 test_files: []