Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add specs for Random::Formatter#alphanumeric #1222

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions library/random/alphanumeric_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
require_relative '../../spec_helper'

ruby_version_is "3.1" do
require 'random/formatter'
Copy link
Member

@andrykonchin andrykonchin Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like Random::Formatter was available in Ruby 3.0 but was part of securerandom.

Random::Formatter is moved to random/formatter.rb, so that you can use Random#hex, Random#base64, and so on without SecureRandom. [Feature #18190]

https://github.com/ruby/ruby/blob/v3_1_0/NEWS.md
https://bugs.ruby-lang.org/issues/18190

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it seems Random::Formatter's methods are available on SecureRandom. So ideally we would want to have a shared example to test #alphanumeric for both Random::Formatter and SequreRandom.

SecureRandom.method(:alphanumeric)
# => #<Method: #<Class:SecureRandom>(Random::Formatter)#alphanumeric(n=..., chars: ...)

JFYI there are specs of Random::Formatter methods in https://github.com/ruby/spec/tree/master/library/securerandom that would probably also might be shared.


describe "Random.alphanumeric" do
it "generates a random alphanumeric string" do
Random.alphanumeric.should =~ /\A[A-Za-z0-9]+\z/
end

it "has a default size of 16 characters" do
Random.alphanumeric.size.should == 16
end

it "accepts a 'size' argument" do
Random.alphanumeric(10).size.should == 10
end

it "uses the default size if 'nil' is given as size argument" do
Random.alphanumeric(nil).size.should == 16
end

it "raises an ArgumentError if the size is not numeric" do
-> {
Random.alphanumeric("10")
}.should raise_error(ArgumentError)
end

it "does not coerce the size argument with #to_int" do
size = mock("size")
size.should_not_receive(:to_int)
-> {
Random.alphanumeric(size)
}.should raise_error(ArgumentError)
end

it "can be used by any object that responds to #random_number" do
random = mock("random")
random.should_receive(:random_number).and_return(42)
random.extend(Random::Formatter)
random.alphanumeric(2).should == "qA"
end

ruby_version_is "3.3" do
it "accepts a 'chars' argument with the output alphabet" do
Random.alphanumeric(chars: ['a', 'b']).should =~ /\A[ab]+\z/
end

it "converts the elements of chars using #to_s" do
to_s = mock("to_s")
to_s.should_receive(:to_s).and_return("[mock to_s]")
# Using 1 value in chars results in an infinite loop
Random.alphanumeric(1, chars: [to_s, to_s]).should == "[mock to_s]"
end
end
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems chars could contain more than 1 character and all of them will be used, not the first one. But documentation states that The argument chars specifies the character list .... As for me it's worth adding a dedicated test case for it.

end
end