scidea-schools 1.0.0

data/features/step_definitions/user_steps.rb

@@ -0,0 +1,16 @@
+Given /^there exists learner "([^"]*)"(?: with password "([^"]*)")?$/ do |email, password|
+  Factory(:user_learner, :email => email)
+end
+
+Given /^there exists learner "([^"]*)" named "([^"]*)"(?: with password "([^"]*)")?$/ do |email, name, password|
+  Factory(:user_learner, :email => email, :profile => Factory(:profile, :last_name => name, :first_name => name))
+end
+
+Given /^user "([^"]*)" has school "([^"]*)"$/ do |email, school|
+  profile = User.find_by_email(email).profile
+  school = School.find_by_name( school ) || Factory(:school, :name => school)
+  audience = Audience.find_by_name( 'Educator' ) || Factory(:audience, :name => 'Educator')
+  profile.school = school
+  profile.audience = audience
+  profile.save!
+end

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,211 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file iwas generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within ([^:]+)$/ do |step, parent|
+  with_scope(parent) { step step }
+end
+
+# Multi-line step scoper
+When /^(.*) within ([^:]+):$/ do |step, parent, table_or_string|
+  with_scope(parent) { step "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    step %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
+
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/features/support/env.rb

@@ -0,0 +1,21 @@
+ENV["RAILS_ENV"] ||= "test"
+
+require File.expand_path("../../../config/environment",  __FILE__)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'rspec/expectations'
+require 'cucumber/rails'
+
+# Remove this line if your app doesn't have a database.
+# For some databases (like MongoDB and CouchDB) you may need to use :truncation instead.
+DatabaseCleaner.strategy = :transaction
+
+Cucumber::Rails::World.use_transactional_fixtures = false
+
+Before do
+  page.driver.options[:resynchronize] = true
+end
+
+# load local factories which will be added to the factories from scidea.
+Dir.glob(File.join(File.dirname(__FILE__), '../../spec/factories/*.rb')).each {|f| require f }

data/features/support/hooks.rb

@@ -0,0 +1,16 @@
+# see https://github.com/cucumber/cucumber/wiki/Hooks
+
+AfterConfiguration do |config| # run once after cucumber configuration load
+end
+
+Before do |scenario|
+  SeedUserRoles.seed
+end
+
+After do |scenario| # each scenario
+  SeedUserRoles.clean
+end
+
+at_exit do # after all scenarios are finished (global tear-down)
+end
+

data/features/support/paths.rb

@@ -0,0 +1,39 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the home\s?page/
+      '/'
+
+    when /the registration page/
+      '/users/sign_up'
+
+    when /the qunit tests/
+      "/qunit_tests"
+
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
+
+    else
+      begin
+        page_name =~ /the (.*) page/
+          path_components = $1.split(/\s+/)
+        self.send(path_components.push('path').join('_').to_sym)
+      rescue Object => e
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+      end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/support/seed_user_roles.rb

@@ -0,0 +1,16 @@
+module SeedUserRoles
+  def self.seed
+    Role.public || Factory( :role_public )
+    Role.learner || Factory( :role_learner )
+    Role.user_admin || Factory(:role_user_admin)
+    Role.course_admin || Factory(:role_course_admin)
+    Role.product_admin || Factory(:role_product_admin)
+    Role.tech_support || Factory(:role_tech_support)
+    Role.scitent_admin || Factory(:role_scitent_admin)
+  end
+
+  def self.clean
+    Role.destroy_all
+  end
+end
+

data/features/support/selectors.rb

@@ -0,0 +1,66 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+    case locator
+
+    when /the page/
+      "html > body"
+
+    when /manage menu/
+      ".manage-menu"
+
+    when /([^"]*) tab content/
+      tab_pane_id = locator.match(/([^"]*) tab content/)[1].downcase.gsub(' ','-')
+      "##{tab_pane_id}.tab-pane"
+
+    when /expandable row for user "([^"]*)"/
+      user = User.find_by_email(locator.match(/expandable row for user "([^"]*)"/)[1])
+      "#users-found > .table-blue-zebra > table > tbody > tr + tr.expandable section#user-#{user.id}"
+
+    when /the seminar applications widget/
+      "#portlet-seminar-applications"
+
+    when /^the "([^"]*)" table$/
+      table_ancestor_id = locator.match(/the "([^"]*)" table/)[1].downcase.gsub(' ','-')
+      "##{table_ancestor_id} table"
+
+    when /cell (\d+) of row (\d+) of the "([^"]*)" table/
+      cell_index, row_index, table_ancestor_id = locator.match(/cell (\d+) of row (\d+) of the "([^"]*)" table/).to_a.drop(1)
+      "##{table_ancestor_id.downcase.gsub(' ','-')} table tbody tr:nth-child(#{row_index}) td:nth-child(#{cell_index})"
+
+    when /cell (\d+) of the header row of the "([^"]*)" table/
+      cell_index, table_ancestor_id = locator.match(/cell (\d+) of the header row of the "([^"]*)" table/).to_a.drop(1)
+      "##{table_ancestor_id.downcase.gsub(' ','-')} table thead tr:first-child th:nth-child(#{cell_index})"
+    
+
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #  when /the (notice|error|info) flash/
+    #    ".flash.#{$1}"
+    
+    # You can also return an array to use a different selector
+    # type, like:
+    #
+    #  when /the header/
+    #    [:xpath, "//header"]
+
+    # This allows you to provide a quoted selector as the scope
+    # for "within" steps as was previously the default for the
+    # web steps:
+    when /"(.+)"/
+      $1
+
+    else
+      raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(HtmlSelectorsHelpers)

data/lib/generators/scidea/schools/migrations_generator.rb

@@ -0,0 +1,14 @@
+require 'scidea/plugins/update_migration_generator'
+
+module Scidea
+  module Schools
+    class MigrationsGenerator < Scidea::Plugins::UpdateMigrationGenerator
+      MigrationsGenerator.source_root(File.expand_path('templates', File.dirname(__FILE__) ) )
+
+      def plugin_migrations_path
+        MigrationsGenerator.source_root
+      end
+
+    end
+  end
+end

data/lib/generators/scidea/schools/removal_migrations_generator.rb

@@ -0,0 +1,14 @@
+require 'scidea/plugins/remove_migration_generator'
+
+module Scidea
+  module Schools
+    class RemovalMigrationsGenerator < Scidea::Plugins::RemoveMigrationGenerator
+      RemovalMigrationsGenerator.source_root(File.expand_path('templates/removal', File.dirname(__FILE__) ) )
+
+      def plugin_migrations_path
+        RemovalMigrationsGenerator.source_root
+      end
+
+    end
+  end
+end

data/lib/generators/scidea/schools/templates/removal/scidea_schools_99_remove.rb

@@ -0,0 +1,35 @@
+class ScideaSchools99Remove < ActiveRecord::Migration
+  def up
+    drop_table :schools
+    remove_column :profiles, :school_id
+    execute "delete from menu_elements where display_name = 'Educational Institutions';"
+  end
+
+  def down
+    create_table "schools" do |t|
+      t.string   "name"
+      t.string   "address_1"
+      t.string   "address_2"
+      t.string   "city"
+      t.string   "state"
+      t.string   "zipcode"
+      t.boolean  "approved"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "phone"
+    end
+
+    add_column :profiles, :school_id, :integer
+
+    sql = <<-SQL
+      set @course_and_scitent_admins = (select group_concat(id) from roles where symbol in ('course_admin', 'scitent_admin'));
+      set @product_and_scitent_admins = (select group_concat(id) from roles where symbol in ('product_admin', 'scitent_admin'));
+      
+      SELECT @admin_nav_secondary_id:=id FROM menus WHERE name = 'Admin Navigation: Secondary' LIMIT 1;
+
+      INSERT INTO menu_elements (display_name, menu_id, url, view_role_list, edit_role_list, order_sequence) VALUES ('Educational Institutions', @admin_nav_secondary_id, '/admin/schools', @course_and_scitent_admins, @product_and_scitent_admins, 102);
+    SQL
+
+    sql.split("\n").reject{|s| s.strip.start_with?('#') || s.strip.empty? }.each{ |s| execute s.strip }
+  end
+end

data/lib/generators/scidea/schools/templates/scidea_schools_01_install.rb

@@ -0,0 +1,35 @@
+class ScideaSchools01Install < ActiveRecord::Migration
+  def up
+    create_table "schools" do |t|
+      t.string   "name"
+      t.string   "address_1"
+      t.string   "address_2"
+      t.string   "city"
+      t.string   "state"
+      t.string   "zipcode"
+      t.boolean  "approved"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "phone"
+    end
+
+    add_column :profiles, :school_id, :integer
+
+    sql = <<-SQL
+      set @course_and_scitent_admins = (select group_concat(id) from roles where symbol in ('course_admin', 'scitent_admin'));
+      set @product_and_scitent_admins = (select group_concat(id) from roles where symbol in ('product_admin', 'scitent_admin'));
+      
+      SELECT @admin_nav_secondary_id:=id FROM menus WHERE name = 'Admin Navigation: Secondary' LIMIT 1;
+
+      INSERT INTO menu_elements (display_name, menu_id, url, view_role_list, edit_role_list, order_sequence) VALUES ('Educational Institutions', @admin_nav_secondary_id, '/admin/schools', @course_and_scitent_admins, @product_and_scitent_admins, 102);
+    SQL
+
+    sql.split("\n").reject{|s| s.strip.start_with?('#') || s.strip.empty? }.each{ |s| execute s.strip }
+  end
+
+  def down
+    drop_table :schools
+    remove_column :profiles, :school_id
+    execute "delete from menu_elements where display_name = 'Educational Institutions';"
+  end
+end

data/lib/scidea/schools/engine.rb

@@ -0,0 +1,31 @@
+require_relative 'models/profile'
+require_relative 'models/ability'
+
+module Scidea
+  module Schools
+    class Engine < ::Rails::Engine
+
+      initializer "scidea.schools.register_view_callbacks" do
+        Scidea::Plugins::Plugin.on(:admin_user_form_after_profile)   { conditional_render('admin/users/school_edit') }
+      
+        Scidea::Plugins::Plugin.on(:registration_new_after_profile)  { conditional_render('users/school_edit') }        
+        Scidea::Plugins::Plugin.on(:user_profile_form_after_profile)  { conditional_render('users/school_edit') }
+
+        Scidea::Plugins::Plugin.on(:admin_user_profile_after_profile) { 'admin/users/profile_show_school' }
+
+        Scidea::Plugins::Plugin.on(:user_profile_page_js) { 'backbone_apps/school_selector' }
+      end
+
+      config.to_prepare do
+        Profile.class_eval { include Scidea::Schools::Models::Profile }
+        Ability.class_eval { include Scidea::Schools::Models::Ability }
+      end
+
+      private
+      def conditional_render(partial)
+        School.render_form? ? partial : nil
+      end
+
+    end # class Engine
+  end
+end

data/lib/scidea/schools/models/ability.rb

@@ -0,0 +1,28 @@
+module Scidea
+  module Schools
+    module Models
+      module Ability
+        extend ActiveSupport::Concern
+
+        module InstanceMethods
+          def initialize_namespace_admin(user)
+            super
+
+            can(:manage, [School]) if user.has_role?(Role.course_admin)
+          end
+
+          def initialize_namespace_none(user)
+            super
+
+            # required for registration form              
+            can([:index, :create, :update], School) 
+
+            # required for profile form
+            can([:index, :create, :update], School) if user.has_role? Role.learner
+          end
+        end      
+
+      end # ability
+    end # models
+  end
+end

data/lib/scidea/schools/models/profile.rb

@@ -0,0 +1,25 @@
+module Scidea
+  module Schools
+    module Models
+      module Profile
+        extend ActiveSupport::Concern
+
+        included do
+          belongs_to :school
+          validate :school_present_if_educator_audience
+        end
+
+        module InstanceMethods
+          def audience_is_educator?
+            audience && audience.name.downcase == 'educator'
+          end
+
+          def school_present_if_educator_audience
+            errors.add(:school, "Educational institution required if you are an educator") if audience_is_educator? && school.nil?
+          end
+        end      
+
+      end # profile
+    end # models
+  end
+end

data/lib/scidea/schools/version.rb

@@ -0,0 +1,5 @@
+module Scidea
+  module Schools
+    VERSION = "1.0.0"
+  end
+end

data/lib/scidea/schools.rb

@@ -0,0 +1,5 @@
+module Scidea
+  module Schools
+    require 'scidea/schools/engine'
+  end
+end

data/lib/scidea-schools.rb

@@ -0,0 +1 @@
+require 'scidea/schools.rb'

data/lib/tasks/db/seed.rake

@@ -0,0 +1,5 @@
+namespace :db do
+  task :seed do
+    Scidea::Schools::Engine.load_seed
+  end
+end