redis-record 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_record.gemspec
+gemspec
+
+gem 'guard'
+  gem 'rb-inotify' if RUBY_PLATFORM.downcase.include?("linux")
+  gem 'rb-fsevent' if RUBY_PLATFORM.downcase.include?("darwin")
+gem 'guard-bundler'
+gem 'guard-rspec'
+gem 'rspec'

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Subhash Chandra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# RedisRecord
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_record'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_record
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/redis-record.rb

@@ -0,0 +1 @@
+require 'redis_record'

data/lib/redis_record.rb

@@ -0,0 +1,29 @@
+require 'active_attr'
+require 'active_support'
+require 'redis'
+
+class RedisRecord
+
+	Dir[File.expand_path("../redis_record/**/*.rb", __FILE__)].each {|f| require f}
+
+  include ActiveAttr::Model
+  include DataTypes
+  include Base
+  include Sorting
+  include Filters
+
+  @@REDIS = nil
+
+  def self.REDIS
+    @@REDIS
+  end
+  def self.REDIS=(client)
+    @@REDIS = client
+  end
+
+  class_attribute :defined_sorts, :defined_filters
+  self.defined_sorts = {id: nil}
+  self.defined_filters = {}
+
+  ActiveSupport.run_load_hooks :redis_record, self
+end

data/lib/redis_record/base.rb

@@ -0,0 +1,43 @@
+module RedisRecord::Base
+  extend ActiveSupport::Concern
+
+  included do
+    extend ActiveSupport::Callbacks
+
+    define_callbacks :save
+    define_callbacks :destroy
+    attr_accessor :persisted
+    attr_accessor :original_attributes
+  end
+
+  def save
+    success = nil
+    RedisRecord.REDIS.multi do
+      run_callbacks :save do
+        success = RedisRecord.REDIS.mapped_hmset(key, attributes)
+      end
+    end
+    self.persisted = (success.value == "OK")
+  end
+  alias save! save
+
+  def destroy
+    success = nil
+    RedisRecord.REDIS.multi do
+      run_callbacks :destroy do
+        success = RedisRecord.REDIS.del key
+      end
+    end
+    success.value == 1 ? self : nil
+  end
+  alias destroy! destroy
+
+  def update_attributes(attrs)
+    assign_attributes attrs
+    save
+  end
+
+  def key
+    self.class.key(id)
+  end
+end

data/lib/redis_record/base/class_methods.rb

@@ -0,0 +1,61 @@
+require 'active_support/core_ext/module/delegation'
+
+module RedisRecord::Base
+  module ClassMethods
+
+    def scoped(*args)
+      RedisScope.new self, *args
+    end
+
+    delegate :filter, :sort, :min, :max, :limit, :offset, :to => :scoped
+    delegate :all, :each, :map, :count, :first, :last, :to => :scoped
+
+    def create(*args)
+      new(*args).save
+    end
+
+    def find(id)
+      find_by_key key id
+    end
+
+
+    def find_or_initialize_by_id(id)
+      find(id) || self.new(:id => id)
+    end
+
+    def create_filter(name, &block)
+      self.defined_filters = self.defined_filters.merge name.to_sym => block
+    end
+
+    def sortable(name, &block)
+      self.defined_sorts = self.defined_sorts.merge name.to_sym => block
+    end
+
+    def values_for_filter(name)
+      RedisRecord.REDIS.zrange filter_key('_Values', name), 0, -1
+    end
+
+    def meta_key(attr)
+      ['Meta', model_name, attr].join ':'
+    end
+
+    def filter_key(name, value)
+      meta_key "Filter:#{name}:#{value}"
+    end
+
+    def key(id)
+      [model_name, id].join ':'
+    end
+
+  private
+    def find_by_key(key)
+      attributes = RedisRecord.REDIS.mapped_hmget(key, *attribute_names)
+      attributes['id'] && self.new(attributes).tap { |r|
+        r.persisted = true
+        r.original_attributes = attributes
+      }
+    end
+
+  end
+end
+

data/lib/redis_record/data_types.rb

@@ -0,0 +1,25 @@
+module RedisRecord::DataTypes
+  extend ActiveSupport::Concern
+  module ClassMethods
+    def create_initializer(type, klass, defaults = {})
+      define_singleton_method(type) do | *list, opts |
+        unless opts.is_a? Hash
+          list << opts
+          opts = {}
+        end
+        opts[:type] ||= klass
+
+        list.each do |attr|
+          attribute attr, defaults.merge(opts)
+        end
+      end
+    end
+  end
+
+  included do
+    [ :integer, :string, :date ].each { |klass| create_initializer klass, klass.to_s.classify.constantize }
+    create_initializer(:boolean, ActiveAttr::Typecasting::Boolean)  # TODO: Ugly hack
+    create_initializer(:datetime, DateTime)
+    create_initializer(:decimal, BigDecimal)
+  end
+end

data/lib/redis_record/filters.rb

@@ -0,0 +1,33 @@
+module RedisRecord::Filters
+  extend ActiveSupport::Concern
+
+  included do
+    set_callback :save, :after, :add_to_filter_lists
+    set_callback :save, :before, :remove_from_filter_lists
+    set_callback :destroy, :before, :remove_from_filter_lists
+  end
+
+protected
+  def filter_key(name, block)
+    value = block ? block.call(self) : self.send(name)
+    RedisRecord.REDIS.zincrby self.class.filter_key('_Values', name), 1, value
+    self.class.filter_key(name, value)
+  end
+
+private
+  def remove_from_filter_lists
+    return unless original_attributes
+
+    old_dog = self.class.new(original_attributes)
+    defined_filters.each do |name, block|
+      RedisRecord.REDIS.srem old_dog.filter_key(name, block), id
+    end
+  end
+
+  def add_to_filter_lists
+    defined_filters.each do |name, block|
+      RedisRecord.REDIS.sadd filter_key(name, block), id
+    end
+  end
+
+end

data/lib/redis_record/redis_scope.rb

@@ -0,0 +1,104 @@
+class RedisScope
+  DEFAULT_OPTIONS = {
+      offset:   0,
+      filters:  [],
+      sort:     :id,
+      min:      '-inf',
+      max:      '+inf'
+    }
+
+  def initialize(model, opts = {})
+    @model = model
+    @options = DEFAULT_OPTIONS.merge opts
+  end
+
+  # Modifiers
+  # always returns self
+
+  def filter(name, value=true)
+    raise NameError, ":#{name} isn't in the defined filters" unless @model.defined_filters.include? name
+    new_filters = @options[:filters] + [[name, value]]
+
+    chain_scope filters: new_filters
+  end
+
+  def sort(attr)
+    chain_scope sort: attr
+  end
+
+  def min(value)
+    chain_scope min: value
+  end
+
+  def max(value)
+    chain_scope max: value
+  end
+
+  def limit(n)
+    chain_scope limit: n
+  end
+
+  def offset(n)
+    chain_scope offset: n
+  end
+
+  # Executors
+  def count
+    apply_filters
+    total_records = RedisRecord.REDIS.zcard temp_key
+
+    remaining_records = total_records - @options[:offset]
+
+    if @options[:limit] and @options[:limit] < remaining_records
+      @options[:limit]
+    else
+      remaining_records
+    end
+  end
+
+  def all
+    ids.map {|id| @model.find id}
+  end
+  delegate :each, :map, to: :all
+  delegate :as_json, to: :all
+
+  def first
+    limit(1).all[0]
+  end
+
+  def last
+    offset(@options[:offset] + count - 1).limit(1).all[0]
+  end
+
+private
+  def chain_scope(opts = {})
+    self.class.new @model, @options.merge(opts)
+  end
+
+  def ids
+    apply_filters
+    RedisRecord.REDIS.zrangebyscore temp_key, @options[:min], @options[:max], limit: [@options[:offset], @options[:limit] || -1]
+  end
+
+  def apply_filters
+    filter_keys = @options[:filters].map do |name, value|
+      if value.is_a? Array
+        values = value
+        union_key = @model.filter_key "_Union:#{name}", values.join('_')
+        value_keys = values.map {|value| @model.filter_key name, value}
+        RedisRecord.REDIS.zunionstore union_key, value_keys
+        union_key
+      else
+        @model.filter_key name, value
+      end
+    end
+    key_sets = [@model.meta_key(@options[:sort])] + filter_keys
+    weights = [1] + [0] * @options[:filters].count
+    RedisRecord.REDIS.zinterstore temp_key, key_sets, weights: weights
+  end
+
+  def temp_key
+    @temp_key ||= @model.meta_key("_Temp:Filtered")
+  end
+
+end

data/lib/redis_record/sorting.rb

@@ -0,0 +1,30 @@
+module RedisRecord::Sorting
+  extend ActiveSupport::Concern
+
+  included do
+    set_callback :destroy, :after, :remove_from_sort_lists
+    set_callback :save, :after, :add_to_sort_lists
+  end
+
+protected
+  def add_to_sort_lists
+    defined_sorts.each do |name, block|
+      score = 0
+      if block
+        if block.respond_to? :call
+          score = block.call self
+        else
+          score = self.send block
+        end
+      end
+      RedisRecord.REDIS.zadd self.class.meta_key(name), score, id
+    end
+  end
+
+  def remove_from_sort_lists
+    defined_sorts.each do |name, _|
+      RedisRecord.REDIS.zrem self.class.meta_key(name), id
+    end
+  end
+
+end

data/lib/redis_record/version.rb

@@ -0,0 +1,3 @@
+class RedisRecord
+  VERSION = "0.0.1"
+end

data/redis-record.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redis_record/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Subhash Chandra"]
+  gem.email         = ["TMaYaD@LoonyB.in"]
+  gem.description   = %q{Active model interface for redis}
+  gem.summary       = %q{Active record like interface for redis without adding bloat}
+  gem.homepage      = "http://github.com/loonybin/redis_record"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "redis-record"
+  gem.require_paths = ["lib"]
+  gem.version       = RedisRecord::VERSION
+
+  gem.add_runtime_dependency 'active_attr'
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'redis'
+end

data/spec/fixtures/domain.rb

@@ -0,0 +1,26 @@
+class Domain < RedisRecord
+  attr_accessible :id
+  attr_accessible :hidden, :liked
+
+  string    :id # name
+  boolean   :hidden, :default => false
+  boolean   :liked, :default => false
+
+  create_filter :numbers do |domain|
+    !!domain.id.match(/[0-9]/)
+  end
+  create_filter :hyphenated do |domain|
+    !!domain.id.match(/-/)
+  end
+  create_filter :tld do |domain|
+    domain.id.split('.').last
+  end
+
+  create_filter :hidden
+  create_filter :liked
+
+  sortable :length do |domain|
+    domain.id.length
+  end
+
+end

data/spec/lib/domain_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'fixtures/domain'
+
+describe Domain do
+  before(:each) do
+    (0..4).each { |i| Domain.create id: "#{i}.com", status: 'Pre-release' }
+  end
+
+  it "should return all the records" do
+    Domain.count.should eq 5
+    Domain.all.map(&:id).should eq %w[0.com 1.com 2.com 3.com 4.com]
+  end
+
+  it "should return only 'limit' number of records" do
+    Domain.limit(2).all.map(&:id).should eq %w[0.com 1.com]
+  end
+
+  it "should return only records starting from 'offset'" do
+    Domain.offset(3).all.map(&:id).should eq %w[3.com 4.com]
+  end
+
+  it "should return only 'limit' records starting from 'offset'" do
+    Domain.offset(2).limit(2).all.map(&:id).should eq %w[2.com 3.com]
+
+    # in any order
+    Domain.limit(2).offset(2).all.map(&:id).should eq %w[2.com 3.com]
+  end
+
+  it "should not return more records than existing" do
+    Domain.offset(3).limit(3).all.map(&:id).should eq %w[3.com 4.com]
+  end
+
+  it "should not display hidden records" do
+    Domain.first.update_attributes hidden: true
+
+    Domain.filter(:hidden, false).count.should eq 4
+    Domain.filter(:hidden, false).all.map(&:id).should eq %w[1.com 2.com 3.com 4.com]
+  end
+
+end

data/spec/lib/redis_record/filters_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'fixtures/domain'
+
+describe Domain do
+  context "with filters" do
+    before(:each) do
+      ('a'..'b').each { |i| Domain.create id: "#{i}.com", status: 'Pre-release' }
+      ('5'..'6').each { |i| Domain.create id: "#{i}-.net", status: 'Pre-release' }
+      ('a'..'b').each { |i| Domain.create id: "#{i}.org", status: 'Pre-release' }
+    end
+
+    it "shouldn't allow undefined filters" do
+      expect{Domain.filter(:blah)}.to raise_error NameError
+    end
+
+    it "should return only records with the given filter applied" do
+      Domain.filter(:numbers).all.map(&:id).should eq %w[5-.net 6-.net]
+    end
+
+    it "should return only records matching all the filters" do
+      Domain.filter(:numbers).filter(:hyphenated).all.map(&:id).should eq %w[5-.net 6-.net]
+    end
+
+    it "should list out all the available values for a given filter" do
+      Domain.values_for_filter(:tld).should eq %w[com net org]
+    end
+
+    it "should return records with the filter matching a custom value" do
+      Domain.filter(:tld, 'net').map(&:id).should eq %w[5-.net 6-.net]
+    end
+
+    it "should return records with the filter matching any of the custom values" do
+      Domain.filter(:tld, ['net', 'org']).map(&:id).should eq %w[5-.net 6-.net a.org b.org]
+    end
+
+    it "should sort and select records even when filters are applied" do
+      (1..4).each {|i| Domain.create id: ('a' * i), status: 'Pre-release'}
+      Domain.filter(:numbers, false).sort(:length).min(2).max(4).map(&:id).should eq %w[aa aaa aaaa]
+    end
+
+    it "should allow defining filters on attributes without block" do
+      Domain.first.update_attributes hidden: true
+
+      Domain.filter(:hidden, false).count.should eq 5
+      Domain.filter(:hidden, false).all.map(&:id).should eq %w[6-.net a.com a.org b.com b.org]
+    end
+  end
+end

data/spec/lib/redis_record/sorting_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'fixtures/domain'
+
+describe Domain do
+  context 'with sorting' do
+    before(:each) do
+      (1..4).each {|i| Domain.create id: ('a' * i), status: 'Pre-release'}
+    end
+
+    it "should sort by given attribute" do
+      Domain.sort(:length).map(&:id).should eq %w[a aa aaa aaaa]
+    end
+
+    it "should filter for min and max on the sort" do
+      Domain.sort(:length).min(3).map(&:id).should eq %w[aaa aaaa]
+      Domain.sort(:length).max(4).map(&:id).should eq %w[a aa aaa aaaa]
+      Domain.sort(:length).min(2).max(4).map(&:id).should eq %w[aa aaa aaaa]
+    end
+  end
+end

data/spec/lib/redis_record_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'fixtures/domain'
+
+describe Domain do
+  before(:each) do
+    (0..4).each { |i| Domain.create id: "#{i}.com" }
+  end
+
+  it "should return all the records" do
+    Domain.count.should eq 5
+    Domain.all.map(&:id).should eq %w[0.com 1.com 2.com 3.com 4.com]
+  end
+
+  it "should return only 'limit' number of records" do
+    Domain.limit(2).all.map(&:id).should eq %w[0.com 1.com]
+  end
+
+  it "should return only records starting from 'offset'" do
+    Domain.offset(3).all.map(&:id).should eq %w[3.com 4.com]
+  end
+
+  it "should return only 'limit' records starting from 'offset'" do
+    Domain.offset(2).limit(2).all.map(&:id).should eq %w[2.com 3.com]
+
+    # in any order
+    Domain.limit(2).offset(2).all.map(&:id).should eq %w[2.com 3.com]
+  end
+
+  it "should not return more records than existing" do
+    Domain.offset(3).limit(3).all.map(&:id).should eq %w[3.com 4.com]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'redis_record'
+RedisRecord.REDIS ||= Redis.new db: 2
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/redis.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |c|
+  c.before(:each) do |example|
+    RedisRecord.REDIS.flushdb
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: redis-record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Subhash Chandra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Active model interface for redis
+email:
+- TMaYaD@LoonyB.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis-record.rb
+- lib/redis_record.rb
+- lib/redis_record/base.rb
+- lib/redis_record/base/class_methods.rb
+- lib/redis_record/data_types.rb
+- lib/redis_record/filters.rb
+- lib/redis_record/redis_scope.rb
+- lib/redis_record/sorting.rb
+- lib/redis_record/version.rb
+- redis-record.gemspec
+- spec/fixtures/domain.rb
+- spec/lib/domain_spec.rb
+- spec/lib/redis_record/filters_spec.rb
+- spec/lib/redis_record/sorting_spec.rb
+- spec/lib/redis_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/redis.rb
+homepage: http://github.com/loonybin/redis_record
+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.23
+signing_key: 
+specification_version: 3
+summary: Active record like interface for redis without adding bloat
+test_files:
+- spec/fixtures/domain.rb
+- spec/lib/domain_spec.rb
+- spec/lib/redis_record/filters_spec.rb
+- spec/lib/redis_record/sorting_spec.rb
+- spec/lib/redis_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/redis.rb