redis-hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aed98af107edcc4945a66ad7cfedc3b068ce1ee4
+  data.tar.gz: afaaeb9760728471e5fb052f87ba31c8d9a62049
+SHA512:
+  metadata.gz: dcf3f11332840f8a78887831f4861e3fe49afc259090c4a0e9982477eb46087f4b24d329958bf69cb30595c85a7fbd616031f56028723255081d2a49959b0c9f
+  data.tar.gz: 852e42e4efb1c20fcb46f43923e6afaf5834fa591443499a95e6107016cf4dbe02908a4eba277b2e87b438c265775f77497019121ba0ec8e8058762c3208686a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redis-hash.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    redis-hash (0.0.1)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  redis-hash!
+  rspec
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Misha Conway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# RedisHash
+
+Lightweight wrapper over redis hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-hash
+
+## Getting started
+
+```ruby
+h = RedisHash.new 'completed_customer_ids'
+```
+
+Or you can pass in your own instance of the Redis class.
+
+```ruby
+h = RedisHash.new 'completed_customer_ids', Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+```
+
+A third option is to instead pass your Redis configurations.
+
+```ruby
+h = RedisHash.new 'completed_customer_ids', :host => "10.0.1.1", :port => 6380, :db => 15
+```
+
+## Using the hash
+
+You can add data to the hash using the set method.
+
+```ruby
+# setting a single item
+h.set {"hello" => "world"}
+
+# setting multiple items
+h.add {"hello" => "world", "goodbye" => "universe"}
+```
+
+You can read data from the hash with the get method
+
+```ruby
+# reading a single key
+h.get "hello"
+
+# reading multiple keys
+h.get "hello", "goodbye"
+```
+
+You can remove keys from the hash with the remove method
+```ruby
+# removing a single key
+h.remove "hello"  
+
+# removing multiple keys
+h.remove "hello", "goodbye" 
+
+```
+
+
+You can get the size of the hash.
+
+```ruby
+h.size
+```
+
+You can see if a key exists in the hash.
+
+```ruby
+h.include? "hello"
+```
+
+You can get all items in the hash.
+
+```ruby
+h.all
+```
+
+You can get all keys in the hash.
+
+```ruby
+h.keys
+```
+
+You can get all values in the hash.
+
+```ruby
+h.values
+```
+
+The hash can be cleared of all items
+```ruby
+h.clear
+```
+
+The hash can also be hash to expire (in seconds).
+```ruby
+# expire in five minutes
+h.expire 60*5
+```
+
+You can enumerate the hash in batches.
+```ruby
+#enumerate through the hash in batches of 100 items per redis op
+h.enumerator(100).each{ |i| puts i } 

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/hash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis/hash.rb

@@ -0,0 +1,118 @@
+require "redis"
+
+class RedisHash
+	attr_reader :name
+
+	VERSION = "0.0.1"
+
+	class InvalidNameException < StandardError; end;
+	class InvalidRedisConfigException < StandardError; end;
+
+	def initialize(name, redis_or_options = {})
+		name = name.to_s if name.kind_of? Symbol
+
+		raise InvalidNameException.new unless name.kind_of?(String) && name.size > 0
+		@name = name
+		@redis = if redis_or_options.kind_of? Redis
+			         redis_or_options
+			       elsif redis_or_options.kind_of? Hash
+				       ::Redis.new redis_or_options
+			       else
+				       raise InvalidRedisConfigException.new
+		         end
+	end
+
+	def get *keys
+		keys = keys.flatten
+		if keys.size > 0
+			values = if 1 == keys.size
+				         @redis.hget name, keys.first
+				       else
+					       @redis.hmget name, *keys
+			         end
+
+			keys.each_with_index.map do |k,i|
+				[k, values[i]]
+			end.to_h
+		end
+	end
+
+	def set hash
+		if hash.size > 0
+			if 1 == hash.size
+				@redis.hset name, hash.keys.first, hash.values.first
+			else
+				@redis.hmset name, *(hash.map { |k, v| [k, v] }.flatten)
+			end
+		end
+	end
+
+	def set_if_does_not_exist key, value
+		@redis.hsetnx(name, key, value)
+	end
+
+	def increment_integer_key key, increment_amount
+		@redis.hincrby(name, key, increment_amount)
+	end
+
+	def increment_float_key key, increment_amount
+		@redis.hincrbyfloat(name, key, increment_amount)
+	end
+
+	def remove *keys
+		keys = keys.flatten
+		if keys.size > 0
+			@redis.hdel name, *keys
+		end
+	end
+
+	def all
+		@redis.hgetall name
+	end
+
+	def keys
+		@redis.hkeys name
+	end
+
+	def values
+		@redis.hvals name
+	end
+
+	def include? key
+		@redis.hexists(name, key)
+	end
+
+	def size
+		@redis.hlen name
+	end
+
+	alias count size
+
+	def scan cursor = 0, amount = 10, match = "*"
+		@redis.hscan name, cursor, :count => amount, :match => match
+	end
+
+	def enumerator(slice_size = 10)
+		cursor = 0
+		Enumerator.new do |yielder|
+			loop do
+				cursor, items = scan cursor, slice_size
+				items.each do |item|
+					yielder << {item.first => item.last}
+				end
+				raise StopIteration if cursor.to_i.zero?
+			end
+		end
+	end
+
+	def clear
+		@redis.del name
+		{}
+	end
+
+	alias flush clear
+
+	def expire seconds
+		@redis.expire name, seconds
+	end
+end

data/redis-hash.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis/hash"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-hash"
+  spec.version       = RedisHash::VERSION
+  spec.authors       = ["Misha Conway"]
+  spec.email         = ["mishaAconway@gmail.com"]
+
+  spec.summary       = %q{Lightweight wrapper over redis hashes.}
+  spec.description   = %q{Lightweight wrapper over redis hashes.}
+  spec.homepage      = "https://github.com/MishaConway/ruby-redis-hash"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency 'redis'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: redis-hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Misha Conway
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight wrapper over redis hashes.
+email:
+- mishaAconway@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis/hash.rb
+- redis-hash.gemspec
+homepage: https://github.com/MishaConway/ruby-redis-hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Lightweight wrapper over redis hashes.
+test_files: []