active_cabinet 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 +4 -4
- data/README.md +18 -6
- data/lib/active_cabinet/version.rb +1 -1
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9adb36f6d291c160a960599e7de79f3f9d08afb3f1536364dfc57c103d81254f
|
|
4
|
+
data.tar.gz: 5a4bfd4907203cb963f1b7102b14701dcfbcefe44fb8dc2e7f0d4ab87af2f03b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b4df4f37043c8285d3333e21161d4a681f375a8a80e63a57f1c0f797bbd6669617e95d4ccdee653aac9ed7bd488dfe4f10ebe00477c147f0c47c4185415e7a42
|
|
7
|
+
data.tar.gz: f76c0f806f6aa0d14c392243cea42585ef108daf8a059659344893a21eee7044d0420bc39045eb39c20effe6ebccdfde9d59b664a5393209598837fa08c7eb45
|
data/README.md
CHANGED
|
@@ -1,14 +1,20 @@
|
|
|
1
1
|
ActiveCabinet
|
|
2
2
|
==================================================
|
|
3
3
|
|
|
4
|
+
[](https://badge.fury.io/rb/active_cabinet)
|
|
5
|
+
[](https://github.com/DannyBen/active_cabinet/actions?query=workflow%3ATest)
|
|
6
|
+
[](https://codeclimate.com/github/DannyBen/active_cabinet/maintainability)
|
|
7
|
+
|
|
4
8
|
---
|
|
5
9
|
|
|
6
|
-
|
|
10
|
+
An ActiveRecord-inspired interface for [HashCabinet], the
|
|
7
11
|
file-basd key-object store.
|
|
8
12
|
|
|
9
13
|
It allows you to create models that are stored in a file-based key-value
|
|
10
14
|
store, backed by Ruby's built in [SDBM].
|
|
11
15
|
|
|
16
|
+
ActiveCabinet is a tiny library, with only [HashCabinet] as a dependency.
|
|
17
|
+
|
|
12
18
|
---
|
|
13
19
|
|
|
14
20
|
Installation
|
|
@@ -83,7 +89,7 @@ song.valid? # => true
|
|
|
83
89
|
|
|
84
90
|
You can also restrict the allowed optional attributes
|
|
85
91
|
|
|
86
|
-
```
|
|
92
|
+
```ruby
|
|
87
93
|
class Song < ActiveCabinet
|
|
88
94
|
required_attributes :title
|
|
89
95
|
optional_attributes :artist
|
|
@@ -125,12 +131,18 @@ class Song < ActiveCabinet
|
|
|
125
131
|
end
|
|
126
132
|
```
|
|
127
133
|
|
|
128
|
-
|
|
134
|
+
## Documentation
|
|
129
135
|
|
|
136
|
+
[Documentation on RubyDoc][docs]
|
|
130
137
|
|
|
131
|
-
|
|
132
|
-
|
|
138
|
+
## Contributing / Support
|
|
139
|
+
|
|
140
|
+
If you experience any issue, have a question or a suggestion, or if you wish
|
|
141
|
+
to contribute, feel free to [open an issue][issues].
|
|
133
142
|
|
|
134
143
|
---
|
|
135
144
|
|
|
136
|
-
[SDBM]: https://ruby-doc.org/stdlib-2.7.1/libdoc/sdbm/rdoc/SDBM.html
|
|
145
|
+
[SDBM]: https://ruby-doc.org/stdlib-2.7.1/libdoc/sdbm/rdoc/SDBM.html
|
|
146
|
+
[docs]: https://rubydoc.info/gems/active_cabinet
|
|
147
|
+
[issues]: https://github.com/DannyBen/active_cabinet/issues
|
|
148
|
+
[HashCabinet]: https://github.com/DannyBen/hash_cabinet
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: active_cabinet
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Danny Ben Shitrit
|
|
@@ -39,7 +39,10 @@ files:
|
|
|
39
39
|
homepage: https://github.com/dannyben/active_cabinet
|
|
40
40
|
licenses:
|
|
41
41
|
- MIT
|
|
42
|
-
metadata:
|
|
42
|
+
metadata:
|
|
43
|
+
bug_tracker_uri: https://github.com/DannyBen/active_cabinet/issues
|
|
44
|
+
documentation_uri: https://rubydoc.info/gems/active_cabinet
|
|
45
|
+
source_code_uri: https://github.com/dannyben/active_cabinet
|
|
43
46
|
post_install_message:
|
|
44
47
|
rdoc_options: []
|
|
45
48
|
require_paths:
|