ropl 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,12 @@
 # Ropl
 
-TODO: Write a gem description
+There are plenty of ORMs out there.  With a K/V database like Riak,
+having an ORM means an awkward fit, since Riak doesn't natively 
+have any way to represent a Relationship.
+
+In a conversation with Nathan Aschbacher, it was pointed out that 
+all we really want in many cases is persistence.  So here it is -- 
+a stupidly simple Riak Object Persistence Layer. ROPL.
 
 ## Installation
 
@@ -18,7 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Take a look at test/test_composition_story.rb and test/test_oop_story.rb
+The later is the preferred usage.
 
 ## Contributing
 

data/Rakefile

@@ -4,7 +4,6 @@ require "bundler/gem_tasks"
 require 'rubygems'
 gem 'bundler'
 require 'bundler'
-require 'ripple'
 
 begin
   Bundler.setup(:default, :development)

data/lib/ropl.rb

@@ -1,5 +1,29 @@
-require "ropl/version"
+require 'riak'
+require 'ropl/composition'
 
 module Ropl
-  # Your code goes here...
+  class Ropl
+    def initialize(riak_client)
+      @riak_client = riak_client
+    end
+
+    def post(object)
+      robject = Riak::RObject.new @riak_client.bucket(object.class.name)
+      robject.content_type = 'application/x-marshalled-ruby-object'
+      robject.raw_data = Marshal::dump(object)
+      robject.store
+    end
+
+    def put(object, key)
+      robject = Riak::RObject.new @riak_client.bucket(object.class.name), key.to_s
+      robject.content_type = 'application/x-marshalled-ruby-object'
+      robject.raw_data = Marshal::dump(object)
+      robject.store.key
+    end
+
+    def get(klass, key)
+      robject = @riak_client.bucket(klass.name).get(key.to_s)
+      Marshal::load(robject.raw_data)
+    end
+  end
 end

data/lib/ropl/composition.rb

@@ -0,0 +1,36 @@
+module Ropl
+  module Composition
+    class Error < StandardError; end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    attr_accessor :ropl, :key
+
+    def persist
+      ropl = self.class.class_variable_get :@@ropl_object
+
+      raise Error if ropl.nil?
+
+      if @key.nil?
+        @key = ropl.post self
+      else
+        ropl.put self, @key
+      end
+      @key
+    end
+
+    module ClassMethods
+      def ropl(riak_client)
+        self.ancestors[0].class_variable_set :@@ropl_object, Ropl.new(riak_client)
+      end
+
+      def retrieve(key)
+        ropl = self.ancestors[0].class_variable_get :@@ropl_object
+        raise Error if ropl.nil?
+        ropl.get self.ancestors[0], key
+      end
+    end
+  end
+end

data/lib/ropl/version.rb

@@ -1,3 +1,3 @@
 module Ropl
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/ropl.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["clr@port49.com"]
   gem.description   = %q{Riak Object Persistence Layer}
   gem.summary       = %q{Why bother with an ORM? Just store the object. This is OOP, after all.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/clr/ropl"
 
   gem.add_dependency "riak-client", "~> 1.0.0"
 

data/test/helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'test/unit'
+require File.join('lib','ropl')

data/test/riak.yml

@@ -0,0 +1,9 @@
+:development:
+  :host: 127.0.0.1
+  :pb_port: 8081
+  :protocol: pbc
+
+:test:
+  :host: 127.0.0.1
+  :pb_port: 8081
+  :protocol: pbc

data/test/test_composition.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.join('..','helper'), __FILE__)
+
+class CompositeClass
+  include Ropl::Composition
+  attr_accessor :attribute_one, :attribute_two
+
+  def initialize(attribute_one, attribute_two)
+    @attribute_one = attribute_one
+    @attribute_two = attribute_two
+  end
+end
+
+class TestCompositeClass < Test::Unit::TestCase
+  def setup
+    riak_config = YAML.load(File.read(File.expand_path(File.join('..','riak.yml'), __FILE__)))[:test]
+    riak_client = Riak::Client.new riak_config
+    # set the persistence connection
+    CompositeClass.ropl riak_client
+  end
+
+  def test_post
+    # create some object without specifying the key
+    composite_class = CompositeClass.new 'post data', 'other post data'
+
+    # save it
+    assert composite_class.persist
+    assert !composite_class.key.nil?
+  end
+
+  def test_put
+    # create some object with a key
+    composite_class = CompositeClass.new 'put data', 'other put data'
+
+    # set the key
+    composite_class.key = 'put key'
+
+    # save it
+    response = composite_class.persist
+    assert 'put key', response
+  end
+
+  def test_put_then_get
+    # create some object with a key
+    composite_class = CompositeClass.new 'put data', 'other put data'
+    composite_class.key = 'put key'
+
+    # save it
+    composite_class.persist
+
+    # get the object back
+    composite_class = CompositeClass.retrieve 'put key'
+
+    assert_equal 'put data',       composite_class.attribute_one
+    assert_equal 'other put data', composite_class.attribute_two
+  end
+end

data/test/test_composition_story.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.join('..','helper'), __FILE__)
+
+class Animal
+  include Ropl::Composition
+
+  attr_accessor :type, :friends, :interests
+end
+
+class TestCompositionStory < Test::Unit::TestCase
+  def test_story
+    # set up Riak connection
+    riak_config = YAML.load(File.read(File.expand_path(File.join('..','riak.yml'), __FILE__)))[:test]
+    riak_client = Riak::Client.new riak_config
+
+    henry = Animal.new
+    henry.key       = 'henry'
+    henry.type      = :chicken
+    henry.friends   = 12
+    henry.interests = ["walking in the woods", "eating berries"]
+
+    timothy = Animal.new
+    timothy.key       = 'timothy'
+    timothy.type      = :bovine
+    timothy.friends   = 17
+    timothy.interests = ["walking in fields of grass", "eating berries", "hanging out with the family"]
+
+    # ... later on that evening,
+    # we decide that henry and timothy
+    # are worth keeping around
+
+    Animal.ropl riak_client
+
+    henry.persist
+    timothy.persist
+
+    # ... and then some time later,
+    # perhaps in a different context,
+    # we want to compare interests
+
+    henry   = Animal.retrieve 'henry'
+    timothy = Animal.retrieve 'timothy'
+
+    assert_equal ["eating berries"], henry.interests & timothy.interests
+  end
+end

data/test/test_oop_story.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.join('..','helper'), __FILE__)
+
+class Animal
+  attr_accessor :type, :friends, :interests
+end
+
+class TestOopStory < Test::Unit::TestCase
+  def test_story
+    # set up Riak connection and persistence object
+    riak_config = YAML.load(File.read(File.expand_path(File.join('..','riak.yml'), __FILE__)))[:test]
+    riak_client = Riak::Client.new riak_config
+    ropl        = Ropl::Ropl.new riak_client
+
+    # go about your day
+    henry = Animal.new
+    henry.type      = :chicken
+    henry.friends   = 12
+    henry.interests = ["walking in the woods", "eating berries"]
+
+    timothy = Animal.new
+    timothy.type      = :bovine
+    timothy.friends   = 17
+    timothy.interests = ["walking in fields of grass", "eating berries", "hanging out with the family"]
+
+    # later on that evening,
+    # we decide that henry and timothy
+    # are worth keeping around
+
+    ropl.put henry,   :henry
+    ropl.put timothy, :timothy
+
+    # then some time even later,
+    # perhaps in a different context,
+    # we want to compare interests
+
+    henry   = ropl.get Animal, :henry
+    timothy = ropl.get Animal, :timothy
+
+    assert_equal ["eating berries"], henry.interests & timothy.interests
+  end
+end

data/test/test_persisted_class.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.join('..','helper'), __FILE__)
+
+class PersistedClass
+  attr_accessor :attribute_one, :attribute_two
+end
+
+class TestPersistedClass < Test::Unit::TestCase
+  def setup
+    riak_config = YAML.load(File.read(File.expand_path(File.join('..','riak.yml'), __FILE__)))[:test]
+    riak_client = Riak::Client.new riak_config
+    @ropl       = Ropl::Ropl.new riak_client
+  end
+
+  def test_post
+    # create some object without a key
+    persisted_class = PersistedClass.new
+    persisted_class.attribute_one = 'post data'
+    persisted_class.attribute_two = 'other post data'
+
+    # save it
+    response = @ropl.post persisted_class
+    assert response
+  end
+
+  def test_put
+    # create some object with a key
+    persisted_class = PersistedClass.new
+    persisted_class.attribute_one = 'put data'
+    persisted_class.attribute_two = 'other put data'
+
+    # save it
+    response = @ropl.put persisted_class, 'put key'
+    assert_equal 'put key', response
+  end
+
+  def test_put_then_get
+    # create some object with a key
+    persisted_class = PersistedClass.new
+    persisted_class.attribute_one = 'put data'
+    persisted_class.attribute_two = 'other put data'
+
+    # save it
+    @ropl.put persisted_class, 'put key'
+
+    # get the object back
+    persisted_class = @ropl.get PersistedClass, 'put key'
+    assert_equal 'put data',       persisted_class.attribute_one
+    assert_equal 'other put data', persisted_class.attribute_two
+  end
+
+=begin
+  def test_a_thousand_ops
+    # create a thousand objects
+    objects = 1000.times.map do
+      random_ascii = lambda{|n| rand(n).times.map{rand(256).chr}.join}
+
+      # create some object with a key
+      persisted_class = PersistedClass.new
+      persisted_class.attribute_one = random_ascii.call(1000)
+      persisted_class.attribute_two = random_ascii.call(1000)
+
+      [persisted_class, random_ascii.call(20)]
+    end
+
+    # persist each object
+    start_time = Time.now
+    objects.each do |object|
+      # save it
+      @ropl.put *object
+    end
+    puts "\nOne thousand ops time elapsed: #{Time.now - start_time} seconds.\n"
+  end
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ropl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
-  requirement: &70174493876300 !ruby/object:Gem::Requirement
+  requirement: &70098053914280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70174493876300
+  version_requirements: *70098053914280
 description: Riak Object Persistence Layer
 email:
 - clr@port49.com
@@ -35,9 +35,16 @@ files:
 - README.md
 - Rakefile
 - lib/ropl.rb
+- lib/ropl/composition.rb
 - lib/ropl/version.rb
 - ropl.gemspec
-homepage: ''
+- test/helper.rb
+- test/riak.yml
+- test/test_composition.rb
+- test/test_composition_story.rb
+- test/test_oop_story.rb
+- test/test_persisted_class.rb
+homepage: https://github.com/clr/ropl
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -61,4 +68,10 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Why bother with an ORM? Just store the object. This is OOP, after all.
-test_files: []
+test_files:
+- test/helper.rb
+- test/riak.yml
+- test/test_composition.rb
+- test/test_composition_story.rb
+- test/test_oop_story.rb
+- test/test_persisted_class.rb