virgild/resumetools

# coding: utf-8

#--
# Copyright (c) 2009 Virgil Dimaguila
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#++

module ResumeTools

  # = Resume
  # Represents a single resume document
  class Resume

    # The full name of the subject of this resume
    attr_accessor :full_name

    # The subject's URL
    attr_accessor :url

    # The subject's e-mail address
    attr_accessor :email

    # The subject's telephone number
    attr_accessor :telephone

    # First line of the address
    attr_accessor :address1

    # Second line of the address
    attr_accessor :address2

    # The resume's sections
    attr_reader :sections

    # Creates a +Resume+ and passes it to the given block. Returns the created +Resume+.
    def self.build(opts={}, &block)
      resume = self.new(opts)
      block.call(resume)
      resume
    end

    # Creates a new +Resume+ with the given properties
    def initialize(props={})
      @full_name = props[:full_name] || ""
      @url = props[:url] || ""
      @email = props[:email] || ""
      @telephone = props[:telephone] || ""
      @address1 = props[:address1] || ""
      @address2 = props[:address2] || ""
      @sections = Array.new
    end

    # Add section
    def add_section(section)
      self.sections << section
      self
    end

    # Create new section and add to sections
    def create_section(props={}, &block)
      section = Section.new(props)
      block.call(section) if block
      self.add_section(section)
      self
    end

    #
    def has_url?
      !self.url.blank?
    end

    #
    def has_email?
      !self.email.blank?
    end

    #
    def has_telephone?
      !self.telephone.blank?
    end

    #
    def has_address1?
      !self.address1.blank?
    end

    #
    def has_address2?
      !self.address2.blank?
    end

    #
    def has_sections?
      !self.sections.empty?
    end

    # Returns an array of lines that has the contact info
    def header_lines
      elements = []
      [:address1, :address2, :telephone, :email].each do |element|
        elements << self.send(element) unless self.send(element).blank?
      end
      lines = []
      elements.each_slice(2) { |pair| lines << pair.join(" • ") }
      lines << self.url unless self.url.blank?
      lines
    end

  end #class Resume


  # = Section
  # Represents a section in the resume
  class Section
    # Section title
    attr_accessor :title

    # Section paragraph
    attr_accessor :para

    # List of periods
    attr_reader :periods

    # List of items
    attr_reader :items

    #
    def initialize(props={})
      @title = props[:title] || ""
      @para = props[:para] || ""
      @items = Array.new
      @periods = Array.new
    end

    #
    def has_paragraph?
      !self.para.blank?
    end

    def has_para?
      self.has_paragraph?
    end

    #
    def has_items?
      !self.items.empty?
    end

    #
    def has_periods?
      !self.periods.empty?
    end

    #
    def has_title?
      !self.title.blank?

    end

    # Creates a period and adds it to the list
    def create_period(props={}, &block)
      period = Period.new(props)
      block.call(period) if block
      self.add_period(period)
      self
    end

    # Adds a period
    def add_period(period)
      self.periods << period
    end

    # Ads an item
    def add_item(item)
      self.items << item
    end

    # Creates an item and adds it to the list
    def create_item(props={}, &block)
      item = Item.new(props)
      block.call(item) if block
      self.add_item(item)
      self
    end
  end


  # = Period
  # Represents a period in the section
  class Period
    # Period title
    attr_accessor :title

    # Period location
    attr_accessor :location

    # Period organization
    attr_accessor :organization

    # Period start date
    attr_accessor :dtstart

    # Period end date
    attr_accessor :dtend

    # List of items
    attr_reader :items

    #
    def initialize(props={})
      @title = props[:title] || ""
      @location = props[:location] || ""
      @organization = props[:organization] || ""
      @dtstart = props[:dtstart] || nil
      @dtend = props[:dtend] || nil
      @items = Array.new
    end

    #
    def has_title?
      !self.title.blank?
    end

    def has_location?
      !self.location.blank?
    end

    def has_organization?
      !self.organization.blank?
    end

    def has_dtstart?
      !self.dtstart.blank?
    end

    def has_dtend?
      !self.dtend.blank?
    end

    def has_items?
      !self.items.empty?
    end

    # Adds an item
    def add_item(item)
      self.items << item
    end

    # Creates an item and adds it to the list
    def create_item(props={}, &block)
      item = Item.new(props)
      block.call(item) if block
      self.add_item(item)
      item
    end

    # The period details in a single line
    def line
      elements = []
      elements << self.organization if self.has_organization?
      elements << self.location if self.has_location?
      if self.has_dtstart? && self.has_dtend?
        date = " (#{self.dtstart} - #{self.dtend})"
      elsif self.has_dtstart? || self.has_dtend?
        value = self.has_dtstart? ? self.dtstart : self.dtend
        date = " (#{value})"
      else
        date = ''
      end
      elements.join(", ").concat("#{date}")
    end
  end


  # = Item
  # Represents an item in a period or section. Items are usually
  # bulleted items that are listed in order
  class Item
    # The item text
    attr_accessor :text

    #
    def initialize(props={})
      @text = props[:text] || ""
    end
  end

end