key_value 0.2.0 → 0.3.0

data/Readme.md

@@ -1,4 +1,4 @@
-Abuse Sql database as Key-Value Store
+Abuse Sql database as Key-Value Store that can be [750k-qps-crazy-fast](http://yoshinorimatsunobu.blogspot.com/2010/10/using-mysql-as-nosql-story-for.html) via HandlerSocket
 
 Install
 =======
@@ -6,12 +6,12 @@ Install
 
 Migration
 =========
-`rails g migration create_key_value`
+`rails g migration create_key_value` and paste in:
 
     class CreateKeyValue < ActiveRecord::Migration
       def self.up
-        create_table :key_values do |t|
-          t.string :key, :null => false
+        create_table :key_values, :id => false do |t|
+          t.string :key, :null => false, :primary => true
           t.text :value, :null => false
         end
         add_index :key_values, :key, :unique => true
@@ -43,10 +43,10 @@ Usage
     # cache
     KeyValue.cache('xxx'){ ..something expensive.. }
 
-HandlerSocket for [750k-qps](http://yoshinorimatsunobu.blogspot.com/2010/10/using-mysql-as-nosql-story-for.html),
-[Ubuntu natty guide](http://grosser.it/2011/05/14/installing-mysql-handlersocket-in-ubuntu-natty-for-ruby/)
+HandlerSocket ([Ubuntu natty guide](http://grosser.it/2011/05/14/installing-mysql-handlersocket-in-ubuntu-natty-for-ruby/)):
 
-    KeyValue.handler_socket = {:host => '127.0.0.1', :port=>'9998', :database => 'foo_development'}
+    KeyValue.handler_socket = true
+    # or Hash with any of these keys :host :port :database :timeout :listen_backlog :sndbuf :rcvbuf
 
     # all read requests use HandlerSocket
     KeyValue['xxx'] # -> same as before but faster :)
@@ -54,9 +54,7 @@ HandlerSocket for [750k-qps](http://yoshinorimatsunobu.blogspot.com/2010/10/usin
 TODO
 ====
  - nice error handling for HandlerSocket
- - reuse host/database from normal connection for HandlerSocket
  - HandlerSocket write support
- - use 'key' column as primary key <-> any problems with that ?
  - make test database configurable
 
 Authors

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/key_value.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{key_value}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roman Heinrich", "Michael Grosser"]
-  s.date = %q{2011-05-14}
+  s.date = %q{2011-05-15}
   s.email = %q{michael@grosser.it}
   s.files = [
     "Gemfile",

data/lib/key_value.rb

@@ -4,8 +4,8 @@ class KeyValue < ActiveRecord::Base
   HS_DEFAULT_CONFIG = {:port => '9998'}
   HS_INDEX = 31234 # just some high number...
   VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
-  validates_presence_of :key
 
+  set_primary_key :key
   serialize :value
 
   cattr_accessor :handler_socket
@@ -18,7 +18,7 @@ class KeyValue < ActiveRecord::Base
 
   def self.get(key)
     if handler_socket
-      hs_connection.open_index(HS_INDEX, handler_socket[:database], 'key_values', 'index_key_values_on_key', 'value')
+      open_key_index
       result = hs_connection.execute_single(HS_INDEX, '=', [key])
       return unless result = result[1][0]
       YAML.load(result[0])
@@ -31,7 +31,10 @@ class KeyValue < ActiveRecord::Base
     if value.nil?
       KeyValue.delete_all(:key => key)
     else
-      record = KeyValue.find_by_key(key) || KeyValue.new(:key => key)
+      unless record = KeyValue.find_by_key(key)
+        record = KeyValue.new
+        record.key = key # no mass assignment on primary key
+      end
       record.value = value
       record.save!
       value
@@ -63,9 +66,18 @@ class KeyValue < ActiveRecord::Base
   private
 
   def self.hs_connection
-    @@hs_connection ||= begin
+    @hs_connection ||= begin
       require 'handlersocket'
-      HandlerSocket.new(HS_DEFAULT_CONFIG.merge(handler_socket).slice(:host, :port))
+      HandlerSocket.new(hs_connection_config)
     end
   end
+
+  def self.hs_connection_config
+    given = (handler_socket == true ? {} : handler_socket)
+    HS_DEFAULT_CONFIG.merge(connection_pool.spec.config.merge(given))
+  end
+
+  def self.open_key_index
+    @open_key_index ||= hs_connection.open_index(HS_INDEX, hs_connection_config[:database], table_name, "index_#{table_name}_on_key", 'value')
+  end
 end

data/spec/key_value_spec.rb

@@ -104,7 +104,7 @@ describe KeyValue do
   if ENV['DB'] == 'mysql'
     describe 'with handlersocket' do
       before do
-        KeyValue.handler_socket = {:host => '127.0.0.1', :port => '9998', :database => 'key_values_test'}
+        KeyValue.handler_socket = true
         KeyValue.delete_all
       end
 
@@ -123,6 +123,26 @@ describe KeyValue do
         KeyValue.should_not_receive(:find_by_key)
         KeyValue['xxx'].should == false
       end
+
+      it "uses defaults" do
+        KeyValue.send(:hs_connection_config).except(:username, :password).should == {
+          :flags=>2,
+          :port=>"9998",
+          :adapter=>"mysql2",
+          :database=>"key_values_test"
+        }
+      end
+
+      it "merges in my given settings" do
+        KeyValue.handler_socket = {:port => '123'}
+        KeyValue.send(:hs_connection_config).except(:username, :password).should == {
+          :flags=>2,
+          :port=>"123",
+          :adapter=>"mysql2",
+          :database=>"key_values_test"
+        }
+
+      end
     end
   else
     puts 'not running HandlerSocket specs'

data/spec/spec_helper.rb

@@ -19,8 +19,8 @@ end
 ActiveRecord::Schema.define(:version => 1) do
   drop_table :key_values rescue nil
 
-  create_table :key_values do |t|
-    t.string :key, :null => false
+  create_table :key_values, :id => false do |t|
+    t.string :key, :null => false,:primary => true
     t.text :value, :null => false
   end
   add_index :key_values, :key, :unique => true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: key_value
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Roman Heinrich
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-14 00:00:00 +02:00
+date: 2011-05-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency