abbey 0.1.0.beta3 → 0.1.1

data/abbey.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abbey"
-  s.version = "0.1.0.beta3"
+  s.version = "0.1.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pavel Kalvoda"]
-  s.date = "2011-11-13"
+  s.date = "2011-11-17"
   s.description = "Primitive JSON data store. Key-value structure with namespaces."
   s.email = "me@pavelkalvoda.com"
   s.extra_rdoc_files = [

data/lib/entity_storage.rb

@@ -4,6 +4,8 @@ module Abbey
   # JSON serialization under the hood.
   class EntityStorage
 
+    ForbiddenChars = '/'
+
     # @return [Settings]
     attr_accessor :settings
 
@@ -29,6 +31,7 @@ module Abbey
     # Set up the directory structure
     # @return void
     def set_up!
+      return if set_up?
       settings.namespaces.each do |ns|
         path = make_path(ns)
         if !Dir.exists?(path) then
@@ -45,7 +48,7 @@ module Abbey
     # @return void
     def save(namespace, key, data)
       path = make_path(namespace, key)
-      raise ItemAlreadyPresentError.new if File.exist?(path)
+      raise ItemAlreadyPresentError, "Item '#{make_key(namespace,key)}' already present" if File.exist?(path)
       f = File.new(path, File::CREAT | File::RDWR)
       size = f.write(MultiJson.encode(data))
       f.close
@@ -58,7 +61,7 @@ module Abbey
     # @return [Object]
     def get(namespace, key)
       path = make_path(namespace, key)
-      raise ItemNotFoundError.new unless exists?(namespace, key)
+      raise ItemNotFoundError, "Item '#{make_key(namespace,key)}' not found" unless exists?(namespace, key)
       settings.logger.info("Read #{make_key(namespace, key)}")
       MultiJson.decode(File.read(path))
     end
@@ -89,7 +92,7 @@ module Abbey
     # @return void
     def delete(namespace, key)
       path = make_path(namespace, key)
-      raise ItemNotFoundError.new unless exists?(namespace, key)
+      raise ItemNotFoundError, "Item '#{make_key(namespace,key)}' already exists" unless exists?(namespace, key)
       File.delete(path)
       settings.logger.info("Deleted #{make_key(namespace,key)}")
     end
@@ -118,13 +121,35 @@ module Abbey
       list(namespace).each {|item| delete(namespace, item)}
     end
 
+    # Check whether the key is formally valid
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return [Boolean]
+    def identifier_valid?(key)
+      key = key.to_s
+      ForbiddenChars.each_char do |char|
+        return false if key.include?(char)
+      end
+    end
+
     private
 
+    def validate_namespace(namespace)
+      raise InvalidNameError, "The namespace contains illegal characters" unless identifier_valid?(namespace)
+    end
+
+    def validate_key(key)
+      raise InvalidNameError, "The key contains illegal characters" unless identifier_valid?(key)
+    end
+
+    # Compose path to a namespace or an item
     def make_path(namespace, key = nil)
+      validate_namespace(namespace)
+      validate_key(key) if key
       dir = File.join(settings.path, namespace.to_s)
       key ? File.join(dir, key.to_s) : dir
     end
 
+    # Unify IDs format
     def make_key(namespace, key)
       namespace.to_s + ':' + key.to_s
     end

data/lib/errors.rb

@@ -1,9 +1,17 @@
 module Abbey
 
-  # Thrown when trying to overwrite an item
+  # Raised when trying to overwrite an item
   class ItemAlreadyPresentError < RuntimeError
   end
 
   class ItemNotFoundError < RuntimeError
   end
+
+  # Raised when the data can't be serialized
+  class NotSerializableError < ArgumentError
+  end
+
+  # Raised when a key or a namespace containing a FS separator is passed
+  class InvalidNameError < ArgumentError
+  end
 end

data/lib/version.rb

@@ -2,8 +2,8 @@ module Abbey
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
-    BUILD = 'beta3'
+    PATCH = 1
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/test/entity_storage_test.rb

@@ -8,7 +8,7 @@ class AbbeyTest < Test::Unit::TestCase
   end
 
   def teardown
-    FileUtils.rm_r('/tmp/abbey')
+    FileUtils.rm_r('/tmp/abbey') if Dir.exist?('/tmp/abbey')
   end
 
   def test_it_will_check_for_readiness
@@ -87,4 +87,24 @@ class AbbeyTest < Test::Unit::TestCase
     assert_equal(Set.new, @abbey.list(:ns1))
     assert_equal Set.new([:key]), @abbey.list(:ns2)
   end
+
+  def test_special_chars_in_keys
+    @abbey.set_up!
+    @abbey.save(:ns1, "with:colon", {"a" => 1})
+    assert_equal ({"a" => 1}), @abbey.get(:ns1, "with:colon")
+    assert_raise Abbey::InvalidNameError do
+      @abbey.save(:ns1, "with/slash", {"a" => 5})
+    end
+  end
+
+  def test_special_chars_in_namespaces
+    abbey = Abbey::EntityStorage.new(Abbey::Settings.new('/tmp/abbey', [:ns1, :"with:colon"], Logger.new(STDOUT)))
+    abbey.set_up!
+    abbey.save("with:colon", :key, ["datadata"])
+    assert_equal ["datadata"], abbey.get("with:colon", :key)
+    assert_raise Abbey::InvalidNameError do
+      Abbey::EntityStorage.new(Abbey::Settings.new('/tmp/abbey', [:ns1, :"with/slash"], Logger.new(STDOUT))).set_up!
+    end
+  end
+
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: abbey
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta3
-  prerelease: 6
+  version: 0.1.1
+  prerelease: 
 platform: ruby
 authors:
 - Pavel Kalvoda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-13 00:00:00.000000000 Z
+date: 2011-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &13335600 !ruby/object:Gem::Requirement
+  requirement: &6562960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13335600
+  version_requirements: *6562960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13334660 !ruby/object:Gem::Requirement
+  requirement: &6560780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13334660
+  version_requirements: *6560780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &13333200 !ruby/object:Gem::Requirement
+  requirement: &6559960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13333200
+  version_requirements: *6559960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &13332360 !ruby/object:Gem::Requirement
+  requirement: &6610240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *13332360
+  version_requirements: *6610240
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &13331340 !ruby/object:Gem::Requirement
+  requirement: &6608820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13331340
+  version_requirements: *6608820
 description: Primitive JSON data store. Key-value structure with namespaces.
 email: me@pavelkalvoda.com
 executables: []
@@ -104,13 +104,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2996718355299514668
+      hash: -1187583575974686402
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10