sambal-cle 0.1.3 → 0.1.4

data/README.md

@@ -1,4 +1,6 @@
 sambal-cle
 ==========
 
-Open source test automation framework for Sakai CLE
+Open source test automation framework for Sakai CLE. Please see the documentation for [test factory](http://rubygems.org/gems/test-factory) to get the usage basics.
+
+More to come...

data/lib/sambal-cle/base_page.rb

@@ -1,4 +1,4 @@
-class BasePage < PageMaker
+class BasePage < PageFactory
 
   class << self
 
@@ -11,6 +11,8 @@ class BasePage < PageMaker
       value(:alert_box) { |b| b.frm.div(:class=>"alertMessage").text }
       # Returns the text of the header.
       value(:header) { |b| b.frm.div(:class=>"portletBody").h3.text }
+      element(:cancel_button) { |b| b.frm.button(:value=>"Cancel") }
+      action(:cancel) { |p| p.cancel_button.click }
     end
 
     # More element group defs go here...

data/lib/sambal-cle/data_objects/announcement.rb

@@ -1,7 +1,9 @@
 class AnnouncementObject
 
-  include Utilities
-  include PageHelper
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include DateFactory
   include Workflows
 
   attr_accessor :title, :body, :site, :link, :access, :availability,
@@ -16,10 +18,8 @@ class AnnouncementObject
         :body=>random_multiline(500, 10, :alpha)
     }
     options = defaults.merge(opts)
-    @title=options[:title]
-    @body=options[:body]
-    @site=options[:site]
-    raise "You must specify a Site for the announcement" if @site==nil
+    set_options(options)
+    requires @site
   end
 
   alias :name :title
@@ -57,10 +57,7 @@ class AnnouncementObject
       end
       edit.save_changes
     end
-    @title=opts[:title] unless opts[:title]==nil
-    @body=opts[:body] unless opts[:body]==nil
-    @access=opts[:access]
-    @availability=opts[:availability]
+    update_options(opts)
   end
 
   def view

data/lib/sambal-cle/data_objects/assessment.rb

@@ -1,32 +1,288 @@
 class AssessmentObject
 
-  include PageHelper
-  include Utilities
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include DateFactory
   include Workflows
 
-  attr_accessor :title, :site
+  attr_accessor :title, :site, :questions, :parts, :status, :type, :available_date,
+                :due_date, :retract_date, :feedback_authoring, :feedback_delivery, :feedback_date,
+                :release_to, :release, :release_options, :secondary_id, :secondary_password,
+                :navigation, :question_layout, :numbering, :submissions, :num_submissions,
+                :late_handling, :submission_message, :final_page_url, :student_ids,
+                :gradebook_options, :recorded_score, :allowed_ips
 
   def initialize(browser, opts={})
     @browser = browser
 
     defaults = {
       :title=>random_alphanums,
-      :site=>"placeholder"
+      :authors=>random_alphanums,
+      :description=>random_alphanums,
+      :parts=>[],
+      :questions=>[],
+      :available_date=>right_now,
+      :due_date=>tomorrow,
+      :retract_date=>next_week,
+      :feedback_authoring=>:question_level_feedback,
+      :feedback_delivery=>:no_feedback,
+      :release=>:release_questions_and,
+      :release_options=>[],
+      :released_to=>:released_to_site,
+      :navigation=>:linear_access,
+      :submissions=>:unlimited_submissions,
+      :late_handling=>:late_submissions_not_accepted,
+      :submission_message=>random_alphanums,
+      :final_page_url=>"http://www.rsmart.com",
+      :student_ids=>:student_ids_seen
+      # TODO: More to add
     }
     options = defaults.merge(opts)
-    @title=options[:title]
-    @site=options[:site]
-    raise "You must specify a Site for your Assessment" if @site==nil
+    set_options(options)
+    requires @site
+
+    default_part = make PartObject, :title=>"Default", :assessment=>@title, :part_number=>1, :information=>""
+    @parts << default_part
   end
 
   def create
     my_workspace.open_my_site_by_name @site unless @browser.title=~/#{@site}/
     tests_and_quizzes unless @browser.title=~/Tests & Quizzes$/
+    reset
     on_page AssessmentsList do |page|
       page.title.set @title
+      page.type.select @type unless @type==nil
       page.create
     end
-    # Do more here eventually...
+    on EditAssessment do |assessment|
+      assessment.settings
+    end
+    on AssessmentSettings do |settings|
+      settings.open
+      # Introduction
+      settings.authors.set @authors
+      settings.description.set @description
+      # Delivery Dates
+      settings.available_date.set @available_date[:samigo]
+      settings.due_date.set @due_date[:samigo]
+      settings.retract_date.set @retract_date[:samigo]
+      # Assessment Released To
+      settings.send(@released_to).set
+      # High Security
+      settings.allow_specified_ips.set @allowed_ips
+      settings.secondary_id.set @secondary_id
+      settings.secondary_pw.set @secondary_password
+      # Assessment Organization
+      settings.send(@navigation).set
+      if @navigation==:random_access
+        settings.send(@question_layout).set
+        settings.send(@numbering).set
+      # Mark for Review
+        settings.send(@mark_for_review)
+      end
+      # Submissions
+      settings.send(@submissions).set
+      if @submissions==:only_x_submissions
+        settings.allowed_submissions.set @num_submissions
+      end
+      settings.send(@late_handling).set
+      # Submission Message
+      settings.submission_message.set @submission_message
+      settings.final_page_url.set @final_page_url
+      # Feedback
+      settings.send(@feedback_authoring).set
+      settings.send(@feedback_delivery).set
+      settings.send(@release).set
+      @release_options.each do |option|
+        settings.send(option).set
+      end
+      if @feedback_delivery==:feedback_on_date
+        settings.feedback_date.set @feedback_date
+      end
+      # Grading
+      # TODO: More to add here
+      # Graphics
+
+      # Metadata
+
+
+      settings.save
+    end
+  end
+
+  def update_settings opts={}
+
+    set_options(opts)
+  end
+
+  def publish
+    my_workspace.open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    tests_and_quizzes unless @browser.title=~/Tests & Quizzes$/
+    reset
+    on AssessmentsList do |list|
+      list.publish @title
+    end
+    on PublishAssessment do |assessment|
+      assessment.publish
+    end
+  end
+
+  def add_part opts={}
+    position
+    defaults = {
+      :assessment=>@title,
+      :part_number=>@parts.length+1
+    }
+    options = defaults.merge(opts)
+    part = make PartObject, options
+    part.create
+    @parts << part
+  end
+
+  def add_question opts={}
+    position
+    defaults = {
+        :assessment=>@title,
+        :part=>@parts[rand(@parts.length)].title
+    }
+    options = defaults.merge(opts)
+    question = make QuestionObject, options
+    question.create
+    @questions << question
+  end
+
+  private
+
+  def position
+    my_workspace.open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    tests_and_quizzes unless @browser.title=~/Tests & Quizzes$/
+    unless @browser.frame(:class=>"portletMainIframe").h3.text=="Questions: #{@title}"
+      reset
+      on AssessmentsList do |list|
+        list.edit @title
+      end
+    end
+  end
+
+end
+
+class QuestionObject
+
+  include Foundry
+  include Utilities
+  include Workflows
+  include StringFactory
+
+  attr_accessor :type, :assessment, :text, :point_value, :part,
+                # Multiple Choice attributes...
+                :correct_type, :answer_credit, :negative_point_value
+
+  def initialize(browser, opts={})
+    @browser = browser
+    defaults = {
+        :type=>QUESTION_TYPES.keys[rand(QUESTION_TYPES.length)],
+        :text=>random_alphanums,
+        :point_value=>(rand(100)+1).to_s
+
+    }
+    options = defaults.merge(opts)
+    set_options(options)
+    requires @assessment
+  end
+
+  QUESTION_TYPES = {
+      :"Multiple Choice"=>:add_multiple_choice,
+      :Survey=>:add_survey#,
+      #:"Short Answer/Essay"=>:add_short_answer,
+      #:"Fill in the Blank"=>:add_fill_in_the_blank,
+      #:"Numeric Response"=>:add_numeric,
+      #:Matching=>:add_matching,
+      #:"True False"=>:add_true_false,
+      #:"Audio Recording"=>:add_audio,
+      #:"File Upload"=>:add_file_upload,
+      #:"Calculated Question"=>:add_calculated_question
+  }
+
+  def create
+    on EditAssessment do |edit|
+      edit.add_question_to_part(@part).select @type
+    end
+    self.send(QUESTION_TYPES[@type.to_sym])
+  end
+
+  private
+
+  def add_multiple_choice
+    on MultipleChoice do |add|
+      add.answer_point_value.set @point_value
+      add.question_text.set @text
+      add.send(@correct_type).set
+      add.send(@answer_credit).set unless @answer_credit==nil
+      add.negative_point_value.set @negative_point_value unless @negative_point_value==nil
+
+    end
+  end
+
+  def add_survey
+    on Survey do |add|
+
+    end
   end
 
-end
+end
+
+class PartObject
+
+  include Foundry
+  include Utilities
+  include Workflows
+  include StringFactory
+
+  attr_accessor :assessment, :title, :information, :type, :number_of_questions, :pool_name, :part_number, :question_ordering
+  
+  def initialize(browser, opts={})
+    @browser = browser
+    
+    defaults = {
+      :title=>random_alphanums,
+      :information=>random_alphanums,
+      :type=>:one_by_one,
+      :question_ordering=>:order_as_listed
+    }
+    options = defaults.merge(opts)
+    
+    set_options(options)
+    requires @assessment
+  end
+    
+  def create
+    on EditAssessment do |edit|
+      edit.add_part
+    end
+    on AddEditAssessmentPart do |part|
+      part.title.set @title
+      part.information.set @information
+      part.send(@type).set
+      part.send(@question_ordering).set
+      # TODO: more to add here
+      part.save
+    end
+  end
+    
+  def edit opts={}
+
+    set_options(opts)
+  end
+    
+  def view
+    
+  end
+    
+  def delete
+    
+  end
+  
+end
+    
+      

data/lib/sambal-cle/data_objects/assignment.rb

@@ -1,9 +1,11 @@
+# This data object is strictly the assignment as created by an instructor
+# for Student submissions of an assignment, use AssignmentSubmissionObject
 class AssignmentObject
 
-  include PageHelper
-  include Utilities
-  include Randomizers
-  include DateMakers
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include DateFactory
   include Workflows
 
   attr_accessor :title, :site, :instructions, :id, :link, :status, :grade_scale,
@@ -28,23 +30,8 @@ class AssignmentObject
     }
     options = defaults.merge(opts)
 
-    @title=options[:title]
-    @instructions=options[:instructions]
-    @site=options[:site]
-    @grade_scale=options[:grade_scale]
-    @max_points=options[:max_points]
-    @allow_resubmission=options[:allow_resubmission]
-    @num_resubmissions=options[:num_resubmissions]
-    @open=options[:open]
-    @due=options[:due]
-    @accept_until=options[:accept_until]
-    @resubmission=options[:resubmission]
-    @student_submissions=options[:student_submissions]
-    @add_due_date=options[:add_due_date]
-    @add_open_announcement=options[:add_open_announcement]
-    @add_to_gradebook=options[:add_to_gradebook]
-    @status=options[:status]
-    raise "You must specify a Site for your Assignment" if @site==nil
+    set_options(options)
+    requires @site
     raise "You must specify max points if your grade scale is 'points'" if @max_points==nil && @grade_scale=="Points"
   end
 
@@ -121,6 +108,7 @@ class AssignmentObject
         list.edit_assignment @title
       end
     end
+
     on AssignmentAdd do |edit|
       edit.title.set opts[:title] unless opts[:title]==nil
       unless opts[:instructions]==nil
@@ -128,11 +116,12 @@ class AssignmentObject
       end
       edit.grade_scale.select opts[:grade_scale] unless opts[:grade_scale]==nil
       edit.max_points.set opts[:max_points] unless opts[:max_points]==nil
-      # This should be one of the last items edited...
-      edit.add_to_gradebook.send(opts[:add_to_gradebook]) unless opts[:add_to_gradebook]==nil
 
       #TODO: All the rest goes here
 
+      # This should be one of the last items edited...
+      edit.add_to_gradebook.send(opts[:add_to_gradebook]) unless opts[:add_to_gradebook]==nil
+
       if (@status=="Draft" && opts[:status]==nil) || opts[:status]=="Draft"
         edit.save_draft
       elsif opts[:status]=="Editing"
@@ -141,12 +130,7 @@ class AssignmentObject
         edit.post
       end
     end
-    @title=opts[:title] unless opts[:title] == nil
-    @instructions=opts[:instructions] unless opts[:instructions] == nil
-    @grade_scale=opts[:grade_scale] unless opts[:grade_scale] == nil
-    @max_points=opts[:max_points] unless opts[:title] == nil
-    @add_to_gradebook==opts[:add_to_gradebook]
-    # TODO: Add all the rest of the elements here
+    set_options(opts)
 
     unless opts[:status]=="Editing"
       on AssignmentsList do |list|
@@ -194,12 +178,34 @@ class AssignmentObject
     end
   end
 
-  def submit
-    # TODO: Create this method
+  def duplicate
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.duplicate @title
+    end
+
+    duplicate_assignment = self
+    duplicate_assignment.title="Draft - #{self.title} - Copy"
+    duplicate_assignment.status="Draft"
+    duplicate_assignment
   end
 
-  def grade
+  def view_submissions
     # TODO: Create this method
   end
 
+  # Use this method to open a submitted assignment for viewing
+  # the page.
+  def view_submission
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.open_assignment @title
+    end
+  end
+  alias open view_submission
+
 end

data/lib/sambal-cle/data_objects/assignment_permissions.rb

@@ -0,0 +1,61 @@
+class AssignmentPermissionsObject # TODO: Need to add support for Group-specific permissions
+
+  include Foundry
+  include DataFactory
+  include Workflows
+  
+  attr_accessor :site, :group, :guest, :instructor, :student, :teaching_assistant
+  
+  def initialize(browser, opts={})
+    @browser = browser
+    checkboxes={:all_groups=>nil, :new=>nil, :submit=>nil, :delete=>nil, :read=>nil, :revise=>nil, :grade=>nil, :receive_notifications=>nil, :share_drafts=>nil}
+    @guest=checkboxes
+    @instructor=checkboxes
+    @student=checkboxes
+    @teaching_assistant=checkboxes
+    set_options(opts)
+    requires @site
+    get
+  end
+    
+  def set opts={}
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.permissions
+    end
+    on AssignmentsPermissions do |perm|
+      roles={:guest=>"Guest", :instructor=>"Instructor", :student=>"Student", :teaching_assistant=>"Teaching Assistant"}
+      roles.each_pair do |role, title|
+        if opts[role]!=nil
+          opts[role].each_pair do |checkbox, setting|
+            perm.send(checkbox, title).send(setting)
+          end
+        end
+      end
+      perm.save
+    end
+    @guest = @guest.merge(opts[:guest]) unless opts[:guest]==nil
+    @instructor = @instructor.merge(opts[:instructor]) unless opts[:instructor]==nil
+    @student = @student.merge(opts[:student]) unless opts[:student]==nil
+    @teaching_assistant = @teaching_assistant.merge(opts[:teaching_assistant]) unless opts[:teaching_assistant]==nil
+  end
+
+  def get
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.permissions
+    end
+    on AssignmentsPermissions do |perm|
+      roles={@guest=>"Guest", @instructor=>"Instructor", @student=>"Student", @teaching_assistant=>"Teaching Assistant"}
+      roles.each_pair do |role, name|
+        role.each_key { |key| role.store(key, checkbox_setting(perm.send(key, name))) }
+      end
+      perm.cancel
+    end
+  end
+  
+end

data/lib/sambal-cle/data_objects/assignment_submission.rb

@@ -0,0 +1,126 @@
+class AssignmentSubmissionObject
+
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include DateFactory
+  include Workflows
+
+  attr_accessor :site, :title, :text, :status, :submission_date,
+      :student, :allow_resubmission, :resubmission, :num_resubmissions,
+      :release_to_student, :grade, :summary_comment, :inline_comment,
+      :grade_status, :accept_until, :returned
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      :text=>random_alphanums,
+      :status=>"Not Started"
+    }
+    options = defaults.merge(opts)
+
+    set_options(options)
+    requires @site, @title, @student
+  end
+
+  def submit
+    open
+    on AssignmentStudentView do |assignment|
+      assignment.assignment_text=@text
+      # TODO: Add stuff for adding file(s) to the assignment
+      assignment.submit
+      @submission_date=right_now[:sakai]
+      @status="Submitted"
+    end
+  end
+
+  def save_draft
+    open
+    on AssignmentStudentView do |assignment|
+      assignment.assignment_text=@text
+      # TODO: Add stuff for adding file(s) to the assignment
+      assignment.save_draft
+      @submission_date=right_now[:sakai]
+      @status="Draft - In progress"
+    end
+  end
+
+  def resubmit opts={}
+    open
+    on AssignmentStudentView do |assignment|
+      assignment.assignment_text=opts[:text] unless opts[:text]==nil
+      # TODO: Add stuff for adding/updating/removing file(s) for the assignment
+      assignment.resubmit
+      @submission_date=right_now[:sakai] # Is this right?
+      @status="Submitted"
+    end
+    @text=opts[:text]
+  end
+
+  def grade_submission opts={}
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.grade @title
+    end
+    on AssignmentSubmissionList do |submissions|
+      submissions.grade @student.ln_fn_id
+    end
+    on AssignmentSubmission do |submission|
+      submission.prepend(submission.assignment_submission, "{{#{opts[@inline_comment]}}}") unless opts[:inline_comment]==nil
+      submission.instructor_comments=opts[:summary_comment] unless opts[:summary_comment]==nil
+      submission.grade.select opts[:grade] unless opts[:grade]==nil
+      submission.allow_resubmission.send(opts[:allow_resubmission]) unless opts[:allow_resubmission]==nil
+      if opts[:allow_resubmission]==:set || submission.allow_resubmission.set?
+        submission.num_resubmissions.wait_until_present
+        if opts[:accept_until]==nil
+          @num_resubmissions=submission.num_resubmissions.selected_options[0].text
+          @accept_until={} # Okay to wipe this (in case it's there) because we're getting
+                           # the values from UI--but most likely this var is nil anyway,
+                           # in which case we need to turn it into a hash.
+          @accept_until[:MON]=submission.accept_until_month.selected_options[0].text
+          @accept_until[:day_of_month]=submission.accept_until_day.selected_options[0].text
+          @accept_until[:year]=submission.accept_until_year.selected_options[0].text
+          @accept_until[:hour]=submission.accept_until_hour.selected_options[0].text
+          @accept_until[:minute_rounded]=submission.accept_until_min.selected_options[0].text
+          @accept_until[:MERIDIAN]=submission.accept_until_meridian.selected_options[0].text
+          @accept_until[:sakai_rounded]=@accept_until[:MON].capitalize+" "+@accept_until[:day_of_month]+", "+@accept_until[:year]+" "+@accept_until[:hour]+":"+@accept_until[:minute_rounded]+" "+@accept_until[:MERIDIAN].downcase
+        else
+          submission.num_resubmissions.select opts[:num_resubmissions]
+          submission.accept_until_month.select opts[:accept_until][:MON]
+          submission.accept_until_day.select opts[:accept_until][:day_of_month]
+          submission.accept_until_year.select opts[:accept_until][:year]
+          submission.accept_until_hour.select opts[:accept_until][:hour]
+          submission.accept_until_min.select opts[:accept_until][:minute_rounded]
+          submission.accept_until_meridian.select opts[:accept_until][:MERIDIAN]
+        end
+      end
+      if opts[:release_to_student]=~/yes/i
+        submission.save_and_release
+        @status="Returned"
+        @returned=right_now
+      else
+        submission.save_and_dont_release
+      end
+      submission.return_to_list
+    end
+    on AssignmentSubmissionList do |list|
+      @grade_status=list.submission_status_of @student.ln_fn_id
+    end
+    set_options(opts)
+  end
+
+  def open
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    reset
+    on AssignmentsList do |list|
+      list.open_assignment @title
+    end
+  end
+  alias view open
+
+
+end

data/lib/sambal-cle/data_objects/blog.rb

@@ -1,7 +1,7 @@
 class BlogEntryObject
 
-  include PageHelper
-  include Utilities
+  include Foundry
+  include StringFactory
   include Workflows
   
   attr_accessor :title, :content, :site, :permissions
@@ -16,11 +16,8 @@ class BlogEntryObject
     }
     options = defaults.merge(opts)
     
-    @title=options[:title]
-    @content=options[:content]
-    @site=options[:site]
-    @permissions=options[:permissions]
-    raise "You need to specify a site for your blog entry" if @site==nil
+    set_options(options)
+    requirements @site
   end
     
   def create