rico 0.4.0 → 0.5.0

data/README.md

@@ -14,28 +14,6 @@ Add rico to your Gemfile and `bundle install`:
 gem "rico"
 ```
 
-## Usage
-
-Instantiate a Rico object with a **bucket** and a **key** then perform operations.
-
-Here's an example of how to use a set to manage a list of followed users:
-
-```ruby
-follows = Rico::Set.new "follows", @user.id
-
-follows.member? @other_user.id  # => false
-
-follows.add @other_user.id
-
-follows.member? @other_user.id  # => true
-follows.length                  # => 1
-
-follows.remove @other_user.id
-
-follows.member? @other_user.id  # => false
-follows.length                  # => 0
-```
-
 ## Configuration
 
 By default, Rico uses a generic Riak::Client instance for operations. You can specify your own options for the Riak client (perhaps inside of a rails initializer) like so:
@@ -55,15 +33,18 @@ Rico.configure do |c|
 end
 ```
 
-## Data Types
+## Supported Data Types
 
 **Arrays** - sequence of values
 
 ```ruby
 a = Rico::Array.new "bucket", "key"
-a.add [3, 1, 1, 4, 2]
-a.members   # => [3, 1, 1, 4, 2]
-a.length    # => 5
+a.add [3, 1, 1, 4, 2]   # writes to riak
+a.members               # => [3, 1, 1, 4, 2]
+a.length                # => 5
+a.remove [2, 4]         # writes to riak
+a.members               # => [3, 1, 1]
+a.raw_data              # => '{"_type":"array","_values":[3,1,1],"_deletes":[2,4]}'
 ```
 
 **Lists** - sorted sequence of values
@@ -71,8 +52,7 @@ a.length    # => 5
 ```ruby
 l = Rico::List.new "bucket", "key"
 l.add [3, 1, 1, 4, 2]
-l.members   # => [1, 1, 2, 3, 4]
-l.length    # => 5
+l.members               # => [1, 1, 2, 3, 4]
 ```
 
 **Sets** - unique sequence of values
@@ -80,8 +60,7 @@ l.length    # => 5
 ```ruby
 s = Rico::Set.new "bucket", "key"
 s.add [3, 1, 1, 4, 2]
-s.members   # => [3, 1, 4, 2]
-s.length    # => 4
+s.members               # => [3, 1, 4, 2]
 ```
 
 **Sorted Sets** - unique, sorted sequence of values
@@ -89,8 +68,8 @@ s.length    # => 4
 ```ruby
 s = Rico::SortedSet.new "bucket", "key"
 s.add [3, 1, 1, 4, 2]
-s.members   # => [1, 2, 3, 4]
-s.length    # => 4
+s.members               # => [1, 2, 3, 4]
+s.reduce(&:+)
 ```
 
 **Maps** - key-value mappings
@@ -99,8 +78,7 @@ s.length    # => 4
 m = Rico::Map.new "bucket", "key"
 m.add({"a" => 1})
 m.add({"b" => 2, "c" => 3})
-m.members   # => {"a" => 1, "b" => 2, "c" => 3}
-m.length    # => 3
+m.members               # => {"a"=>1, "b"=>2, "c"=>3}
 ```
 
 **Sorted Maps** - key-value mappings sorted by key
@@ -109,8 +87,8 @@ m.length    # => 3
 m = Rico::SortedMap.new "bucket", "key"
 m.add({"b" => 2, "c" => 3})
 m.add({"a" => 1})
-m.members   # => {"a" => 1, "b" => 2, "c" => 3}
-m.length    # => 3
+m.members               # => {"a"=>1, "b"=>2, "c"=>3}
+m.raw_data              # => '{"_type":"smap","_values":{"a":1,"b":2,"c":3}}'
 ```
 
 **Capped Sorted Maps** - key-value mappings sorted by key and bound by size
@@ -119,19 +97,17 @@ m.length    # => 3
 m = Rico::CappedSortedMap.new "bucket", "key", limit: 2
 m.add({"b" => 2, "c" => 3})
 m.add({"a" => 1})
-m.members   # => {"b" => 2, "c" => 3}
-m.length    # => 2
+m.members               # => {"b"=>2, "c"=>3}
+m.length                # => 2
 ```
 
 **Values** - generic serialized values
 
 ```ruby
 v = Rico::Value.new "bucket", "key"
-v.exists?   # => false
-v.get       # => nil
+v.get                   # => nil
 v.set "bob"
-v.get       # => "bob"
-v.exists?   # => true
+v.get                   # => "bob"
 ```
 
 ## Content Types
@@ -144,10 +120,43 @@ v.exists?   # => true
 s = Rico::Set.new "bucket", "key"
 s.content_type = "application/x-gzip"
 s.add [1,2,3]
-s.get       # => [1, 2, 3]
-s.raw_data  # => "\u001F\x8B\b\u0000G...."
+s.members               # => [1, 2, 3]
+s.data                  # => {"_type"=>"set", "_values"=>[1, 2, 3]}
+s.raw_data              # => "\u001F\x8B\b\u0000G...."
 ```
 
+## Under The Hood
+
+Objects are stored in a simple map encoded to JSON.
+
+**Array, List, Set and SortedSet** types look like this:
+
+```json
+{ "_type": "sset", "_values": [1,2,3], "_deletes": [4] }
+```
+
+The *_deletes* field acts as a temporary tombstone for preserve deletes during conflict resolution. The field will normally contain the deletes processed during the last write, or the cumulative deletes processed during the last sibling merge. The value of _deletes is intentionally forgotten after a successful read and will not taint future operations.
+
+Conflict resolution works by adding the difference between value arrays, removing deleted values and returning the result. This implementation is susceptible to sticky deletes - if different clients delete and add the same value simultenously the delete will ultimately win and the value is left out.
+
+**Map, SortedMap and CappedSortedMap** types look like this:
+
+```json
+{ "_type": "csmap", "_values": {"a": 1, "b": 2, "c": 3}, "_deletes": ["d"] }
+```
+
+The *_deletes* field for map objects contains only the keys deleted.
+
+Conflict resolution works by merging value hashes, removing deleted keys and returning the result. This implementation is susceptible to sticky deletes - if different clients delete and add the same key simultenously the delete will ultimately win and the value is left out.
+
+**Value** type looks like this:
+
+```json
+{ "_type": "value", "_value": "Hipsters love modern folk rock" }
+```
+
+Conflict resolution is handled by last-write-wins.
+
 ## Notes
 
 ### Enumerable
@@ -158,10 +167,6 @@ Enumerable-looking types are indeed Enumerable
 
 Data is persisted at operation time. For example, List#add(5) will immediately update the record in Riak. It'd generally be wise to compute a list of values to be added or removed and then issue a single operation.
 
-## TODO
-
-- Ability to provide custom sibling resolution callbacks
-
 ## Contributing
 
 1. Fork it

data/lib/rico.rb

@@ -23,10 +23,11 @@ module Rico
   TYPES = {
     "Array" => "array",
     "List" => "list",
-    "Map" => "map",
-    "Set" => "set",
     "SortedSet" => "sset",
+    "Set" => "set",
+    "Map" => "map",
     "SortedMap" => "smap",
+    "CappedSortedMap" => "csmap",
     "Value" => "value"
   }
 

data/lib/rico/array.rb

@@ -7,7 +7,9 @@ module Rico
     #
     # Returns the data in the object as an array
     def members
-      Array((data || {})["_values"])
+      assert_type(::Array) do
+        data["_values"] || []
+      end
     end
 
     # Resolve conflict between one or more RObject siblings
@@ -35,18 +37,38 @@ module Rico
 
     protected
 
+    # Constructs a document map for the given operation
+    #
+    # items - Items to add to members
+    #
+    # Returns a Hash representing the document map
     def build_map_add(items)
       { "_type" => type_key, "_values" => compute_add(items) }
     end
 
+    # Constructs a document map for the given operation
+    #
+    # items - Items to remove to members
+    #
+    # Returns a Hash representing the document map
     def build_map_remove(items)
       { "_type" => type_key, "_values" => compute_remove(items), "_deletes" => items }
     end
 
+    # Add items to our member array
+    #
+    # items - Items to add
+    #
+    # Returns an Array of the resulting addition
     def compute_add(items)
       members + Array(items)
     end
 
+    # Remove items from our member array
+    #
+    # items - Items to remove. Can be an array of values or a single object
+    #
+    # Returns an Array of the new object
     def compute_remove(items)
       members - Array(items)
     end

data/lib/rico/map.rb

@@ -7,7 +7,9 @@ module Rico
     #
     # Returns the data in the object as an array
     def members
-      ((data || {})["_values"] || {})
+      assert_type(::Hash) do
+        data["_values"] || {}
+      end
     end
 
     # Resolve conflict between one or more RObject siblings
@@ -29,19 +31,39 @@ module Rico
 
     protected
 
+    # Constructs a document map for the given operation
+    #
+    # items - Items to add to members
+    #
+    # Returns a Hash representing the document map
     def build_map_add(items)
       { "_type" => type_key, "_values" => compute_add(items) }
     end
 
+    # Constructs a document map for the given operation
+    #
+    # items - Items to remove to members
+    #
+    # Returns a Hash representing the document map
     def build_map_remove(items)
       keys = extract_keys(items)
       { "_type" => type_key, "_values" => compute_remove(items), "_deletes" => keys }
     end
 
+    # Add items to our member hash
+    #
+    # items - Items to add
+    #
+    # Returns a Hash of the resulting merge
     def compute_add(items)
       members.merge(items)
     end
 
+    # Remove items from our member hash
+    #
+    # items - Items to remove. Can be a hash, array of keys or single key
+    #
+    # Returns a Hash of the new object
     def compute_remove(items)
       keys = extract_keys(items)
       members.delete_if {|k,v| keys.include? k.to_s }

data/lib/rico/object.rb

@@ -2,7 +2,7 @@ module Rico
   module Object
     extend Forwardable
 
-    def_delegators :riak_object, :conflict?, :content_type, :content_type=, :data, :delete, :store, :raw_data
+    def_delegators :riak_object, :conflict?, :content_type, :content_type=, :delete, :store, :raw_data
 
     attr_accessor :bucket, :key
 
@@ -17,6 +17,19 @@ module Rico
       options.each {|k,v| send("#{k}=", v)}
     end
 
+    # Retrieves data from Riak
+    #
+    # Raises an error on type mismatch
+    def data
+      result = riak_object.data || {}
+
+      if result["_type"] && (result["_type"] != type_key)
+        raise TypeError, "#{@bucket}:#{@key} expected type to be #{type_key}, got #{result["_type"]}"
+      end
+
+      result
+    end
+
     # Sets a new value on the object and stores it
     #
     # value - new value to set
@@ -36,11 +49,33 @@ module Rico
 
     protected
 
+    # Determines an appropriate type key for the object
+    #
+    # Returns a String
     def type_key
       name = self.class.name.split("::").last
       Rico::TYPES[name]
     end
 
+    # Verifies the result of a given block is of a given type.
+    #
+    # klass - Class to test type
+    # block - Block to call that produces value for test
+    #
+    # Returns the result of the block on success, raises a TypeError on failure
+    def assert_type(klass, &block)
+      value = block.call
+
+      unless value.class == klass
+        raise TypeError, "#{@bucket}:#{@key} expected value to be #{klass.name}, got #{value.class}"
+      end
+
+      value
+    end
+
+    # Instantiates and memoizes a Riak::RObject instance for our bucket and key
+    #
+    # Returns the Riak::RInstance object
     def riak_object
       @riak_object ||= Rico.bucket(@bucket).get_or_new @key
     end

data/lib/rico/value.rb

@@ -5,14 +5,18 @@ module Rico
     # Gets the value of the object
     #
     # Returns the deserialized value
-    alias_method :get, :data
+    def get
+      data["_value"]
+    end
 
     # Sets and stores the new value for the object
     #
     # value - the new value to store
     #
     # Returns the result of the store operation
-    alias_method :set, :mutate
+    def set(value)
+      mutate build_map(value)
+    end
 
     # Sets the value if it does not exist
     #
@@ -36,9 +40,22 @@ module Rico
     #
     # Returns a single RObject result or nil
     def self.resolve(robject)
-      obj = Riak::RObject.new(robject.bucket, robject.key)
-      obj.data = robject.siblings.first.data
+      winner = robject.siblings.sort {|a,b| b.last_modified <=> a.last_modified }.first
+
+      obj = robject.dup
+      obj.siblings = [winner]
       obj
     end
+
+    protected
+
+    # Constructs a document map for the new value
+    #
+    # value - Value to include in map
+    #
+    # Returns a Hash representing the document map
+    def build_map(value)
+      { "_type" => type_key, "_value" => value }
+    end
   end
 end

data/lib/rico/version.rb

@@ -1,3 +1,3 @@
 module Rico
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/array_spec.rb

@@ -97,6 +97,13 @@ describe Rico::Array do
   end
 
   describe "#members" do
+    it "asserts value type as array" do
+      a = Rico::Map.new RiakHelpers.bucket, "array_members_assert_type"
+      a.add({"a" => 1})
+      b = Rico::Array.new RiakHelpers.bucket, "array_members_assert_type"
+      lambda { b.members }.should raise_error(TypeError)
+    end
+
     it "returns a list of members" do
       a = Rico::Array.new RiakHelpers.bucket, "array_members_lists"
       a.add [{"usd" => 123.41, "cad" => 61.89}, "Bears", "Beets", "Battlestar Galactica", 3.14159, 71]

data/spec/map_spec.rb

@@ -85,6 +85,15 @@ describe Rico::Map do
     end
   end
 
+  describe "#members" do
+    it "asserts value type as hash" do
+      a = Rico::Array.new RiakHelpers.bucket, "map_members_assert_type"
+      a.add [1,2,3]
+      b = Rico::Map.new RiakHelpers.bucket, "map_members_assert_type"
+      lambda { b.members }.should raise_error(TypeError)
+    end
+  end
+
   describe "#length" do
     it "returns zero for an empty list" do
       a = Rico::Map.new RiakHelpers.bucket, "map_length_empty"

data/spec/value_spec.rb

@@ -25,7 +25,7 @@ describe Rico::Value do
       a = Rico::Value.new RiakHelpers.bucket, "value_gzip_content_type"
       a.content_type = "application/x-gzip"
       a.set "JOHN DOE"
-      gunzip(a.raw_data).should eql "\"JOHN DOE\""
+      gunzip(a.raw_data).should eql({"_type" => "value", "_value" => "JOHN DOE"}.to_json)
       a.content_type.should eql "application/x-gzip"
     end
 
@@ -108,23 +108,27 @@ describe Rico::Value do
   end
 
   describe ".resolve" do
-    it "just returns the first sibling" do
-      datas = ["Tom", "Jerry"]
-      conflicted = RiakHelpers.build_conflicted_robject "value_resolve_simple", datas
-      result = Rico::Value.resolve(conflicted)
-      result.data.should eql "Tom"
-    end
-
-    it "properly deletes deleted values after resolve" do
+    it "just returns the last modified sibling" do
       datas = [
-        { "_type" => "array", "_values" => [1,2,3,4] },
-        { "_type" => "array", "_values" => [1,2,3], "_deletes" => [4] }
+        { "_type" => "value", "_value" => "Oldest" },
+        { "_type" => "value", "_value" => "Middle" },
+        { "_type" => "value", "_value" => "Newest" },
+        { "_type" => "value", "_value" => "Middle" },
+        { "_type" => "value", "_value" => "Middle" }
       ]
-      conflicted = RiakHelpers.build_conflicted_robject "array_resolve_delete", datas
-      result = Rico::Array.resolve(conflicted)
-      result.data["_values"].should eql [1,2,3]
-      result.data["_deletes"].should eql [4]
+      times = [
+        Time.utc(2012, 10, 10, 10, 10, 10),
+        Time.utc(2013, 10, 10, 10, 10, 10),
+        Time.utc(2014, 10, 10, 10, 10, 10),
+        Time.utc(2013, 10, 10, 10, 10, 10),
+        Time.utc(2013, 10, 10, 10, 10, 10)
+      ]
+      conflicted = RiakHelpers.build_conflicted_robject "value_resolve_simple", datas
+      conflicted.siblings.each_with_index do |s, i|
+        s.last_modified = times[i]
+      end
+      result = Rico::Value.resolve(conflicted)
+      result.data.should eql({ "_type" => "value", "_value" => "Newest" })
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rico
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors: