rediline 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,3 @@
 .DS_Store
 .bundle/
-
+pkg/*

data/Gemfile

@@ -4,8 +4,12 @@ gem "redis", '2.0.7'
 gem "redis-namespace", '0.10.0'
 gem "json"
 gem "i18n"
-gem "activesupport", "~> 3.0.0"
-gem "activemodel", '~> 3.0.0'
+
+#
+# About the version required there, please see the "compatibility" section in the README
+#
+gem "activesupport", ">= 2"
+gem "activemodel",   "~> 3.0"
 
 group :development do
   gem "jeweler"

data/Gemfile.lock

@@ -50,8 +50,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activemodel (~> 3.0.0)
-  activesupport (~> 3.0.0)
+  activemodel (~> 3.0)
+  activesupport (>= 2)
   i18n
   jeweler
   json

data/README.md

@@ -3,6 +3,28 @@
 
 Rediline is a ruby library which intends to allow you to create timelines for your users in ruby.
 
+## Compatibility
+
+Rediling has been built with the idea to make it compatible with any other ORM possible.
+Whether your users and objects are in SQL, MongoDB, CouchDB or anything else, you should be able to use it.
+
+There are several requirements though.
+
+* The ORM should provide an ActiveModel::Calbacks similar API (most ORM depends of it anyway)
+* The ORM should provide a #find method to query the objects (if it does not, you can use [complex queries](http://github.com/dmathieu/rediline/wiki/Complex-queries-to-get-an-object) though).
+
+You should also be able to use Rediling in a non-rails application. Sinatra for example.
+There are be dependencies to ActiveSupport and ActiveModel though.
+
+### Rails 2 and Rails 3
+
+As we're using ActiveSupport (mainly for #constantize), there were some problems with the version of the gem we're using.
+
+Currently, ActiveSupport is required on a very permissive way (>= 2). That's intended to allow you to run rediline on a Rails2 application.
+
+Moreover, we're using ActiveModel for the callbacks. And it requires ActiveSupport 3.0.
+So for now, there's no dependency to ActiveModel. But you must know that you need your models to behave correctly with it in order to have rediline to work.
+
 ## Installation
 
 Add the following to your Gemfile :
@@ -49,7 +71,7 @@ And a "public" one, which will contain all the actions made by this user's frien
 
 You can retrieve a list's actions with the each method.
 
-    User.first.timeline.each(:egocentric) do |action|
+    User.first.timeline.limit(10).each(:egocentric) do |action|
         p action.inspect
     end
 
@@ -92,7 +114,7 @@ Rediline has a redis setter which can be given a string or a Redis object.
 This means if you're already using Redis in your app, Rediline can re-use the existing connection.
 
 String: `Rediline.redis = 'localhost:6379'`  
-Redis: `Resque.redis = $redis`
+Redis: `Rediline.redis = $redis`
 
 In a rails app, I have an initializer in `config/initializers/rediline.rb` where I load `config/rediline.yml` and set the redis information appropriately.
 

data/Rakefile

@@ -27,7 +27,12 @@ begin
     gemspec.add_dependency "redis-namespace", '0.10.0'
     gemspec.add_dependency "json"
     gemspec.add_dependency "i18n"
-    gemspec.add_dependency "activesupport", "3.0.0"
+    
+    #
+    # About the version required there, please see the "compatibility" section in the README
+    #
+    gemspec.add_dependency "activesupport", ">= 2"
+    #gemspec.add_dependency "activemodel",   "~> 3.0"
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rediline/entry.rb

@@ -4,10 +4,10 @@ require 'active_support/core_ext'
 module Rediline
   
   class Entry
-    attr_reader   :content
+    attr_reader   :content, :queries
     
-    def initialize(content)
-      @content = parse(content)
+    def initialize(content, queries={})
+      @content, @queries = parse(content), queries
       @objects = {}
     end
     
@@ -18,7 +18,7 @@ module Rediline
     def method_missing(name, *args)
       return content[name] if content.include?(name)
       if content.include?(:"#{name}_object") && content.include?(:"#{name}_object")
-        return @objects[name] ||= content[:"#{name}_object"].constantize.find(content[:"#{name}_id"])
+        return @objects[name] ||= find_query(name, content[:"#{name}_id"])
       end
       super
     end
@@ -33,12 +33,14 @@ module Rediline
     def parse(string)
       if string.is_a?(String)
         string = JSON.parse(string).symbolize_keys
+        string.delete :queries
         
         [:user_id, :user_object, :object_id, :object_object, :verb].each do |f|
           raise "invalid content : missing field #{f}" if string[f].nil?
         end
       else
         string.symbolize_keys!
+        string.delete :queries
         
         [:user, :object, :verb].each do |f|
           raise "invalid content : missing field #{f}" if string[f].nil?
@@ -61,5 +63,13 @@ module Rediline
       end
       string
     end
+    
+    def find_query(name, id)
+      if queries.nil? or queries[name].nil?
+        return content[:"#{name}_object"].constantize.find(id)
+      else
+        return queries[name].call(self, id)
+      end
+    end
   end
 end

data/lib/rediline/object.rb

@@ -26,7 +26,7 @@ module Rediline
         
         define_method "rediline_#{callback}" do
           if attrs.frozen?
-            entry = Rediline::Entry.new(attrs.dup)
+            entry = Rediline::Entry.new(attrs.dup, attrs[:queries])
           else
             attrs[:object] = self
             case attrs[:user]
@@ -38,7 +38,7 @@ module Rediline
                 attrs[:user] = send(:user)
             end
             attrs.freeze
-            entry = Rediline::Entry.new(attrs.dup)
+            entry = Rediline::Entry.new(attrs.dup, attrs[:queries])
           end
           
           entry.user.send(field_name).lists.each_pair do |k, v|

data/lib/rediline/timeline/user.rb

@@ -6,16 +6,24 @@ module Rediline
       def initialize(field_name, user, block)
         @field_name, @user, @block = field_name, user
         @lists = {}
+        @limit, @start_at = 10, 0
         instance_eval(&block)
       end
       
       def each(type)
         raise "you must provide a block" unless block_given?
-        (0..count(type)-1).each do |i|
+        (@start_at..@limit).each do |i|
           data = Rediline.redis.lindex(key(type), i)
+          next if data.nil?
           yield Rediline::Entry.new(data)
         end
       end
+      
+      def destroy
+        lists.each do |l|
+          Rediline.redis.del key(l)
+        end
+      end
 
       def to_a(type)
         result = Array.new
@@ -33,6 +41,16 @@ module Rediline
         @lists[name] = instance_eval(&block)
       end
       
+      def limit(count)
+        @limit = count
+        self
+      end
+      
+      def start_at(count)
+        @start_at = count
+        self
+      end
+      
       private
       def key(type)
         "#{field_name.to_s}:#{@user.class.to_s}.#{@user.id.to_s}:#{type}"

data/lib/rediline/user.rb

@@ -9,6 +9,11 @@ module Rediline
         define_method field_name.to_sym do
           Rediline::Timeline::User.new(field_name.to_sym, self, block)
         end
+        
+        private
+        define_method "delete_rediline_#{field_name}" do
+          send(field_name).destroy
+        end
       end
     end
   end

data/rediline.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rediline}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Damien MATHIEU"]
-  s.date = %q{2010-09-23}
+  s.date = %q{2010-09-29}
   s.description = %q{Timeline library}
   s.email = %q{42@dmathieu.com}
   s.extra_rdoc_files = [
@@ -70,20 +70,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<redis-namespace>, ["= 0.10.0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, ["= 3.0.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2"])
     else
       s.add_dependency(%q<redis>, ["= 2.0.7"])
       s.add_dependency(%q<redis-namespace>, ["= 0.10.0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<i18n>, [">= 0"])
-      s.add_dependency(%q<activesupport>, ["= 3.0.0"])
+      s.add_dependency(%q<activesupport>, [">= 2"])
     end
   else
     s.add_dependency(%q<redis>, ["= 2.0.7"])
     s.add_dependency(%q<redis-namespace>, ["= 0.10.0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<i18n>, [">= 0"])
-    s.add_dependency(%q<activesupport>, ["= 3.0.0"])
+    s.add_dependency(%q<activesupport>, [">= 2"])
   end
 end
 

data/spec/entry_spec.rb

@@ -37,6 +37,13 @@ describe Rediline::Entry do
         entry.content[o].should be_nil
       end
     end
+    
+    it 'should not store the queries parameter' do
+      c = valid_json
+      c[:queries] = {}
+      entry = Rediline::Entry.new c.to_json
+      entry.content[:queries].should be_nil
+    end
   end
   
   describe 'when initializing with a hash' do
@@ -76,6 +83,13 @@ describe Rediline::Entry do
       entry = Rediline::Entry.new c
       entry.second_object.should eql(42)
     end
+    
+    it 'should not store the queries parameter' do
+      c = valid_hash
+      c[:queries] = {}
+      entry = Rediline::Entry.new c
+      entry.content[:queries].should be_nil
+    end
   end
   
   describe 'creation date' do
@@ -107,6 +121,19 @@ describe Rediline::Entry do
     end
   end
   
+  describe 'queries' do
+    it 'should allow us to instantiate with a queries object' do
+      lambda do
+        Rediline::Entry.new valid_hash, { :object => lambda {|o, id| o.object.find(id) }}
+      end
+    end
+    
+    it 'should execute the specified query' do
+      entry = Rediline::Entry.new valid_hash, { :object => lambda {|o, id| TestingTimelineObject.new(7) }}
+      entry.object.id.should eql(7)
+    end
+  end
+  
   def valid_hash
     {
       :object => TestingTimelineObject.new(42),

data/spec/support/timeline.rb

@@ -10,6 +10,11 @@ class TestingTimelineObject
   rediline :timeline,
       :user => lambda {|o| o.user },
       :verb => :destroyed,
+      :queries => {
+        :object => lambda {|o, id|
+          TestingTimelineObject.new(id+1)
+        }
+      },
       :when => :before_destroy
   
   attr_reader   :id, :user

data/spec/support/user.rb

@@ -1,5 +1,8 @@
 class User
+  extend ActiveModel::Callbacks
+  define_model_callbacks :create, :destroy
   include Rediline::User
+  
   rediline :timeline do
     list :egocentric do
       [user]
@@ -17,4 +20,15 @@ class User
   def self.find(id)
     self.new(id)
   end
+  
+  def create
+    _run_create_callbacks do
+      # Your create action methods here
+    end
+  end
+  def destroy
+    _run_destroy_callbacks do
+      # Your destroy action methods here
+    end
+  end
 end

data/spec/timeline/user_spec.rb

@@ -37,6 +37,12 @@ describe Rediline::Timeline::User do
       end
     end
     
+    it 'should not fail if there are not enough entries' do
+      @timeline.limit(@timeline.count(:egocentric) + 1).each(:egocentric) do |entry|
+        entry.should be_kind_of(Rediline::Entry)
+      end
+    end
+    
     [:object, :user].each do |o|
       it "should not have any #{o} in it\'s values" do
         @timeline.each(:egocentric) do |entry|
@@ -46,6 +52,18 @@ describe Rediline::Timeline::User do
     end
   end
   
+  describe 'destroy' do
+    it 'should destroy all the user\'s lists keys' do
+      Rediline.redis.expects(:del).twice
+      @timeline.destroy
+    end
+    
+    it 'should destroy the timelines when destroying the user' do
+      Rediline.redis.expects(:del).twice
+      User.new(1).destroy
+    end
+  end
+  
   describe 'to_a' do
     it 'should return an array' do
       @timeline.to_a(:egocentric).should be_kind_of(Array)
@@ -68,4 +86,34 @@ describe Rediline::Timeline::User do
       @timeline.send(:key, :egocentric).should eql('timeline:User.1:egocentric')
     end
   end
+  
+  describe 'limit' do
+    it 'should default the limit to 10' do
+      @timeline.instance_eval('@limit').should eql(10)
+    end
+    
+    it 'should redefine the limit' do
+      @timeline.limit(20)
+      @timeline.instance_eval('@limit').should eql(20)
+    end
+    
+    it 'should return self' do
+      @timeline.limit(30).should eql(@timeline)
+    end
+  end
+  
+  describe 'start_at' do
+    it 'should default the start_at to 0' do
+      @timeline.instance_eval('@start_at').should eql(0)
+    end
+    
+    it 'should redefine the start_at' do
+      @timeline.start_at(20)
+      @timeline.instance_eval('@start_at').should eql(20)
+    end
+    
+    it 'should return self' do
+      @timeline.start_at(30).should eql(@timeline)
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Damien MATHIEU
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 +02:00
+date: 2010-09-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,13 +78,11 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 2
+        version: "2"
   type: :runtime
   prerelease: false
   version_requirements: *id005
@@ -137,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1586793397385962776
+      hash: 355954079675066628
       segments: 
       - 0
       version: "0"