salesforce_certification_calculator 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee895a9e21c058eefc6cb56279c7ec58f700b5dfec8a08d034482ba0d656a04f
-  data.tar.gz: b988479222226cf9a93513e7eadd5aee75e8dad8db6d6ccdb1c82cd35b55c28a
+  metadata.gz: d3e2c79e3592dc37772b3e758787237aee2a59eb61fdf6bb79e69a2922fb409c
+  data.tar.gz: f71f648b7227e328e16e914d1285f53242c3b5d35456c1c59971924f6087cf52
 SHA512:
-  metadata.gz: d1819b8eed67b8e1dd3b8e957a25155c4a117c009b6476c37723c8e1d97d6af71304b142d12dc847f614b1381859520e6d3f495ca662de1caf048aaf4a1eaa62
-  data.tar.gz: 5d648caa5592a03f61f42ab341f434d8d69327158186333536780a835ba629d7ba4cb0ce81b903155e521b8324d81fe8d2e701d2de89298a41de264cacc76b39
+  metadata.gz: 75e7530e1274da33a63de6705ae6d024cd8aa736266b74dcd4c01623303fbd4ce2bfdcab96f67423c3451265d84b6cfe03473d3ac867e29148631291b554eaa3
+  data.tar.gz: 200ce30ad30d7841a0fa37f03f86b2ca1d34b3391e6d75fed0604c38bcac88bd77c680ca1268dd567a275889753fad7e3f35b807d9f4b7b8b67f2fcf10eb9814

data/README.md

@@ -39,16 +39,19 @@ I've taken a few Salesforce certification exams in my day, and I was always anno
 ### Set Up Environment
 
 1. Install `rbenv` via Homebrew: `brew install rbenv`
-2. Update your `.zshrc` config file:
-> `export PATH="/usr/local/opt/ruby/bin:/usr/local/lib/ruby/gems/3.1.0/bin:$PATH"`
-> `eval "$(rbenv init - zsh)"`
-> `export PATH=$HOME/.rbenv/shims:$PATH`
-> `export GEM_HOME=$HOME/gems`
-> `export PATH=$HOME/gems/bin:$PATH`
+2. Add the code block below these steps to your `.zshrc` config file
 3. Install latest version of Ruby via the `rbenv` package: `rbenv install 3.1.2`
 4. Set global version of Ruby via the `rbenv` package: `rbenv global 3.1.2`
 5. Fix `racc` version: `gem pristine racc --version 1.6.0`
 
+```bash
+export PATH="/usr/local/opt/ruby/bin:/usr/local/lib/ruby/gems/3.1.0/bin:$PATH"
+eval "$(rbenv init - zsh)"
+export PATH=$HOME/.rbenv/shims:$PATH
+export GEM_HOME=$HOME/gems
+export PATH=$HOME/gems/bin:$PATH
+```
+
 ### Download Package
 
 ```
@@ -62,11 +65,11 @@ 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.0.gem`
+4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.3.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.0.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.3.gem` may need to become `-0.3.0.gem`).
 
 ## Usage
 
@@ -96,6 +99,8 @@ def calculate_total
 
     if summed_weights != 100
         @total = "CANNOT CALCULATE"
+    else
+        @total = @total.round(2)
     end
 end
 ```
@@ -103,7 +108,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")
 

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 103 tests in 0.013265s on 7/29/22 --- OK --- #

data/lib/salesforce_certification_calculator/exam.rb

@@ -53,7 +53,7 @@ class SalesforceCertificationCalculator::Exam
             @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

@@ -1,19 +1,15 @@
 class SalesforceCertificationCalculator::FileReader
     SFC = SalesforceCertificationCalculator
 
-    # Gets list of all exams in the database, including their names and file paths
+    # Creates FileReader object by establishing a base path
     # 
-    # @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 = []
+    # @example Create FileReader Object
+    #   >> fr = FileReader.new
+    def initialize
+        sfc_gems = []
+
         gems_path = ENV["HOME"] + "/gems/gems"
         all_gems = Dir.children(gems_path)
-        sfc_gems = []
 
         all_gems.each do |gem|
             if gem.include? "salesforce_certification_calculator"
@@ -23,12 +19,26 @@ class SalesforceCertificationCalculator::FileReader
 
         sfc_gems.sort
         latest_sfc = sfc_gems[sfc_gems.length - 1]
-        base_path = gems_path + "/" + latest_sfc
-        files = Dir.glob("data/*xml", base: base_path)
+
+        @base_path = gems_path + "/" + latest_sfc
+    end
+
+    # 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", base: @base_path)
 
         files.each do |file|
             exam = SFC::Exam.new
-            doc = File.open(file) { |f| Nokogiri::XML(f) }
+            file_path = @base_path + "/" + file
+            doc = File.open(file_path) { |f| Nokogiri::XML(f) }
             title = doc.at_xpath("//title")
             exam.title = title.content
             exam.file = file
@@ -50,7 +60,8 @@ class SalesforceCertificationCalculator::FileReader
     # 
     # @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) }
+        file_path = @base_path + "/" + exam.file
+        doc = File.open(file_path) { |f| Nokogiri::XML(f) }
         names = doc.xpath("//name")
         weights = doc.xpath("//weight")
 

metadata

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