key_vortex-contract 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 543e93a3027dedfe80e8907b3532016d59d654cc9a0c88997b12229e5271c092
-  data.tar.gz: 0f37a24926f35974aa1c7f29e760abf1325f25c30a9379aa67a056d2134fd35d
+  metadata.gz: 1469f469f1d5844fd358ee02cf0170adcb2524a205df9ceacc37ada6ca96ef36
+  data.tar.gz: ca7dc3ebbc34889aef1ff62bd4a9a441da4a7de58c3312a9f0ec8eb6e3fbde72
 SHA512:
-  metadata.gz: 8f3ef0ca6c385fc527bba5215b4ff78a1dc29be0534d214b3596589f591e9180d4bddc30f86acd77d2f5f506bd96a874c85efbe623fbd8a126e43b2c531e78c5
-  data.tar.gz: 98cdf06193c38aef67c602a218d7bec104c2823d6f37cb37ce99825086d7047b9cb8f04ec0fc29984fa913f2b5c268a76bed27b9b7b55cc1ab0ba98cf6fb27f9
+  metadata.gz: e7cf2d061a0301a195b194f0ecfdd1c41740d4faf7ccf676980b3bed7f8f30e61e8dd84881847490ea5cc6bab18bf02c48da2263e3f131da43778a291605d0e2
+  data.tar.gz: d6fe973d5d2bce29034b88e142c1e7fd609b1f93ada2ec62d751a0ae07e9e827583f2b11c48bc526c6e41f8de4f1bdd3a45317c2ff2dc04299341c1aec7a1b67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    key_vortex-contract (0.2.4)
+    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.4"
+    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.4
+  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