omniauth-identity 3.1.5 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +67 -1
- data/CITATION.cff +6 -6
- data/CONTRIBUTING.md +94 -104
- data/FUNDING.md +20 -16
- data/LICENSE.md +10 -0
- data/MIT.md +21 -0
- data/README.md +191 -184
- data/SECURITY.md +3 -15
- data/certs/pboling.pem +27 -0
- data/lib/omniauth/identity/model.rb +35 -4
- data/lib/omniauth/identity/models/active_record.rb +18 -16
- data/lib/omniauth/identity/models/couch_potato.rb +50 -46
- data/lib/omniauth/identity/models/mongoid.rb +40 -36
- data/lib/omniauth/identity/models/nobrainer.rb +40 -36
- data/lib/omniauth/identity/models/rom.rb +41 -28
- data/lib/omniauth/identity/models/sequel.rb +65 -63
- data/lib/omniauth/identity/secure_password.rb +14 -12
- data/lib/omniauth/identity/version.rb +2 -5
- data/lib/omniauth/identity.rb +7 -0
- data/lib/omniauth/strategies/identity.rb +1 -1
- data/sig/omniauth/identity/version.rbs +8 -0
- data.tar.gz.sig +0 -0
- metadata +120 -63
- metadata.gz.sig +0 -0
- data/LICENSE.txt +0 -24
- data/REEK +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8d6c5c19c87bfae564702490d38fc897d15dd2eb13a973c2988c7e757e38e47f
|
|
4
|
+
data.tar.gz: f64a55f83157ef8a8e87bcdc4e7e20cb9d37241a0fbaeefe88f90af561d0227b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c4afd39437ef0cc4c37e731651370608ab6c9ce3f353e7c3f99cff5639ef21a8a2c4c41976946b39ab30feb0d2bb989acdb47e74b84d43e0ed7dc788a79e7ab4
|
|
7
|
+
data.tar.gz: a67a905c8e44c003bf013264dec3200eb1bc01bd36859bac831e4ab0883f528c43c10d30643d35b49b70447eaf4585c3be18adce2d7ca4a9c793df853164761a
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -30,6 +30,68 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
30
30
|
|
|
31
31
|
### Security
|
|
32
32
|
|
|
33
|
+
## [3.2.1] - 2026-07-14
|
|
34
|
+
|
|
35
|
+
- TAG: [v3.2.1][3.2.1t]
|
|
36
|
+
- COVERAGE: 22.91% -- 93/406 lines in 12 files
|
|
37
|
+
- BRANCH COVERAGE: 20.75% -- 22/106 branches in 12 files
|
|
38
|
+
- 85.26% documented
|
|
39
|
+
|
|
40
|
+
### Added
|
|
41
|
+
|
|
42
|
+
- Added support for JRuby 10.1 and TruffleRuby 34.0.
|
|
43
|
+
|
|
44
|
+
### Changed
|
|
45
|
+
|
|
46
|
+
- Retemplated generated project metadata, support documentation, CI workflows,
|
|
47
|
+
binstubs, and development dependency floors with `kettle-jem` v7.0.0.
|
|
48
|
+
- Raised the `anonymous_loader` runtime dependency floor to `>= 0.1.3`.
|
|
49
|
+
- Raised the runtime dependency floor for `auth-sanitizer` to `>= 0.2.3`, so
|
|
50
|
+
OmniAuth Identity consumers get hash and nested-attribute inspect redaction
|
|
51
|
+
fixes plus downstream RBS duplicate-declaration fixes, and switched isolated
|
|
52
|
+
sanitizer loading to the released `anonymous_loader` gem.
|
|
53
|
+
- Raised generated `version_gem` and `appraisal2` dependency floors to
|
|
54
|
+
`version_gem` >= 1.1.14 and `appraisal2` >= 3.1.4.
|
|
55
|
+
- Refreshed generated Rakefile metadata from the current kettle-jem template.
|
|
56
|
+
|
|
57
|
+
### Fixed
|
|
58
|
+
|
|
59
|
+
- Restored ORM-specific spec rake tasks and made optional ORM spec files avoid
|
|
60
|
+
loading unavailable adapter gems when the matching appraisal does not include them.
|
|
61
|
+
|
|
62
|
+
- Package configured license files in gem release file lists.
|
|
63
|
+
|
|
64
|
+
## [3.2.0] - 2026-06-05
|
|
65
|
+
|
|
66
|
+
- TAG: [v3.2.0][3.2.0t]
|
|
67
|
+
- COVERAGE: 94.21% -- 374/397 lines in 12 files
|
|
68
|
+
- BRANCH COVERAGE: 81.82% -- 90/110 branches in 12 files
|
|
69
|
+
- 81.82% documented
|
|
70
|
+
|
|
71
|
+
### Added
|
|
72
|
+
|
|
73
|
+
- Added `OmniAuth::Identity::VERSION` as the traditional public version
|
|
74
|
+
constant, in addition to `OmniAuth::Identity::Version::VERSION`.
|
|
75
|
+
|
|
76
|
+
### Changed
|
|
77
|
+
|
|
78
|
+
- Refreshed generated package metadata, support documentation, CI workflows,
|
|
79
|
+
and development dependency floors from the current kettle-jem template.
|
|
80
|
+
- Made identity model and secure password configuration accessors synchronized
|
|
81
|
+
so concurrent callers do not race while reading or updating authentication
|
|
82
|
+
keys, ROM adapter settings, or BCrypt minimum-cost mode.
|
|
83
|
+
|
|
84
|
+
### Fixed
|
|
85
|
+
|
|
86
|
+
- Made local `kettle-test` runs skip CouchDB, MongoDB, and RethinkDB adapter
|
|
87
|
+
specs by default unless the matching service adapter environment variable is enabled.
|
|
88
|
+
- Updated ORM adapter specs to exercise concrete ActiveRecord and Mongoid model classes.
|
|
89
|
+
|
|
90
|
+
### Security
|
|
91
|
+
|
|
92
|
+
- Added `auth-sanitizer` integration so identity model `#inspect` output
|
|
93
|
+
filters password-related attributes by default.
|
|
94
|
+
|
|
33
95
|
## [3.1.5] - 2025-10-13
|
|
34
96
|
|
|
35
97
|
- TAG: [v3.1.5][3.1.5t]
|
|
@@ -334,7 +396,11 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
334
396
|
- Gemfile.lock file
|
|
335
397
|
- MongoMapper support; unable to satisfy dependencies of both MongoMapper and Mongoid now that MongoMapper is no longer actively maintained.
|
|
336
398
|
|
|
337
|
-
[Unreleased]: https://github.com/omniauth/omniauth-identity/compare/v3.1
|
|
399
|
+
[Unreleased]: https://github.com/omniauth/omniauth-identity/compare/v3.2.1...HEAD
|
|
400
|
+
[3.2.1]: https://github.com/omniauth/omniauth-identity/compare/v3.2.0...v3.2.1
|
|
401
|
+
[3.2.1t]: https://github.com/omniauth/omniauth-identity/releases/tag/v3.2.1
|
|
402
|
+
[3.2.0]: https://github.com/omniauth/omniauth-identity/compare/v3.1.5...v3.2.0
|
|
403
|
+
[3.2.0t]: https://github.com/omniauth/omniauth-identity/releases/tag/v3.2.0
|
|
338
404
|
[3.1.5]: https://github.com/omniauth/omniauth-identity/compare/v3.1.4...v3.1.5
|
|
339
405
|
[3.1.5t]: https://github.com/omniauth/omniauth-identity/releases/tag/v3.1.5
|
|
340
406
|
[3.1.4]: https://github.com/omniauth/omniauth-identity/compare/v3.1.3...v3.1.4
|
data/CITATION.cff
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
cff-version: 1.2.0
|
|
2
|
-
title: omniauth-identity
|
|
2
|
+
title: "omniauth-identity"
|
|
3
3
|
message: >-
|
|
4
4
|
If you use this work and you want to cite it,
|
|
5
5
|
then you can use the metadata from this file.
|
|
6
6
|
type: software
|
|
7
7
|
authors:
|
|
8
|
-
- given-names: Peter
|
|
9
|
-
family-names: Boling
|
|
10
|
-
email:
|
|
11
|
-
affiliation:
|
|
8
|
+
- given-names: "Peter H."
|
|
9
|
+
family-names: "Boling"
|
|
10
|
+
email: "floss@galtzo.com"
|
|
11
|
+
affiliation: "galtzo.com"
|
|
12
12
|
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
13
|
identifiers:
|
|
14
14
|
- type: url
|
|
15
15
|
value: 'https://github.com/omniauth/omniauth-identity'
|
|
16
|
-
description: omniauth-identity
|
|
16
|
+
description: "omniauth-identity"
|
|
17
17
|
repository-code: 'https://github.com/omniauth/omniauth-identity'
|
|
18
18
|
abstract: >-
|
|
19
19
|
omniauth-identity
|
data/CONTRIBUTING.md
CHANGED
|
@@ -8,47 +8,62 @@ To submit a patch, please fork the project, create a patch with tests, and send
|
|
|
8
8
|
|
|
9
9
|
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
10
10
|
|
|
11
|
+
## Developer Certificate of Origin
|
|
12
|
+
|
|
13
|
+
In order to protect users of this project, we require all contributors to comply with the
|
|
14
|
+
[Developer Certificate of Origin](https://developercertificate.org/).
|
|
15
|
+
This ensures that all contributions are properly licensed and attributed.
|
|
16
|
+
|
|
11
17
|
## Help out!
|
|
12
18
|
|
|
13
|
-
Take a look at the
|
|
19
|
+
Take a look at the open issues and pull requests, or use the gem and find something to improve.
|
|
14
20
|
|
|
15
21
|
Follow these instructions:
|
|
16
22
|
|
|
17
|
-
1.
|
|
18
|
-
2.
|
|
19
|
-
3.
|
|
20
|
-
4.
|
|
21
|
-
5.
|
|
22
|
-
6.
|
|
23
|
-
7.
|
|
23
|
+
1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
24
|
+
2. Fork the repository
|
|
25
|
+
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
26
|
+
4. Make some fixes.
|
|
27
|
+
5. Commit your changes (`git commit -am 'Added some feature'`)
|
|
28
|
+
6. Push to the branch (`git push origin my-new-feature`)
|
|
29
|
+
7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
30
|
+
8. Create new Pull Request.
|
|
31
|
+
9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
|
|
24
32
|
|
|
25
33
|
## Executables vs Rake tasks
|
|
26
34
|
|
|
27
|
-
Executables shipped by
|
|
28
|
-
|
|
35
|
+
Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
|
|
36
|
+
after running `bin/setup`. These include:
|
|
29
37
|
|
|
38
|
+
- gem_checksums
|
|
30
39
|
- kettle-changelog
|
|
31
40
|
- kettle-commit-msg
|
|
32
|
-
-
|
|
41
|
+
- kettle-dev-setup
|
|
33
42
|
- kettle-dvcs
|
|
34
43
|
- kettle-pre-release
|
|
35
44
|
- kettle-readme-backers
|
|
36
45
|
- kettle-release
|
|
37
46
|
|
|
38
|
-
|
|
39
|
-
See the full list of rake tasks in head of Rakefile
|
|
47
|
+
There are many Rake tasks available as well. You can see them by running:
|
|
40
48
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
group :development do
|
|
44
|
-
gem "omniauth-identity", require: false
|
|
45
|
-
end
|
|
49
|
+
```shell
|
|
50
|
+
bin/rake -T
|
|
46
51
|
```
|
|
47
52
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
53
|
+
## Code quality checks
|
|
54
|
+
|
|
55
|
+
Run the Reek task when you want a smell check that fails on current findings:
|
|
56
|
+
|
|
57
|
+
```shell
|
|
58
|
+
bin/rake reek
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
|
|
62
|
+
the raw `reek` executable output. The rake task uses the project bundle and
|
|
63
|
+
avoids stale generated binstubs shadowing the Reek gem executable:
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
bin/rake reek:update
|
|
52
67
|
```
|
|
53
68
|
|
|
54
69
|
## Environment Variables for Local Development
|
|
@@ -61,7 +76,7 @@ General/runtime
|
|
|
61
76
|
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
62
77
|
|
|
63
78
|
Coverage (kettle-soup-cover / SimpleCov)
|
|
64
|
-
- K_SOUP_COV_DO: Enable coverage collection (default: true in .
|
|
79
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
|
|
65
80
|
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
66
81
|
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
67
82
|
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
@@ -77,7 +92,9 @@ GitHub API and CI helpers
|
|
|
77
92
|
Releasing and signing
|
|
78
93
|
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
79
94
|
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
80
|
-
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
95
|
+
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
96
|
+
- `kettle-release` will set this automatically for the session.
|
|
97
|
+
- Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
|
|
81
98
|
|
|
82
99
|
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
83
100
|
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
@@ -85,99 +102,69 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
|
85
102
|
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
86
103
|
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
87
104
|
|
|
88
|
-
|
|
105
|
+
Git diff driver setup
|
|
106
|
+
- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
|
|
107
|
+
- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
|
|
108
|
+
- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
|
|
109
|
+
- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
|
|
110
|
+
|
|
111
|
+
```console
|
|
112
|
+
K_JEM_TEMPLATING=true kettle-jem install
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Troubleshooting Git diffs
|
|
116
|
+
- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
|
|
117
|
+
- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
|
|
118
|
+
- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
|
|
119
|
+
- To remove managed local entries, run `K_JEM_TEMPLATING=true kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
|
|
120
|
+
|
|
121
|
+
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
|
|
89
122
|
|
|
90
123
|
## Appraisals
|
|
91
124
|
|
|
92
125
|
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
126
|
+
Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
|
|
127
|
+
in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4`.
|
|
128
|
+
That value describes the lowest Ruby version expected to run the test/development
|
|
129
|
+
toolchain, and it may be higher than the gemspec runtime floor.
|
|
130
|
+
|
|
93
131
|
They are created and updated with the commands:
|
|
94
132
|
|
|
95
133
|
```console
|
|
96
|
-
bin/rake appraisal:
|
|
134
|
+
bin/rake appraisal:generate
|
|
97
135
|
```
|
|
98
136
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
## The Reek List
|
|
102
|
-
|
|
103
|
-
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
137
|
+
Use `bin/rake appraisal:update` when you intentionally need to resolve fresh
|
|
138
|
+
appraisal locks.
|
|
104
139
|
|
|
105
|
-
|
|
140
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
106
141
|
|
|
107
142
|
```console
|
|
108
|
-
|
|
143
|
+
bin/rake appraisal:reset
|
|
109
144
|
```
|
|
110
145
|
|
|
146
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
147
|
+
|
|
111
148
|
## Run Tests
|
|
112
149
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
```console
|
|
117
|
-
brew install rethinkdb
|
|
118
|
-
rethinkdb
|
|
119
|
-
```
|
|
120
|
-
2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
|
|
121
|
-
```console
|
|
122
|
-
brew tap mongodb/brew
|
|
123
|
-
brew install mongodb-community@4.4
|
|
124
|
-
mongod --config /usr/local/etc/mongod.conf
|
|
125
|
-
```
|
|
126
|
-
3. [CouchDB](https://couchdb.apache.org) - download the .app, or:
|
|
127
|
-
```console
|
|
128
|
-
brew install couchdb
|
|
129
|
-
```
|
|
130
|
-
CouchDB 3.x requires a set admin password set before startup.
|
|
131
|
-
Add one to your `$HOMEBREW_PREFIX/etc/local.ini` before starting CouchDB e.g.:
|
|
132
|
-
```ini
|
|
133
|
-
[admins]
|
|
134
|
-
admin = yourabsolutesecret
|
|
135
|
-
```
|
|
136
|
-
Also add whatever password you set to your `.env.local`:
|
|
137
|
-
```dotenv
|
|
138
|
-
export COUCHDB_PASSWORD=yourabsolutesecret
|
|
139
|
-
```
|
|
140
|
-
Then start the CouchDB service
|
|
141
|
-
```console
|
|
142
|
-
brew services start couchdb
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
Now you can run any of the tests!
|
|
146
|
-
|
|
147
|
-
To run all tests on all databases (except RethinkDB):
|
|
148
|
-
```console
|
|
149
|
-
bundle exec rake spec:orm:all
|
|
150
|
-
```
|
|
150
|
+
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
151
|
+
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
152
|
+
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
151
153
|
|
|
152
|
-
To run all tests that do not require any additional services, i.e. excluding MongoDB, CouchDB, & RethinkDB:
|
|
153
154
|
```console
|
|
154
|
-
bundle exec
|
|
155
|
+
bundle exec kettle-test
|
|
155
156
|
```
|
|
156
157
|
|
|
157
|
-
|
|
158
|
-
```console
|
|
159
|
-
# CouchDB / CouchPotato
|
|
160
|
-
bundle exec rspec spec spec_orms --tag 'couchdb'
|
|
161
|
-
|
|
162
|
-
# ActiveRecord and Sequel, as they both use the in-memory SQLite driver.
|
|
163
|
-
bundle exec rspec spec spec_orms --tag 'sqlite3'
|
|
158
|
+
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
164
159
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
# MongoDB / Mongoid
|
|
169
|
-
bundle exec rspec spec_orms/mongoid_spec.rb
|
|
170
|
-
|
|
171
|
-
# RethinkDB / NoBrainer (Ignored by CI! see spec file for reasons)
|
|
172
|
-
bundle exec rspec spec_ignored/nobrainer_spec.rb
|
|
160
|
+
```console
|
|
161
|
+
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
173
162
|
```
|
|
174
163
|
|
|
175
164
|
### Spec organization (required)
|
|
176
165
|
|
|
177
|
-
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/omniauth/identity
|
|
178
|
-
- Never add a second spec file for the same class/module. Examples of disallowed names: `*_more_spec.rb`, `*_extra_spec.rb`, `*_status_spec.rb`, or any other suffix that still targets the same class. If you find yourself wanting a second file, merge those examples into the canonical spec file for that class/module.
|
|
166
|
+
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/omniauth/identity/my_class.rb` -> `spec/omniauth/identity/my_class_spec.rb`.
|
|
179
167
|
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
|
|
180
|
-
- Migration note: If a duplicate spec file exists, move all examples into the canonical file and delete the duplicate. Do not leave stubs or empty files behind.
|
|
181
168
|
|
|
182
169
|
## Lint It
|
|
183
170
|
|
|
@@ -200,7 +187,7 @@ For more detailed information about using RuboCop in this project, please see th
|
|
|
200
187
|
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
201
188
|
|
|
202
189
|
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
203
|
-
- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
190
|
+
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
204
191
|
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
205
192
|
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
206
193
|
|
|
@@ -235,39 +222,41 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
|
|
|
235
222
|
1. Update version.rb to contain the correct version-to-be-released.
|
|
236
223
|
2. Run `bundle exec kettle-changelog`.
|
|
237
224
|
3. Run `bundle exec kettle-release`.
|
|
225
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
238
226
|
|
|
239
227
|
#### Manual process
|
|
240
228
|
|
|
241
229
|
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
242
230
|
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
243
231
|
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
244
|
-
4. Run `
|
|
245
|
-
5. Run `git
|
|
232
|
+
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
233
|
+
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
234
|
+
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
246
235
|
- NOTE: Remember to [check the build][🧪build].
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
236
|
+
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
237
|
+
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
238
|
+
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
239
|
+
10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
|
|
251
240
|
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
252
241
|
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
253
242
|
- If the echo above has no output, then it didn't work.
|
|
254
243
|
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
255
244
|
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
256
|
-
|
|
257
|
-
|
|
245
|
+
11. Run `bundle exec rake build`
|
|
246
|
+
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
258
247
|
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
259
248
|
[gem][💎stone_checksums].
|
|
260
249
|
- The script automatically commits but does not push the checksums
|
|
261
|
-
|
|
250
|
+
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
262
251
|
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
263
|
-
|
|
252
|
+
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
264
253
|
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
265
254
|
|
|
266
|
-
[📜src-gl]: https://gitlab.com/omniauth/omniauth-identity
|
|
255
|
+
[📜src-gl]: https://gitlab.com/omniauth/omniauth-identity
|
|
267
256
|
[📜src-cb]: https://codeberg.org/omniauth/omniauth-identity
|
|
268
257
|
[📜src-gh]: https://github.com/omniauth/omniauth-identity
|
|
269
258
|
[🧪build]: https://github.com/omniauth/omniauth-identity/actions
|
|
270
|
-
[🤝conduct]: https://
|
|
259
|
+
[🤝conduct]: https://github.com/omniauth/omniauth-identity/blob/main/CODE_OF_CONDUCT.md
|
|
271
260
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
272
261
|
[🖐contributors]: https://github.com/omniauth/omniauth-identity/graphs/contributors
|
|
273
262
|
[🚎contributors-gl]: https://gitlab.com/omniauth/omniauth-identity/-/graphs/main
|
|
@@ -283,3 +272,4 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
|
|
|
283
272
|
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
284
273
|
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
285
274
|
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
275
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
data/FUNDING.md
CHANGED
|
@@ -4,20 +4,20 @@ Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉
|
|
|
4
4
|
|
|
5
5
|
Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
|
|
6
6
|
|
|
7
|
-
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal]
|
|
7
|
+
[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal]
|
|
8
8
|
|
|
9
|
-
[![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate
|
|
9
|
+
[![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
10
10
|
|
|
11
11
|
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
12
12
|
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
13
|
+
[🖇osc-backers]: https://opencollective.com/omniauth#backer
|
|
14
|
+
[🖇osc-backers-i]: https://opencollective.com/omniauth/backers/badge.svg?style=flat
|
|
15
|
+
[🖇osc-sponsors]: https://opencollective.com/omniauth#sponsor
|
|
16
|
+
[🖇osc-sponsors-i]: https://opencollective.com/omniauth/sponsors/badge.svg?style=flat
|
|
13
17
|
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
14
18
|
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
15
|
-
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
16
|
-
[🖇polar]: https://polar.sh/pboling
|
|
17
19
|
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
18
|
-
[🖇kofi]: https://ko-fi.com/
|
|
19
|
-
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
20
|
-
[🖇patreon]: https://patreon.com/galtzo
|
|
20
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
21
21
|
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
22
22
|
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
23
23
|
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
@@ -27,11 +27,11 @@ Many paths lead to being a sponsor or a backer of this project. Are you on such
|
|
|
27
27
|
|
|
28
28
|
<!-- RELEASE-NOTES-FOOTER-END -->
|
|
29
29
|
|
|
30
|
-
# 🤑
|
|
30
|
+
# 🤑 A request for help
|
|
31
31
|
|
|
32
32
|
Maintainers have teeth and need to pay their dentists.
|
|
33
|
-
After getting laid off in an RIF in March and
|
|
34
|
-
I
|
|
33
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
34
|
+
I began spending most of my time building open source tools.
|
|
35
35
|
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
36
36
|
so if you value the work I am doing, I need your support.
|
|
37
37
|
Please consider sponsoring me or the project.
|
|
@@ -40,16 +40,13 @@ To join the community or get help 👇️ Join the Discord.
|
|
|
40
40
|
|
|
41
41
|
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
42
42
|
|
|
43
|
-
To say "thanks
|
|
43
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
44
44
|
|
|
45
|
-
[![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay
|
|
45
|
+
[![Sponsor omniauth/omniauth-identity on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
|
|
46
46
|
|
|
47
47
|
# Another Way to Support Open Source Software
|
|
48
48
|
|
|
49
|
-
|
|
50
|
-
>—Anne Frank
|
|
51
|
-
|
|
52
|
-
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
|
|
49
|
+
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
|
|
53
50
|
|
|
54
51
|
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
|
|
55
52
|
|
|
@@ -58,6 +55,13 @@ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed
|
|
|
58
55
|
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
59
56
|
|
|
60
57
|
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
58
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/omniauth
|
|
59
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/omniauth
|
|
60
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/omniauth
|
|
61
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/omniauth?style=for-the-badge
|
|
62
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/omniauth?style=for-the-badge
|
|
63
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/omniauth?style=for-the-badge
|
|
64
|
+
[🖇osc]: https://opencollective.com/omniauth
|
|
61
65
|
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
62
66
|
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
|
63
67
|
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
data/LICENSE.md
ADDED
data/MIT.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
See [LICENSE.md](LICENSE.md) for the copyright notice.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|