key_value 0.1.4 → 0.2.0

data/Gemfile

@@ -4,6 +4,8 @@ gem 'activerecord'
 
 group :dev do # not development <-> would add unneeded development dependencies in gemspec
   gem 'sqlite3'
+  gem 'mysql2', '~>0.2.0'
+  gem 'handlersocket'
   gem 'rake'
   gem 'rspec', '~>2'
   gem 'jeweler'

data/Gemfile.lock

@@ -15,20 +15,22 @@ GEM
     builder (2.1.2)
     diff-lcs (1.1.2)
     git (1.2.5)
+    handlersocket (0.0.2)
     i18n (0.5.0)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    mysql2 (0.2.7)
     rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.0)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
     sqlite3 (1.3.3)
     tzinfo (0.3.27)
 
@@ -37,7 +39,9 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord
+  handlersocket
   jeweler
+  mysql2 (~> 0.2.0)
   rake
   rspec (~> 2)
   sqlite3

data/Readme.md

@@ -24,23 +24,40 @@ Migration
 
 Usage
 =====
-    KeyValue['xxx'] = {:baz=>'foo'})
-    or KeyValue.set('xxx', {:baz=>'foo'})
-
+    # get
     KeyValue['xxx'] -> {:baz=>'foo'}
     or KeyValue.get('xxx') -> {:baz=>'foo'}
 
+    # set
+    KeyValue['xxx'] = {:baz=>'foo'})
+    or KeyValue.set('xxx', {:baz=>'foo'})
+
+    # delete
     KeyValue['xxx'] = nil
     or KeyValue.del('xxx')
 
+    # increment
     KeyValue.inc('xxx') # !! Not atomic
     or KeyValue.inc('xxx', 5)
 
+    # 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/)
+
+    KeyValue.handler_socket = {:host => '127.0.0.1', :port=>'9998', :database => 'foo_development'}
+
+    # all read requests use HandlerSocket
+    KeyValue['xxx'] # -> same as before but faster :)
+
 TODO
 ====
- - HandlerSocket support
+ - 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.1.4
+0.2.0

data/key_value.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{key_value}
-  s.version = "0.1.4"
+  s.version = "0.2.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-13}
+  s.date = %q{2011-05-14}
   s.email = %q{michael@grosser.it}
   s.files = [
     "Gemfile",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "key_value.gemspec",
     "lib/key_value.rb",
+    "spec/Readme.md",
     "spec/key_value_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/key_value.rb

@@ -1,11 +1,15 @@
 require 'active_record'
 
 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
 
   serialize :value
 
+  cattr_accessor :handler_socket
+
   # serialize would treat false the same as nil
   def value=(x)
     x = x.to_yaml unless x.nil?
@@ -13,7 +17,14 @@ class KeyValue < ActiveRecord::Base
   end
 
   def self.get(key)
-    KeyValue.find_by_key(key).try(:value)
+    if handler_socket
+      hs_connection.open_index(HS_INDEX, handler_socket[:database], 'key_values', 'index_key_values_on_key', 'value')
+      result = hs_connection.execute_single(HS_INDEX, '=', [key])
+      return unless result = result[1][0]
+      YAML.load(result[0])
+    else
+      KeyValue.find_by_key(key).try(:value)
+    end
   end
 
   def self.set(key, value)
@@ -48,4 +59,13 @@ class KeyValue < ActiveRecord::Base
       value
     end
   end
+
+  private
+
+  def self.hs_connection
+    @@hs_connection ||= begin
+      require 'handlersocket'
+      HandlerSocket.new(HS_DEFAULT_CONFIG.merge(handler_socket).slice(:host, :port))
+    end
+  end
 end

data/spec/Readme.md

@@ -0,0 +1,4 @@
+You can run the tests with sqlite.
+
+To get full handlersocket coverage, use `DB=mysql rake`.
+Handlersocket should be configured on localhost prot 9998 with database key_value_test.

data/spec/key_value_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path('spec/spec_helper')
 
 describe KeyValue do
   before do
+    KeyValue.handler_socket = false
     KeyValue.delete_all
   end
 
@@ -99,4 +100,31 @@ describe KeyValue do
       KeyValue.cache('xxx'){true}.should == false
     end
   end
+
+  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.delete_all
+      end
+
+      it "can get" do
+        KeyValue['xxx'] = '123'
+        KeyValue.should_not_receive(:find_by_key)
+        KeyValue['xxx'].should == '123'
+      end
+
+      it "can get nil" do
+        KeyValue['xxx'].should == nil
+      end
+
+      it "can get false" do
+        KeyValue['xxx'] = false
+        KeyValue.should_not_receive(:find_by_key)
+        KeyValue['xxx'].should == false
+      end
+    end
+  else
+    puts 'not running HandlerSocket specs'
+  end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,24 @@
 require 'active_record'
 
-# connect                                                                                                                                                                                                                                     
-ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => ":memory:"
-)
+# connect
+if ENV['DB'] == 'mysql'
+  puts 'using mysql'
+  ActiveRecord::Base.establish_connection(
+    :adapter => "mysql2",
+    :database => "key_values_test"
+  )
+else
+  puts 'using sqlite'
+  ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => ":memory:"
+  )
+end
 
 # create tables
 ActiveRecord::Schema.define(:version => 1) do
+  drop_table :key_values rescue nil
+
   create_table :key_values do |t|
     t.string :key, :null => false
     t.text :value, :null => false

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: key_value
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Roman Heinrich
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 +02:00
+date: 2011-05-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,7 @@ files:
 - VERSION
 - key_value.gemspec
 - lib/key_value.rb
+- spec/Readme.md
 - spec/key_value_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true