nairobi/spec/models/debate_spec.rb

require "rails_helper"

describe Debate do
  let(:debate) { build(:debate) }

  it_behaves_like "globalizable", :debate

  describe "Concerns" do
    it_behaves_like "has_public_author"
    it_behaves_like "notifiable"
    it_behaves_like "sanitizable"
    it_behaves_like "acts as paranoid", :debate
  end

  it "is valid" do
    expect(debate).to be_valid
  end

  it "is not valid without an author" do
    debate.author = nil
    expect(debate).not_to be_valid
  end

  describe "#title" do
    it "is not valid without a title" do
      debate.title = nil
      expect(debate).not_to be_valid
    end

    it "is not valid when very short" do
      debate.title = "abc"
      expect(debate).not_to be_valid
    end

    it "is not valid when very long" do
      debate.title = "a" * 81
      expect(debate).not_to be_valid
    end
  end

  describe "#description" do
    it "is not valid without a description" do
      debate.description = nil
      expect(debate).not_to be_valid
    end

    it "is not valid when very short" do
      debate.description = "abc"
      expect(debate).not_to be_valid
    end

    it "is not valid when very long" do
      debate.description = "a" * 6001
      expect(debate).not_to be_valid
    end
  end

  describe "#tag_list" do
    it "is not valid with a tag list of more than 6 elements" do
      debate.tag_list = ["Hacienda", "Economía", "Medio Ambiente", "Corrupción", "Fiestas populares", "Prensa", "Huelgas"]
      expect(debate).not_to be_valid
    end

    it "is valid with a tag list of 6 elements" do
      debate.tag_list = ["Hacienda", "Economía", "Medio Ambiente", "Corrupción", "Fiestas populares", "Prensa"]
      expect(debate).to be_valid
    end
  end

  it "is not valid without accepting terms of service" do
    debate.terms_of_service = nil
    expect(debate).not_to be_valid
  end

  describe "#editable?" do
    let(:debate) { create(:debate) }

    before { Setting["max_votes_for_debate_edit"] = 3 }

    it "is true if debate has no votes yet" do
      expect(debate.total_votes).to eq(0)
      expect(debate.editable?).to be true
    end

    it "is true if debate has less than limit votes" do
      create_list(:vote, 2, votable: debate)
      expect(debate.total_votes).to eq(2)
      expect(debate.editable?).to be true
    end

    it "is false if debate has more than limit votes" do
      create_list(:vote, 4, votable: debate)
      expect(debate.total_votes).to eq(4)
      expect(debate.editable?).to be false
    end
  end

  describe "#editable_by?" do
    let(:debate) { create(:debate) }

    before { Setting["max_votes_for_debate_edit"] = 1 }

    it "is true if user is the author and debate is editable" do
      expect(debate.editable_by?(debate.author)).to be true
    end

    it "is false if debate is not editable" do
      create_list(:vote, 2, votable: debate)
      expect(debate.editable_by?(debate.author)).to be false
    end

    it "is false if user is not the author" do
      expect(debate.editable_by?(create(:user))).to be false
    end
  end

  describe "#votable_by?" do
    let(:debate) { create(:debate) }

    before do
      Setting["max_ratio_anon_votes_on_debates"] = 50
    end

    it "is true for level two verified users" do
      user = create(:user, residence_verified_at: Time.current, confirmed_phone: "666333111")
      expect(debate.votable_by?(user)).to be true
    end

    it "is true for level three verified users" do
      user = create(:user, verified_at: Time.current)
      expect(debate.votable_by?(user)).to be true
    end

    it "is true for anonymous users if allowed anonymous votes" do
      debate.update!(cached_anonymous_votes_total: 420, cached_votes_total: 1000)
      user = create(:user)
      expect(debate.votable_by?(user)).to be true
    end

    it "is true for anonymous users if less than 100 votes" do
      debate.update!(cached_anonymous_votes_total: 90, cached_votes_total: 92)
      user = create(:user)
      expect(debate.votable_by?(user)).to be true
    end

    it "is false for anonymous users if too many anonymous votes" do
      debate.update!(cached_anonymous_votes_total: 520, cached_votes_total: 1000)
      user = create(:user)
      expect(debate.votable_by?(user)).to be false
    end
  end

  describe "#register_vote" do
    let(:debate) { create(:debate) }

    before do
      Setting["max_ratio_anon_votes_on_debates"] = 50
    end

    describe "from level two verified users" do
      it "registers vote" do
        user = create(:user, residence_verified_at: Time.current, confirmed_phone: "666333111")
        expect { debate.register_vote(user, "yes") }.to change { debate.reload.votes_for.size }.by(1)
      end

      it "does not increase anonymous votes counter " do
        user = create(:user, residence_verified_at: Time.current, confirmed_phone: "666333111")
        expect { debate.register_vote(user, "yes") }.not_to change { debate.reload.cached_anonymous_votes_total }
      end
    end

    describe "from level three verified users" do
      it "registers vote" do
        user = create(:user, verified_at: Time.current)
        expect { debate.register_vote(user, "yes") }.to change { debate.reload.votes_for.size }.by(1)
      end

      it "does not increase anonymous votes counter " do
        user = create(:user, verified_at: Time.current)
        expect { debate.register_vote(user, "yes") }.not_to change { debate.reload.cached_anonymous_votes_total }
      end
    end

    describe "from anonymous users when anonymous votes are allowed" do
      before { debate.update(cached_anonymous_votes_total: 42, cached_votes_total: 100) }

      it "registers vote" do
        user = create(:user)
        expect { debate.register_vote(user, "yes") }.to change { debate.reload.votes_for.size }.by(1)
      end

      it "increases anonymous votes counter" do
        user = create(:user)
        expect { debate.register_vote(user, "yes") }.to change { debate.reload.cached_anonymous_votes_total }.by(1)
      end
    end

    describe "from anonymous users when there are too many anonymous votes" do
      before { debate.update(cached_anonymous_votes_total: 520, cached_votes_total: 1000) }

      it "does not register vote " do
        user = create(:user)
        expect { debate.register_vote(user, "yes") }.not_to change { debate.reload.votes_for.size }
      end

      it "does not increase anonymous votes counter " do
        user = create(:user)
        expect { debate.register_vote(user, "yes") }.not_to change { debate.reload.cached_anonymous_votes_total }
      end
    end
  end

  describe "#anonymous_votes_ratio" do
    it "returns the percentage of anonymous votes of the total votes" do
      debate = create(:debate, cached_anonymous_votes_total: 25, cached_votes_total: 100)
      expect(debate.anonymous_votes_ratio).to eq(25.0)
    end
  end

  describe "#hot_score" do
    let(:now) { Time.current }

    it "period is correctly calculated to get exact votes per day" do
      new_debate = create(:debate, created_at: 23.hours.ago)
      2.times { new_debate.vote_by(voter: create(:user), vote: "yes") }
      expect(new_debate.hot_score).to be 2

      old_debate = create(:debate, created_at: 25.hours.ago)
      2.times { old_debate.vote_by(voter: create(:user), vote: "yes") }
      expect(old_debate.hot_score).to be 1

      older_debate = create(:debate, created_at: 49.hours.ago)
      3.times { older_debate.vote_by(voter: create(:user), vote: "yes") }
      expect(old_debate.hot_score).to be 1
    end

    it "remains the same for not voted debates" do
      new = create(:debate, created_at: now)
      old = create(:debate, created_at: 1.day.ago)
      older = create(:debate, created_at: 2.months.ago)
      expect(new.hot_score).to be 0
      expect(old.hot_score).to be 0
      expect(older.hot_score).to be 0
    end

    it "increases for debates with more positive votes" do
      more_positive_votes = create(:debate)
      2.times { more_positive_votes.vote_by(voter: create(:user), vote: "yes") }

      less_positive_votes = create(:debate)
      less_positive_votes.vote_by(voter: create(:user), vote: "yes")

      expect(more_positive_votes.hot_score).to be > less_positive_votes.hot_score
    end

    it "increases for debates with the same amount of positive votes within less days" do
      newer_debate = create(:debate, created_at: now)
      5.times { newer_debate.vote_by(voter: create(:user), vote: "yes") }

      older_debate = create(:debate, created_at: 2.days.ago)
      5.times { older_debate.vote_by(voter: create(:user), vote: "yes") }

      expect(newer_debate.hot_score).to be > older_debate.hot_score
    end

    it "decreases for debates with more negative votes" do
      more_negative_votes = create(:debate)
      5.times { more_negative_votes.vote_by(voter: create(:user), vote: "yes") }
      3.times { more_negative_votes.vote_by(voter: create(:user), vote: "no") }

      less_negative_votes = create(:debate)
      5.times { less_negative_votes.vote_by(voter: create(:user), vote: "yes") }
      2.times { less_negative_votes.vote_by(voter: create(:user), vote: "no") }

      expect(more_negative_votes.hot_score).to be < less_negative_votes.hot_score
    end

    it "increases for debates voted within the period (last month by default)" do
      newer_debate = create(:debate, created_at: 2.months.ago)
      20.times { create(:vote, votable: newer_debate, created_at: 3.days.ago) }

      older_debate = create(:debate, created_at: 2.months.ago)
      20.times { create(:vote, votable: older_debate, created_at: 40.days.ago) }

      expect(newer_debate.hot_score).to be > older_debate.hot_score
    end

    describe "actions which affect it" do
      let(:debate) { create(:debate) }

      before do
        5.times { debate.vote_by(voter: create(:user), vote: "yes") }
        2.times { debate.vote_by(voter: create(:user), vote: "no") }
      end

      it "increases with positive votes" do
        previous = debate.hot_score
        3.times { debate.vote_by(voter: create(:user), vote: "yes") }
        expect(previous).to be < debate.hot_score
      end

      it "decreases with negative votes" do
        previous = debate.hot_score
        3.times { debate.vote_by(voter: create(:user), vote: "no") }
        expect(previous).to be > debate.hot_score
      end
    end
  end

  describe "#confidence_score" do
    it "takes into account percentage of total votes and total_positive and total negative votes" do
      debate = create(:debate, :with_confidence_score, cached_votes_up: 100, cached_votes_score: 100, cached_votes_total: 100)
      expect(debate.confidence_score).to eq(10000)

      debate = create(:debate, :with_confidence_score, cached_votes_up: 0, cached_votes_total: 100)
      expect(debate.confidence_score).to eq(0)

      debate = create(:debate, :with_confidence_score, cached_votes_up: 0, cached_votes_total: 0)
      expect(debate.confidence_score).to eq(1)

      debate = create(:debate, :with_confidence_score, cached_votes_up: 75, cached_votes_total: 100)
      expect(debate.confidence_score).to eq(3750)

      debate = create(:debate, :with_confidence_score, cached_votes_up: 750, cached_votes_total: 1000)
      expect(debate.confidence_score).to eq(37500)

      debate = create(:debate, :with_confidence_score, cached_votes_up: 10, cached_votes_total: 100)
      expect(debate.confidence_score).to eq(-800)
    end

    describe "actions which affect it" do
      let(:debate) { create(:debate, :with_confidence_score) }

      it "increases with like" do
        previous = debate.confidence_score
        5.times { debate.register_vote(create(:user), true) }
        expect(previous).to be < debate.confidence_score
      end

      it "decreases with dislikes" do
        debate.register_vote(create(:user), true)
        previous = debate.confidence_score
        3.times { debate.register_vote(create(:user), false) }
        expect(previous).to be > debate.confidence_score
      end
    end
  end

  describe "cache" do
    let(:debate) { create(:debate) }

    it "expires cache when it has a new comment" do
      expect { create(:comment, commentable: debate) }
      .to change { debate.updated_at }
    end

    it "expires cache when it has a new vote" do
      expect { create(:vote, votable: debate) }
      .to change { debate.updated_at }
    end

    it "expires cache when it has a new flag" do
      expect { create(:flag, flaggable: debate) }
      .to change { debate.reload.updated_at }
    end

    it "expires cache when it has a new tag" do
      expect { debate.update(tag_list: "new tag") }
      .to change { debate.updated_at }
    end

    it "expires cache when hidden" do
      expect { debate.hide }
      .to change { debate.updated_at }
    end

    it "expires cache when the author is hidden" do
      expect { debate.author.hide }
      .to change { [debate.reload.updated_at, debate.author.updated_at] }
    end

    it "expires cache when the author is erased" do
      expect { debate.author.erase }
      .to change { [debate.reload.updated_at, debate.author.updated_at] }
    end

    it "expires cache when its author changes" do
      expect { debate.author.update(username: "Eva") }
      .to change { [debate.reload.updated_at, debate.author.updated_at] }
    end

    it "expires cache when the author's organization get verified" do
      create(:organization, user: debate.author)
      expect { debate.author.organization.verify }
      .to change { [debate.reload.updated_at, debate.author.updated_at] }
    end
  end

  describe "custom tag counters when hiding/restoring" do
    it "decreases the tag counter when hiden, and increases it when restored" do
      debate = create(:debate, tag_list: "foo")
      tag = Tag.find_by(name: "foo")
      expect(tag.debates_count).to eq(1)

      debate.hide
      expect(tag.reload.debates_count).to eq(0)

      debate.restore
      expect(tag.reload.debates_count).to eq(1)
    end
  end

  describe "conflictive debates" do
    it "returns true when it has more than 1 flag for 5 positive votes" do
      debate.update!(cached_votes_up: 4)
      debate.update!(flags_count: 1)
      expect(debate).to be_conflictive

      debate.update!(cached_votes_up: 9)
      debate.update!(flags_count: 2)
      expect(debate).to be_conflictive

      debate.update!(cached_votes_up: 14)
      debate.update!(flags_count: 3)
      expect(debate).to be_conflictive

      debate.update!(cached_votes_up: 2)
      debate.update!(flags_count: 20)
      expect(debate).to be_conflictive
    end

    it "returns false when it has less than or equal to 1 flag for 5 positive votes" do
      debate.update!(cached_votes_up: 5)
      debate.update!(flags_count: 1)
      expect(debate).not_to be_conflictive

      debate.update!(cached_votes_up: 10)
      debate.update!(flags_count: 2)
      expect(debate).not_to be_conflictive

      debate.update!(cached_votes_up: 100)
      debate.update!(flags_count: 2)
      expect(debate).not_to be_conflictive
    end

    it "returns false when it has no flags" do
      debate.update!(flags_count: 0)
      expect(debate).not_to be_conflictive
    end

    it "returns false when it has not votes up" do
      debate.update!(cached_votes_up: 0)
      expect(debate).not_to be_conflictive
    end
  end

  describe "search" do
    context "attributes" do
      let(:attributes) do
        { title: "save the world",
          description: "in order to save the world one must think about...",
          title_es: "para salvar el mundo uno debe pensar en...",
          description_es: "uno debe pensar" }
      end

      it "searches by title" do
        debate = create(:debate, attributes)
        results = Debate.search("save the world")
        expect(results).to eq([debate])
      end

      it "searches by title across all languages translations" do
        debate = create(:debate, attributes)
        results = Debate.search("salvar el mundo")
        expect(results).to eq([debate])
      end

      it "searches by description" do
        debate = create(:debate, attributes)
        results = Debate.search("one must think")
        expect(results).to eq([debate])
      end

      it "searches by description across all languages translations" do
        debate = create(:debate, attributes)
        results = Debate.search("uno debe pensar")
        expect(results).to eq([debate])
      end

      it "searches by author name" do
        author = create(:user, username: "Danny Trejo")
        debate = create(:debate, author: author)
        results = Debate.search("Danny")
        expect(results).to eq([debate])
      end

      it "searches by geozone" do
        geozone = create(:geozone, name: "California")
        debate = create(:debate, geozone: geozone)
        results = Debate.search("California")
        expect(results).to eq([debate])
      end
    end

    context "stemming" do
      it "searches word stems in Spanish" do
        allow(SearchDictionarySelector).to receive(:call).and_return("spanish")
        debate = create(:debate, title: "limpiar")

        results = Debate.search("limpiará")
        expect(results).to eq([debate])

        results = Debate.search("limpiémos")
        expect(results).to eq([debate])

        results = Debate.search("limpió")
        expect(results).to eq([debate])
      end
    end

    context "accents" do
      it "searches with accents" do
        debate = create(:debate, title: "difusión")

        results = Debate.search("difusion")
        expect(results).to eq([debate])

        debate2 = create(:debate, title: "estadisticas")
        results = Debate.search("estadísticas")
        expect(results).to eq([debate2])

        debate3 = create(:debate, title: "público")
        results = Debate.search("publico")
        expect(results).to eq([debate3])
      end
    end

    context "case" do
      it "searches case insensite" do
        debate = create(:debate, title: "SHOUT")

        results = Debate.search("shout")
        expect(results).to eq([debate])

        debate2 = create(:debate, title: "scream")
        results = Debate.search("SCREAM")
        expect(results).to eq([debate2])
      end
    end

    context "tags" do
      it "searches by tags" do
        debate = create(:debate, tag_list: "Latina")

        results = Debate.search("Latina")
        expect(results.first).to eq(debate)

        results = Debate.search("Latin")
        expect(results.first).to eq(debate)
      end
    end

    context "order" do
      it "orders by weight" do
        debate_description = create(:debate,  description: "stop corruption")
        debate_title       = create(:debate,  title:       "stop corruption")

        results = Debate.search("stop corruption")

        expect(results).to eq [debate_title, debate_description]
      end

      it "orders by weight and then votes" do
        title_some_votes    = create(:debate, title: "stop corruption", cached_votes_up: 5)
        title_least_voted   = create(:debate, title: "stop corruption", cached_votes_up: 2)
        title_most_voted    = create(:debate, title: "stop corruption", cached_votes_up: 10)
        description_most_voted = create(:debate, description: "stop corruption", cached_votes_up: 10)

        results = Debate.search("stop corruption")

        expect(results).to eq [title_most_voted, title_some_votes, title_least_voted, description_most_voted]
      end

      it "gives much more weight to word matches than votes" do
        exact_title_few_votes    = create(:debate, title: "stop corruption", cached_votes_up: 5)
        similar_title_many_votes = create(:debate, title: "stop some of the corruption", cached_votes_up: 500)

        results = Debate.search("stop corruption")

        expect(results).to eq [exact_title_few_votes, similar_title_many_votes]
      end
    end

    context "reorder" do
      it "is able to reorder by hot_score after searching" do
        lowest_score  = create(:debate,  title: "stop corruption", cached_votes_up: 1)
        highest_score = create(:debate,  title: "stop corruption", cached_votes_up: 2)
        average_score = create(:debate,  title: "stop corruption", cached_votes_up: 3)

        lowest_score.update_column(:hot_score, 1)
        highest_score.update_column(:hot_score, 100)
        average_score.update_column(:hot_score, 10)

        results = Debate.search("stop corruption")

        expect(results).to eq [average_score, highest_score, lowest_score]

        results = results.sort_by_hot_score

        expect(results).to eq [highest_score, average_score, lowest_score]
      end

      it "is able to reorder by confidence_score after searching" do
        lowest_score  = create(:debate,  title: "stop corruption", cached_votes_up: 1)
        highest_score = create(:debate,  title: "stop corruption", cached_votes_up: 2)
        average_score = create(:debate,  title: "stop corruption", cached_votes_up: 3)

        lowest_score.update_column(:confidence_score, 1)
        highest_score.update_column(:confidence_score, 100)
        average_score.update_column(:confidence_score, 10)

        results = Debate.search("stop corruption")

        expect(results).to eq [average_score, highest_score, lowest_score]

        results = results.sort_by_confidence_score

        expect(results).to eq [highest_score, average_score, lowest_score]
      end

      it "is able to reorder by created_at after searching" do
        recent  = create(:debate,  title: "stop corruption", cached_votes_up: 1, created_at: 1.week.ago)
        newest  = create(:debate,  title: "stop corruption", cached_votes_up: 2, created_at: Time.current)
        oldest  = create(:debate,  title: "stop corruption", cached_votes_up: 3, created_at: 1.month.ago)

        results = Debate.search("stop corruption")

        expect(results).to eq [oldest, newest, recent]

        results = results.sort_by_created_at

        expect(results).to eq [newest, recent, oldest]
      end

      it "is able to reorder by most commented after searching" do
        least_commented = create(:debate,  title: "stop corruption",  cached_votes_up: 1, comments_count: 1)
        most_commented  = create(:debate,  title: "stop corruption",  cached_votes_up: 2, comments_count: 100)
        some_comments   = create(:debate,  title: "stop corruption",  cached_votes_up: 3, comments_count: 10)

        results = Debate.search("stop corruption")

        expect(results).to eq [some_comments, most_commented, least_commented]

        results = results.sort_by_most_commented

        expect(results).to eq [most_commented, some_comments, least_commented]
      end
    end

    context "no results" do
      it "no words match" do
        create(:debate, title: "save world")

        results = Debate.search("destroy planet")
        expect(results).to eq([])
      end

      it "too many typos" do
        create(:debate, title: "fantastic")

        results = Debate.search("frantac")
        expect(results).to eq([])
      end

      it "too much stemming" do
        create(:debate, title: "reloj")

        results = Debate.search("superrelojimetro")
        expect(results).to eq([])
      end

      it "empty" do
        create(:debate, title: "great")

        results = Debate.search("")
        expect(results).to eq([])
      end
    end
  end

  describe "#last_week" do
    it "returns debates created this week" do
      debate = create(:debate)

      expect(Debate.last_week.all).to eq [debate]
    end

    it "does not show debates created more than a week ago" do
      create(:debate, created_at: 8.days.ago)

      expect(Debate.last_week.all).to be_empty
    end
  end

  describe "#to_param" do
    it "returns a friendly url" do
      expect(debate.to_param).to eq "#{debate.id} #{debate.title}".parameterize
    end
  end

  describe "public_for_api scope" do
    it "returns debates" do
      debate = create(:debate)

      expect(Debate.public_for_api).to eq [debate]
    end

    it "does not return hidden debates" do
      create(:debate, :hidden)

      expect(Debate.public_for_api).to be_empty
    end
  end

  describe "#recommendations" do
    let(:user) { create(:user) }

    it "does not return any debates when user has not interests" do
      create(:debate)

      expect(Debate.recommendations(user)).to be_empty
    end

    it "returns debates related to the user's interests ordered by cached_votes_total" do
      create(:proposal, tag_list: "Sport", followers: [user])

      debate1 =  create(:debate, cached_votes_total: 1, tag_list: "Sport")
      debate2 =  create(:debate, cached_votes_total: 5, tag_list: "Sport")
      debate3 =  create(:debate, cached_votes_total: 10, tag_list: "Sport")

      results = Debate.recommendations(user).sort_by_recommendations

      expect(results).to eq [debate3, debate2, debate1]
    end

    it "does not return debates unrelated to user interests" do
      create(:proposal, tag_list: "Sport", followers: [user])
      create(:debate, tag_list: "Politics")

      results = Debate.recommendations(user)

      expect(results).to be_empty
    end

    it "does not return debates when user is the author" do
      create(:proposal, tag_list: "Sport", followers: [user])
      create(:debate, author: user, tag_list: "Sport")

      results = Debate.recommendations(user)

      expect(results).to be_empty
    end
  end
end