Add linting with Rubocop, generated docs with Yard #14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ore installing an older version
tinahollygb
commented
Apr 19, 2023
lib/growthbook/util.rb
Outdated
| def self.chooseVariation(userId, experiment) | ||
| testId = experiment.id | ||
| weights = experiment.getScaledWeights | ||
| def self.choose_variation_for_user(user_id, experiment) |
There was a problem hiding this comment.
There's already a choose_variation so I needed to call this one something else to avoid a naming conflict.
There was a problem hiding this comment.
This got cleaned up when deleting the deprecated classes. 🤷♀️
tinahollygb
commented
Apr 19, 2023
.github/workflows/ci.yml
Outdated
Comment on lines
5
to
26
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: 3.2.2 | ||
| bundler-cache: true | ||
| - name: Lint | ||
| run: | | ||
| gem install rubocop -v 1.50.2 | ||
| gem install rubocop-rspec -v 2.20.0 | ||
| rubocop | ||
|
|
||
| build-test: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| ruby: | ||
| - '2.5' | ||
| - '3.2.2' |
There was a problem hiding this comment.
On CI, we are now running:
- lint, on Ruby 3.2.2 (newest)
- tests on:
- 2.5 – oldest we can support based on syntax
- 3.2.2 – newest version of Ruby
tinahollygb
commented
Apr 19, 2023
.github/workflows/docs.yml
Outdated
Comment on lines
8
to
25
| docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: 3.2.2 | ||
| bundler-cache: true | ||
| - name: Generate docs | ||
| run: | | ||
| gem install yard | ||
| yard doc 'lib/**/*.rb' | ||
|
|
||
| - name: Publish docs | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| publish_dir: doc |
There was a problem hiding this comment.
Generates class docs here: https://growthbook.github.io/growthbook-ruby/
tinahollygb
commented
Apr 19, 2023
|
|
||
| ## Quick start |
There was a problem hiding this comment.
These docs are redundant so I'm linking to the official docs instead.
tinahollygb
commented
Apr 19, 2023
Comment on lines
-138
to
+141
| return nill unless val | ||
| return nil unless val |
There was a problem hiding this comment.
This branch must be untested because this should've thrown a reference error.
This was referenced Apr 19, 2023
Merged
jdorn
approved these changes
Apr 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs
Generates class docs. On a successful push to main, they build and deploy here: https://growthbook.github.io/growthbook-ruby
Removes redundant docs from the readme (it's all duplicated from the real docs).
Related PR links to this new generated class docs site: growthbook/growthbook#1202
Dead code
Deletes deprecated classes Client, Experiment, ExperimentResult, User, LookupResult.
Linting, Tests, CI
Adds linting with Rubocop. This required a lot of changes for naming conventions and style.
On CI, we are now running:
Test coverage
Also adds code coverage. Reports can be open locally by running
open coverage/index.htmlafter runningbundle exec rspec.