redis_record 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+pkg

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm @redis_record
+bundle install

data/Gemfile

@@ -0,0 +1,10 @@
+source :gemcutter
+
+gem 'rake'
+gem 'redis'
+
+group :test do
+  gem 'minitest'
+  gem 'watchr'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    minitest (1.7.2)
+    rake (0.8.7)
+    redis (2.0.10)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  minitest
+  rake
+  redis
+  watchr

data/README.rdoc

@@ -0,0 +1,22 @@
+= RedisRecord
+
+ActiveRecord-like API for Objects stored in Redis.
+
+== Usage
+  
+  require 'lib/redis_record'
+
+  class User
+    attr_accessor :email, :username
+
+    extend RedisRecord
+    use_redis
+  end
+
+  u = User.new
+  u.email = "email@example.com"
+  u.username = "thk"
+  u.save
+  puts u.id # => 1
+
+  u_new = User.find(1)

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.ruby_opts << "-rubygems"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace :test do
+  desc "Run tests VERBOSE"
+  task :verbose do
+    # TODO pass task arguments in a better way
+    ENV['TESTOPTS'] = "-v"
+    Rake::Task[:test].invoke
+  end
+
+  task :watchr do
+    system "./test.watchr"
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "redis_record"
+    gemspec.summary = "One line summary of your gem"
+    # gemspec.description = "TODO"
+    gemspec.email = "peter-redis_record@suschlik.de"
+    gemspec.homepage = "http://github.com/splattael/redis_record"
+    gemspec.authors = ["Thomas Kerstgens", "Peter Suschlik"]
+    gemspec.add_dependency 'redis', '~> 2.0.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/redis_record.rb

@@ -0,0 +1,66 @@
+require 'redis'
+
+module RedisRecord
+  @@redis = nil
+
+  # call this to mixin member-methods
+  # TODO: redis parameters (host, port, etc.)
+  def use_redis(*args)
+    class_eval do
+      attr_accessor :id
+
+      def save
+        unless persisted?
+          # Note: redis automatically generates an key_value-pair with type int
+          self.id = self.class.redis.incr('#' + self.class.redis_key)
+        end
+        "OK" == self.class.redis.set(self.class.redis_key(id), self.dump)
+      end
+
+      def persisted?
+        !id.nil?
+      end
+
+      protected
+
+      def dump
+        Marshal.dump(self)
+      end
+    end
+
+    @@redis = Redis.new(*args)
+  end
+
+  def redis
+    @@redis
+  end
+
+  def redis_key(*args)
+    # redis_key -> user
+    # redis_key(1) -> user_1
+    # redis_key(1, "attr") -> user_1_attr
+    [ @_prefix ||= self.name.downcase, *args ].join('_')
+  end
+
+  def find(id)
+    data = redis.get(redis_key(id))
+    parse(data) if data
+  end
+
+  def all
+    keys = redis.keys(redis_key("*"))
+    objects = []
+    keys.each do |key|
+      if data = redis.get(key)
+        objects << parse(data)
+      end
+    end
+    objects
+  end
+
+protected
+
+  def parse(data)
+    Marshal.load(data)
+  end
+end

data/redis_record.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{redis_record}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Kerstgens", "Peter Suschlik"]
+  s.date = %q{2010-10-04}
+  s.email = %q{peter-redis_record@suschlik.de}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".rvmrc",
+     "Gemfile",
+     "Gemfile.lock",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/redis_record.rb",
+     "redis_record.gemspec",
+     "test.watchr",
+     "test/helper.rb",
+     "test/test_redis_record.rb",
+     "test/test_redis_record_real.rb"
+  ]
+  s.homepage = %q{http://github.com/splattael/redis_record}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{One line summary of your gem}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_redis_record.rb",
+     "test/test_redis_record_real.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, ["~> 2.0.0"])
+    else
+      s.add_dependency(%q<redis>, ["~> 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<redis>, ["~> 2.0.0"])
+  end
+end
+

data/test.watchr

@@ -0,0 +1,49 @@
+#!/usr/bin/env watchr
+
+def run(cmd)
+  puts(cmd)
+  system cmd
+end
+
+def run_test_file(file)
+  clear
+  run "ruby -rubygems -Ilib:test #{file}"
+end
+
+def run_tests
+  clear
+  run "rake"
+end
+
+def clear
+  system "clear"
+end
+
+def underscore(file)
+  file.gsub('/', '_')
+end
+
+@interrupted = false
+
+Signal.trap 'QUIT' do
+  run_tests
+end
+
+Signal.trap 'INT' do
+  if @interrupted then
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_tests
+  end
+end
+
+run_tests
+
+watch('test/test_.*\.rb') {|md| run_test_file md[0] }
+watch('lib/(.*)\.rb') {|md| run_test_file "test/test_#{underscore(md[1])}.rb" }
+watch('test/helper.rb') { run_tests }
+

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'redis_record'
+
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/mock'
+
+# Magically run tests at exit.
+MiniTest::Unit.autorun
+
+module MockedRedis
+  def setup
+    @redis = MiniTest::Mock.new
+    # TODO should defined on User class!
+    RedisRecord.send(:class_variable_set, :@@redis, @redis)
+  end
+
+  def teardown
+    @redis.verify
+  end
+end

data/test/test_redis_record.rb

@@ -0,0 +1,103 @@
+require 'helper'
+
+class User < Struct.new(:name)
+  extend RedisRecord
+  use_redis
+end
+
+class TestRedisMocked < MiniTest::Unit::TestCase
+  include MockedRedis
+
+  def test_mocked_redis
+    assert_same @redis, User.redis
+  end
+end
+
+class TestRedisRecordUser < MiniTest::Unit::TestCase
+  def test_has_name
+    user = User.new("foo")
+
+    assert_equal "foo", user.name
+    user.name = "bar"
+    assert_equal "bar", user.name
+  end
+
+  def test_has_id
+    user = User.new("foo")
+
+    assert_nil user.id
+    assert !user.persisted?
+
+    user.id = 1
+    assert_equal 1, user.id
+    assert user.persisted?
+  end
+
+  def test_redis_key
+    assert_equal "user", User.redis_key
+    assert_equal "user_1", User.redis_key(1)
+    assert_equal "user_*", User.redis_key("*")
+  end
+end
+
+class TestRedisRecordEmpty < MiniTest::Unit::TestCase
+  include MockedRedis
+
+  def test_does_not_find_user
+    @redis.expect :get, nil, ["user_1"]
+
+    user = User.find(1)
+    assert_nil user
+  end
+
+  def test_no_users_at_all
+    @redis.expect :keys, [], ["user_*"]
+
+    users = User.all
+    assert_equal [], users
+  end
+end
+
+class TestRedisRecordNonEmpty < MiniTest::Unit::TestCase
+  include MockedRedis
+
+  def setup
+    super # mock redis
+    @user = User.new("foo")
+    @dump = @user.send(:dump)
+  end
+
+  def test_finds_user
+    @redis.expect :get, @dump, ["user_1"]
+
+    found = User.find(1)
+    assert_equal @user.name, found.name
+  end
+
+  def test_find_all_users
+    @redis.expect :keys, ["user_1"], ["user_*"]
+    @redis.expect :get, @dump, ["user_1"]
+
+    found = User.all
+    assert_equal 1, found.size
+    assert_equal @user.name, found.first.name
+  end
+
+  def test_saves_new_user
+    assert_nil @user.id
+
+    @redis.expect :incr, 3, ["#user"]
+    @user.id = 3 # for the dump
+    @redis.expect :set, "OK", ["user_3", @user.send(:dump)]
+    @user.id = nil
+
+    assert @user.save
+  end
+
+  def test_save_fails
+    @user.id = 23
+
+    @redis.expect :set, "NOT OK", ["user_23", @user.send(:dump)]
+    assert !@user.save
+  end
+end

data/test/test_redis_record_real.rb

@@ -0,0 +1,71 @@
+require 'helper'
+
+class RealUser < Struct.new(:name)
+  extend RedisRecord
+  use_redis(:db => 2)
+end
+
+redis_server_running = \
+begin
+  # Start with a fresh db
+  "PONG" == RealUser.redis.ping
+rescue => e
+  puts e
+  false
+end
+
+if redis_server_running
+
+class TestRealRedis < MiniTest::Unit::TestCase
+  def setup
+    RealUser.redis.flushall
+    @alice = RealUser.new("alice")
+    @bob = RealUser.new("bob")
+  end
+
+  def test_uses_test_db_as_option
+    assert_equal 2, RealUser.redis.client.db
+  end
+
+  def test_real_user
+    assert_equal "realuser", RealUser.redis_key
+  end
+
+  def test_empty
+    assert_equal [], RealUser.all
+    assert_nil RealUser.find(1)
+  end
+
+  def test_find
+    assert @alice.save
+
+    assert_nil RealUser.find(-1)
+    assert_equal @alice, RealUser.find(@alice.id)
+  end
+
+  def test_all
+    assert @alice.save
+    assert @bob.save
+
+    assert_equal [@alice, @bob], RealUser.all
+  end
+
+  def test_save_and_update
+    assert @alice.save
+    assert_equal 1, @alice.id
+
+    @alice.name = "Ali"
+    assert @alice.save
+    assert_equal 1, @alice.id
+    assert_equal @alice, RealUser.find(@alice.id)
+
+    assert @bob.save
+    assert_equal 2, @bob.id
+  end
+end
+
+else
+
+  puts "SKIP: Redis server not running!"
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: redis_record
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Kerstgens
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: redis
+description: 
+email: peter-redis_record@suschlik.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis_record.rb
+- redis_record.gemspec
+- test.watchr
+- test/helper.rb
+- test/test_redis_record.rb
+- test/test_redis_record_real.rb
+has_rdoc: true
+homepage: http://github.com/splattael/redis_record
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: One line summary of your gem
+test_files: 
+- test/helper.rb
+- test/test_redis_record.rb
+- test/test_redis_record_real.rb