voting 0.1.0

data/lib/voting/models/voting/voting.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Voting
+  class Voting < ActiveRecord::Base
+    self.table_name = 'voting_votings'
+
+    belongs_to :resource,  polymorphic: true
+    belongs_to :scopeable, polymorphic: true
+
+    validates :estimate, :negative, :positive, :resource, presence: true
+    validates :estimate, numericality: true
+    validates :negative, :positive, numericality: { greater_than_or_equal_to: 0, only_integer: true }
+
+    validates :resource_id, uniqueness: {
+      case_sensitive: false,
+      scope:          %i[resource_type scopeable_id scopeable_type]
+    }
+
+    class << self
+      def values_data(resource, scopeable)
+        sql = %(
+          SELECT
+            COALESCE(SUM(negative), 0) voting_negative,
+            COALESCE(SUM(positive), 0) voting_positive
+          FROM #{vote_table_name}
+          WHERE resource_type = ? and resource_id = ? and #{scope_query(scopeable)}
+        ).squish
+
+        values =  [sql, resource.class.name, resource.id]
+        values += [scopeable.class.name, scopeable.id] unless scopeable.nil?
+
+        execute_sql values
+      end
+
+      def update_voting(resource, scopeable)
+        record = find_or_initialize_by(resource: resource, scopeable: scopeable)
+        values = values_data(resource, scopeable)
+
+        record.estimate = estimate(values)
+        record.negative = values.voting_negative
+        record.positive = values.voting_positive
+
+        record.save!
+      end
+
+      private
+
+      def estimate(values)
+        sum = values.voting_negative + values.voting_positive
+
+        return 0 if sum.zero?
+
+        square = Math.sqrt((values.voting_negative * values.voting_positive) / sum + 0.9604)
+
+        ((values.voting_positive + 1.9208) / sum - 1.96 * square / sum) / (1 + 3.8416 / sum)
+      end
+
+      def execute_sql(sql)
+        Vote.find_by_sql(sql).first
+      end
+
+      def vote_table_name
+        @vote_table_name ||= Vote.table_name
+      end
+
+      def scope_query(scopeable)
+        return 'scopeable_type is NULL and scopeable_id is NULL' if scopeable.nil?
+
+        'scopeable_type = ? and scopeable_id = ?'
+      end
+    end
+  end
+end

data/lib/voting/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Voting
+  VERSION = '0.1.0'
+end

data/spec/factories/article.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :article
+end

data/spec/factories/author.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :author
+end

data/spec/factories/category.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :category
+end

data/spec/factories/comment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :comment
+end

data/spec/factories/voting/vote.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :voting_vote, class: Voting::Vote do
+    author   { create :author }
+    resource { create :comment }
+  end
+end

data/spec/factories/voting/voting.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :voting_voting, class: Voting::Voting do
+    estimate 100
+
+    association :resource, factory: :comment, strategy: :build
+  end
+end

data/spec/models/extension/after_save_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, 'after_save' do
+  context 'when record is author' do
+    let!(:record) { build :author }
+
+    it 'does warm up the cache' do
+      expect(record).not_to receive(:voting_warm_up)
+
+      record.save
+    end
+  end
+
+  context 'when record is not author' do
+    context 'when record has scoping' do
+      let!(:record) { build :article }
+
+      it 'warms up the cache' do
+        expect(record).to receive(:voting_warm_up).with(scoping: :categories)
+
+        record.save
+      end
+    end
+
+    context 'when record has no scoping' do
+      let!(:record) { build :comment }
+
+      it 'warms up the cache' do
+        expect(record).to receive(:voting_warm_up).with(scoping: nil)
+
+        record.save
+      end
+    end
+  end
+end

data/spec/models/extension/as_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, ':as' do
+  context 'when is nil' do
+    let!(:comment) { create :comment }
+
+    it 'creates a voting record with values as zero to warm up the cache' do
+      voting = Voting::Voting.find_by(resource: comment)
+
+      expect(voting.negative).to  eq 0
+      expect(voting.positive).to  eq 0
+      expect(voting.resource).to  eq comment
+      expect(voting.scopeable).to eq nil
+    end
+  end
+
+  context 'when is :author' do
+    let!(:author) { create :author }
+
+    it 'does not creates a voting record' do
+      expect(Voting::Voting.exists?(resource: author)).to eq false
+    end
+  end
+end

data/spec/models/extension/down_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, '.down' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    it 'delegates to create method' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: nil, value: -1
+
+      author.down comment
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { build :category }
+
+    it 'delegates to create method' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: category, value: -1
+
+      author.down comment, scope: category
+    end
+  end
+end

data/spec/models/extension/order_by_voting_spec.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'support/shared_context/with_database_records'
+
+RSpec.describe Voting::Extension, ':order_by_voting' do
+  include_context 'with_database_records'
+
+  context 'with default filters' do
+    it 'sorts by :estimate :desc' do
+      expect(Comment.order_by_voting).to eq [
+        comment_1,
+        comment_2,
+        comment_3
+      ]
+    end
+  end
+
+  context 'when filtering by :estimate' do
+    context 'with asc' do
+      it 'works' do
+        expect(Comment.order_by_voting(:estimate, :asc)).to eq [
+          comment_3,
+          comment_2,
+          comment_1
+        ]
+      end
+
+      context 'with scope' do
+        it 'works' do
+          expect(Comment.order_by_voting(:estimate, :asc, scope: category)).to eq [
+            comment_1
+          ]
+        end
+      end
+    end
+
+    context 'with desc' do
+      it 'works' do
+        expect(Comment.order_by_voting(:estimate, :desc)).to eq [
+          comment_1,
+          comment_2,
+          comment_3
+        ]
+      end
+
+      context 'with scope' do
+        it 'works' do
+          expect(Comment.order_by_voting(:estimate, :desc, scope: category)).to eq [
+            comment_1
+          ]
+        end
+      end
+    end
+  end
+
+  context 'when filtering by :negative' do
+    context 'with asc' do
+      it 'works' do
+        expect(Comment.order_by_voting(:negative, :asc)).to eq [
+          comment_3,
+          comment_1,
+          comment_2
+        ]
+      end
+
+      context 'with scope' do
+        it 'works' do
+          expect(Comment.order_by_voting(:negative, :asc, scope: category)).to eq [
+            comment_1
+          ]
+        end
+      end
+    end
+
+    context 'with desc' do
+      it 'works' do
+        expect(Comment.order_by_voting(:negative, :desc)).to eq [
+          comment_2,
+          comment_1,
+          comment_3
+        ]
+      end
+
+      context 'with scope' do
+        it 'works' do
+          expect(Comment.order_by_voting(:negative, :desc, scope: category)).to eq [
+            comment_1
+          ]
+        end
+      end
+    end
+  end
+end

data/spec/models/extension/up_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, '.up' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    it 'delegates to create method' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: nil, value: 1
+
+      author.up comment
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { build :category }
+
+    it 'delegates to create method' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: category, value: 1
+
+      author.up comment, scope: category
+    end
+  end
+end

data/spec/models/extension/vote_for_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, ':vote_for' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    it 'delegates to vote object' do
+      expect(Voting::Vote).to receive(:vote_for).with author: author, resource: comment, scopeable: nil
+
+      author.vote_for comment
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { build :category }
+
+    it 'delegates to vote object' do
+      expect(Voting::Vote).to receive(:vote_for).with author: author, resource: comment, scopeable: category
+
+      author.vote_for comment, scope: category
+    end
+  end
+end

data/spec/models/extension/vote_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, ':vote' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    it 'delegates to vote object' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: nil, value: 1
+
+      author.vote comment, 1
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { build :category }
+
+    it 'delegates to vote object' do
+      expect(Voting::Vote).to receive(:create).with author: author, resource: comment, scopeable: category, value: 1
+
+      author.vote comment, 1, scope: category
+    end
+  end
+end

data/spec/models/extension/voted_question_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Extension, ':voted?' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    context 'when has no vote for the given resource' do
+      before { allow(author).to receive(:vote_for).with(comment, scope: nil) { nil } }
+
+      specify { expect(author.voted?(comment)).to eq false }
+    end
+
+    context 'when has vote for the given resource' do
+      before { allow(author).to receive(:vote_for).with(comment, scope: nil) { double } }
+
+      specify { expect(author.voted?(comment)).to eq true }
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { build :category }
+
+    context 'when has no vote for the given resource' do
+      before { allow(author).to receive(:vote_for).with(comment, scope: category) { nil } }
+
+      specify { expect(author.voted?(comment, scope: category)).to eq false }
+    end
+
+    context 'when has vote for the given resource' do
+      before { allow(author).to receive(:vote_for).with(comment, scope: category) { double } }
+
+      specify { expect(author.voted?(comment, scope: category)).to eq true }
+    end
+  end
+end

data/spec/models/extension/voted_records_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'support/shared_context/with_database_records'
+
+RSpec.describe Voting::Extension, '.voted_records' do
+  include_context 'with_database_records'
+
+  it 'returns all votes that this author gave' do
+    expect(author_1.voted_records).to match_array [vote_1, vote_4, vote_7]
+  end
+end