persisted_hash 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bf7c2de5bc646c5a5a8c54e72d256bd33163ecf
-  data.tar.gz: 4a614a0c554b9c74e237d48ac0512feb79f96feb
+  metadata.gz: dbcfc87af10f53d1290169f4daca8d60c4e7e530
+  data.tar.gz: 80cab411cb7b1fb8c7b84172b82ca8d3b23b5be0
 SHA512:
-  metadata.gz: c06704a5bcbff3983ec8782153816a3d948ab34036186f49f90cc46d6d242a7828e0b6af9e5aa18f4516c4d35d19e0769690d15d9c730397a12464469bcfa478
-  data.tar.gz: fa842ef95726e65aa8fdd405b92095dcbb8469dd936cb2e9dc5622f2ed9550c367d2fc3758d6cd1094a3791fee477dac4e9edfc0f770a81d29daa9b9b5e3fff7
+  metadata.gz: 19734863251e5a350133dd8ef6c0a72838d26fe3ee305209e0b688e09ffa2b53043f789ed8f6dad03e8417d11583c79f2d05c7bf15c4d1bacdf9920f484ac141
+  data.tar.gz: 615c058a6b6106c2209ddfb4bf6a6eab0cbdc71764b977af505902231e3cbb20f21217fee04f5e561dd3251ee8852f3ff0fb3536872c3db145c0f939d90e340a

data/README.md

@@ -0,0 +1,41 @@
+This was originally written in [gemmy](http://github.com/maxpleaner/gemmy) but was extracted to a gem.
+
+It's on rubygems. To install `gem install persisted_hash` and `require 'persisted_hash'` as expected.
+
+There are three potential ways to create a 'persisted hash':
+
+1. via a global patch on hash
+2. via a scoped refinement on hash
+3. functionally, via class method
+
+Globally:
+
+```rb
+Hash.include PersistedHash
+hash = {}.persisted("path.yaml")
+```
+
+Refinements:
+
+```rb
+class MyClass
+  using PersistedHash
+  hash = {}.persisted("path.yaml")
+end
+```
+
+Functionally:
+
+```rb
+hash = PersistedHash.new({})
+```
+The API to interact with the persisted hash is as follows:
+
+- `get(*keys)` reads
+- `set(*keys)` writes
+- `data` get all
+- `set_state(hash)` overwrite
+- `clear` empty
+
+The persisted object inherits from hash, so methods like `[]` can still be called.
+They'll just work on the in-memory version, though. 

data/lib/persisted_hash.rb

@@ -4,12 +4,12 @@ module PersistedHash
 
   using Gemmy.patch("hash/i/persisted")
 
-  def self.persisted_hash(hash, *args)
+  def self.new(hash, *args)
     hash.persisted *args
   end
 
   def persisted(*args)
-    PersistedHash.persisted_hash self, *args
+    PersistedHash.new self, *args
   end
 
   refine Hash do

data/lib/version.rb

@@ -1,3 +1,3 @@
 module PersistedHash
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: persisted_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - maxpleaner
@@ -31,6 +31,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/persisted_hash
 - lib/persisted_hash.rb
 - lib/version.rb