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

Prepare for release of v1.0.0 #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
## [1.0.0] - 2025-01-04
- [20] Automated tests running with Github Actions
- [19] Update Readme and Gem Description

Possible breaking changes:
- [18] Lazy loaded (and evictable) dictionaries.

The resulting values are unchanged but the way the gem works now changed to allow speedup app initialization and save memory.
Dictionaries are no longer loaded with the gem which speeds up initialization and reduce initial memory usage.
It also no longer keep the dictionaries in memory after use, garbage collection will free all the memory used by the dictionaries.
If you would like to avoid reloading the dictionaries on every call of `Zxcvbn.zxcvbn(...)` or `Zxcvbn.test(...)` class methods you could use
`Zxcvbn::Tester.new` to keep an instance with dictionaries loaded. Check the example on [README.md#testing-multiple-passwords](https://github.com/formigarafa/zxcvbn-rb/tree/master?tab=readme-ov-file#testing-multiple-passwords) for reference.

## [0.1.13] - 2024-11-05
- [17] Optimize both allocated and retained memory usage

Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
zxcvbn (0.1.13)
zxcvbn (1.0.0)

GEM
remote: https://rubygems.org/
Expand Down
2 changes: 1 addition & 1 deletion lib/zxcvbn/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Zxcvbn
VERSION = "0.1.13"
VERSION = "1.0.0"
end
Loading