virgild-resumetools 0.2.0

data/lib/resume/resume.rb

@@ -0,0 +1,231 @@
+#--
+# 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 title of the resume
+    attr_accessor :title
+    
+    # The name (or label) for this resume
+    attr_accessor :name
+    
+    # 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(&block)
+      resume = self.new
+      yield resume
+      resume
+    end
+    
+    # Creates a new +Resume+ with the given properties
+    def initialize(props={})
+      @title = props[:title] || ""
+      @name = props[:name] || "Unnamed Resume"
+      @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)
+      yield section if block_given?
+      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
+    
+  end
+  
+  
+  # = 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
+
+    # Creates a period and adds it to the list
+    def create_period(props={}, &block)
+      period = Period.new(props)
+      yield period if block_given?
+      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)
+      yield item if block_given?
+      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
+    
+    # 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)
+      yield item if block_given?
+      self.add_item(item)
+      item
+    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

data/lib/resume/text_reader.rb

@@ -0,0 +1,107 @@
+#--
+# 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
+  module TextReader
+    class ParseException < Exception
+    end
+    
+    module ClassMethods
+      require 'treetop'
+      
+      Treetop.load File.join(File.dirname(__FILE__), '..', 'grammars', 'resume.treetop')
+      
+      # Builds a new Resume instance from text
+      def from_text(text)
+        parser = ::ResumeParser.new
+        result = parser.parse(text)
+        
+        if result.nil?
+          raise ParseException.new(parser.failure_reason)
+        end
+        
+        resume = ResumeTools::Resume.new
+        current_section = nil
+        current_period = nil
+        
+        result.elements.each do |element|
+          case element.data_type
+          when :item
+            item = ::ResumeTools::Item.new(:text => element.value)
+            if current_period
+              current_period.add_item(item)
+            elsif current_section
+              current_section.add_item(item)
+            end
+          when :period
+            current_period = ::ResumeTools::Period.new(:title => element.value)
+            current_section.add_period(current_period) if current_section
+          when :section
+            current_period = nil # Reset period
+            current_section = ::ResumeTools::Section.new(:title => element.value)
+            resume.add_section(current_section)
+          when :period_location
+            current_period.location = element.value if current_period
+          when :period_organization
+            current_period.organization = element.value if current_period
+          when :period_dates
+            if current_period
+              dates = element.value.split("to", 2).map { |d| d.strip }
+              if dates.length == 1
+                current_period.dtend = dates[0]
+                current_period.dtstart = nil
+              elsif dates.length == 2
+                current_period.dtstart = dates[0]
+                current_period.dtend = dates[1]
+              end
+            end
+          when :paragraph
+            current_section.para = element.value if current_section
+          when :contact_name
+            resume.full_name = element.value
+          when :contact_telephone
+            resume.telephone = element.value
+          when :contact_email
+            resume.email = element.value
+          when :contact_address
+            if resume.address1.blank?
+              resume.address1 = element.value
+            elsif resume.address2.blank?
+              resume.address2 = element.value
+            end
+          when :contact_url
+            resume.url = element.value
+          end
+        end
+        
+        resume
+      end
+    end
+  end
+  
+  class << Resume
+    include TextReader::ClassMethods
+  end
+end

data/lib/resumetools/version.rb

@@ -0,0 +1,35 @@
+#--
+# Resume Tools, 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.
+#++
+
+unless defined? ResumeTools::VERSION
+  module ResumeTools
+    module VERSION
+      MAJOR = 0
+      MINOR = 2
+      TINY  = 0
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/lib/resumetools.rb

@@ -0,0 +1,34 @@
+#--
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__))
+
+require "extlib"
+require "uuidtools"
+
+require "resumetools/version"
+require "resume/resume"
+require "resume/text_reader"
+require "resume/pdf"

data/spec/grammar_spec.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+require "treetop"
+
+Treetop.load File.join(File.dirname(__FILE__), "../lib/grammars/resume.treetop")
+
+describe "Resume Grammar" do
+  before(:all) do
+    resume_file = "sample.resume"
+    @parser = ResumeParser.new
+    @resume_txt = File.read(File.join(File.dirname(__FILE__), "../examples/#{resume_file}"))
+  end
+  
+  it "should have a parser" do
+    @parser.should be_instance_of(ResumeParser)
+  end
+  
+  describe "after parsing sample file" do
+    def elements_with_type(type)
+      @elements.reject { |e| e.data_type != type }
+    end
+    
+    before(:all) do
+      @result = @parser.parse(@resume_txt)
+      @elements = @result.elements
+    end
+    
+    it "should parse our file" do
+      @result.should_not be_nil
+    end
+        
+    it "should have 33 items" do
+      elements_with_type(:item).length.should == 33
+    end
+    
+    it "should have 2 paragraphs" do
+      elements_with_type(:paragraph).length.should == 2
+    end
+    
+    it "should have 7 sections" do
+      elements_with_type(:section).length.should == 7
+    end
+    
+    it "should have contact name" do
+      elements_with_type(:contact_name).length.should == 1
+      elements_with_type(:contact_name)[0].value.should == "Thomas B. Seeker"
+    end
+    
+    it "should have contact telephone" do
+      elements_with_type(:contact_telephone).length.should == 1
+      elements_with_type(:contact_telephone)[0].value.should == "(410) 555-1212"
+    end
+    
+    it "should have contact addresses" do
+      elements_with_type(:contact_address).length.should == 2
+      elements_with_type(:contact_address)[0].value.should == "1234 Northern Star Circle"
+      elements_with_type(:contact_address)[1].value.should == "Baltimore, MD 12345"
+    end
+    
+    it "should have contact e-mail" do
+      elements_with_type(:contact_email).length.should == 1
+      elements_with_type(:contact_email)[0].value.should == "seeker@nettcom.com"
+    end
+    
+    it "should have contact URL" do
+      elements_with_type(:contact_url).length.should == 1
+      elements_with_type(:contact_url)[0].value.should == "http://nettcom.com/tseeker"
+    end
+    
+    it "should have 5 periods" do
+      elements_with_type(:period).length.should == 5
+    end
+    
+    it "should have 5 period organizations" do
+      elements_with_type(:period_organization).length.should == 5
+      elements_with_type(:period_organization).map { |o| o.value }.should == [
+        "Computer Engineering Corporation",
+        "Business Consultants, Inc.",
+        "US Army Infantry",
+        "Air Force Institute of Technology (AFIT)",
+        "University of California, Los Angeles (UCLA)"
+      ]
+    end
+    
+    it "should have 3 period locations" do
+      elements_with_type(:period_location).length.should == 3
+    end
+    
+    it "should have 3 period dates" do
+      elements_with_type(:period_dates).length.should == 3
+    end
+  end
+  
+end

data/spec/read_resume_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe "Creating a resume from a text" do
+  before do
+    sample = File.join(File.dirname(__FILE__), '..', 'examples', 'sample.resume')
+    text = File.read(sample)
+    @resume = ResumeTools::Resume.from_text(text)
+  end
+  
+  it "should create a resume" do
+    @resume.should be_instance_of(ResumeTools::Resume)
+  end
+  
+  it "should have the correct contact info" do
+    @resume.full_name.should == "Thomas B. Seeker"
+    @resume.address1.should == "1234 Northern Star Circle"
+    @resume.address2.should == "Baltimore, MD 12345"
+    @resume.telephone.should == "(410) 555-1212"
+  end
+  
+  it "should have 7 sections" do
+    @resume.should have(7).sections
+  end
+  
+  it "should have sections in order" do
+    @resume.sections.map { |s| s.title }.should == [
+      "Career Goal",
+      "Qualifications Summary", 
+      "Technical Skills", 
+      "Professional Experience", 
+      "Education", 
+      "Specialized Training", 
+      "Certification, Honors, and Professional Affiliations"
+    ]
+  end
+  
+  it "should have a paragraph in the Career Goal section" do
+    @resume.sections[0].para.should_not be_blank
+  end
+  
+  it "should have a paragraph in the Qualifications Summary section" do
+    @resume.sections[1].para.should_not be_blank
+  end
+  
+  it "should have 4 items in the Technical Skills section" do
+    @resume.sections[2].should have(4).items
+  end
+  
+  it "should have 3 periods in the Professional Experience section" do
+    @resume.sections[3].should have(3).periods
+  end
+  
+  it "should have 4 items in the Systems Engineer period" do
+    @resume.sections[3].periods[0].should have(4).items
+  end
+  
+  it "should have proper dates" do
+    @resume.sections[3].periods[0].dtstart.should == "1993"
+    @resume.sections[3].periods[0].dtend.should == "Present"
+  end
+end

data/spec/rendering_pdf_spec.rb

@@ -0,0 +1,37 @@
+#--
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe "Rendering a Resume to PDF" do
+  before do
+    @resume = ResumeTools::Resume.new
+  end
+  
+  it "should render to PDF" do
+    result = @resume.render_pdf
+    result.should_not be_nil
+  end
+end