biovision-vote 0.2.180610 → 0.4.190905.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adda0f4c749b69d036ee7ed68eeb0bf5c7b239b0bcf1e319a0b41047159fa528
-  data.tar.gz: 70afc612c239040da36ab2d3c4e576749bd2ae5301373ece07dd80029f97a118
+  metadata.gz: b9622a08b05afd38c9d1c3114c2abc19e83f12b64729060216cfd5f7acf8df19
+  data.tar.gz: 5c561a9230de49435f88ecec4e7aab3d04bc60973aa942af44d17268ac9bc2ac
 SHA512:
-  metadata.gz: bc1b959e92bb5d0bfb80d52fc8253bb3b5c049348cdb38bb2aa55a8aa5622a7b112dc464169dc273a0e3880a6eb93ecaf3255ba5d2bc87d1c53cfb02c42dcd94
-  data.tar.gz: 9d72d310271a1939606abfbe25e8ae66ad06932caf9293002a4a08a3ad43da0438cf0ad937c546db393076211cedc9d4817f2480ec075bc6385d8d28ff4da94b
+  metadata.gz: b9fdc9b015b3cac71815c8a0c340b7130338b777c001f645abd758da328b8b762519bc742d32db0f35a882d240b2415ea9ee236d353ab59d6712b2e1473f1ea6
+  data.tar.gz: 39e630aeb2517455a084bdcdda72fb51bb43b6ad45e9041de6792a7df8cdb9fad052845713a336156d07546ad22806ae9ad6191ae4f308b2bc14c549f52faaf9

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

@@ -32,7 +32,7 @@ document.addEventListener('DOMContentLoaded', function () {
                     handle_ajax_failure(result);
                 };
 
-                const request = Biovision.new_ajax_request('POST', $form.getAttribute('action'), on_success, on_failure);
+                const request = Biovision.jsonAjaxRequest('POST', $form.getAttribute('action'), on_success, on_failure);
 
                 $button.classList.add('switch');
 

data/app/controllers/admin/votes_controller.rb

@@ -1,12 +1,20 @@
+# frozen_string_literal: true
+
+# Administrative part of vote handling
 class Admin::VotesController < AdminController
   # get /admin/votes
   def index
-    @collection = Vote.page_for_administration(current_page)
+    @collection = Vote.list_for_administration.page(current_page)
   end
 
   private
 
+  def component_slug
+    Biovision::Components::VoteComponent::SLUG
+  end
+
   def restrict_access
-    require_privilege :moderator
+    error = 'Managing votes is not allowed'
+    handle_http_401(error) unless component_handler.allow?('moderator')
   end
 end

data/app/controllers/votes_controller.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
+# Handling votes
 class VotesController < ApplicationController
-  before_action :set_entity, only: [:destroy]
+  before_action :set_entity, only: :destroy
 
   # post /votes
   def create
@@ -19,6 +22,10 @@ class VotesController < ApplicationController
 
   private
 
+  def component_slug
+    Biovision::Components::VoteComponent::SLUG
+  end
+
   def set_entity
     @entity = Vote.find_by(id: params[:id])
     if @entity.nil? || !@entity.editable_by?(current_user)
@@ -28,7 +35,7 @@ class VotesController < ApplicationController
 
   def creation_parameters
     parameters = params.require(:vote).permit(Vote.creation_parameters)
-    parameters.merge(owner_for_entity(true))
+    parameters.merge(owner_for_entity(true)).merge(slug: visitor_slug)
   end
 
   def process_vote
@@ -41,9 +48,7 @@ class VotesController < ApplicationController
 
   def count_vote
     @entity.save
-    name = @entity.upvote? ? Vote::METRIC_UPVOTE_HIT : Vote::METRIC_DOWNVOTE_HIT
-    Metric.register(name)
-    Metric.register(Vote::METRIC_VOTE_HIT)
+    component_handler.count_vote(@entity)
 
     render :result, status: :created
   end

data/app/models/concerns/votable_item.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module VotableItem
   extend ActiveSupport::Concern
 
   included do
-    has_many :votes, as: :votable, dependent: :destroy
+    has_many :votes, as: :votable, dependent: :delete_all
   end
 
   # @param [Vote|String] vote_or_slug
@@ -25,6 +27,7 @@ module VotableItem
   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,16 +1,26 @@
+# frozen_string_literal: true
+
+# Vote
+#
+# Attributes:
+#   agent_id [Agent], optional
+#   created_at [DateTime]
+#   delta [Integer]
+#   ip [Inet], optional
+#   slug [String]
+#   updated_at [DateTime]
+#   user_id [User], optional
+#   votable_id [Integer]
+#   votable_type [String]
 class Vote < ApplicationRecord
   include HasOwner
 
-  METRIC_VOTE_HIT     = 'votes.any.hit'
-  METRIC_UPVOTE_HIT   = 'votes.upvote.hit'
-  METRIC_DOWNVOTE_HIT = 'votes.downvote.hit'
-
   belongs_to :user, optional: true
   belongs_to :agent, optional: true
   belongs_to :votable, polymorphic: true
 
   before_validation { self.delta = (delta.to_i > 0 ? 1 : -1) }
-  before_validation :generate_slug
+  before_validation { self.slug = current_slug if slug.blank? }
   validates_uniqueness_of :votable_id, scope: [:slug, :votable_type]
 
   after_create :add_vote_result
@@ -51,7 +61,7 @@ class Vote < ApplicationRecord
   end
 
   def self.creation_parameters
-    %i(votable_id votable_type delta)
+    %i[delta votable_id votable_type]
   end
 
   def upvote?
@@ -73,14 +83,11 @@ class Vote < ApplicationRecord
 
   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?
     votable.downvote_count = votable.downvote_count + 1 if downvote?
+    votable.vote_impact(delta) if votable.respond_to?(:vote_impact)
     votable.save
   end
 

data/app/services/biovision/components/vote_component.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Component for votes
+    class VoteComponent < 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]
+      end
+
+      # @param [Vote] entity
+      def count_vote(entity)
+        name = entity.upvote? ? METRIC_UPVOTE_HIT : METRIC_DOWNVOTE_HIT
+        register_metric(name)
+        register_metric(METRIC_VOTE_HIT)
+      end
+    end
+  end
+end

data/app/views/admin/components/links/_vote.html.erb

@@ -0,0 +1,3 @@
+<% if handler.allow?('moderator') %>
+  <li><%= render 'admin/votes/nav_item' %></li>
+<% end %>

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

@@ -1,6 +1,7 @@
 <% content_for :meta_title, t('.title', page: current_page) %>
 <% content_for :breadcrumbs do %>
-    <span><%= t('admin.votes.nav_item.text') %></span>
+  <%= admin_biovision_component_link(component_handler.component) %>
+  <span><%= t('admin.votes.nav_item.text') %></span>
 <% end %>
 
 <article>

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

@@ -1,17 +1,16 @@
 <%
-  slug = Vote.slug_string(current_user, request.env['HTTP_X_REAL_IP'] || request.remote_ip, agent.id)
-  block_class = votable.vote_applicable?(slug) ? 'active' : ''
+  block_class = votable.vote_applicable?(visitor_slug) ? 'active' : ''
 %>
-<div class="vote-block <%= block_class %> voted-<%= votable.voted(slug) %>" data-id="<%= votable.id %>">
+<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) %>
-      <%= form_tag votes_path, method: :post do %>
-          <%= hidden_field_tag 'vote[votable_id]', entity.votable_id, id: "vote_votable_id_#{votable.id}" %>
-          <%= hidden_field_tag 'vote[votable_type]', entity.votable_type, id: "vote_votable_type_#{votable.id}" %>
-          <%= hidden_field_tag 'vote[delta]', '0', id: "vote_delta_#{votable.id}" %>
+      <% 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 %>
 </div>

data/config/locales/votes-en.yml

@@ -35,3 +35,7 @@ en:
       dashboard:
         biovision_vote:
           heading: "User votes"
+  biovision:
+    components:
+      vote:
+        name: "Vote"

data/config/locales/votes-ru.yml

@@ -16,9 +16,7 @@ ru:
       vote: "Голос"
     attributes:
       vote:
-        agent: "Агент пользователя"
         delta: "Изменение"
-        ip: "IP-адрес"
         slug: "Идентификатор"
         user: "Пользователь"
         votable: "Объект голосования"
@@ -35,3 +33,9 @@ ru:
       dashboard:
         biovision_vote:
           heading: "Голоса пользователей"
+  biovision:
+    components:
+      vote:
+        name: "Голосование"
+        privileges:
+          moderator: "Модератор"

data/config/locales/votes-sv.yml

@@ -0,0 +1,41 @@
+sv:
+  upvote_count:
+    zero: "Inga röster upp"
+    one: "%{count} rösta upp"
+    few: "%{count} röster upp"
+    many: "%{count} röster upp"
+    other: "%{count} röster upp"
+  downvote_count:
+    zero: "Inga röster nere"
+    one: "%{count} rösta ner"
+    few: "%{count} röster ner"
+    many: "%{count} röster ner"
+    other: "%{count} röster ner"
+  activerecord:
+    models:
+      vote: "Omröstning"
+    attributes:
+      vote:
+        agent: "Användaragent"
+        delta: "Delta"
+        ip: "IP-adress"
+        slug: "Pollett"
+        user: "Användare"
+        votable: "Röstade-entitet"
+        votable_id: "Röstade-entitet"
+  admin:
+    votes:
+      nav_item:
+        description: "Hantera användarnas röster"
+        text: "Röster av användare"
+      index:
+        heading: "Röster av användare"
+        title: "Röster av användare, sida %{page}"
+    index:
+      dashboard:
+        biovision_vote:
+          heading: "Röster av användare"
+  biovision:
+    components:
+      vote:
+        name: "Röster"

data/config/routes.rb

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

data/db/migrate/20170330000001_create_votes.rb

@@ -1,22 +1,32 @@
-class CreateVotes < ActiveRecord::Migration[5.1]
+# frozen_string_literal: true
+
+# Create table and component for votes
+class CreateVotes < ActiveRecord::Migration[5.2]
   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
+    create_component
+    create_votes unless Vote.table_exists?
   end
 
   def down
-    if Vote.table_exists?
-      drop_table :votes
+    drop_table :votes if Vote.table_exists?
+  end
+
+  private
+
+  def create_votes
+    create_table :votes, comment: 'Vote' do |t|
+      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
+      t.timestamps
+      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
+
+  def create_component
+    BiovisionComponent.create(slug: Biovision::Components::VoteComponent::SLUG)
+  end
 end

data/lib/biovision/vote/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Biovision
   module Vote
-    VERSION = '0.2.180610'
+    VERSION = '0.4.190905.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biovision-vote
 version: !ruby/object:Gem::Version
-  version: 0.2.180610
+  version: 0.4.190905.0
 platform: ruby
 authors:
 - Maxim Khan-Magomedov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rails-i18n
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: kaminari
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +140,8 @@ 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/services/biovision/components/vote_component.rb
+- app/views/admin/components/links/_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
@@ -163,9 +150,9 @@ files:
 - app/views/votes/result.jbuilder
 - config/locales/votes-en.yml
 - config/locales/votes-ru.yml
+- config/locales/votes-sv.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
@@ -189,8 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Voting functionality for biovision-based applications

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

@@ -1,10 +0,0 @@
-<% 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/db/migrate/20180610110015_add_slug_to_votes.rb

@@ -1,15 +0,0 @@
-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