openproject/spec/models/cost_query/operator_spec.rb

#-- copyright
# OpenProject Reporting Plugin
#
# Copyright (C) 2010 - 2014 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# version 3.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#++

require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')

describe CostQuery, type: :model, reporting_query_helper: true do
  minimal_query

  let!(:project1) { FactoryGirl.create(:project, name: "project1", created_on: 5.minutes.ago) }
  let!(:project2) { FactoryGirl.create(:project, name: "project2", created_on: 6.minutes.ago) }

  describe CostQuery::Operator do
    def query(table, field, operator, *values)
      sql = CostQuery::SqlStatement.new table
      yield sql if block_given?
      operator.to_operator.modify sql, field, *values
      ActiveRecord::Base.connection.select_all sql.to_s
    end

    def query_on_entries(field, operator, *values)
      sql = CostQuery::SqlStatement.for_entries
      operator.to_operator.modify sql, field, *values
      ActiveRecord::Base.connection.select_all sql.to_s
    end

    def create_project(options = {})
      parent = options.delete :parent
      p = Project.mock! options
      p.set_parent! parent if parent
      p
    end

    it "does =" do
      expect(query('projects', 'id', '=', project1.id).size).to eq(1)
    end

    it "does = for multiple values" do
      expect(query('projects', 'id', '=', project1.id, project2.id).size).to eq(2)
    end

    it "does = for no values" do
      sql = CostQuery::SqlStatement.new 'projects'
      "=".to_operator.modify sql, 'id'
      result = (ActiveRecord::Base.connection.select_all sql.to_s)
      expect(result.count).to eq(0)
    end

    it "does = for nil" do
      expect(query('projects', 'id', '=', nil).size).to eq(0)
    end

    it "does <=" do
      expect(query('projects', 'id', '<=', project2.id - 1).size).to eq(1)
    end

    it "does >=" do
      expect(query('projects', 'id', '>=', project1.id + 1).size).to eq(1)
    end

    it "does !" do
      expect(query('projects', 'id', '!', project1.id).size).to eq(1)
    end

    it "does ! for multiple values" do
      expect(query('projects', 'id', '!', project1.id, project2.id).size).to eq(0)
    end

    it "does !*" do
      expect(query('cost_entries', 'project_id', '!*', []).size).to eq(0)
    end

    it "does ~ (contains)" do
      expect(query('projects', 'name', '~', 'o').size).to eq(Project.all.select { |p| p.name =~ /o/ }.count)
      expect(query('projects', 'name', '~', 'test').size).to eq(Project.all.select { |p| p.name =~ /test/ }.count)
      expect(query('projects', 'name', '~', 'child').size).to eq(Project.all.select { |p| p.name =~ /child/ }.count)
    end

    it "does !~ (not contains)" do
      expect(query('projects', 'name', '!~', 'o').size).to eq(Project.all.select { |p| p.name !~ /o/ }.count)
      expect(query('projects', 'name', '!~', 'test').size).to eq(Project.all.select { |p| p.name !~ /test/ }.count)
      expect(query('projects', 'name', '!~', 'child').size).to eq(Project.all.select { |p| p.name !~ /child/ }.count)
    end

    it "does c (closed work_package)" do
      expect(query('work_packages', 'status_id', 'c') { |s| s.join Status => [WorkPackage, :status] }.size).to be >= 0
    end

    it "does o (open work_package)" do
      expect(query('work_packages', 'status_id', 'o') { |s| s.join Status => [WorkPackage, :status] }.size).to be >= 0
    end

    it "does give the correct number of results when counting closed and open work_packages" do
      a = query('work_packages', 'status_id', 'o') { |s| s.join Status => [WorkPackage, :status] }.size
      b = query('work_packages', 'status_id', 'c') { |s| s.join Status => [WorkPackage, :status] }.size
      expect(WorkPackage.count).to eq(a + b)
    end

    it "does w (this week)" do
      #somehow this test doesn't work on sundays
      n = query('projects', 'created_on', 'w').size
      day_in_this_week = Time.now.at_beginning_of_week + 1.day
      Project.mock! created_on: day_in_this_week
      expect(query('projects', 'created_on', 'w').size).to eq(n + 1)
      Project.mock! created_on: day_in_this_week + 7.days
      Project.mock! created_on: day_in_this_week - 7.days
      expect(query('projects', 'created_on', 'w').size).to eq(n + 1)
    end

    it "does t (today)" do
      s = query('projects', 'created_on', 't').size
      Project.mock! created_on: Date.yesterday
      expect(query('projects', 'created_on', 't').size).to eq(s)
      Project.mock! created_on: Time.now
      expect(query('projects', 'created_on', 't').size).to eq(s + 1)
    end

    it "does <t+ (before the day which is n days in the future)" do
      n = query('projects', 'created_on', '<t+', 2).size
      Project.mock! created_on: Date.tomorrow + 1
      expect(query('projects', 'created_on', '<t+', 2).size).to eq(n + 1)
      Project.mock! created_on: Date.tomorrow + 2
      expect(query('projects', 'created_on', '<t+', 2).size).to eq(n + 1)
    end

    it "does t+ (n days in the future)" do
      n = query('projects', 'created_on', 't+', 1).size
      Project.mock! created_on: Date.tomorrow
      expect(query('projects', 'created_on', 't+', 1).size).to eq(n + 1)
      Project.mock! created_on: Date.tomorrow + 2
      expect(query('projects', 'created_on', 't+', 1).size).to eq(n + 1)
    end

    it "does >t+ (after the day which is n days in the furure)" do
      n = query('projects', 'created_on', '>t+', 1).size
      Project.mock! created_on: Time.now
      expect(query('projects', 'created_on', '>t+', 1).size).to eq(n)
      Project.mock! created_on: Date.tomorrow + 1
      expect(query('projects', 'created_on', '>t+', 1).size).to eq(n + 1)
    end

    it "does >t- (after the day which is n days ago)" do
      n = query('projects', 'created_on', '>t-', 1).size
      Project.mock! created_on: Date.today
      expect(query('projects', 'created_on', '>t-', 1).size).to eq(n + 1)
      Project.mock! created_on: Date.yesterday - 1
      expect(query('projects', 'created_on', '>t-', 1).size).to eq(n + 1)
    end

    it "does t- (n days ago)" do
      n = query('projects', 'created_on', 't-', 1).size
      Project.mock! created_on: Date.yesterday
      expect(query('projects', 'created_on', 't-', 1).size).to eq(n + 1)
      Project.mock! created_on: Date.yesterday - 2
      expect(query('projects', 'created_on', 't-', 1).size).to eq(n + 1)
    end

    it "does <t- (before the day which is n days ago)" do
      n = query('projects', 'created_on', '<t-', 1).size
      Project.mock! created_on: Date.today
      expect(query('projects', 'created_on', '<t-', 1).size).to eq(n)
      Project.mock! created_on: Date.yesterday - 1
      expect(query('projects', 'created_on', '<t-', 1).size).to eq(n + 1)
    end

    #Our own operators
    it "does =_child_projects" do
      expect(query('projects', 'id', '=_child_projects', project1.id).size).to eq(1)
      p_c1 = create_project parent: project1
      expect(query('projects', 'id', '=_child_projects', project1.id).size).to eq(2)
      create_project parent: p_c1
      expect(query('projects', 'id', '=_child_projects', project1.id).size).to eq(3)
    end

    it "does =_child_projects on multiple projects" do
      expect(query('projects', 'id', '=_child_projects', project1.id, project2.id).size).to eq(2)
      p1_c1 = create_project parent: project1
      p2_c1 = create_project parent: project2
      expect(query('projects', 'id', '=_child_projects', project1.id, project2.id).size).to eq(4)
      p1_c1_c1 = create_project parent: p1_c1
      create_project parent: p1_c1_c1
      create_project parent: p2_c1
      expect(query('projects', 'id', '=_child_projects', project1.id, project2.id).size).to eq(7)
    end

    it "does !_child_projects" do
      expect(query('projects', 'id', '!_child_projects', project1.id).size).to eq(1)
      p_c1 = create_project parent: project1
      expect(query('projects', 'id', '!_child_projects', project1.id).size).to eq(1)
      create_project parent: project1
      create_project parent: p_c1
      expect(query('projects', 'id', '!_child_projects', project1.id).size).to eq(1)
      create_project
      expect(query('projects', 'id', '!_child_projects', project1.id).size).to eq(2)
    end

    it "does !_child_projects on multiple projects" do
      expect(query('projects', 'id', '!_child_projects', project1.id, project2.id).size).to eq(0)
      p1_c1 = create_project parent: project1
      p2_c1 = create_project parent: project2
      create_project
      expect(query('projects', 'id', '!_child_projects', project1.id, project2.id).size).to eq(1)
      p1_c1_c1 = create_project parent: p1_c1
      create_project parent: p1_c1_c1
      create_project parent: p2_c1
      create_project
      expect(query('projects', 'id', '!_child_projects', project1.id, project2.id).size).to eq(2)
    end

    it "does =n" do
      # we have a time_entry with costs==4.2 and a cost_entry with costs==2.3 in our fixtures
      expect(query_on_entries('costs', '=n', 4.2).size).to eq(Entry.all.select { |e| e.costs == 4.2 }.count)
      expect(query_on_entries('costs', '=n', 2.3).size).to eq(Entry.all.select { |e| e.costs == 2.3 }.count)
    end

    it "does 0" do
      expect(query_on_entries('costs', '0').size).to eq(Entry.all.select { |e| e.costs == 0 }.count)
    end

    # y/n seem are for filtering overridden costs
    it "does y" do
      expect(query_on_entries('overridden_costs', 'y').size).to eq(Entry.all.select { |e| e.overridden_costs != nil }.count)
    end

    it "does n" do
      expect(query_on_entries('overridden_costs', 'n').size).to eq(Entry.all.select { |e| e.overridden_costs == nil }.count)
    end

    it "does =d" do
      #assuming that there aren't more than one project created at the same time
      expect(query('projects', 'created_on', '=d', Project.first(order: "id ASC").created_on).size).to eq(1)
    end

    it "does <d" do
      expect(query('projects', 'created_on', '<d', Time.now).size).to eq(Project.count)
    end

    it "does <>d" do
      expect(query('projects', 'created_on', '<>d', Time.now, 5.minutes.from_now).size).to eq(0)
    end

    it "does >d" do
      #assuming that all projects were created in the past
      expect(query('projects', 'created_on', '>d', Time.now).size).to eq(0)
    end

    describe 'arity' do
      arities = {'t' => 0, 'w' => 0, '<>d' => 2, '>d' => 1}
      arities.each do |o,a|
        it("#{o} should take #{a} values") { expect(o.to_operator.arity).to eq(a) }
      end
    end

  end
end