salesforce_certification_calculator 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef5a9b0381b8fa4e0bc2bec71b5095410c1d204e14894d4fe1bb3920b38813c5
-  data.tar.gz: 2792ca40ed89823d99e38498d0866a2fda1761ed3700e991e8e5f0a491d97531
+  metadata.gz: c6cd3c2dd6799ce7b8249d9651553b869544681b35622118147642aefe6eaa19
+  data.tar.gz: 98bddd3304510dcfd2b47b844d9a8f4385297a3c0c2fd214c826dbcdf632a251
 SHA512:
-  metadata.gz: 71b256254c6f6af442ddcc5b1913d27a9d07686f97409c3530294b347b68fb4c0982cf4b7d82d8a4750c24831861da89fc2ce15ea658080b885110de767c4c7c
-  data.tar.gz: 3b6dbfd4b6e2035f618eda5bebd96319c895e2a2d02ded544383a8693860eb5b8a2c3ae08739374d960d9d7c31b5ced62155413acc1838e2ad0bf07c88d3db20
+  metadata.gz: 433f1b4df8363609831ce77597db9a052fea4c3303ab840bee07376e35334b384ab9cb142c745fd02057f1a30bf118402c4a4b28dc52a69341e40794f06c70d8
+  data.tar.gz: 3f588ef7f3f53d504f837a9539260e4f106554f00fcc01d9f75100010aa75cf7732e54eef5b80d19231274221380551baa0a9cee6c9357fac0d8dda70be1f5b6

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
 
@@ -39,16 +40,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,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.1.gem`
+4. Then install that built module: `gem install ./salesforce_certification_calculator-0.2.4.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.1.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.4.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`
@@ -78,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.
@@ -96,6 +110,8 @@ def calculate_total
 
     if summed_weights != 100
         @total = "CANNOT CALCULATE"
+    else
+        @total = @total.round(2)
     end
 end
 ```
@@ -103,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")
 

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,25 @@ 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
-            file_path = base_path + "/" + file
+            file_path = @base_path + "/" + file
             doc = File.open(file_path) { |f| Nokogiri::XML(f) }
             title = doc.at_xpath("//title")
             exam.title = title.content
@@ -51,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.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Jackson Reeves