scidea-schools 1.0.0

data/qunit/html_fixtures/backbone_apps/_school_selector.html.erb

@@ -0,0 +1,16 @@
+<%= test_fixture do %>
+  <% @user = User.new %>
+  <% @profile = Profile.new %>
+  <% Audience.find_or_create_by_name("Educator") %>
+  <script type="text/template" id="new-school-form-tpl">
+    <%= render :partial => 'schools/form' %>
+  </script>
+
+  <%= render :partial => 'shared/form_errors', :locals => { :object => @user } %>
+
+  <%= semantic_form_for(@profile, :url => "#", :method => :get, :html => {:novalidate => nil, :autocomplete => "off"}) do |form| %>
+    <%= render :partial => "schools/profile_form", :locals => {:form => form} %>
+    <%= form.input :audience, :as => :select, :collection => Audience.all, :label => 'Profession', :required => true, :input_html => { :required => 'required', 'data-message' => Profile.error_message(:audience) } %>
+    <%= form.submit %>
+  <% end %>
+<% end %>

data/qunit/test_runner.html.erb

@@ -0,0 +1,25 @@
+<% @html_fixtures.each do |fixture| %>
+  <%= render fixture %>
+<% end %>
+
+<% head_js { javascript_include_tag 'qunit.js' } %>
+
+<% css { stylesheet_link_tag 'qunit.css' } %>
+
+<% page_title("QUnit Javascript Test Suite") %>
+
+<div id="qunit-test-results">
+  <h1 id="qunit-header">Scitent QUnit Test Suite</h1>
+  <h2 id="qunit-banner"></h2>
+  <div id="qunit-testrunner-toolbar"></div>
+  <h2 id="qunit-userAgent"></h2>
+  <ol id="qunit-tests"></ol>
+</div>
+
+<div id="qunit-fixture">
+  <%= yield :test_fixture %>
+</div>
+
+<%= page_js do %>
+  <%= raw @test_js %>
+<% end %>

data/qunit/tests/backbone_apps/school_selector.js

@@ -0,0 +1,50 @@
+require(['backbone_apps/school_selector'], function(plugin) {
+  var SchoolSelectorView = plugin($);
+
+  module("School Selector Tests");
+
+  test("SchoolSelectorView loaded", function() {
+    ok(SchoolSelectorView, "SchoolSelectorView defined");
+
+    var ssv = new SchoolSelectorView({
+      el : $('#profile-school').get(),
+      audienceField : $('#profile_audience_id')
+    });
+    ok(ssv, "SchoolSelectorView instantiable");
+    ok(ssv.newSchoolForm, "SchoolSelectorView#newSchoolForm accessible");
+    ok(ssv.stateDefs, "SchoolSelectorView#stateDefs accessible");
+  });
+
+  test("zipcode validation", function() {
+    var audienceField = $('#profile_audience_id');
+    var ssv = new SchoolSelectorView({
+      el : $('#profile-school').get(),
+      audienceField : audienceField
+    });
+
+    // School field only shows up when audience is set to Educator
+    var educatorOption = $('#profile_audience_id option:contains(Educator)');
+    audienceField.val(educatorOption.val()).trigger('refreshCustomValidityRules');
+    audienceField.change();
+
+    var zipcode = $("#school-select-zipcode");
+    ok(zipcode, "Found zipcode DOM element");
+    ok(zipcode.prop("required"), "zipcode should be required");
+
+    zipcode.val("").trigger('refreshCustomValidityRules');
+    ok(!zipcode.prop('validity').valid, "empty zipcode should not be valid");
+
+    zipcode.val("123").trigger('refreshCustomValidityRules');
+    ok(!zipcode.prop('validity').valid, "too short");
+
+    zipcode.val("12345").trigger('refreshCustomValidityRules');
+    ok(zipcode.checkValidity(), "good format, correct length (checkValidity)");
+    ok(zipcode.prop('validity').valid, "good format, correct length");
+
+    zipcode.val("abcde").trigger('refreshCustomValidityRules');
+    ok(!zipcode.checkValidity(), "bad format (checkValidity)");
+    ok(!zipcode.prop('validity').valid, "bad format");
+    equals(zipcode.prop('validationMessage'), "Invalid zipcode", "custom error message shows");
+  });
+
+});

data/spec/factories/schools.rb

@@ -0,0 +1,10 @@
+Factory.define :school do |f|
+  f.sequence(:name) { |n| "School #{n}" } #n will increment each time a school factory is created
+  f.address_1 'School Address 1'
+  f.address_2 'School Address 2'
+  f.city 'School City'
+  f.state 'VA'
+  f.zipcode '12345'
+  f.phone '9876543210'
+  f.approved true
+end

data/spec/models/ability_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Ability do
+  describe "as a course admin user" do
+    subject { Ability.new(Factory.build(:user_course_admin), 'Admin') }
+    
+    it { should be_able_to(:manage, School) }
+  end
+
+  describe "as a learner user" do
+    subject { Ability.new(Factory.build(:user_learner)) }
+
+    it { should be_able_to(:create, School) }
+    it { should be_able_to(:update, School) }
+    it { should be_able_to(:index, School) }
+  end
+
+  describe "as an unregistered user" do
+    subject { Ability.new(User.new) }
+    
+    it { should be_able_to(:create, School) }
+    it { should be_able_to(:update, School) }
+    it { should be_able_to(:index, School) }   
+    it { should be_able_to(:create, User) }
+  end
+
+end

data/spec/models/profile_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Profile do
+  subject { Factory(:profile) }
+
+  it { should belong_to(:school) }
+
+  describe "school validation" do
+    context "there exists a few audiences, including educator" do
+      before do
+        @doctor_audience  = Factory :audience, :name => "Doctor"
+        @educator_audience = Factory :audience, :name => "Educator"
+      end
+
+      context "A profile is created with a non-educators audience and without a school;" do
+        it "should be a valid profile" do
+          @profile = Factory :profile, :audience => @doctor_audience
+          @profile.valid?.should be_true
+        end
+      end
+
+      context "A profile is created with a educators audience;" do
+        context "the profile does not have a school associated with it;" do
+          it "should not be a valid profile" do
+            lambda{ Factory :profile, :audience => @educator_audience, :school => nil }.should raise_error
+          end
+        end
+  
+        context "the profile does have a school associated with it;" do
+          it "should be a valid profile" do
+            @profile = Factory :profile, :audience => @educator_audience, :school => Factory(:school)
+            @profile.valid?.should be_true
+          end
+        end
+      end
+    end 
+  end #describe 
+end

data/spec/models/school_spec.rb

@@ -0,0 +1,304 @@
+require 'spec_helper'
+
+describe School do
+
+  subject { Factory(:school) }
+
+  it { should validate_presence_of(:address_1) }
+  it { should validate_presence_of(:city) }
+  it { should validate_presence_of(:name) }
+  it { should validate_presence_of(:state) }
+  it { should validate_presence_of(:zipcode) }
+
+  it { should have_many(:profiles) }
+
+  describe "zipcode formatting" do
+    it "should only persist the first five digits" do
+      lambda{ Factory(:school, :zipcode => '123456') }.should raise_error
+    end
+
+    it "should only accept numerical values" do
+      lambda{ Factory(:school, :zipcode => 'a2345') }.should raise_error
+    end
+
+    it "should require full five digits" do
+      lambda{ Factory(:school, :zipcode => '1234') }.should raise_error
+    end
+  end
+
+  describe "search" do
+    context "there are no schools" do
+      it "it should return no results" do
+        School.search('whatever').should be_empty
+      end
+    end
+
+    context "there exist two schools with different names but the same zipcodes" do
+      before do
+        @shared_zipcode = '12345'
+        @temple = Factory :school, :name => 'Temple University', :zipcode => @shared_zipcode
+        @drexel = Factory :school, :name => 'Drexel University', :zipcode => @shared_zipcode
+        @unc    = Factory :school, :name => 'University of North Carolina', :zipcode => '00000'
+      end
+
+      it "should return no schools if no search terms match" do
+        School.search('whatever').should be_empty
+      end
+
+      it "should only return schools that contain the search term in their name" do
+        (School.search(@temple.name) - [@temple]).should be_empty
+      end
+
+      it "should return all schools that match the search terms by zipcode" do
+        (School.search(@shared_zipcode) - [@temple, @drexel]).should be_empty
+      end
+
+    end
+  end
+
+  describe "user_count" do
+    context "there are two schools, each with different amounts of users" do
+      before do
+        @school_a = Factory :school
+        @school_b = Factory :school
+        @school_a_users = 1
+        @school_b_users = 3
+        @school_a_users.times { Factory :profile, :school => @school_a }
+        @school_b_users.times { Factory :profile, :school => @school_b }
+      end
+
+      it "should return the number of profiles associated with the school" do
+        @school_a.user_count.should == @school_a_users
+        @school_b.user_count.should == @school_b_users
+      end
+    end
+  end
+
+  describe "migrate_users_to" do
+    before do
+      @school = Factory :school
+    end
+
+    it "should throw an error if target school is nil" do
+      lambda { @school.migrate_users_to(nil) }.should raise_error
+    end
+
+    context "there is a valid target school" do
+      before do
+        @target_school = Factory :school
+      end
+
+      it "should migrate and return 0 users" do
+        @school.migrate_users_to(@target_school).should be_empty
+      end
+
+      context "there are multiple useres in a school" do
+        before do
+          2.times { Factory :profile, :school => @school }
+          @users = @school.profiles.map{ |p| p.user }
+        end
+
+        it "should return all users that were in the school" do
+          (@school.migrate_users_to(@target_school) - @users).should be_empty
+        end
+
+        it "should remove all users from that school" do
+          @school.migrate_users_to(@target_school)
+          @school.user_count.should == 0
+        end
+
+        it "should add all users to the target school" do
+          migrated_users = @school.migrate_users_to(@target_school)
+          (@users - migrated_users).should be_empty
+        end
+      end
+    end
+
+  end # describe migrate_users_to
+
+  describe "learner_form_search" do
+    before do
+      @zipcode = '99999'
+    end
+
+    context "when searching by a bad zipcode" do
+      it "will return an empty result set" do
+        School.learner_form_search('abcde').should be_empty
+      end
+    end
+
+    context "there are no schools" do
+      it "will return an empty result set" do
+        School.learner_form_search(@zipcode).should be_empty
+      end
+
+      context "and a user-created school is passed as a paramter" do
+        before do
+          @user_created_school = Factory :school, :approved => false, :zipcode => '31415'
+        end
+
+        it "will return only the user created school" do
+          School.learner_form_search(@user_created_school.zipcode, @user_created_school).should == [@user_created_school]
+        end
+
+        context "and the user-created school is from a zipcode different from the search parameter" do
+          it "should return an empty result set" do
+            School.learner_form_search(@zipcode, @user_created_school).should be_empty
+          end
+        end
+      end
+    end
+
+    context "there are several schools in different zipcodes" do
+      before do
+        @c_school = Factory :school, :name => 'C School', :zipcode => @zipcode
+        @b_school = Factory :school, :name => 'B School'
+        @a_school = Factory :school, :name => 'A School', :zipcode => @zipcode
+      end
+
+      context "when searching by a zipcode with two schools in it;" do
+        it "should return the two schools, sorted ascending by name" do
+          School.learner_form_search(@zipcode).should == [@a_school, @c_school]
+        end
+
+        context "and a user-created school (with the same zipcode) is passed as a paramter" do
+          before { @user_created_school = Factory :school, :name => 'Ac School', :approved => false, :zipcode => @zipcode }
+
+          it "will return the two existing schools and the user-created school" do
+            School.learner_form_search(@zipcode, @user_created_school).should == [@a_school, @user_created_school, @c_school]
+          end
+
+          context "and the user-created school is from a zipcode different from the search parameter" do
+            before do
+              @user_created_school.zipcode = '31415'
+              @user_created_school.save
+            end
+
+            it "should the original result set without the user created school" do
+              School.learner_form_search(@zipcode, @user_created_school).should == [@a_school, @c_school]
+            end
+
+            context "the user-created school is nil" do
+              before { @user_created_school = nil }
+
+              it "should the original result set without the user created school" do
+                School.learner_form_search(@zipcode, @user_created_school).should == [@a_school, @c_school]
+              end            
+            end
+          end
+        end # user-created school passed as a parameter
+      end
+
+      context "when searching by a zipcode with two schools, one pending admin approval" do
+        before do
+          @c_school.approved = false
+          @c_school.save
+          @results = School.learner_form_search(@zipcode)
+        end
+
+        it "should only return the school that is approved" do
+          @results.should == [@a_school]
+        end
+      end
+
+      context "when searching by a bad zipcode" do
+        it "will return an empty result set" do
+          School.learner_form_search('abcde').should be_empty
+        end
+      end
+
+    end # several schools
+ 
+  end # describe learner_form_search
+
+  describe "render_form?" do
+    context "when there do not exist any schools" do
+      before { School.stub(:count).and_return(0) }
+
+      it "will return false" do
+        School.render_form?.should be_false
+      end
+    end
+
+    context "when there exists a school" do
+      before do 
+        School.stub(:count).and_return(1)
+        Audience.stub(:count).and_return(0)
+      end
+
+      it "will return false" do
+        School.render_form?.should be_false
+      end
+
+      context "and an audience" do
+        before { Audience.stub(:count).and_return(1) }
+
+        it "will return true" do
+          School.render_form?.should be_true
+        end
+      end
+    end
+  end # describe render_form?
+
+  describe "to_client_model_json" do
+    context "the record is new" do
+      it "should not contain created_at" do
+        School.new.to_client_model_json.include?('created_at').should be_false
+      end
+
+      it "should not contain updated_at" do
+        School.new.to_client_model_json.include?('updated_at').should be_false
+      end
+    end
+
+    context "the record has been persisted" do
+      it "should not contain created_at" do
+        subject.to_client_model_json.include?('created_at').should be_false
+      end
+
+      it "should not contain updated_at" do
+        subject.to_client_model_json.include?('updated_at').should be_false
+      end
+    end
+  end
+
+  describe "phone validation" do
+    before { @school = Factory :school }
+
+    context "the phone number is valid;" do
+      context "it contains extra characters" do
+        before { @school.phone = '987-654-2310' }
+
+        it "should return a value without extra characters" do
+          @school.phone.should == '(987) 654-2310'
+        end
+      end
+    end
+
+    context "the phone number is missing" do
+      before { @school.phone = '' }
+
+      it "should not validate" do
+        @school.valid?.should be_false
+      end
+    end
+
+    context "the phone number contains only non-numeric values" do
+      before { @school.phone = 'abcdefg' }
+
+      it "should not validate" do
+        @school.valid?.should be_false
+      end
+    end
+
+    context "the phone number is invalid (too short);" do     
+      before { @school.phone = '123' }
+
+      it "should not validate" do
+
+        @school.valid?.should be_false
+      end
+    end
+  end
+
+end

data/spec/routing/admin/admin_schools_routing_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Admin::SchoolsController do
+  describe "routing" do
+
+    it "recognizes and generates #index" do
+      { :get => "/admin/schools" }.should route_to(:controller => "admin/schools", :action => "index")
+    end
+
+    it "recognizes and generates #new" do
+      { :get => "/admin/schools/new" }.should route_to(:controller => "admin/schools", :action => "new")
+    end
+
+    it "recognizes and generates #show" do
+      { :get => "/admin/schools/1" }.should route_to(:controller => "admin/schools", :action => "show", :id => "1")
+    end
+
+    it "recognizes and generates #edit" do
+      { :get => "/admin/schools/1/edit" }.should route_to(:controller => "admin/schools", :action => "edit", :id => "1")
+    end
+
+    it "recognizes and generates #create" do
+      { :post => "/admin/schools" }.should route_to(:controller => "admin/schools", :action => "create")
+    end
+
+    it "recognizes and generates #update" do
+      { :put => "/admin/schools/1" }.should route_to(:controller => "admin/schools", :action => "update", :id => "1")
+    end
+
+    it "recognizes and generates #destroy" do
+      { :delete => "/admin/schools/1" }.should route_to(:controller => "admin/schools", :action => "destroy", :id => "1")
+    end
+
+    it "recognizes and generates #new_migration" do
+      { :get => "/admin/schools/1/migration/new" }.should route_to(:controller => "admin/schools", :action => "new_migration", :id => "1")
+    end
+
+    it "recognizes and generates #confirm_migration" do
+      { :get => "/admin/schools/1/migration/2/confirm" }.should route_to(:controller => "admin/schools", :action => "confirm_migration", :id => "1", :target_school_id => "2")
+    end
+
+    it "recognizes and generates #migration" do
+      { :post => "/admin/schools/1/migration/2" }.should route_to(:controller => "admin/schools", :action => "create_migration", :id => "1", :target_school_id => "2")
+    end
+
+  end
+end

data/spec/routing/schools_routing_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe SchoolsController do
+  describe "routing" do
+
+    it "recognizes and generates #index" do
+      { :get => "schools" }.should route_to(:controller => "schools", :action => "index" )
+    end
+
+    it "should not recognize #new" do
+      { :get => "schools/new" }.should_not be_routable
+    end
+
+    it "should not recognize #show" do
+      { :get => "schools/1" }.should_not be_routable
+    end
+
+    it "should recognize #edit" do
+      { :get => "schools/1/edit" }.should route_to(:controller => "schools", :action => "edit", :id => "1")
+    end
+
+    it "recognizes and generates #create" do
+      { :post => "schools" }.should route_to(:controller => "schools", :action => "create")
+    end
+
+    it "recognizes and generates #update" do
+      { :put => "schools/1" }.should route_to(:controller => "schools", :action => "update", :id => "1")
+    end
+
+    it "should not recognize #destroy" do
+      { :delete => "schools/1" }.should_not be_routable
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../../config/environment", __FILE__)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'scidea-schools'
+
+require 'rspec/rails'
+require 'rspec_tag_matchers'
+require 'cancan/matchers'
+require 'paperclip/matchers'
+
+require File.expand_path("../../features/support/seed_user_roles.rb", __FILE__)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+ 
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+    ::SeedUserRoles.seed
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    ::SeedUserRoles.clean
+  end
+end
+
+# load local factories which will be added to the factories from scidea.
+Rails.configuration.after_initialize do
+  FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]
+  FactoryGirl.find_definitions
+end