Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filter teacher application workshop list to only future workshops #19985

Merged
merged 2 commits into from
Jan 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,26 @@ def find

# Find the matching partner, even if it has no workshops
partner = @partners.find_by_region(zip_code, state) || RegionalPartner.find_by_region(zip_code, state)

render json: partner, serializer: Api::V1::Pd::RegionalPartnerWorkshopsSerializer,
scope: {course: @course, subject: @subject}
render json: serialize_partner(partner)
end

# GET /api/v1/pd/regional_partner_workshops
def index
render json: @partners, each_serializer: Api::V1::Pd::RegionalPartnerWorkshopsSerializer,
scope: {course: @course, subject: @subject}
render json: @partners.map {|p| serialize_partner(p)}
end

private

def serialize_partner(partner)
# The scope is not being passed to the serializer with `render json: serializer:` syntax,
# so initialize this explicitly.
# TODO (Andrew): Look into updating our very outdated version of ActiveModelSerializers
Api::V1::Pd::RegionalPartnerWorkshopsSerializer.new(
partner,
scope: {course: @course, subject: @subject}
).attributes
end

def get_filtered_workshops
@partners = RegionalPartner.includes(:pd_workshops_organized)

Expand Down
3 changes: 3 additions & 0 deletions dashboard/app/models/pd/workshop.rb
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,9 @@ def self.scheduled_start_on_or_after(date)
joins(:sessions).group_by_id.having('(DATE(MIN(start)) >= ?)', date)
end

# Filters to workshops that are scheduled on or after today and have not yet ended
scope :future, -> {scheduled_start_on_or_after(Time.zone.today).where(ended_at: nil)}

# Orders by the scheduled start date (date of the first session),
# @param :desc [Boolean] optional - when true, sort descending
def self.order_by_scheduled_start(desc: false)
Expand Down
5 changes: 5 additions & 0 deletions dashboard/app/models/regional_partner.rb
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ class RegionalPartner < ActiveRecord::Base
has_many :pd_workshops_organized, class_name: 'Pd::Workshop', through: :regional_partner_program_managers
has_many :mappings, -> {order :state, :zip_code}, class_name: Pd::RegionalPartnerMapping, dependent: :destroy

# Upcoming and not ended
def future_pd_workshops_organized
pd_workshops_organized.future
end

# Make sure the phone number contains at least 10 digits.
# Allow any format and additional text, such as extensions.
PHONE_NUMBER_VALIDATION_REGEX = /(\d.*){10}/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class Api::V1::Pd::RegionalPartnerWorkshopsSerializer < ActiveModel::Serializer

def workshops
object.try do |partner|
workshops = partner.pd_workshops_organized
workshops = partner.future_pd_workshops_organized
workshops = workshops.where(course: @scope[:course]) if @scope.try(:[], :course)
workshops = workshops.where(subject: @scope[:subject]) if @scope.try(:[], :course)
workshops.map do |workshop|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ module Api::V1::Pd
class RegionalPartnerWorkshopsControllerTest < ::ActionController::TestCase
include Pd::Application::RegionalPartnerTeacherconMapping

freeze_time Time.new(2018, 2, 1)

self.use_transactional_test_case = true
setup_all do
Pd::Workshop.any_instance.stubs(:process_location)
first_session_time = Time.new(2017, 3, 15, 9)
first_session_time = Time.new(2018, 3, 15, 9)

@partner_organizer = create :workshop_organizer, :as_regional_partner_program_manager
@non_partner_organizer = create :workshop_organizer
Expand Down Expand Up @@ -175,11 +177,11 @@ def expected_partner_workshops_all
group: @regional_partner.group,
workshops: [{
id: @partner_csd_workshop.id,
dates: 'March 15-19, 2017',
dates: 'March 15-19, 2018',
location: 'Code.org, Seattle, WA'
}, {
id: @partner_csp_workshop.id,
dates: 'March 15-19, 2017',
dates: 'March 15-19, 2018',
location: 'Code.org, Seattle, WA'
}],
teachercon: nil
Expand All @@ -193,7 +195,7 @@ def expected_partner_workshops_csd
group: @regional_partner.group,
workshops: [{
id: @partner_csd_workshop.id,
dates: 'March 15-19, 2017',
dates: 'March 15-19, 2018',
location: 'Code.org, Seattle, WA'
}],
teachercon: nil
Expand Down
20 changes: 20 additions & 0 deletions dashboard/test/models/pd/workshop_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,26 @@ class Pd::WorkshopTest < ActiveSupport::TestCase
Pd::Workshop.scheduled_start_on_or_after(pivot_date).scheduled_start_on_or_before(pivot_date).pluck(:id)
end

test 'future scope' do
future_workshops = [
# Today
create(:pd_workshop, num_sessions: 1, sessions_from: Date.today),

# Next week
create(:pd_workshop, num_sessions: 1, sessions_from: Date.today + 1.week)
]

# Excluded (not future) workshops:
# Last week
create :pd_workshop, num_sessions: 1, sessions_from: Date.today - 1.week
# Today, but ended
create :pd_ended_workshop, num_sessions: 1, sessions_from: Date.today
# Next week, but ended
create :pd_ended_workshop, num_sessions: 1, sessions_from: Date.today + 1.week

assert_equal future_workshops, Pd::Workshop.future
end

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like the structure of this test and how easy it is to understand the intended behavior in very little code

test 'end date filters' do
pivot_date = Date.today
workshop_before = create :pd_workshop, ended_at: pivot_date - 1.week
Expand Down
19 changes: 19 additions & 0 deletions dashboard/test/models/regional_partner_test.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'test_helper'

class RegionalPartnerTest < ActiveSupport::TestCase
freeze_time

test "regional partners initialized from tsv" do
RegionalPartner.find_or_create_all_from_tsv('test/fixtures/regional_partners.tsv')

Expand Down Expand Up @@ -151,4 +153,21 @@ class RegionalPartnerTest < ActiveSupport::TestCase

assert_equal partner_workshops, regional_partner.pd_workshops_organized
end

test 'future_pd_workshops_organized' do
regional_partner = create :regional_partner
partner_organizer = create :workshop_organizer
create :regional_partner_program_manager, regional_partner: regional_partner, program_manager: partner_organizer

future_partner_workshops = [
create(:pd_workshop, organizer: partner_organizer, num_sessions: 1, sessions_from: Date.today),
create(:pd_workshop, organizer: partner_organizer, num_sessions: 1, sessions_from: Date.tomorrow)
]

# excluded (past or ended) partner workshops
create :pd_workshop, organizer: partner_organizer, num_sessions: 1, sessions_from: Date.yesterday
create :pd_ended_workshop, organizer: partner_organizer, num_sessions: 1, sessions_from: Date.today

assert_equal future_partner_workshops, regional_partner.future_pd_workshops_organized
end
end