redis-model-extension 0.3.3 → 0.3.4

data/README.markdown

@@ -2,6 +2,24 @@
 
 Redis model is basic implementation of few methods for creating model which store data in Redis
 
+## Initialization
+
+You can use yml config file in `config` directory:
+
+``` yml
+test:
+  host: "127.0.0.1"
+  port: 6379
+  db: 3
+other omnited...
+```
+
+Or you can setup directly in initializer (or before any of redis call) redis instance directly:
+
+``` ruby
+RedisModelExtension::Database.redis = Redis.new(host: "127.0.0.1", port: 6379, db: 0)
+```
+
 ## Usage
 
 ``` ruby
@@ -14,7 +32,7 @@ class TestRedisModel
        :symbol => :to_sym,
       }, 
       :required => [:integer, :string],
-      :redis_key => [:string],
+      :redis_key => [:string, :symbol],
       :redis_aliases => {
         :token => [:symbol]
       }
@@ -24,6 +42,39 @@ class TestRedisModel
 end
 
 foo = TestRedisModel.new()
+
+# you can validate your object
+
+if foo.valid?
+  foo.save #save object
+else
+  puts foo.errors #you can get nice errors what is wrong
+end
+
+#you can update more attributes at once
+foo.update(:integer => 234, :string => "bar")
+
+# !!! if you try to save invalid object you will get ArgumentError execption !!!
+
+# after save you can find and get object find_by_alias
+
+#this will return array of all object witch has string with value "foo"
+#you can perfor find only with keys which are in redis key
+#this is slow variant for redis but compared to other databases super fast :-)
+#if you specify all keys from redis key it will perform faster method get
+TestRedisModel.find(:string => "foo") 
+
+#you can use get method if you know all keys used in redis key
+#this variant is super fast
+TestRedisModel.get(:string => "foo", :symbol=> true) 
+
+#you can ask redis if this item exists
+TestRedisModel.exists?(:string => "foo", :symbol=> true) 
+
+#you can try to find by alias - alias needs to be uniq 
+#use alias only for uniq combination of keys
+TestRedisModel.find_by_alias(:token, :symbol=> true) 
+
 ```
 
 Now you can easily access all attributes from TestRedisModel by `foo.integer` or exists? `foo.integer?` or set value by `foo.integer = 1234` 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/database.rb

@@ -2,20 +2,32 @@
 #Wrapper for redis connection
 #============================
 #Creates only one connection to redis per application in first time it needs to work with redis
-module Database
+module RedisModelExtension
+  module Database
 
-  def self.config
-    if File.exists?('config/redis_config.yml')
-      YAML.load_file('config/redis_config.yml')[ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'].symbolize_keys
-    else
-      FileUtils.mkdir_p('config') unless File.exists?('config')
-      FileUtils.cp(File.join(File.dirname(__FILE__),"../config/redis_config.yml.example"), 'config/redis_config.yml.example')
-      raise ArgumentError, "Redis configuration file does not exists -> 'config/redis_config.yml', please provide it! I have created example file in config directory..."
+    def self.config
+      if File.exists?('config/redis_config.yml')
+        YAML.load_file('config/redis_config.yml')[ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'].symbolize_keys
+      else
+        FileUtils.mkdir_p('config') unless File.exists?('config')
+        FileUtils.cp(File.join(File.dirname(__FILE__),"../config/redis_config.yml.example"), 'config/redis_config.yml.example')
+        raise ArgumentError, "Redis configuration file does not exists -> 'config/redis_config.yml', please provide it! I have created example file in config directory..."
+      end
+    end
+    
+    def self.redis= redis
+      if redis.is_a?(Redis) #valid redis instance
+        @redis = redis  
+      elsif redis.nil? #remove redis instance for changing connection or using in next call configs
+        @redis = nil
+      else #else you assigned something wrong
+        raise ArgumentError, "You have to assign Redis instance!"
+      end
     end
-  end
-  
-  def self.redis
-    @redis ||= Redis.new(Database.config)
-  end
 
+    def self.redis
+      @redis ||= Redis.new(Database.config)
+    end
+
+  end
 end

data/lib/redis-model-extension.rb

@@ -94,12 +94,12 @@ module RedisModel
 
     #Check if key by arguments exists in db
     def exists?(args = {})
-      Database.redis.exists(self.name.constantize.generate_key(args))
+      RedisModelExtension::Database.redis.exists(self.name.constantize.generate_key(args))
     end
 
     #Check if key by alias name and arguments exists in db
     def alias_exists?(alias_name, args = {})
-      Database.redis.exists(self.name.constantize.generate_alias_key(alias_name, args))
+      RedisModelExtension::Database.redis.exists(self.name.constantize.generate_alias_key(alias_name, args))
     end
 
     #Wrapper around find to get all instances
@@ -116,12 +116,12 @@ module RedisModel
       #is key specified directly? -> no needs of looking for other keys! -> faster
       if klass.valid_key?(args)
         if klass.exists?(args)
-          data_args = Database.redis.hgetall(klass.generate_key(args))
+          data_args = RedisModelExtension::Database.redis.hgetall(klass.generate_key(args))
           out << klass.new(args.merge(data_args).merge({:old_args => data_args})) 
         end
       else
-        Database.redis.keys(klass.generate_key(args)).each do |key|
-          data_args = Database.redis.hgetall(key)
+        RedisModelExtension::Database.redis.keys(klass.generate_key(args)).each do |key|
+          data_args = RedisModelExtension::Database.redis.hgetall(key)
           out << klass.new(args.merge(data_args).merge({:old_args => data_args}))
         end
       end
@@ -138,7 +138,7 @@ module RedisModel
       if klass.valid_alias_key?(alias_name, args)
         out << klass.get_by_alias(alias_name, args) if klass.alias_exists?(alias_name, args)
       else
-        Database.redis.keys(klass.generate_alias_key(alias_name, args)).each do |key|
+        RedisModelExtension::Database.redis.keys(klass.generate_alias_key(alias_name, args)).each do |key|
           out << klass.get_by_alias_key(key)
         end
       end
@@ -150,7 +150,7 @@ module RedisModel
       args.symbolize_keys!
       klass = self.name.constantize
       if klass.valid_key?(args) && klass.exists?(args)
-        data_args = Database.redis.hgetall(klass.generate_key(args))
+        data_args = RedisModelExtension::Database.redis.hgetall(klass.generate_key(args))
         klass.new(args.merge(data_args).merge({:old_args => data_args})) 
       else
         nil
@@ -159,9 +159,9 @@ module RedisModel
 
     #if you know redis key and would like to get object
     def get_by_redis_key(redis_key)
-      if redis_key.is_a?(String) && Database.redis.exists(redis_key)
+      if redis_key.is_a?(String) && RedisModelExtension::Database.redis.exists(redis_key)
         unless redis_key.include?("*")
-          data_args = Database.redis.hgetall(redis_key)
+          data_args = RedisModelExtension::Database.redis.hgetall(redis_key)
           klass = self.name.constantize
           klass.new(data_args.merge({:old_args => data_args})) 
         else
@@ -177,9 +177,9 @@ module RedisModel
       args.symbolize_keys!
       klass = self.name.constantize
       if klass.valid_alias_key?(alias_name, args) && klass.alias_exists?(alias_name, args)
-        key = Database.redis.get(klass.generate_alias_key(alias_name, args))
-        if Database.redis.exists(key)
-          data_args = Database.redis.hgetall(key)
+        key = RedisModelExtension::Database.redis.get(klass.generate_alias_key(alias_name, args))
+        if RedisModelExtension::Database.redis.exists(key)
+          data_args = RedisModelExtension::Database.redis.hgetall(key)
           klass.new(args.merge(data_args).merge({:old_args => data_args})) 
         else
           nil
@@ -192,10 +192,10 @@ module RedisModel
     #fastest method to get object from redis by getting it by alias and arguments
     def get_by_alias_key(alias_key)
       klass = self.name.constantize
-      if Database.redis.exists(alias_key)
-        key = Database.redis.get(alias_key)
-        if Database.redis.exists(key)
-          klass.new(args.merge(Database.redis.hgetall(key)).merge({:old_args => key}))
+      if RedisModelExtension::Database.redis.exists(alias_key)
+        key = RedisModelExtension::Database.redis.get(alias_key)
+        if RedisModelExtension::Database.redis.exists(key)
+          klass.new(args.merge(RedisModelExtension::Database.redis.hgetall(key)).merge({:old_args => key}))
         else
           nil
         end
@@ -260,14 +260,14 @@ module RedisModel
   
     #if this record exists in database
     def exists?
-      Database.redis.exists(self.class.generate_key(self.args))
+      RedisModelExtension::Database.redis.exists(self.class.generate_key(self.args))
     end
 
     #remove record form database
     def destroy!
       if exists?
         #destroy main object
-        Database.redis.del(redis_key) 
+        RedisModelExtension::Database.redis.del(redis_key) 
         destroy_aliases!
       end
     end
@@ -278,7 +278,7 @@ module RedisModel
       if self.old_args
         self.class.conf[:redis_aliases].each do |alias_name, fields|
           if self.class.valid_alias_key?(alias_name, self.old_args) && self.class.alias_exists?(alias_name, self.old_args)
-            Database.redis.del(self.class.generate_alias_key(alias_name, self.old_args)) 
+            RedisModelExtension::Database.redis.del(self.class.generate_alias_key(alias_name, self.old_args)) 
           end
         end
       end
@@ -288,7 +288,7 @@ module RedisModel
     def create_aliases
       main_key = redis_key
       self.class.conf[:redis_aliases].each do |alias_name, fields|
-        Database.redis.set(self.class.generate_alias_key(alias_name, self.args), main_key) if self.class.valid_alias_key?(alias_name, self.args)
+        RedisModelExtension::Database.redis.set(self.class.generate_alias_key(alias_name, self.args), main_key) if self.class.valid_alias_key?(alias_name, self.args)
       end
     end
   
@@ -302,13 +302,23 @@ module RedisModel
       self.class.generate_alias_key(alias_name, self.args)
     end
   
+    #update multiple attrubutes at once
+    def update args
+      args.each do |key, value|
+        method = "#{key}=".to_sym 
+        if self.respond_to? method
+          self.send(method, value)
+        end
+      end
+    end
+
     #save method
     def save
       if valid?
         #generate key (possibly new)
         generated_key = redis_key
-        Database.redis.rename(self.class.generate_key(self.old_args), generated_key) if self.old_args && generated_key != self.class.generate_key(self.old_args) && Database.redis.exists(self.class.generate_key(self.old_args))
-        Database.redis.hmset(generated_key, *self.args.reject{|k,v| v.nil?}.inject([]){ |arr,kv| arr + [kv[0], kv[1].to_s]})
+        RedisModelExtension::Database.redis.rename(self.class.generate_key(self.old_args), generated_key) if self.old_args && generated_key != self.class.generate_key(self.old_args) && RedisModelExtension::Database.redis.exists(self.class.generate_key(self.old_args))
+        RedisModelExtension::Database.redis.hmset(generated_key, *self.args.reject{|k,v| v.nil?}.inject([]){ |arr,kv| arr + [kv[0], kv[1].to_s]})
         
         #destroy aliases
         destroy_aliases!

data/redis-model-extension.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "redis-model-extension"
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ondrej Bartas"]
-  s.date = "2012-05-17"
+  s.date = "2012-07-27"
   s.description = "It provides functions as find, find_by_alias, get, exists?, validate, save etc."
   s.email = "ondrej@bartas.cz"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "redis-model-extension.gemspec",
     "redis-model.gemspec",
     "test/helper.rb",
+    "test/test_database_module.rb",
     "test/test_redis-model-extension.rb"
   ]
   s.homepage = "http://github.com/ondrejbartas/redis-model-extension"

data/test/test_database_module.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class DatabaseModuleTest < Test::Unit::TestCase
+  context "DatabaseModule" do
+    setup do
+      #cleare previously assigned redis instance
+      RedisModelExtension::Database.redis = nil
+    end
+
+    should "be initialized directly" do
+      assert_nothing_raised do
+        RedisModelExtension::Database.redis = Redis.new(host: "127.0.0.1", port: 6379, db: 0)
+        RedisModelExtension::Database.redis.info
+      end
+      assert RedisModelExtension::Database.redis.is_a? Redis
+    end
+
+    should "be initialized from config" do
+      assert_nothing_raised do
+        RedisModelExtension::Database.redis.info
+      end
+      assert RedisModelExtension::Database.redis.is_a? Redis
+    end
+  end
+end

data/test/test_redis-model-extension.rb

@@ -3,7 +3,7 @@ require 'helper'
 class RedisModelTest < Test::Unit::TestCase
   context "RedisModel" do
     setup do
-      Database.redis.flushdb
+      RedisModelExtension::Database.redis.flushdb
       
       class TestRedisModel
         REDIS_MODEL_CONF = {
@@ -97,16 +97,39 @@ class RedisModelTest < Test::Unit::TestCase
       end
     end
     
+    context "updating" do
+      setup do
+        @new_args = {:integer => 123457, :string => "bar", :symbol => :foo, :boolean => false}
+      end
+
+      should "change attributes" do
+        @test_model.update @new_args
+        assert_equal @test_model.integer, @new_args[:integer]
+        assert_equal @test_model.string, @new_args[:string]
+        assert_equal @test_model.symbol, @new_args[:symbol]
+        assert_equal @test_model.boolean, @new_args[:boolean]
+      end
+
+      should "ignore unknown attributes and other normaly update" do
+        @test_model.update @new_args.merge(:unknown => "attribute")
+        assert_equal @test_model.integer, @new_args[:integer]
+        assert_equal @test_model.string, @new_args[:string]
+        assert_equal @test_model.symbol, @new_args[:symbol]
+        assert_equal @test_model.boolean, @new_args[:boolean]
+      end
+
+    end
+
     context "saving" do
       setup do
         @test_model.save
       end
       
       should "be saved and then change of variable included in key should rename it in redis!" do
-        assert_equal Database.redis.keys("*").size, 2 #including key and alias
+        assert_equal RedisModelExtension::Database.redis.keys("*").size, 2 #including key and alias
         @test_model.string = "change_of_strging"
         @test_model.save
-        assert_equal Database.redis.keys("*").size, 2 #including key and alias
+        assert_equal RedisModelExtension::Database.redis.keys("*").size, 2 #including key and alias
       end
 
       should "have same elements after get" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-model-extension
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70209861357400 !ruby/object:Gem::Requirement
+  requirement: &70305276410840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70209861357400
+  version_requirements: *70305276410840
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70209861356840 !ruby/object:Gem::Requirement
+  requirement: &70305276528280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70209861356840
+  version_requirements: *70305276528280
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70209861417400 !ruby/object:Gem::Requirement
+  requirement: &70305276527660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70209861417400
+  version_requirements: *70305276527660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70209861416880 !ruby/object:Gem::Requirement
+  requirement: &70305276526760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70209861416880
+  version_requirements: *70305276526760
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70209861416220 !ruby/object:Gem::Requirement
+  requirement: &70305276524500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70209861416220
+  version_requirements: *70305276524500
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70209861415420 !ruby/object:Gem::Requirement
+  requirement: &70305276520460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70209861415420
+  version_requirements: *70305276520460
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &70209861413780 !ruby/object:Gem::Requirement
+  requirement: &70305276495380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70209861413780
+  version_requirements: *70305276495380
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70209861410960 !ruby/object:Gem::Requirement
+  requirement: &70305276494300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70209861410960
+  version_requirements: *70305276494300
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70209861283760 !ruby/object:Gem::Requirement
+  requirement: &70305276493040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70209861283760
+  version_requirements: *70305276493040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70209861282480 !ruby/object:Gem::Requirement
+  requirement: &70305276492000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70209861282480
+  version_requirements: *70305276492000
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70209861281040 !ruby/object:Gem::Requirement
+  requirement: &70305276491180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *70209861281040
+  version_requirements: *70305276491180
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70209861280120 !ruby/object:Gem::Requirement
+  requirement: &70305276490680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70209861280120
+  version_requirements: *70305276490680
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &70209861279180 !ruby/object:Gem::Requirement
+  requirement: &70305276490000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -153,7 +153,7 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *70209861279180
+  version_requirements: *70305276490000
 description: It provides functions as find, find_by_alias, get, exists?, validate,
   save etc.
 email: ondrej@bartas.cz
@@ -177,6 +177,7 @@ files:
 - redis-model-extension.gemspec
 - redis-model.gemspec
 - test/helper.rb
+- test/test_database_module.rb
 - test/test_redis-model-extension.rb
 homepage: http://github.com/ondrejbartas/redis-model-extension
 licenses:
@@ -193,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 510311586469191495
+      hash: 1302206026057497451
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: