redis_storage 0.2.3

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1,9 @@
+#rvm use rbx-2.0.0pre@redisrecord --create
+#export RBXOPT=-Xrbc.db=$HOME/.rbx
+rvm use ree@redisrecord --create
+
+if ! command -v bundle ; then
+  gem install bundler
+fi
+# Bundle while redcing excess noise.
+bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in redis_record.gemspec
+gemspec
+
+group :development do
+  # irb stuff
+  gem 'wirble'
+  gem 'hirb'
+  gem 'awesome_print'
+  gem 'bond'
+  gem 'sketches'
+end

data/README

@@ -0,0 +1,82 @@
+RedisStorage
+---
+
+* some kind of database mapper for redis on rails
+* uses ActiveModel to provide things like validations
+* provides a Rails 3 Generator
+
+Installation
+---
+
+As this gem need redis running you will have to install it(see redis.io for more information on that task)
+
+Then just add the gem to your Gemfile and run bundler
+
+    gem 'redis_storage'
+
+or just install it manually
+
+    gem install redis_storage
+
+Then this gem will need a global object $db which just is a Redis connection.
+
+    redis_config = { :host => 'localhost', :port => 6379, :password => '', :db => 1 }
+    $db = Redis.new(redis_config)
+
+Usage
+---
+
+require the gem in your code
+
+    require 'redis_storage'
+
+create a model which inherit from RedisStorage::Model
+
+    class MyModel < RedisStorage::Model
+    ...
+    end
+
+and define the models attributes via self.attrs, additional to the defined attributes there will always be an attribute id
+
+    def self.attrs
+      [:body, :title]
+    end
+    attr_accessor *attrs
+
+Minimal Example
+---
+
+    require 'redis_storage'
+    class MyModel < RedisStorage::Model
+      def self.attrs
+        [:body, :title]
+      end
+      attr_accessor *attrs
+    end
+
+Rails 3 Integration
+---
+
+to initialize redis there is a rake task
+
+    rake install_redis
+
+The task will install a initializer file which creates the above mentioned $db object and a redis.yml file to configure the redis connection.
+
+There is also a Rails 3 Generator which will generates the above mentioned model
+
+    rails g redis model attr1 attr2
+
+or
+
+    rails g scaffold model attr1:string attr2:int -o redis
+
+meta
+---
+
+Inspired by
+
+* some ideas from the redis backend in [scanty-redis](https://github.com/adamwiggins/scanty-redis)
+* various small sinatra projects from myself which use a pre version of this gem
+
+sch1zo

data/Rakefile

@@ -0,0 +1,9 @@
+include Rake::DSL
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/generators/rails/redis_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module Rails
+  module Generators
+    class RedisGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../../templates', __FILE__)
+      argument :attrs, :type => :array, :default => [], :banner => "field field"
+      check_class_collision
+      desc "This generator creates an model for redis"
+
+      def create_model_file
+        template 'model.rb', File.join('app/models',class_path,"#{file_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,6 @@
+class <%= class_name %> < RedisStorage::Model
+  def self.attrs
+    [ :id<%=", :" unless attrs.empty?%><%= attrs.map{|e| e.split(':')[0]}.join(', :') %> ]
+  end
+  attr_accessor *attrs
+end

data/lib/redis_storage/railtie.rb

@@ -0,0 +1,13 @@
+require 'redis_storage'
+module RedisStorage
+  class Railtie <::Rails::Railtie
+    rake_tasks do
+      load "tasks/redis_storage.rake"
+    end
+    #if ::Rails.version.to_f >= 3.1
+    #  config.app_generators.orm :redis
+    #else
+    #  config.generators.orm :redis
+    #end
+  end
+end

data/lib/redis_storage/version.rb

@@ -0,0 +1,3 @@
+module RedisStorage
+  VERSION = "0.2.3"
+end

data/lib/redis_storage.rb

@@ -0,0 +1,124 @@
+require 'json'
+require 'active_model'
+
+module RedisStorage
+  require 'redis_storage/railtie' if defined?(Rails)
+
+  class Model
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    validates_presence_of :id
+
+    def self.attrs
+      []
+    end
+
+    attr_accessor *attrs
+    attr_accessor :id
+    attr_reader :errors
+
+    def self.build(params)
+      new params
+    end
+
+    def self.create(params)
+      obj = build params
+      obj.save
+      obj
+    end
+
+    def self.find(params=nil)
+      return find_by_id(params) unless params.nil?   #TODO perhaps make this at some point more generic
+      return all
+    end
+    def self.find_by_id(entry_id)
+      r = $db.get("#{db_key}:#{entry_id}")
+      new(JSON.parse(r)) unless r.nil?
+    end
+
+    def self.all
+      keys = $db.smembers("#{db_key}:persisted").map do |i|
+        "#{db_key}:#{i}"
+      end
+
+      if keys.empty?
+        []
+      else
+        $db.mget(*keys).inject([]) do |a,json|
+          a << new(JSON.parse(json))
+        end
+      end
+    end
+
+    def serializable_hash
+      self.class.attrs.inject({:id => @id}) do |a,key|
+        a[key] = send(key)
+        a
+      end
+    end
+    def to_json
+      serializable_hash.to_json
+    end
+
+    def update_attributes(params)
+      params.each do |key, value|
+        send("#{key}=", value) unless key.to_sym == :id
+      end
+      save
+    end
+    def save
+      unless persisted?
+        @id = $db.incr("#{db_key}:nextid")
+      end
+      if valid?
+        $db.multi do
+          $db.set db_key, serializable_hash.to_json
+          $db.sadd "#{self.class.db_key}:persisted", id
+        end
+        @id
+      else
+        nil
+      end
+    end
+
+    def destroy
+      delete!     #for the default rails controller
+    end
+    def delete!
+      if persisted?
+        $db.multi do
+          $db.del db_key
+          $db.srem "#{self.class.db_key}:persisted", id
+        end
+        true
+      else
+        false
+      end
+    end
+
+    def persisted?
+      if id.nil?
+        false
+      else
+        $db.sismember("#{self.class.db_key}:persisted", id)
+      end
+    end
+
+    def self.db_key
+      model_name.downcase
+    end
+    def db_key
+      "#{self.class.db_key}:#{self.id}"
+    end
+
+    def initialize(params={})
+      @id = nil
+      @errors = ActiveModel::Errors.new(self)
+      params.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/tasks/redis_storage.rake

@@ -0,0 +1,31 @@
+desc "copies an initializer for redis into the app"
+task :install_redis do
+  init= <<-INIT
+require 'redis'
+c = YAML.load_file("\#{::Rails.root.to_s}/config/redis.yml")[::Rails.env]
+redis_config = { :host => c['host'], :port => c['port'], :password => c['password'], :db => c['db'] }
+
+$db = Redis.new(redis_config)
+  INIT
+  yml= <<-YAML
+development:
+  host: "localhost"
+  port: 6379
+  password:
+  db: 3
+test:
+  host: "localhost"
+  port: 6379
+  password:
+  path: 12
+productive:
+  host: "localhost"
+  port: 6379
+  password:
+  path: 1
+  YAML
+  p "create  config/initializers/redis.rb"
+  File.open('config/initializers/redis.rb', 'w') {|f| f.write(init) }
+  p "create  config/redis.yml"
+  File.open('config/redis.yml', 'w') {|f| f.write(yml) }
+end

data/redis_storage.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis_storage/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redis_storage"
+  s.version     = RedisStorage::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andreas Eger"]
+  s.email       = ["dev@eger-andreas.de"]
+  s.homepage    = "https://github.com/sch1zo/redis_storage"
+  s.summary     = %q{A simple Redis ORM for Rails}
+  s.description = %q{Provides a databackend for a Redis in Rails, will also provide a Rails 3 Generator}
+
+  s.add_dependency 'redis'
+  s.add_dependency 'json'
+  s.add_dependency 'activemodel', '>= 3.0.0'
+
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'autotest'
+  s.add_development_dependency 'redis'
+  s.add_development_dependency 'rails', '>= 3.0.0'
+
+  s.rubyforge_project = "redis_storage"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/model_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+class MockModel < RedisStorage::Model
+  def self.attrs
+    [:body, :title]
+  end
+  attr_accessor *attrs
+end
+
+describe RedisStorage::Model do
+  it_should_behave_like "ActiveModel"
+  let(:modelhash) do
+    {'body'=>"Lorem Ipsum", 'title' => "some test"}
+  end
+
+  context 'class' do
+    it 'should have a db_key with the name of the class' do
+      MockModel.db_key.should eq('mockmodel')
+    end
+    context '#build' do
+      it 'should simply call new on MockModel' do
+        MockModel.expects(:new)
+        MockModel.build modelhash
+      end
+      it 'should create accessors for all hash key/value pairs' do
+        model = MockModel.build modelhash
+        model.body.should == modelhash['body']
+        model.title.should == modelhash['title']
+      end
+    end
+    context '#create' do
+      before(:each) do
+        @model = MockModel.build modelhash
+      end
+      it 'should call new to create the accessors' do
+        MockModel.expects(:build).returns(@model)
+        MockModel.create modelhash
+      end
+      it 'should call save to save the record' do
+        @model.expects(:save)
+        MockModel.stubs(:build).returns(@model)
+        MockModel.create modelhash
+      end
+    end
+    context '#find' do
+      let(:h) do
+        [ {'body' =>"Lorem Ipsum", 'title' => "first test"},
+          {'body' =>"Dolor Sit", 'title' => "second test"},
+          {'body' =>"Amet consetetur", 'title' => "third test"},
+          {'body' =>"sadipscing elitr", 'title' => "forth test"}]
+      end
+      before(:each) do
+        h.each do |e|
+          MockModel.create e
+        end
+      end
+      it 'should call .all if .find is called with no parama' do
+        MockModel.expects(:all)
+        MockModel.find
+      end
+      it 'should push the given Params from .find to .find_by_id' do
+        MockModel.expects(:find_by_id).with(3)
+        MockModel.find(3)
+      end
+      context '#find_by_id' do
+        1.upto(4) do |i|
+          it "should find record #{i} and create a new instance" do
+            record = MockModel.find_by_id(i)
+            record.id.should == i
+            record.body.should == h[i-1]['body']
+            record.title.should == h[i-1]['title']
+          end
+        end
+      end
+      context '#all' do
+        it 'should return an empty array if there are no entries' do
+          Redis.any_instance.stubs(:smembers => [])
+          records = MockModel.all
+          records.should eq([])
+        end
+        it 'should return all entries' do
+          records = MockModel.all
+          records.size.should eq(4)
+        end
+        it 'should return an Array with all entries' do
+          records = MockModel.all
+          records.each do |m|
+            i = m.id
+            m.body.should eq(h[i-1]['body'])
+            m.title.should eq(h[i-1]['title'])
+          end
+        end
+      end
+    end
+  end
+
+  context 'instance' do
+    let(:model) do
+      model = MockModel.build modelhash
+    end
+    context '#persisted?' do
+      it 'should be false if it did not get saved yet' do
+        model.persisted?.should be_false
+      end
+      it 'should be true if the model got saved' do
+        model.save
+        model.persisted?.should be_true
+      end
+    end
+    context '#save' do
+      it 'should be valid to save the model' do
+        model.stubs(:valid? => true)
+        model.save.should_not be_nil
+      end
+      it 'should not save the model if its invalid' do
+        model.stubs(:valid? => false)
+        model.save.should be_nil
+      end
+      it 'should create a redis entry' do
+        id = model.save
+        JSON.parse($db.get("mockmodel:#{id}")).should == modelhash.merge('id'=>id)
+      end
+      it 'should add the id to the persisted set in redis' do
+        id = model.save
+        $db.sismember("mockmodel:persisted", id).should be_true
+      end
+    end
+    context '#update_attributes' do
+      it 'should take the given hash to update the attributes' do
+        model.update_attributes({:body => 'updated body'})
+        model.body.should eq('updated body')
+      end
+      it 'should call save' do
+        model.expects(:save=>1)
+        model.update_attributes({:body => 'updated body'})
+      end
+    end
+    context '#delete!' do
+      it 'should return false if the object is not persisted' do
+        model.stubs(:persisted? => false)
+        model.delete!.should be_false
+      end
+      it 'should return true if the object was persisted' do
+        model.stubs(:persisted? => true)
+        model.delete!.should be_true
+      end
+      it 'should remove the key from redis' do
+        id=model.save
+        model.delete!
+        $db.get("mockmodel:#{id}").should be_nil
+      end
+      it 'should remove the id from the persisted set in redis' do
+        id=model.save
+        model.delete!
+        $db.sismember("mockmodel:persisted", id).should be_false
+      end
+    end
+
+    #context '#dirty' do
+    #  it 'should be true till first saved' do
+    #    model.changed?.should be_true
+    #  end
+    #  it 'should be false after saving' do
+    #    model.save
+    #    model.changed?.should be_false
+    #  end
+    #  it 'should be true if something got changed since last save' do
+    #    model.save
+    #    model.changed?.should be_false
+    #    model.body = 'lorem ipsum'
+    #    model.changed?.should be_true
+    #  end
+    #end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'lib/redis_storage' # and any other gems you need
+require 'redis'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.before(:all) do
+    $db = Redis.new({})
+  end
+  config.before(:each) do
+    $db.select 12
+    $db.flushdb
+  end
+end
+
+shared_examples_for "ActiveModel" do
+  require 'test/unit/assertions'
+  require 'active_model/lint'
+  include Test::Unit::Assertions
+  include ActiveModel::Lint::Tests
+
+  # to_s is to support ruby-1.9
+  ActiveModel::Lint::Tests.public_instance_methods.map{|m| m.to_s}.grep(/^test/).each do |m|
+    example m.gsub('_',' ') do
+      send m
+    end
+  end
+
+  def model
+    subject
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'bundler'
+Bundler.setup
+
+require 'lib/generators/rails/redis_generator'
+
+class RedisGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+  tests ::Rails::Generators::RedisGenerator
+
+  test 'should create a model file with a few basic lines' do
+    run_generator %w(Schedule title body created_at)
+    assert_file 'app/models/schedule.rb', /class Schedule < RedisStorage::Model/
+    assert_file 'app/models/schedule.rb', /attr_accessor \*attrs/
+  end
+  test 'should set the classes attrs' do
+    run_generator %w(Schedule title body created_at)
+    assert_file 'app/models/schedule.rb' do |model|
+      assert_class_method :attrs, model do |attrs|
+        assert_match /[ :id, :title, :body, :created_at ]/, attrs
+      end
+    end
+  end
+  test 'should set id as only class attribute if none given' do
+    run_generator %w(Schedule title body)
+    assert_file 'app/models/schedule.rb' do |model|
+      assert_class_method :attrs, model do |attrs|
+        assert_match /[ :title, :body ]/, attrs
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification 
+name: redis_storage
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 3
+  version: 0.2.3
+platform: ruby
+authors: 
+- Andreas Eger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id008
+description: Provides a databackend for a Redis in Rails, will also provide a Rails 3 Generator
+email: 
+- dev@eger-andreas.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- lib/generators/rails/redis_generator.rb
+- lib/generators/templates/model.rb
+- lib/redis_storage.rb
+- lib/redis_storage/railtie.rb
+- lib/redis_storage/version.rb
+- lib/tasks/redis_storage.rake
+- redis_storage.gemspec
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- test/generator_test.rb
+homepage: https://github.com/sch1zo/redis_storage
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: redis_storage
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A simple Redis ORM for Rails
+test_files: []
+