biovision-vote 0.4.190905.0 → 0.6.200627.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9622a08b05afd38c9d1c3114c2abc19e83f12b64729060216cfd5f7acf8df19
-  data.tar.gz: 5c561a9230de49435f88ecec4e7aab3d04bc60973aa942af44d17268ac9bc2ac
+  metadata.gz: d0b3721a3296b82fb23854ea3bdd4365a278fef68ea522d0d84da05c3e6162d5
+  data.tar.gz: 6596c3c780a7e2ddc47bac92924fdad775495f5531a67f87e7083ee0f032a4dd
 SHA512:
-  metadata.gz: b9fdc9b015b3cac71815c8a0c340b7130338b777c001f645abd758da328b8b762519bc742d32db0f35a882d240b2415ea9ee236d353ab59d6712b2e1473f1ea6
-  data.tar.gz: 39e630aeb2517455a084bdcdda72fb51bb43b6ad45e9041de6792a7df8cdb9fad052845713a336156d07546ad22806ae9ad6191ae4f308b2bc14c549f52faaf9
+  metadata.gz: 250ac4ffb39d351bea23e77056173fbe7d73834318121ba74923cf1305aa175bae7b676cd5880116976ddf38559374b31d8326e0db0d10b6c4296cbe8f975d8f
+  data.tar.gz: 7276e36d6d53e06091b01711d671f1cb05782714cf2789cf4b6990a6e45798564b672c33c013d01070289dae306bed24428f3cbab9c01cdd89d5bb09ce887db4

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

@@ -1,97 +1,66 @@
-'use strict';
-
-document.addEventListener('DOMContentLoaded', function () {
-    document.querySelectorAll('.vote-block.active .vote').forEach(function (element) {
-        element.addEventListener('click', function () {
-            const $button = this;
-            const $container = $button.closest('.vote-block');
-            const votable_id = $container.getAttribute('data-id');
-            const upvote = $button.classList.contains('upvote');
-
-            document.getElementById('vote_delta_' + votable_id).value = upvote ? '1' : '-1';
-
-            if ($container.classList.contains('active')) {
-                const $form = $container.querySelector('form');
-                const on_success = function () {
-                    const result = JSON.parse(this.responseText);
-
-                    $button.classList.remove('switch');
-                    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);
-                        $container.querySelector('.result').innerHTML = vote_result;
-                    }
-                };
-
-                const on_failure = function (result) {
-                    $button.classList.remove('switch');
-                    $button.classList.add('error');
-                    handle_ajax_failure(result);
-                };
-
-                const request = Biovision.jsonAjaxRequest('POST', $form.getAttribute('action'), on_success, on_failure);
-
-                $button.classList.add('switch');
-
-                request.send(new FormData($form));
+"use strict";
+
+const Votes = {
+    initialized: false,
+    autoInitComponents: true,
+    components: {}
+};
+
+Votes.components.voteButtons = {
+    initialized: false,
+    buttons: [],
+    url: "/votes",
+    selector: ".vote-block .vote",
+    init: function () {
+        document.querySelectorAll(this.selector).forEach(this.apply);
+        this.initialized = true;
+    },
+    apply: function (button) {
+        const component = Votes.components.voteButtons;
+        component.buttons.push(button);
+        button.addEventListener("click", component.click);
+    },
+    click: function (event) {
+        const component = Votes.components.voteButtons;
+        const button = event.target;
+        const delta = button.classList.contains("upvote") ? 1 : -1;
+        const container = button.closest(".vote-block");
+        const data = {
+            "vote": {
+                "votable_id": container.getAttribute("data-id"),
+                "votable_type": container.getAttribute("data-type"),
+                "delta": delta
             }
+        };
 
-            $container.classList.remove('active');
+        container.querySelectorAll(".vote").forEach(function (element) {
+            element.disabled = true;
         });
-    });
 
-    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');
+        const onSuccess = function () {
+            const result = JSON.parse(this.responseText);
+            if (result.hasOwnProperty("meta")) {
+                const meta = result.meta;
 
-                button.addEventListener('click', function () {
-                    const delta = this.getAttribute('data-vote') === 'up' ? 1 : -1;
-                    const pressedButton = this;
+                container.classList.remove("voted-none");
+                container.classList.add("voted-" + meta["vote_type"]);
+                container.querySelector(".result").innerHTML = meta["vote_result"];
+                button.classList.remove("switch");
+            }
+        };
 
-                    /**
-                     * Во время голосования состояние переключается
-                     * на 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 onFailure = function () {
+            button.classList.remove("switch");
+            button.classList.add("error");
 
-                        const request = Biovision.jsonAjaxRequest('POST', url, function () {
-                            if (this.responseText) {
-                                const response = JSON.parse(this.responseText);
+            Biovision.handleAjaxFailure();
+        };
 
-                                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');
-                            }
-                        });
+        const request = Biovision.jsonAjaxRequest("POST", component.url, onSuccess, onFailure);
 
-                        container.classList.remove('vote-active');
-                        container.classList.add('vote-inactive');
+        button.classList.add("switch");
+        request.send(JSON.stringify(data));
+    }
+};
 
-                        request.send(JSON.stringify(data));
-                    }
-                });
-            }
-        }
-    });
-});
+Biovision.components.votes = Votes;

data/app/assets/stylesheets/biovision/vote/vote.scss

@@ -5,23 +5,27 @@
 
   .vote {
     background: no-repeat center / cover;
+    border: none;
+    cursor: pointer;
     height: 1.2rem;
     width: 1.2rem;
-  }
 
-  &.active {
-    .vote {
-      cursor: pointer;
+    &:focus {
+      box-shadow: 0 0 .2rem rgba(0, 0, 0, .5);
+    }
+
+    &:disabled {
+      cursor: default;
     }
+  }
 
-    &.voted-none {
-      .upvote:hover {
-        background-image: image_url('biovision/vote/icons/upvote-active.svg');
-      }
+  &.voted-none {
+    .upvote:not(:disabled):hover {
+      background-image: image_url('biovision/vote/icons/upvote-active.svg');
+    }
 
-      .downvote:hover {
-        background-image: image_url('biovision/vote/icons/downvote-active.svg');
-      }
+    .downvote:not(:disabled):hover {
+      background-image: image_url('biovision/vote/icons/downvote-active.svg');
     }
   }
 

data/app/controllers/admin/votes_controller.rb

@@ -9,8 +9,8 @@ class Admin::VotesController < AdminController
 
   private
 
-  def component_slug
-    Biovision::Components::VoteComponent::SLUG
+  def component_class
+    Biovision::Components::VotesComponent
   end
 
   def restrict_access

data/app/controllers/votes_controller.rb

@@ -22,8 +22,8 @@ class VotesController < ApplicationController
 
   private
 
-  def component_slug
-    Biovision::Components::VoteComponent::SLUG
+  def component_class
+    Biovision::Components::VotesComponent
   end
 
   def set_entity

data/app/models/concerns/votable_item.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Model has votes
 module VotableItem
   extend ActiveSupport::Concern
 
@@ -16,10 +17,10 @@ module VotableItem
   # @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(vote_or_slug)
+      upvote_count: data.dig('votes', 'up'),
+      downvote_count: data.dig('votes', 'down'),
+      vote_result: data.dig('votes', 'total'),
+      vote_type: voted(vote_or_slug)
     }
   end
 
@@ -30,4 +31,30 @@ module VotableItem
 
     vote.upvote? ? :upvote : :downvote
   end
+
+  # @param [Integer] delta
+  def add_vote_result(delta)
+    return unless has_attribute?(:data)
+
+    vote_data = data['votes'].to_h
+    key = delta.positive? ? 'up' : 'down'
+    vote_data[key] = vote_data.key?(key) ? vote_data[key].to_i + 1 : 1
+    vote_data['total'] = vote_data.key?('total') ? vote_data['total'] + delta : delta
+    self.data['votes'] = vote_data
+
+    save
+  end
+
+  # @param [Integer] delta
+  def discard_vote_result(delta)
+    return unless has_attribute?(:data)
+
+    vote_data = data['votes'].to_h
+    key = delta.positive? ? 'up' : 'down'
+    vote_data[key] = vote_data[key].to_i - 1 if vote_data[key].to_i.positive?
+    vote_data['total'] = vote_data['total'].to_i - delta
+    self.data['votes'] = vote_data
+
+    save
+  end
 end

data/app/models/vote.rb

@@ -10,10 +10,12 @@
 #   slug [String]
 #   updated_at [DateTime]
 #   user_id [User], optional
+#   uuid [UUID]
 #   votable_id [Integer]
 #   votable_type [String]
 class Vote < ApplicationRecord
   include HasOwner
+  include HasUuid
 
   belongs_to :user, optional: true
   belongs_to :agent, optional: true
@@ -74,7 +76,7 @@ class Vote < ApplicationRecord
 
   # @param [User] user
   def editable_by?(user)
-    owned_by?(user) || UserPrivilege.user_has_privilege?(:user, :moderator)
+    owned_by?(user) || user&.super_user?
   end
 
   def current_slug
@@ -84,17 +86,11 @@ class Vote < ApplicationRecord
   private
 
   def add_vote_result
-    votable.vote_result    = votable.vote_result + delta
-    votable.upvote_count   = votable.upvote_count + 1 if upvote?
-    votable.downvote_count = votable.downvote_count + 1 if downvote?
+    votable.add_vote_result(delta)
     votable.vote_impact(delta) if votable.respond_to?(:vote_impact)
-    votable.save
   end
 
   def discard_vote_result
-    votable.vote_result    = votable.vote_result - delta
-    votable.upvote_count   = votable.upvote_count - 1 if upvote?
-    votable.downvote_count = votable.downvote_count - 1 if downvote?
-    votable.save
+    votable.discard_vote_result(delta)
   end
 end

data/app/services/biovision/components/{vote_component.rb → votes_component.rb}

@@ -3,11 +3,10 @@
 module Biovision
   module Components
     # Component for votes
-    class VoteComponent < BaseComponent
+    class VotesComponent < BaseComponent
       METRIC_VOTE_HIT = 'votes.any.hit'
       METRIC_UPVOTE_HIT = 'votes.upvote.hit'
       METRIC_DOWNVOTE_HIT = 'votes.downvote.hit'
-      SLUG = 'vote'
 
       def self.privilege_names
         %w[moderator]

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

@@ -1,16 +1,10 @@
-<%
-  block_class = votable.vote_applicable?(visitor_slug) ? 'active' : ''
-%>
-<div class="vote-block <%= block_class %> voted-<%= votable.voted(visitor_slug) %>" data-id="<%= votable.id %>">
-  <div class="vote upvote"></div>
-  <div class="result"><%= votable.vote_result %></div>
-  <div class="vote downvote"></div>
-  <% unless block_class.blank? %>
-      <% entity = Vote.new(votable: votable, delta: 0) %>
-      <%= form_with(model: entity, local: true) do %>
-          <%= f.hidden_field :votable_id, id: "vote_votable_id_#{votable.id}" %>
-          <%= f.hidden_field :votable_type, id: "vote_votable_type_#{votable.id}" %>
-          <%= f.hidden_field :delta, id: "vote_delta_#{votable.id}" %>
-      <% end %>
-  <% end %>
+<% postfix = votable.vote_applicable?(visitor_slug) ? '' : ' disabled' %>
+<div
+  class="vote-block voted-<%= votable.voted(visitor_slug) %>"
+  data-id="<%= votable.id %>"
+  data-type="<%= votable.class.to_s %>"
+>
+  <button class="vote upvote"<%= postfix %>></button>
+  <div class="result"><%= votable.data.dig('votes', 'total').to_i %></div>
+  <button class="vote downvote"<%= postfix %>></button>
 </div>

data/config/locales/votes-en.yml

@@ -37,5 +37,5 @@ en:
           heading: "User votes"
   biovision:
     components:
-      vote:
+      votes:
         name: "Vote"

data/config/locales/votes-ru.yml

@@ -35,7 +35,7 @@ ru:
           heading: "Голоса пользователей"
   biovision:
     components:
-      vote:
+      votes:
         name: "Голосование"
         privileges:
           moderator: "Модератор"

data/config/locales/votes-sv.yml

@@ -37,5 +37,5 @@ sv:
           heading: "Röster av användare"
   biovision:
     components:
-      vote:
+      votes:
         name: "Röster"

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
   resources :votes, only: :destroy, defaults: { format: :json }
 

data/db/migrate/20170330000001_create_votes.rb

@@ -15,6 +15,7 @@ class CreateVotes < ActiveRecord::Migration[5.2]
 
   def create_votes
     create_table :votes, comment: 'Vote' do |t|
+      t.uuid :uuid, null: false
       t.references :user, foreign_key: { on_update: :cascade, on_delete: :cascade }
       t.references :agent, foreign_key: { on_update: :cascade, on_delete: :nullify }
       t.inet :ip
@@ -24,9 +25,11 @@ class CreateVotes < ActiveRecord::Migration[5.2]
       t.string :votable_type, null: false
       t.string :slug, index: true
     end
+
+    add_index :votes, :uuid, unique: true
   end
 
   def create_component
-    BiovisionComponent.create(slug: Biovision::Components::VoteComponent::SLUG)
+    BiovisionComponent.create(slug: Biovision::Components::VotesComponent.slug)
   end
 end

data/db/migrate/20200207101010_add_uuid_to_votes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Add UUID column to votes and rename component to "votes"
+class AddUuidToVotes < ActiveRecord::Migration[5.2]
+  def up
+    criteria = { slug: Biovision::Components::VotesComponent.slug }
+
+    return if BiovisionComponent.where(criteria).exists?
+
+    BiovisionComponent['vote']&.update!(criteria) || BiovisionComponent.create(criteria)
+
+    add_column :votes, :uuid, :uuid
+    add_index :votes, :uuid, unique: true
+
+    Vote.order('id asc').each(&:save!)
+  end
+
+  def down
+    # No rollback needed
+  end
+end

data/lib/biovision/vote/version.rb

@@ -2,6 +2,6 @@
 
 module Biovision
   module Vote
-    VERSION = '0.4.190905.0'
+    VERSION = '0.6.200627.0'
   end
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: biovision-vote
 version: !ruby/object:Gem::Version
-  version: 0.4.190905.0
+  version: 0.6.200627.0
 platform: ruby
 authors:
 - Maxim Khan-Magomedov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rails-i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: biovision-base
   requirement: !ruby/object:Gem::Requirement
@@ -140,8 +112,8 @@ files:
 - app/models/biovision/vote/application_record.rb
 - app/models/concerns/votable_item.rb
 - app/models/vote.rb
-- app/services/biovision/components/vote_component.rb
-- app/views/admin/components/links/_vote.html.erb
+- app/services/biovision/components/votes_component.rb
+- app/views/admin/components/links/_votes.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
@@ -153,6 +125,7 @@ files:
 - config/locales/votes-sv.yml
 - config/routes.rb
 - db/migrate/20170330000001_create_votes.rb
+- db/migrate/20200207101010_add_uuid_to_votes.rb
 - lib/biovision/vote.rb
 - lib/biovision/vote/engine.rb
 - lib/biovision/vote/version.rb
@@ -176,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Voting functionality for biovision-based applications