acts_as_caesar 0.0.1

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# testing
+coverage
+spec/javascripts/compiled
+spec/javascripts/*.js
+
+# dummy project
+spec/dummy/log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/.DS_Store
+spec/dummy/*/.DS_Store
+spec/dummy/*/*/.DS_Store
+spec/dummy/*/*/*/.DS_Store
+spec/dummy/*/*/*/*/.DS_Store
+spec/dummy/test
+spec/dummy/tmp
+
+# .DS_Store files
+.DS_Store
+*/.DS_Store
+*/*/.DS_Store
+*/*/*/.DS_Store
+*/*/*/*/.DS_Store

data/.rvmrc

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+if ! rvm list | grep ruby-1.9.3 ; then
+  rvm install 1.9.3
+fi
+
+rvm 1.9.3
+
+if ! rvm gemset list | grep platformq_acts_as_caesar ; then
+  rvm gemset create platformq_acts_as_caesar
+fi
+
+rvm 1.9.3@platformq_acts_as_caesar
+
+if ! gem list | grep -q bundler ; then
+  gem install --no-ri --no-rdoc bundler
+  bundle install --without production
+fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright 2012 Platform Q Limited
+
+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.textile

@@ -0,0 +1,61 @@
+h1. Description
+
+Acts As Caesar is a voting system - allowing up/down voting of objects.
+
+h1. Installation
+
+Simply add acts_as_caesar to your Gemfile
+
+<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.
+
+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@):
+
+<pre><code>$redis = Redis.new(:host => 'localhost', :port => 6379)</code></pre>
+
+Or for Heroku:
+
+<pre><code>require 'uri'
+uri = URI.parse(ENV["REDISTOGO_URL"])
+$redis = Redis.new(host: uri.host, port: uri.port, password: uri.password)</code></pre>
+
+h1. Usage
+
+h2. In Rails projects
+
+Add the JavaScript library to your app/assets/application.js file:
+
+<pre><code>//= require acts_as_caesar</code></pre>
+
+Mount the engine into your routes.rb file, under any path you wish:
+
+<pre><code>mount ActsAsCaesar::Rails::Engine => "/acts_as_caesar"</code></pre>
+
+In any ActiveModel-compatible you wish to be updated with their score include the ActAsCandidate module:
+
+<pre><code>class Review < ActiveRecord::Base
+  include ActsAsCaesar::ActAsCandidate
+end</code></pre>
+
+In your views, where you wish to display the voting buttons, call the helper as so:
+
+<pre><code><%= acts_as_caesar(candidate: review, voter: current_user, base_path: '/acts_as_caesar') %></code></pre>
+
+*Note:* the above base_path should match the one used in the routes file.
+
+h1. Testing
+
+To run the Acts As Caesar tests, simply run @rake@, this will run both RSpec and Jasmine. To run just RSpec use @rake spec@ or to run just Jasmine use @rake jasmine_spec@
+
+*Note:* the RSpec test suite expects MongoDB to be running on localhost:27017 without authentication. You can customise this in @spec/dummy/config/mongoid.yml@.
+
+h1. License
+
+Please see "LICENSE":https://github.com/PlatformQ/acts_as_caesar/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'coffee-script'
+require 'fileutils'
+
+desc "Runs both Rspec and Jasmine specs"
+task default: ['spec', 'jasmine_spec']
+
+desc "Compiles CoffeeScript and runs Jasmine specs"
+task :jasmine_spec do
+  Rake::Task['compile_coffeescript'].invoke
+  Rake::Task['jasmine:ci'].invoke
+end
+
+desc "Compiles CoffeeScript files"
+task :compile_coffeescript do
+  puts "Compiling coffeescript"
+  [
+    {
+      input_dir: 'vendor/assets/javascripts/*',
+      output_dir: 'spec/javascripts/compiled'
+    },
+    {
+      input_dir: 'spec/assets/*',
+      output_dir: 'spec/javascripts'
+    }
+  ].each do |opts|
+    output_dir = File.join(File.dirname(__FILE__), opts[:output_dir])
+    
+    Dir[File.join(output_dir, "*.js")].each { |f| FileUtils.rm f }
+    FileUtils.makedirs(output_dir)
+    
+    Dir[File.join(File.dirname(__FILE__), opts[:input_dir])].each do |source_file|
+      next unless source_file =~ /#{opts[:input_dir]}\/(.*)\.coffee$/
+      print "."
+      output_file = File.join(output_dir, $1)
+  
+      begin
+        FileUtils.makedirs(File.dirname(output_file))
+        
+        File.open(output_file, 'w') do |f|
+          f.write CoffeeScript.compile File.read(source_file)
+        end
+      rescue Exception => e
+        puts "\nError in #{source_file}"
+        raise
+      end
+    end
+  end
+  puts ""
+end
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/acts_as_caesar.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_caesar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_caesar"
+  s.version     = ActsAsCaesar::VERSION
+  s.authors     = ["Ryan Townsend"]
+  s.email       = ["ryan@ryantownsend.co.uk"]
+  s.homepage    = "http://platformq.co.uk/"
+  s.summary     = %q{Acts As Caesar is a voting system - allowing up/down voting of objects.}
+  s.description = %q{Acts As Caesar is a voting system - allowing up/down voting of objects.}
+
+  s.rubyforge_project = "acts_as_caesar"
+
+  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"]
+
+  s.add_dependency 'redis', '3.0.0.rc1'
+  s.add_dependency 'json', '~> 1.6.6'
+
+  # testing only
+  s.add_development_dependency 'rspec', '~> 2.8'
+  s.add_development_dependency 'rack', '~> 1.4'
+  s.add_development_dependency 'rack-test', '~> 0.6'
+  s.add_development_dependency 'simplecov', '~> 0.6'
+  s.add_development_dependency 'jasmine', '~> 1.1'
+  s.add_development_dependency 'coffee-script', '~> 2.2'
+  
+  # integration testing only
+  s.add_development_dependency 'rspec-rails', '~> 2.9'
+  s.add_development_dependency 'rails', '~> 3.2'
+  s.add_development_dependency 'mongoid', '~> 2.4'
+  s.add_development_dependency 'bson_ext', '~> 1.5'
+  s.add_development_dependency 'jquery-rails', '~> 2.0'
+end

data/lib/acts_as_caesar/modules/act_as_candidate.rb

@@ -0,0 +1,26 @@
+require 'acts_as_caesar/objects/candidate'
+require 'acts_as_caesar/objects/notification'
+
+module ActsAsCaesar
+  module ActAsCandidate
+    def self.included(base)
+      Notification.subscribe(key: /^#{base.name.downcase}\_[\da-f]+$/) do |candidate|
+        candidate.key =~ /\_([\da-f]+)$/ &&
+        base.find($1).update_total_candidate_score
+      end
+    end
+    
+    def as_candidate
+      @as_candidate = ActsAsCaesar::Candidate.new(self)
+    end
+    
+    def update_total_candidate_score
+      self.score = total_candidate_score
+      save!
+    end
+
+    def total_candidate_score
+      @total_candidate_score ||= as_candidate.total
+    end
+  end
+end

data/lib/acts_as_caesar/objects/candidate.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'acts_as_caesar/objects/key'
+
+module ActsAsCaesar
+  class Candidate
+    def initialize(source)
+      @source = source
+    end
+    
+    def key
+      Key.for_source(source)
+    end
+    
+    def to_json(*args)
+      key
+    end
+    
+    def total
+      @total ||= Persistence.vote_total(self)
+    end
+    
+    private
+    attr_reader :source
+  end
+end

data/lib/acts_as_caesar/objects/key.rb

@@ -0,0 +1,15 @@
+module ActsAsCaesar
+  class Key
+    class << self
+      def for_source(source)
+        if source.respond_to?(:acts_as_caesar_key)
+          source.acts_as_caesar_key
+        elsif source.respond_to?(:id)
+          "#{source.class.name.downcase}_#{source.id}"
+        else
+          source.to_s
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_caesar/objects/notification.rb

@@ -0,0 +1,24 @@
+module ActsAsCaesar
+  class Notification
+    class << self
+      # publishes a change to a candidate
+      def publish(object)
+        subscriptions.each do |subscription|
+          if object.key =~ subscription[:options][:key]
+            subscription[:process].yield(object)
+          end
+        end
+      end
+
+      # subscribes to changes on a candidate
+      def subscribe(options = {}, &block)
+        @subscriptions ||= []
+        @subscriptions << { options: options, process: block }
+      end
+      
+      def subscriptions
+        @subscriptions || []
+      end
+    end
+  end
+end

data/lib/acts_as_caesar/objects/persistence.rb

@@ -0,0 +1,45 @@
+require 'redis'
+require 'acts_as_caesar/objects/notification'
+
+module ActsAsCaesar
+  class Persistence
+    class << self
+      def connection
+        $redis ||= Redis.new(:host => 'localhost', :port => 6379)
+      end
+      
+      def increment_total_votes_on(object)
+        result = connection.incr("#{object.key}_total")
+        Notification.publish(object)
+        result
+      end
+      
+      def decrement_total_votes_on(object)
+        result = connection.decr("#{object.key}_total")
+        Notification.publish(object)
+        result
+      end
+      
+      def vote_total(object)
+        (connection.get("#{object.key}_total") || 0).to_i
+      end
+      
+      def vote_value(options)
+        key = [options[:candidate], options[:voter]].map(&:key).join("_")
+        (connection.get(key) || 0).to_i
+      end
+      
+      def set_vote_value(value, options = {})
+        # load the keys
+        key = [options[:candidate], options[:voter]].map(&:key).join("_")
+        # if the value was zero, delete it
+        if value == 0
+          connection.del(key)
+        # if the value isn't zero, update it
+        else
+          connection.set(key, value)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_caesar/objects/vote.rb

@@ -0,0 +1,77 @@
+require 'acts_as_caesar/objects/persistence'
+
+module ActsAsCaesar
+  class Vote
+    class << self
+      def find(options)
+        from_value(Persistence.vote_value(options), options)
+      end
+      
+      def from_value(value, options = {})
+        case value
+        when 1
+          PositiveVote
+        when -1
+          NegativeVote
+        else
+          NoVote
+        end.new(options)
+      end
+      
+      def value
+        0
+      end
+    end
+
+    def voter
+      @attrs[:voter]
+    end
+    
+    def candidate
+      @attrs[:candidate]
+    end
+    
+    def initialize(attrs)
+      @attrs = attrs
+    end
+    
+    def value
+      self.class.value
+    end
+    
+    def update(new_value)
+      raise ArgumentError, "Only accepts Integer objects" unless new_value.kind_of?(Integer)
+      # don't change if the values already match
+      return self if new_value == value
+      # set the new value
+      Persistence.set_vote_value(new_value, @attrs)
+      # if the value has increased
+      if new_value > value
+        Persistence.increment_total_votes_on(candidate)
+      # if the value has decreased
+      elsif new_value < value
+        Persistence.decrement_total_votes_on(candidate)
+      end
+      # return the new value object
+      self.class.from_value(new_value, @attrs)
+    end
+    
+    def to_json(*args)
+      {
+        voter: voter.to_json,
+        candidate: candidate.to_json,
+        value: value
+      }
+    end
+  end
+  
+  class NoVote < Vote; end
+  
+  class PositiveVote < Vote
+    def self.value; 1; end
+  end
+  
+  class NegativeVote < Vote
+    def self.value; -1; end
+  end
+end

data/lib/acts_as_caesar/objects/voter.rb

@@ -0,0 +1,43 @@
+require 'acts_as_caesar/objects/vote'
+require 'acts_as_caesar/objects/key'
+
+module ActsAsCaesar
+  class Voter
+    def initialize(source)
+      @source = source || NoVoter.new
+    end
+    
+    def has_voted_on?(candidate)
+      !vote_placed_on(candidate).kind_of?(NoVote)
+    end
+
+    def vote_value_for(candidate)
+      vote_placed_on(candidate).value
+    end
+    
+    def update_vote(candidate, value)
+      vote_placed_on(candidate).update(value)
+    end
+
+    def vote_placed_on(candidate)
+      Vote.find(voter: self, candidate: candidate)
+    end
+    
+    def key
+      Key.for_source(source)
+    end
+    
+    def to_json(*args)
+      key
+    end
+
+    private
+    attr_reader :source
+  end
+  
+  class NoVoter
+    def acts_as_caesar_key
+      ''
+    end
+  end
+end

data/lib/acts_as_caesar/rack.rb

@@ -0,0 +1,63 @@
+require 'acts_as_caesar/objects/voter'
+require 'acts_as_caesar/objects/candidate'
+require 'json'
+require 'rack/request'
+
+module Rack
+  class ActsAsCaesar
+    attr_reader :request, :app
+
+    def initialize(app = nil)
+      @app = app
+    end
+
+    def call(env)
+      # pass through app if response already exists
+      if app
+        status, headers, body = app.call(env)
+        return [status, headers, body] unless status == 404
+      end
+      
+      @request = Rack::Request.new(env)
+      if request.path =~ /\/votes\/(\w+)\/([\w\-]+).json/
+        if request.get?
+          render_votes($1, $2)
+        elsif request.post?
+          update_vote($1, $2, request.params['value'].to_i)
+        else
+          method_not_allowed
+        end
+      else
+        not_found
+      end
+    end
+
+    private
+    def render_votes(voter, candidates)
+      voter = ::ActsAsCaesar::Voter.new(voter)
+      votes = candidates.split('-').map do |c|
+        ::ActsAsCaesar::Candidate.new(c)
+      end.map do |c|
+        voter.vote_placed_on(c)
+      end
+      # return an array of vote objects
+      [200, {"Content-Type" => "application/json"}, [JSON.generate(votes.map(&:to_json))]]
+    end
+    
+    def update_vote(voter, candidate, value)
+      voter = ::ActsAsCaesar::Voter.new(voter)
+      candidate = ::ActsAsCaesar::Candidate.new(candidate)
+      vote = voter.update_vote(candidate, value)
+      # return the vote object
+      [200, {"Content-Type" => "application/json"}, [JSON.generate(vote.to_json)]]
+    end
+
+    def not_found
+      [404, {}, ["ActsAsCaesar - Action not found"]]
+    end
+
+    def method_not_allowed
+      [405, {}, ["ActsAsCaesar - Method not allowed"]]
+    end
+  end
+end

data/lib/acts_as_caesar/rails/engine.rb

@@ -0,0 +1,11 @@
+require 'acts_as_caesar/rack'
+
+module ActsAsCaesar
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer "engine.add_middleware" do |app|
+        app.middleware.use Rack::ActsAsCaesar
+      end
+    end
+  end
+end

data/lib/acts_as_caesar/rails/view_helpers.rb

@@ -0,0 +1,17 @@
+require 'acts_as_caesar/objects/candidate'
+require 'acts_as_caesar/objects/voter'
+
+module ActsAsCaesar
+  module Rails
+    module ViewHelpers
+      def acts_as_caesar(options = {})
+        content_tag(:div, options[:content] || '', (options[:html] || {}).merge({
+          "data-candidate" => Candidate.new(options[:candidate]).key,
+          "data-voter" => Voter.new(options[:voter]).key,
+          "data-acts-as-caesar" => 'uninit',
+          "data-base-path" => options[:base_path]
+        }.delete_if { |k,v| v.blank? }))
+      end
+    end
+  end
+end

data/lib/acts_as_caesar/version.rb

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

data/lib/acts_as_caesar.rb

@@ -0,0 +1,21 @@
+require "acts_as_caesar/version"
+require "acts_as_caesar/objects/persistence"
+require "acts_as_caesar/objects/candidate"
+require "acts_as_caesar/objects/voter"
+require "acts_as_caesar/modules/act_as_candidate"
+
+if defined?(::Rails)
+  require "acts_as_caesar/rails/engine"
+  if defined?(::ActiveSupport)
+    require "acts_as_caesar/rails/view_helpers"
+    ::ActiveSupport.on_load(:action_view) do
+      include ActsAsCaesar::Rails::ViewHelpers
+    end
+  end
+elsif defined?(Rack)
+  require "acts_as_caesar/rack"
+end
+
+module ActsAsCaesar
+  # Your code goes here...
+end

data/spec/assets/jasmine_helper.js.coffee

@@ -0,0 +1,5 @@
+beforeEach ->
+  this.addMatchers {
+    toBeInstanceOf: (expected) ->
+      !!(this.actual instanceof expected)
+  }

data/spec/assets/jquery_helper.js.coffee

@@ -0,0 +1,2 @@
+class window.jQuery
+  @ajax = (opts) ->