sambal-cle 0.1.3

data/lib/sambal-cle/date_makers.rb

@@ -0,0 +1,118 @@
+# Some date and time helper functions....
+module DateMakers
+
+  MONTHS = %w{JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC}
+  def an_hour_ago
+    date_factory(Time.now - 3600)
+  end
+  alias last_hour an_hour_ago
+
+  def right_now
+    date_factory(Time.now)
+  end
+
+  def in_an_hour
+    date_factory(Time.now + 3600)
+  end
+  alias next_hour in_an_hour
+
+  def last_year
+    date_factory(Time.now - (3600*24*365))
+  end
+  alias a_year_ago last_year
+
+  def last_month
+    index = MONTHS.index(current_month)
+    return MONTHS[index-1]
+  end
+
+  def hours_ago(num)
+    date_factory(Time.now - num*3600)
+  end
+
+  def hours_from_now(num)
+    date_factory(Time.now + num*3600)
+  end
+
+  def minutes_ago(num)
+    date_factory(Time.now - num*60)
+  end
+
+  def minutes_from_now(num)
+    date_factory(Time.now + num*60)
+  end
+
+  def current_month
+    Time.now.strftime("%^b")
+  end
+
+  def next_month
+    index = MONTHS.index(current_month)
+    if index < 11
+      return MONTHS[index+1]
+    else
+      return MONTHS[0]
+    end
+  end
+
+  def in_a_year
+    date_factory(Time.now + (3600*24*365))
+  end
+
+  def yesterday
+    date_factory(Time.now - (3600*24))
+  end
+
+  def tomorrow
+    date_factory(Time.now + (3600*24))
+  end
+
+  def in_a_week
+    date_factory(Time.now + (3600*24*7))
+  end
+  alias next_week in_a_week
+
+  def a_week_ago
+    date_factory(Time.now - (3600*24*7))
+  end
+
+  def next_monday
+    date_factory(Time.at(Time.now+(8-Time.now.wday)*24*3600))
+  end
+
+  # Formats a date string Sakai-style.
+  # Useful for verifying creation dates and such.
+  #
+  # Supplied variable must be of of the Time class.
+  def make_date(time_object)
+    month = time_object.strftime("%b ")
+    day = time_object.strftime("%-d")
+    year = time_object.strftime(", %Y ")
+    mins = time_object.strftime(":%M %P")
+    hour = time_object.strftime("%l").to_i
+    return month + day + year + hour.to_s + mins
+  end
+
+  # Takes a time object and returns a hash containing
+  # various parts of the relevant date.
+  def date_factory(time_object)
+    {
+        :sakai=>make_date(time_object),
+        :short_date=>time_object.strftime("%b %-d, %Y"), # => "Oct 18, 2013"
+        :MON => time_object.strftime("%^b"), # => "DEC"
+        :Mon => time_object.strftime("%b"), # => "Jan"
+        :Month => time_object.strftime("%B"), # => "February"
+        :month_int => time_object.month, # => 3
+        :day_of_month => time_object.day, # => 17 Note this is not zero-padded
+        :weekday => time_object.strftime("%A"), # => "Monday"
+        :wkdy => time_object.strftime("%a"), # => "Tue"
+        :year => time_object.year, # => 2013
+        :hour => time_object.strftime("%I").to_i, # => "07" Zero-padded, 12-hour clock
+        :minute => (time_object).strftime("%M"), # => "02" Zero-padded
+        :minute_rounded => (Time.at(time_object.to_i/(5*60)*(5*60))).strftime("%M"), # => "05" Zero-padded, rounded to 5-minute increments
+        :meridian => time_object.strftime("%P"), # => "pm"
+        :MERIDIAN => time_object.strftime("%p") # => "AM"
+    }
+  end
+
+end

data/lib/sambal-cle/gem_ext.rb

@@ -0,0 +1,23 @@
+# Need this to extend Watir to be able to attach to Sakai's non-standard tags...
+module Watir
+  class Element
+    # attaches to the "headers" tags inside of the assignments table.
+    def headers
+      @how = :ole_object
+      return @o.headers
+    end
+
+    # attaches to the "for" tags in "label" tags.
+    def for
+      @how = :ole_object
+      return @o.for
+    end
+
+    # attaches to the "summary" tag
+    def summary
+      @how = :ole_object
+      return @o.summary
+    end
+
+  end
+end

data/lib/sambal-cle/page_helper.rb

@@ -0,0 +1,22 @@
+module PageHelper
+
+  def visit page_class, &block
+    on page_class, true, &block
+  end
+
+  def on page_class, visit=false, &block
+    @current_page = page_class.new @browser, visit
+    block.call @current_page if block
+    @current_page
+  end
+  alias on_page on
+
+  def make data_object_class, opts={}
+    data_object_class.new @browser, opts
+  end
+
+  def wait_until(timeout=30, message=nil, &block)
+    Object::Watir::Wait.until(timeout, message, &block)
+  end
+
+end

data/lib/sambal-cle/page_maker.rb

@@ -0,0 +1,48 @@
+class PageMaker
+
+  def initialize browser, visit = false
+    @browser = browser
+    goto if visit
+    expected_element if respond_to? :expected_element
+    has_expected_title? if respond_to? :has_expected_title?
+  end
+
+  def method_missing sym, *args, &block
+    @browser.send sym, *args, &block
+  end
+
+  class << self
+
+    def page_url url
+      define_method 'goto' do
+        @browser.goto url
+      end
+    end
+
+    def expected_element element_name, timeout=30
+      define_method 'expected_element' do
+        self.send(element_name).wait_until_present timeout
+      end
+    end
+
+    def expected_title expected_title
+      define_method 'has_expected_title?' do
+        has_expected_title = expected_title.kind_of?(Regexp) ? expected_title =~ @browser.title : expected_title == @browser.title
+        raise "Expected title '#{expected_title}' instead of '#{@browser.title}'" unless has_expected_title
+      end
+    end
+
+    def element element_name
+      raise "#{element_name} is being defined twice in #{self}!" if self.instance_methods.include?(element_name.to_sym)
+      define_method element_name.to_s do
+        yield self
+      end
+    end
+
+    alias :value :element
+    alias :action :element
+    alias :thing :element
+
+  end
+
+end # PageMaker

data/lib/sambal-cle/page_objects/account.rb

@@ -0,0 +1,111 @@
+#================
+# User's Account Page - in "My Settings"
+#================
+
+# The Page for editing User Account details
+class EditAccount < BasePage
+
+  frame_element
+
+  # Clicks the update details button then
+  # makes sure there isn't any error message present.
+  # If there is, it reinstantiates the Edit Account Class,
+  # otherwise it instantiates the UserAccount Class.
+  def update_details
+    frm.button(:value=>"Update Details").click
+    # Need to check if the update took...
+    if frm.div(:class=>"portletBody").h3.text=="My Account Details"
+      # Apparently it did...
+      UserAccount.new(@browser)
+    elsif frm.div(:class=>"portletBody").h3.text=="Account Details"
+      # We are on the edit page (or we're using the Admin account)...
+      EditAccount.new(@browser)
+    elsif frm.div(:class=>"portletBody").h3.text=="Users"
+      Users.new(@browser)
+    end
+  end
+
+  element(:first_name) { |b| b.frm.text_field(:id=>"first-name") }
+  element(:last_name) { |b| b.frm.text_field(:id=>"last-name") }
+  element(:email) { |b| b.frm.text_field(:id=>"email") }
+  element(:current_password) { |b| b.frm.text_field(:id=>"pwcur") }
+  element(:create_new_password) { |b| b.frm.text_field(:id=>"pw") }
+  element(:verify_new_password) { |b| b.frm.text_field(:id=>"pw0") }
+end
+
+
+# A Non-Admin User's Account page
+# Accessible via the "Account" link in "MY SETTINGS"
+#
+# IMPORTANT: this class does not use PageObject or the ToolsMenu!!
+# So, the only available method to navigate away from this page is
+# Home. Otherwise, you'll have to call the navigation link
+# Explicitly in the test case itself.
+#
+# Objects and methods used in this class must be explicitly
+# defined using Watir and Ruby code.
+#
+# Do NOT use the PageObject syntax in this class.
+class UserAccount < BasePage
+
+  frame_element
+
+  # Clicks the Modify Details button. Instantiates the EditAccount class.
+  def modify_details
+    @browser.frame(:index=>0).button(:name=>"eventSubmit_doModify").click
+    EditAccount.new(@browser)
+  end
+
+  # Gets the text of the User ID field.
+  def user_id
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>0)[0][1].text
+  end
+
+  # Gets the text of the First Name field.
+  def first_name
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>0)[1][1].text
+  end
+
+  # Gets the text of the Last Name field.
+  def last_name
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>0)[2][1].text
+  end
+
+  # Gets the text of the Email field.
+  def email
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>0)[3][1].text
+  end
+
+  # Gets the text of the Type field.
+  def type
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>0)[4][1].text
+  end
+
+  # Gets the text of the Created By field.
+  def created_by
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>1)[0][1].text
+  end
+
+  # Gets the text of the Created field.
+  def created
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>1)[1][1].text
+  end
+
+  # Gets the text of the Modified By field.
+  def modified_by
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>1)[2][1].text
+  end
+
+  # Gets the text of the Modified (date) field.
+  def modified
+    @browser.frame(:index=>0).table(:class=>"itemSummary", :index=>1)[3][1].text
+  end
+
+  # Clicks the Home buton in the left menu.
+  # instantiates the Home Class.
+  def home
+    @browser.link(:text, "Home").click
+    Home.new(@browser)
+  end
+
+end

data/lib/sambal-cle/page_objects/aliases.rb

@@ -0,0 +1,43 @@
+#================
+# Aliases Pages
+#================
+
+# The Aliases page - "icon-sakai-aliases", found in the Administration Workspace
+class Aliases < BasePage
+
+  frame_element
+
+  element(:search_field) { |b| b.frm.text_field(:id=>"search") }
+  action(:next) { |b| b.frm.button(:name=>"eventSubmit_doList_next").click }
+  action(:last) { |b| b.frm.button(:name=>"eventSubmit_doList_last").click }
+  action(:previous) { |b| b.frm.button(name=>"eventSubmit_doList_prev").click }
+  action(:first) { |b| b.frm.button(:name=>"eventSubmit_doList_first").click }
+  action(:new_alias) { |b| b.frm.link(:text=>"New Alias").click }
+  action(:search_button) { |b| b.frm.button(:text=>"Search").click }
+  element(:select_page_size) { |b| b.frm.select(:id=>"selectPageSize") }
+
+end
+
+# The Page that appears when you create a New Alias
+class AliasesCreate < BasePage
+
+  frame_element
+
+  element(:alias_name) { |b| b.frm.text_field(:id=>"id") }
+  element(:target) { |b| b.frm.text_field(:id=>"target") }
+  action(:save) { |b| b.frm.button(:name=>"eventSubmit_doSave").click }
+  action(:cancel) { |b| b.frm.button(:name=>"eventSubmit_doCancel").click }
+
+end
+
+# Page for editing an existing Alias record
+class EditAlias < BasePage
+
+  frame_element
+
+  action(:remove_alias) { |b| b.frm.link(:text=>"Remove Alias").click }
+  element(:target) { |b| b.frm.text_field(:id=>"target") }
+  action(:save) { |b| b.frm.button(:name=>"eventSubmit_doSave").click }
+  action(:cancel) { |b| b.frm.button(:name=>"eventSubmit_doCancel").click }
+
+end

data/lib/sambal-cle/page_objects/announcements.rb

@@ -0,0 +1,190 @@
+# The Announcements list page for a Site.
+class Announcements < BasePage
+
+  frame_element
+
+  # Clicks the add button, goes to the AddEditAnnouncements class.
+  action(:add) { |b| b.frm.div(:class=>"portletBody").link(:title=>"Add").click }
+
+  # Edits the specified announcement in the list.
+  # @param subject [String] the text of the announcement listing link.
+  def edit(subject)
+    frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).link(:text=>"Edit").click
+  end
+
+  def view(title)
+    frm.link(:text=>title).click
+  end
+
+  # Returns an array of the subject strings of the announcements
+  # listed on the page.
+  def subjects
+    links = frm.table(:class=>"listHier").links.find_all { |link| link.title=~/View announcement/ }
+    subjects = []
+    links.each { |link| subjects << link.text }
+    return subjects
+  end
+
+  def href(subject)
+    frm.link(:text=>subject).href
+  end
+
+  # Returns true or false depending on whether the specified announcement has an attachment.
+  # @param subject [String] the text of the announcement listing link.
+  def has_attachment?(subject)
+    if frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).exist?
+      return frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).image(:alt=>"attachment").exist?
+    else
+      puts "Can't find your target row. Your test is faulty."
+      return false
+    end
+  end
+
+  # Returns the text of the "For" column for
+  # the specified announcement.
+  # @param subject [String] the text of the announcement listing link.
+  def for_column(subject)
+    frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/)[4].text
+  end
+
+  # Clicks the specified announcement link and instantiates the PreviewAnnouncements class.
+  # @param subject [String] the text of the announcement listing link.
+  def preview_announcement(subject)
+    frm.link(:text=>subject).click
+    PreviewAnnouncements.new(@browser)
+  end
+
+  # Selects the specified list item from the View selection list.
+  # @param list_item [String] the text of the option in the selection list.
+  def view=(list_item)
+    frm.select(:id=>"view").set(list_item)
+  end
+
+  # Clicks the Merge link and goes to the AnnouncementsMerge class.
+  action(:merge) { |b| b.frm.link(:text=>"Merge").click }
+
+end
+
+# Show Announcements from Another Site. On this page you select what announcements
+# you want to merge into the current Site.
+class AnnouncementsMerge < BasePage
+
+  frame_element
+
+  # Checks the checkbox for the specified site name
+  # @param site_name [String] the name of the relevant site displayed in the table
+  def check(site_name)
+    frm.table(:class=>"listHier lines nolines").row(:text=>/#{Regexp.escape(site_name)}/).checkbox(:id=>/site/).set
+  end
+
+  # Clicks the Save button and goes to the Announcements class.
+  action(:save) { |b| b.frm.button(:value=>"Save").click }
+
+end
+
+# This Class does double-duty. It's for the Preview page when editing an
+# Announcement, plus for when you just click an Announcement to view it.
+class ViewAnnouncement < BasePage
+
+  frame_element
+
+  # Clicks the Return to list button and goes to the Announcements class.
+  action(:return_to_list) { |b| b.frm.button(:value=>"Return to List").click }
+
+  # Clicks the Save changes button and goes to the Announcements class.
+  action(:save_changes) { |b| b.frm.button(:value=>"Save Changes").click }
+
+  # Clicks the Edit button and goes to the AddEditAnnouncements class.
+  action(:edit) { |b| b.frm.button(:value=>"Edit").click }
+
+  value(:subject) { |b| b.frm.table(class: "itemSummary")[0][1].text }
+  value(:saved_by) { |b| b.frm.table(class: "itemSummary")[1][1].text }
+  value(:date) { |b| b.frm.table(class: "itemSummary")[2][1].text }
+  value(:groups) { |b| b.frm.table(class: "itemSummary")[3][1].text }
+  value(:message) { |b| b.frm.div(class: "portletBody").p.text }
+  value(:message_html) { |b| b.frm.div(class: "portletBody").p.html }
+
+end
+
+# The page where an announcement is created or edited.
+class AddEditAnnouncements < BasePage
+
+  include FCKEditor
+  frame_element
+
+  expected_element :editor
+
+  element(:editor) { |b| b.frm.frame(:id, "body___Frame") }
+
+  # Clicks the Add Announcement button. The next class is either
+  # AddEditAnnouncements or Announcements.
+  action(:add_announcement) { |b| b.frm.button(:value=>"Add Announcement").click }
+
+  # Clicks the Save changes button. Next is the Announcements class.
+  action(:save_changes) { |b| b.frm.button(:value=>"Save Changes").click }
+
+  # Clicks the Preview button. Next is the PreviewAnnouncements class.
+  action(:preview){ |b| b.frm.button(:value=>"Preview").click }
+
+
+  # Sends the specified text block to the rich text editor
+  # @param text [String] the text that you want to add to the editor.
+  def body=(text)
+    editor.td(:id, "xEditingArea").frame(:index=>0).send_keys(text)
+  end
+
+  # Clicks the Add attachments button. Next is the Announcments Attach class.
+  action(:add_attachments) { |b| b.frm.button(:value=>"Add Attachments").click }
+
+  # Clicks the checkbox for the specified group name
+  # when you've set the announcement access to display
+  # to groups.
+  # @param group_name [String] the name of the group in the table that you intend to select.
+  def check_group(group_name)
+    frm.table(:id=>"groupTable").row(:text=>/#{Regexp.escape(group_name)}/).checkbox(:name=>"selectedGroups").set
+  end
+
+  element(:title) { |b| b.frm.text_field(:id=>"subject") }
+  element(:site_members) { |b| b.frm.radio(:id=>"site") }
+  element(:publicly_viewable) { |b| b.frm.radio(:id=>"pubview") }
+  element(:groups) { |b| b.frm.radio(:id=>"groups") }
+  element(:show) { |b| b.frm.radio(:id=>"hidden_false") }
+  element(:hide) { |b| b.frm.radio(:id=>"hidden_true") }
+  element(:specify_dates) { |b| b.frm.radio(:id=>"hidden_specify") }
+  element(:beginning) { |b| b.frm.checkbox(:id=>"use_start_date") }
+  element(:ending) { |b| b.frm.checkbox(:id=>"use_end_date") }
+  element(:all) { |b| b.frm.checkbox(:id=>"selectall") }
+
+  element(:beginning_month) { |b| b.frm.select(:id=>"release_month") }
+
+  # Sets the Beginning Day selection to the
+  # specified string.
+  element(:beginning_day) { |b| b.frm.select(:id=>"release_day") }
+  element(:beginning_year) { |b| b.frm.select(:id=>"release_year") }
+  element(:beginning_hour) { |b| b.frm.select(:id=>"release_hour") }
+  element(:beginning_minute) { |b| b.frm.select(:id=>"release_minute") }
+  element(:beginning_meridian) { |b| b.frm.select(:id=>"release_ampm") }
+  element(:ending_month) { |b| b.frm.select(:id=>"retract_month") }
+  element(:ending_day) { |b| b.frm.select(:id=>"retract_day") }
+  element(:ending_year) { |b| b.frm.select(:id=>"retract_year") }
+  element(:ending_hour) { |b| b.frm.select(:id=>"retract_hour") }
+  element(:ending_minute) { |b| b.frm.select(:id=>"retract_minute") }
+  element(:ending_meridian) { |b| b.frm.select(:id=>"retract_ampm") }
+
+  value(:alert_message) { |b| b.frm.div(:class=>"alertMessage").text }
+
+end
+
+# Page for setting up options for announcements
+class AnnouncementsOptions < BasePage
+
+  frame_element
+
+end
+
+# Page containing permissions options for announcements
+class AnnouncementsPermissions < BasePage
+
+  frame_element
+
+end