metastore 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cca3216af0666502760ad04279db43a9a8bc57f
-  data.tar.gz: 768a7cbf250acfd0b2d7f06e87606611d733aa23
+  metadata.gz: 17185ce2d6da4fd3375df8d3e7c51eec1875b146
+  data.tar.gz: 5dcfcbce2626843877613757859193a108d4efb9
 SHA512:
-  metadata.gz: f738de3d865b98b7b7df13bf4d0b9ec70fe561fa72fe845efc8cf67875799a9a311f2af21e27ec6a170410518d2180b8750c1a174329e6df6920b6a658ed1a37
-  data.tar.gz: 6354a19e99dc4e6aae63122cc77e84feef41ee5c3398c1e44be33fb3fa3e6546e6c21b496672e3f433869e511641fdb2082e52ab9aad610baadf847261859957
+  metadata.gz: 04cacb72808ab9a1938a99ac1c5b718afef87b61929d2d80bf327aba5c4b2b095f9fb8f77445eb43a89839f96d9960fafd6e0c79dbd6744a2dc380063407b503
+  data.tar.gz: 473ce35a7281f94fb605d13c509a1133aa396eca495ac02b8e060244d7efb05a13fbbb75bb596cfce3e9dee2f06739e666a26081ab652d24ed749c61b9acfa15

data/README.md

@@ -1,11 +1,12 @@
 # Metastore
 
 [![Gem Version](https://badge.fury.io/rb/metastore.svg)](http://badge.fury.io/rb/metastore)
-[![Code Climate](https://codeclimate.com/github/ashmckenzie/metastore/badges/gpa.svg)](https://codeclimate.com/github/ashmckenzie/metastore)
 [![Build Status](https://travis-ci.org/ashmckenzie/metastore.svg?branch=wip)](https://travis-ci.org/ashmckenzie/metastore)
+[![Code Climate](https://codeclimate.com/github/ashmckenzie/metastore/badges/gpa.svg)](https://codeclimate.com/github/ashmckenzie/metastore)
+[![Test Coverage](https://codeclimate.com/github/ashmckenzie/metastore/badges/coverage.svg)](https://codeclimate.com/github/ashmckenzie/metastore)
 [![Dependency Status](https://gemnasium.com/ashmckenzie/metastore.svg)](https://gemnasium.com/ashmckenzie/metastore)
 
-Store and retrieve meta information with ease
+Store and retrieve meta information with ease.  Currently YAML and JSON are the supported storage backends.
 
 ## Installation
 
@@ -32,13 +33,30 @@ There are four public methods hanging off `Metastore::Cabinet`:
 * `#clear!`
 * `#contents`
 
+When calling `#get()` or `#set()`:
+
+`key` can be expressed as follows:
+
+  * `key` - basic string key
+  * `:key` - basic symbol key (will be converted into string)
+  * `key1.key2` - using a `.` here allows nested keys to be defined.
+
+When calling `#set()`:
+
+`key` can be expressed as described above.  The YAML file is also immediately saved.
+
 ### Setup
 
 ```ruby
 require 'metastore'
 
-file = File.join(ENV['HOME'], '.metadata.yaml')
-store = Metastore::Cabinet.new(file)
+file = File.join(ENV['HOME'], '.metastore.yaml')
+
+# YAML (default)
+store = Metastore::Cabinet.new(file, storage_type: :yaml)
+
+# JSON
+store = Metastore::Cabinet.new(file, storage_type: :json)
 ```
 
 ### Basic example
@@ -56,6 +74,9 @@ store.get('key')
 store.set('key', 'value')
 => true
 
+store.get('key')
+=> "value"
+
 store.contents
 => {"key"=>"value"}
 
@@ -86,6 +107,9 @@ store.contents
 store.set('key3.key4', { 'key' => 'value' })
 => true
 
+store.get('key1.key2')
+=> "key.key2.value"
+
 store.contents
 => {"key1"=>{"key2"=>"key.key2.value"}, "key3"=>{"key4"=>{"key"=>"value"}}}
 ```
@@ -103,13 +127,19 @@ store['key1.key2']
 => nil
 
 store['key1.key2'] = 'key.key2.value'
-=> true
+=> "key.key2.value"
+
+store['key1.key2']
+=> "key.key2.value"
 
 store.contents
 => {"key1"=>{"key2"=>"key.key2.value"}}
 
 store['key3.key4'] = { 'key' => 'value' }
-=> true
+=> {"key"=>"value"}
+
+store['key3.key4']
+=> {"key"=>"value"}
 
 store.contents
 => {"key1"=>{"key2"=>"key.key2.value"}, "key3"=>{"key4"=>{"key"=>"value"}}}

data/lib/metastore.rb

@@ -1,6 +1,7 @@
 require 'metastore/version'
 require 'metastore/errors'
 require 'metastore/cabinet'
+require 'metastore/storage'
 
 module Metastore
 end

data/lib/metastore/cabinet.rb

@@ -1,12 +1,12 @@
 require 'fileutils'
 require 'pathname'
-require 'yaml'
 
 module Metastore
   class Cabinet
 
-    def initialize(file)
+    def initialize(file, storage_type: :yaml)
       @file = Pathname.new(file).expand_path
+      @storage_type = storage_type
     end
 
     def get(key)
@@ -17,16 +17,14 @@ module Metastore
       current_contents = contents
       set_key_and_value(current_contents, split_key(key), value)
       save!(current_contents)
-      true
     end
 
     def clear!
       save!({})
-      true
     end
 
     def contents
-      file.exist? ? YAML.load(file.read) || {} : {}
+      storage.contents || {}
     end
 
     alias_method :[], :get
@@ -34,7 +32,11 @@ module Metastore
 
     private
 
-      attr_reader :file
+      attr_reader :file, :storage_type
+
+      def storage
+        @store || StorageFactory.from_sym(storage_type).new(file)
+      end
 
       def split_key(key)
         key.to_s.split('.')
@@ -45,7 +47,7 @@ module Metastore
         input[current_key] = {} unless input[current_key]
 
         if key.empty?
-          input[current_key] = recursive_stringify_keys(value)
+          input[current_key] = stringify_keys(value)
           input
         else
           input[current_key] = {} unless input[current_key].is_a?(Hash)
@@ -53,16 +55,16 @@ module Metastore
         end
       end
 
-      def recursive_stringify_keys(input)
+      def stringify_keys(input)
         case input
         when Hash
           Hash[
             input.map do |k, v|
-              [ k.respond_to?(:to_s) ? k.to_s : k, recursive_stringify_keys(v) ]
+              [ k.respond_to?(:to_s) ? k.to_s : k, stringify_keys(v) ]
             end
           ]
         when Enumerable
-          input.map { |v| recursive_stringify_keys(v) }
+          input.map { |v| stringify_keys(v) }
         else
           input.is_a?(Symbol) ? input.to_s : input
         end
@@ -70,7 +72,8 @@ module Metastore
 
       def save!(new_values)
         FileUtils.mkdir_p(file.dirname) unless file.exist?
-        File.open(file.to_s, 'w') { |f| f.write(new_values.to_yaml) }
+        storage.save!(new_values)
+        true
       rescue => e
         raise Errors::CabinetCannotSet.new(e.message)
       end

data/lib/metastore/errors.rb

@@ -1,5 +1,6 @@
 module Metastore
   module Errors
     class CabinetCannotSet < StandardError; end
+    class UnknownStorageType < StandardError; end
   end
 end

data/lib/metastore/storage.rb

@@ -0,0 +1,9 @@
+require 'metastore/storage_factory'
+require 'metastore/storage/base'
+require 'metastore/storage/yaml'
+require 'metastore/storage/json'
+
+module Metastore
+  module Storage
+  end
+end

data/lib/metastore/storage/base.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+module Metastore
+  module Storage
+    class Base
+
+      def initialize(file)
+        @file = file
+      end
+
+      def contents
+        file.exist? ? read : {}
+      end
+
+      def save!(values)
+        File.open(file.to_s, 'w') { |f| f.write(to_write(values)) }
+      end
+
+      private
+
+        attr_reader :file
+
+        def read
+          raise NotImplementedError
+        end
+
+        def to_write(values)
+          raise NotImplementedError
+        end
+
+    end
+  end
+end

data/lib/metastore/storage/json.rb

@@ -0,0 +1,18 @@
+require 'json'
+
+module Metastore
+  module Storage
+    class JSON < Base
+
+      private
+
+        def read
+          ::JSON.parse(file.read)
+        end
+
+        def to_write(values)
+          values.to_json
+        end
+    end
+  end
+end

data/lib/metastore/storage/yaml.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+module Metastore
+  module Storage
+    class YAML < Base
+
+      private
+
+        def read
+          ::YAML.load(file.read)
+        end
+
+        def to_write(values)
+          values.to_yaml
+        end
+    end
+  end
+end

data/lib/metastore/storage_factory.rb

@@ -0,0 +1,11 @@
+module Metastore
+  class StorageFactory
+
+    def self.from_sym(symbol)
+      klass = symbol.to_s.upcase
+      Storage.const_get(klass)
+    rescue NameError => e
+      raise Errors::UnknownStorageType.new(e.message)
+    end
+  end
+end

data/lib/metastore/version.rb

@@ -1,3 +1,3 @@
 module Metastore
-  VERSION = "0.2.3"
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metastore
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ash McKenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,11 @@ files:
 - lib/metastore.rb
 - lib/metastore/cabinet.rb
 - lib/metastore/errors.rb
+- lib/metastore/storage.rb
+- lib/metastore/storage/base.rb
+- lib/metastore/storage/json.rb
+- lib/metastore/storage/yaml.rb
+- lib/metastore/storage_factory.rb
 - lib/metastore/version.rb
 - metastore.gemspec
 homepage: https://github.com/ashmckenzie/metastore