geode 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1357dd8aadd830b705e45dcee476fdd473222574269373691ff6f91964da95
-  data.tar.gz: 1cc2d1a5129a238c25d89dc75a33c9edacdc79b45d9f7768ffc5912c4068e97d
+  metadata.gz: c0e61d7408e1968eef5ce7ca4f044ba24ad8c60556f0e447fc4c5053b33e3696
+  data.tar.gz: a71f1f43281f5c207b7172ce80317e91608f18c226ec707a4a485c27b3ddc916
 SHA512:
-  metadata.gz: 982b9ab60e0e287bdc79b431074ac3a65afffe306d49e79d99add358a3401babc36ba2a77dca01d92b0f46f1f72c2ce052d3eb52d4fec1a147c7ce70f966e4dc
-  data.tar.gz: 33237585799704b24e0634335d5a84a9cc75ec95340b7d24be6b1befe5a671f27884a82cbfb3099ed1a5a3d5218b3b3f127ae4aea52ec0127d0f8b9c1af7fa34
+  metadata.gz: 85b0de5f20e66ab77782b0a9db839e2888c8f3258335461e20595e8effcab0399b612c1ef53c0cebb34572b7c1d533394dc27a2249919f76570cdb36ad88076a
+  data.tar.gz: aacbdfd3ae417f3b5d17c8a88ff21975604c33e875a16157a6614eb2418971feefd7bc17cacb644dcd13afcd9115279b910c37d1e78a848113a3c06609d6ade9

data/lib/geode.rb

@@ -10,10 +10,39 @@ module Geode
 
     # "Open" the store for reading and/or writing.
     # @yield a block which receives `table` as its sole parameter
-    # @yieldparam table [Hash] The table belonging to `@name`
+    # @yieldparam table [Hash] The store's table. Changes to this Hash will
+    # be persisted in the store
+    # When in doubt, use this method.
+    # @example
+    #   "store.open { |table| table[:key] = 5 }"
+    # @example
+    #   "store.open { |table| table[:key] } #=> 5"
     # @return [Object] The return value of the block
     def open
       raise NotImplementedError
     end
+
+    # "Peek" inside the store, returning a copy of its table.
+    # Changes to this copy will NOT be persisted in the store.
+    # Use this if you simply want to view the store's table.
+    # @example
+    #   "store.peek.key?(:test) #=> false"
+    # @return [Hash] A copy of the store's table
+    def peek
+      open(&:itself)
+    end
+
+    # Retrieve the object at `key` from the store.
+    # This is implemented using `#peek` and therefore
+    # changes to the object returned by this method will NOT
+    # be persisted in the store.
+    # Use this if you simply need to fetch a value from the store.
+    # @example
+    #   "store[:key] #=> 5"
+    # @param key [Object] The key to look up
+    # @return [Object] The object at `key`
+    def [](key)
+      peek[key]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geode
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - biqqles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg