quick_store 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc979e2e5e8ac6debcf84aedacbdddef39abfaa4
-  data.tar.gz: c65348865e6a22cc2facd0556b46a7673aff600d
+  metadata.gz: 288ad220c7a70b7417fc5e90b24d797ae159144f
+  data.tar.gz: 4b9873b3ca493c87f3cbf1ee6179273622e08150
 SHA512:
-  metadata.gz: 2bfea78a041c46588bc532a3ad04588dff6a1baed59edaabec645b93de63a2f4e78b98976501e05caf5db9dbfce4c4e18b7b7e9d2b9e44ac5395e03b106ccba9
-  data.tar.gz: db7808449b82ce2d1be9a4b82702ce6e83f7a50daf3743c6e660d683c668ae71d3936897990f0acdf323cb9e826074811c495ceb430a7fb8e499d66a2faca27f
+  metadata.gz: 77326c038ccdac3e1f66ba85ecb55d480a9f26a0bbe6d67bc38ada47b0c532707e8a40b95873eff858095fd586d48e83d8b29a9c576e73d89a25a3b134837bf0
+  data.tar.gz: 410501cb9cfbf8ad412c31c03f895879ce33198ecca62443adf1a2080b058d49f212e8e4c48f9b365d3fe31dd59da2b1c2a5492e4e537ce5c00f264cec373a2e

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-2

data/README.md

@@ -1,5 +1,8 @@
 # QuickStore
 
+[![Gem Version](https://badge.fury.io/rb/quick_store.svg)](http://badge.fury.io/rb/quick_store)
+[![Travis Build](https://travis-ci.org/daigaku-ruby/quick_store.svg)](https://travis-ci.org/daigaku-ruby/quick_store)
+
 Simple local key-value store based on YAML::Store.
 
 ## Installation
@@ -33,23 +36,34 @@ QuickStore.configure do |config|
 end
 ```
 
-### Storing and fetching data
-You can store and receive data from the store using different methods:
+### Storing, fetching, and deleting data
+You can store, receive, and remove data from the store by using different methods:
 
 ```ruby
 # Using dynamic setters and getters
-QuickStore.store.arbitrary_key = 'value' # => "value"
-QuickStore.store.arbitrary_key           # => "value"
+QuickStore.store.arbitrary_key = 'value'      # => "value"
+QuickStore.store.arbitrary_key                # => "value"
+QuickStore.store.delete_arbitrary_key         # => "value"
 
-# Using the ::set and ::get methods
+# Using the ::set, ::get, and ::delete methods
 QuickStore.store.set(:arbitrary_key, 'value') # => "value"
 QuickStore.store.get(:arbitrary_key)          # => "value"
+QuickStore.store.delete(:arbitrary_key)       # => "value"
 
 # Example for a nested key ('/' is the default key separator)
-QuickStore.store.set('a/b/c', 'value') # => {"b"=>{"c"=>"value"}}
-QuickStore.store.get('a/b/c')          # => "value"
-QuickStore.store.get('a/b')            # => {"c"=>"value"}
-QuickStore.store.get('a')              # => {"b"=>{"c"=>"value"}}
+QuickStore.store.set('a/b/c', 'value')        # => {"b"=>{"c"=>"value"}}
+
+QuickStore.store.get('a/b/c')                 # => "value"
+QuickStore.store.get('a/b')                   # => {"c"=>"value"}
+QuickStore.store.get('a')                     # => {"b"=>{"c"=>"value"}}
+
+# Removing data for a certain nested key
+QuickStore.store.delete('a/b/c')              # => {"b"=>{"c"=>nil}}
+QuickStore.get('a')                           # => {"b"=>{"c"=>nil}}
+
+# Removing data for all nested keys under a certain key
+QuickStore.store.delete('a')                  # => {"b"=>{"c"=>nil}}
+QuickStore.get('a')                           # => nil
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/quick_store/store.rb

@@ -45,7 +45,7 @@ module QuickStore
 
       old_value = get(base_key)
 
-      if old_value.is_a? Hash
+      if old_value.is_a?(Hash) && final_value.is_a?(Hash)
         updated_values = old_value ? old_value.deep_merge(final_value) : final_value
       else
         updated_values = final_value
@@ -73,47 +73,63 @@ module QuickStore
       base_key = keys.shift
 
       @db.transaction do
-       data = @db[base_key.to_s]
+        data = @db[base_key.to_s]
 
-       if data
-         keys.reduce(data) { |value, key| value ? value = value[key] : nil }
-       end
-     end
+        if data
+          keys.reduce(data) { |value, key| value ? value = value[key] : nil }
+        end
+      end
     end
 
-    def self.get(key)
-      instance.get(key)
+    def delete(key)
+      if key.to_s =~ Regexp.new(QuickStore.config.key_separator)
+        set(key, nil)
+      else
+        @db.transaction { @db.delete(key.to_s) }
+      end
     end
 
-    def self.set(key, value)
-      instance.set(key, value)
-    end
+    class << self
+      def get(key)
+        instance.get(key)
+      end
 
-    def self.file
-      instance.file
-    end
+      def set(key, value)
+        instance.set(key, value)
+      end
 
-    # Defines getter and setter methods for arbitrarily named methods.
-    #
-    #   QuickStore::Store.answer = 42 # saves 'answer: 42' to the store
-    #   # => 42
-    #
-    #   QuickStore::Store.answer
-    #   # => 42
-    def self.method_missing(method, *args, &block)
-      if method =~ /.*=$/
-        if singleton_methods.include?(method.to_s.chop.to_sym)
-          raise "There is a \"#{method.to_s.chop}\" instance method already " +
+      def file
+        instance.file
+      end
+
+      def delete(key)
+        instance.delete(key)
+      end
+
+      # Defines getter and setter methods for arbitrarily named methods.
+      #
+      #   QuickStore::Store.answer = 42 # saves 'answer: 42' to the store
+      #   # => 42
+      #
+      #   QuickStore::Store.answer
+      #   # => 42
+      def method_missing(method, *args, &block)
+        if method =~ /.*=$/
+          if singleton_methods.include?(method.to_s.chop.to_sym)
+            raise "There is a \"#{method.to_s.chop}\" instance method already " +
             "defined. This will lead to problems while getting values " +
             "from the store. Please use another key than " +
             "#{singleton_methods.map(&:to_s)}."
+          end
+
+          instance.set(method.to_s.gsub(/=$/, ''), args[0])
+        elsif method =~/\Adelete\_.*$/
+          instance.delete(method.to_s.gsub(/\Adelete\_/, ''))
+        elsif args.count == 0
+          instance.get(method)
+        else
+          super
         end
-
-        instance.set(method.to_s.gsub(/=$/, ''), args[0])
-      elsif args.count == 0
-        instance.get(method)
-      else
-        super
       end
     end
   end

data/lib/quick_store/version.rb

@@ -1,3 +1,3 @@
 module QuickStore
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/quick_store.gemspec

@@ -6,11 +6,12 @@ require 'quick_store/version'
 Gem::Specification.new do |spec|
   spec.name          = "quick_store"
   spec.version       = QuickStore::VERSION
+  spec.required_ruby_version = '>= 1.9.3'
   spec.authors       = ["Paul Götze"]
   spec.email         = ["paul.christoph.goetze@gmail.com"]
   spec.summary       = %q{Simple local key-value store based on YAML::Store.}
   spec.description   = %q{Simple local key-value store based on YAML::Store.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/daigaku-ruby/quick_store"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/quick_store/store_spec.rb

@@ -27,6 +27,15 @@ describe QuickStore::Store do
     expect(QuickStore::Store.carrots).to eq "carrots"
   end
 
+  it "allows deleting arbitrary keys by dynamic delete" do
+    value = 'chips'
+    QuickStore::Store.potatoes_variation = value
+    expect(QuickStore::Store.potatoes_variation).to eq value
+
+    QuickStore::Store::delete_potatoes_variation
+    expect(QuickStore::Store.potatoes_variation).to be_nil
+  end
+
   it "returns nil for not set simple keys" do
     expect(QuickStore::Store.hamburger).to be_nil
   end
@@ -41,16 +50,10 @@ describe QuickStore::Store do
       .to raise_error NoMethodError
   end
 
-  it "responds to ::get" do
-    expect(QuickStore::Store).to respond_to :get
-  end
-
-  it "responds to ::set" do
-    expect(QuickStore::Store).to respond_to :set
-  end
-
-  it "responds to ::file" do
-    expect(QuickStore::Store).to respond_to :file
+  [:get, :set, :file, :delete].each do |method|
+    it "responds to ::#{method}" do
+      expect(QuickStore::Store).to respond_to method
+    end
   end
 
   describe "::get" do
@@ -103,6 +106,41 @@ describe QuickStore::Store do
     end
   end
 
+  describe "::delete" do
+    [:to_delete, 'to_delete'].each do |key|
+      it "removes the key from the store" do
+        statement = 'I really love deleting things!'
+
+        QuickStore.store.to_delete = statement
+        expect(QuickStore.store.to_delete).to eq statement
+
+        QuickStore.store.delete(:to_delete)
+        expect(QuickStore.store.to_delete).to be_nil
+      end
+    end
+
+    it "removes nested keys, but keeps other keys on same level" do
+      key = 'a/deeply/nested/key'
+      other_key = 'a/deeply/nested/other_key'
+      value = 'Such worth being deleted.'
+      other_value = 'Such worth being kept.'
+
+      QuickStore.store.set(key, value)
+      QuickStore.store.set(other_key, other_value)
+
+      expect(QuickStore.store.get(key)).to eq value
+      expect(QuickStore.store.get(other_key)).to eq other_value
+
+      QuickStore.store.delete(key)
+
+      expect(QuickStore.store.get(key)).to be_nil
+      expect(QuickStore.store.get(other_key)).to eq other_value
+
+      hash = { 'nested' => { 'key' => nil, 'other_key' => other_value } }
+      expect(QuickStore.store.get('a/deeply')).to eq hash
+    end
+  end
+
   it "raises an error if the related getter for a setter is already defined" do
     expect { QuickStore::Store.clone = 'defined' }.to raise_error
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quick_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Götze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -85,7 +86,7 @@ files:
 - spec/quick_store_spec.rb
 - spec/spec_helper.rb
 - spec/support/macros/test_helpers.rb
-homepage: ''
+homepage: https://github.com/daigaku-ruby/quick_store
 licenses:
 - MIT
 metadata: {}
@@ -97,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Simple local key-value store based on YAML::Store.