redis-struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60698b761c41da3306c3a7cbf4c5c0b70a743193
+  data.tar.gz: 71db081e8f77f9143992dcaf5d87821fd0fedfb7
+SHA512:
+  metadata.gz: 164b1bf8c7bb4bae8376c16d73d1db1e23788c9221de2807bc66de665825fdd79f1cfe0383724541f91d1316e96aaa295e1260b58dd6074183e643acac121764
+  data.tar.gz: 1c2ee1c445cddfb9d1b903960f7f5cdca5f7722628531c1c9a2f87a89b2bf63864c5b3ab422f2d668da90b9413a67b932119fde237774cd28eaa7f1af4142f45

data/lib/redis-struct.rb

@@ -0,0 +1,228 @@
+
+require 'ostruct'
+require 'redis'
+
+class RedisHash < Hash
+	
+	@fixed = false
+	
+	def config_database(database)
+		@database = database
+	end
+	
+	def config_prefix(prefix)
+		@prefix = prefix
+	end
+	
+	def config_suffix(suffix)
+		@suffix = suffix
+	end
+	
+	# def config_redis_struct(redis_struct)
+	# 	@redis_struct = redis_struct
+	# end
+	
+	def config_hash(hash)
+		@hash = hash
+	end
+	
+	def []=(key,value)
+		@database.set prefix(key), value
+	end
+	
+	def [](key)
+		@database.get prefix(key)
+	end
+	
+	def each_key(&block)
+		keys = @database.keys prefix("*")
+		keys.each do |key|
+			yield unprefix(key)
+		end
+	end
+	
+	def each_pair # (&block) ## I don't think this works.
+		each_key do |key|
+			value = self[key]
+			yield unprefix(key), value
+		end
+	end
+	
+	def dup 
+		self
+	end
+	
+	def to_h
+		hash = {}
+		each_key do |key|
+			hash[key] = self[key]
+		end
+		hash
+	end
+	
+	def prefix(key)
+		"#{@prefix}:#{get_suffix}:#{key}"
+	end
+	
+	def get_suffix
+		@suffix || self.object_id
+	end
+	
+	def unprefix(key)
+		key.sub /^#{@prefix}:#{get_suffix}:/, ''
+	end
+	
+	def prefix_with_id(key)
+		"#{@prefix}:#{self.object_id}:#{key}"
+	end
+	
+	def add_hash
+		@hash.each_pair do |key,value|
+			self[key] = value
+		end
+	end
+	
+	def delete(key)
+		@database.del prefix(key)
+	end
+	#
+	# private
+	#
+	# # An internal method that uses the name of @redis_struct when possible,
+	# # otherwise the RedisHash's object id.
+	# 	def fix
+	# 		begin
+	# 			unless @fixed
+	# 				@fixed = true
+	# 				add_hash
+	# 			end
+	# 			result = @redis_struct.very_old_name
+	# 			# puts 'not rescued'
+	# 		rescue Exception => e
+	# 			p e
+	# 			# puts 'rescued'
+	# 			result = self.object_id
+	# 		end
+	# 		result
+	# 	end
+		
+	
+end
+
+
+class RedisStruct < OpenStruct
+	
+	
+	# This resets unnecessary methods for users'
+	# convenience.
+	
+	# Uncomment these to access old methods
+	
+	# alias :very_old_class :class
+	# alias :very_old_display :display
+	# alias :very_old_clone :clone
+	# alias :very_old_trust :trust
+	# alias :very_old_method :method
+	# alias :very_old_taint :taint
+	
+	undef :taint
+	undef :method
+	undef :trust
+	undef :clone
+	undef :display
+	undef :class
+
+	
+	
+	# An RedisStruct wraps the OpenStruct class, which uses method_missing
+	# to store values in a hash. Instead, RedisStruct stores these values
+	# in Redis, providing a pleasant way of interfacing with $redis.
+	#
+	# #When $redis = Redis.new :host => '0.0.0.0', :port => '6379'
+	# example = RedisStruct.new($redis)
+	# 
+	# example.color = 'blue'
+	# 
+	# example.color  # => 'blue'
+	#
+	# The hash will load any data you want into the RedisStruct, without
+	# having to iterate over it. And the prefix is what's used to 
+	# store in $redis. Good luck!
+	 
+  def initialize(hash=nil, prefix = 'redis_struct', suffix = nil, database)
+    @table = RedisHash.new
+		@table.config_database database
+		@table.config_prefix prefix
+		
+		if suffix
+			@table.config_suffix suffix
+		end
+		
+		# Enables the user to load a hash into the database
+		# Hash will be compiled later - once the RedisStruct's name is known
+		@table.config_hash hash
+		@table.add_hash if hash
+		
+  end
+	
+	def get_redis_hash_object_id
+		@table.object_id
+	end
+	
+	def to_str
+		to_h.to_s
+	end
+	
+	# Rewriting so RedisStruct#to_h doesn't call RedisHash#dup
+	def to_h
+		@table.to_h
+	end
+	
+	def inspect
+		"#<redis-struct : #{to_h}>"
+	end
+	
+end
+
+
+
+
+# Examples
+
+# It's generally better to use an RedisStruct than make
+# a RedisHash directly. RedisHashes are more adapters
+# than anything else.
+#
+#
+#
+# $redis = Redis.new :host => '0.0.0.0', :port => '6379'
+#
+# icecream = RedisHash.new
+# icecream.config_database $redis
+# icecream.config_prefix 'hello'
+# icecream['color'] = 'blue'
+#
+# p icecream['color']
+# puts
+# puts '-------------'
+# puts
+# 
+#
+# 
+# Snowcone = RedisStruct.new({name: 'blue'}, $redis)
+#
+# Snowcone.class = 'hi'
+#
+# p Snowcone.class
+# p Snowcone.name
+#
+# Snowcone.kind = 'sheep'
+# Snowcone.blue = 'animal'
+#
+# p Snowcone.kind
+# p Snowcone.blue
+#
+# p Snowcone.color
+#
+#
+# puts Snowcone.name

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: redis-struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charles Chamberlain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: OpenStructs meet Redis
+email: charles@charlesetc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis-struct.rb
+homepage: https://github.com/Charlesetc/redis-struct#redis-struct
+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.0.5
+signing_key: 
+specification_version: 4
+summary: OpenStructs meet Redis
+test_files: []
+has_rdoc: