oria 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README.markdown

@@ -3,12 +3,12 @@ Oria
 
 Oria (oh-rye-uh) is an in-memory, Ruby-based Key-Value Store. It's designed to handle moderate amounts of data quickly
 and easily without causing deployment issues or server headaches. It uses EventMachine to provide a networked interface
-to a semi-persistent KVS and asynchronously writes the in-memory data to YAML files.
+to a semi-persistent store and asynchronously writes the in-memory data to YAML files.
 
 Installation
 -
 
-Oria is a provided as a Gem. Use the following command to install it:
+Oria is provided as a Gem. Use the following command to install it:
 
 	gem install oria --source http://gemcutter.org
 
@@ -41,7 +41,7 @@ untested, so please test it heavily before deploying, and _report any issues you
 Usage
 -
 
-Okay, now for the fun part. Oria behaves (mostly) like a Hash - you could say that it responds to 2/3 of @wycats' Moneta
+Okay, now for the fun part. Oria behaves (mostly) like a Hash - you could say that it responds to 2/3 of [@wycats](http://github.com/wycats)' Moneta
 plugin. Specifically, it responds to the following Hash methods:
 
 	[]=(value)			Set a key to ... something.
@@ -117,6 +117,9 @@ Let's try it out:
 	Oria.app_key = "my_app_1"
 	Oria[:foo] #=> "bar"
 
+That's it! I hope you enjoy Oria, and please let me know if you find any issues or have any trouble. As you will no doubt see from
+the current version information, it's a very young project, and any contribution is welcome.
+
 Dependencies
 -
 
@@ -127,7 +130,60 @@ It also needs [EventMachine](http://github.com/eventmachine/eventmachine) to do
 UDP sockets, and spent a lifetime on this. But EventMachine is seriously, seriously, seriously awesome, and works very well
 without me writing an insane amount of code I couldn't write very well anyway. Check it out and see for yourself.
 
-That's it! I hope you enjoy Oria, and please let me know if you find any issues or have any trouble. As you will no doubt see from
-the current version information, it's a very young project, and any contribution is welcome.
+Warnings
+-
+
+Oria is weak in a few places. First, it forks all over the place with no regard for the consequences. Someday I'm going to upgrade it
+to use Daemons, but not right now. In general, the forking is dangerous and clumsy.
+
+Also, Oria's auto-start feature relies on `sleep`. In fact, Oria relies on `sleep` in more than one place. _This is terrible_ and I
+want to fix it someday. But I also want to get the code out there so people can start breaking it and tell me where it breaks.
+
+Which means: **please report any problems you have using the  [Github issue tracking](http://github.com/flipsasser/oria/issues)!**
+
+Benchmarks
+-
+
+I've run some benchmarks comparing Oria to Redis. It's not pretty:
+
+	                     user     system      total        real
+	Redis (write):   0.050000   0.020000   0.070000 (  0.115850)
+	Oria (write):    0.140000   0.110000   0.250000 (  1.267912)
+	Redis (read):    0.070000   0.020000   0.090000 (  0.145078)
+	Oria (read):     0.150000   0.110000   0.260000 (  1.247791)
+
+As you can see, Oria is about 10x slower than Redis on my development computer. Even worse, if you run the benchmark like so:
+
+	ruby redis_v_oria.rb 10000
+
+Oria's server will fail to fulfill all of those requests. Scary. Clearly, it needs some serious improvement. Oria will never be
+as performant as something like Redis - it's not meant to be (plus it's written in Ruby, not C). But it could use some reduction
+in overhead, and any help is welcome.
+
+But I knew Oria wouldn't compete with Redis. What about MySQL?
+
+	                     user     system      total        real
+	MySQL (write):   0.270000   0.030000   0.300000 (  0.445586)
+	Oria (write):    0.170000   0.120000   0.290000 (  1.676674)
+	MySQL (read):    0.310000   0.020000   0.330000 (  0.484944)
+	Oria (read):     0.120000   0.120000   0.240000 (  1.616851)
+
+Ew. Oria is consistently about 4x slower than MySQL. But check this out: I removed persistence, and here are the new benchmarks:
+
+	                     user     system      total        real
+	Redis (write):   0.040000   0.020000   0.060000 (  0.113882)
+	Oria (write):    0.130000   0.100000   0.230000 (  0.396776)
+	Redis (read):    0.070000   0.020000   0.090000 (  0.145068)
+	Oria (read):     0.130000   0.100000   0.230000 (  0.395410)
+
+That's getting competitive. How about MySQL?
+
+	                     user     system      total        real
+	MySQL (write):   0.270000   0.030000   0.300000 (  0.453413)
+	Oria (write):    0.150000   0.110000   0.260000 (  0.430725)
+	MySQL (read):    0.320000   0.030000   0.350000 (  0.484978)
+	Oria (read):     0.100000   0.100000   0.200000 (  0.373431)
+
+Oh snap! Oria outperforms MySQL when persistence is disabled. So I'll have to refactor the code.
 
 Copyright (c) 2009 Flip Sasser, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/benchmarks/mysql_table.sql

@@ -0,0 +1,26 @@
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8 */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+DROP TABLE IF EXISTS `oria_test`;
+
+CREATE TABLE `oria_test` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `key` varchar(32) DEFAULT NULL,
+  `value` varchar(128) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `key` (`key`)
+) ENGINE=MyISAM AUTO_INCREMENT=2 DEFAULT CHARSET=latin1;
+
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;

data/benchmarks/redis_v_oria.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'redis'
+require '../lib/oria'
+require 'benchmark'
+
+redis = Redis.new
+n = (ARGV.shift || 1000).to_i
+
+Benchmark.bm(15) do |bm|
+  bm.report("Redis (write):") do
+    n.times do
+      redis['foo'] = 'bar'
+    end
+  end
+
+  bm.report("Oria (write):") do
+    n.times do
+      Oria['foo'] = 'bar'
+    end
+  end
+
+  bm.report("Redis (read):") do
+    n.times do
+      foo = redis['foo']
+    end
+  end
+
+  bm.report("Oria (read):") do
+    n.times do
+      foo = Oria['foo']
+    end
+  end
+end

data/benchmarks/sequel_v_oria.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'sequel'
+require '../lib/oria'
+require 'benchmark'
+
+DB = Sequel.connect('mysql://root@localhost/oria_test')
+n = (ARGV.shift || 1000).to_i
+
+Benchmark.bm(15) do |bm|
+  bm.report("MySQL (write):") do
+    table = DB[:oria_test]
+    n.times do
+      if foo = table[:key => 'foo']
+        foo.update(:value => 'bar')
+      else
+        table.insert(:key => 'foo', :value => 'bar')
+      end
+    end
+  end
+
+  bm.report("Oria (write):") do
+    n.times do
+      Oria['foo'] = 'bar'
+    end
+  end
+
+  bm.report("MySQL (read):") do
+    table = DB[:oria_test]
+    n.times do
+      foo = table[:key => 'foo']
+    end
+  end
+
+  bm.report("Oria (read):") do
+    n.times do
+      foo = Oria['foo']
+    end
+  end
+end

data/benchmarks/sqlite_v_oria.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'sequel'
+require '../lib/oria'
+require 'benchmark'
+
+DB = Sequel.sqlite
+DB.create_table :oria_test do
+  primary_key :id
+  String :key
+  String :value
+end
+
+n = (ARGV.shift || 1000).to_i
+
+Benchmark.bm(16) do |bm|
+  bm.report("SQLite3 (write):") do
+    table = DB[:oria_test]
+    n.times do
+      if foo = table[:key => 'foo']
+        foo.update(:value => 'bar')
+      else
+        table.insert(:key => 'foo', :value => 'bar')
+      end
+    end
+  end
+
+  bm.report("Oria (write):") do
+    n.times do
+      Oria['foo'] = 'bar'
+    end
+  end
+
+  bm.report("SQLite3 (read):") do
+    table = DB[:oria_test]
+    n.times do
+      foo = table[:key => 'foo']
+    end
+  end
+
+  bm.report("Oria (read):") do
+    n.times do
+      foo = Oria['foo']
+    end
+  end
+end

data/bin/oria

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 require 'optparse'
-# require 'rubygems'
-# require 'oria'
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'oria'))
+require 'rubygems'
+require 'oria'
+# require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'oria'))
 
 module OriaCommand
   def self.go
@@ -15,7 +15,7 @@ module OriaCommand
       stop
       start
     else
-      puts parser #"Usage: oria start|stop|restart"
+      puts parser
     end
   end
 
@@ -29,6 +29,9 @@ module OriaCommand
       opts.on('-h', '--host [IP]', 'The hostname or IP Oria should listen on.') do |host|
         @options[:host] = port
       end
+      opts.on('-d', '--debug', 'Log output to /tmp/oria.log') do |debug|
+        @options[:debug] = true
+      end
     end
   end
 

data/lib/oria/server.rb

@@ -3,10 +3,16 @@ require 'tmpdir'
 module Oria
   class Server < EventMachine::Connection
     class << self
+      @@timer = nil
+
       def debug?
         @@debug
       end
 
+      def log(value, app_key = nil)
+        logger.debug("#{"#{app_key}: " if app_key}#{value}") if debug?
+      end
+
       def logger
         require 'logger'
         @@logger ||= Logger.new(log_file, 0, 100 * 1024 * 1024) 
@@ -42,11 +48,14 @@ module Oria
         end
       end
 
-      def write_hash
-        @@write_hash ||= proc do
+      def store_hash(app_key)
+        @@timer.cancel if @@timer
+        @@timer = EventMachine::Timer.new(10) do
+          log "Writing changes to disk", app_key
           File.open(yaml_store, 'w') do |store|
             store.puts YAML.dump(@@servers)
           end
+          @@timer = nil
         end
       end
 
@@ -69,11 +78,11 @@ module Oria
     end
 
     def post_init
-      log "Client connected"
+      Oria::Server.log "Client connected"
     end
 
     def receive_data(data)
-      log "Responding to #{data}"
+      Oria::Server.log "Responding to #{data}"
       data = data.split(' ')
       method = data.shift
       data = JSON.parse(data.join(' '))
@@ -98,10 +107,12 @@ module Oria
       end
       if defined?(response)
         response = JSON.generate({:response => response})
-        log "Sending response: #{response}"
+        Oria::Server.log "Sending response: #{response}"
+        Oria::Server.store_hash(@app_key)
         send_data response
       end
-      EventMachine.defer(Oria::Server.write_hash)
+    rescue JSON::ParserError
+      send_data "Invalid request"
     end
 
     def unbind
@@ -112,12 +123,6 @@ module Oria
       @hash ||= @@servers[@app_key || 'default'] ||= {}
     end
 
-    def log(value)
-      if Oria::Server.debug?
-        Oria::Server.logger.debug(value)
-      end
-    end
-
     def random_key
       chars = ['a'..'z', 'A'..'Z', 0..9].map(&:to_a).flatten
       max = [hash.length, 2].max

data/oria.gemspec

@@ -5,13 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oria}
-  s.version = "0.0.1"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Flip Sasser"]
-  s.date = %q{2009-11-22}
+  s.date = %q{2009-11-23}
   s.default_executable = %q{oria}
-  s.description = %q{}
+  s.description = %q{
+      Oria (oh-rye-uh) is an in-memory, Ruby-based Key-Value store. It's designed to handle moderate amounts of data quickly
+      and easily without causing deployment issues or server headaches. It uses EventMachine to provide a networked interface
+      to a semi-persistent KVS and asynchronously writes the in-memory data to YAML files.
+    }
   s.email = %q{flip@x451.com}
   s.executables = ["oria"]
   s.extra_rdoc_files = [
@@ -19,15 +23,21 @@ Gem::Specification.new do |s|
      "README.markdown"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "LICENSE",
      "README.markdown",
      "Rakefile",
      "VERSION",
+     "benchmarks/mysql_table.sql",
+     "benchmarks/redis_v_oria.rb",
+     "benchmarks/sequel_v_oria.rb",
+     "benchmarks/sqlite_v_oria.rb",
      "bin/oria",
      "lib/oria.rb",
      "lib/oria/client.rb",
      "lib/oria/errors.rb",
      "lib/oria/server.rb",
+     "oria.gemspec",
      "spec/oria_spec.rb",
      "spec/rcov.opts",
      "spec/spec.opts",
@@ -49,14 +59,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_runtime_dependency(%q<json>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<json>, [">= 1.2.0"])
     else
       s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_dependency(%q<json>, [">= 2.0.0"])
+      s.add_dependency(%q<json>, [">= 1.2.0"])
     end
   else
     s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-    s.add_dependency(%q<json>, [">= 2.0.0"])
+    s.add_dependency(%q<json>, [">= 1.2.0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oria
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Flip Sasser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-22 00:00:00 -05:00
+date: 2009-11-23 00:00:00 -05:00
 default_executable: oria
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,10 +42,15 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
+- .gitignore
 - LICENSE
 - README.markdown
 - Rakefile
 - VERSION
+- benchmarks/mysql_table.sql
+- benchmarks/redis_v_oria.rb
+- benchmarks/sequel_v_oria.rb
+- benchmarks/sqlite_v_oria.rb
 - bin/oria
 - lib/oria.rb
 - lib/oria/client.rb