quick_store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc979e2e5e8ac6debcf84aedacbdddef39abfaa4
+  data.tar.gz: c65348865e6a22cc2facd0556b46a7673aff600d
+SHA512:
+  metadata.gz: 2bfea78a041c46588bc532a3ad04588dff6a1baed59edaabec645b93de63a2f4e78b98976501e05caf5db9dbfce4c4e18b7b7e9d2b9e44ac5395e03b106ccba9
+  data.tar.gz: db7808449b82ce2d1be9a4b82702ce6e83f7a50daf3743c6e660d683c668ae71d3936897990f0acdf323cb9e826074811c495ceb430a7fb8e499d66a2faca27f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# QuickStore
+
+Simple local key-value store based on YAML::Store.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quick_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quick_store
+
+## Usage
+
+```ruby
+require 'quick_store'
+```
+
+### Configuration
+
+```ruby
+QuickStore.configure do |config|
+  config.file_path = 'path/to/store/file.yml'
+  config.key_separator = '|' # default is '/'
+end
+```
+
+### Storing and fetching data
+You can store and receive data from the store using different methods:
+
+```ruby
+# Using dynamic setters and getters
+QuickStore.store.arbitrary_key = 'value' # => "value"
+QuickStore.store.arbitrary_key           # => "value"
+
+# Using the ::set and ::get methods
+QuickStore.store.set(:arbitrary_key, 'value') # => "value"
+QuickStore.store.get(: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"}}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/quick_store/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The quick_store gem is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/quick_store/store.rb

@@ -0,0 +1,121 @@
+require 'active_support'
+require 'yaml/store'
+require 'fileutils'
+require 'singleton'
+
+module QuickStore
+
+  class Store
+    include Singleton
+
+    attr_reader :file
+
+    def initialize
+      @file = QuickStore.config.file_path
+
+      raise(QuickStore::NO_FILE_PATH_CONFIGURED) unless @file
+
+      directory = File.dirname(@file)
+      FileUtils.makedirs(directory) unless Dir.exist?(directory)
+
+      @db = YAML::Store.new(@file)
+    end
+
+    # Sets the value for the given key.
+    # If the key is of structure "a/b/c" then the value is saved as a
+    # nested Hash.
+    #
+    #   QuickStore::Store.instance.set('a', 'value')
+    #   # => "value"
+    #
+    #   QuickStore::Store.instance.set('a/b', 'value')
+    #   # => { "c": "value" }
+    #
+    #   QuickStore::Store.instance.set('a/b/c', 'value')
+    #   # => { "b": { "c": "value" } }
+    def set(key, value)
+      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
+        updated_values = old_value ? old_value.deep_merge(final_value) : final_value
+      else
+        updated_values = final_value
+      end
+
+      @db.transaction { @db[base_key.to_s] = updated_values }
+    end
+
+    # 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.
+    #
+    #   QuickStore::Store.instance.get('a')
+    #   # => {"b"=>{"c"=>"value"}}
+    #
+    #   QuickStore::Store.instance.get('a/b')
+    #   # => {"c"=>"value"}
+    #
+    #   QuickStore::Store.instance.get('a/b/c')
+    #   # => "value"
+    def get(key)
+      keys = key.to_s.split(QuickStore.config.key_separator)
+      base_key = keys.shift
+
+      @db.transaction do
+       data = @db[base_key.to_s]
+
+       if data
+         keys.reduce(data) { |value, key| value ? value = value[key] : nil }
+       end
+     end
+    end
+
+    def self.get(key)
+      instance.get(key)
+    end
+
+    def self.set(key, value)
+      instance.set(key, value)
+    end
+
+    def self.file
+      instance.file
+    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 " +
+            "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 args.count == 0
+        instance.get(method)
+      else
+        super
+      end
+    end
+  end
+
+end

data/lib/quick_store/version.rb

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

data/lib/quick_store.rb

@@ -0,0 +1,57 @@
+require "quick_store/version"
+require "quick_store/store"
+
+module QuickStore
+
+  NO_FILE_PATH_CONFIGURED = "Please configure a file_path for your QuickStore!"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configures the QuickStore::Store
+  #
+  #   QuickStore.configure do |config|
+  #     config.file_path = 'path/to/store/file.yml'
+  #     config.key_separator = '|' # default is '/'
+  #   end
+  def self.configure
+    yield(self.config)
+    raise(NO_FILE_PATH_CONFIGURED) unless self.config.file_path
+    self.config
+  end
+
+  # Returns the QuickStore::Configuration.
+  def self.config
+    self.configuration ||= Configuration.new
+  end
+
+  # Returns the QuickStore::Store.
+  # You can store and receive data from the store using different methods:
+  #
+  #   # Using dynamic setters and getters
+  #   QuickStore.store.arbitrary_key = 'value' # => "value"
+  #   QuickStore.store.arbitrary_key           # => "value"
+  #
+  #   # Using the ::set and ::get methods
+  #   QuickStore.store.set(:arbitrary_key, 'value') # => "value"
+  #   QuickStore.store.get(: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"}}
+  def self.store
+    QuickStore::Store
+  end
+
+  class Configuration
+    attr_accessor :key_separator, :file_path
+
+    def initialize
+      @key_separator = '/'
+    end
+  end
+
+end

data/quick_store.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quick_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quick_store"
+  spec.version       = QuickStore::VERSION
+  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.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.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"
+end

data/spec/quick_store/store_spec.rb

@@ -0,0 +1,109 @@
+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 }
+    expect { QuickStore::Store.send(:new) }.to raise_error
+  end
+
+  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
+  end
+
+  it "allows getting subsequently set keys" do
+    QuickStore::Store.carrots = "carrots"
+    expect(QuickStore::Store.carrots).to eq "carrots"
+  end
+
+  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 "raises an method missing errror for non getter/setter methods" do
+    expect { QuickStore::Store.arbitrary_method(1, 2) }
+      .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
+  end
+
+  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'
+      second_key = 'muffins'
+      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
+      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"
+      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"
+      muffin = 'apple walnut muffin'
+
+      QuickStore::Store.set(key, muffin)
+      expect(QuickStore::Store.get(key)).to eq muffin
+    end
+  end
+
+  describe "::file" do
+    it "returns the storage file path" do
+      expect(QuickStore::Store.file).to eq QuickStore.config.file_path
+    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
+end

data/spec/quick_store_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe QuickStore 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
+      expect(QuickStore.store).to be QuickStore::Store
+    end
+
+    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
+    end
+
+    it "allows setting the file_path" do
+      QuickStore.configure do |config|
+        config.file_path = file_path
+      end
+
+      expect(QuickStore.config.file_path).to eq file_path
+    end
+
+    it "allows setting the key_separator" do
+      QuickStore.configure do |config|
+        config.key_separator = '.'
+      end
+
+      expect(QuickStore.config.key_separator).to eq '.'
+    end
+
+    it "returns the QuickStore::Configuration" do
+      config = QuickStore.configure do |config|
+      end
+
+      expect(config).to be_a QuickStore::Configuration
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+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
+  end
+end
+
+RSpec.configure do |config|
+  config.color = true
+
+  require File.expand_path('../../lib/quick_store', __FILE__)
+  require_files_from ["../support/**/"]
+
+  config.include TestHelpers
+
+  config.before(:all) { use_test_store }
+  config.after(:all) { remove_test_files }
+end

data/spec/support/macros/test_helpers.rb

@@ -0,0 +1,17 @@
+module TestHelpers
+
+  def file_path
+    File.expand_path('../../test_files/store.yml', __FILE__)
+  end
+
+  def use_test_store
+    QuickStore::Configuration.send(:new)
+    QuickStore.config.instance_variable_set(:@file_path, file_path)
+    QuickStore::Store.send(:new)
+  end
+
+  def remove_test_files
+    dir = File.dirname(file_path)
+    FileUtils.remove_dir(dir) if Dir.exist?(dir)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: quick_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Götze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple local key-value store based on YAML::Store.
+email:
+- paul.christoph.goetze@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/quick_store.rb
+- lib/quick_store/store.rb
+- lib/quick_store/version.rb
+- quick_store.gemspec
+- spec/quick_store/store_spec.rb
+- spec/quick_store_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/test_helpers.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Simple local key-value store based on YAML::Store.
+test_files:
+- spec/quick_store/store_spec.rb
+- spec/quick_store_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/test_helpers.rb