biovision-vote 0.1.2.170925 → 0.2.180610

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2896e74fd3e5c25c96555df47134054a1dd6f590
-  data.tar.gz: 9864256f76fcc4c69b4a8e3a051f92ec7a1278f0
+SHA256:
+  metadata.gz: adda0f4c749b69d036ee7ed68eeb0bf5c7b239b0bcf1e319a0b41047159fa528
+  data.tar.gz: 70afc612c239040da36ab2d3c4e576749bd2ae5301373ece07dd80029f97a118
 SHA512:
-  metadata.gz: 2e04835cfee1d598a18143385563b64aaa394368bf5cf419cff484e45265579d8a1823ce1f5413827cb7b7bb76801e8ab612d20fd8083dd6cfd1ea60f9f3ad97
-  data.tar.gz: d34535db6f6717c29c73268052f0f578713bc1da3ec0c26a9af184f0a72345daab2054b57727d970f8aa8d116bc78d8775ab53e818c1c07efdca5a1bca61f60a
+  metadata.gz: bc1b959e92bb5d0bfb80d52fc8253bb3b5c049348cdb38bb2aa55a8aa5622a7b112dc464169dc273a0e3880a6eb93ecaf3255ba5d2bc87d1c53cfb02c42dcd94
+  data.tar.gz: 9d72d310271a1939606abfbe25e8ae66ad06932caf9293002a4a08a3ad43da0438cf0ad937c546db393076211cedc9d4817f2480ec075bc6385d8d28ff4da94b

data/app/assets/images/biovision/vote/icons/downvote-active.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#822" stroke="#844" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#822" stroke="#844" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/downvote-error.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#888" stroke="#444" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#888" stroke="#444" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/downvote-switch.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#ff4" stroke="#884" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="#ff4" stroke="#884" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/downvote.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="none" stroke="#844" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 2, 9 12, 4 12, 11 21, 13 21, 20 12, 15 12, 15 2, 9 2" fill="none" stroke="#844" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/upvote-active.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#282" stroke="#484" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#282" stroke="#484" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/upvote-error.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#888" stroke="#444" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#888" stroke="#444" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/upvote-switch.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#ff4" stroke="#884" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="#ff4" stroke="#884" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/images/biovision/vote/icons/upvote.svg

@@ -1,3 +1 @@
-<svg version="1.1" baseProfile="full" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg">
-  <polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="none" stroke="#484" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
-</svg>
+<svg version="1.1" viewBox="0 0 24 24" width="24" height="24" xmlns="http://www.w3.org/2000/svg"><polyline points="9 21, 9 11, 4 11, 11 2, 13 2, 20 11, 15 11, 15 21, 9 21" fill="none" stroke="#484" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" /></svg>

data/app/assets/javascripts/biovision/vote/biovision-vote.js

@@ -16,9 +16,9 @@ document.addEventListener('DOMContentLoaded', function () {
                     const result = JSON.parse(this.responseText);
 
                     $button.classList.remove('switch');
-                    if (result.hasOwnProperty('data')) {
-                        const vote_type = result['data']['vote_type'];
-                        const vote_result = result['data']['vote_result'];
+                    if (result.hasOwnProperty('meta')) {
+                        const vote_type = result['meta']['vote_type'];
+                        const vote_result = result['meta']['vote_result'];
 
                         $container.classList.remove('voted-none');
                         $container.classList.add('voted-' + vote_type);
@@ -26,7 +26,7 @@ document.addEventListener('DOMContentLoaded', function () {
                     }
                 };
 
-                const on_failure = function(result) {
+                const on_failure = function (result) {
                     $button.classList.remove('switch');
                     $button.classList.add('error');
                     handle_ajax_failure(result);
@@ -42,4 +42,56 @@ document.addEventListener('DOMContentLoaded', function () {
             $container.classList.remove('active');
         });
     });
+
+    document.querySelectorAll('[data-vote]').forEach(function (button) {
+        const container = button.closest('[data-vote-url]');
+        if (container) {
+            if (container.classList.contains('vote-active')) {
+                const url = container.getAttribute('data-vote-url');
+
+                button.addEventListener('click', function () {
+                    const delta = this.getAttribute('data-vote') === 'up' ? 1 : -1;
+                    const pressedButton = this;
+
+                    /**
+                     * Во время голосования состояние переключается
+                     * на vote-inactive, поэтому проверяем ещё раз
+                     */
+                    if (container.classList.contains('vote-active')) {
+                        const data = {
+                            vote: {
+                                votable_id: container.getAttribute('data-votable-id'),
+                                votable_type: container.getAttribute('data-votable-type'),
+                                delta: delta,
+                            }
+                        };
+
+                        const request = Biovision.jsonAjaxRequest('POST', url, function () {
+                            if (this.responseText) {
+                                const response = JSON.parse(this.responseText);
+
+                                if (response.hasOwnProperty('meta')) {
+                                    if (delta > 0) {
+                                        pressedButton.innerHTML = response.meta['upvote_count'];
+                                    } else {
+                                        pressedButton.innerHTML = response.meta['downvote_count'];
+                                    }
+                                    container.classList.remove('voted-none');
+                                    container.classList.add('voted-' + response.meta['vote_type']);
+                                }
+                            } else {
+                                container.classList.remove('vote-inactive');
+                                container.classList.add('vote-active');
+                            }
+                        });
+
+                        container.classList.remove('vote-active');
+                        container.classList.add('vote-inactive');
+
+                        request.send(JSON.stringify(data));
+                    }
+                });
+            }
+        }
+    });
 });

data/app/controllers/votes_controller.rb

@@ -4,10 +4,10 @@ class VotesController < ApplicationController
   # post /votes
   def create
     @entity = Vote.new(creation_parameters)
-    if @entity.votable.votable_by?(current_user)
+    if @entity.votable.vote_applicable?(@entity)
       process_vote
     else
-      render :result, status: :unauthorized
+      render :result, status: :unprocessable_entity
     end
   end
 
@@ -32,7 +32,7 @@ class VotesController < ApplicationController
   end
 
   def process_vote
-    if Vote.voted?(current_user, @entity.votable)
+    if Vote.voted?(@entity.current_slug, @entity.votable)
       render :result, status: :conflict
     else
       count_vote

data/app/models/concerns/votable_item.rb

@@ -5,26 +5,26 @@ module VotableItem
     has_many :votes, as: :votable, dependent: :destroy
   end
 
-  # @param [User] user
-  def votable_by?(user)
-    return false if user.nil?
-    !Vote.voted?(user, self)
+  # @param [Vote|String] vote_or_slug
+  def vote_applicable?(vote_or_slug)
+    slug = vote_or_slug.is_a?(String) ? vote_or_slug : vote_or_slug.slug
+    !Vote.voted?(slug, self)
   end
 
-  # @param [User] user
-  def vote_data(user = nil)
+  # @param [String|Vote] vote_or_slug
+  def vote_data(vote_or_slug)
     {
         upvote_count: upvote_count,
         downvote_count: downvote_count,
         vote_result: vote_result,
-        vote_type: voted(user)
+        vote_type: voted(vote_or_slug)
     }
   end
 
-  # @param [User] user
-  def voted(user)
-    vote = votes.find_by(user: user)
-    return :none if vote.nil?
+  # @param [String|Vote] vote_or_slug
+  def voted(vote_or_slug)
+    vote = vote_or_slug.is_a?(String) ? votes.find_by(slug: vote_or_slug) : vote_or_slug
+    return :none if vote&.id.nil?
     vote.upvote? ? :upvote : :downvote
   end
 end

data/app/models/vote.rb

@@ -1,8 +1,6 @@
 class Vote < ApplicationRecord
   include HasOwner
 
-  PER_PAGE = 20
-
   METRIC_VOTE_HIT     = 'votes.any.hit'
   METRIC_UPVOTE_HIT   = 'votes.upvote.hit'
   METRIC_DOWNVOTE_HIT = 'votes.downvote.hit'
@@ -12,22 +10,35 @@ class Vote < ApplicationRecord
   belongs_to :votable, polymorphic: true
 
   before_validation { self.delta = (delta.to_i > 0 ? 1 : -1) }
-  validates_uniqueness_of :votable_id, scope: [:user_id, :votable_type]
+  before_validation :generate_slug
+  validates_uniqueness_of :votable_id, scope: [:slug, :votable_type]
 
   after_create :add_vote_result
   after_destroy :discard_vote_result
 
   scope :recent, -> { order('id desc') }
+  scope :list_for_administration, -> { recent }
 
   # @param [Integer] page
   def self.page_for_administration(page = 1)
-    recent.page(page).per(PER_PAGE)
+    list_for_administration.page(page)
   end
 
   # @param [User] user
+  # @param [String] ip
+  # @param [Integer] agent_id
+  def self.slug_string(user, ip, agent_id)
+    if user.nil?
+      "#{ip}:#{agent_id}"
+    else
+      user.id.to_s
+    end
+  end
+
+  # @param [String] slug
   # @param [ApplicationRecord] votable
-  def self.voted?(user, votable)
-    exists?(user: user, votable: votable)
+  def self.voted?(slug, votable)
+    exists?(slug: slug, votable: votable)
   end
 
   # @param [User] user
@@ -56,8 +67,16 @@ class Vote < ApplicationRecord
     owned_by?(user) || UserPrivilege.user_has_privilege?(:user, :moderator)
   end
 
+  def current_slug
+    self.class.slug_string(user, ip, agent_id)
+  end
+
   private
 
+  def generate_slug
+    self.slug = current_slug
+  end
+
   def add_vote_result
     votable.vote_result    = votable.vote_result + delta
     votable.upvote_count   = votable.upvote_count + 1 if upvote?

data/app/views/admin/index/dashboard/_biovision_vote.html.erb

@@ -0,0 +1,10 @@
+<% if current_user_has_privilege?(:moderator) %>
+    <nav>
+      <div class="heading" id="biovision-vote-nav-heading">
+        <%= t('.heading') %>
+      </div>
+      <ul aria-labelledby="biovision-vote-nav-heading">
+        <li><%= render 'admin/votes/nav_item' %></li>
+      </ul>
+    </nav>
+<% end %>

data/app/views/admin/votes/_nav_item.html.erb

@@ -1,6 +1,2 @@
-<div>
-  <%= link_to t('.text'), admin_votes_path %>
-</div>
-<div class="description">
-  <%= t('.description') %>
-</div>
+<div><%= link_to t('.text'), admin_votes_path %></div>
+<div class="description"><%= t('.description') %></div>

data/app/views/admin/votes/entity/_in_list.html.erb

@@ -2,13 +2,8 @@
   <%= vote_image(entity) %>
 </div>
 <div class="data">
-  <div>
-    <%= biovision_votable_link(entity.votable) %>
-  </div>
-  <div class="info">
-    <%= admin_user_link(entity.user) %>
-  </div>
-  <div class="secondary info">
-    <%= time_tag(entity.created_at) %>
-  </div>
+  <div><%= biovision_votable_link(entity.votable) %></div>
+  <div class="info"><%= admin_user_link(entity.user) %></div>
+  <div class="secondary info"><%= entity.slug %></div>
+  <div class="secondary info"><%= time_tag(entity.created_at) %></div>
 </div>

data/app/views/votes/_vote_block.html.erb

@@ -1,5 +1,8 @@
-<% block_class = votable.votable_by?(current_user) ? 'active' : '' %>
-<div class="vote-block <%= block_class %> voted-<%= votable.voted(current_user) %>" data-id="<%= votable.id %>">
+<%
+  slug = Vote.slug_string(current_user, request.env['HTTP_X_REAL_IP'] || request.remote_ip, agent.id)
+  block_class = votable.vote_applicable?(slug) ? 'active' : ''
+%>
+<div class="vote-block <%= block_class %> voted-<%= votable.voted(slug) %>" data-id="<%= votable.id %>">
   <div class="vote upvote"></div>
   <div class="result"><%= votable.vote_result %></div>
   <div class="vote downvote"></div>

data/app/views/votes/result.jbuilder

@@ -1 +1 @@
-json.data @entity.votable.vote_data(current_user)
+json.meta @entity.votable.vote_data(@entity)

data/config/locales/votes-en.yml

@@ -0,0 +1,37 @@
+en:
+  upvote_count:
+    zero: "no upvotes"
+    one: "%{count} upvote"
+    few: "%{count} upvotes"
+    many: "%{count} upvotes"
+    other: "%{count} upvotes"
+  downvote_count:
+    zero: "no downvotes"
+    one: "%{count} downvote"
+    few: "%{count} downvotes"
+    many: "%{count} downvotes"
+    other: "%{count} downvotes"
+  activerecord:
+    models:
+      vote: "Vote"
+    attributes:
+      vote:
+        agent: "User agent"
+        delta: "Delta"
+        ip: "IP address"
+        slug: "Slug"
+        user: "User"
+        votable: "Votable entity"
+        votable_id: "Votable entity"
+  admin:
+    votes:
+      nav_item:
+        description: "Manage user votes"
+        text: "User votes"
+      index:
+        heading: "User votes"
+        title: "User votes, page %{page}"
+    index:
+      dashboard:
+        biovision_vote:
+          heading: "User votes"

data/config/locales/votes-ru.yml

@@ -16,16 +16,22 @@ ru:
       vote: "Голос"
     attributes:
       vote:
-        user: "Пользователь"
-        votable: "Объект голосования"
         agent: "Агент пользователя"
-        ip: "IP-адрес"
         delta: "Изменение"
+        ip: "IP-адрес"
+        slug: "Идентификатор"
+        user: "Пользователь"
+        votable: "Объект голосования"
+        votable_id: "Объект голосования"
   admin:
     votes:
       nav_item:
-        text: "Голоса пользователей"
         description: "Просмотр голосов пользователей"
+        text: "Голоса пользователей"
       index:
-        title: "Голоса, страница %{page}"
         heading: "Голоса пользователей"
+        title: "Голоса, страница %{page}"
+    index:
+      dashboard:
+        biovision_vote:
+          heading: "Голоса пользователей"

data/config/routes.rb

@@ -1,7 +1,11 @@
 Rails.application.routes.draw do
-  resources :votes, only: [:create, :destroy], defaults: { format: :json }
+  resources :votes, only: [:destroy], defaults: { format: :json }
 
-  namespace :admin do
-    resources :votes, only: [:index]
+  scope '(:locale)', constraints: { locale: /ru|en/ } do
+    resources :votes, only: [:create], defaults: { format: :json }
+
+    namespace :admin do
+      resources :votes, only: [:index]
+    end
   end
 end

data/db/migrate/20170330000001_create_votes.rb

@@ -1,13 +1,22 @@
-class CreateVotes < ActiveRecord::Migration[5.0]
-  def change
-    create_table :votes do |t|
-      t.timestamps
-      t.references :user, foreign_key: true, on_update: :cascade, on_delete: :cascade
-      t.references :agent, foreign_key: true, on_update: :cascade, on_delete: :nullify
-      t.inet :ip
-      t.integer :delta, limit: 2, default: 0, null: false
-      t.integer :votable_id, null: false
-      t.string :votable_type, null: false
+class CreateVotes < ActiveRecord::Migration[5.1]
+  def up
+    unless Vote.table_exists?
+      create_table :votes do |t|
+        t.timestamps
+        t.references :user, foreign_key: true, on_update: :cascade, on_delete: :cascade
+        t.references :agent, foreign_key: true, on_update: :cascade, on_delete: :nullify
+        t.inet :ip
+        t.integer :delta, limit: 2, default: 0, null: false
+        t.integer :votable_id, null: false
+        t.string :votable_type, null: false
+        t.string :slug, index: true
+      end
+    end
+  end
+
+  def down
+    if Vote.table_exists?
+      drop_table :votes
     end
   end
 end

data/db/migrate/20180610110015_add_slug_to_votes.rb

@@ -0,0 +1,15 @@
+class AddSlugToVotes < ActiveRecord::Migration[5.2]
+  def up
+    unless column_exists?(:votes, :slug)
+      add_column :votes, :slug, :string, index: true
+
+      Vote.order('id asc').each do |vote|
+        vote.update! slug: vote.current_slug
+      end
+    end
+  end
+
+  def down
+    # No need to rollback
+  end
+end

data/lib/biovision/vote/engine.rb

@@ -7,7 +7,7 @@ module Biovision
 
       config.generators do |g|
         g.test_framework :rspec
-        g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+        g.fixture_replacement :factory_bot, :dir => 'spec/factories'
       end
     end
   end

data/lib/biovision/vote/version.rb

@@ -1,5 +1,5 @@
 module Biovision
   module Vote
-    VERSION = '0.1.2.170925'
+    VERSION = '0.2.180610'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biovision-vote
 version: !ruby/object:Gem::Version
-  version: 0.1.2.170925
+  version: 0.2.180610
 platform: ruby
 authors:
 - Maxim Khan-Magomedov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -154,15 +154,18 @@ files:
 - app/models/biovision/vote/application_record.rb
 - app/models/concerns/votable_item.rb
 - app/models/vote.rb
+- app/views/admin/index/dashboard/_biovision_vote.html.erb
 - app/views/admin/votes/_nav_item.html.erb
 - app/views/admin/votes/entity/_in_list.html.erb
 - app/views/admin/votes/index.html.erb
 - app/views/layouts/biovision/vote/application.html.erb
 - app/views/votes/_vote_block.html.erb
 - app/views/votes/result.jbuilder
+- config/locales/votes-en.yml
 - config/locales/votes-ru.yml
 - config/routes.rb
 - db/migrate/20170330000001_create_votes.rb
+- db/migrate/20180610110015_add_slug_to_votes.rb
 - lib/biovision/vote.rb
 - lib/biovision/vote/engine.rb
 - lib/biovision/vote/version.rb
@@ -187,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Voting functionality for biovision-based applications