hash_cabinet 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d284b1a7d996a2e750db02e4db77d2be4afb543ae88da7a385174f00f1533b9c
-  data.tar.gz: 270859870c5130c08e057cb7379f74902bf691db52c87ee8dffe592343b7dd14
+  metadata.gz: 4bddfb98bc67f51e3aabf476d95da84990f5e271ad26d404e5f5e2722b95275d
+  data.tar.gz: c4a45182a0becb13ddf7915b8c0aa28c2fd43cd1571185f4afff1da21032f702
 SHA512:
-  metadata.gz: c3e93b6bc0904c02f003b8c913c7d25989d0526e0233bfdd612faedd75cfeb3fd193bf026066371a98fe26a33d8ae4fc4a3c274f0351eb1fbb31f063b609c9c1
-  data.tar.gz: 01d325e99d38b83f73c0e3007d546884af69af974f3193b6908b476ac8cadfb9a10ec16efec49bbd11e75e16aa7886a5e9635128c915ca4be1709f9ec7c93f54
+  metadata.gz: 0ed28a440b890b56a368619450200c89c5b748c63f6fe52223a3c0767c0403d81771587a062c613a8f681dc06f20a708cca5c2fc10f1420eec5965b229a7926f
+  data.tar.gz: '09684dd6832e8a5bb6156c483c7e1a8a0645215394b7d48e288be4ad654ecc6f68ab89b9082329e745eb9f3e338582034397d4b562dbc0daa4c402cd6753d866'

data/README.md

@@ -2,6 +2,8 @@ Hash Cabinet - File based key-object store
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/hash_cabinet.svg)](https://badge.fury.io/rb/hash_cabinet)
+[![Build Status](https://travis-ci.com/DannyBen/hash_cabinet.svg?branch=master)](https://travis-ci.com/DannyBen/hash_cabinet)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c69f9676cd8cd5fc33bc/maintainability)](https://codeclimate.com/github/DannyBen/hash_cabinet/maintainability)
 
 ---
 
@@ -29,10 +31,12 @@ Usage
 --------------------------------------------------
 
 ```ruby
+require 'hash_cabinet'
+
 cabinet = HashCabinet.new 'dbfile'
 
 # Store values
-cabinet['some-key'] = 'some=value'
+cabinet['some-key'] = 'some-value'
 cabinet['another-key'] = { color: 'yellow' }
 
 # Retrieve values
@@ -41,8 +45,50 @@ p cabinet['another-key']
 
 # Show all values
 p cabinet.to_h
-#=> {"some-key"=>"some=value", "another-key"=>{:color=>"yellow"}
+#=> {"some-key"=>"some=value", "another-key"=>{:color=>"yellow"}}
 
 ```
 
-[SDBM]: https://ruby-doc.org/stdlib-2.6.3/libdoc/sdbm/rdoc/SDBM.html
+Quick Reference
+--------------------------------------------------
+
+| Method | Description |
+|--------|-------------|
+| `cabinet.transaction { ... }`       | Yields the `SDBM` object. (like `SDBM.open`) |
+| `cabinet[key]`                      | Returns the value at key |
+| `cabinet[key] = value`              | Saves the value at key |
+| `cabinet.clear`                     | Deletes all data |
+| `cabinet.delete key`                | Deletes a key |
+| `cabinet.delete_if { \|k, v\| ... }`| Deletes keys based on the block result |
+| `cabinet.each { \|k, v\| ... }`     | Iterates over the data |
+| `cabinet.each_key { \|k\| ... }`    | Iterates over the keys |
+| `cabinet.each_value { \|v\| ... }`  | Iterates over the values |
+| `cabinet.emoty?`                    | Returns true if the database is empty |
+| `cabinet.has_key? key`              | Returns true if the key exists | 
+| `cabinet.has_value? value`          | Returns true if the value exists | 
+| `cabinet.include? key`              | Same as `cabinet.has_key?` |
+| `cabinet.key value`                 | Returns the key associated with the value |
+| `cabinet.key? key`                  | Same as `cabinet.has_key?` |
+| `cabinet.keys`                      | Returns all the keys |
+| `cabinet.length`                    | Returns the number of key-value pairs |
+| `cabinet.replace data`              | Reset the database with new data |
+| `cabinet.select { \|k, v\| ... }`   | Returns a hash based on the block result |
+| `cabinet.shift`                     | Removes and returns one key-value pair |
+| `cabinet.size`                      | Same as `cabinet.length` |
+| `cabinet.to_a`                      | Returns an array of `[key, value]` pairs |
+| `cabinet.to_h`                      | Returns a hash with all key-value pairs |
+| `cabinet.update data`               | Insert or update new data |
+| `cabinet.value? value`              | Returns true if the value is in the database |
+| `cabinet.values`                    | Returns an array of all the values |
+| `cabinet.values_at key, ...`        | Returns an array of values corresponding to the given keys |
+
+
+Documentation
+--------------------------------------------------
+
+- [Documentation on RubyDoc][docs]
+
+
+
+[SDBM]: https://ruby-doc.org/stdlib-2.6.3/libdoc/sdbm/rdoc/SDBM.html
+[docs]: https://rubydoc.info/gems/hash_cabinet/HashCabinet

data/lib/hash_cabinet.rb

@@ -3,8 +3,8 @@ require 'yaml'
 
 class HashCabinet
 
-  # Refinements to allow using +from_yaml+ as the opposite of +to_yaml+.
-  module ReverseYAML
+  # Refinements for internal use
+  module Refinements
     refine String do
       def from_yaml
         YAML.load self
@@ -18,7 +18,7 @@ class HashCabinet
     end
   end
 
-  using ReverseYAML
+  using Refinements
 
   # Returns the path to the database file.
   attr_reader :path
@@ -45,12 +45,12 @@ class HashCabinet
 
   # Returns the value in the database associated with the given +key+.
   def [](key)
-    transaction { |db| db[key].from_yaml }
+    transaction { |db| db[key.to_s].from_yaml }
   end
 
   # Inserts or updates a value in the database with the given key as an index.
   def []=(key, value)
-    transaction { |db| db[key] = value.to_yaml }
+    transaction { |db| db[key.to_s] = value.to_yaml }
   end
 
   # Deletes all key-value pairs from the database.
@@ -60,7 +60,7 @@ class HashCabinet
 
   # Deletes the given `key` from the database.
   def delete(key)
-    transaction { |db| db.delete key }
+    transaction { |db| db.delete key.to_s }
   end
 
   # Iterates over the key-value pairs in the database, deleting those for
@@ -81,13 +81,11 @@ class HashCabinet
       end
     end
   end
-
   
   # Iterates over each key in the database.
   def each_key(&block)
     transaction { |db| db.each_key &block }
   end
-
   
   # Iterates over each key-value pair in the database.
   def each_value(&block)
@@ -105,19 +103,16 @@ class HashCabinet
 
   # Returns true if the database contains the given key.
   def has_key?(key)
-    transaction { |db| db.has_key? key }
+    transaction { |db| db.has_key? key.to_s }
   end
+  alias include? has_key?
+  alias key? has_key?
 
   # Returns +true+ if the database contains the given value.
   def has_value?(value)
     transaction { |db| db.has_value? value.to_yaml }
   end
 
-  # Returns +true+ if the database contains the given key.
-  def include?(key)
-    transaction { |db| db.include? key }
-  end
-
   # Returns the key associated with the given value. If more than one key
   # corresponds to the given value, then the first key will be returned.
   # If no keys are found, +nil+ will be returned.
@@ -125,11 +120,6 @@ class HashCabinet
     transaction { |db| db.key value.to_yaml }
   end
 
-  # Returns +true+ if the database contains the given key.
-  def key?(key)
-    transaction { |db| db.key? key }
-  end
-
   # Returns a new Array containing the keys in the database.
   def keys
     transaction { |db| db.keys }
@@ -139,13 +129,21 @@ class HashCabinet
   def length
     transaction { |db| db.length }
   end
+  alias size length
+  alias count length
 
   # Empties the database, then inserts the given key-value pairs.
+  #
   # This method will work with any object which implements an +#each_pair+
-  # method, such as a Hash.
+  # method, such as a Hash, or with any object that implements an +#each+
+  # method, such as an Array. In this case, the array will be converted to 
+  # a `key=key` hash before storing it.
   def replace(data)
-    data = data.transform_values &:to_yaml
-    data = data.transform_keys &:to_s
+    if !data.respond_to? :each_pair and data.respond_to? :each
+      data = array_to_hash data
+    end
+
+    data = normalize_types data
     transaction { |db| db.replace data }
   end
 
@@ -168,11 +166,6 @@ class HashCabinet
     end
   end
 
-  # Returns the number of keys in the database.
-  def size
-    transaction { |db| db.size }
-  end
-
   # Returns a new Array containing each key-value pair in the database.
   def to_a
     transaction do |db| 
@@ -190,9 +183,15 @@ class HashCabinet
   # Insert or update key-value pairs.
   # 
   # This method will work with any object which implements an +#each_pair+
-  # method, such as a Hash.
+  # method, such as a Hash, or with any object that implements an +#each+
+  # method, such as an Array. In this case, the array will be converted to 
+  # a `key=key` hash before storing it.
   def update(data)
-    data = data.transform_values &:to_yaml
+    if !data.respond_to? :each_pair and data.respond_to? :each
+      data = array_to_hash data
+    end
+
+    data = normalize_types data
     transaction { |db| db.update data }
   end
 
@@ -211,8 +210,20 @@ class HashCabinet
   # Returns an Array of values corresponding to the given keys.
   def values_at(*key)
     transaction do |db| 
-      db.values_at(*key).map &:from_yaml
+      db.values_at(*(key.map &:to_s)).map &:from_yaml
     end
   end
 
+private
+
+  def array_to_hash(array)
+    array.map { |item| [item, item] }.to_h
+  end
+
+  def normalize_types(hash)
+    hash.map do |key, value|
+      [key.to_s, value.to_yaml]
+    end.to_h
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_cabinet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -21,7 +21,10 @@ files:
 homepage: https://github.com/dannyben/hash_cabinet
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/hash_cabinet/issues
+  documentation_uri: https://rubydoc.info/gems/hash_cabinet/HashCabinet
+  source_code_uri: https://github.com/dannyben/hash_cabinet
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -30,7 +33,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="