acts_as_caesar 0.0.1

data/spec/assets/vote_cache_spec.js.coffee

@@ -0,0 +1,63 @@
+describe 'VoteCache', ->
+  it 'should be defined globally', ->
+    expect(VoteCache).toBeDefined()
+
+  describe 'checking enabled status', ->
+    describe 'in a browser supporting localStorage', ->
+      it 'should be enabled', ->
+        expect(VoteCache.enabled).toBeTruthy()
+
+  describe 'writing values', ->
+    VoteCache.write(-1,123,456)
+
+  describe 'read values', ->
+    describe 'when the key exists', ->
+      beforeEach ->
+        VoteCache.write(-1,123,456)
+      it 'should return a cached vote', ->
+        expect(VoteCache.read(123,456)).toBeInstanceOf(CachedVote)
+      it 'should return the correct vote value', ->
+        expect(VoteCache.read(123,456).value).toEqual(-1)
+      
+      describe 'and the cache is disabled', ->
+        it 'should return a no cache vote', ->
+          VoteCache.enabled = false
+          expect(VoteCache.enabled).toBeFalsy()
+          expect(VoteCache.read(123,456)).toBeInstanceOf(NoCachedVote)
+          VoteCache.enabled = true
+
+    describe 'when the key does not exist', ->
+      it 'should return a no cache vote', ->
+        expect(VoteCache.read(1,2)).toBeInstanceOf(NoCachedVote)
+
+describe 'CachedVote', ->
+  it 'should be defined globally', ->
+    expect(CachedVote).toBeDefined()
+
+  describe 'a positive vote', ->
+    beforeEach ->
+      @vote = new CachedVote(1)
+    it 'should have a value of 1', ->
+      expect(@vote.value).toEqual(1)
+
+  describe 'a negative vote', ->
+    beforeEach ->
+      @vote = new CachedVote(-1)
+    it 'should have a value of -1', ->
+      expect(@vote.value).toEqual(-1)
+
+  describe 'a neutral vote', ->
+    beforeEach ->
+      @vote = new CachedVote(0)
+    it 'should have a value of 0', ->
+      expect(@vote.value).toEqual(0)
+
+describe 'NoCachedVote', ->
+  it 'should be defined globally', ->
+    expect(NoCachedVote).toBeDefined()
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new NoCachedVote()
+    it 'should have a value of 0', ->
+      expect(@vote.value).toEqual(0)

data/spec/assets/vote_persistence_spec.js.coffee

@@ -0,0 +1,31 @@
+describe 'VotePersistence', ->
+  it 'should be defined globally', ->
+    expect(VotePersistence).toBeDefined()
+  
+  describe 'generating a URL', ->
+    describe 'with a base_path set', ->
+      beforeEach ->
+        window.ActsAsCaesar ||= {}
+        window.ActsAsCaesar.base_path = '/aac'
+        @url = VotePersistence.url(1,2)
+        window.ActsAsCaesar.base_path = null
+      it 'should return a URL prepended with the base path', ->
+        expect(@url).toEqual('/aac/votes/1/2.json')
+    describe 'with one candidate', ->
+      beforeEach ->
+        @url = VotePersistence.url(1,2)
+      it 'should return a URL containing the voter and candidate', ->
+        expect(@url).toEqual('/votes/1/2.json')
+
+    describe 'with multiple candidates', ->
+      beforeEach ->
+        @url = VotePersistence.url(1,[2,5,4])
+      it 'should return a URL containing the voter and sorted candidates', ->
+        expect(@url).toEqual('/votes/1/2-4-5.json')
+  
+  describe 'fetching votes', ->
+    it 'should perform an AJAX request to the votes API', ->
+      spyOn(jQuery, 'ajax').andReturn(true)
+      VotePersistence.fetch(1,2)
+      url = VotePersistence.url(1,2)
+      expect(jQuery.ajax.mostRecentCall.args[0]["url"]).toEqual(url)

data/spec/assets/vote_spec.js.coffee

@@ -0,0 +1,59 @@
+describe 'Vote', ->
+  it 'should be defined globally', ->
+    expect(Vote).toBeDefined()
+    
+  describe 'when creating a vote from a value', ->
+    it 'should return a positive vote when given a value of 1', ->
+      expect(Vote.from_value(1,0,0)).toBeInstanceOf(PositiveVote)
+    it 'should return a no vote when given a value of 0', ->
+      expect(Vote.from_value(0,0,0)).toBeInstanceOf(NoVote)
+    it 'should return a negative vote when given a value of -1', ->
+      expect(Vote.from_value(-1,0,0)).toBeInstanceOf(NegativeVote)
+    it 'should return a pending vote when given a value of null', ->
+      expect(Vote.from_value(null,0,0)).toBeInstanceOf(PendingVote)
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new Vote(1,2)
+    it 'should have a value of 0', ->
+      expect(@vote.value).toEqual(0)
+
+describe 'NoVote', ->
+  it 'should be defined globally', ->
+    expect(NoVote).toBeDefined()
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new NoVote(1,2)
+    it 'should have a value of 0', ->
+      expect(@vote.value).toEqual(0)
+
+describe 'PositiveVote', ->
+  it 'should be defined globally', ->
+    expect(PositiveVote).toBeDefined()
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new PositiveVote(1,2)
+    it 'should have a value of 1', ->
+      expect(@vote.value).toEqual(1)
+
+describe 'NegativeVote', ->
+  it 'should be defined globally', ->
+    expect(NegativeVote).toBeDefined()
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new NegativeVote(1,2)
+    it 'should have a value of -1', ->
+      expect(@vote.value).toEqual(-1)
+
+describe 'PendingVote', ->
+  it 'should be defined globally', ->
+    expect(PendingVote).toBeDefined()
+
+  describe 'instance', ->
+    beforeEach ->
+      @vote = new PendingVote(1,2)
+    it 'should have a value of 0', ->
+      expect(@vote.value).toEqual(0)

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require acts_as_caesar
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,52 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/
+
+/* example Acts As Caesar styles */
+div[data-acts-as-caesar] button {
+  border: 1px solid #ccc;
+  background: #eee;
+}
+div[data-acts-as-caesar][data-current-value='1'] button[value='1'],
+div[data-acts-as-caesar][data-current-value='-1'] button[value='-1'] {
+  border-color: #aaa;
+  background: #ddd;
+}
+
+/* generic styles */
+html {
+  margin: 0;
+  padding: 0;
+  background: #eee;
+}
+
+body {
+  max-width: 900px;
+  margin: 0 auto;
+  padding: 20px;
+  border: 1px solid #ddd;
+  border-width: 0 1px;
+  background: #fff;
+  font: 13px/1.5 'helvetica neue', arial, sans-serif
+}
+
+p { margin: 0 0 20px }
+h1, h2 { margin: 0 }
+h1 { font-size: 1.5em }
+h2 { font-size: 1.25em }
+
+.album {
+  border-top: 1px solid #ddd;
+  padding-top: 20px;
+  margin-bottom: 20px;
+}

data/spec/dummy/app/controllers/albums_controller.rb

@@ -0,0 +1,58 @@
+class AlbumsController < ApplicationController
+  before_filter :load_album, except: [:index, :new, :create]
+
+  def index
+    respond_with(@albums = Album.by_score)
+  end
+  
+  def new
+    respond_with(@album = Album.new) do |format|
+      format.html { render :form }
+    end
+  end
+  
+  def create
+    @album = Album.create(params[:album])
+
+    respond_with(@album, location: { action: :index }) do |format|
+      format.html do
+        @album.persisted? ?
+        redirect_to({ action: :index }, notice: "Album created!") :
+        render(:form)
+      end
+    end
+  end
+  
+  def edit
+    respond_with(@album) do |format|
+      format.html { render :form }
+    end
+  end
+
+  def update
+    @album.update_attributes(params[:album])
+
+    respond_with(@album, location: { action: :index }) do |format|
+      format.html do
+        @album.errors.empty? ?
+        redirect_to({ action: :index }, notice: "Album updated!") :
+        render(:form)
+      end
+    end
+  end
+
+  def destroy
+    @album.destroy
+    
+    respond_with(@album) do |format|
+      format.html do
+        redirect_to({ action: :index }, notice: "Album deleted!")
+      end
+    end
+  end
+  
+  protected
+  def load_album
+    @album = Album.find(params[:id])
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  respond_to :html, :json, :xml
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/album.rb

@@ -0,0 +1,15 @@
+require 'mongoid'
+
+class Album
+  include Mongoid::Document
+  include ActsAsCaesar::ActAsCandidate
+  
+  field :name, type: String
+  field :score, type: Integer
+  
+  class << self
+    def by_score
+      scoped.order_by([:score, :desc])
+    end
+  end
+end

data/spec/dummy/app/views/albums/form.html.erb

@@ -0,0 +1,10 @@
+<h1><%= @album.new_record? ? 'New Album' : 'Edit Album' %></h1>
+
+<%= form_for(@album) do |f| %>
+  <p>
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </p>
+  
+  <%= f.submit 'Save' %>
+<% end %>

data/spec/dummy/app/views/albums/index.html.erb

@@ -0,0 +1,12 @@
+<h1>Albums</h1>
+
+<p><%= link_to 'New Album', new_album_path %></p>
+
+<%= content_tag_for(:div, @albums) do |album| %>
+  <h2><%= album.name %></h2>
+  <p>
+    <%= link_to 'Edit', edit_album_path(album) %> |
+    <%= link_to 'Delete', album_path(album), method: :delete %>
+  </p>
+  <%= acts_as_caesar(candidate: album, voter: "123", base_path: '/acts_as_caesar') %>
+<% end %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+
+<body>
+
+  <%= yield %>
+
+</body>
+
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+require "jquery-rails"
+
+Bundler.require
+require "acts_as_caesar"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+    
+    config.generators do |g|
+      g.orm :mongoid
+      g.test_framework :rspec
+      g.helper false
+      g.stylesheets false
+      g.javascripts false
+    end
+  end
+end
+