valkey-objects 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bff1543f882229f211fa61e3c86b372c9a1aa2847db1775d53a3d97e1dfdc74
-  data.tar.gz: af2d8421208fae7af41d748ffa3e8cab093fc6d61898f395daff15ab84d50dd2
+  metadata.gz: d49af322f308f1198814c35b6ebf232f6ef1d74c1b463e86266fa1b615732fd4
+  data.tar.gz: d103edca7b0a92a4658677e233142df4f5a9e976d3ee52cfd3bfa57093088b0a
 SHA512:
-  metadata.gz: 53b7f59cb71b020cac52cd6ccc72127520001d79a5368a3e706a22089db28aaa0b75d62f0eaaba44cb105cb92b2628ed26e3353d2e58f4dd43559d12688a2d8c
-  data.tar.gz: 84c030763ee5c46698b9ea80f9b4bcd1f889aca82af932a88f0714507bf2f67b9790bcafd2f07b67537371b9a0d35b4ba222d3ab856630fa6e51e9d10a7b2e54
+  metadata.gz: 43ad7391f93e204795c2a9151250396e332b8dd042361146ee54d30868c083ec687b49e5a2e0f50d88b14a6f58dc3b87d9505449a98665eed9da40ba0c2ec572
+  data.tar.gz: 34cf2362b197da87609c64183e9dbbc8f345d3441373cec4836c82029ee8fffe8a0bf054729a23654b40bd1ced3948f96b8bcefd98903fdfff99c5ec031a5752

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-10-18
+## [0.1.0] - 2025-11-18
 
 - Initial release

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at xorgnak@xorgnak.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in valkey-objects.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    valkey-objects (0.4.9)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.5.4)
+    rake (13.0.6)
+    redis (5.4.1)
+      redis-client (>= 0.22.0)
+    redis-client (0.25.1)
+      connection_pool
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  valkey-objects!
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 TODO: Write your name
+Copyright (c) 2025 Erik Olson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,97 +1,50 @@
-# ValKey Objects
-Based upon the redis-objects library, VK allows for ValKey backed ruby objects.
+## Installation
 
-## installation
-```
-gem install valkey-objects
-```
+Install the gem and add to the application's Gemfile by executing:
 
-## usage
+    $ bundle add valkey-objects
 
-### simple
-```
-require 'valkey/objects'
-class ValKey
-  # 1. include valkey-objects layer
-  include VK
-  # 2. stitch your object together.
-  value :myvalue
-  counter :mycounter
-  hashkey :myhash
-  sortedset :mysortedset
-  set :myset
-  queue :myqueue
-  place :myplace
-  pipe :mypipe
-  toggle :mytoggle
-  # 3. define @id in initialize.
-  def initialize k
-    @id = k
-  end
-  # other stuff...
-end
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-@x = ValKey.new("My Special Valkey object.")
-@x.mypipe.on { |msg| puts %[MSG]; ap msg }
-@x.mypipe << "Pipe Connected!"
-@x.myvalue.value = "Hello, World"
-@x.mycounter.value = 1.2345
-@x.myhash[:key] = "Value"
-@x.mysortedset["my other key"] = 9.8
-@x.mysortedset.poke "my key", @x.mysortedset["my other key"]
-@x.mysortedset.value { |i, e| puts %[Sorted Sets: i: #{i} e: #{e}] }
-@x.myset << "my member"
-@x.myset << "my new member"
-h = @x.myset[/ new /]
-@x.myset.value { |i, e| puts %[Sets: i: #{i} e: #{e}] }
-@x.myplace.add "Palermo", 13.361389, 38.115556
-@x.myplace.add "Catania", 15.087269, 37.502669
-distance = @x.myplace.distance "Palermo", "Catania"
-places = @x.myplace.radius 15.087269, 37.502669, 5000
-@x.myplace.value { |i, e| puts %[Places: i: #{i} e: #{e}] }
-```
+    $ gem install valkey-objects
 
-### advanced
-```
-class Game
-  include VK
-  sortedset :points
-  def initialize k
-    @id = k
-  end
-  def score p, h={ points: 1 }
-    self.points.poke p, h[:points]
-  end
-end
-
-@game = Hash.new { |h,k| h[k] = Game.new(k) }
-```
+## Usage
 
-### modular
-```
-module X
-  @@X = Hash.new { |h,k| h[k] = Ex.new(k) }
-  class Ex
-    include VK
-    set :stuff
-    pipe :ear
-    def initialize k
-      @id = k
-    end
-  end
-  def self.keys
-    @@X.keys
-  end
-  def self.[] k
-    if !@@X.has_key?(k)
-      @@X[k].ear.on { |msg| puts "MSG[#{k}]:"; ap msg }
-    end
-    @@X[k]
-  end
+```ruby
+class X
+  include ValkeyObjects
+  value :myValue
+  counter :myCounter
+  list :myList
+  set :mySet
+  hash_key :myHash
+  sorted_set :mySortedSet
 end
 
-X['Aaa'].ear << %[A]
-X['Bbb'].ear << %[B]
-X['Ccc'].ear << %[C]
-
+@user = X.new
+@user.myValue.value = "Alice"
+@user.myValue.value #=> "Alice"
+
+@user.myCounter.increment
+@user.myCounter.decrement
+@user.myCounter.increment 1
+@user.myCounter.decrement 2
+@user.myCounter.to_i #=> -1
+
+@user.myList << "item"
+@user.myList << "this"
+@user.myList[1] #=> "this"
+@user.myList[1] = "next"
+@user.myList.shift
+@user.myList.to_a #=> ["next"]
+@user.myList.knn #=> values as KNN object
+
+@user.mySet << "one"
+@user.mySet << "two"
+@user.mySet.members
+@user.mySet.knn #=> members as KNN object
+
+@user.myHash[:key] = "value"
+@user.myHash[:key] #=> "value"
+@user.myHash.to_h
 ```

data/lib/valkey/objects/version.rb

@@ -2,6 +2,6 @@
 
 module Valkey
   module Objects
-    VERSION = "0.4.8"
+    VERSION = "0.5.0"
   end
 end