quick_store 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 288ad220c7a70b7417fc5e90b24d797ae159144f
-  data.tar.gz: 4b9873b3ca493c87f3cbf1ee6179273622e08150
+  metadata.gz: ce685b7a4f43be47881c868dfbdc1c5ba78369af
+  data.tar.gz: d40c5ea3bd418caec5d7ff4538cfca30a2b25421
 SHA512:
-  metadata.gz: 77326c038ccdac3e1f66ba85ecb55d480a9f26a0bbe6d67bc38ada47b0c532707e8a40b95873eff858095fd586d48e83d8b29a9c576e73d89a25a3b134837bf0
-  data.tar.gz: 410501cb9cfbf8ad412c31c03f895879ce33198ecca62443adf1a2080b058d49f212e8e4c48f9b365d3fe31dd59da2b1c2a5492e4e537ce5c00f264cec373a2e
+  metadata.gz: 3820442b0e7aabfbf9ff41bfe7e831ee157941accb944f324c64520a1e271a6c2a8ff8ce0c21292ab25c789daf751be4b94af4707d36c9551df91c6197d1dd02
+  data.tar.gz: 443d9e13a96c503de77cd034f0367d68aec5cee9948749c2a5c7e5b8244c3bed2573fa3ca42fba585ccb28c99da293ec671521d0b673c8cd7a9cd57d6403b34d

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
+cache: bundler
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.2.0
+  - 2.3.0
   - ruby-head
   - jruby-19mode
-  - rbx-2
+  - jruby-9.0.0.0
+  - jruby-9.1.5.0

data/README.md

@@ -37,6 +37,7 @@ end
 ```
 
 ### Storing, fetching, and deleting data
+
 You can store, receive, and remove data from the store by using different methods:
 
 ```ruby
@@ -59,11 +60,11 @@ 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}}
+QuickStore.store.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
+QuickStore.store.get('a')                     # => nil
 ```
 
 ## Contributing

data/Rakefile

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

data/lib/quick_store.rb

@@ -1,9 +1,11 @@
-require "quick_store/version"
-require "quick_store/store"
+require 'quick_store/version'
+require 'quick_store/configuration'
+require 'quick_store/store'
 
+# Allows configuring a YAML store and accessing the configured YAML store
+# through the .store method.
 module QuickStore
-
-  NO_FILE_PATH_CONFIGURED = "Please configure a file_path for your QuickStore!"
+  NO_FILE_PATH_CONFIGURED = 'Please configure a file_path for your QuickStore!'.freeze
 
   class << self
     attr_accessor :configuration
@@ -16,9 +18,9 @@ module QuickStore
   #     config.key_separator = '|' # default is '/'
   #   end
   def self.configure
-    yield(self.config)
-    raise(NO_FILE_PATH_CONFIGURED) unless self.config.file_path
-    self.config
+    yield(config) if block_given?
+    raise(NO_FILE_PATH_CONFIGURED) unless config.file_path
+    config
   end
 
   # Returns the QuickStore::Configuration.
@@ -45,13 +47,4 @@ module QuickStore
   def self.store
     QuickStore::Store
   end
-
-  class Configuration
-    attr_accessor :key_separator, :file_path
-
-    def initialize
-      @key_separator = '/'
-    end
-  end
-
 end

data/lib/quick_store/configuration.rb

@@ -0,0 +1,14 @@
+module QuickStore
+  # The Configuration class is used internally by QuickStore to create a
+  # singleton configuration.
+  # The *key_separator* defines the character which can be used to access nested
+  # store items (default is "/").
+  # The *file_path* determines where the YAML file is stored.
+  class Configuration
+    attr_accessor :key_separator, :file_path
+
+    def initialize
+      @key_separator = '/'
+    end
+  end
+end

data/lib/quick_store/store.rb

@@ -1,15 +1,64 @@
-require 'active_support'
 require 'yaml/store'
 require 'fileutils'
 require 'singleton'
 
 module QuickStore
-
+  # Provides setter and getter methods for inserting values into the YAML store,
+  # fetching (nested) values, and removing (nested) items from the YAML store.
   class Store
     include Singleton
 
     attr_reader :file
 
+    class << self
+      def get(key)
+        instance.get(key)
+      end
+
+      def set(key, value)
+        instance.set(key, value)
+      end
+
+      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 =~ /.*=$/
+          ensure_not_singleton_method!(method)
+          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
+      end
+
+      private
+
+      def ensure_not_singleton_method!(key)
+        return unless singleton_methods.include?(key.to_s.chop.to_sym)
+
+        raise "There is a \"#{key.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
+    end
+
     def initialize
       @file = QuickStore.config.file_path
 
@@ -34,22 +83,12 @@ module QuickStore
     #   QuickStore::Store.instance.set('a/b/c', 'value')
     #   # => { "b": { "c": "value" } }
     def set(key, value)
-      keys = key.to_s.split(QuickStore.config.key_separator)
+      keys     = key.to_s.split(QuickStore.config.key_separator)
       base_key = keys.shift
 
-      if keys.empty?
-        final_value = value
-      else
-        final_value = keys.reverse.inject(value) { |v, k| { k => v } }
-      end
-
-      old_value = get(base_key)
-
-      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
-      end
+      final_value    = final_value(keys, value)
+      old_value      = get(base_key)
+      updated_values = updated_values(old_value, final_value)
 
       @db.transaction { @db[base_key.to_s] = updated_values }
     end
@@ -57,8 +96,8 @@ module QuickStore
     # Gets the value for the given key.
     # If the value was saved for a key of structure "a/b/c" then the value is
     # searched in a nested Hash, like: {"a"=>{"b"=>{"c"=>"value"}}}.
-    # If there is a value stored within a nested hash, it returns the appropriate
-    # Hash if a partial key is used.
+    # If there is a value stored within a nested hash, it returns the
+    # appropriate Hash if a partial key is used.
     #
     #   QuickStore::Store.instance.get('a')
     #   # => {"b"=>{"c"=>"value"}}
@@ -76,7 +115,9 @@ module QuickStore
         data = @db[base_key.to_s]
 
         if data
-          keys.reduce(data) { |value, key| value ? value = value[key] : nil }
+          keys.reduce(data) do |value, store_key|
+            value ? value[store_key] : nil
+          end
         end
       end
     end
@@ -89,49 +130,38 @@ module QuickStore
       end
     end
 
-    class << self
-      def get(key)
-        instance.get(key)
-      end
+    private
 
-      def set(key, value)
-        instance.set(key, value)
+    def final_value(keys, value)
+      if keys.empty?
+        value
+      else
+        keys.reverse.inject(value) { |final_value, key| { key => final_value } }
       end
+    end
 
-      def file
-        instance.file
+    def updated_values(old_value, final_value)
+      if old_value.is_a?(Hash) && final_value.is_a?(Hash)
+        deep_merge(old_value, final_value)
+      else
+        final_value
       end
+    end
 
-      def delete(key)
-        instance.delete(key)
-      end
+    def deep_merge(old_hash, new_hash)
+      final_hash = old_hash.dup
 
-      # 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
+      new_hash.each_pair do |key, other_value|
+        old_value = final_hash[key]
 
-          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)
+        if old_value.is_a?(Hash) && other_value.is_a?(Hash)
+          final_hash[key] = deep_merge(old_value, other_value)
         else
-          super
+          final_hash[key] = other_value
         end
       end
+
+      final_hash
     end
   end
-
 end

data/lib/quick_store/version.rb

@@ -1,3 +1,3 @@
 module QuickStore
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/quick_store.gemspec

@@ -4,24 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'quick_store/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "quick_store"
+  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      = "https://github.com/daigaku-ruby/quick_store"
-  spec.license       = "MIT"
+  spec.authors       = ['Paul Götze']
+  spec.email         = ['paul.christoph.goetze@gmail.com']
+  spec.summary       = 'Simple local key-value store based on YAML::Store.'
+  spec.description   = 'Simple local key-value store based on YAML::Store.'
+  spec.homepage      = 'https://github.com/daigaku-ruby/quick_store'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activesupport", "~> 4.0"
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
 end

data/spec/quick_store/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe QuickStore::Configuration do
+  it { is_expected.to respond_to :key_separator }
+  it { is_expected.to respond_to :key_separator= }
+  it { is_expected.to respond_to :file_path }
+  it { is_expected.to respond_to :file_path= }
+
+  it 'has the default key separator "/"' do
+    expect(QuickStore::Configuration.new.key_separator).to eq '/'
+  end
+end

data/spec/quick_store/store_spec.rb

@@ -1,98 +1,100 @@
 require 'spec_helper'
 
 describe QuickStore::Store do
-
   subject { QuickStore::Store.send(:new) }
 
   it { is_expected.to respond_to :get }
   it { is_expected.to respond_to :set }
   it { is_expected.to respond_to :file }
 
-  it "raises an error if used without a configured file_path" do
-    allow_any_instance_of(QuickStore::Configuration).to receive(:file_path) { nil }
+  it 'raises an error if used without a configured file_path' do
+    allow_any_instance_of(QuickStore::Configuration)
+      .to receive(:file_path)
+      .and_return(nil)
+
     expect { QuickStore::Store.send(:new) }.to raise_error
   end
 
-  it "creates the store file in the given directory on access" do
+  it 'creates the store file in the given directory on access' do
     QuickStore::Store.call_an_arbitrary_method
     expect(File.exist?(file_path)).to be_truthy
   end
 
-  it "allows setting arbitrary keys by setter methods" do
-    expect { QuickStore::Store.brownie = "brownie" }.not_to raise_error
+  it 'allows setting arbitrary keys by setter methods' do
+    expect { QuickStore::Store.brownie = 'brownie' }.not_to raise_error
   end
 
-  it "allows getting subsequently set keys" do
-    QuickStore::Store.carrots = "carrots"
-    expect(QuickStore::Store.carrots).to eq "carrots"
+  it 'allows getting subsequently set keys' do
+    QuickStore::Store.carrots = 'carrots'
+    expect(QuickStore::Store.carrots).to eq 'carrots'
   end
 
-  it "allows deleting arbitrary keys by dynamic delete" do
+  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
+    QuickStore::Store.delete_potatoes_variation
     expect(QuickStore::Store.potatoes_variation).to be_nil
   end
 
-  it "returns nil for not set simple keys" do
+  it 'returns nil for not set simple keys' do
     expect(QuickStore::Store.hamburger).to be_nil
   end
 
-  it "returns nil for not set nested keys" do
-      key = "pastries/muffins/savory"
-      expect(QuickStore::Store.get(key)).to be_nil
-    end
+  it 'returns nil for not set nested keys' do
+    key = 'pastries/muffins/savory'
+    expect(QuickStore::Store.get(key)).to be_nil
+  end
 
-  it "raises an method missing errror for non getter/setter methods" do
+  it 'raises an method missing errror for non getter/setter methods' do
     expect { QuickStore::Store.arbitrary_method(1, 2) }
       .to raise_error NoMethodError
   end
 
   [:get, :set, :file, :delete].each do |method|
-    it "responds to ::#{method}" do
+    it "responds to .#{method}" do
       expect(QuickStore::Store).to respond_to method
     end
   end
 
-  describe "::get" do
-    it "returns the value of the given key" do
+  describe '.get' do
+    it 'returns the value of the given key' do
       toast = 'toast'
       QuickStore::Store.toast = toast
       expect(QuickStore::Store.get(:toast)).to eq toast
     end
 
-    it "gets the value hash for a given partly key" do
-      base_key = 'pastries'
+    it 'gets the value hash for a given partly key' do
+      base_key   = 'pastries'
       second_key = 'muffins'
-      third_key = 'sweet'
-      key = "#{base_key}/#{second_key}/#{third_key}"
-      muffin = 'raspberry cream muffin'
-      hash = { second_key => { third_key => muffin } }
+      third_key  = 'sweet'
+      key        = "#{base_key}/#{second_key}/#{third_key}"
+      muffin     = 'raspberry cream muffin'
+      hash       = { second_key => { third_key => muffin } }
 
       QuickStore::Store.set(key, muffin)
       expect(QuickStore::Store.get(base_key)).to eq hash
     end
   end
 
-  describe "::set" do
-    it "sets the value for the given key" do
+  describe '.set' do
+    it 'sets the value for the given key' do
       juice = 'orange juice'
       QuickStore::Store.set(:juice, juice)
       expect(QuickStore::Store.juice).to eq juice
     end
 
-    it "sets the value for the given nested key" do
-      key = "pastries/muffins/sweet"
+    it 'sets the value for the given nested key' do
+      key    = 'pastries/muffins/sweet'
       muffin = 'blueberry muffin'
 
       QuickStore::Store.set(key, muffin)
       expect(QuickStore::Store.get(key)).to eq muffin
     end
 
-    it "sets the value for the given nested key" do
-      key = "pastries/muffins/sweet"
+    it 'sets the value for the given nested key' do
+      key    = 'pastries/muffins/sweet'
       muffin = 'apple walnut muffin'
 
       QuickStore::Store.set(key, muffin)
@@ -100,29 +102,29 @@ describe QuickStore::Store do
     end
   end
 
-  describe "::file" do
-    it "returns the storage file path" do
+  describe '.file' do
+    it 'returns the storage file path' do
       expect(QuickStore::Store.file).to eq QuickStore.config.file_path
     end
   end
 
-  describe "::delete" do
+  describe '.delete' do
     [:to_delete, 'to_delete'].each do |key|
-      it "removes the key from the store" do
+      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)
+        QuickStore.store.delete(key)
         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.'
+    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)
@@ -141,7 +143,7 @@ describe QuickStore::Store do
     end
   end
 
-  it "raises an error if the related getter for a setter is already defined" do
+  it 'raises an error if the related getter for a setter is already defined' do
     expect { QuickStore::Store.clone = 'defined' }.to raise_error
   end
 end

data/spec/quick_store_spec.rb

@@ -1,29 +1,28 @@
 require 'spec_helper'
 
 describe QuickStore do
-
-  describe '::config' do
-    it "returns a QuickStore::Configuration instance" do
+  describe '.config' do
+    it 'returns a QuickStore::Configuration instance' do
       expect(QuickStore.config).to be_a QuickStore::Configuration
     end
   end
 
-  describe '::store' do
-    it "retuns the QuickStore::Store class" do
+  describe '.store' do
+    it 'retuns the QuickStore::Store class' do
       expect(QuickStore.store).to be QuickStore::Store
     end
 
-    it "can be used to set values" do
+    it 'can be used to set values' do
       expect { QuickStore.store.muffin = 'blueberry muffin' }.not_to raise_error
     end
   end
 
-  describe '::configure' do
-    it "allows passing in a block" do
-      expect { QuickStore.configure { |config| } }.not_to raise_error
+  describe '.configure' do
+    it 'allows passing in a block' do
+      expect { QuickStore.configure }.not_to raise_error
     end
 
-    it "allows setting the file_path" do
+    it 'allows setting the file_path' do
       QuickStore.configure do |config|
         config.file_path = file_path
       end
@@ -31,7 +30,7 @@ describe QuickStore do
       expect(QuickStore.config.file_path).to eq file_path
     end
 
-    it "allows setting the key_separator" do
+    it 'allows setting the key_separator' do
       QuickStore.configure do |config|
         config.key_separator = '.'
       end
@@ -39,10 +38,8 @@ describe QuickStore do
       expect(QuickStore.config.key_separator).to eq '.'
     end
 
-    it "returns the QuickStore::Configuration" do
-      config = QuickStore.configure do |config|
-      end
-
+    it 'returns the QuickStore::Configuration' do
+      config = QuickStore.configure
       expect(config).to be_a QuickStore::Configuration
     end
   end

data/spec/spec_helper.rb

@@ -2,9 +2,8 @@ require 'rspec'
 
 def require_files_from(paths = [])
   paths.each do |path|
-    Dir[File.join(File.expand_path("#{path}*.rb", __FILE__))].sort.each do |file|
-      require file
-    end
+    files = Dir[File.join(File.expand_path("#{path}*.rb", __FILE__))].sort
+    files.each { |file| require file }
   end
 end
 
@@ -12,7 +11,7 @@ RSpec.configure do |config|
   config.color = true
 
   require File.expand_path('../../lib/quick_store', __FILE__)
-  require_files_from ["../support/**/"]
+  require_files_from ['../support/**/']
 
   config.include TestHelpers
 

data/spec/support/macros/test_helpers.rb

@@ -1,5 +1,5 @@
+# Provides convenience helpers for the specs.
 module TestHelpers
-
   def file_path
     File.expand_path('../../test_files/store.yml', __FILE__)
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: quick_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Götze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,9 +65,11 @@ files:
 - README.md
 - Rakefile
 - lib/quick_store.rb
+- lib/quick_store/configuration.rb
 - lib/quick_store/store.rb
 - lib/quick_store/version.rb
 - quick_store.gemspec
+- spec/quick_store/configuration_spec.rb
 - spec/quick_store/store_spec.rb
 - spec/quick_store_spec.rb
 - spec/spec_helper.rb
@@ -106,11 +94,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple local key-value store based on YAML::Store.
 test_files:
+- spec/quick_store/configuration_spec.rb
 - spec/quick_store/store_spec.rb
 - spec/quick_store_spec.rb
 - spec/spec_helper.rb