redis-persistence 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+scratch/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in redis-persistence.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,51 @@
+Redis Persistence
+=================
+
+`Redis::Persistence` is a simple persistence layer for Ruby objects, fully compatible with ActiveModel,
+and thus easily used both standalone or in a Rails project.
+
+## Usage ##
+
+```ruby
+require 'redis/persistence'
+
+Redis::Persistence.config.redis = Redis.new
+# => #<Redis client v2.2.2 connected to redis://127.0.0.1:6379/0 (Redis v2.4.1)>
+
+class Article
+  include Redis::Persistence
+
+  property :id
+  property :title
+  property :body
+  property :author, :default => '(Unknown)'
+end
+
+article = Article.new :id => 1, :title => 'Lorem Ipsum'
+# => #<Article: {"id"=>1, "title"=>"Lorem Ipsum", "body"=>nil, "author"=>"(Unknown)"}>
+
+article.save
+# => #<Article: {"id"=>1, "title"=>"Lorem Ipsum", "body"=>nil, "author"=>"(Unknown)"}>
+
+article = Article.find(1)
+# => #<Article: {"id"=>1, "title"=>"Lorem Ipsum", "body"=>nil, "author"=>"(Unknown)"}>
+
+article.title
+# => "Lorem Ipsum"
+
+article.author
+# => "(Unknown)"
+```
+
+It comes with the standard feature set of ActiveModel classes: validations, callbacks, serialization,
+Rails DOM helpers compatibility, etc.
+
+
+## Installation ##
+
+    git clone git://github.com/Ataxo/redis-persistence.git
+    rake install
+
+-----
+
+(c) 2011, Ataxo Interactive, s.r.o., released under the MIT License.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/*_test.rb']
+  test.verbose = true
+  # test.warning = true
+end

data/examples/article.rb

@@ -0,0 +1,82 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'redis/persistence'
+require 'active_support/core_ext/hash/indifferent_access'
+
+Redis::Persistence.config.redis = Redis.new :db => 14
+Redis::Persistence.config.redis.flushdb
+# => #<Redis client v2.2.2 connected to redis://127.0.0.1:6379/0 (Redis v2.4.1)>
+
+class Comment
+  def initialize(params);                      @attributes = HashWithIndifferentAccess.new(params); end
+  def method_missing(method_name, *arguments); @attributes[method_name];                            end
+  def as_json(*);                              @attributes;                                         end
+end
+
+class Article
+  include Redis::Persistence
+
+  property :title
+  property :body
+  property :author, :default  => '(Unknown)'
+  property :created
+
+  property :comments, :default => [], :class => [Comment], :family => 'comments'
+end
+
+article = Article.new :title   => 'Do Not Blink',
+                      :author  => 'Malcom Gladwell',
+                      :body    => 'Imagine that I asked you ...',
+                      :created => Time.now.utc
+# => #<Article: {"id"=>1, "title"=>"Do Not Blink", ...>
+
+p article.save
+# => #<Article: {"id"=>1, "title"=>"Do Not Blink", ...>
+
+p article = Article.find(1)
+# => #<Article: {"id"=>1, "title"=>"Do Not Blink", ...>
+
+p article.title
+# => "Do Not Blink"
+
+p article.created.year
+# => 2011
+
+article = Article.new :title => 'In the Beginning Was the Command Line'
+p article.save
+# => #<Article: {"id"=>2, "title"=>"In the Beginning Was the Command Line", ... "author"=>"(Unknown)"}>
+
+p article = Article.find(2)
+# => #<Article: {"id"=>2, "title"=>"In the Beginning Was the Command Line", ... "author"=>"(Unknown)"}>
+
+p article.author
+# => "(Unknown)"
+
+article = Article.create :title => 'OMG BLOG!'
+
+p article.comments
+# => []
+
+article.comments << {:nick => '4chan', :body => 'WHY U NO QUIT?'}
+
+article.comments << Comment.new(:nick => 'h4x0r', :body => 'WHY U NO USE BBS?')
+
+p article.comments.size
+# => 2
+
+p article.save
+# => <Article: {"id"=>3, ... "comments"=>[{:nick=>"4chan", :body=>"WHY U NO QUIT?"}]}>
+
+article = Article.find(3)
+p article.comments
+# => []
+
+article = Article.find(3, :families => 'comments')
+p article.comments
+# => [#<Comment:0x007f893180dd08 @attributes={"nick"=>"4chan", "body"=>"WHY U NO QUIT?"}>]
+
+p article.comments.first.nick
+# => "4chan"
+
+p article.comments.last.nick
+# => "h4x0r"

data/examples/benchmark.rb

@@ -0,0 +1,62 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'benchmark'
+require 'redis/persistence'
+require 'active_support/core_ext/hash/indifferent_access'
+
+content = DATA.read
+COUNT   = ENV['COUNT'] || 100_000
+
+Redis::Persistence.config.redis = Redis.new :db => 14
+Redis::Persistence.config.redis.flushdb
+
+class Article
+  include Redis::Persistence
+
+  property :title
+  property :content, :family => 'extra'
+  property :created, :family => 'extra'
+end
+
+puts "Saving #{COUNT} documents into Redis..."
+
+elapsed = Benchmark.realtime do
+  (1..COUNT).map do |i|
+    Article.create title: "Document #{i}", content: content, created: Time.now.utc
+  end
+end
+
+puts "Duration: #{elapsed} seconds, rate: #{COUNT.to_f/elapsed} docs/sec",
+     '-'*80
+
+puts "Finding #{COUNT} documents one by one..."
+
+elapsed = Benchmark.realtime do
+  (1..COUNT).map do |i|
+    Article.find(i, :family => 'extra')
+  end
+end
+
+puts "Duration: #{elapsed} seconds, rate: #{COUNT.to_f/elapsed} docs/sec",
+     '-'*80
+
+puts "Finding first 1000 documents with only 'data' family..."
+
+elapsed = Benchmark.realtime do
+  Article.find (1..1000).to_a
+end
+
+puts "Duration: #{elapsed*1000} milliseconds, rate: #{1000.0/elapsed} docs/sec, #{(elapsed/1000.0)*1000.0} msec/doc",
+     '-'*80
+
+puts "Updating all documents in batches of 1000..."
+
+elapsed = Benchmark.realtime do
+  Article.find_each { |document| document.title += ' (touched)' and document.save }
+end
+
+puts "Duration: #{elapsed} seconds, rate: #{COUNT.to_f/elapsed} docs/sec",
+     '-'*80
+
+__END__
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/examples/rails-template.rb

@@ -0,0 +1,124 @@
+# =======================================================================
+# Template for generating basic Rails application with Redis::Persistence
+# =======================================================================
+#
+# Requirements
+# ------------
+#
+# * Git
+# * Ruby >= 1.9.3
+# * Rubygems
+# * Rails >= 3.1.0
+# * Redis >= 2.4.1
+#
+#
+# Usage
+# -----
+#
+#     $ rails new articles -m https://raw.github.com/Ataxo/redis-persistence/master/examples/rails-template.rb
+#
+# ===================================================================================================================
+
+require 'rubygems'
+
+run "rm public/index.html"
+run "rm public/images/rails.png"
+run "touch tmp/.gitignore log/.gitignore vendor/.gitignore"
+
+run "rm -f .gitignore"
+file ".gitignore", <<-END.gsub(/  /, '')
+  .DS_Store
+  log/*.log
+  tmp/**/*
+  config/database.yml
+  db/*.sqlite3
+END
+
+git :init
+git :add => '.'
+git :commit => "-m 'Initial commit: Clean application'"
+
+puts
+say_status  "Rubygems", "Adding Rubygems into Gemfile...\n", :yellow
+puts        '-'*80, ''; sleep 1
+
+gem 'redis-persistence', :git => 'git://github.com/Ataxo/redis-persistence.git'
+
+git :add => '.'
+git :commit => "-m 'Added gems'"
+
+puts
+say_status  "Rubygems", "Installing Rubygems...", :yellow
+puts        '-'*80, ''
+
+run "bundle install"
+
+puts
+say_status  "Model", "Adding the Article resource...", :yellow
+puts        '-'*80, ''; sleep 1
+
+generate :scaffold, "Article title:string content:text published:date"
+route "root :to => 'articles#index'"
+
+git :add => '.'
+git :commit => "-m 'Added the Article resource'"
+
+puts
+say_status  "Model", "Adding Redis::Persistence into the Article model...", :yellow
+puts        '-'*80, ''; sleep 1
+
+run "rm -f app/models/article.rb"
+file 'app/models/article.rb', <<-CODE
+class Article
+  include Redis::Persistence
+
+  property :title
+  property :content
+  property :published
+end
+CODE
+
+initializer 'redis-persistence.rb', <<-CODE
+Redis::Persistence.config.redis = Redis.new(:db => 14)
+CODE
+
+git :commit => "-a -m 'Added Redis::Persistence into the Article model, added initializer (Redis DB=14)'"
+
+puts
+say_status  "Database", "Seeding the database with data...", :yellow
+puts        '-'*80, ''; sleep 0.25
+
+run "rm -rf db/migrate"
+run "redis-cli -n 14 flushdb"
+run "rm -f db/seeds.rb"
+file 'db/seeds.rb', <<-CODE
+contents = [
+'Lorem ipsum dolor sit amet.',
+'Consectetur adipisicing elit, sed do eiusmod tempor incididunt.',
+'Labore et dolore magna aliqua.',
+'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.',
+'Excepteur sint occaecat cupidatat non proident.'
+]
+
+puts "Creating articles..."
+%w[ One Two Three Four Five ].each_with_index do |title, i|
+  Article.create title: title, content: contents[i], published: i.days.ago.utc
+end
+CODE
+
+rake "db:seed"
+
+git :add    => "db/seeds.rb"
+git :commit => "-m 'Added database seeding script'"
+
+puts
+say_status  "Git", "Details about the application:", :yellow
+puts        '-'*80, ''
+
+run "git log --reverse --pretty=format:'%Cblue%h%Creset | %s'"
+
+puts  "", "="*80
+say_status  "DONE", "\e[1mStarting the application...\e[0m", :yellow
+puts  "="*80, ""
+
+run  "rails server"

data/lib/redis/persistence.rb

@@ -0,0 +1,188 @@
+require 'redis'
+require 'hashr'
+require 'multi_json'
+require 'active_model'
+require 'active_support/concern'
+require 'active_support/configurable'
+
+class Redis
+  module Persistence
+    include ActiveSupport::Configurable
+    extend  ActiveSupport::Concern
+
+    included do
+      include ActiveModelIntegration
+      self.include_root_in_json = false
+
+      def self.__redis
+        Redis::Persistence.config.redis
+      end
+
+      def __redis
+        self.class.__redis
+      end
+
+    end
+
+    module ActiveModelIntegration
+      extend ActiveSupport::Concern
+
+      included do
+        include ActiveModel::AttributeMethods
+        include ActiveModel::Validations
+        include ActiveModel::Serialization
+        include ActiveModel::Serializers::JSON
+        include ActiveModel::Naming
+        include ActiveModel::Conversion
+
+        extend  ActiveModel::Callbacks
+        define_model_callbacks :save, :destroy
+      end
+    end
+
+    module ClassMethods
+
+      def create(attributes={})
+        new(attributes).save
+      end
+
+      def property(name, options = {})
+        attr_accessor name.to_sym
+        properties << name.to_s unless properties.include?(name.to_s)
+
+        property_defaults[name.to_sym] = options[:default] if options[:default]
+        property_types[name.to_sym]    = options[:class]   if options[:class]
+        unless options[:family]
+          (property_families[:data] ||= [])                   << name.to_s
+        else
+          (property_families[options[:family].to_sym] ||= []) << name.to_s
+        end
+        self
+      end
+
+      def properties
+        @properties ||= ['id']
+      end
+
+      def property_defaults
+        @property_defaults ||= {}
+      end
+
+      def property_types
+        @property_types ||= {}
+      end
+
+      def property_families
+        @property_families ||= { :data => ['id'] }
+      end
+
+      def find(args, options={})
+        args.is_a?(Array) ? __find_many(args, options) : __find_one(args, options)
+      end
+
+      def __find_one(id, options={})
+        families = ['data'] | Array(options[:families])
+        data = __redis.hmget("#{self.model_name.plural}:#{id}", *families)
+
+        unless data.compact.empty?
+          attributes = data.inject({}) { |hash, item| hash.update( MultiJson.decode(item) ); hash }
+          self.new attributes
+        end
+      end
+
+      def __find_all(options={})
+        __find_many __all_ids
+      end
+      alias :all :__find_all
+
+      def __find_many(ids, options={})
+        ids.map { |id| __find_one(id, options) }.compact
+      end
+
+      def find_each(options={}, &block)
+        options = { :batch_size => 1000 }.update(options)
+        __all_ids.each_slice options[:batch_size] do |batch|
+          __find_many(batch).each { |document| yield document }
+        end
+      end
+
+      def __next_id
+        __redis.incr("#{self.model_name.plural}_ids")
+      end
+
+      def __all_ids
+        __redis.keys("#{self.model_name.plural}:*").map { |id| id[/:(\d+)$/, 1].to_i }.sort
+      end
+
+    end
+
+    module InstanceMethods
+      attr_accessor :id
+
+      def initialize(attributes={})
+        __update_attributes self.class.property_defaults.merge(attributes)
+        self
+      end
+      alias :attributes= :initialize
+
+      def update_attributes(attributes={})
+        __update_attributes attributes
+        save
+        self
+      end
+
+      def attributes
+        self.class.
+          properties.
+          inject({}) {|attributes, key| attributes[key] = send(key); attributes}
+      end
+
+      def save
+        run_callbacks :save do
+          self.id ||= self.class.__next_id
+          params    = self.class.property_families.keys.map do |family|
+                        [family.to_s, self.to_json(:only => self.class.property_families[family])]
+                      end.flatten
+          __redis.hmset "#{self.class.model_name.plural}:#{self.id}", *params
+        end
+        self
+      end
+
+      def destroy
+        run_callbacks :destroy do
+          __redis.del "#{self.class.model_name.plural}:#{self.id}"
+        end
+        self.freeze
+      end
+
+      def persisted?
+        __redis.exists "#{self.class.model_name.plural}:#{self.id}"
+      end
+
+      def inspect
+        "#<#{self.class}: #{attributes}>"
+      end
+
+      def __update_attributes(attributes)
+        attributes.each do |name, value|
+          case
+          when klass = self.class.property_types[name.to_sym]
+            if klass.is_a?(Array) && value.is_a?(Array)
+              send "#{name}=", value.map { |v| klass.first.new(v) }
+            else
+              send "#{name}=", klass.new(value)
+            end
+          when value.is_a?(Hash)
+            send "#{name}=", Hashr.new(value)
+          else
+            # Automatically convert <http://en.wikipedia.org/wiki/ISO8601> formatted strings to Time
+            value = Time.parse(value) if value.is_a?(String) && value =~ /^\d{4}[\/\-]\d{2}[\/\-]\d{2}T\d{2}\:\d{2}\:\d{2}Z$/
+            send "#{name}=", value
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/redis/persistence/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  module Persistence
+    VERSION = "0.0.1"
+  end
+end

data/redis-persistence.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redis/persistence/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Karel Minarik", "Vojtech Hyza"]
+  gem.email         = ["karmi@karmi.cz", "vhyza@vhyza.eu"]
+  gem.description   = %q{Simple ActiveModel-compatible persistence layer in Redis}
+  gem.summary       = %q{Simple ActiveModel-compatible persistence layer in Redis}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "redis-persistence"
+  gem.require_paths = ["lib"]
+  gem.version       = Redis::Persistence::VERSION
+
+  # = Library dependencies
+  #
+  gem.add_dependency "activemodel", "~> 3.0"
+  gem.add_dependency "multi_json",  "~> 1.0"
+  gem.add_dependency "redis",       "~> 2.2.2"
+  gem.add_dependency "hashr",       "~> 0.0.16"
+
+  # = Development dependencies
+  #
+  gem.add_development_dependency "bundler",     "~> 1.0"
+  gem.add_development_dependency "yajl-ruby",   "~> 0.8.0"
+  gem.add_development_dependency "shoulda"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "turn"
+end

data/test/_helper.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'shoulda'
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["CI"]
+require 'mocha'
+
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'redis/persistence'
+require 'yajl'
+
+require 'models'
+
+class Test::Unit::TestCase
+
+  def setup
+    Redis::Persistence.config.redis = Redis.new db: ENV['REDIS_PERSISTENCE_TEST_DATABASE'] || 14
+    Redis::Persistence.config.redis.flushdb
+  end
+
+  def teardown
+    Redis::Persistence.config.redis.flushdb
+    Redis::Persistence.configure do |config|
+      config.redis = nil
+    end
+  end
+
+end

data/test/active_model_lint_test.rb

@@ -0,0 +1,18 @@
+require '_helper'
+
+class Redis
+  module Persistence
+
+    class ActiveModelLintTest < Test::Unit::TestCase
+
+      include ActiveModel::Lint::Tests
+
+      def setup
+        super
+        @model = PersistentArticle.new title: 'Test'
+      end
+
+    end
+
+  end
+end

data/test/models.rb

@@ -0,0 +1,106 @@
+class Piece
+  def initialize(params)
+    @attributes = HashWithIndifferentAccess.new(params)
+  end
+
+  def method_missing(method_name, *arguments)
+    @attributes[method_name]
+  end
+
+  def as_json(*)
+    @attributes
+  end
+end
+
+class PersistentArticle
+  include Redis::Persistence
+
+  property :title
+  property :created
+end
+
+class ModelWithBooleans
+  include Redis::Persistence
+
+  property :published
+  property :approved
+end
+
+class ModelWithDefaults
+  include Redis::Persistence
+
+  property :title, default: '(Unknown)'
+  property :admin, default: true
+end
+
+class ModelWithCallbacks
+  include Redis::Persistence
+
+  before_save    :my_callback_method
+  after_save     :my_callback_method
+  before_destroy { @hooked = 'YEAH' }
+
+  property :title
+
+  def my_callback_method
+  end
+end
+
+class ModelWithValidations
+  include Redis::Persistence
+
+  property :title
+
+  validates_presence_of :title
+end
+
+class ModelWithCasting
+
+  class Thing
+    attr_reader :value
+
+    def initialize(params={})
+      @value = params[:value] || params['value']
+    end
+  end
+
+  class Stuff
+    attr_reader :values
+
+    def initialize(values)
+      @values = values
+    end
+
+    def as_json(*)
+      values
+    end
+  end
+
+  include Redis::Persistence
+
+  property :thing,  :class => Thing
+  property :stuff,  :class => Stuff,   :default => []
+  property :pieces, :class => [Piece], :default => []
+end
+
+class ModelWithDeepHashes
+  include Redis::Persistence
+
+  property :tree
+end
+
+class ModelWithFamily
+  include Redis::Persistence
+
+  property :name
+
+  property :views,  :family => 'counters'
+  property :visits, :family => 'counters'
+
+  property :lang,   :family => 'meta'
+end
+
+class ModelWithCastingInFamily
+  include Redis::Persistence
+  property :pieces, :class => [Piece], :default => [], :family => 'meta'
+end

data/test/redis_persistence_test.rb

@@ -0,0 +1,293 @@
+require '_helper'
+
+class RedisPersistenceTest < ActiveSupport::TestCase
+  def setup;    super; end
+  def teardown; super; end
+
+  def in_redis
+    Redis::Persistence.config.redis
+  end
+
+  context "Redis Connection" do
+  
+    should "be set" do
+      assert_nothing_raised { in_redis.info }
+    end
+  
+  end
+  
+  context "Defining properties" do
+
+    should "define accessors from attributes" do
+      article = PersistentArticle.new title: 'One'
+      assert_equal 'One', article.title
+    end
+
+    should "set the attributes" do
+      article = PersistentArticle.new title: 'One'
+      article.title = 'Two'
+      assert_equal 'Two', article.title
+    end
+
+    should "raise error when passing invalid attribute" do
+      assert_raise NoMethodError do
+        PersistentArticle.new krapulitzowka: 'Not'
+      end
+    end
+
+    should "return nil for not passed attributes" do
+      assert_nil PersistentArticle.new.title
+      assert_nil PersistentArticle.create.title
+    end
+
+    should "return default values" do
+      d = ModelWithDefaults.create
+      assert_equal '(Unknown)', d.title
+      assert_equal true, d.admin
+
+      d = ModelWithDefaults.find(1)
+      assert_equal '(Unknown)', d.title
+      assert_equal true, d.admin
+    end
+
+    should "return time as time" do
+      a = PersistentArticle.create created: Time.new(2011, 11, 9).utc
+      assert_instance_of Time, a.created
+
+      a = PersistentArticle.find(1)
+      assert_instance_of Time, a.created
+    end
+
+    should "return boolean as boolean" do
+      m = ModelWithBooleans.create published: false, approved: true
+      assert_instance_of FalseClass, m.published
+      assert_instance_of TrueClass,  m.approved
+
+      m = ModelWithBooleans.find(1)
+      assert_instance_of FalseClass, m.published
+      assert_instance_of TrueClass,  m.approved
+    end
+
+    should "cast the value" do
+      m = ModelWithCasting.new
+      assert_equal [], m.stuff.values
+
+      m = ModelWithCasting.new
+      assert_equal [], m.pieces
+
+      m = ModelWithCasting.create thing: { :value => 1 }, stuff: [1, 2, 3], pieces: [ { name: 'One', level: 42 } ]
+
+      assert_instance_of ModelWithCasting::Thing, m.thing
+      assert_equal 1, m.thing.value
+
+      assert_instance_of ModelWithCasting::Stuff, m.stuff
+      assert_equal 1, m.stuff.values.first
+
+      assert_instance_of Array, m.pieces
+      assert_instance_of Piece, m.pieces.first
+
+      assert_equal 'One', m.pieces.first.name
+      assert_equal 42,    m.pieces.first.level
+
+      m = ModelWithCasting.find(1)
+      assert_instance_of ModelWithCasting::Thing, m.thing
+      assert_instance_of ModelWithCasting::Stuff, m.stuff
+      assert_equal 1, m.thing.value
+      assert_equal 1, m.stuff.values.first
+    end
+
+    should "provide easy access to deep hashes" do
+      m = ModelWithDeepHashes.create tree: { trunk: { branch: 'leaf' } }
+      assert_equal 'leaf', m.tree.trunk.branch
+
+      m = ModelWithDeepHashes.find(1)
+      assert_equal 'leaf', m.tree.trunk.branch
+    end
+
+  end
+
+  context "Defining properties in families" do
+
+    should "store properties in the 'data' family by default" do
+      m = ModelWithFamily.new name: 'One'
+      m.save
+
+      assert in_redis.exists('model_with_families:1'), in_redis.keys.to_s
+      assert in_redis.hkeys('model_with_families:1').include?('data')
+    end
+
+    should "store properties in the correct family" do
+      m = ModelWithFamily.new name: 'F', views: 100, visits: 10, lang: 'en'
+      m.save
+
+      assert_equal 1, m.id
+      assert in_redis.exists('model_with_families:1'), in_redis.keys.to_s
+      assert in_redis.hkeys('model_with_families:1').include?('data'),     in_redis.hkeys('model_with_families:1').to_s
+      assert in_redis.hkeys('model_with_families:1').include?('counters'), in_redis.hkeys('model_with_families:1').to_s
+
+      m = ModelWithFamily.find(1)
+      assert_not_nil m.name
+      assert_nil     m.views
+
+      m = ModelWithFamily.find(1, :families => ['counters', 'meta'])
+      assert_not_nil m.name
+      assert_not_nil m.views
+
+      assert_equal 'F',  m.name
+      assert_equal 10,   m.visits
+      assert_equal 'en', m.lang
+    end
+
+    should "cast the values" do
+      m = ModelWithCastingInFamily.create pieces: [ { name: 'One', level: 42 } ]
+      m.save
+
+      m = ModelWithCastingInFamily.find(1)
+      assert_equal [], m.pieces
+      assert_nil       m.pieces.first
+
+      m = ModelWithCastingInFamily.find(1, :families => 'meta')
+      assert_not_nil   m.pieces.first
+      assert_equal 42, m.pieces.first.level
+    end
+
+  end
+
+  context "Class" do
+
+    should "have properties" do
+      assert_equal ['id', 'title', 'created'], PersistentArticle.properties
+    end
+
+    should "have auto-incrementing counter" do
+      assert_equal 1, PersistentArticle.__next_id
+      assert_equal 2, PersistentArticle.__next_id
+    end
+
+    should "create new instance" do
+      a = PersistentArticle.create title: 'One'
+      assert          a.persisted?
+      assert_equal 1, a.id
+      assert in_redis.keys.size > 0, 'Key not saved into Redis?'
+    end
+
+    should "return one instance" do
+      a = PersistentArticle.create title: 'One'
+      a = PersistentArticle.find(1)
+      assert_equal 'One', a.title
+    end
+
+    should "return all instances" do
+      3.times { |i| PersistentArticle.create title: "#{i+1}" }
+      assert_equal 3,   PersistentArticle.all.size
+      assert_equal '3', PersistentArticle.all.last.title
+    end
+
+    should "return instances by IDs" do
+      10.times { |i| PersistentArticle.create title: "#{i+1}" }
+      assert_equal 10, PersistentArticle.all.size
+      articles = PersistentArticle.find [2, 5, 6]
+      assert_equal '2', articles[0].title
+      assert_equal '5', articles[1].title
+      assert_equal '6', articles[2].title
+    end
+
+    should "return instances in batches" do
+      runs = 0
+      100.times { |i| PersistentArticle.create title: "#{i+1}" }
+
+      PersistentArticle.find_each :batch_size => 10 do |article|
+        article.title += ' (touched)' and article.save
+        runs += 1
+      end
+
+      assert_equal 100, runs
+      assert_match /touched/, PersistentArticle.find(1).title
+    end
+
+  end
+
+  context "Instance" do
+
+    should "be inspectable" do
+      assert_nothing_raised do
+        assert_match /PersistentArticle/, PersistentArticle.new(id: 1, title: { some: { deep: 'Hash', :a => [1, 2, 3] } }).inspect
+      end
+    end
+
+    should "have attributes" do
+      assert_equal ['id', 'title', 'created'], PersistentArticle.new.attributes.keys
+    end
+
+    should "not persist by default" do
+      assert ! PersistentArticle.new.persisted?
+    end
+
+    should "be saved and found in Redis" do
+      article = PersistentArticle.new id: 1, title: 'One'
+      assert article.save
+      assert in_redis.exists("persistent_articles:1")
+
+      assert PersistentArticle.find(1)
+      assert in_redis.keys.size > 0, 'Key not saved into Redis?'
+      assert_equal 'One', PersistentArticle.find(1).title
+    end
+
+    should "be deleted from Redis" do
+      article = PersistentArticle.new id: 1, title: 'One'
+      assert article.save
+      assert_not_nil PersistentArticle.find(1)
+      assert in_redis.keys.size > 0, 'Key not saved into Redis?'
+
+      article.destroy
+      assert_nil PersistentArticle.find(1)
+      assert_equal 0, in_redis.keys.size, 'Key not removed from Redis?'
+    end
+
+    should "update attributes" do
+      a = PersistentArticle.new title: 'Old'
+      a.save
+
+      assert a.update_attributes title: 'New'
+
+      a = PersistentArticle.find(1)
+      assert_equal 'New', a.title
+    end
+
+    should "get auto-incrementing ID on save when none is passed" do
+      article = PersistentArticle.new title: 'One'
+
+      assert_nil article.id
+
+      assert article.save
+      assert_not_nil article.id
+
+      assert_equal 1, PersistentArticle.find(1).id
+      assert_equal 2, PersistentArticle.__next_id
+    end
+
+    should "fire before_save hooks" do
+      article = ModelWithCallbacks.new title: 'Hooks'
+      article.expects(:my_callback_method).twice
+
+      article.save
+    end
+
+    should "fire before_destroy hooks" do
+      article = ModelWithCallbacks.new title: 'Hooks'
+      article.save
+      article.destroy
+
+      assert_equal 'YEAH', article.instance_variable_get(:@hooked)
+    end
+
+    should "perform validations" do
+      m = ModelWithValidations.new
+
+      assert ! m.valid?
+      assert_equal 1, m.errors.to_a.size
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: redis-persistence
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Karel Minarik
+- Vojtech Hyza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70276358101260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70276358101260
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70276358100760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70276358100760
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70276358100300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70276358100300
+- !ruby/object:Gem::Dependency
+  name: hashr
+  requirement: &70276358099840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  type: :runtime
+  prerelease: false
+  version_requirements: *70276358099840
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70276358099380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276358099380
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70276358098920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70276358098920
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70276358098540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276358098540
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70276352583600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276352583600
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70276352974040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276352974040
+description: Simple ActiveModel-compatible persistence layer in Redis
+email:
+- karmi@karmi.cz
+- vhyza@vhyza.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- examples/article.rb
+- examples/benchmark.rb
+- examples/rails-template.rb
+- lib/redis/persistence.rb
+- lib/redis/persistence/version.rb
+- redis-persistence.gemspec
+- test/_helper.rb
+- test/active_model_lint_test.rb
+- test/models.rb
+- test/redis_persistence_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple ActiveModel-compatible persistence layer in Redis
+test_files:
+- test/_helper.rb
+- test/active_model_lint_test.rb
+- test/models.rb
+- test/redis_persistence_test.rb