salesforce_certification_calculator 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c567ac0623c7dd10af68535253e5e41940c3bb95a40f4d4bf949db7ab66c6fdc
-  data.tar.gz: 5199c2d3b10aa5be6ee0f8d4c7a017b074cd273895af7998a173dd338dc67480
+  metadata.gz: a085ce0eb296c739f492519f11e1e11ed162423632aa115cb1e73aa66eb3c8e6
+  data.tar.gz: 76e04f4e08be8de4708986ec1609a0226d9c75a67cc01718d24d3dc55465c28f
 SHA512:
-  metadata.gz: 9958c6e030202ee90903b6305bbf0279d87e0ed98e8c24c9c8d398b3ac6913bc2bd21cd9fdb3f4c0be41cb9b59c419565ad19a21de39a9811a4d1a2de970f084
-  data.tar.gz: 4d4b26d5210bb43bc701302579205897e654eeab15324d0429fa985ea9550845171b1961d16171f0442024e648b8810e55be37dbf1dbe7593f7cc7ac74a1e83d
+  metadata.gz: 6c6b97f0d765f336d447914fc9e870a94646e4a80858e5fbc6442eca0e2210f7fc20aff23e375985fe07d12cd4ab042bc34e050b12a0668ba00df481ae032f1a
+  data.tar.gz: f31d416f959c4aeb42d3d29ebdf966d538aa7805965aecff6840b8a17ced8a9e13771c4ea03ba4bfbb705cb3984eb655f004663e9c41e1e5a2e13569490c5731

data/README.md

@@ -28,6 +28,7 @@ I've taken a few Salesforce certification exams in my day, and I was always anno
 - File reading functionality
 - User interface for the CLI to provide prompts to walk user through the input process
 - Methods for calculating the cumulative total and for walking the user through all stages of data collection
+- Executable to allow user to run the module's core functionality with a simple command in the CLI instead of needing to go into a Ruby shell
 
 ## Requirements
 
@@ -65,14 +66,16 @@ If you have trouble downloading the package or just want to play around with the
 1. Fork this repository
 2. Clone it to your local computer
 3. From within your local version of the directory, build the module: `gem build salesforce_certification_calculator.gemspec`
-4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.2.gem`
+4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.5.gem`
 5. Open a Ruby environment to use the module: `irb`
 6. Execute any of the recently installed methods
 
-You may need to update the specific version of the build as later releases come out (e.g., `-0.2.2.gem` may need to become `-0.3.0.gem`).
+You may need to update the specific version of the build as later releases come out (e.g., `-0.2.5.gem` may need to become `-0.3.0.gem`).
 
 ## Usage
 
+### Module
+
 1. Open a Ruby environment to use the module: `irb`
 2. Require the package: `require 'salesforce_certification_calculator'`
 3. Create a new calculator to use: `calculator = SalesforceCertificationCalculator.new`
@@ -81,6 +84,14 @@ You may need to update the specific version of the build as later releases come
 
 Of course, you may use any of the other methods provided by the package, but `determine_percentage_manually` is the core method.
 
+### Executable
+
+This package also contains an executable, so you can run its core functionality (the above `determine_percentage_manually` method) directly from the CLI without needing to enter a Ruby shell:
+
+```
+salesforce_certification_calculator
+```
+
 ## Documentation
 
 This project uses **YARD** for documentation generation. To view the published form, see the [documentation on the RubyDoc site](https://www.rubydoc.info/gems/salesforce_certification_calculator/). To view the docs locally, go to the `doc` folder. To generate the docs yourself, execute `rake yard` in the CLI from the root of your local copy of the project.
@@ -99,6 +110,8 @@ def calculate_total
 
     if summed_weights != 100
         @total = "CANNOT CALCULATE"
+    else
+        @total = @total.round(2)
     end
 end
 ```
@@ -106,7 +119,8 @@ end
 **Helper function to pull data stored in a reference XML file**
 ```ruby
 def extract_initial_exam_data(exam)
-    doc = File.open(exam.file) { |f| Nokogiri::XML(f) }
+    file_path = @base_path + "/" + exam.file
+    doc = File.open(file_path) { |f| Nokogiri::XML(f) }
     names = doc.xpath("//name")
     weights = doc.xpath("//weight")
 
@@ -120,7 +134,7 @@ end
 
 ## Testing
 
-This project has 103 automated tests, located in the `test` folder at the root. To run them, execute `rake test`. In order to successfully run these tests, you may need to also install `stringio` and `o_stream_catcher`.
+This project has 106 automated tests, located in the `test` folder at the root. To run them, execute `rake test`. In order to successfully run these tests, you may need to also install `stringio` and `o_stream_catcher`.
 
 ## Future Goals
 

data/Rakefile

@@ -12,4 +12,4 @@ end
 desc "Run tests"
 task default: :test
 
-# --- Ran 103 tests in 0.013676s on 7/28/22 --- OK --- #
+# --- Ran 106 tests in 0.013781s on 7/30/22 --- OK --- #

data/lib/salesforce_certification_calculator/exam.rb

@@ -48,12 +48,13 @@ class SalesforceCertificationCalculator::Exam
     def calculate_total
         summed_weights = 0
 
+        # Sum weighted scores of all sections
         @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
+        # Sets total to error message when sum of sections' weights is not 100; otherwise, rounds answer
         if summed_weights != 100
             @total = "CANNOT CALCULATE"
         else

data/lib/salesforce_certification_calculator/file_reader.rb

@@ -8,18 +8,22 @@ class SalesforceCertificationCalculator::FileReader
     def initialize
         sfc_gems = []
 
+        # Get full path to where Ruby gems are stored on user's computer, starting at the base
         gems_path = ENV["HOME"] + "/gems/gems"
         all_gems = Dir.children(gems_path)
 
+        # Create list of all versions of module installed on user's computer
         all_gems.each do |gem|
             if gem.include? "salesforce_certification_calculator"
                 sfc_gems.push(gem)
             end
         end
 
+        # Determine most recent version of module available
         sfc_gems.sort
         latest_sfc = sfc_gems[sfc_gems.length - 1]
 
+        # Set path variable for use by the class's methods
         @base_path = gems_path + "/" + latest_sfc
     end
 
@@ -35,6 +39,7 @@ class SalesforceCertificationCalculator::FileReader
         exams = []
         files = Dir.glob("data/*xml", base: @base_path)
 
+        # Create list of all exams, including their titles and file paths
         files.each do |file|
             exam = SFC::Exam.new
             file_path = @base_path + "/" + file
@@ -65,6 +70,7 @@ class SalesforceCertificationCalculator::FileReader
         names = doc.xpath("//name")
         weights = doc.xpath("//weight")
 
+        # Add all sections' names and weights to existing exam data
         (0..names.length-1).each do |i|
             exam.add_section(names[i].content, weights[i].content.to_i)
         end

data/lib/salesforce_certification_calculator/u_i.rb

@@ -13,6 +13,7 @@ class SalesforceCertificationCalculator::UI
         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
 
+        # Only return value if user selected one of the two provided options; otherwise, recursively recall function
         if choice == "LIST" || choice == "NEW"
             return choice
         else
@@ -33,18 +34,28 @@ class SalesforceCertificationCalculator::UI
     # 
     # @return [Exam] object with name, file, and section details for selected exam
     def select_specific_exam(exams)
+        exams_length = exams.length
+
         puts "Your choices are:"
 
+        # List exam options
         exams.each do |exam|
             puts "#{exams.find_index(exam) + 1} - #{exam.title}"
         end
 
+        # Add option to take user back to the LIST or NEW prompt
+        puts "#{exams_length + 1} - NOT LISTED"
         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)
+        if choice.between?(1, exams_length)
+            # Only return value if user inputted number within range
             return exams[choice - 1]
+        elsif choice == exams_length + 1
+            # Allow user to opt out if last option entered
+            select_list_or_new()
         else
+            # Recursively recall function if invalid input
             select_specific_exam(exams)
         end
     end
@@ -65,6 +76,7 @@ class SalesforceCertificationCalculator::UI
     def provide_scores(exam)
         sections = exam.sections
 
+        # Get scores for each section from the user
         sections.each do |section|
             puts "#{section.name} is worth #{section.weight}%"
             puts "What score did you get on that section? (enter an integer)"
@@ -90,6 +102,7 @@ class SalesforceCertificationCalculator::UI
         puts "How many sections does it have?"
         length = gets.chomp.to_i
 
+        # Get names, weights, and scores for each section of the exam from the user
         (1..length).each do |i|
             puts "What is the name of Section #{i}?"
             name = gets.chomp

data/lib/salesforce_certification_calculator.rb

@@ -66,6 +66,7 @@ class SalesforceCertificationCalculator
         choice = @ui.select_list_or_new
 
         if choice == "LIST"
+            # Get list of exams, prompt user to select one, then require user to provide their scores for all the exam's sections
             @exams = @reader.generate_exams_list
             @exam = @ui.select_specific_exam(@exams)
             @exam = @reader.extract_initial_exam_data(@exam)
@@ -75,6 +76,7 @@ class SalesforceCertificationCalculator
             
             @exam = @ui.provide_scores(@exam)
         else
+            # Allow user to manually enter all data themselves without the aid of the data already stored in the module's XML files
             @exam = @ui.provide_all_details_manually
         end
 

data/test/test_u_i.rb

@@ -184,6 +184,20 @@ class UITest < Minitest::Test
         assert_equal 1, result[1].scan("Which one would you like to select").length, "should call select_specific_exam only once if user inputs 2"
     end
 
+    def test_select_specific_exam_call_list_new
+        result = OStreamCatcher.catch do
+            string_io = StringIO.new
+            string_io.puts "#{@@exams.length + 1}"
+            string_io.puts "NEW"
+            string_io.rewind
+            $stdin = string_io
+            @@ui.select_specific_exam(@@exams)
+            $stdin = STDIN
+        end
+
+        assert_equal 1, result[1].scan("Do you want to select an exam from a list (enter LIST), or do you want to type in your own details (enter NEW)?").length, "should call select_list_or_new if user enters NOT LISTED option"
+    end
+
     def test_select_specific_exam_recursion_greater
         result = OStreamCatcher.catch do
             string_io = StringIO.new
@@ -212,6 +226,34 @@ class UITest < Minitest::Test
         assert_operator result[1].scan("Which one would you like to select").length, :>, 1, "should call select_specific_exam more than once if user inputs 0"
     end
 
+    def test_select_specific_exam_recursion_letter
+        result = OStreamCatcher.catch do
+            string_io = StringIO.new
+            string_io.puts "a"
+            string_io.puts "1"
+            string_io.rewind
+            $stdin = string_io
+            @@ui.select_specific_exam(@@exams)
+            $stdin = STDIN
+        end
+
+        assert_operator result[1].scan("Which one would you like to select").length, :>, 1, "should call select_specific_exam more than once if user inputs letter"
+    end
+
+    def test_select_specific_exam_recursion_title
+        result = OStreamCatcher.catch do
+            string_io = StringIO.new
+            string_io.puts "Advanced Administrator"
+            string_io.puts "1"
+            string_io.rewind
+            $stdin = string_io
+            @@ui.select_specific_exam(@@exams)
+            $stdin = STDIN
+        end
+
+        assert_operator result[1].scan("Which one would you like to select").length, :>, 1, "should call select_specific_exam more than once if user inputs title of exam instead of number"
+    end
+
     def test_provide_scores_returns_exam
         result = {}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_certification_calculator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Jackson Reeves