redis_object 1.1 → 1.2

data/README.markdown

@@ -3,6 +3,7 @@ RedisObject is a fast and simple-to-use object persistence layer for Ruby.
 
 [![Build Status](https://travis-ci.org/remotezygote/RedisObject.png?branch=master)](https://travis-ci.org/remotezygote/RedisObject)
 [![Coverage Status](https://coveralls.io/repos/remotezygote/RedisObject/badge.png?branch=master)](https://coveralls.io/r/remotezygote/RedisObject?branch=master)
+[![Code Climate](https://codeclimate.com/github/remotezygote/RedisObject.png)](https://codeclimate.com/github/remotezygote/RedisObject)
 
 ## Prerequisites
 You'll need [Redis](http://redis.io). Other storage adapters are in the works. Maybe.

data/lib/redis_object/base.rb

@@ -72,7 +72,9 @@ module Seabright
 		
 		def get(k)
 			cached_hash_values[k.to_s] ||= Proc.new {|key|
-				if v = store.hget(hkey, key.to_s)
+				if is_ref_key?(k) && (v = get_reference(store.hget(hkey, key.to_s)))
+					define_setter_getter(key)
+				elsif v = store.hget(hkey, key.to_s)
 					define_setter_getter(key)
 				end
 				v
@@ -111,12 +113,40 @@ module Seabright
 		end
 		
 		def set(k,v)
+			return set_ref(k,v) if v.is_a?(RedisObject)
 			store.hset(hkey, k.to_s, v.to_s)
 			cached_hash_values[k.to_s] = v
 			define_setter_getter(k)
 			v
 		end
 		
+		def set_ref(k,v)
+			return unless v.is_a?(RedisObject)
+			track_ref_key(k)
+			store.hset(hkey, k.to_s, v.hkey)
+			cached_hash_values[k.to_s] = v
+			define_setter_getter(k)
+			v
+		end
+		
+		def track_ref_key(k)
+			store.sadd(ref_field_key, k.to_s)
+		end
+		
+		def is_ref_key?(k)
+			if store.sismember(ref_field_key,k.to_s)
+				return true
+			end
+			false
+		end
+		
+		def get_reference(hkey)
+			if o = RedisObject.find_by_key(hkey)
+				return o
+			end
+			nil
+		end
+		
 		def setnx(k,v)
 			if success = store.hsetnx(hkey, k.to_s, v.to_s)
 				cached_hash_values[k.to_s] = v

data/lib/redis_object/ext/script_cache.rb

@@ -60,7 +60,7 @@ module Seabright
 			end
 			
 			def untrack_script(name)
-				ScriptSHAMap.delete name
+				$ScriptSHAMap.delete name
 				(@tmp_store || store).del(script_sha_key(name))
 			end
 			
@@ -75,6 +75,7 @@ module Seabright
 				store_obj.keys(script_sha_key("*")).each do |k|
 					store_obj.del k
 				end
+				$ScriptSHAMap = {}
 			end
 			
 			def script_sha_key(name)

data/lib/redis_object/ext/triggers.rb

@@ -11,40 +11,32 @@ module Seabright
 			def intercept_sets_for_triggers!
 				return if @intercepted_sets_for_triggers
 				self.class_eval do
-					alias_method :untriggered_set, :set unless method_defined?(:untriggered_set)
-					def set(k,v)
-						untriggered_set(k,v)
-						unless self.class.untriggerables.include?(k)
-							begin
-								self.class.untriggerables << k
-								if self.class.field_triggers[k.to_sym]
-									send(self.class.field_triggers[k.to_sym],k,v)
-								end
-								self.class.update_triggers.each do |actn|
-									send(actn.to_sym,k,v)
-								end
-							ensure
-								self.class.untriggerables.delete k
+					
+					def triggered_set(cmd,k,v)
+						ret = send("untriggered_#{cmd}".to_sym,k,v)
+						return ret if self.class.untriggerables.include?(k)
+						begin
+							self.class.untriggerables << k
+							if self.class.field_triggers[k.to_sym]
+								send(self.class.field_triggers[k.to_sym],k,v)
+							end
+							self.class.update_triggers.each do |actn|
+								send(actn.to_sym,k,v)
 							end
+						ensure
+							self.class.untriggerables.delete k
 						end
+						ret
 					end
+					
+					alias_method :untriggered_set, :set unless method_defined?(:untriggered_set)
+					def set(k,v)
+						triggered_set(:set,k,v)
+					end
+					
 					alias_method :untriggered_setnx, :setnx unless method_defined?(:untriggered_setnx)
 					def setnx(k,v)
-						ret = untriggered_setnx(k,v)
-						unless self.class.untriggerables.include?(k)
-							begin
-								self.class.untriggerables << k
-								if self.class.field_triggers[k.to_sym]
-									send(self.class.field_triggers[k.to_sym],k,v)
-								end
-								self.class.update_triggers.each do |actn|
-									send(actn.to_sym,k,v)
-								end
-							ensure
-								self.class.untriggerables.delete k
-							end
-						end
-						ret
+						triggered_set(:setnx,k,v)
 					end
 					
 				end

data/lib/redis_object/keys.rb

@@ -13,6 +13,10 @@ module Seabright
 			"#{key}_h"
 		end
 		
+		def ref_field_key(ident = nil)
+			"#{key}_ref_fields"
+		end
+		
 		module ClassMethods
 			
 			def key(ident=nil)
@@ -27,6 +31,10 @@ module Seabright
 				"#{key(ident)}_h"
 			end
 			
+			def ref_field_key(ident = nil)
+				"#{key(ident)}_ref_fields"
+			end
+			
 		end
 		
 		def self.included(base)

data/lib/redis_object/types.rb

@@ -1,127 +1,87 @@
 module Seabright
 	module Types
 		
-		def enforce_format(k,v)
-			if v && fmt = self.class.field_formats[k.to_sym] 
-				send(fmt,v)
-			else 
-				v
-			end
-		end
-		
-		def score_format(k,v)
-			if v && fmt = self.class.score_formats[k.to_sym] 
-				send(fmt,v)
-			else 
-				0
-			end
-		end
-		
-		def save_format(k,v)
-			v && (fmt = self.class.save_formats[k.to_s.gsub(/\=$/,'').to_sym]) ? send(fmt,v) : v
-		end
-		
-		def format_date(val)
-			begin
-				val.is_a?(DateTime) || val.is_a?(Date) || val.is_a?(Time) ? val : ( val.is_a?(String) ? DateTime.parse(val) : nil )
-			rescue StandardError => e
-				puts "Could not parse value as date using Date.parse. Returning nil instead. Value: #{val.inspect}\nError: #{e.inspect}" if DEBUG
-				nil
-			end
-		end
-		
-		def score_date(val)
-			val.to_time.to_i
-		end
-		
-		def format_array(val)
-			Yajl::Parser.new(:symbolize_keys => true).parse(val)
-		end
-		
-		def save_array(val)
-			Yajl::Encoder.encode(val)
+		def self.alias_type(als,sym)
+			type_aliases[als.to_s.downcase.to_sym] = sym.to_s.downcase.to_sym
 		end
 		
-		def format_number(val)
-			val.to_i
+		def self.type_aliases
+			@type_aliases ||= {}
 		end
 		
-		def score_number(val)
-			Float(val)
+		def self.register_type(sym)
+			known_types << sym.to_s.downcase.to_sym
 		end
 		
-		def format_float(val)
-			Float(val)
+		def self.known_types
+			@known_types ||= []
 		end
-		alias_method :score_float, :format_float
 		
-		def format_json(val)
-			Yajl::Parser.new(:symbolize_keys => true).parse(val)
-		end
-		
-		def save_json(val)
-			Yajl::Encoder.encode(val)
+		def type_filter_for(prefix,k)
+			if (fmt = self.class.field_formats[k.to_sym]) && (sym = "#{prefix}_#{fmt}".to_sym) && respond_to?(sym)
+				return sym
+			end
+			nil
 		end
 		
-		def format_boolean(val)
-			val=="true"
+		def enforce_format(k,v)
+			if sym = type_filter_for(:format,k)
+				return send(sym,v)
+			end
+			v
 		end
 		
-		def save_boolean(val)
-			val === true ? "true" : "false"
+		def score_format(k,v)
+			if sym = type_filter_for(:score,k)
+				return send(sym,v)
+			end
+			0
 		end
 		
-		def score_boolean(val)
-			val ? 1 : 0
+		def save_format(k,v)
+			if sym = type_filter_for(:save,k)
+				return send(sym,v)
+			end
+			v
 		end
 		
 		module ClassMethods
 			
-			def date(k)
-				set_field_format(k, :format_date)
-				set_score_format(k, :score_date)
-			end
-			
-			def number(k)
-				set_field_format(k, :format_number)
-				set_score_format(k, :score_number)
-			end
-			alias_method :int, :number
-			
-			def float(k)
-				set_field_format(k, :format_float)
-				set_score_format(k, :score_float)
-			end
-			
-			def bool(k)
-				set_field_format(k, :format_boolean)
-				set_score_format(k, :score_boolean)
-				set_save_format(k, :save_boolean)
-			end
-			alias_method :boolean, :bool
-			
-			def array(k)
-				set_field_format(k, :format_array)
-				set_save_format(k, :save_array)
+			def method_missing(sym,*args,&block)
+				if als = Types.type_aliases[sym]
+					org = sym
+					sym = als
+				end
+				if Types.known_types.include?(sym)
+					register_type(sym,org)
+					send(sym,*args,&block)
+				else
+					super(sym,*args,&block)
+				end
 			end
 			
-			def json(k)
-				set_field_format(k, :format_json)
-				set_save_format(k, :save_json)
+			def register_type(sym,als=nil)
+				sym = sym.to_sym
+				return if self.respond_to?(sym)
+				self.send(:include,Types.const_get("#{sym.to_s.capitalize}Type".to_sym))
+				metaclass = class << self; self; end
+				metaclass.class_eval do
+					define_method(sym) do |k|
+						set_field_format k, sym
+					end
+					if als
+						als = als.to_sym
+						define_method(als) do |k|
+							set_field_format k, sym
+						end
+					end
+				end
 			end
 			
 			def field_formats
 				@field_formats_hash ||= (defined?(superclass.field_formats) ? superclass.field_formats.clone : {})
 			end
 			
-			def score_formats
-				@score_formats_hash ||= (defined?(superclass.score_formats) ? superclass.score_formats.clone : {})
-			end
-			
-			def save_formats
-				@save_formats_hash ||= (defined?(superclass.save_formats) ? superclass.save_formats.clone : {})
-			end
-			
 			def set_field_format(k, v)
 				field_formats_set_locally.add(k)
 				field_formats[k] = v
@@ -147,56 +107,6 @@ module Seabright
 				end
 			end
 			
-			def set_score_format(k, v)
-				score_formats_set_locally.add(k)
-				score_formats[k] = v
-				update_child_class_score_formats(k, v)
-				intercept_for_typing!
-			end
-			
-			def score_formats_set_locally
-				@score_formats_set_locally_set ||= Set.new
-			end
-			
-			def inherit_score_format(k, v)
-				unless scores_formats_set_locally.include? k
-					score_formats[k] = v
-					update_child_class_score_formats(k, v)
-				end
-				intercept_for_typing!
-			end
-			
-			def update_child_class_score_formats(k, v)
-				child_classes.each do |child_class|
-					child_class.inherit_score_format(k, v)
-				end
-			end
-			
-			def set_save_format(k, v)
-				save_formats_set_locally.add(k)
-				save_formats[k] = v
-				update_child_class_save_formats(k, v)
-				intercept_for_typing!
-			end
-			
-			def save_formats_set_locally
-				@save_formats_set_locally_set ||= Set.new
-			end
-			
-			def inherit_save_format(k, v)
-				unless save_formats_set_locally.include? k
-					save_formats[k] = v
-					update_child_class_save_formats(k, v)
-				end
-				intercept_for_typing!
-			end
-			
-			def update_child_class_save_formats(k, v)
-				child_classes.each do |child_class|
-					child_class.inherit_save_format(k, v)
-				end
-			end
-			
 			def register_format(k,fmt)
 				send(fmt, k)
 			end
@@ -274,3 +184,9 @@ module Seabright
 		
 	end
 end
+require "redis_object/types/array"
+require "redis_object/types/boolean"
+require "redis_object/types/date"
+require "redis_object/types/float"
+require "redis_object/types/json"
+require "redis_object/types/number"

data/lib/redis_object/types/array.rb

@@ -0,0 +1,18 @@
+module Seabright
+	module Types
+		module ArrayType
+			
+			def format_array(val)
+				Yajl::Parser.new(:symbolize_keys => true).parse(val)
+			end
+			
+			def save_array(val)
+				Yajl::Encoder.encode(val)
+			end
+			
+		end
+		
+		register_type :Array
+		
+	end
+end

data/lib/redis_object/types/boolean.rb

@@ -0,0 +1,23 @@
+module Seabright
+	module Types
+		module BooleanType
+			
+			def format_boolean(val)
+				val=="true"
+			end
+			
+			def save_boolean(val)
+				val === true ? "true" : "false"
+			end
+			
+			def score_boolean(val)
+				val ? 1 : 0
+			end
+			
+		end
+		
+		register_type :Boolean
+		alias_type :Bool, :Boolean
+		
+	end
+end

data/lib/redis_object/types/date.rb

@@ -0,0 +1,23 @@
+module Seabright
+	module Types
+		module DateType
+			
+			def format_date(val)
+				begin
+					val.is_a?(DateTime) || val.is_a?(Date) || val.is_a?(Time) ? val : ( val.is_a?(String) ? DateTime.parse(val) : nil )
+				rescue StandardError => e
+					puts "Could not parse value as date using Date.parse. Returning nil instead. Value: #{val.inspect}\nError: #{e.inspect}" if DEBUG
+					nil
+				end
+			end
+			
+			def score_date(val)
+				val.to_time.to_i
+			end
+			
+		end
+		
+		register_type :Date
+		
+	end
+end

data/lib/redis_object/types/float.rb

@@ -0,0 +1,15 @@
+module Seabright
+	module Types
+		module FloatType
+			
+			def format_float(val)
+				Float(val)
+			end
+			alias_method :score_float, :format_float
+			
+		end
+		
+		register_type :Float
+		
+	end
+end

data/lib/redis_object/types/json.rb

@@ -0,0 +1,18 @@
+module Seabright
+	module Types
+		module JsonType
+			
+			def format_json(val)
+				Yajl::Parser.new(:symbolize_keys => true).parse(val)
+			end
+			
+			def save_json(val)
+				Yajl::Encoder.encode(val)
+			end
+			
+		end
+		
+		register_type :Json
+		
+	end
+end

data/lib/redis_object/types/number.rb

@@ -0,0 +1,19 @@
+module Seabright
+	module Types
+		module NumberType
+			
+			def format_number(val)
+				val.to_i
+			end
+			
+			def score_number(val)
+				Float(val)
+			end
+			
+		end
+		
+		register_type :Number
+		alias_type :Int, :Number
+		
+	end
+end

data/lib/redis_object/version.rb

@@ -1,5 +1,5 @@
 module Seabright
 	class RedisObject
-		VERSION = "1.1"
+		VERSION = "1.2"
 	end
 end

data/spec/field_ref_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module FieldRefSpec
+	
+	class Dad < RedisObject; end
+	class Son < RedisObject; end
+	
+	describe RedisObject do
+		
+		before do
+			RedisObject.store.flushdb
+			@dad = Dad.create("daddy")
+			@son = Son.create("sonny")
+			@dad.stepson = @son
+		end
+		
+		it "can store an object at  any field location" do
+			
+			@dad.stepson = @son
+			
+		end
+		
+		it "can get the object back by get" do
+			
+			@dad.get(:stepson).should be_a(Son)
+			
+		end
+		
+		it "can get the object back by bracket" do
+			
+			@dad[:stepson].should be_a(Son)
+			
+		end
+		
+		it "can get the object back by pseudo-getter" do
+			
+			@dad.stepson.should be_a(Son)
+			
+		end
+		
+		it "can get the object back after reload" do
+			
+			Dad.find(@dad.id).stepson.should be_a(Son)
+			
+		end
+		
+	end
+end

data/spec/script_cache_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module ScriptCacheSpec
+	
+	class GenericObject < RedisObject;end
+	
+	describe Seabright::CachedScripts do
+		before do
+			
+			RedisObject.store.flushdb
+			
+			(1..5).each do |n|
+				GenericObject.create(n.to_s)
+			end
+			
+		end
+		
+		it "should cache scripts" do
+			
+			GenericObject.recently_created.first.id.should eq("5")
+			
+		end
+		
+		it "should untrack a script" do
+			
+			GenericObject.recently_created.first.id.should eq("5")
+			GenericObject.indexed(:created_at,-1,false).to_a.last.id.should eq("4")
+			
+			$ScriptSHAMap.keys.count.should eq(1)
+			RedisObject.untrack_script :RevScript
+			$ScriptSHAMap.keys.count.should eq(0)
+			
+		end
+		
+		it "should handle a missing script SHA" do
+			
+			GenericObject.recently_created.first.id.should eq("5")
+			RedisObject.store.script :flush
+			GenericObject.recently_created.to_a[2].id.should eq("3")
+			
+		end
+		
+		it "should expire scripts" do
+			
+			# $ScriptSHAMap.keys.count.should eq(1)
+			
+			RedisObject.stores.each do |(name,store)|
+				RedisObject.expire_all_script_shas(store)
+			end
+			
+			$ScriptSHAMap.keys.count.should eq(0)
+			
+		end
+		
+		it "should error on unknown script source" do
+			
+			expect { GenericObject.run_script(:MysteriousCommand) }.to raise_error
+			
+		end
+		
+	end
+end

data/spec/timestamp_spec.rb

@@ -4,10 +4,6 @@ module TriggerSpec
 	
 	class TimestampedObject < RedisObject;end
 	
-	class UnTimestampedObject < RedisObject
-		# time_matters_not!
-	end
-	
 	describe Seabright::Triggers do
 		before do
 			RedisObject.store.flushdb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_object
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -113,6 +113,12 @@ files:
 - lib/redis_object/timestamps.rb
 - lib/redis_object/tpl.rb
 - lib/redis_object/types.rb
+- lib/redis_object/types/array.rb
+- lib/redis_object/types/boolean.rb
+- lib/redis_object/types/date.rb
+- lib/redis_object/types/float.rb
+- lib/redis_object/types/json.rb
+- lib/redis_object/types/number.rb
 - lib/redis_object/validation.rb
 - lib/redis_object/version.rb
 - redis_object.gemspec
@@ -121,9 +127,11 @@ files:
 - spec/benchmark_spec.rb
 - spec/collections_spec.rb
 - spec/defaults_spec.rb
+- spec/field_ref_spec.rb
 - spec/filters_spec.rb
 - spec/indices_spec.rb
 - spec/rename_class_spec.rb
+- spec/script_cache_spec.rb
 - spec/spec_helper.rb
 - spec/timestamp_spec.rb
 - spec/trigger_spec.rb
@@ -161,9 +169,11 @@ test_files:
 - spec/benchmark_spec.rb
 - spec/collections_spec.rb
 - spec/defaults_spec.rb
+- spec/field_ref_spec.rb
 - spec/filters_spec.rb
 - spec/indices_spec.rb
 - spec/rename_class_spec.rb
+- spec/script_cache_spec.rb
 - spec/spec_helper.rb
 - spec/timestamp_spec.rb
 - spec/trigger_spec.rb