acts_as_caesar 0.0.4 → 0.0.5

data/README.textile

@@ -6,17 +6,19 @@ h1. Installation
 
 Simply add acts_as_caesar to your Gemfile
 
-<pre><code>gem 'acts_as_caesar'</code></pre>
+<pre><code>gem "acts_as_caesar"</code></pre>
 
 h2. Requirements
 
 You must have Redis server installed. We will seek to make the persistence layer database agnostic over time.
 
+Candidate objects (things that are being up/downvoted, e.g. comments) must be persisted using ActiveRecord or Mongoid
+
 You must have jQuery installed and JavaScript on the client-side is required.
 
 h2. Configuration
 
-Acts As Caesar will connect to Redis on localhost, port 6379 (default for Redis server), unless you override this by creating your own Redis connection using the code below (for Rails place this in @config/initializers/redis.rb@):
+Acts As Caesar expects a Redis connection to exist on the @$redis@ constant, if that's not set it will connect to Redis on localhost, port 6379 (default for Redis server). You can easily create your own Redis connection using the code below (for Rails place this in @config/initializers/redis.rb@):
 
 <pre><code>$redis = Redis.new(:host => 'localhost', :port => 6379)</code></pre>
 

data/lib/acts_as_caesar/modules/act_as_candidate.rb

@@ -1,26 +1,41 @@
 require 'acts_as_caesar/objects/candidate'
 require 'acts_as_caesar/objects/notification'
+require 'acts_as_caesar/services/active_record_persistence'
+require 'acts_as_caesar/services/mongoid_persistence'
 
 module ActsAsCaesar
   module ActAsCandidate
     def self.included(base)
       Notification.subscribe(key: /^#{base.name.downcase.gsub('::', '_')}\_[\da-f]+$/) do |candidate|
-        candidate.key =~ /\_([\da-f]+)$/ &&
-        base.find($1).update_total_candidate_score
+        handle_candidate_update_notification(base, candidate)
       end
     end
     
-    def as_candidate
-      @as_candidate = ActsAsCaesar::Candidate.new(self)
-    end
-    
-    def update_total_candidate_score
-      self.score = total_candidate_score
-      save!
+    def self.handle_candidate_update_notification(base, candidate)
+      # ensure we have an id
+      unless candidate.key =~ /\_([\da-f]+)$/ && id = $1
+        raise ArgumentError, "#{candidate.key} does not contain a valid key"
+      end
+
+      if ActiveRecordPersistence.can_handle?(base)
+        ActiveRecordPersistence.new(base, id).update_score
+      elsif MongoidPersistence.can_handle?(base)
+        MongoidPersistence.new(base, id).update_score
+      elsif base.respond_to?(:acts_as_caesar_score_persistence)
+        base.acts_as_caesar_score_persistence.new(base, id).update_score
+      else
+        raise StandardError, %Q(
+          Incompatible database adapter, try implementing the following method:
+          def self.acts_as_caesar_score_persistence
+            # returns a class name like lib/acts_as_caesar/services/mongoid_persistence.rb
+            # e.g. MongoidPersistence
+          end
+        )
+      end
     end
 
     def total_candidate_score
-      @total_candidate_score ||= as_candidate.total
+      ActsAsCaesar::Candidate.new(self).total
     end
   end
 end

data/lib/acts_as_caesar/services/active_record_persistence.rb

@@ -0,0 +1,23 @@
+module ActsAsCaesar
+  class ActiveRecordPersistence
+    class << self
+      def can_handle?(klass)
+        defined?(ActiveRecord) && defined?(ActiveRecord::Base) &&
+        (klass < ActiveRecord::Base)
+      end
+    end
+
+    def initialize(klass, id)
+      @klass = klass
+      @id = id
+    end
+
+    def update_score
+      candidate.update_attribute(:score, candidate.total_candidate_score)
+    end
+
+    def candidate
+      @candidate ||= @klass.find(@id)
+    end
+  end
+end

data/lib/acts_as_caesar/services/mongoid_persistence.rb

@@ -0,0 +1,52 @@
+module ActsAsCaesar
+  class MongoidPersistence
+    class << self
+      def can_handle?(klass)
+        defined?(Mongoid) && defined?(Mongoid::Document) &&
+        klass.included_modules.include?(Mongoid::Document)
+      end
+    end
+
+    def initialize(klass, id)
+      @klass = klass
+      @id = id
+    end
+
+    def update_score
+      puts "Updating score of #{candidate}"
+      candidate.update_attribute(:score, candidate.total_candidate_score)
+    end
+
+    def candidate
+      return @candidate if defined?(@candidate)
+      
+      relations = []
+      klass = @klass
+      
+      # loop back through nesting, appending relations
+      while (embedded_relations = klass.relations.select { |k,v| v.macro == :embedded_in }) && embedded_relations.size > 0
+        relation = embedded_relations.values.first
+        klass = relation.class_name.constantize
+        relations << relation.inverse_of
+      end
+      
+      # start at the root document
+      scope = klass
+      
+      # for each nested relation
+      while relation = relations.pop
+        key = relation.to_s
+        if relations.size > 0
+          key += "."
+          key += relations.reverse.join(".")
+        end
+        key += "._id"
+        # append the condition
+        scope = scope.where(key => BSON::ObjectId(@id)).first.send(relation)
+      end
+      
+      # find the final object
+      @candidate = scope.find(@id)
+    end
+  end
+end

data/lib/acts_as_caesar/version.rb

@@ -1,3 +1,3 @@
 module ActsAsCaesar
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/modules/act_as_candidate_spec.rb

@@ -1,9 +1,44 @@
-require_relative '../../lib/acts_as_caesar/modules/act_as_candidate'
-require_relative '../../lib/acts_as_caesar/objects/notification'
+require "mongoid"
+require_relative "../../lib/acts_as_caesar/modules/act_as_candidate"
+require_relative "../../lib/acts_as_caesar/objects/notification"
 
 class ActsAsCaesar::TestActAsCandidate
   attr_accessor :score
   include ActsAsCaesar::ActAsCandidate
+  
+  def key
+    "#{self.class.name}_abcdef1234567890"
+  end
+end
+
+class ActsAsCaesar::MongoTestActAsCandidate
+  include Mongoid::Document
+  include ActsAsCaesar::ActAsCandidate
+  
+  field :score, type: Integer
+  
+  embeds_many :nested_mongo_tests,
+    class_name: "ActsAsCaesar::NestedMongoTestActAsCandidate",
+    inverse_of: :mongo_test
+  
+  def key
+    "#{self.class.name}_#{id}"
+  end
+end
+
+class ActsAsCaesar::NestedMongoTestActAsCandidate
+  include Mongoid::Document
+  include ActsAsCaesar::ActAsCandidate
+  
+  field :score, type: Integer
+  
+  embedded_in :mongo_test,
+    class_name: "ActsAsCaesar::MongoTestActAsCandidate",
+    inverse_of: :nested_mongo_tests
+  
+  def key
+    "#{self.class.name}_#{id}"
+  end
 end
 
 describe ActsAsCaesar::ActAsCandidate do
@@ -26,18 +61,68 @@ describe ActsAsCaesar::ActAsCandidate do
   end
 
   context "when updating the score" do
-    before(:each) do
-      subject.should_receive(:total_candidate_score).and_return(987)
-      subject.should_receive(:save!).and_return(true)
+    context "of an ActiveRecord object" do
+      before(:each) do
+        ActsAsCaesar::ActiveRecordPersistence.should_receive(:can_handle?).and_return(true)
+        ActsAsCaesar::ActiveRecordPersistence.any_instance.should_receive(:candidate).any_number_of_times.and_return(subject)
+        subject.should_receive(:total_candidate_score).and_return(987)
+        subject.should_receive(:update_attribute).with(:score, 987).and_return(true)
+      end
+      
+      it "should persist the score" do
+        ActsAsCaesar::ActAsCandidate.handle_candidate_update_notification(subject.class, subject)
+      end
     end
     
-    it "should set the score to the total candidate score" do
-      subject.update_total_candidate_score
-      subject.score.should == 987
+    context "of a Mongoid object" do
+      before(:each) do
+        ActsAsCaesar::MongoidPersistence.should_receive(:can_handle?).and_return(true)
+        ActsAsCaesar::MongoidPersistence.any_instance.should_receive(:candidate).any_number_of_times.and_return(subject)
+        subject.should_receive(:total_candidate_score).and_return(987)
+        subject.should_receive(:update_attribute).with(:score, 987).and_return(true)
+      end
+      
+      it "should persist the score" do
+        ActsAsCaesar::ActAsCandidate.handle_candidate_update_notification(subject.class, subject)
+      end
     end
+    
+    context "of a nested Mongoid object" do
+      subject do
+        parent = ActsAsCaesar::MongoTestActAsCandidate.create!
+        parent.nested_mongo_tests.create!
+      end
 
-    it "should return true" do
-      subject.update_total_candidate_score.should == true
+      before(:each) do
+        ActsAsCaesar::NestedMongoTestActAsCandidate.any_instance.should_receive(:total_candidate_score).and_return(987)
+        ActsAsCaesar::NestedMongoTestActAsCandidate.any_instance.should_receive(:update_attribute).once.with(:score, 987).and_return(true)
+      end
+      
+      it "should persist the score" do
+        ActsAsCaesar::ActAsCandidate.handle_candidate_update_notification(subject.class, subject)
+      end
+    end
+    
+    context "of an object with custom AAC support" do
+      class CustomPersister < Struct.new(:klass, :id); end
+      
+      before(:each) do
+        subject.class.should_receive(:respond_to?).with(:acts_as_caesar_score_persistence).and_return(true)
+        subject.class.should_receive(:acts_as_caesar_score_persistence).and_return(CustomPersister)
+        CustomPersister.any_instance.should_receive(:update_score).and_return(true)
+      end
+
+      it "should call the custom class" do
+        ActsAsCaesar::ActAsCandidate.handle_candidate_update_notification(subject.class, subject).should be_true
+      end
+    end
+    
+    context "of an object without custom AAC support" do
+      it "should raise an error" do
+        lambda do
+          ActsAsCaesar::ActAsCandidate.handle_candidate_update_notification(subject.class, subject)
+        end.should raise_error
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_caesar
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -244,6 +244,8 @@ files:
 - lib/acts_as_caesar/rack.rb
 - lib/acts_as_caesar/rails/engine.rb
 - lib/acts_as_caesar/rails/view_helpers.rb
+- lib/acts_as_caesar/services/active_record_persistence.rb
+- lib/acts_as_caesar/services/mongoid_persistence.rb
 - lib/acts_as_caesar/version.rb
 - spec/assets/jasmine_helper.js.coffee
 - spec/assets/jquery_helper.js.coffee