simple_column-scopes 0.1.0 → 0.1.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 +5 -5
- checksums.yaml.gz.sig +2 -0
- data/CHANGELOG.md +56 -0
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +106 -46
- data/CONTRIBUTING.md +227 -0
- data/FUNDING.md +74 -0
- data/LICENSE.txt +1 -1
- data/README.md +557 -28
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +21 -0
- data/lib/simple_column/scopes/version.rb +4 -1
- data/lib/simple_column/scopes.rb +15 -5
- data.tar.gz.sig +0 -0
- metadata +262 -32
- metadata.gz.sig +0 -0
- data/.gitignore +0 -12
- data/.rspec +0 -2
- data/.travis.yml +0 -5
- data/Gemfile +0 -4
- data/Rakefile +0 -6
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/simple_column-scopes.gemspec +0 -27
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: fcc5b22cc47368ff977058013305bc4e99992585ba274a508016ac82802345b5
|
|
4
|
+
data.tar.gz: 11f2caff41c2d5f82aedb74496cf60c349bfb622b04fa07f1cb0d40b5f59e285
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: be6a3b99d1fd21a0003d74f2b0829280deea050a4e76a99591e58df92111cfd502de89972d102611ad0b306157a9a10bda7e103f057e7a314a2fdc8853aa2ab1
|
|
7
|
+
data.tar.gz: 5cefabb91e5e68eb6b32c2099bd6df6c8013d148407628118da8f50f94db9b2c788e30a85b236bbbeb57eb6853a1bae2fa0cfcdd03541e221379eb3e957b0f21
|
checksums.yaml.gz.sig
ADDED
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
|
|
4
|
+
|
|
5
|
+
All notable changes to this project will be documented in this file.
|
|
6
|
+
|
|
7
|
+
The format is based on [Keep a Changelog][📗keep-changelog],
|
|
8
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
|
|
9
|
+
and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
|
|
10
|
+
Please file a bug if you notice a violation of semantic versioning.
|
|
11
|
+
|
|
12
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
13
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
|
|
14
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
15
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
16
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
17
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
18
|
+
|
|
19
|
+
## [Unreleased]
|
|
20
|
+
|
|
21
|
+
### Added
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
|
|
25
|
+
### Deprecated
|
|
26
|
+
|
|
27
|
+
### Removed
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
### Security
|
|
32
|
+
|
|
33
|
+
## [0.1.1] - 2026-02-03
|
|
34
|
+
|
|
35
|
+
- TAG: [v0.1.1][0.1.1t]
|
|
36
|
+
- COVERAGE: 100.00% -- 29/29 lines in 2 files
|
|
37
|
+
- BRANCH COVERAGE: 100.00% -- 2/2 branches in 2 files
|
|
38
|
+
- 50.00% documented
|
|
39
|
+
|
|
40
|
+
### Fixed
|
|
41
|
+
|
|
42
|
+
- circular require
|
|
43
|
+
|
|
44
|
+
## [0.1.0] - 2017-06-20
|
|
45
|
+
|
|
46
|
+
- TAG: [v0.1.0][0.1.0t]
|
|
47
|
+
|
|
48
|
+
### Added
|
|
49
|
+
|
|
50
|
+
- initial release
|
|
51
|
+
|
|
52
|
+
[Unreleased]: https://github.com/galtzo-floss/simple_column-scopes/compare/v0.1.1...HEAD
|
|
53
|
+
[0.1.1]: https://github.com/galtzo-floss/simple_column-scopes/compare/v0.1.0...v0.1.1
|
|
54
|
+
[0.1.1t]: https://github.com/galtzo-floss/simple_column-scopes/releases/tag/v0.1.1
|
|
55
|
+
[0.1.0]: https://github.com/galtzo-floss/simple_column-scopes/compare/f2bce9c56122527d5d035d9f4bc7f7d13a2f8b57...v0.1.0
|
|
56
|
+
[0.1.0t]: https://github.com/galtzo-floss/simple_column-scopes/tags/v0.1.0
|
data/CITATION.cff
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: simple_column-scopes
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this work and you want to cite it,
|
|
5
|
+
then you can use the metadata from this file.
|
|
6
|
+
type: software
|
|
7
|
+
authors:
|
|
8
|
+
- given-names: Peter Hurn
|
|
9
|
+
family-names: Boling
|
|
10
|
+
email: peter@railsbling.com
|
|
11
|
+
affiliation: railsbling.com
|
|
12
|
+
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
|
+
identifiers:
|
|
14
|
+
- type: url
|
|
15
|
+
value: 'https://github.com/galtzo-floss/simple_column-scopes'
|
|
16
|
+
description: simple_column-scopes
|
|
17
|
+
repository-code: 'https://github.com/galtzo-floss/simple_column-scopes'
|
|
18
|
+
abstract: >-
|
|
19
|
+
simple_column-scopes
|
|
20
|
+
license: See license file
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -2,73 +2,133 @@
|
|
|
2
2
|
|
|
3
3
|
## Our Pledge
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
nationality, personal appearance, race, religion, or sexual
|
|
10
|
-
orientation.
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
11
14
|
|
|
12
15
|
## Our Standards
|
|
13
16
|
|
|
14
|
-
Examples of behavior that contributes to
|
|
15
|
-
include:
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
16
19
|
|
|
17
|
-
*
|
|
18
|
-
* Being respectful of differing viewpoints and experiences
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
22
27
|
|
|
23
|
-
Examples of unacceptable behavior
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
24
29
|
|
|
25
|
-
* The use of sexualized language or imagery and
|
|
26
|
-
|
|
27
|
-
* Trolling, insulting
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
28
33
|
* Public or private harassment
|
|
29
|
-
* Publishing others' private information, such as a physical or
|
|
30
|
-
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
31
36
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
37
|
professional setting
|
|
33
38
|
|
|
34
|
-
##
|
|
39
|
+
## Enforcement Responsibilities
|
|
35
40
|
|
|
36
|
-
|
|
37
|
-
behavior and
|
|
38
|
-
response to any
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
39
45
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
threatening, offensive, or harmful.
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
45
50
|
|
|
46
51
|
## Scope
|
|
47
52
|
|
|
48
|
-
This Code of Conduct applies
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
representative at an online or offline event.
|
|
53
|
-
further defined and clarified by project maintainers.
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
54
58
|
|
|
55
59
|
## Enforcement
|
|
56
60
|
|
|
57
61
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
-
reported
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
63
87
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
67
114
|
|
|
68
115
|
## Attribution
|
|
69
116
|
|
|
70
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
71
|
-
available at
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
72
127
|
|
|
73
|
-
[homepage]:
|
|
74
|
-
[
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
133
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
134
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
|
|
4
|
+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
|
+
the [code of conduct][🤝conduct].
|
|
6
|
+
|
|
7
|
+
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
8
|
+
|
|
9
|
+
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
10
|
+
|
|
11
|
+
## Help out!
|
|
12
|
+
|
|
13
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
14
|
+
|
|
15
|
+
Follow these instructions:
|
|
16
|
+
|
|
17
|
+
1. Fork the repository
|
|
18
|
+
2. Create a feature branch (`git checkout -b my-new-feature`)
|
|
19
|
+
3. Make some fixes.
|
|
20
|
+
4. Commit changes (`git commit -am 'Added some feature'`)
|
|
21
|
+
5. Push to the branch (`git push origin my-new-feature`)
|
|
22
|
+
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
23
|
+
7. Create new Pull Request.
|
|
24
|
+
|
|
25
|
+
## Executables vs Rake tasks
|
|
26
|
+
|
|
27
|
+
Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
|
|
28
|
+
after running `bin/setup`. These include:
|
|
29
|
+
|
|
30
|
+
- gem_checksums
|
|
31
|
+
- kettle-changelog
|
|
32
|
+
- kettle-commit-msg
|
|
33
|
+
- kettle-dev-setup
|
|
34
|
+
- kettle-dvcs
|
|
35
|
+
- kettle-pre-release
|
|
36
|
+
- kettle-readme-backers
|
|
37
|
+
- kettle-release
|
|
38
|
+
|
|
39
|
+
There are many Rake tasks available as well. You can see them by running:
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
bin/rake -T
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Environment Variables for Local Development
|
|
46
|
+
|
|
47
|
+
Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
|
|
48
|
+
|
|
49
|
+
General/runtime
|
|
50
|
+
- DEBUG: Enable extra internal logging for this library (default: false)
|
|
51
|
+
- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
|
|
52
|
+
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
53
|
+
|
|
54
|
+
Coverage (kettle-soup-cover / SimpleCov)
|
|
55
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
|
|
56
|
+
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
57
|
+
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
58
|
+
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
59
|
+
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
|
|
60
|
+
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
|
|
61
|
+
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
|
|
62
|
+
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
|
|
63
|
+
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
|
|
64
|
+
|
|
65
|
+
GitHub API and CI helpers
|
|
66
|
+
- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
|
|
67
|
+
|
|
68
|
+
Releasing and signing
|
|
69
|
+
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
70
|
+
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
71
|
+
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
72
|
+
- `kettle-release` will set this automatically for the session.
|
|
73
|
+
- Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
|
|
74
|
+
|
|
75
|
+
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
76
|
+
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
77
|
+
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
|
|
78
|
+
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
79
|
+
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
80
|
+
|
|
81
|
+
For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
|
|
82
|
+
|
|
83
|
+
## Appraisals
|
|
84
|
+
|
|
85
|
+
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
86
|
+
They are created and updated with the commands:
|
|
87
|
+
|
|
88
|
+
```console
|
|
89
|
+
bin/rake appraisal:update
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
93
|
+
|
|
94
|
+
```console
|
|
95
|
+
bin/rake appraisal:reset
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
99
|
+
|
|
100
|
+
## The Reek List
|
|
101
|
+
|
|
102
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
103
|
+
|
|
104
|
+
To refresh the `reek` list:
|
|
105
|
+
|
|
106
|
+
```console
|
|
107
|
+
bundle exec reek > REEK
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Run Tests
|
|
111
|
+
|
|
112
|
+
To run all tests
|
|
113
|
+
|
|
114
|
+
```console
|
|
115
|
+
bundle exec rake test
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Spec organization (required)
|
|
119
|
+
|
|
120
|
+
- 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/simple_column/scopes/my_class.rb` -> `spec/simple_column/scopes/my_class_spec.rb`.
|
|
121
|
+
- 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.
|
|
122
|
+
|
|
123
|
+
## Lint It
|
|
124
|
+
|
|
125
|
+
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
126
|
+
|
|
127
|
+
```console
|
|
128
|
+
bundle exec rake
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Or just run the linter.
|
|
132
|
+
|
|
133
|
+
```console
|
|
134
|
+
bundle exec rake rubocop_gradual:autocorrect
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
138
|
+
|
|
139
|
+
### Important: Do not add inline RuboCop disables
|
|
140
|
+
|
|
141
|
+
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:
|
|
142
|
+
|
|
143
|
+
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
144
|
+
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
145
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
146
|
+
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
147
|
+
|
|
148
|
+
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
149
|
+
|
|
150
|
+
## Contributors
|
|
151
|
+
|
|
152
|
+
Your picture could be here!
|
|
153
|
+
|
|
154
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
155
|
+
|
|
156
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
157
|
+
|
|
158
|
+
Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/simple_column-scopes/-/graphs/main][🚎contributors-gl]
|
|
159
|
+
|
|
160
|
+
## For Maintainers
|
|
161
|
+
|
|
162
|
+
### One-time, Per-maintainer, Setup
|
|
163
|
+
|
|
164
|
+
**IMPORTANT**: To sign a build,
|
|
165
|
+
a public key for signing gems will need to be picked up by the line in the
|
|
166
|
+
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
167
|
+
All releases are signed releases.
|
|
168
|
+
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
169
|
+
|
|
170
|
+
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
171
|
+
|
|
172
|
+
### To release a new version:
|
|
173
|
+
|
|
174
|
+
#### Automated process
|
|
175
|
+
|
|
176
|
+
1. Update version.rb to contain the correct version-to-be-released.
|
|
177
|
+
2. Run `bundle exec kettle-changelog`.
|
|
178
|
+
3. Run `bundle exec kettle-release`.
|
|
179
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
180
|
+
|
|
181
|
+
#### Manual process
|
|
182
|
+
|
|
183
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
184
|
+
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
185
|
+
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
186
|
+
4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
187
|
+
5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
188
|
+
- NOTE: Remember to [check the build][🧪build].
|
|
189
|
+
6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
190
|
+
7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
191
|
+
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
192
|
+
9. 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
|
|
193
|
+
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
194
|
+
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
195
|
+
- If the echo above has no output, then it didn't work.
|
|
196
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
197
|
+
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
198
|
+
10. Run `bundle exec rake build`
|
|
199
|
+
11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
200
|
+
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
201
|
+
[gem][💎stone_checksums].
|
|
202
|
+
- The script automatically commits but does not push the checksums
|
|
203
|
+
12. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
204
|
+
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
205
|
+
13. Run `bundle exec rake release` which will create a git tag for the version,
|
|
206
|
+
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
207
|
+
|
|
208
|
+
[📜src-gl]: https://gitlab.com/galtzo-floss/simple_column-scopes/
|
|
209
|
+
[📜src-cb]: https://codeberg.org/galtzo-floss/simple_column-scopes
|
|
210
|
+
[📜src-gh]: https://github.com/galtzo-floss/simple_column-scopes
|
|
211
|
+
[🧪build]: https://github.com/galtzo-floss/simple_column-scopes/actions
|
|
212
|
+
[🤝conduct]: https://gitlab.com/galtzo-floss/simple_column-scopes/-/blob/main/CODE_OF_CONDUCT.md
|
|
213
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
214
|
+
[🖐contributors]: https://github.com/galtzo-floss/simple_column-scopes/graphs/contributors
|
|
215
|
+
[🚎contributors-gl]: https://gitlab.com/galtzo-floss/simple_column-scopes/-/graphs/main
|
|
216
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/simple_column-scopes
|
|
217
|
+
[💎gem-coop]: https://gem.coop
|
|
218
|
+
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
219
|
+
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
220
|
+
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
221
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
222
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
223
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
224
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
225
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
226
|
+
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
227
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
data/FUNDING.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
<!-- RELEASE-NOTES-FOOTER-START -->
|
|
2
|
+
|
|
3
|
+
Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
4
|
+
|
|
5
|
+
Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
|
|
6
|
+
|
|
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
|
+
|
|
9
|
+
[![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
|
|
10
|
+
|
|
11
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
12
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
13
|
+
[🖇osc-backers]: https://opencollective.com/galtzo-floss#backer
|
|
14
|
+
[🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
|
|
15
|
+
[🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
|
|
16
|
+
[🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/sponsors/badge.svg?style=flat
|
|
17
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
18
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
19
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
20
|
+
[🖇polar]: https://polar.sh/pboling
|
|
21
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
22
|
+
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
|
23
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
24
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
25
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
26
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
27
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
28
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
29
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
30
|
+
[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
|
|
31
|
+
|
|
32
|
+
<!-- RELEASE-NOTES-FOOTER-END -->
|
|
33
|
+
|
|
34
|
+
# 🤑 A request for help
|
|
35
|
+
|
|
36
|
+
Maintainers have teeth and need to pay their dentists.
|
|
37
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
38
|
+
I began spending most of my time building open source tools.
|
|
39
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
40
|
+
so if you value the work I am doing, I need your support.
|
|
41
|
+
Please consider sponsoring me or the project.
|
|
42
|
+
|
|
43
|
+
To join the community or get help 👇️ Join the Discord.
|
|
44
|
+
|
|
45
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
46
|
+
|
|
47
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
48
|
+
|
|
49
|
+
[![Sponsor galtzo-floss/simple_column-scopes 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]
|
|
50
|
+
|
|
51
|
+
# Another Way to Support Open Source Software
|
|
52
|
+
|
|
53
|
+
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).
|
|
54
|
+
|
|
55
|
+
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`.
|
|
56
|
+
|
|
57
|
+
I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
|
|
58
|
+
|
|
59
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
60
|
+
|
|
61
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
62
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/galtzo-floss
|
|
63
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
|
|
64
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
|
|
65
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
|
|
66
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
|
|
67
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
|
|
68
|
+
[🖇osc]: https://opencollective.com/galtzo-floss
|
|
69
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
70
|
+
[🖇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
|
|
71
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
72
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
73
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
74
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
|
data/LICENSE.txt
CHANGED