key_vortex-stashify 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5820077a118d1e5d9258d6ea8aa4f0da3604806e9f3c73a66f8f2028955fbab
-  data.tar.gz: e49c2e7639f44f80b47f45dc405f7f809ea084175c77cc91b579194864943436
+  metadata.gz: 5b5f3d54cc8d0971c44d0d28a7d7fa809b487d5ae411e4abde547fba15729bf1
+  data.tar.gz: b49c189fed5f2271f80d6dad83d40a123c39cd9c40df9502de09eb7237937fdc
 SHA512:
-  metadata.gz: 60c61f2acc27fbe2bd81250ca9260e46a49fe7c24a9cdf85557b461563f02ba1d8fd18c8931f14ca8ce55912ddf84ab1dad80ccb16b40d0641739dc1764efaeb
-  data.tar.gz: 36ae0eebbd3d7483cfcb697502b57330d327161c2d2f4578bcf5d10ba97453ed2e43f52ca2b534d7ac699bca06a5fff5483eeb2166fbcf0917e875c779a2248a
+  metadata.gz: 8e6712fa9691e942bf0fa21201389d5d9dd014f25ad3e5844bfee322fe3efb132b9d82da1c4f0a5619e44ef8087360f142db829b11dba1d242f0f08a8895e471
+  data.tar.gz: 5b973b8b2719fb6034ea5e9e81d4e2825944435908c47b46ed4ac4a5d9841abed840d2acdf487f763145f58dea6f0ecf18682402f1dbb42e8786ca5496e05bf0

data/.rubocop.yml

@@ -12,7 +12,3 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
-
-# TODO: Remove once design is set
-Style/Documentation:
-  Enabled: false

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    key_vortex-stashify (0.2.4)
-      key-vortex (~> 0.2.4)
+    key_vortex-stashify (1.0.0)
+      key-vortex (~> 1.0.0)
       stashify (~> 3.2.1)
 
 GEM
@@ -35,8 +35,8 @@ GEM
       guard (~> 2.0)
       rubocop (< 2.0)
     json (2.6.3)
-    key-vortex (0.2.4)
-    key_vortex-contract (0.2.4)
+    key-vortex (1.0.0)
+    key_vortex-contract (1.0.0)
       rantly (~> 2.0.0)
       rspec (~> 3.0)
     kwalify (0.7.2)

data/README.md

@@ -1,8 +1,6 @@
 # KeyVortex::Stashify
 
-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/stashify`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an implementation of an adapter for [KeyVortex](https://github.com/lambda-Null/key-vortex/) allowing use of any file storage provider via [Stashify](https://github.com/Lambda-Null/stashify).
 
 ## Installation
 
@@ -22,7 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "key_vortex/adapter/stashify"
+require "stashify/directory/local"
+require "key_vortex/record"
+
+class ExampleRecord < KeyVortex::Record
+  field :a, String, length: 100
+end
+
+> vortex = KeyVortex.vortex(:stashify, ExampleRecord, stashify: Stashify::Directory::Local.new(path: "/tmp/demo"))
+=>
+#<KeyVortex:0x0000557c90244b88
+> vortex.save(ExampleRecord.new(key: "foo", a: "bar"))
+> vortex.find("foo")
+=> #<ExampleRecord:0x0000557c90ff5868 @values={:key=>"foo", :a=>"bar"}>
+> vortex.remove("foo")
+> vortex.find("foo")
+=> nil
+```
 
 ## Development
 

data/key_vortex-stashify.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "key-vortex", "~> 0.2.4"
+  spec.add_dependency "key-vortex", "~> 1.0.0"
   spec.add_dependency "stashify", "~> 3.2.1"
 
   # For more information and examples about making a new gem, checkout our

data/lib/key_vortex/adapter/stashify.rb

@@ -8,16 +8,28 @@ require "stashify/file"
 
 class KeyVortex
   class Adapter
+    # Implements a {https://rubydoc.info/gems/key-vortex/KeyVortex/Adapter KeyVortex Adapter}
+    # for {https://rubydoc.info/gems/stashify/Stashify/Directory Stashify Directories}.
+    # Sometimes file storage is all that's needed, going fancier just
+    # isn't necessary. By supporting Stashify's API, development can be
+    # done against local storage, but production systems can use the
+    # Blob storage for whatever provider makes the most sense.
     class Stashify < KeyVortex::Adapter
+      # @param stashify [Stashify::Directory] The Stashify Directory which should be used
+      # @return [KeyVortex::Adapter::Stashify]
       def self.build(stashify:)
         new(stashify)
       end
 
+      # @param stashify [Stashify::Directory] The Stashify Directory which should be used
       def initialize(stashify)
         super()
         @stashify = stashify
       end
 
+      # Write a record to the directory with the filename record.key
+      # and a json version of the record as its contents.
+      # @param record [KeyVortex::Record] The record to be saved
       def save(record)
         @stashify.write(
           ::Stashify::File.new(
@@ -27,12 +39,19 @@ class KeyVortex
         )
       end
 
+      # Load the file with filename key, assuming that the contents of
+      # the file are a json version of the record.
+      # @param key [String]
+      # @return [KeyVortex::Record]
+      # @return [nil] if the file does not exist
       def find(key)
         return unless @stashify.exists?(key)
 
         JSON.parse(@stashify.find(key).contents, create_additions: true)
       end
 
+      # Delete the file with filename key
+      # @param key [String]
       def remove(key)
         @stashify.delete(key)
       end

data/lib/key_vortex/stashify/version.rb

@@ -2,6 +2,6 @@
 
 class KeyVortex
   class Stashify
-    VERSION = "0.2.4"
+    VERSION = "1.0.0"
   end
 end

data/lib/key_vortex/stashify.rb

@@ -1,10 +1,3 @@
 # frozen_string_literal: true
 
 require_relative "stashify/version"
-
-class KeyVortex
-  class Stashify
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key_vortex-stashify
 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: key-vortex
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: stashify
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +46,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md

data/.reek.yml

@@ -1,4 +0,0 @@
-detectors:
-  # TODO: Remove once design is set
-  IrresponsibleModule:
-    enabled: false