key-vortex 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fcc61bdf13488c6d20e7f6aa4e889852a37ef52b4ea341d8f4c62c40afe8426
-  data.tar.gz: e219c616d9a53e0874221e3ff748a2b4c608dd7c03c86fa765f3f13ffbfabc09
+  metadata.gz: dc49e3b37bc928e227b99983919d05c1e2da5fc06a3c545229dbc8d26c4b3457
+  data.tar.gz: a8356f1144d194f56818375243348aeffd0ed2221b99f9e39dea4610e8be335f
 SHA512:
-  metadata.gz: df02551af7fd966c79f390ea2e15c5984540774eaf23c8770593ac3f750277eebec72975d10d6c8fa80216cd3096689caaf565308b3629d6eb1e7383ee0c6279
-  data.tar.gz: 294e8d44baddfb66d5c909754cf1f48aac50af12fedde35dc9d81e73e8ea68efb1a7a623283229eae745ff19cea284f19b5c08925147089b9b99ff87afe97235
+  metadata.gz: 601d86c191a60adbb6015a66d5fdee969902c211f8c4f2071d5ef84f1014661e4d4fc4522d162260e629b630327674977288e081ec66a0b84d0e1cbdea4890b1
+  data.tar.gz: 66416fd173dabd98442bd38164a8e79afdce5fd2e393d74068bee34f15d0dc4a7ac78b2534d8336729c742989a07e57421a21e2cacc5baad5b1d488bde3d155c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    key-vortex (0.2.2)
+    key-vortex (0.2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -33,7 +33,7 @@ GEM
       guard (~> 2.0)
       rubocop (< 2.0)
     json (2.6.3)
-    key_vortex-contract (0.2.1.2)
+    key_vortex-contract (0.2.4)
       rantly (~> 2.0.0)
       rspec (~> 3.0)
     kwalify (0.7.2)
@@ -80,7 +80,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.54.1)
+    rubocop (1.54.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)

data/README.md

@@ -1,5 +1,41 @@
 # KeyVortex
 
+KeyVortex provides a common abstraction around storing records in various datastores. It allows for the use of different adapters depending on the environment, and provides constraints to protect programmatically against differing constraints between them.
+
+To start using KeyVortex, you'll need to define a record:
+
+```ruby
+require "key_vortex/record"
+
+class ExampleRecord < KeyVortex::Record
+	field :a, String, length: 20
+	field :b, Integer, maximum: 100
+end
+```
+
+Now you can use this object in various ways:
+
+```
+> record = ExampleRecord.new(key: "foo", a: "bar", b: 10)
+=> #<ExampleRecord:0x000055fe0b5fe538 @values={:key=>"foo", :a=>"bar", :b=>10}>
+> record.a
+=> "bar"
+> record.a = "baz"
+=> "baz"
+> record.a
+=> "baz"
+> record.b = 1000
+Invalid value 1000 for b (KeyVortex::Error)
+```
+
+You may notice that a `key` field was defined as well. This can be a String up to 36 characters long, to accomodate a GUID if that's what you wish to use.
+
+In order to save the record somewhere, you'll need to choose an adapter. To keep dependencies down, these will generally be implemented in other gems, but an in memory adapter does ship with this gem.
+
+```
+> require "key_vortex/adapter/memory"
+
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/key_vortex`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem

data/lib/key_vortex/adapter/memory.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require "key_vortex"
 require "key_vortex/adapter"
 
 class KeyVortex
   class Adapter
     class Memory < KeyVortex::Adapter
+      def self.build(items: {}, limitations: [])
+        new(items, limitations: limitations)
+      end
+
       def initialize(items, limitations: [])
         super()
         @items = items
@@ -25,3 +30,5 @@ class KeyVortex
     end
   end
 end
+
+KeyVortex.register(KeyVortex::Adapter::Memory)

data/lib/key_vortex/adapter.rb

@@ -13,5 +13,9 @@ class KeyVortex
     def register_limitation(limitation)
       @limitations[limitation.type] = limitation
     end
+
+    def self.symbol
+      name.split(":").last.downcase.to_sym
+    end
   end
 end

data/lib/key_vortex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class KeyVortex
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/key_vortex.rb

@@ -5,6 +5,21 @@ require_relative "key_vortex/version"
 class KeyVortex
   class Error < StandardError; end
 
+  def self.register(adapter_class)
+    @adapter_registry ||= {}
+    @adapter_registry[adapter_class.symbol] = adapter_class
+  end
+
+  def self.vortex(adapter_symbol, record_class, **options)
+    puts @adapter_registry
+    new(
+      @adapter_registry[adapter_symbol].build(**options),
+      record_class
+    )
+  end
+
+  attr_reader :adapter, :record_class
+
   def initialize(adapter, record_class)
     @adapter = adapter
     @record_class = record_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key-vortex
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-14 00:00:00.000000000 Z
 dependencies: []
 description: Defines abstractions that can be built on top of for key/value storage
   on different technologies (file, s3, sql, redis, etc.)