riaktor 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-03-15
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/riaktor.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_riaktor.rb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on riaktor, see http://riaktor.rubyforge.org and
+http://wiki.github.com/benmyles/riaktor/.
+

data/README.rdoc

@@ -0,0 +1,70 @@
+= Riaktor
+
+* http://github.com/benmyles/riaktor
+
+== DESCRIPTION:
+
+Riaktor is a Ruby client and object mapper for Riak (http://riak.basho.com/).
+It's brand new and probably has bugs, but feel free to try it out.
+
+== FEATURES/PROBLEMS:
+
+* Fast: all GETs are concurrent, support for concurrent PUTs and DELETEs.
+  Operations like find_many on a document make this transparent.
+
+* Attributes: split your document up into attributes so that you reduce the
+  chance of conflicts and better spread out your data.
+
+* Indexes: create basic, arbitrary indexes on your Riak objects with one line.
+
+* Associations: define associations with one line. Uses the Riak links feature
+  so that you'll be able to do easy map reduce functions. Also supports paging
+  through your association members so that you don't need to load them all
+  at once.
+
+== SYNOPSIS:
+
+  See tests. Better documentation coming soon to the Wiki.
+
+== REQUIREMENTS:
+
+* Ruby 1.9+
+* Rails 3.0 beta (Riaktor doesn't care if it's used within a Rails project or not
+  but it does rely on Active Model and Active Support).
+
+== INSTALL:
+
+$ gem install tzinfo builder memcache-client rack rack-test rack-mount erubis mail text-format thor bundler i18n
+$ gem install rails --pre
+$ gem install riaktor
+
+== LINKS:
+
+* Documentation: http://wiki.github.com/benmyles/riaktor/
+* Email: ben dot myles at gmail dot com
+* Twitter: benmyles
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Ben Myles
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/riaktor'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'riaktor' do
+  self.developer 'Ben Myles', 'ben.myles@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+  self.extra_deps           = [ ['typhoeus',"= 0.1.22"],
+                                ['uuidtools','= 2.1.1'],
+                                ['yajl-ruby', '= 0.7.4'],
+                                ['activesupport', '= 3.0.0.beta'],
+                                ["activemodel", '= 3.0.0.beta'] ]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/riaktor.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+gem "typhoeus", "= 0.1.22"
+require "typhoeus"
+
+gem 'uuidtools','= 2.1.1'
+require 'uuidtools'
+
+gem 'yajl-ruby', '= 0.7.4'
+require 'yajl'
+
+gem "activesupport", '= 3.0.0.beta'
+require "active_support/all"
+
+gem "activemodel", '= 3.0.0.beta'
+require "active_model"
+  
+module Riaktor
+  VERSION = '0.0.1'
+end
+
+require "#{File.dirname(__FILE__)}/riaktor/client"
+require "#{File.dirname(__FILE__)}/riaktor/r_object"
+require "#{File.dirname(__FILE__)}/riaktor/document"

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/riaktor.rb'}"
+puts "Loading riaktor gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/riaktor'
+
+class Person < Riaktor::Document::Base
+  attribute :occupation
+  attribute :age
+  attribute :updated_at
+  attribute :phone_number
+  
+  index :phone_number
+  
+  association :friends, :class => :person
+  
+  validates_presence_of :age
+  
+  before_save :set_updated_at
+  
+  protected
+  
+  def set_updated_at
+    self.updated_at.value = Time.now.utc
+  end
+end

data/test/test_riaktor.rb

@@ -0,0 +1,312 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRiaktor < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_document
+    if p = Person.find("ben")
+      assert p.destroy
+      sleep(0.01)
+      assert_nil Person.find("ben")
+    end
+    
+    p = Person.new
+    p.key = "ben"
+    p.value = "Ben Myles"
+    p.age.value = 20
+    assert p.save
+    
+    p = Person.find("ben")
+    assert_equal "Ben Myles", p.value
+    p.occupation.value = "something"
+    p.age.value = 26
+    assert p.save
+    
+    p = Person.find("ben")
+    assert_equal "something", p.occupation.value
+    assert_equal 26, p.age.value
+  end
+  
+  def test_destroy
+    if p = Person.find("test_destroy")
+      assert p.destroy
+      sleep(0.01)
+      assert_nil Person.find("test_destroy")
+    end
+    
+    p = Person.new
+    p.key = "test_destroy"
+    p.value = "test_destroy value"
+    p.age.value = 20
+    assert p.save
+    
+    assert Person.find("test_destroy")
+    assert Riaktor::Document::Attribute.find(p.age.key, {:bucket => p.bucket})
+    assert p.destroy; sleep(0.01)
+
+    assert_nil Person.find("test_destroy")
+    assert_nil Riaktor::Document::Attribute.find(p.age.key, {:bucket => p.bucket})
+  end
+  
+  def test_find_many
+    keys = []
+    1.upto(25) do |i|
+      if p = Person.find("person#{i}")
+        p.destroy; sleep(0.01)
+      end
+      p = Person.new(:key => "person#{i}", :value => "value#{i}")
+      p.age.value = i
+      assert p.save
+      keys << p.key
+    end
+    results = Person.find_many(keys)
+    1.upto(25) do |i|
+      p = results["person#{i}"]
+      assert_equal "value#{i}", p.value
+      assert_equal i, p.age.value
+    end
+  end
+  
+  def test_save_many_and_destroy_many
+    keys = []
+    1.upto(25) { |i| keys << "person#{i}" }
+    if people = Person.find_many(keys) and !people.empty?
+      results = Person.destroy_many(people.collect { |k,v| v })
+      results.each { |k,v| assert v == true }
+    end; sleep(0.01)
+    
+    docs = []
+    
+    1.upto(25) do |i|
+      assert_nil Person.find("person#{i}")
+      p = Person.new(:key => "person#{i}", :value => "value#{i}")
+      p.age.value = i
+      docs << p
+    end
+
+    results = Person.save_many(docs)
+    results.each { |doc,res| assert res == true }
+    
+    1.upto(25) do |i|
+      p = Person.find("person#{i}")
+      assert_equal "value#{i}", p.value
+      assert_equal i, p.age.value
+    end
+    
+    keys = []
+    1.upto(25) { |i| keys << "person#{i}" }
+    if people = Person.find_many(keys) and !people.empty?
+      results = Person.destroy_many(people.collect { |k,v| v })
+      results.each { |k,v| assert v == true }
+    end
+    
+    sleep(0.01)
+    
+    1.upto(25) do |i|
+      assert_nil Person.find("person#{i}")
+    end
+  end
+  
+  def test_validations
+    p = Person.new(:key => "test_validations")
+    assert !p.save
+    assert_equal({:age=>["can't be blank"]}, p.errors)
+  end
+  
+  def test_non_unique_key
+    unless p = Person.find("ben")
+      p = Person.new
+      p.key = "ben"
+      p.value = "Ben Myles"
+      p.age.value = 20
+      assert p.save
+    end
+    
+    p = Person.new(:key => "ben")
+    assert !p.save
+    assert_equal({:key=>["is not unique"]}, p.errors)
+  end
+  
+  def test_cannot_save_attributes_if_doc_is_not_valid
+    unless p = Person.find("ben")
+      p = Person.new
+      p.key = "ben"
+      p.value = "Ben Myles"
+      p.age.value = 20
+      assert p.save
+    end
+    
+    p.occupation.value = "engineer"
+    assert p.occupation.save
+    assert p.valid?
+    p.age.value = nil
+    assert !p.valid?
+    assert !p.occupation.save
+  end
+  
+  def test_callbacks
+    unless p = Person.find("ben")
+      p = Person.new
+      p.key = "ben"
+      p.value = "Ben Myles"
+      p.age.value = 20
+    end
+    assert p.save
+    assert p.updated_at.value.is_a?(Time)
+    t1 = p.updated_at.value
+    assert p.save
+    assert p.updated_at.value.is_a?(Time)
+    assert p.updated_at.value > t1
+  end
+  
+  def test_siblings
+    props = Riaktor::Client.bucket_props("person")
+    props["props"]["allow_mult"] = true
+    assert Riaktor::Client.set_bucket_props("person", props)
+    props = Riaktor::Client.bucket_props("person")
+    assert props["props"]["allow_mult"] == true
+    
+    if p = Person.find("test_siblings")
+      assert p.resolved!
+      assert p.age.resolved!
+      assert p.updated_at.resolved!
+      assert p.destroy
+      sleep(0.1)
+      assert_nil Person.find("test_siblings")
+    end
+    
+    Riaktor::Client.client_id = "client1"
+    unless client1_p = Person.find("test_siblings")
+      client1_p = Person.new
+      client1_p.key = "test_siblings"
+      client1_p.value = "client1 value"
+      client1_p.age.value = 20
+    end
+    assert client1_p.save
+    
+    client2_p = Person.find("test_siblings")
+    assert_equal 20, client2_p.age.value
+    assert_equal "client1 value", client2_p.value
+
+    Riaktor::Client.client_id = "client1"
+    client1_p.value = "client1 value II"
+    client1_p.age.value = 21
+    assert client1_p.save
+    
+    Riaktor::Client.client_id = "client2"
+    client2_p.value = "client2 value"
+    client2_p.age.value = 22
+    assert client2_p.save
+    
+    assert_equal 2, client2_p.siblings.keys.size
+    assert_equal 2, client2_p.age.siblings.keys.size
+    assert_equal 2, client2_p.updated_at.siblings.keys.size
+    assert client2_p.in_conflict?
+    client2_p.value = "client2 value"
+    client2_p.resolved!
+    assert client2_p.in_conflict?
+    client2_p.age.value = 23
+    client2_p.age.resolved!
+    client2_p.updated_at.resolved!
+    assert !client2_p.in_conflict?
+    assert client2_p.save
+    
+    p = Person.find("test_siblings")
+    assert_equal "client2 value", p.value
+    assert_equal 23, p.age.value
+  end
+  
+  def test_indexes
+    if p = Person.find("test_indexes")
+      assert p.destroy
+    end
+    
+    p = Person.new(:key => "test_indexes")
+    p.value = "Ben Myles"
+    p.age.value = 26
+    p.phone_number.value = "555-444-5555"
+    assert p.save
+    
+    p = Person.find_with_index(:phone_number, "555-444-5555")
+    assert p
+    assert_equal "555-444-5555", p.phone_number.value
+    p.phone_number.value = "555-555-5555"
+    assert p.save
+    assert_nil Person.find_with_index(:phone_number, "555-444-5555")
+    p = Person.find_with_index(:phone_number, "555-555-5555")
+    assert p
+    assert p.destroy
+    assert_nil Person.find_with_index(:phone_number, "555-444-5555")
+  end
+  
+  def test_links
+    ["test_links_ben","test_links_chris", "test_links_sean"].each do |key|
+      if p = Person.find(key)
+        p.destroy
+      end
+    end
+    
+    ben = Person.new(:key => "test_links_ben")
+    ben.value = "Ben"
+    ben.age.value = 26
+    ben.phone_number.value = "555-444-5555"
+    assert ben.save
+    ben.age.value = 25
+    assert ben.save
+
+    chris = Person.new(:key => "test_links_chris")
+    chris.value = "Chris"
+    chris.age.value = 26
+    chris.phone_number.value = "555-555-5555"
+    assert chris.save
+
+    sean = Person.new(:key => "test_links_sean")
+    sean.value = "Sean"
+    sean.age.value = 26
+    sean.phone_number.value = "123-555-5555"
+    assert sean.save
+    
+    assert_equal [], ben.links
+    assert_equal [], ben.friends.members
+    assert ben.friends << chris
+    assert_equal 1, ben.friends.members.size
+    assert_equal 1, ben.links.size
+    
+    ben = Person.find("test_links_ben")
+    assert_equal [], ben.links
+    assert_equal [], ben.friends.members
+    assert ben.friends << chris
+    assert_equal 1, ben.friends.members.size
+    assert_equal 1, ben.links.size
+    assert ben.friends.save
+    
+    ben = Person.find("test_links_ben")
+    assert_equal 1, ben.friends.members.size
+    assert_equal 1, ben.links.size
+    assert_equal chris, ben.friends.members.first
+    
+    ben.friends << sean
+    assert ben.friends.save
+    assert_equal 2, ben.friends.members.size
+    assert_equal 2, ben.links.size
+    assert_equal chris, ben.friends.members.first
+    ben = Person.find("test_links_ben")
+    assert_equal 2, ben.friends.members.size
+    assert_equal 2, ben.links.size
+    assert_equal chris, ben.friends.members.first
+    assert_equal [chris], ben.friends.members(0,0)
+    assert_equal [sean], ben.friends.members(1,1)
+    assert_equal [chris,sean], ben.friends.members
+    
+    assert ben.friends.remove(chris)
+    assert_equal 1, ben.links.size
+    assert_equal 1, ben.friends.members.size
+    assert ben.friends.save
+    
+    ben = Person.find("test_links_ben")
+    assert_equal 1, ben.links.size
+    assert_equal 1, ben.friends.members.size
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: riaktor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Myles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 22
+        version: 0.1.22
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id008
+description: |-
+  Riaktor is a Ruby client and object mapper for Riak (http://riak.basho.com/).
+  It's brand new and probably has bugs, but feel free to try it out.
+email: 
+- ben.myles@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/riaktor.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_riaktor.rb
+has_rdoc: true
+homepage: http://github.com/benmyles/riaktor
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: riaktor
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Riaktor is a Ruby client and object mapper for Riak (http://riak.basho.com/)
+test_files: 
+- test/test_helper.rb
+- test/test_riaktor.rb