kuality-coeus 0.0.1 → 0.0.2

data/lib/kuality-coeus.rb

@@ -1,14 +1,17 @@
 require 'test-factory'
+require 'date'
+require 'yaml'
 Dir["#{File.dirname(__FILE__)}/kuality-coeus/*.rb"].each {|f| require f }
 Dir["#{File.dirname(__FILE__)}/kuality-coeus/page_objects/*.rb"].each {|f| require f }
 Dir["#{File.dirname(__FILE__)}/kuality-coeus/page_objects/*/*.rb"].each {|f| require f }
 Dir["#{File.dirname(__FILE__)}/kuality-coeus/data_objects/*.rb"].each {|f| require f }
+Dir["#{File.dirname(__FILE__)}/kuality-coeus/data_objects/*/*.rb"].each {|f| require f }
 
 # Initialize this class at the start of your test cases to
-# open the specified test browser at the specified Sakai welcome page URL.
+# open the specified test browser at the specified welcome page URL.
 #
 # The initialization will
-# create the @browser variable used throughout the page classes
+# create the browser object that can be used throughout the page classes
 class Kuality
 
   attr_reader :browser

data/lib/kuality-coeus/core_extensions.rb

@@ -0,0 +1,10 @@
+class String
+
+  # Used to remove commas from long number strings,
+  # then converting the result to a Float so that it
+  # can be used in calculations.
+  def groom
+    self.gsub(',','').to_f
+  end
+
+end

data/lib/kuality-coeus/data_objects/award/award.rb

@@ -0,0 +1,126 @@
+class AwardObject
+
+  include Foundry
+  include DataFactory
+  include Navigation
+  include DateFactory
+  include StringFactory
+
+  attr_accessor :description, :transaction_type, :award_id, :funding_proposal, :award_status,
+                :award_title, :lead_unit, :activity_type, :award_type, :sponsor_id,
+                :project_start_date, :project_end_date, :obligation_start_date,
+                :obligation_end_date, :anticipated_amount, :obligated_amount, :document_id,
+                :creation_date, :transactions
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      description:           random_alphanums,
+      transaction_type:      '::random::',
+      award_status:          '::random::',
+      award_title:           random_alphanums,
+      activity_type:         '::random::',
+      award_type:            '::random::',
+      project_start_date:    right_now, # Note how this is the date hash, for increased flexibility of validations or tests, if necessary
+      project_end_date:      in_a_year, # Same goes for this variable. It's the entire date hash
+      sponsor_id:            '::random::',
+      lead_unit:             '::random::',
+      obligation_start_date: right_now, # Date hash, again
+      obligation_end_date:   in_a_year, # and again
+      anticipated_amount:    '1000000',
+      obligated_amount:      '1000000',
+      transactions:       TransactionCollection.new
+    }
+
+    set_options(defaults.merge(opts))
+  end
+
+  def create
+    @creation_date = right_now[:date_w_slashes]
+    visit(CentralAdmin).create_award
+    on Award do |create|
+      create.expand_all
+      fill_out create, :description, :transaction_type, :award_status, :award_title,
+               :activity_type, :award_type, :obligated_amount, :anticipated_amount
+      create.project_start_date.fit @project_start_date[:date_w_slashes]
+      create.project_end_date.fit @project_end_date[:date_w_slashes]
+      create.obligation_start_date.fit @obligation_start_date[:date_w_slashes]
+      create.obligation_end_date.fit @obligation_end_date[:date_w_slashes]
+      set_sponsor_id
+      set_lead_unit
+      create.save
+      @document_id = create.header_document_id
+      @award_id = create.header_award_id
+    end
+    add_funding_proposal if @funding_proposal
+  end
+
+  def add_funding_proposal # TODO: Add support for multiple funding proposals and merge types.
+    on Award do |page|
+      page.expand_all
+      page.institutional_proposal_number.set @funding_proposal
+      page.add_proposal
+    end
+  end
+
+  def add_transaction opts={}
+    defaults={award_id: @award_id}
+    options = defaults.merge(opts)
+    trans = make AwardTransactionObject, options
+    trans.create
+    @transactions << trans
+  end
+
+  # ========
+  private
+  # ========
+
+  def set_sponsor_id
+    if @sponsor_id=='::random::'
+      on(Award).lookup_sponsor
+      on SponsorLookup do |look|
+        look.sponsor_type_code.pick! '::random::'
+        look.search
+        look.page_links[rand(look.page_links.length)].click if look.page_links.size > 0
+        look.return_random
+      end
+    else
+      on(Award).sponsor_id.fit @sponsor_id
+    end
+  end
+
+  def set_lead_unit
+    lu_edit = on(Award).lead_unit_id.present?
+    randomize = @lead_unit=='::random::'
+    if lu_edit && randomize
+      on(Award).lookup_lead_unit
+      on UnitLookup do |lk|
+        lk.search
+        lk.return_random
+      end
+    elsif lu_edit && !randomize
+      on(Award).lead_unit_id.fit @lead_unit
+    else
+      @lead_unit=on(Award).lead_unit_ro
+    end
+  end
+
+  def navigate
+    doc_search unless on_award?
+    on(TimeAndMoney).return_to_award if on_tm?
+  end
+
+  def on_award?
+    if on(Award).headerinfo_table.exist?
+      on(Award).header_award_id==@award_id
+    else
+      false
+    end
+  end
+
+  def on_tm?
+    !(on(Award).t_m_button.exist?)
+  end
+
+end

data/lib/kuality-coeus/data_objects/award/award_transaction.rb

@@ -0,0 +1,57 @@
+class AwardTransactionObject
+
+  include Foundry
+  include DataFactory
+  include Navigation
+  include StringFactory
+
+  attr_accessor :award_id, :comment, :source_award, :destination_award, :obligated_change,
+                :anticipated_change
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      comment: random_string
+    }
+    set_options(defaults.merge(opts))
+    requires :award_id
+  end
+
+  def create
+    navigate
+    on TimeAndMoney do |create|
+      create.expand_all
+      create.transaction_comment.fit @comment
+      fill_out create, :source_award, :destination_award, :obligated_change,
+               :anticipated_change
+      create.add_transaction
+    end
+  end
+
+# ========
+  private
+# ========
+
+  def navigate
+    doc_search unless on_award?
+    on(Award).time_and_money unless on_tm?
+  end
+
+  def on_award?
+    if on(Award).headerinfo_table.exist?
+      on(Award).header_award_id==@award_id
+    else
+      false
+    end
+  end
+
+  def on_tm?
+    !(on(Award).t_m_button.exist?)
+  end
+
+end # AwardTransactionObject
+
+class TransactionCollection < Array
+
+end # TransactionCollection

data/lib/kuality-coeus/data_objects/budget/budget_periods.rb

@@ -0,0 +1,114 @@
+class BudgetPeriodObject
+
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include Navigation
+
+  attr_accessor :document_id, :budget_name, :number, :start_date, :end_date,
+                :total_sponsor_cost, :direct_cost, :f_and_a_cost, :unrecovered_f_and_a,
+                :cost_sharing, :cost_limit, :direct_cost_limit, :datified
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      doc_type: 'Budget Document ' # Note: the trailing space is not a typo!
+    }
+
+    set_options(defaults.merge(opts))
+    requires :document_id, :budget_name, :start_date
+    datify
+  end
+
+  def create
+    navigate
+    on Parameters do |create|
+      create.period_start_date.fit @start_date
+      create.period_end_date.fit @end_date
+      create.total_sponsor_cost.fit @total_sponsor_cost
+      fill_out create, :direct_cost, :cost_sharing, :cost_limit, :direct_cost_limit
+      create.fa_cost.fit @f_and_a_cost
+      create.unrecovered_fa_cost.fit @unrecoverd_f_and_a
+      create.add_budget_period
+    end
+  end
+
+  def edit opts={}
+    navigate
+    on Parameters do |edit|
+      edit.start_date_period(@number).fit opts[:start_date]
+      edit.end_date_period(@number).fit opts[:end_date]
+      # TODO: At some point it may become critical for the data object to automatically "know" that the total sponsor cost
+      # is always the sum of the direct and f&a costs.
+      dollar_fields.each do |field|
+        edit.send("#{field}_period", @number).fit opts[field]
+      end
+      edit.save
+      break if edit.errors.size > 0
+    end
+    set_options(opts)
+    datify
+  end
+
+  def delete
+    navigate
+    on(Parameters).delete_period @number
+  end
+
+  def dollar_fields
+    [:total_sponsor_cost, :direct_cost, :f_and_a_cost, :unrecovered_f_and_a,
+     :cost_sharing, :cost_limit, :direct_cost_limit]
+  end
+
+  # =======
+  private
+  # =======
+
+  # Nav Aids
+
+  def navigate
+    open_document @doc_type
+    unless on_page?(on(Parameters).on_off_campus) && on_budget?
+      on(Proposal).budget_versions
+      on(BudgetVersions).open @budget_name
+    end
+  end
+
+  def on_budget?
+    begin
+      on(Parameters).budget_name==@budget_name
+    rescue Selenium::WebDriver::Error::StaleElementReferenceError
+      false
+    end
+  end
+
+  # This takes the period start date and converts it into a Date object
+  # which is then stored in @datified.
+  #
+  # It's important in the context of the Budget Periods Collection,
+  # which uses it to determine the order of the Periods on the page.
+  def datify
+    @datified=Date.parse(@start_date[/(?<=\/)\d+$/] + '/' + @start_date[/^\d+\/\d+/])
+  end
+
+end # BudgetPeriodObject
+
+class BudgetPeriodsCollection < Array
+
+  def period(number)
+    self.find { |period| period.number==number }
+  end
+
+  # This will update the number values of the budget periods,
+  # based on their start date values.
+  def number!
+    self.sort_by! { |period| period.datified }
+    self.each_with_index { |period, index| period.number=index+1 }
+  end
+
+  def total_sponsor_cost
+    self.collect{ |period| period.total_sponsor_cost.to_f }.inject(0, :+)
+  end
+
+end # BudgetPeriodsCollection

data/lib/kuality-coeus/data_objects/budget/budget_versions.rb

@@ -0,0 +1,221 @@
+class BudgetVersionsObject
+
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include Navigation
+
+  attr_accessor :name, :document_id, :status,
+                # Stuff on Budget Versions page...
+                :version, :direct_cost, :f_and_a, :on_off_campus,
+                :total, :final, :residual_funds, :cost_sharing, :unrecovered_fa,
+                :comments, :f_and_a_rate_type, :last_updated, :last_updated_by,
+                # Stuff on the Parameters page...
+                :project_start_date, :project_end_date, :total_direct_cost_limit,
+                :budget_periods, :unrecovered_fa_rate_type, :f_and_a_rate_type,
+                :submit_cost_sharing, :residual_funds, :total_cost_limit,
+                :subaward_budgets
+
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      name:              random_alphanums_plus(40),
+      cost_sharing:      '0.00',
+      f_and_a:           '0.00',
+      budget_periods:    BudgetPeriodsCollection.new,
+      subaward_budgets:  SubawardBudgetCollection.new
+    }
+
+    set_options(defaults.merge(opts))
+    requires :document_id, :doc_type
+  end
+
+  def create
+    navigate
+    on BudgetVersions do |add|
+      @doc_header=add.doc_title
+      add.name.set @name
+      add.add
+      add.final(@name).fit @final
+      add.budget_status(@name).pick! @status
+      add.save
+      break if parameters.compact==nil # No reason to continue if there aren't other things to do
+      # Otherwise, go to parameters page and fill out the rest of the stuff...
+      add.open(@name)
+    end
+    #TODO: This needs to be dealt with more intelligently.
+    # It's clear that we need to learn more about how to set up
+    # sponsors better, so that we can predict when this dialog
+    # will show up and when it won't...
+    confirmation
+    on Parameters do |parameters|
+      @project_start_date=parameters.project_start_date
+      @project_end_date=parameters.project_end_date
+      parameters.total_direct_cost_limit.fit @total_direct_cost_limit
+      fill_out parameters, :comments, :modular_budget,
+               :residual_funds, :total_cost_limit, :unrecovered_fa_rate_type,
+               :f_and_a_rate_type, :submit_cost_sharing
+      parameters.on_off_campus.fit @on_off_campus
+      parameters.alert.ok if parameters.alert.exists?
+      parameters.save
+    end
+    confirmation
+    get_budget_periods
+  end
+
+  def add_period opts={}
+    defaults={
+        document_id: @document_id,
+        budget_name: @name,
+        doc_type: @doc_header
+    }
+    opts.merge!(defaults)
+
+    bp = create BudgetPeriodObject, opts
+    return if on(Parameters).errors.size > 0 # No need to continue the method if we have an error
+    @budget_periods << bp
+    @budget_periods.number! # This updates the number value of all periods, as necessary
+  end
+
+  def edit_period number, opts={}
+    @budget_periods.period(number).edit opts
+    @budget_periods.number!
+  end
+
+  def delete_period number
+    @budget_periods.period(number).delete
+    @budget_periods.delete(@budget_periods.period(number))
+    @budget_periods.number!
+  end
+
+  # Please note, this method is for VERY basic editing...
+  # Use it for editing the Budget Version while on the Proposal, but not the Periods
+  def edit opts={}
+    navigate
+    on BudgetVersions do |edit|
+      edit.final(@name).fit opts[:final]
+      edit.budget_status(@name).fit opts[:budget_status]
+      # TODO: More here as needed...
+      edit.save
+    end
+    set_options(opts)
+  end
+
+  def open_budget
+    navigate
+    on BudgetVersions do |page|
+      page.open @name
+    end
+    #TODO: This needs to be dealt with more intelligently.
+    # It's clear that we need to learn more about how to set up
+    # sponsors better, so that we can predict when this dialog
+    # will show up and when it won't...
+    confirmation
+  end
+
+  def copy_all_periods(new_name)
+    navigate
+    new_version_number='x'
+    on(BudgetVersions).copy @name
+    on(Confirmation).copy_all_periods
+    on BudgetVersions do |copy|
+      copy.name_of_copy.set new_name
+      copy.save
+      new_version_number=copy.version(new_name)
+    end
+    new_bv = self.clone
+    new_bv.name=new_name
+    new_bv.version=new_version_number
+    new_bv
+  end
+
+  def copy_one_period(new_name, version)
+    # pending resolution of a bug
+  end
+
+  def default_periods
+    open_budget
+    on Parameters do |page|
+      page.parameters unless page.parameters_button.parent.class_name=='tabright tabcurrent'
+      page.default_periods
+    end
+    @budget_periods.clear
+    get_budget_periods
+  end
+
+  def add_subaward_budget(opts={})
+    open_budget
+    on(Parameters).budget_actions
+    sab = make SubawardBudgetObject, opts
+    sab.create
+    @subaward_budgets << sab
+  end
+
+  # =======
+  private
+  # =======
+
+  # This is just a collection of the instance variables
+  # associated with the Parameters page. It's used to determine
+  # whether or not the create method should go to that page
+  # and fill stuff out.
+  def parameters
+    [@total_direct_cost_limit, @on_off_campus, @comments, @modular_budget,
+     @residual_funds, @total_cost_limit, @unrecovered_fa_rate_type, @f_and_a_rate_type,
+     @submit_cost_sharing]
+  end
+
+  def get_budget_periods
+    on Parameters do |page|
+      1.upto(page.period_count) do |number|
+        period = make BudgetPeriodObject, document_id: @document_id,
+                      budget_name: @name, start_date: page.start_date_period(number).value,
+                      end_date: page.end_date_period(number).value,
+                      total_sponsor_cost: page.total_sponsor_cost_period(number).value.groom,
+                      direct_cost: page.direct_cost_period(number).value.groom,
+                      f_and_a_cost: page.fa_cost_period(number).value.groom,
+                      unrecovered_f_and_a: page.unrecovered_fa_period(number).value.groom,
+                      cost_sharing: page.cost_sharing_period(number).value.groom,
+                      cost_limit: page.cost_limit_period(number).value.groom,
+                      direct_cost_limit: page.direct_cost_limit_period(number).value.groom
+        @budget_periods << period
+      end
+    end
+    @budget_periods.number!
+  end
+
+  # Nav Aids...
+
+  def navigate
+    @doc_header ||= @doc_type
+    open_document @doc_header
+    on(Proposal).budget_versions unless on_page?(on(BudgetVersions).name)
+  end
+
+  # Use this if the confirmation dialog may appear
+  # due to missing rates...
+  def confirmation
+    begin
+      on(Confirmation) do |conf|
+        conf.yes if conf.yes_button.present?
+      end
+    rescue
+      # do nothing because the dialog isn't there
+    end
+  end
+
+end # BudgetVersionsObject
+
+class BudgetVersionsCollection < Array
+
+  def budget(name)
+    self.find { |budget| budget.name==name }
+  end
+
+  def copy_all_periods(name, new_name)
+    self << self.budget(name).copy_all_periods(new_name)
+  end
+
+end # BudgetVersionsCollection