key-vortex 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f43cf073bdd351c00643d8efadeca2cb832cba972ca21fdeb2cd8e7f96e0b305
-  data.tar.gz: 121850a5e65071c2b1b7d88a00768c2768c815c94b9bde9adacaf86468b78b35
+  metadata.gz: 5f5d707741ec015d0e2b2550267246b8d59ba9adf324cdbfd2502a81aedecfa1
+  data.tar.gz: f852c54e10c99863649639ab7974e81a93dc91403969d9cfaabd35ff068bdc67
 SHA512:
-  metadata.gz: f3674b7796e65a5cc6f01a0b51c53a960fc52d4502438cf184b5cbd977b234a68b404225545f5d4dac8b2ca64acffe396556fc6a2ef96e3741ee329b0b88461a
-  data.tar.gz: 51505756b9515790e6b8a5071ceb6fc2db46ab6890e6a22118e6dccd2e28b44bd4876ca7317f6ab08ed4c6ad6884f2ac6cdab3098c283006ab3bfa58ff6da50a
+  metadata.gz: c2d55b7eadf96acaacab4e9b81b52042c5809716d3536a76768c387f72353190a3ba15c38aded87b7ab6af357f0e8402fb8a8169b7f08271ca1e7ead84cae6f5
+  data.tar.gz: b8e30dca290040a2030b4d0b0583a5c63ee4087207635e584f116a716be472953bdc442e4be5270cd4614b5eba2021fbd9c011359f3b952e860815985bf1adb5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    key-vortex (0.2.1)
+    key-vortex (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -33,8 +33,11 @@ GEM
       guard (~> 2.0)
       rubocop (< 2.0)
     json (2.6.3)
-    key_vortex-contract (0.2.0)
+    key_vortex-contract (0.2.3)
+      rantly (~> 2.0.0)
+      rspec (~> 3.0)
     kwalify (0.7.2)
+    language_server-protocol (3.17.0.3)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -44,14 +47,17 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rantly (2.0.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -59,32 +65,33 @@ GEM
       kwalify (~> 0.7.0)
       parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.49.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     shellany (0.0.1)

data/README.md

@@ -1,5 +1,37 @@
 # 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.
+
+
+
 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.downcase
+    end
   end
 end

data/lib/key_vortex/field.rb

@@ -25,5 +25,9 @@ class KeyVortex
     def accepts?(value)
       limitation.accepts?(value)
     end
+
+    def enable_json_additions
+      @limitation.enable_json_additions
+    end
   end
 end

data/lib/key_vortex/limitation.rb

@@ -27,9 +27,9 @@ class KeyVortex
     end
 
     def encompasses_constraint?(constraint)
-      !applicable_constraints(constraint).select do |con|
+      applicable_constraints(constraint).any? do |con|
         con.within?(constraint)
-      end.empty?
+      end
     end
 
     def within?(limitation)
@@ -39,9 +39,9 @@ class KeyVortex
     end
 
     def within_constraint?(constraint)
-      !applicable_constraints(constraint).select do |con|
+      applicable_constraints(constraint).any? do |con|
         con.within?(constraint)
-      end.empty?
+      end
     end
 
     def applicable_constraints(constraint)
@@ -54,6 +54,27 @@ class KeyVortex
       value.is_a?(type) && @constraints.all? { |constraint| constraint.accepts?(value) }
     end
 
+    JSON_ADDITIONS = {
+      BigDecimal: "json/add/bigdecimal",
+      Complex: "json/add/complex",
+      Date: "json/add/date",
+      DateTime: "json/add/date_time",
+      Exception: "json/add/exception",
+      OpenStruct: "json/add/ostruct",
+      Range: "json/add/range",
+      Rational: "json/add/rational",
+      Regexp: "json/add/regexp",
+      Set: "json/add/set",
+      Struct: "json/add/struct",
+      Symbol: "json/add/symbol",
+      Time: "json/add/time"
+    }.freeze
+
+    def enable_json_additions
+      path = JSON_ADDITIONS[@type.class.name]
+      require path if path
+    end
+
     def to_s
       "Limitation: #{@type}\n\t#{@constraints.join('\n\t')}"
     end

data/lib/key_vortex/record.rb

@@ -25,6 +25,7 @@ class KeyVortex
 
     def self.register_field(field)
       field_hash[field.name] = field
+      field.enable_json_additions
       define_getter(field)
       define_setter(field)
     end
@@ -63,5 +64,16 @@ class KeyVortex
     def ==(other)
       self.class == other.class && values == other.values
     end
+
+    def to_json(*args)
+      {
+        JSON.create_id => self.class.name,
+        "values" => @values
+      }.to_json(*args)
+    end
+
+    def self.json_create(object)
+      new(object["values"])
+    end
   end
 end

data/lib/key_vortex/version.rb

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

data/lib/key_vortex.rb

@@ -5,6 +5,20 @@ 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)
+    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.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-07-13 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.)