key_vortex-contract 0.2.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cb2953b918193e1e011d64dc301c1abe6c1e114b8c49e4a198ff1d435786ff2
-  data.tar.gz: 065411af7e6a7f429073e0938bddc25f5205753796a0e71b4a808744b121f37b
+  metadata.gz: 1469f469f1d5844fd358ee02cf0170adcb2524a205df9ceacc37ada6ca96ef36
+  data.tar.gz: ca7dc3ebbc34889aef1ff62bd4a9a441da4a7de58c3312a9f0ec8eb6e3fbde72
 SHA512:
-  metadata.gz: 5c8cb9f799ad3fb2129a74d434a28e3d52ce32a223f6ed7a6c64f758935d7d1ff5e8e0de3a6969e283c0989d766d7bceb66b6dde602f19769dba124dd542ab1a
-  data.tar.gz: 9642cb39fbd27b5d57ef118082a813ef9b8fdff474fedd061634f0c4bdb924a280e28dc7498062696bb10bdb42f2439ebef6972782d93642e0b0edb1a3e6fab6
+  metadata.gz: e7cf2d061a0301a195b194f0ecfdd1c41740d4faf7ccf676980b3bed7f8f30e61e8dd84881847490ea5cc6bab18bf02c48da2263e3f131da43778a291605d0e2
+  data.tar.gz: d6fe973d5d2bce29034b88e142c1e7fd609b1f93ada2ec62d751a0ae07e9e827583f2b11c48bc526c6e41f8de4f1bdd3a45317c2ff2dc04299341c1aec7a1b67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    key_vortex-contract (0.2.5)
+    key_vortex-contract (1.0.0)
       rantly (~> 2.0.0)
       rspec (~> 3.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # KeyVortex::Contract
 
-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/contract`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Adapters built for [KeyVortex](https://github.com/lambda-Null/key-vortex/) must conform to a common set of behaviors in order to play nicely together. This gem provides [shared examples](https://rubydoc.info/gems/key_vortex-contract/KeyVortex/Contract) that can be included in your tests to verify that you support these behaviors.
 
 ## Installation
 
@@ -22,7 +20,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Within the RSpec tests for your adapter subclass, you can include the contract like this:
+
+```ruby
+require "key_vortex/constract"
+
+RSpec.describe KeyVortex::Adapter::SomethingAwesome do
+  subject { KeyVortex::Adapter::SomethingAwesome.new() }
+  it_behaves_like "an adapter"
+end
+```
 
 ## Development
 

data/lib/key_vortex/contract/version.rb

@@ -1,7 +1,23 @@
 # frozen_string_literal: true
 
 module KeyVortex
+  # NOTE: yard isn't going to document a shared example, so adding it here.
+
+  # KeyVortex will assume that adapters behave in certain ways, which
+  # are documented here. You can also include shared examples provided
+  # by this gem to ensure that it conforms to those behaviors.
+  #
+  # In order to use KeyVortex.vortex, it must register the class by
+  # calling KeyVortex.register.
+  #
+  # If #save is called, #find must be able to retrieve the record
+  # using the #key afterwards.
+  #
+  # If #remove is called, #find must return nil on the key afterward.
+  #
+  # if #save is called on a record, subsequent calls to #find must
+  # return the same class that was saved.
   module Contract
-    VERSION = "0.2.5"
+    VERSION = "1.0.0"
   end
 end

data/lib/key_vortex/contract.rb

@@ -13,7 +13,7 @@ end
 
 require "rantly/rspec_extensions"
 
-RSpec.shared_context "an adapter" do |build_args = {}|
+RSpec.shared_examples "an adapter" do |build_args = {}|
   around(:each) do |s|
     property_of { string }.check(100) do |sample|
       @sample = sample

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key_vortex-contract
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rantly