jor 0.1.1

data/test/unit/doc_test.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class StorageTest < JOR::Test::Unit::TestCase
+
+  def setup
+    super
+    @jor.create_collection("test")
+  end
+
+  def test_all_paths
+    doc = create_sample_doc_restaurant({"_id" => 1})
+    paths = JOR::Doc.paths("",doc)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/name", "obj"=>"restaurant", "class"=>String},
+      {"path_to"=>"/stars", "obj"=>3, "class"=>Fixnum},
+      {"path_to"=>"/cuisine", "obj"=>"asian", "class"=>String},
+      {"path_to"=>"/cuisine", "obj"=>"japanese", "class"=>String},
+      {"path_to"=>"/address/address", "obj"=>"Main St 100", "class"=>String},
+      {"path_to"=>"/address/city", "obj"=>"Ann Arbor", "class"=>String},
+      {"path_to"=>"/address/zipcode", "obj"=>"08104", "class"=>String},
+      {"path_to"=>"/description", "obj"=>"very long description that we might not want to index", "class"=>String},
+      {"path_to"=>"/wines/name", "obj"=>"wine1", "class"=>String},
+      {"path_to"=>"/wines/year", "obj"=>1998, "class"=>Fixnum},
+      {"path_to"=>"/wines/type", "obj"=>"garnatxa", "class"=>String},
+      {"path_to"=>"/wines/type", "obj"=>"merlot", "class"=>String},
+      {"path_to"=>"/wines/name", "obj"=>"wine2", "class"=>String},
+      {"path_to"=>"/wines/year", "obj"=>2009, "class"=>Fixnum},
+      {"path_to"=>"/wines/type", "obj"=>"syrah", "class"=>String},
+      {"path_to"=>"/wines/type", "obj"=>"merlot", "class"=>String}
+    ]
+
+    assert_equal expected_paths, paths
+  end
+
+  def test_path_selectors
+    doc = {"_id" => 1, "year" => 1898, "list" => {"quantity" => 15}}
+    paths = JOR::Doc.paths("",doc)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>15, "class"=>Fixnum}
+    ]
+    assert_equal expected_paths, paths
+
+    doc = {"_id" => 1, "year" => 1898, "list" => {"quantity" => {"$lt" => 60}}}
+    paths = JOR::Doc.paths("",doc)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>{"$lt"=>60}, "class"=>Hash, "selector"=>true}
+    ]
+    assert_equal expected_paths, paths
+
+    doc = {"_id" => 1, "year" => 1898, "list" => {"quantity" => {"$gt" => 10, "$lt" => 60}}}
+    paths = JOR::Doc.paths("",doc)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>{"$gt"=>10, "$lt"=>60}, "class"=>Hash, "selector"=>true}
+    ]
+    assert_equal expected_paths, paths
+
+    doc = {"_id" => {"$in" => [1, 2, 42]}}
+    paths = JOR::Doc.paths("",doc)
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>{"$in"=>[1, 2, 42]}, "class"=>Hash, "selector"=>true}
+    ]
+    assert_equal expected_paths, paths
+
+    doc = {"_id" => {"$all" => [1, 2, 42]}}
+    paths = JOR::Doc.paths("",doc)
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>{"$all"=>[1, 2, 42]}, "class"=>Hash, "selector"=>true}
+    ]
+    assert_equal expected_paths, paths
+  end
+
+  def test_difference
+
+    doc = {"_id" => 1, "year" => 1898,
+            "list" => {"quantity" => 15, "extra" => "long description that you want to skip"}}
+    paths = JOR::Doc.paths("",doc)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>15, "class"=>Fixnum},
+      {"path_to"=>"/list/extra", "obj"=>"long description that you want to skip", "class"=>String}
+    ]
+    assert_equal expected_paths, paths
+
+    paths_to_exclude = JOR::Doc.paths("",{"_id" => 1})
+
+    assert_raise JOR::FieldIdCannotBeExcludedFromIndex do
+      JOR::Doc.difference(paths,paths_to_exclude)
+    end
+
+    paths_to_exclude = JOR::Doc.paths("",{"list" => {"extra" => ""}})
+
+    expected_paths = [
+      {"path_to"=>"/list/extra", "obj"=>"", "class"=>String}
+    ]
+    assert_equal expected_paths, paths_to_exclude
+
+    diff_paths = JOR::Doc.difference(paths, paths_to_exclude)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>15, "class"=>Fixnum}
+    ]
+    assert_equal expected_paths, diff_paths
+
+    paths_to_exclude = JOR::Doc.paths("",{"list" => true})
+    diff_paths = JOR::Doc.difference(paths, paths_to_exclude)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/year", "obj"=>1898, "class"=>Fixnum},
+    ]
+    assert_equal expected_paths, diff_paths
+
+
+    paths_to_exclude = JOR::Doc.paths("",{"list" => {"extra" => true}, "year" => true})
+    diff_paths = JOR::Doc.difference(paths, paths_to_exclude)
+
+    expected_paths = [
+      {"path_to"=>"/_id", "obj"=>1, "class"=>Fixnum},
+      {"path_to"=>"/list/quantity", "obj"=>15, "class"=>Fixnum}
+    ]
+    assert_equal expected_paths, diff_paths
+
+  end
+end

data/test/unit/server_test.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class ServerTest < JOR::Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    JOR::Server.new
+  end
+
+  def setup
+    super
+    @jor.create_collection("test")
+  end
+
+  def test_calling_methods
+
+    put '/last_id'
+    assert_equal 422, last_response.status
+    assert_equal "Collection \"last_id\" does not exist", JSON::parse(last_response.body)["error"]
+
+    put '/test.last_id'
+    assert_equal 200, last_response.status
+    assert_equal 0, JSON::parse(last_response.body)["value"]
+
+    put '/test.last_id'
+    assert_equal 200, last_response.status
+    assert_equal 0, JSON::parse(last_response.body)["value"]
+
+    doc1 = create_sample_doc_restaurant({"_id" => 1})
+
+    put '/test.insert', [doc1].to_json
+    assert_equal 200, last_response.status
+
+    doc2 = create_sample_doc_restaurant({"_id" => 2})
+    put '/test.insert', [doc2].to_json
+    assert_equal 200, last_response.status
+
+    docs = [create_sample_doc_restaurant({"_id" => 3}), create_sample_doc_restaurant({"_id" => 4})]
+    put '/test.insert', [docs].to_json
+    assert_equal 200, last_response.status
+
+    put '/test.find', [{"_id" => 4}].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal 1, results.size
+
+    put '/test.find', [{}].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal 4, results.size
+    4.times do |i|
+      assert_equal i+1, results[i]["_id"]
+    end
+
+    put '/test.find', [{}, {"reversed" => true}].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal 4, results.size
+    4.times do |i|
+      assert_equal 4-i, results[i]["_id"]
+    end
+
+    put '/test.find', [{},{"reversed" => true}].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal 4, results.size
+    4.times do |i|
+      assert_equal 4-i, results[i]["_id"]
+    end
+
+    put '/test.find', [{"fake" => "super_fake"}].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal 0, results.size
+
+  end
+
+  def test_create_collection
+    put '/create_collection', ["with_autoincrement", {:auto_increment => true}].to_json
+    assert_equal 200, last_response.status
+
+    put '/create_collection', ["without_autoincrement", {:auto_increment => false}].to_json
+    assert_equal 200, last_response.status
+
+    put '/collections', [].to_json
+    assert_equal 200, last_response.status
+    results = JSON::parse(last_response.body)
+
+    assert_equal ["with_autoincrement", "without_autoincrement", "test"].sort, results.sort
+
+    put '/with_autoincrement.insert', [{"foo" => "bar"}].to_json
+    assert_equal 200, last_response.status
+
+    put '/with_autoincrement.insert', [{"_id" => 42, "foo" => "bar"}].to_json
+    assert_equal 422, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal JOR::DocumentDoesNotNeedId.new("with_autoincrement").to_s, results["error"]
+
+    put '/without_autoincrement.insert', [{"foo" => "bar"}].to_json
+    assert_equal 422, last_response.status
+    results = JSON::parse(last_response.body)
+    assert_equal JOR::DocumentNeedsId.new("without_autoincrement").to_s, results["error"]
+
+    put '/without_autoincrement.insert', [{"_id" => 42, "foo" => "bar"}].to_json
+    assert_equal 200, last_response.status
+  end
+
+  def test_is_not_put
+    post '/create_collection', ["with_autoincrement", {:auto_increment => true}].to_json
+    assert_equal 422, last_response.status
+  end
+
+end

data/test/unit/storage_test.rb

@@ -0,0 +1,171 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class StorageTest < JOR::Test::Unit::TestCase
+
+  def setup
+    super
+  end
+
+  def test_create_collection
+    @jor.create_collection("coll_foo")
+    @jor.create_collection("coll_bar")
+    assert_equal ["coll_foo", "coll_bar"].sort, @jor.collections.sort
+
+    @jor.create_collection("coll_zoe")
+    assert_equal ["coll_foo", "coll_bar", "coll_zoe"].sort, @jor.collections.sort
+
+    assert_raise JOR::CollectionAlreadyExists do
+      @jor.create_collection("coll_zoe")
+    end
+    assert_equal ["coll_foo", "coll_bar", "coll_zoe"].sort, @jor.collections.sort
+
+    assert_raise JOR::CollectionNotValid do
+      @jor.create_collection("collections")
+    end
+    assert_equal ["coll_foo", "coll_bar", "coll_zoe"].sort, @jor.collections.sort
+
+  end
+
+  def test_destroy_collection
+    @jor.create_collection("coll_1")
+    @jor.create_collection("coll_2")
+    @jor.create_collection("coll_3")
+    assert_equal ["coll_1", "coll_2", "coll_3"].sort, @jor.collections.sort
+
+    assert_raise JOR::CollectionDoesNotExist do
+      @jor.destroy_collection("foo")
+    end
+    assert_equal ["coll_1", "coll_2", "coll_3"].sort, @jor.collections.sort
+
+    @jor.destroy_collection("coll_1")
+    assert_equal ["coll_2", "coll_3"].sort, @jor.collections.sort
+
+    @jor.destroy_all()
+    assert_equal [].sort, @jor.collections.sort
+  end
+
+  def test_destroy_all_does_not_leave_documents_hanging
+
+    @jor.create_collection("coll_1")
+    @jor.create_collection("coll_2")
+    @jor.create_collection("coll_3")
+
+    @jor.coll_1.insert(create_sample_doc_restaurant({"_id" => 1}))
+    @jor.coll_2.insert(create_sample_doc_restaurant({"_id" => 1}))
+    @jor.coll_3.insert(create_sample_doc_restaurant({"_id" => 1}))
+
+    assert_equal true, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_1/*").size > 0
+    assert_equal true, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_2/*").size > 0
+    assert_equal true, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_3/*").size > 0
+    assert_equal true, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/collection/*").size > 0
+
+    assert_equal ["coll_1", "coll_2", "coll_3"].sort, @jor.collections.sort
+
+    keys_clean = []
+    keys_from_index = @jor.redis.smembers(@jor.coll_1.send(:idx_set_key,1))
+    keys_from_index.each do |key|
+      keys_clean << key.gsub("_zrem","").gsub("_srem","")
+    end
+
+    assert_equal @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_1/idx/*").sort, keys_clean.sort
+
+    @jor.destroy_all()
+
+    assert_equal [], @jor.collections
+
+    puts @jor.redis.keys("*")
+
+    assert_equal 0, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_1/*").size
+    assert_equal 0, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_2/*").size
+    assert_equal 0, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/coll_3/*").size
+    assert_equal 0, @jor.redis.keys("#{JOR::Storage::NAMESPACE}/collection/*").size
+
+  end
+
+  def test_collection_has_not_been_created_or_removed
+
+    assert_raise JOR::CollectionDoesNotExist do
+      @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => 1}))
+    end
+
+    @jor.create_collection("restaurant")
+    @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => 1}))
+    @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => 2}))
+    @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => 3}))
+    assert_equal 3, @jor.restaurant.count()
+
+    @jor.destroy_collection("restaurant")
+
+    assert_raise JOR::CollectionDoesNotExist do
+      @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => 1}))
+    end
+
+  end
+
+  def test_switching_between_collections
+    @jor.create_collection("restaurant")
+    @jor.create_collection("cs")
+
+    10.times do |i|
+      @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => i}))
+    end
+
+    assert_equal 10, @jor.restaurant.count()
+    assert_equal 0, @jor.cs.count()
+
+    100.times do |i|
+      @jor.cs.insert(create_sample_doc_cs({"_id" => i}))
+    end
+    assert_equal 10, @jor.restaurant.count()
+    assert_equal 100, @jor.cs.count()
+
+    @jor.destroy_collection("restaurant")
+    assert_raise JOR::CollectionDoesNotExist do
+      @jor.restaurant.count()
+    end
+    assert_equal 100, @jor.cs.count()
+  end
+
+  def test_info
+    @jor.create_collection("restaurant")
+    @jor.create_collection("cs")
+
+    1000.times do |i|
+      @jor.cs.insert(create_sample_doc_cs({"_id" => i}))
+    end
+
+    2000.times do |i|
+      @jor.restaurant.insert(create_sample_doc_restaurant({"_id" => i}),
+          {:excluded_fields_to_index => {"description" => true}})
+    end
+
+    info = @jor.info
+    assert_equal true, info["used_memory_in_redis"] > 0
+    assert_equal 2, info["num_collections"]
+    assert_equal 2000, info["collections"]["restaurant"]["num_documents"]
+    assert_equal false, info["collections"]["restaurant"]["auto_increment"]
+    assert_equal 1000, info["collections"]["cs"]["num_documents"]
+    assert_equal false, info["collections"]["cs"]["auto_increment"]
+  end
+
+  def test_deleting_collections_from_other_jor
+    @other_jor = JOR::Storage.new(@jor.redis)
+    @other_jor.create_collection("restaurant")
+
+    20.times do |i|
+      @other_jor.restaurant.insert create_sample_doc_restaurant({"_id" => i})
+    end
+    assert_equal 20, @other_jor.restaurant.count()
+
+    @jor.destroy_all
+
+    assert_raise JOR::CollectionDoesNotExist do
+      @jor.restaurant.count()
+    end
+
+    assert_raise JOR::CollectionDoesNotExist do
+      @other_jor.restaurant.count()
+    end
+  end
+
+end

data/test/unit/test_case.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+module JOR
+  module Test
+    module Unit
+      class TestCase < ::Test::Unit::TestCase
+        def setup
+          @jor = JOR::Storage.new(Redis.new(:db => 9, :driver => :hiredis))
+          JOR::Storage::NAMESPACE.replace("jor-test")
+        end
+
+        def teardown
+          keys = @jor.redis.keys("jor-test/*")
+          @jor.redis.pipelined do
+            keys.each { |key| @jor.redis.del(key) }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: jor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Josep M. Pujol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSON on top of Redis
+email: josep@3scale.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- config.ru
+- jor.gemspec
+- lib/jor.rb
+- lib/jor/collection.rb
+- lib/jor/doc.rb
+- lib/jor/errors.rb
+- lib/jor/server.rb
+- lib/jor/storage.rb
+- lib/jor/version.rb
+- test/test_helper.rb
+- test/test_helpers/fixtures.rb
+- test/unit/collection_test.rb
+- test/unit/doc_test.rb
+- test/unit/server_test.rb
+- test/unit/storage_test.rb
+- test/unit/test_case.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Storage engine for JSON documents using Redis. It allows fast find operations
+  (index) by any field of the JSON document (ala MongoDB)
+test_files:
+- test/test_helper.rb
+- test/test_helpers/fixtures.rb
+- test/unit/collection_test.rb
+- test/unit/doc_test.rb
+- test/unit/server_test.rb
+- test/unit/storage_test.rb
+- test/unit/test_case.rb
+has_rdoc: