redis-column 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/config/database.yml
+*.log
+*.sqlite3

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@redis_column

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+RedisColumn
+===========
+
+Seamlessly extend your AR model with Redis
+
+The RedisColumn gem allows for the seamless integration of Redis within your ActiveRecord model in order to store heavy objects away from tables with a lot of rows.
+
+Installation
+------------
+
+    gem install redis-column
+  
+Usage
+-----
+
+Within an initializer:
+
+    RedisColumn.config = YAML.load_file(Rails.root.join('config/redis.yml'))[:development]
+
+  
+Within your model:
+
+    class Page < ActiveRecord::Base
+      redis_column :body
+    end
+
+    
+    

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis-column/version.rb

@@ -0,0 +1,3 @@
+module RedisColumn
+  VERSION = "0.0.1"
+end

data/lib/redis-column.rb

@@ -0,0 +1,92 @@
+require "active_record"
+require "redis"
+require File.dirname(__FILE__) + "/redis-column/version"
+
+module RedisColumn
+  
+  # Returns the current Redis configuration
+  def self.config
+    @@config ||= {}
+  end
+  
+  # Sets the Redis configuration
+  def self.config= hash
+    @@config = hash 
+  end
+  
+  # Active Redis connection
+  def self.redis_instance
+    @@redis_instance ||= Redis.new(config)
+  end
+  
+  module Record
+    extend ActiveSupport::Concern
+
+    included do
+      # Set up the class attribute that must be available to all subclasses.
+      class_attribute :redis_columns
+      self.redis_columns = []
+      # Allow the instance access to this class attributes
+      delegate :redis_columns, :to => "self.class"
+      # Allow the instance access to RedisColumn.redis_instance
+      delegate :redis_instance, :to => "RedisColumn"
+      # Save the columns after 
+      after_save :save_redis_columns!
+      # Boosh!
+      alias_method_chain :attributes, :redis_columns
+    end
+
+    module ClassMethods
+      
+      # Setup a redis column
+      def redis_column column_name
+        self.redis_columns += [column_name]
+        attr_writer column_name
+        define_method column_name do # read the attribute or find from Redis and set to instance var
+          send(:instance_variable_get, "@#{column_name}") || send("#{column_name}=", read_redis_attribute(column_name))
+        end
+      end
+      alias_method :redis_col, :redis_column
+      
+    end
+    
+    module InstanceMethods
+      
+      # Returns the key to be used in Redis
+      def redis_key column_name
+        "#{self.class.model_name.i18n_key}:#{self.id}:#{column_name}"
+      end
+      
+      # Read from Redis and unserialise
+      def read_redis_attribute column_name
+        val = redis_instance.get(redis_key(column_name))
+        YAML.load(val) unless val.nil?
+      end
+      
+      # Serialise and write to Redis
+      def write_redis_attribute column_name, val
+        redis_instance.set(redis_key(column_name), val.to_yaml) and return val
+      end
+      
+      # Returns both the AR attributes and the Redis attributes in one hash
+      def attributes_with_redis_columns
+        _attributes = attributes_without_redis_columns.with_indifferent_access
+        redis_columns.inject(_attributes) do |res, column_name|
+          res.merge(column_name => send(column_name))
+        end
+      end
+      
+      # Save all values back to Redis
+      def save_redis_columns!
+        redis_columns.each do |column_name|
+          write_redis_attribute column_name, send(column_name)
+        end
+      end
+      
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, RedisColumn::Record
+end

data/redis-column.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis-column/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redis-column"
+  s.version     = RedisColumn::VERSION
+  s.authors     = ["Alex Neill"]
+  s.email       = ["alex.neill@gmail.com"]
+  s.homepage    = "https://github.com/ajn/redis-column"
+  s.summary     = %q{Seamlessly extend your AR model with Redis}
+  s.description = %q{The RedisColumn gem allows for the seamless integration of Redis within your ActiveRecord model in order to store heavy objects away from tables with a lot of rows.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord"
+  s.add_dependency "redis"
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "fakeredis"
+end

data/spec/config/database.yml.sample

@@ -0,0 +1,19 @@
+sqlite3:
+  adapter: sqlite3
+  database: redis_column.sqlite3
+
+mysql:
+  adapter: mysql2
+  hostname: localhost
+  username: root
+  password:
+  database: redis_column
+  charset: utf8
+  
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: redis_column
+  encoding: utf8

data/spec/config/models.rb

@@ -0,0 +1,6 @@
+class TestModel < ActiveRecord::Base; end
+
+class DescriptionInRedisModel < TestModel
+  redis_col :description
+end
+

data/spec/config/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "test_models", :force => true do |t|
+    t.integer  "integer"
+    t.datetime "created_at"
+    t.string   "type", :default => 'TestModel'
+    t.string   "string"
+  end
+
+  add_index "test_models", ["integer"], :name => "index_test_models_on_integer"
+  add_index "test_models", ["created_at"], :name => "index_test_models_on_created_at"
+  add_index "test_models", ["type"], :name => "index_test_models_on_type"
+end

data/spec/redis_column_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe TestModel do
+  it { TestModel.should respond_to(:redis_column) }
+  it { TestModel.should respond_to(:redis_col) }
+  it { TestModel.should respond_to(:redis_columns) }
+  
+  describe 'redis_column' do
+    context 'with no arguments' do
+      it "should raise an argument error" do
+        lambda { TestModel.redis_column }.should raise_error(ArgumentError)
+      end
+    end
+    
+    context "with a column_name" do
+      it "should add the column_name to the redis_columns array" do
+        TestModel.redis_columns.should == []
+        TestModel.redis_column :body
+        TestModel.redis_columns.should == [:body]
+      end
+      
+      it "should add an accessor for the column_name" do
+        TestModel.redis_column :body
+        TestModel.new.should respond_to(:body)
+        TestModel.new.should respond_to(:body=)
+      end
+    end
+  end
+end
+
+describe DescriptionInRedisModel do
+  it "should have a redis_column for the description attribute" do
+    DescriptionInRedisModel.redis_columns.should == [:description]
+  end
+  
+  it "should have a default redis key of '<model_name>:<id>:<column_name>' for the description attribute" do
+    instance = DescriptionInRedisModel.create
+    instance.redis_key(:description).should == "description_in_redis_model:#{instance.id}:description"
+  end
+  
+  context "before save" do
+    it "should not have stored the description in redis" do
+      instance = DescriptionInRedisModel.new(description: "A looong description")
+      RedisColumn.redis_instance.get("description_in_redis_model:#{instance.id}:description").should_not be("A looong description".to_yaml)
+    end
+  end
+  
+  context "when saving" do
+    it "should store the description in redis, with the key '<model_name>:<id>:<column_name>'" do
+      instance = DescriptionInRedisModel.create!(description: "A looong description")
+      RedisColumn.redis_instance.get("description_in_redis_model:#{instance.id}:description").should == "A looong description".to_yaml
+    end
+  end
+  
+  context "when saved" do
+    it "should retrive the description from redis, with the key '<model_name>:<id>:<column_name>'" do
+      instance = DescriptionInRedisModel.create!(description: "A looong description")
+      instance = DescriptionInRedisModel.find(instance.id)
+      instance.description.should == "A looong description"
+    end
+    
+    it "should return the redis_columns within :attributes" do
+      instance = DescriptionInRedisModel.create!(string: "A string", description: "A looong description")
+      instance.attributes.should have_key('string')
+      instance.attributes.should have_key('description')
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+require 'logger'
+
+begin
+  require "rubygems"
+  require "bundler"
+
+  if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.5")
+    raise RuntimeError, "Your bundler version is too old." +
+     "Run `gem install bundler` to upgrade."
+  end
+
+  # Set up load paths for all bundled gems
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run \`bundlee install\`?"
+end
+
+Bundler.require
+require File.expand_path('../../lib/redis-column', __FILE__)
+require "fakeredis"
+db_name = ENV['DB'] || 'sqlite3'
+database_yml = File.expand_path('../config/database.yml', __FILE__)
+
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)
+  
+  ActiveRecord::Base.configurations = active_record_configuration
+  config = ActiveRecord::Base.configurations[db_name]
+  
+  begin
+    ActiveRecord::Base.establish_connection(db_name)
+    ActiveRecord::Base.connection
+  rescue
+    case db_name
+    when /mysql/      
+      ActiveRecord::Base.establish_connection(config.merge('database' => nil))
+      ActiveRecord::Base.connection.create_database(config['database'],  {:charset => 'utf8', :collation => 'utf8_unicode_ci'})
+    when 'postgresql'
+      ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+      ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => 'utf8'))
+    end
+    
+    ActiveRecord::Base.establish_connection(config)
+  end
+    
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  ActiveRecord::Base.default_timezone = :utc
+  
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+    
+    load(File.dirname(__FILE__) + '/config/schema.rb')
+    load(File.dirname(__FILE__) + '/config/models.rb')
+  end
+  
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end
+
+def clean_database!
+  ActiveRecord::Base.connection.execute "DELETE FROM test_models"
+end
+
+clean_database!

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: redis-column
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Neill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2152025520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152025520
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2152025060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152025060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152024300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152024300
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &2152023600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152023600
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2152022840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152022840
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: &2152022260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152022260
+description: The RedisColumn gem allows for the seamless integration of Redis within
+  your ActiveRecord model in order to store heavy objects away from tables with a
+  lot of rows.
+email:
+- alex.neill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/redis-column.rb
+- lib/redis-column/version.rb
+- redis-column.gemspec
+- spec/config/database.yml.sample
+- spec/config/models.rb
+- spec/config/schema.rb
+- spec/redis_column_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ajn/redis-column
+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: Seamlessly extend your AR model with Redis
+test_files: []