salesforce_certification_calculator 0.1.0

data/data/MarketingCloudEmailSpecialist-Spring2022.xml

@@ -0,0 +1,30 @@
+<exam>
+    <title>Marketing Cloud Email Specialist - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Email Marketing Best Practices</name>
+            <weight>10</weight>
+        </section>
+        
+        <section>
+            <name>Content Creation and Delivery</name>
+            <weight>24</weight>
+        </section>
+        
+        <section>
+            <name>Marketing Automation</name>
+            <weight>26</weight>
+        </section>
+        
+        <section>
+            <name>Subscriber and Data Management</name>
+            <weight>26</weight>
+        </section>
+        
+        <section>
+            <name>Insights and Analytics</name>
+            <weight>14</weight>
+        </section>
+    </sections>
+</exam>

data/data/PlatformAppBuilder-Spring2022.xml

@@ -0,0 +1,30 @@
+<exam>
+    <title>Platform App Builder - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Salesforce Fundamentals</name>
+            <weight>23</weight>
+        </section>
+        
+        <section>
+            <name>Data Modeling and Management</name>
+            <weight>22</weight>
+        </section>
+        
+        <section>
+            <name>Business Logic and Process Automation</name>
+            <weight>28</weight>
+        </section>
+        
+        <section>
+            <name>User Interface</name>
+            <weight>17</weight>
+        </section>
+        
+        <section>
+            <name>App Deployment</name>
+            <weight>10</weight>
+        </section>
+    </sections>
+</exam>

data/data/PlatformDeveloperI-Spring2022.xml

@@ -0,0 +1,25 @@
+<exam>
+    <title>Platform Developer I - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Developer Fundamentals</name>
+            <weight>23</weight>
+        </section>
+        
+        <section>
+            <name>Process Automation and Logic</name>
+            <weight>30</weight>
+        </section>
+        
+        <section>
+            <name>User Interface</name>
+            <weight>25</weight>
+        </section>
+        
+        <section>
+            <name>Testing, Debugging, and Deployment</name>
+            <weight>22</weight>
+        </section>
+    </sections>
+</exam>

data/data/PlatformDeveloperII-Spring2022.xml

@@ -0,0 +1,30 @@
+<exam>
+    <title>Platform Developer II - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Advanced Developer Fundamentals</name>
+            <weight>18</weight>
+        </section>
+        
+        <section>
+            <name>Process Automation, Logic, and Integration</name>
+            <weight>24</weight>
+        </section>
+        
+        <section>
+            <name>User Interface</name>
+            <weight>20</weight>
+        </section>
+        
+        <section>
+            <name>Testing, Debugging, and Deployment</name>
+            <weight>20</weight>
+        </section>
+        
+        <section>
+            <name>Performance</name>
+            <weight>18</weight>
+        </section>
+    </sections>
+</exam>

data/data/SalesCloudConsultant-Spring2022.xml

@@ -0,0 +1,55 @@
+<exam>
+    <title>Sales Cloud Consultant - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Sales Practices</name>
+            <weight>11</weight>
+        </section>
+        
+        <section>
+            <name>Implementation Strategies</name>
+            <weight>13</weight>
+        </section>
+        
+        <section>
+            <name>Application of Product Knowledge</name>
+            <weight>18</weight>
+        </section>
+        
+        <section>
+            <name>Lead Management</name>
+            <weight>7</weight>
+        </section>
+        
+        <section>
+            <name>Account and Contact Management</name>
+            <weight>11</weight>
+        </section>
+        
+        <section>
+            <name>Opportunity Management</name>
+            <weight>10</weight>
+        </section>
+        
+        <section>
+            <name>Sales Productivity and Integration</name>
+            <weight>8</weight>
+        </section>
+        
+        <section>
+            <name>Consulting Practices</name>
+            <weight>7</weight>
+        </section>
+        
+        <section>
+            <name>Sales Metrics, Reports, and Dashboards</name>
+            <weight>7</weight>
+        </section>
+        
+        <section>
+            <name>Data Management</name>
+            <weight>8</weight>
+        </section>
+    </sections>
+</exam>

data/data/ServiceCloudConsultant-Spring2022.xml

@@ -0,0 +1,50 @@
+<exam>
+    <title>Service Cloud Consultant - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Industry Knowledge</name>
+            <weight>10</weight>
+        </section>
+        
+        <section>
+            <name>Implementation Strategies</name>
+            <weight>15</weight>
+        </section>
+        
+        <section>
+            <name>Service Cloud Solution Design</name>
+            <weight>16</weight>
+        </section>
+        
+        <section>
+            <name>Knowledge Management</name>
+            <weight>9</weight>
+        </section>
+        
+        <section>
+            <name>Interaction Channels</name>
+            <weight>10</weight>
+        </section>
+        
+        <section>
+            <name>Case Management</name>
+            <weight>15</weight>
+        </section>
+        
+        <section>
+            <name>Contact Center Analytics</name>
+            <weight>5</weight>
+        </section>
+        
+        <section>
+            <name>Integration and Data Management</name>
+            <weight>5</weight>
+        </section>
+        
+        <section>
+            <name>Service Console</name>
+            <weight>15</weight>
+        </section>
+    </sections>
+</exam>

data/data/SharingAndVisibilityArchitect-Spring2022.xml

@@ -0,0 +1,20 @@
+<exam>
+    <title>Sharing and Visibility Architect - Spring 2022</title>
+
+    <sections>
+        <section>
+            <name>Declarative Sharing</name>
+            <weight>76</weight>
+        </section>
+        
+        <section>
+            <name>Performance and Scalability</name>
+            <weight>7</weight>
+        </section>
+        
+        <section>
+            <name>Programmatic Sharing</name>
+            <weight>17</weight>
+        </section>
+    </sections>
+</exam>

data/lib/salesforce_certification_calculator/exam.rb

@@ -0,0 +1,63 @@
+class SalesforceCertificationCalculator::Exam
+    SFC = SalesforceCertificationCalculator
+
+    # @!attribute title
+    #   @return [String] name of the exam
+    # 
+    # @!attribute file
+    #   @return [String] path to file containing exam data
+    # 
+    # @!attribute [r] sections
+    #   @return [Array] collection of Section objects for all sections of the exam
+    # 
+    # @!attribute [r] total
+    #   @return [Number] cumulative score for the entire exam; if sections' weights do not sum to 100, it will return an error message as a string
+    attr_accessor :title, :file
+    attr_reader :sections, :total
+
+    # Creates Exam object
+    # 
+    # @example Create Exam Object
+    #   >> my_exam = Exam.new
+    def initialize
+        @title = ""
+        @file = ""
+        @sections = []
+        @total = 0
+    end
+
+    # Adds a new Section object to the exam's array of sections
+    # 
+    # @example Add New Section
+    #   >> my_exam = Exam.new
+    #   >> my_exam.add_section('Database', 24)
+    # 
+    # @param name [String] title of the section
+    # @param weight [Number] percentage weight of the section, expressed as an integer
+    # @param score [Number] individual's percentage score on that section of the exam, expressed as an integer; uses 0 as default value
+    def add_section(name, weight, score = 0)
+        section = SFC::Section.new(name, weight, score)
+        @sections.push(section)
+    end
+
+    # Determines cumulative score for the exam based on its sections' weights and scores
+    # 
+    # @example Calculate Total
+    #   >> my_exam = Exam.new
+    #   >> my_exam.calculate_total
+    def calculate_total
+        summed_weights = 0
+
+        @sections.each do |section|
+            summed_weights += section.weight
+            @total += section.weight * section.score / 100.0
+        end
+
+        # Sets total to error message when sum of sections' weights is not 100
+        if summed_weights != 100
+            @total = "CANNOT CALCULATE"
+        end
+    end
+end
+
+require "salesforce_certification_calculator/section"

data/lib/salesforce_certification_calculator/file_reader.rb

@@ -0,0 +1,53 @@
+class SalesforceCertificationCalculator::FileReader
+    SFC = SalesforceCertificationCalculator
+
+    # Gets list of all exams in the database, including their names and file paths
+    # 
+    # @example Retrieve Exams
+    #   >> reader = FileReader.new
+    #   >> exams = reader.generate_exams_list
+    #   => [<SalesforceCertificationCalculator::Exam 0x000987>, <SalesforceCertificationCalculator::Exam 0x000988>]
+    # 
+    # @return [Array] collection of Exam objects
+    def generate_exams_list
+        exams = []
+        files = Dir.glob("data/*xml")
+
+        files.each do |file|
+            exam = SFC::Exam.new
+            doc = File.open(file) { |f| Nokogiri::XML(f) }
+            title = doc.at_xpath("//title")
+            exam.title = title.content
+            exam.file = file
+            exams.push(exam)
+        end
+
+        return exams
+    end
+
+    # Gets all details about an exam's sections, including names and weights
+    # 
+    # @example Retrieve Exam Data
+    #   >> reader = FileReader.new
+    #   >> exams = FileReader.generate_exams_list
+    #   >> exam = reader.extract_exam_data(exams[0])
+    #   => <SalesforceCertificationCalculator::Exam 0x000987>
+    # 
+    # @param exam [Exam] object, containing name and file properties, to use to get full data
+    # 
+    # @return [Exam] object with not only name and file, but also all sections, with their names and weights
+    def extract_initial_exam_data(exam)
+        doc = File.open(exam.file) { |f| Nokogiri::XML(f) }
+        names = doc.xpath("//name")
+        weights = doc.xpath("//weight")
+
+        (0..names.length-1).each do |i|
+            exam.add_section(names[i].content, weights[i].content.to_i)
+        end
+
+        return exam
+    end
+end
+
+require "nokogiri"
+require "salesforce_certification_calculator/exam"

data/lib/salesforce_certification_calculator/section.rb

@@ -0,0 +1,25 @@
+class SalesforceCertificationCalculator::Section
+    # @!attribute name
+    #   @return [String] name of the section
+    # 
+    # @!attribute weight
+    #   @return [Number] percentage indicating how much the section is worth to the total score, represented as an integer
+    # 
+    # @!attribute score
+    #   @return [Number] individual's score on the specific section, represented as an integer
+    attr_accessor :name, :weight, :score
+
+    # Creates Section object
+    # 
+    # @example Create Section Object
+    #   >> my_section = Section.new('Database', 24, 85)
+    # 
+    # @param name [String] name of the section
+    # @param weight [Number] percentage indicating how much the section is worth to the total score, represented as an integer
+    # @param score [Number] individual's score on the specific section, represented as an integer
+    def initialize(name, weight, score)
+        @name = name
+        @weight = weight
+        @score = score
+    end
+end

data/lib/salesforce_certification_calculator/u_i.rb

@@ -0,0 +1,107 @@
+class SalesforceCertificationCalculator::UI
+    SFC = SalesforceCertificationCalculator
+
+    # Allows user to select between viewing a list of all existing exams or inputting all data manually
+    # 
+    # @example Make Choice
+    #   >> ui = UI.new
+    #   >> choice = ui.select_list_or_new
+    #   => 'LIST'
+    # 
+    # @return [String] 'LIST' to indicate user wants to see a list of all existing exams; 'NEW' to indicate user wants to input all data manually
+    def select_list_or_new
+        puts "Do you want to select an exam from a list (enter LIST), or do you want to type in your own details (enter NEW)?"
+        choice = gets.chomp
+
+        if choice == "LIST" || choice == "NEW"
+            return choice
+        else
+            select_list_or_new()
+        end
+    end
+
+    # Allows user to select which exam from the list of existing exams to use
+    # 
+    # @example Select a Specific Exam
+    #   >> ui = UI.new
+    #   >> reader = FileReader.new
+    #   >> exams = reader.generate_exams_list
+    #   >> exam = ui.select_specific_exam(exams)
+    #   => <SalesforceCertificationCalculator::Exam 0x000987>
+    # 
+    # @param exams [Array] collection of Exam objects to use for selection
+    # 
+    # @return [Exam] object with name, file, and section details for selected exam
+    def select_specific_exam(exams)
+        puts "Your choices are:"
+
+        exams.each do |exam|
+            puts "#{exams.find_index(exam) + 1} - #{exam.title}"
+        end
+
+        puts "Which one would you like to select? Enter the number before the exam name:"
+        choice = gets.chomp.to_i
+
+        if choice.between?(1, exams.length)
+            return exams[choice - 1]
+        else
+            select_specific_exam(exams)
+        end
+    end
+
+    # Allows user to input their scores for each section
+    # 
+    # @example Enter Scores
+    #   >> ui = UI.new
+    #   >> reader = FileReader.new
+    #   >> exams = reader.generate_exams_list
+    #   >> exam = ui.select_specific_exam(exams)
+    #   >> updated_exam = ui.provide_scores(exam)
+    #   => <SalesforceCertificationCalculator::Exam 0x000987>
+    # 
+    # @param exam [Exam] object with name, file, and section details
+    # 
+    # @return [Exam] object with name, file, and section details, updated with the individual scores for each section
+    def provide_scores(exam)
+        sections = exam.sections
+
+        sections.each do |section|
+            puts "#{section.name} is worth #{section.weight}%"
+            puts "What score did you get on that section? (enter an integer)"
+            score = gets.chomp.to_i
+            section.score = score
+        end
+
+        return exam
+    end
+
+    # Allows user to provide all exam data manually
+    # 
+    # @example Input Information
+    #   >> ui = UI.new
+    #   >> exam = ui.provide_all_details_manually
+    #   => <SalesforceCertificationCalculator::Exam 0x000987>
+    # 
+    # @return [Exam] object with name, file, and section details, including scores for each section
+    def provide_all_details_manually
+        exam = SFC::Exam.new
+        puts "What is the title of this exam?"
+        exam.title = gets.chomp
+        puts "How many sections does it have?"
+        length = gets.chomp.to_i
+
+        (1..length).each do |i|
+            puts "What is the name of Section #{i}?"
+            name = gets.chomp
+            puts "How many percentage points is Section #{i} worth?"
+            weight = gets.chomp.to_i
+            puts "What score did you get on Section #{i}?"
+            score = gets.chomp.to_i
+            exam.add_section(name, weight, score)
+        end
+
+        return exam
+    end
+end
+
+require "salesforce_certification_calculator/exam"

data/lib/salesforce_certification_calculator.rb

@@ -0,0 +1,92 @@
+class SalesforceCertificationCalculator
+    # @!attribute exam
+    #   @return [Exam] object being used for calculations
+    # 
+    # @!attribute [r] exams
+    #   @return [Array] collection of Exam objects used for temporary storage
+    attr_accessor :exam
+    attr_reader :exams
+
+    # Creates SalesforceCertificationCalculator object
+    # 
+    # @example Create Calculator Object
+    #   >> calculator = SalesforceCertificationCalculator.new
+    def initialize
+        @exams = []
+        @exam = Exam.new
+        @reader = FileReader.new
+        @ui = UI.new
+    end
+
+    # Gets list of all exams in the database, including their names and file paths; shortcut for FileReader method to modify exams attribute on object
+    # 
+    # @example Retrieve Exams
+    #   >> calculator = SalesforceCertificationCalculator.new
+    #   >> exams = calculator.generate_exams_list
+    #   => [<SalesforceCertificationCalculator::Exam 0x000987>, <SalesforceCertificationCalculator::Exam 0x000988>]
+    def generate_exams_list
+        @exams = @reader.generate_exams_list
+    end
+
+    # Gets all details about an exam's sections, including names and weights; shortcut for FileReader method to modify exam attribute on object
+    # 
+    # @example Retrieve Exam Data
+    #   >> calculator = SalesforceCertificationCalculator.new
+    #   >> exams = calculator.generate_exams_list
+    #   >> exam = calculator.extract_exam_data(exams[0])
+    #   => <SalesforceCertificationCalculator::Exam 0x000987>
+    # 
+    # @param exam [Exam] object, containing name and file properties, to use to get full data
+    def extract_initial_exam_data
+        @exam = @reader.extract_initial_exam_data(@exam)
+    end
+
+    # Determines cumulative score for the exam based on its sections' weights and scores; shortcut for Exam method that returns total value of exam after calculating total
+    # 
+    # @example Calculate Total
+    #   >> calculator = SalesforceCertificationCalculator.new
+    #   >> total = calculator.calculate_total
+    #   => 87
+    # 
+    # @return [Number] cumulative score on exam; if sections' weights do not sum to 100, it will return an error message as a string
+    def calculate_total
+        @exam.calculate_total
+
+        return @exam.total
+    end
+
+    # Determines cumulative score manually; shortcut that combines all of UI's methods
+    # 
+    # @example Calculate Total
+    #   >> calculator = SalesforceCertificationCalculator.new
+    #   >> total = calculator.determine_percentage_manually
+    #   => 87
+    # 
+    # @return [Number] cumulative score on exam
+    def determine_percentage_manually
+        choice = @ui.select_list_or_new
+
+        if choice == "LIST"
+            @exams = @reader.generate_exams_list
+            @exam = @ui.select_specific_exam(@exams)
+            @exam = @reader.extract_initial_exam_data(@exam)
+
+            puts "You selected: #{@exam.title}"
+            puts "Enter your scores for each of the exam's #{@exam.sections.length} sections in the order you are prompted"
+            
+            @exam = @ui.provide_scores(@exam)
+        else
+            @exam = @ui.provide_all_details_manually
+        end
+
+        @exam.calculate_total
+
+        puts "Your cumulative score is: #{@exam.total}%"
+
+        return @exam.total
+    end
+end
+
+require "salesforce_certification_calculator/exam"
+require "salesforce_certification_calculator/u_i"
+require "salesforce_certification_calculator/file_reader"