salesforce_certification_calculator 0.1.0 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -17
  3. data/Rakefile +1 -1
  4. data/bin/salesforce_certification_calculator +2 -1
  5. data/lib/salesforce_certification_calculator.rb +3 -4
  6. metadata +64 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 261768563e556f96d8dc7cf3c0c27bb192f21a364261e727986d41e1a5fa0106
4
- data.tar.gz: 847be3e13f524378222c85e1b569dbebd061c497ef992fe816d2662d083cc180
3
+ metadata.gz: f22ae65bcbef0473ae9e52421a4907f017d0642ab6f65df5a52b0c2552a35396
4
+ data.tar.gz: d2ce21e0908dc21bf91f68d477301667bc25fd8425b51c97d06d3f32a5df72a2
5
5
  SHA512:
6
- metadata.gz: 56a368833a149e38fe351cae441e8a82c2badc22b6d0a71bfbdd9f1fa7182fabd34bd6f75868056e952acd51bcdbb474e352f2e8d3dbabfd523ceb1fc6ac4876
7
- data.tar.gz: 2b9f04207b572825091fa0d17aa407d1a9805e22ec03beefd5072432f8110916aa7402de557c716408ad34f2e1c30874b4c6475011b73b246197d6bb3388c424
6
+ metadata.gz: 70914bb6b37c2497d98ff8e7cf1667e3d86edf7758b7b984637ff2c4286eece6adf79ac4f2554f74115c1924cc1c086838c182a56e9381fbb51330e41d9606f3
7
+ data.tar.gz: a2dacb5b70ee020e252f18ec3a805b962c9db041fb823750cd6668625c7ee27bfae8d3ef6683beb210fa5ed6f22d6fdea6ba7731c34f0751d9a1b531c34fa64b
data/README.md CHANGED
@@ -3,24 +3,24 @@
3
3
  *Calculates cumulative percentage from Salesforce certification section results*
4
4
 
5
5
  **Contents**
6
- 1. [Description](https://github.com/jtreeves/salesforce_certification_calculator#description)
7
- 2. [Inspiration](https://github.com/jtreeves/salesforce_certification_calculator#inspiration)
8
- 3. [Features](https://github.com/jtreeves/salesforce_certification_calculator#features)
9
- 4. [Requirements](https://github.com/jtreeves/salesforce_certification_calculator#requirements)
10
- 5. [Installation](https://github.com/jtreeves/salesforce_certification_calculator#installation)
11
- 6. [Usage](https://github.com/jtreeves/salesforce_certification_calculator#usage)
12
- 7. [Documentation](https://github.com/jtreeves/salesforce_certification_calculator#documentation)
13
- 8. [Code Examples](https://github.com/jtreeves/salesforce_certification_calculator#code-examples)
14
- 9. [Testing](https://github.com/jtreeves/salesforce_certification_calculator#testing)
15
- 10. [Future Goals](https://github.com/jtreeves/salesforce_certification_calculator#future-goals)
6
+ 1. [Description](#description)
7
+ 2. [Inspiration](#inspiration)
8
+ 3. [Features](#features)
9
+ 4. [Requirements](#requirements)
10
+ 5. [Installation](#installation)
11
+ 6. [Usage](#usage)
12
+ 7. [Documentation](#documentation)
13
+ 8. [Code Examples](#code-examples)
14
+ 9. [Testing](#testing)
15
+ 10. [Future Goals](#future-goals)
16
16
 
17
17
  ## Description
18
18
 
19
- A **Ruby** gem module for taking all the sections' weights and scores provided by **Salesforce** and using them to generate a cumulative score for the entire exam. Built using [Ruby's guide to making gems](https://guides.rubygems.org/make-your-own-gem/).
19
+ A **Ruby** gem module for taking all the sections' weights and scores provided by **Salesforce** and using them to generate a cumulative score for the entire exam. Built using [Ruby's guide to making gems](https://guides.rubygems.org/make-your-own-gem/). View the details on the [published module on Ruby's site](https://rubygems.org/gems/salesforce_certification_calculator).
20
20
 
21
21
  ## Inspiration
22
22
 
23
- I've taken a few Salesforce certification exams in my day, and I was always annoyed that even though Salesforce provides you with your score on a given section, it refuses to provide you with a simple cumulative score. It does tell you if you passed of failed, but it would be useful to know by exactly how much. I created this module to give users a simple way to achieve that for themselves.
23
+ I've taken a few Salesforce certification exams in my day, and I was always annoyed that even though Salesforce provides you with your score on a given section, it refuses to provide you with a simple cumulative score. It does tell you if you passed of failed, but it would be useful to know by exactly how much. Previously, I would use a calculator to manually enter the data. However, given how many sections an exam may have, I can mis-enter some data. I created this module to give users a simple way to achieve that for themselves.
24
24
 
25
25
  ## Features
26
26
 
@@ -36,6 +36,21 @@ I've taken a few Salesforce certification exams in my day, and I was always anno
36
36
 
37
37
  ## Installation
38
38
 
39
+ ### Set Up Environment
40
+
41
+ 1. Install `rbenv` via Homebrew: `brew install rbenv`
42
+ 2. Update your `.zshrc` config file:
43
+ ```bash
44
+ export PATH="/usr/local/opt/ruby/bin:/usr/local/lib/ruby/gems/3.1.0/bin:$PATH"
45
+ eval "$(rbenv init - zsh)"
46
+ export PATH=$HOME/.rbenv/shims:$PATH
47
+ export GEM_HOME=$HOME/gems
48
+ export PATH=$HOME/gems/bin:$PATH
49
+ ```
50
+ 3. Install latest version of Ruby via the `rbenv` package: `rbenv install 3.1.2`
51
+ 4. Set global version of Ruby via the `rbenv` package: `rbenv global 3.1.2`
52
+ 5. Fix `racc` version: `gem pristine racc --version 1.6.0`
53
+
39
54
  ### Download Package
40
55
 
41
56
  ```
@@ -44,16 +59,16 @@ gem install salesforce_certification_calculator
44
59
 
45
60
  ### Create Local Repository
46
61
 
47
- If you have trouble downloading the package or just want to play around with the code yourself, you can clone down the repository. Ensure you already have Ruby on your local computer. (You can check this by executing `ruby -v`.)
62
+ If you have trouble downloading the package or just want to play around with the code yourself, you can clone down the [repository on GitHub](https://github.com/jtreeves/salesforce_certification_calculator). Ensure you already have Ruby on your local computer. (You can check this by executing `ruby -v`.)
48
63
 
49
64
  1. Fork this repository
50
65
  2. Clone it to your local computer
51
66
  3. From within your local version of the directory, build the module: `gem build salesforce_certification_calculator.gemspec`
52
- 4. Then install that built module: `gem install ./salesforce_certification_calculator-0.1.0.gem`
67
+ 4. Then install that built module: `gem install ./salesforce_certification_calculator-0.1.3.gem`
53
68
  5. Open a Ruby environment to use the module: `irb`
54
69
  6. Execute any of the recently installed methods
55
70
 
56
- You may need to update the specific version of the build as later releases come out (e.g., `-0.1.0.gem` may need to become `-0.2.0.gem`).
71
+ You may need to update the specific version of the build as later releases come out (e.g., `-0.1.3.gem` may need to become `-0.2.0.gem`).
57
72
 
58
73
  ## Usage
59
74
 
@@ -67,7 +82,7 @@ Of course, you may use any of the other methods provided by the package, but `de
67
82
 
68
83
  ## Documentation
69
84
 
70
- This project uses **YARD** for documentation generation. To view the docs, 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.
85
+ 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/0.1.3). 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.
71
86
 
72
87
  ## Code Examples
73
88
 
@@ -110,5 +125,5 @@ This project has 103 automated tests, located in the `test` folder at the root.
110
125
 
111
126
  - Extract score data from text file (or better yet, a PDF or directly from an email message), and use that to also determine which exam it is for in the hopes of minimizing the amount of data that the user needs to key in
112
127
  - More robust error handling and exception raising for when a user attempts to run `calculate_total` on an exam with sections whose weights do not equal 100; similar issue with interacting with the UI methods
113
- - A **Rails** app to live in the browser an facilitate much of the above
128
+ - A **Rails** app to live in the browser and facilitate much of the above
114
129
  - More aesthetically appealing documentation pages
data/Rakefile CHANGED
@@ -12,4 +12,4 @@ end
12
12
  desc "Run tests"
13
13
  task default: :test
14
14
 
15
- # --- Ran 103 tests in 0.018368s on 7/21/22 --- OK --- #
15
+ # --- Ran 103 tests in 0.013676s on 7/28/22 --- OK --- #
data/bin/salesforce_certification_calculator CHANGED
@@ -2,4 +2,5 @@
2
2
 
3
3
  require "salesforce_certification_calculator"
4
4
 
5
- puts SalesforceCertificationCalculator.cumulative_score(ARGV[0], ARGV[1])
5
+ calculator = SalesforceCertificationCalculator.new
6
+ calculator.determine_percentage_manually
data/lib/salesforce_certification_calculator.rb CHANGED
@@ -32,11 +32,10 @@ class SalesforceCertificationCalculator
32
32
  #
33
33
  # @example Retrieve Exam Data
34
34
  # >> calculator = SalesforceCertificationCalculator.new
35
- # >> exams = calculator.generate_exams_list
36
- # >> exam = calculator.extract_exam_data(exams[0])
35
+ # >> calculator.generate_exams_list
36
+ # >> calculator.exam = calculator.exams[1]
37
+ # >> calculator.extract_exam_data
37
38
  # => <SalesforceCertificationCalculator::Exam 0x000987>
38
- #
39
- # @param exam [Exam] object, containing name and file properties, to use to get full data
40
39
  def extract_initial_exam_data
41
40
  @exam = @reader.extract_initial_exam_data(@exam)
42
41
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: salesforce_certification_calculator
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jackson Reeves
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-15 00:00:00.000000000 Z
11
+ date: 2022-07-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: nokogiri
@@ -24,7 +24,64 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.13'
27
- description: Salesforce resource for certifications
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '13.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '13.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: yard
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0.9'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0.9'
55
+ - !ruby/object:Gem::Dependency
56
+ name: stringio
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: o_stream_catcher
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: 0.0.1
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: 0.0.1
83
+ description: Calculates cumulative percentage from Salesforce certification section
84
+ results
28
85
  email: jr@jacksonreeves.com
29
86
  executables:
30
87
  - salesforce_certification_calculator
@@ -79,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
79
136
  requirements:
80
137
  - - ">="
81
138
  - !ruby/object:Gem::Version
82
- version: '0'
139
+ version: '2.0'
83
140
  required_rubygems_version: !ruby/object:Gem::Requirement
84
141
  requirements:
85
142
  - - ">="
@@ -89,10 +146,10 @@ requirements: []
89
146
  rubygems_version: 3.3.7
90
147
  signing_key:
91
148
  specification_version: 4
92
- summary: Calculates cumulative percentage from Salesforce certification section results
149
+ summary: Uses linear algebra to determine total scores on exams
93
150
  test_files:
94
- - test/test_exam.rb
95
- - test/test_file_reader.rb
96
151
  - test/test_salesforce_certification_calculator.rb
152
+ - test/test_exam.rb
97
153
  - test/test_section.rb
154
+ - test/test_file_reader.rb
98
155
  - test/test_u_i.rb