Name lib/ top-level file to match expected require #144
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
In 00312b9 the namespace of this gem was converted from `statistics` to `ruby-statistics`. This includes the instructions for requiring the entire gem to use `require 'ruby-statistics'`. However, that file does not exist in the gem. The `lib/statistics.rb` file still existed. And in tests for the gem, that file was still being loaded. As a result the tests were still passing after the change. To be in agreement with the documentation and the upgrade path, this creates a `lib/ruby-statistics.rb` file. That is loaded in tests to confirm the behavior we are documenting in the README. This file naming is a bit unconventional, as we may expect to be using underscore to separate the words. That would also be consistent with RubyGem's [naming guide](https://guides.rubygems.org/name-your-gem/). However, the gem name is already defined and considered out of scope for this change. We *can* make this file `lib/ruby_statistics.rb`. That would match a Ruby conventional file-naming scheme. As a result of that, we would update the documentation to `require 'ruby-statistics'`. I would also advocate for changing the `ruby-statistics` directory to `ruby_statistics`. Doing that would have inconsistency between the gem name and what's being required, though some of it would be more conventional. Rather than making those sweeping changes, this proposes creating this file so that the gem can be required as the README suggests.
|
Hi @kevin-j-m thank you so much for this PR! I thought it was something on my env as I couldn't replicate this behaviour constantly on my end. I'll give some tests and let you know how it goes. Thank you! |
|
Alright, I did some tests and it looks good. You're missing one spot, so if you can add it to the PR I really appreciate it! https://github.com/estebanz01/ruby-statistics/blob/master/bin/console |
estebanz01
previously approved these changes
Aug 10, 2024
|
@estebanz01 I pushed 14c295f to include the console change. Let me know if you need anything else. |
estebanz01
approved these changes
Aug 12, 2024
estebanz01
added a commit
that referenced
this pull request
Aug 13, 2024
This change includes the fix reported in #144 by @kevin-j-m Thanks!
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.
In 00312b9 the namespace of this gem was converted from
statisticstoruby-statistics. This includes the instructions for requiring the entire gem to userequire 'ruby-statistics'. However, that file does not exist in the gem.The
lib/statistics.rbfile still existed. And in tests for the gem, that file was still being loaded. As a result the tests were still passing after the change.To be in agreement with the documentation and the upgrade path, this creates a
lib/ruby-statistics.rbfile. That is loaded in tests to confirm the behavior we are documenting in the README.This file naming is a bit unconventional, as we may expect to be using underscore to separate the words. That would also be consistent with RubyGem's naming guide. However, the gem name is already defined and considered out of scope for this change.
We can make this file
lib/ruby_statistics.rb. That would match a Ruby conventional file-naming scheme. As a result of that, we would update the documentation torequire 'ruby_statistics'. I would also advocate for changing theruby-statisticsdirectory toruby_statistics.Doing that would have inconsistency between the gem name and what's being required, though some of it would be more conventional.
Rather than making those sweeping changes, this proposes creating this file so that the gem can be required as the README suggests.