redis-rbs 0.1.0
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 +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +31 -0
- data/sig/redis.rbs +1369 -0
- metadata +66 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: ed827e176cef22013f927fbe5c721fd18e3c571f09b098a8d2e10a366f7bdc4c
|
|
4
|
+
data.tar.gz: e958c0ed9470e4c2e106109b72af38e2fce8fc0757cdb2eb05bab8127616c32f
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 4f060cafd028469cb7859334442fb1adde084e2bcd4e3fee15643724900f21ea2e087e16cde854d25d6cefd4c189203ca7683dc0b40171f4c14c4cc309373034
|
|
7
|
+
data.tar.gz: 5dc188e70b22dca5ea4412138ec2da0c6478e5b226d30aa9d3951dd8cc8d2282c7e617b63d35f68610348ebebf00d49bb21e3170424f3892b00a0cadde091f54
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ldebortoli
|
|
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 all
|
|
13
|
+
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 THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# redis-rbs
|
|
2
|
+
|
|
3
|
+
Generated RBS signatures for [`redis-rb`](https://github.com/redis/redis-rb).
|
|
4
|
+
|
|
5
|
+
Version `0.1.x` targets `redis >= 5.4.0, < 5.5`. It covers the concrete client, command modules, pipelines, futures, subscriptions, distributed support and auxiliary classes shipped by Redis 5.4.1. The older community signature collection for Redis 4.2 was used only as historical reference because Redis 5.x has a different client architecture and API surface.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem "redis", "~> 5.4.1"
|
|
11
|
+
gem "redis-rbs", "~> 0.1.0", require: false
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
RBS, Steep and compatible editors discover the `.rbs` files from the installed gem's `sig/` directory. This gem adds no runtime behavior and never opens a Redis connection by itself.
|
|
15
|
+
|
|
16
|
+
## Generation and coverage
|
|
17
|
+
|
|
18
|
+
The generator runs RBS's Ruby prototype over every file shipped in `redis` and enriches exact Ruby parameter shapes with the source's YARD parameter and return types. `data/coverage.yml` records the source/signature counts and is checked by the test suite, so a new public or auxiliary method cannot disappear silently.
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
bundle install
|
|
22
|
+
bundle exec rake generate
|
|
23
|
+
bundle exec rake
|
|
24
|
+
bundle exec rake build
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Generated signatures are committed; consumers do not need the generator or network access.
|
|
28
|
+
|
|
29
|
+
## License
|
|
30
|
+
|
|
31
|
+
MIT. Redis and redis-rb names and API facts belong to their respective projects; redis-rb is also distributed under the MIT license.
|