vote 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51d09c11a38c409fffc5db3c465c8943e9200c39
-  data.tar.gz: 1996f876bca6339c9648ca93fbe58027ae3d03ce
+  metadata.gz: f492ffc6df02f2b36eb5bce6535dd736f89b5b49
+  data.tar.gz: 33ce6da072b7b4c4b0d762614e16a03eaa5c4ad9
 SHA512:
-  metadata.gz: 457d82db8aad6622e239da9c5b7965d734f22e1e8225cf4d3fb9a1d898db72a1cd2d6cb388fce88985e3b904b3b4d715bd32467649b44e8ef3bda5bf07fe6108
-  data.tar.gz: 6bc938f3df69381d5f5459eff4590071d7ca92747ae090e79c3bfac8cbfa355f0c3c1b36272e9f7446f9d49398066bc3db334efa3dee0f0ac2e441e52862550b
+  metadata.gz: e9b96eb34c8168348db87d7d03d7b002527c875511ef29c0334b9d0f8da85a39893d138730d09ee630e77d16b076b4a94af2ff11a390e84cc75191900b1476c4
+  data.tar.gz: d96f009f7722010206d3d3a568ac8d4ff26b3908e3fd5ae8b5de7891d0b74b4fe078e4f19c3320f6f1f69bb4c81270bb683aed22ef71285dfd964a1a3de6bf3c

data/Rakefile

@@ -8,17 +8,15 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Vote'
+  rdoc.title    = 'Votable'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -30,5 +28,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/assets/javascripts/vote.js

@@ -0,0 +1,74 @@
+var vote = function(type, id, direction) {
+  upvote_qs = '#upvote_' + type + '_' + id;
+  downvote_qs = '#downvote_' + type + '_' + id;
+
+  active_class = 'vote-active';
+
+  if (direction) {
+    if (document.querySelector(upvote_qs).getAttribute('class') == 'vote-up ' + active_class) {
+      removeClass(upvote_qs, active_class);
+      removeClass(upvote_qs, active_class);
+    } else {
+      addClass(upvote_qs, active_class);
+      removeClass(downvote_qs, active_class);
+    }
+  } else {
+    if (document.querySelector(downvote_qs).getAttribute('class') == 'vote-down ' + active_class) {
+      removeClass(downvote_qs, active_class);
+      removeClass(downvote_qs, active_class);
+    } else {
+      addClass(downvote_qs, active_class);
+      removeClass(upvote_qs, active_class);
+    }
+  }
+
+  var request = new XMLHttpRequest();
+  request.open('POST', '/vote/create', true);
+  request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8');
+  var csrf_token = document.querySelector("meta[name='csrf-token']");
+  if (csrf_token) {
+    request.setRequestHeader('X-CSRF-Token', csrf_token.content);
+  }
+  request.onreadystatechange = (function() {
+    if (request.readyState == 4) {
+      if (request.status == 200) {
+        response = JSON.parse(request.responseText);
+        if (response) {
+          document.getElementById('score_' + type + '_' + id).innerHTML = response.score;
+        } else {
+          handle_signed_out_user();
+        }
+      } else {
+        console.log('There was an error performing your request.');
+      }
+    }
+  });
+  request.send('vote_type=' + type + '&vote_id=' + id + '&direction=' + direction);
+};
+
+// Override this and include your desired behavior (redirect to /sign-in, etc.)
+var handle_signed_out_user = function() {
+  console.log('Please sign in to vote');
+};
+
+var addClass = function(el, className) {
+  if (document.contains(document.querySelector(el))) {
+    nav = document.querySelector(el);
+    if (nav.classList) {
+      nav.classList.add(className);
+    } else {
+      nav.className += ' ' + classTar;
+    }
+  }
+}
+
+var removeClass = function(el, className) {
+  if (document.contains(document.querySelector(el))) {
+    nav = document.querySelector(el);
+    if (nav.classList) {
+      nav.classList.remove(className);
+    } else {
+      nav.className = nav.className.replace(new RegExp('(^|\\b)' + className.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');
+    }
+  }
+}

data/app/assets/stylesheets/vote.css.erb

@@ -0,0 +1,39 @@
+.vote {
+  border-width: 1px;
+  border-color: #000;
+}
+
+.vote * {
+  text-align: center;
+}
+
+.vote-up, .vote-down {
+  cursor: pointer;
+  width: 45px;
+  height: 10px;
+  margin: 0 auto;
+
+  background-size: 100%;
+}
+
+.vote-up {
+  background-image: url("<%=asset_path('votable/up.png')%>");
+  background-position: 0 top;
+}
+
+.vote-up.vote-active {
+  background-position: 0 15px;
+}
+
+.vote-count {
+  display: block;
+}
+
+.vote-down {
+  background-image: url("<%=asset_path('votable/down.png')%>");
+  background-position: 0 bottom;
+}
+
+.vote-down.vote-active {
+  background-position: 0 25px;
+}

data/app/controllers/vote_controller.rb

@@ -0,0 +1,12 @@
+class VoteController < ApplicationController
+  layout false
+
+  def create
+    # if Votable.concerned_classes.include? params[:vote_type]
+      @votable_element = params[:vote_type].constantize.__send__(:find_by_id, params[:vote_id])
+      @votable_element.votes.create(user_id: current_user.try(:id), direction: params[:direction])
+    # else
+      # redirect_to root_path
+    # end
+  end
+end

data/app/helpers/vote_helper.rb

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

data/app/models/concerns/voter.rb

@@ -0,0 +1,8 @@
+module Voter
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :votes,
+             class_name: Vote
+  end
+end

data/app/models/concerns/voting.rb

@@ -0,0 +1,60 @@
+module Voting
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :votes,
+             as: :vote,
+             class_name: Vote,
+             dependent: :destroy
+
+    has_many :upvotes,
+             -> { where(direction: true) },
+             as: :vote,
+             class_name: Vote
+
+    has_many :downvotes,
+             -> { where(direction: false) },
+             as: :vote,
+             class_name: Vote
+
+    def score
+      upvotes.count - downvotes.count
+    end
+
+    def rank
+      order = Math.log10(
+        [score.abs, 1].max
+      )
+
+      sign = if score > 0
+               1
+             elsif score < 0
+               -1
+             else
+               0
+             end
+
+      seconds = created_at.to_i - Votable.rank_epoch
+
+      (
+        order + sign * seconds
+      ).round(11)
+    end
+
+    def upvote_status(user)
+      if user
+        upvotes.where(user_id: user.id).exists?
+      else
+        false
+      end
+    end
+
+    def downvote_status(user)
+      if user
+        downvotes.where(user_id: user.id).exists?
+      else
+        false
+      end
+    end
+  end
+end

data/app/models/vote.rb

@@ -0,0 +1,34 @@
+class Vote < ActiveRecord::Base
+  belongs_to :vote, polymorphic: true
+
+  validates :vote_type, presence: true
+  validates :vote_id, presence: true
+  validates :direction, inclusion: [true, false], if: 'Votable.enable_upvotes && Votable.enable_downvotes'
+  validates :direction, inclusion: [true], if: 'Votable.enable_upvotes && !Votable.enable_downvotes'
+  validates :direction, inclusion: [false], if: '!Votable.enable_upvotes && Votable.enable_downvotes'
+
+  before_create :remove_existing, if: 'Votable.remove_existing_votes'
+  after_create :update_cache_columns, if: 'Votable.enable_cache_columns'
+  after_destroy :update_cache_columns, if: 'Votable.enable_cache_columns', prepend: true
+
+  private
+
+  def remove_existing
+    votes = Vote.where(user_id: user_id, vote_type: vote_type, vote_id: vote_id)
+    opposing = votes.where(direction: !direction).count
+    existing = votes.count
+    votes.destroy_all
+
+    false if existing > 0 && opposing == 0
+  end
+
+  def update_cache_columns
+    @element = vote_type.camelize.constantize.__send__(:find_by_id, vote_id)
+    @element.update(
+      upvotes_count: @element.upvotes.count,
+      downvotes_count: @element.downvotes.count,
+      score: @element.score,
+      rank: @element.rank
+    )
+  end
+end

data/app/views/application/_vote.html.erb

@@ -0,0 +1,11 @@
+<div class="vote">
+  <% unless Votable.enable_upvotes == false %>
+    <div id="upvote_<%=element.class%>_<%=element.id%>" onclick="vote('<%=element.class%>', <%=element.id%>, true);" class="vote-up <%=('vote-active' if element.upvote_status(current_user))%>"></div>
+  <% end %>
+  <% unless Votable.show_score == false %>
+    <div id="score_<%=element.class%>_<%=element.id%>" class="vote-count"><%=element.score%></div>
+  <% end %>
+  <% unless Votable.enable_downvotes == false %>
+    <div id="downvote_<%=element.class%>_<%=element.id%>" onclick="vote('<%=element.class%>', <%=element.id%>, false);" class="vote-down <%=('vote-active' if element.downvote_status(current_user))%>"></div>
+  <% end %>
+</div>

data/app/views/vote/create.jbuilder

@@ -0,0 +1,3 @@
+json.upvotes @votable_element.upvotes
+json.downvotes @votable_element.downvotes
+json.score @votable_element.score

data/config/routes.rb

@@ -1,2 +1,3 @@
 Rails.application.routes.draw do
+  post 'vote/create', to: 'vote#create'
 end

data/db/migrate/20141211124855_create_votes.rb

@@ -0,0 +1,11 @@
+class CreateVotes < ActiveRecord::Migration
+  def change
+    create_table :votes do |t|
+      t.integer :user_id
+      t.boolean :direction, null: false
+      t.references :vote, polymorphic: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/{vote_tasks.rake → votable_tasks.rake}

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :vote do
+# task :votable do
 #   # Task goes here
 # end

data/lib/votable.rb

@@ -0,0 +1,40 @@
+require 'votable/engine'
+require 'jbuilder'
+
+module Votable
+  mattr_accessor :concerned_classes do
+    []
+  end
+
+  mattr_accessor :rank_epoch do
+    0
+  end
+
+  mattr_accessor :remove_existing_votes do
+    true
+  end
+
+  mattr_accessor :autoload_migrations do
+    false
+  end
+
+  mattr_accessor :autoload_decorators do
+    false
+  end
+
+  mattr_accessor :enable_cache_columns do
+    false
+  end
+
+  mattr_accessor :enable_upvotes do
+    true
+  end
+
+  mattr_accessor :enable_downvotes do
+    true
+  end
+
+  mattr_accessor :show_score do
+    true
+  end
+end

data/lib/votable/engine.rb

@@ -0,0 +1,23 @@
+module Votable
+  class Engine < ::Rails::Engine
+    initializer 'autoload migrations' do |app|
+      if Votable.autoload_migrations
+        return if app.root.to_s == root.to_s
+
+        config.paths['db/migrate'].expanded.each do |path|
+          app.config.paths['db/migrate'].push(path)
+        end
+      end
+    end
+
+    initializer 'autoload decorators' do |_app|
+      if Votable.autoload_decorators
+        config.to_prepare do
+          Dir.glob(Rails.root + 'app/decorators/**/*_decorator*.rb').each do |c|
+            require_dependency(c)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/votable/version.rb

@@ -0,0 +1,3 @@
+module Votable
+  VERSION = '0.2.0'.freeze
+end

data/test/controllers/vote_controller_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class VoteControllerTest < ActionController::TestCase
+  setup do
+    Votable.remove_existing_votes = true
+    Votable.concerned_classes = [VotableElement]
+  end
+
+  test 'can post votes' do
+    assert_difference 'Vote.count' do
+      post :create, direction: 'true', vote_type: 'VotableElement', vote_id: 3
+      assert_equal 'application/json', response.content_type
+      assert_response :success
+    end
+  end
+
+  test 'depending on settings, remove duplicate votes' do
+    assert_difference 'Vote.count', -1 do
+      post :create, direction: 'false', vote_type: 'VotableElement', vote_id: 1
+      assert_equal 'application/json', response.content_type
+      assert_response :success
+    end
+  end
+
+  test "depending on settings, don't remove duplicate votes" do
+    Votable.remove_existing_votes = false
+
+    assert_difference 'Vote.count' do
+      post :create, direction: 'true', vote_type: 'VotableElement', vote_id: 1
+      assert_equal 'application/json', response.content_type
+      assert_response :success
+    end
+  end
+
+  test "doesn't toggle off when casting opposing vote" do
+    assert_no_difference 'Vote.count' do
+      post :create, direction: 'true', vote_type: 'VotableElement', vote_id: 1
+      assert_equal 'application/json', response.content_type
+      assert_response :success
+    end
+  end
+end

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

@@ -11,3 +11,4 @@
 // about supported directives.
 //
 //= require_tree .
+//= require vote

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

@@ -12,4 +12,5 @@
  *
  *= require_tree .
  *= require_self
+ *= require vote
  */