kuality-coeus 0.0.1 → 0.0.2

data/lib/kuality-coeus/data_objects/proposal_development/kuali_university_questions.rb

@@ -0,0 +1,58 @@
+class KualiUniversityQuestionsObject
+
+  include Foundry
+  include DataFactory
+  include Navigation
+
+  attr_accessor :document_id, :dual_dept_appointment, :dual_dept_review_date, :dual_dept_explanation,
+                :on_sabbatical, :sabbatical_review_date, :used_by_small_biz, :small_biz_review_date,
+                :understand_deadline, :deadline_review_date
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    # PLEASE NOTE:
+    # This is an unusual data object class in that
+    # it breaks the typical model for radio button
+    # methods and their associated class instance variables
+    #
+    # In general, it's not workable to set up radio button elements
+    # to use "Y" and "N" as the instance variables associated with them.
+    #
+    # These are set up in this way, however, because of how
+    # the HTML elements are being defined.
+    defaults = {
+      dual_dept_appointment: 'N',
+      on_sabbatical:         'N',
+      used_by_small_biz:     'N',
+      understand_deadline:   'Y'
+    }
+
+    set_options(defaults.merge(opts))
+    requires :document_id
+  end
+
+  def create
+    navigate
+    on Questions do |kuali|
+      kuali.show_kuali_university
+      fill_out kuali, :dual_dept_appointment, :dual_dept_review_date,
+               :dual_dept_explanation, :on_sabbatical, :sabbatical_review_date,
+               :used_by_small_biz, :small_biz_review_date, :understand_deadline,
+               :deadline_review_date
+      kuali.save
+    end
+  end
+
+  # =======
+  private
+  # =======
+
+  # Nav Aids...
+
+  def navigate
+    open_document @doc_type
+    on(Proposal).questions unless on_page?(on(Questions).questions_header)
+  end
+
+end

data/lib/kuality-coeus/data_objects/proposal_development/permissions.rb

@@ -0,0 +1,107 @@
+class PermissionsObject
+
+  include Foundry
+  include DataFactory
+  include Navigation
+
+  attr_accessor :document_id, :aggregators, :budget_creators, :narrative_writers,
+                :viewers, :approvers, :delete_proposals
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+        budget_creators:   [], # Arrays should contain usernames
+        narrative_writers: [],
+        viewers:           [],
+        delete_proposals:  [],
+        approvers:         []
+    }
+
+    set_options(defaults.merge(opts))
+    requires :document_id, :aggregators
+  end
+
+  # It's important to realize that this method assigns
+  # users to roles, but does not check who is already
+  # assigned. You need to make sure that the values
+  # used in the instantiation of the class are
+  # an accurate reflection of what exists in the site.
+  def assign
+    navigate
+    on Permissions do |add|
+      # See the roles method defined below...
+      roles.each do |inst_var, role|
+        get(inst_var).each do |username|
+          unless add.user_row(username).present? && add.assigned_role(username).include?(role)
+            add.user_name.set username
+            add.role.select role
+            add.add
+            add.user_row(username).wait_until_present
+          end
+        end
+      end
+      add.save
+      # TODO: Add some logic here to use in case the user is already added to the list (so use add_roles)
+    end
+  end
+
+  # This method is used when the user is already assigned a
+  # role and you need to assign them more roles.
+  def add_roles(username, *roles)
+    # get to the right page...
+    navigate
+    on Permissions do |page|
+      # click the edit role button for the right user...
+      page.edit_role username
+      # This opens a new window, so we have to use it...
+      page.windows.last.use
+    end
+    on Roles do |page|
+      roles.each do |role|
+        # Set the appropriate role checkbox...
+        page.send(snakify(role)).set
+        # Add the username to the correct role
+        # instance variable...
+        get(roles.invert[role]) << username
+      end
+      page.save
+      # Now we're done with the child window so we close it...
+      page.close
+      # Attach to the main window again...
+      page.windows.first.use
+    end
+  end
+
+  def delete username
+    navigate
+    on(Permissions).delete username
+    roles.each do |role|
+      get(role).delete_if { |name| name==username }
+    end
+  end
+
+  # =======
+  private
+  # =======
+
+  # Nav Aids...
+
+  def navigate
+    open_document @doc_type
+    on(Proposal).permissions unless on_page?(on(Permissions).user_name)
+  end
+
+  # Add/Remove roles here, as needed...
+  def roles
+    {
+        :@aggregators=>'Aggregator',
+        :@viewers=>'Viewer',
+        :@budget_creators=>'Budget Creator',
+        :@narrative_writers=>'Narrative Writer',
+        :@approvers=>'approver',
+        :@delete_proposals=>'Delete Proposal'
+    }
+  end
+
+end

data/lib/kuality-coeus/data_objects/proposal_development/personnel_attachments.rb

@@ -0,0 +1,46 @@
+class PersonnelAttachmentObject
+
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include Navigation
+
+  attr_accessor :person, :type, :file_name, :description, :document_id, :doc_type
+
+  def initialize(browser, opts={})
+    @browser = browser
+    defaults = {
+        person:      '::random::',
+        type:        '::random::',
+        description: random_alphanums(30)
+    }
+    set_options defaults.merge(opts)
+    requires :document_id, :file_name
+  end
+
+  def add
+    navigate
+    on AbstractsAndAttachments do |attach|
+      attach.expand_all
+      fill_out attach, :person
+      attach.personnel_attachment_description.fit @description
+      attach.personnel_attachment_type.fit @type
+      attach.personnel_attachment_file_name.set($file_folder+@file_name)
+      attach.add_personnel_attachment
+    end
+  end
+
+  private
+
+  def navigate
+    open_document @doc_type
+    on(Proposal).abstracts_and_attachments unless on_page?(on(AbstractsAndAttachments).proposal_attachment_type)
+  end
+
+end
+
+class PersonnelAttachmentsCollection < Array
+
+
+
+end

data/lib/kuality-coeus/data_objects/proposal_development/proposal_attachments.rb

@@ -0,0 +1,41 @@
+class ProposalAttachmentObject
+
+  include Foundry
+  include DataFactory
+  include Navigation
+
+  attr_accessor :type, :file_name, :status, :description, :document_id, :doc_type
+
+  def initialize(browser, opts={})
+    @browser = browser
+    set_options opts
+    requires :document_id, :type, :file_name
+  end
+
+  def add
+    navigate
+    on AbstractsAndAttachments do |attach|
+      attach.expand_all
+      attach.proposal_attachment_type.select @type
+      attach.proposal_attachment_description.fit @description
+      attach.proposal_attachment_file_name.set($file_folder+@file_name)
+      attach.attachment_status.fit @status
+      attach.add_proposal_attachment
+      raise "Unexpected attachment error" if attach.errors.size > 0
+    end
+  end
+
+  private
+
+  def navigate
+    open_document @doc_type
+    on(Proposal).abstracts_and_attachments unless on_page?(on(AbstractsAndAttachments).proposal_attachment_type)
+  end
+
+end
+
+class ProposalAttachmentsCollection < Array
+
+
+
+end

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

@@ -0,0 +1,301 @@
+class ProposalDevelopmentObject
+
+  include Foundry
+  include DataFactory
+  include StringFactory
+  include DateFactory
+  include Navigation
+  
+  attr_accessor :proposal_type, :lead_unit, :activity_type, :project_title, :proposal_number,
+                :sponsor_code, :sponsor_type_code, :project_start_date, :project_end_date, :document_id,
+                :status, :initiator, :created, :sponsor_deadline_date, :key_personnel,
+                :opportunity_id, # Maybe add competition_id and other stuff here...
+                :special_review, :budget_versions, :permissions, :s2s_questionnaire, :proposal_attachments,
+                :proposal_questions, :compliance_questions, :kuali_u_questions, :custom_data, :recall_reason,
+                :personnel_attachments, :mail_by, :mail_type
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      proposal_type:         'New',
+      lead_unit:             '::random::',
+      activity_type:         '::random::',
+      project_title:         random_alphanums,
+      sponsor_code:          '::random::',
+      sponsor_type_code:     '::random::',
+      project_start_date:    next_week[:date_w_slashes], # TODO: Think about using the date object here, and not the string
+      project_end_date:      next_year[:date_w_slashes],
+      sponsor_deadline_date: next_week[:date_w_slashes],
+      mail_by:               '::random::',
+      mail_type:             '::random::',
+      key_personnel:         KeyPersonnelCollection.new,
+      special_review:        SpecialReviewCollection.new,
+      budget_versions:       BudgetVersionsCollection.new,
+      personnel_attachments: PersonnelAttachmentsCollection.new,
+      proposal_attachments:  ProposalAttachmentsCollection.new
+    }
+
+    set_options(defaults.merge(opts))
+  end
+    
+  def create
+    on BasePage do |page|
+      if page.windows.size > 1 && page.portal_window.exists?
+        page.return_to_portal
+        page.close_children
+      elsif page.windows.size > 1
+        page.use_new_tab
+        page.close_parents
+      end
+    end
+    visit(Researcher).create_proposal
+    on Proposal do |doc|
+      @doc_header=doc.doc_title
+      @document_id=doc.document_id
+      @status=doc.document_status
+      @initiator=doc.initiator
+      @created=doc.created
+      doc.expand_all
+      fill_out doc, :proposal_type, :activity_type,
+                    :project_title, :project_start_date, :project_end_date,
+                    :sponsor_deadline_date, :mail_by, :mail_type#, :description
+      set_sponsor_code
+      set_lead_unit
+      doc.save
+      @proposal_number=doc.proposal_number
+      @permissions = make PermissionsObject, document_id: @document_id, aggregators: [@initiator]
+    end
+  end
+
+  def edit opts={}
+    open_proposal
+    on Proposal do |edit|
+      edit.proposal
+      edit.expand_all
+      edit.project_start_date.fit opts[:project_start_date]
+      edit.opportunity_id.fit opts[:opportunity_id]
+      edit.proposal_type.fit opts[:proposal_type]
+      # TODO: Add more stuff here as necessary
+      edit.save
+    end
+    update_options(opts)
+  end
+
+  def add_key_person opts={}
+    @key_personnel << prep(KeyPersonObject, opts)
+  end
+  # This alias is recommended only for when
+  # using this method with no options.
+  alias_method :add_principal_investigator, :add_key_person
+
+
+  # This method simply sets all the credit splits to
+  # equal values based on how many persons and units
+  # are attached to the Proposal. If more complicated
+  # credit splits are needed, these will have to be
+  # coded in the step def, accessing the key person
+  # objects directly.
+  def set_valid_credit_splits
+    # calculate a "person" split value that will work
+    # based on the number of people attached...
+    split = (100.0/@key_personnel.with_units.size).round(2)
+
+    # Now make a hash to use for editing the person's splits...
+    splits = {responsibility: split, financial: split, recognition: split, space: split}
+
+    # Now we update the KeyPersonObjects' instance variables
+    # for their own splits as well as for their units
+    @key_personnel.with_units.each do |person|
+      person.edit splits
+      units_split = (100.0/person.units.size).round(2)
+      # Make a temp container for the units we're updating...
+      units = []
+      person.units.each { |unit| units << {:number=>unit[:number]} }
+      # Iterate through the units, updating their credit splits with the
+      # valid split amount...
+      units.each do |unit|
+        [:responsibility, :financial, :recognition, :space].each { |item| unit[item]=units_split }
+      end
+      person.update_unit_credit_splits units
+    end
+  end
+
+  def add_special_review opts={}
+    @special_review << prep(SpecialReviewObject, opts)
+  end
+
+  def add_budget_version opts={}
+    opts[:version] ||= (@budget_versions.size+1).to_s
+    @budget_versions << prep(BudgetVersionsObject, opts)
+  end
+
+  def add_custom_data opts={}
+    @custom_data = prep(CustomDataObject, opts)
+  end
+
+  def add_proposal_attachment opts={}
+    merge_settings(opts)
+    p_a = make ProposalAttachmentObject, opts
+    p_a.add
+    @proposal_attachments << p_a
+  end
+
+  def add_personnel_attachment opts={}
+    merge_settings(opts)
+    p_a = make PersonnelAttachmentObject, opts
+    p_a.add
+    @personnel_attachments << p_a
+  end
+
+  def complete_s2s_questionnaire opts={}
+    @s2s_questionnaire = prep(S2SQuestionnaireObject, opts)
+  end
+
+  def complete_phs_fellowship_questionnaire opts={}
+    @phs_fellowship_questionnaire = prep(PHSFellowshipQuestionnaireObject, opts)
+  end
+
+  def complete_phs_training_questionnaire opts={}
+    @phs_training_questionnaire = prep(PHSTrainingQuestionnaireObject, opts)
+  end
+
+  def make_institutional_proposal
+    # TODO: Write any preparatory web site functional steps and page scraping code
+    ip = make InstitutionalProposalObject, dev_proposal_number: @proposal_number,
+         proposal_type: @proposal_type,
+         activity_type: @activity_type,
+         project_title: @project_title,
+         project_personnel: Marshal::load(Marshal.dump(@key_personnel)),
+         special_review: Marshal::load(Marshal.dump(@special_review)),
+         custom_data: Marshal::load(Marshal.dump(@custom_data))
+         # TODO: Add more here as needed...
+  end
+
+  def delete
+    proposal_actions
+    on(ProposalActions).delete_proposal
+    on(Confirmation).yes
+    # Have to update the data object's status value
+    # in a valid way (getting it from the system)
+    visit DocumentSearch do |search|
+      search.document_id.set @document_id
+      search.search
+      @status=search.doc_status @document_id
+    end
+  end
+
+  def recall(type, reason=random_alphanums)
+    types={:revision=>:recall_to_action_list, :cancel=>:recall_and_cancel}
+    @recall_reason=reason
+    open_proposal
+    on(Proposal).recall
+    on Confirmation do |conf|
+      conf.reason.set @recall_reason
+      conf.send(types[type])
+    end
+  end
+
+  def close
+    open_proposal
+    on(Proposal).close
+  end
+
+  def view(tab)
+    open_proposal
+    unless @status=='CANCELED' || on(Proposal).send((tab.to_s+'_button').to_sym).parent.class_name=~/tabcurrent$/
+      on(Proposal).send(tab)
+    end
+  end
+
+  def submit(type=:s)
+    types={:s=>:submit, :ba=>:blanket_approve,
+           :to_sponsor=>:submit_to_sponsor, :to_s2s=>:submit_to_s2s}
+    proposal_actions
+    on(ProposalActions).send(types[type])
+    if type==:to_sponsor
+      on NotificationEditor do |page|
+        # A breaking of the design pattern, here,
+        # but we have no alternative...
+        @status=page.document_status
+        page.send_fyi
+      end
+    elsif type == :to_s2s
+      on S2S do |page|
+        @status=page.document_status
+      end
+    else
+      on ProposalActions do |page|
+        page.data_validation_header.wait_until_present
+        @status=page.document_status
+      end
+    end
+  end
+
+  # Note: This method does not navigate because
+  # the assumption is that the only time you need
+  # to save the proposal is when you are on the
+  # proposal. You will never need to open the
+  # proposal and then immediately save it.
+  def save
+    on(Proposal).save
+  end
+
+  def open_proposal
+    open_document @doc_header
+  end
+
+  def blanket_approve
+    submit :ba
+  end
+
+  # =======
+  private
+  # =======
+
+  def merge_settings(opts)
+    defaults = {
+        document_id: @document_id,
+        doc_type: @doc_header
+    }
+    opts.merge!(defaults)
+  end
+
+  def set_sponsor_code
+    if @sponsor_code=='::random::'
+      on(Proposal).find_sponsor_code
+      on SponsorLookup do |look|
+        look.sponsor_type_code.pick! @sponsor_type_code
+        look.search
+        look.page_links[rand(look.page_links.length)].click if look.page_links.size > 0
+        look.return_random
+      end
+      @sponsor_code=on(Proposal).sponsor_code.value
+    else
+      on(Proposal).sponsor_code.fit @sponsor_code
+    end
+  end
+
+  def set_lead_unit
+    on(Proposal)do |prop|
+      if prop.lead_unit.present?
+        prop.lead_unit.pick! @lead_unit
+      else
+        @lead_unit=prop.lead_unit_ro
+      end
+    end
+  end
+
+  def proposal_actions
+    open_proposal
+    on(Proposal).proposal_actions
+  end
+
+  def prep(object_class, opts)
+    merge_settings(opts)
+    object = make object_class, opts
+    object.create
+    object
+  end
+
+end