riakrest 0.1.6 → 0.1.7

data/History.txt

@@ -1,5 +1,8 @@
+=== 0.1.7 2009-12-17
+  - Added write data conversion.
+
 === 0.1.6 2009-12-17
-  - Add method for specifying data conversion in JiakData and JiakResouce.
+  - Add method for specifying read data conversion in JiakData and JiakResouce.
   - Add testing and examples for data conversion.
 
 === 0.1.5 2009-12-11

data/README.rdoc

@@ -44,7 +44,7 @@ sudo gem install riakrest
   class People
     include JiakResource
     server 'http://localhost:8002/jiak'
-    jattr_accessor :name, :age
+    attr_accessor :name, :age
   end
 
   # Created and store a resource.

data/Rakefile

@@ -20,8 +20,8 @@ Jeweler::Tasks.new do |gem|
     that gives a true RESTful feel.
   EOS
   gem.authors = ["Paul Rogers"]
-  gem.email = "riak@dingosky.com"
-  gem.homepage = "http://github.com/wcpr/riakrest"
+  gem.email = "paul@riakrest.com"
+  gem.homepage = "http://riakrest.com"
   gem.add_dependency('rest-client', '>= 1.0.0')
   gem.add_dependency('json', '>= 1.1.9')
   gem.add_development_dependency "rest-client", ">= 1.0.0"

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/examples/jiak_client.data.rb

@@ -1,11 +1,12 @@
 require File.dirname(__FILE__) + '/example_helper.rb'
 require 'date'
 
-# JiakData class with a couple of attributes, one of which requires conversion
+# JiakData class with a couple of attributes, one with conversion
 class DateData
   include JiakData
   attr_accessor :name, :date
-  convert :date => lambda{|value| Date.parse(value)}
+
+  attr_converter :date => { :read => lambda{|value| Date.parse(value)} }
 end
 
 client = JiakClient.new(SERVER_URI)
@@ -23,10 +24,28 @@ puts leap_obj.data.date.inspect                 # => #<Date: 2008-02-29 (etc.)>
 client.delete(bucket,leap_obj.key)
 
 
-# It is also possible to use Ruby JSON processing to achieve a similar result;
-# however, this is not optimal as the stored Riak data value contains
-# Ruby-secific information which may be undesirable to non-Ruby consumers of
-# that data.
+# Alter DateData to store ordinal Date
+class DateData
+  attr_converter(:date => {
+                   :write => lambda {|v| { :year => v.year, :yday => v.yday} },
+                   :read  => lambda {|v| Date::ordinal(v['year'],v['yday'])} } )
+end
+leap_obj = client.store(JiakObject.new(:bucket => bucket,
+                                       :data => leap_2008),
+                        :return => :object)
+puts leap_obj.data.date.inspect                 # => #<Date: 2008-02-29 (etc.)>
+
+# JSON payload
+#   {"name":"Leap 2008","date":{"year":2008,"yday":60}}
+
+# Clean-up stored object
+client.delete(bucket,leap_obj.key)
+
+
+# It is also possible to change the JSON processing of the Ruby Date class to
+# achieve the same results as above. Given the following changes to the Date
+# class, the DateData class could be defined as before, but without any
+# attribute converters.
 
 # Instrument the Ruby Date class for round-trip JSON processing.
 class Date
@@ -47,16 +66,18 @@ end
 
 bucket = JiakBucket.new('date data',DateData2)
 
-leap_2012 = DateData2.new(:name => "Leap 2012", 
-                          :date => Date.new(2012,02,29))
+leap_2008 = DateData2.new(:name => "Leap 2008", 
+                          :date => Date.new(2008,02,29))
 leap_obj = client.store(JiakObject.new(:bucket => bucket,
-                                       :data => leap_2012),
+                                       :data => leap_2008),
                         :return => :object)
-puts leap_obj.data.date.inspect                 # => #<Date: 2012-02-29 (etc.)>
+puts leap_obj.data.date.inspect                 # => #<Date: 2008-02-29 (etc.)>
 
-# JSON payload: 
-#  leap_2008 : {"name":"leap","date":"2008-02-29"}
-#  leap_2012 : {"name":"leap","date":{"json_class":"Date","date":"2012-02-29"}}
+# However, this is not optimal as the data stored in Riak now contains
+# Ruby-secific information which may be undesirable to non-Ruby consumers of
+# the data. For the code above, the JSON payload contains:
+#
+#   {"name":"Leap 2008","date":{"json_class":"Date","date":"2008-02-29"}}
 
 # Clean-up stored object
 client.delete(bucket,leap_obj.key)

data/examples/jiak_resource_data.rb

@@ -1,23 +1,27 @@
 require File.dirname(__FILE__) + '/example_helper.rb'
 require 'date'
 
-# JiakResource with a couple of attributes, one of which requires conversion
+# JiakResource with a couple of attributes. Store birthdate as ordinal Date.
 class Person
   include JiakResource
   server SERVER_URI
   attr_accessor :name, :birthdate
-  convert :birthdate => lambda{|value| Date.parse(value)}
+  attr_converter :birthdate => { :read => lambda{|value| Date.parse(value)} }
   keygen {name.downcase}
 
+  # Calculate "human" age from birthdate
   def age
     now = DateTime.now
     age = now.year - birthdate.year
-    age -= 1 if(now.yday < birthdate.yday)
+    if((now.month <  birthdate.month) or
+       (now.month == birthdate.month and now.day < birthdate.day))
+      age -= 1 
+    end
     age
   end
 end
 
-# Create and post resource, showing birthdate is a Date before and after post.
+# The birthdate attribute is a Date before and after post.
 remy = Person.new(:name => 'Remy',:birthdate => Date.new(1999,06,26))
 puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
 puts remy.age                                   # => current age
@@ -27,3 +31,59 @@ puts remy.age                                   # => current age
 
 remy.delete
 
+# JSON payload from the HTTP request and response
+#   {"name":"Remy","birthdate":"1999-06-26"}
+
+class Person
+  attr_converter(:birthdate => {
+                   :write => lambda{|v| {:year => v.year, :yday => v.yday} },
+                   :read  => lambda{|v| Date::ordinal(v['year'],v['yday'])}})
+end
+
+# The same code as previous yields the exact same results.
+remy = Person.new(:name => 'Remy',:birthdate => Date.new(1999,06,26))
+puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
+puts remy.age                                   # => current age
+remy.post
+puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
+puts remy.age                                   # => current age
+
+remy.delete
+
+# JSON payload from the HTTP request and response with ordinal Date structure
+#   {"name":"Remy","birthdate":{"year":1999,"yday":177}}
+
+
+# It is also possible to change the JSON processing of the Ruby Date class to
+# achieve the same results as above. Given the following changes to the Date
+# class, the Person class could be defined as before, but without any attribute
+# converters.
+
+# Instrument the Ruby Date class for round-trip JSON processing.
+class Date
+  def to_json(*args)
+    { 'json_class' => self.class.name,
+      'date' => to_s
+    }.to_json(*args)
+  end
+  def self.json_create(hash)
+    parse(hash['date'])
+  end
+end
+
+class Person2
+  include JiakResource
+  server SERVER_URI
+  attr_accessor :name, :birthdate
+end
+
+remy = Person2.new(:name => 'Remy',:birthdate => Date.new(1999,06,26))
+remy.post
+puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
+
+# However, this is not optimal as the data stored in Riak now contains
+# Ruby-secific information which may be undesirable to non-Ruby consumers of
+# the data. For the code above, the JSON payload contains:
+#
+#   {"name":"Remy","birthdate":{"json_class":"Date","date":"1999-06-26"}}
+

data/lib/riakrest/core/jiak_data.rb

@@ -81,6 +81,34 @@ module RiakRest
         writable *fields
       end
 
+      # :call-seq:
+      #   att_converter(hash)  -> nil
+      #
+      # Specify a hash of optional Procs for converting data attribute values
+      # during reading and writing data to a Jiak server. Each hash key should
+      # be a data class attribute, with an associated value of a hash
+      # containing a write and/or a read Proc for use in converting data. Each
+      # Procs should accept one argument, the data value actually stored in
+      # Riak.
+      #
+      # ====Example
+      #
+      # A Person data class that stores a Date in ordinal format:
+      #
+      # def PersonData
+      #   include JiakData
+      #   attr_accessor :name, :birthdate
+      #   attr_converter(:birthdate => {
+      #     :write => lambda {|v| { :year => v.year, :yday => v.yday} },
+      #     :read  => lambda {|v| Date::ordinal(v['year'],v['yday'])} } )
+      # end
+      def attr_converter(hash)
+        hash.each do |attr,blks|
+          @read_converter[attr]  = blks[:read]   if(blks[:read])
+          @write_converter[attr] = blks[:write]  if(blks[:write])
+        end
+      end
+
       # :call-seq:
       #   allow :f1, ..., :fn   -> array
       #   allow [:f1, ..., :fn]   -> array
@@ -180,33 +208,12 @@ module RiakRest
         define_method(:keygen,&block)
       end
 
-      # :call-seq:
-      #   JiakData.convert(hash)  -> nil
-      #
-      # Specify a hash of optional Procs for converting the data values stored
-      # in Riak during the process of inflating returned Riak data into Ruby
-      # objects. The hash values should be Procs used to convert the data
-      # attribute specified by the hash key. The Procs must accept one
-      # argument, the data value actually stored in Riak. The converted result
-      # will be the actual value of the data field inside the inflated Ruby
-      # object.
-      #
-      # ====Example
-      # def PersonData
-      #   include JiakData
-      #   attr_accessor :name, :birthdate
-      #   convert :birthdate => lambda {|val| Date.parse(val)}
-      # end
-      def convert(hash)
-        @converter ||= {}
-        hash.each {|k,blk| @converter[k.to_s] = blk}
-      end
-
-      # Use optional converters to convert returned data values before passing
-      # to the JiakData constructor.
+      # Use optional read converters to convert returned data values before
+      # passing to the JiakData constructor.
       def jiak_create(jiak)     # :nodoc:
-        unless(@converter.nil?)
-          @converter.each {|k,blk| jiak[k] = blk.call(jiak[k])}
+        read_converter.each do |attr,blk|
+          key = attr.to_s
+          jiak[key] = blk.call(jiak[key])
         end
         new(jiak)
       end
@@ -214,11 +221,27 @@ module RiakRest
     end
 
     def self.included(including_class)  # :nodoc:
-      including_class.extend(ClassMethods)
+      including_class.instance_eval do
+        extend ClassMethods
+
+        def read_converter
+          @read_converter
+        end
+        @read_converter =  {}
+        
+        def write_converter
+          @write_converter
+        end
+        @write_converter = {}
+      end
 
       define_method(:to_jiak) do
-        self.class.schema.write_mask.inject({}) do |build,field|
-          build[field] = send("#{field}")
+        self.class.schema.write_mask.inject({}) do |build,attr|
+          val = send("#{attr}")
+          if(self.class.write_converter[attr])
+            val = self.class.write_converter[attr].call(val)
+          end
+          build[attr] = val
           build
         end
       end

data/lib/riakrest/resource/jiak_resource.rb

@@ -135,17 +135,16 @@ module RiakRest
       end
 
       # :call-seq:
-      #   JiakResource.convert(hash)
-      #
-      # Specify a hash of optional Procs for converting the data values stored
-      # in Riak during the process of inflating returned Riak data into
-      # JiakResource objects. The hash values should be Procs used to convert
-      # the data attribute specified by the hash key. The Procs must accept one
-      # argument, the data value actually stored in Riak. The converted result
-      # will be the actual value of the data field inside the inflated
-      # JiakResource.
-      def convert(hash)
-        jiak.data.convert(hash)
+      #   attr_converter(hash)
+      #
+      # Specify a hash of optional Procs for converting data attribute values
+      # during reading and writing data to a Jiak server. Each hash key should
+      # be a data class attribute, with an associated value of a hash
+      # containing a write and/or a read Proc for use in converting data. Each
+      # Procs should accept one argument, the data value actually stored in
+      # Riak.
+      def attr_converter(hash)
+        jiak.data.attr_converter(hash)
       end
 
       # :call-seq:

data/spec/core/jiak_client_spec.rb

@@ -11,7 +11,9 @@ require 'date'
 class DateData
   include JiakData
   attr_accessor :name, :date
-  convert :date => lambda { |v| Date.parse(v) }
+  attr_converter(:date => {
+                   :write => lambda {|v| { :year => v.year, :yday => v.yday} },
+                   :read  => lambda {|v| Date::ordinal(v['year'],v['yday'])} } )
 end
 
 class PersonData

data/spec/resource/jiak_resource_spec.rb

@@ -325,7 +325,9 @@ describe "JiakResource data conversion" do
     server         SERVER_URI
     group          'dogs'
     attr_accessor  :name, :birthdate
-    convert :birthdate => lambda{|value| Date.parse(value)}
+    attr_converter(:birthdate => {
+                     :write => lambda{|v| {:year => v.year, :yday => v.yday} },
+                     :read  => lambda{|v| Date::ordinal(v['year'],v['yday'])}})
     keygen { name }
     auto_manage
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riakrest
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Paul Rogers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-16 00:00:00 -08:00
+date: 2009-12-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,7 +73,7 @@ dependencies:
         version: 1.2.9
     version: 
 description: "    RiakRest provides structured, RESTful interaction with\n    the HTTP/JSON interface of a Riak[http://riak.basho.com] document data\n    store. RiakRest provides two levels of interaction: Core Client and\n    Resource. Core Client works at the Jiak level and exposes Jiak\n    internals. JiakResource is an abstraction built on top of the Core Client\n    that gives a true RESTful feel.\n"
-email: riak@dingosky.com
+email: paul@riakrest.com
 executables: []
 
 extensions: []
@@ -123,7 +123,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/wcpr/riakrest
+homepage: http://riakrest.com
 licenses: []
 
 post_install_message: