riakrest 0.0.4 → 0.1.0

data/lib/riakrest/data/jiak_data_hash.rb

@@ -1,182 +0,0 @@
-module RiakRest
-  # JiakDataHash provides a easy-to-use default JiakData implementation. See
-  # JiakData for a discussion on creating user-defined data classes.
-  #
-  # JiakDataHash creates a JiakData from a list of user-data fields. Note
-  # JiakDataHash, like JiakData, is not used to create instances of user data;
-  # rather it is used to create the class for the user data. That class is then
-  # used to create instances of the user data itself.
-  #
-  # The class created by JiakDataHash is anonymous and takes the name of the
-  # constant to which it is assigned. See the example below.
-  #
-  # Object instances of the class created by JiakDataHash have read and write
-  # accessors for each the fields used in creating the class. Instance values
-  # can also be accessed via [] and []=. Other hash sematics are not
-  # provided. The created class does have a <code>to_hash</code> method that
-  # returns a hash of the instance data fields and values.
-  #
-  # The class created by JiakDataHash includes an initialize method that takes
-  # as argument a hash of the field/value pairs for the instance. The instance
-  # still has all of the field attributes, this simply provides a easy way to
-  # initialize some or all of the values for the fields.
-  #
-  # The class created by JiakDataHash also provides a <code>keygen</code> class
-  # method that allows specifying a list of fields for use in generating the
-  # key for instance data. See JiakDataHash#keygen.
-  #
-  # Note the created class has methods provided by JiakData to inspect or
-  # manipulate the structure Jiak interaction for instances of the class. See
-  # JiakData#ClassMethods for those methods.
-  #
-  # ===Usage
-  # <code>
-  #   Dog = JiakDataHash.create(:name,:weight)
-  #   Dog.keygen :name
-  #
-  #   addie = Dog.new(:name => "Adelaide", :weight => 45)
-  #   addie.name                                           # => "Adeliade"
-  #   addie.weight                                         # => 45
-  #
-  #   addie.weight = 47                                    # => 47
-  # </code>
-  #
-  class JiakDataHash
-
-    # :call-seq:
-    #   JiakDataHash.create(:f1,...,fn)    -> JiakDataHash
-    #   JiakDataHash.create([:f1,...,fn])  -> JiakDataHash
-    #   JiakDataHash.create(schema)        -> JiakDataHash
-    #
-    # Creates a JiakDataHash class that can be used to create JiakData objects
-    # containing the specified fields.
-    def self.create(*args)
-      Class.new do
-        include JiakData
-
-        if(args.size == 1)
-          case args[0]
-          when Symbol, Array
-            allowed *args[0]
-          when JiakSchema
-            allowed  *args[0].allowed_fields
-            required *args[0].required_fields
-            readable *args[0].read_mask
-            writable *args[0].write_mask
-          end
-        else
-          allowed *args
-        end
-
-        # :call-seq:
-        #   DataClass.keygen(*fields)
-        #
-        # The key generation for the data class will be a concatenation of the
-        # to_s result of calling each of the listed data class fields.
-        def self.keygen(*fields)
-          define_method(:keygen) do
-            fields.inject("") {|key,field| key += send("#{field}").to_s}
-          end
-        end
-
-        # :call-seq:
-        #   data.new({})  -> JiakDataHash
-        #
-        # Create an instance of the user-defined JiakDataHash using the provide
-        # hash as initial values.
-        def initialize(hsh={})
-          hsh.each {|key,value| send("#{key}=",value)}
-        end
-        
-        # :call-seq:
-        #   data.jiak_create(jiak)  ->  JiakDataHash
-        #
-        # Used by RiakRest to create an instance of the user-defined data class
-        # from the values returned by the Jiak server.
-        def self.jiak_create(jiak)
-          new(jiak)
-        end
-
-        # :call-seq:
-        #   data[field] -> value
-        #
-        # Get the value of a field.
-        #
-        # Returns <code>nil</code> if <code>field</code> was not declared for
-        # this class. <code>field</code> can be in either string or symbol
-        # form.
-        def [](key)
-          send("#{key}") rescue nil
-        end
-
-        # :call-seq:
-        #   data[field] = value
-        #
-        # Set the value of a field.
-        #
-        # Returns the value set, or <code>nil</code> if <code>field</code> was
-        # not declared for this class.
-        def []=(key,value)
-          send("#{key}=",value)  rescue nil
-        end
-
-        # :call-seq:
-        #   data.for_jiak  -> hash
-        #
-        # Return a hash of the writable fields and their values. Used by
-        # RiakRest to prepare the data for transport to the Jiak server.
-        def for_jiak
-          self.class.schema.write_mask.inject({}) do |build,field|
-            val = send("#{field}")
-            build[field] = val  unless val.nil?
-            build
-          end
-        end
-        
-        # :call-seq:
-        #   data.to_hash
-        #
-        # Return a hash of the allowed fields and their values.
-        def to_hash
-          self.class.schema.allowed_fields.inject({}) do |build,field|
-            val = send("#{field}")
-            build[field] = val
-            build
-          end
-        end
-
-
-        # call-seq:
-        #    jiak_data == other -> true or false
-        #
-        # Equality -- Two JiakDataHash objects are equal if they contain the
-        # same values for all attributes.
-        def ==(other)
-          self.class.schema.allowed_fields.reduce(true) do |same,field|
-            same && (other.send("#{field}") == (send("#{field}")))
-          end
-        end
-
-        # call-seq:
-        #    data.eql?(other) -> true or false
-        #
-        # Returns <code>true</code> if <code>other</code> is a JiakObject with
-        # the same the same attribute values for all allowed fields.
-        def eql?(other)
-          other.is_a?(self.class) &&
-            self.class.schema.allowed_fields.reduce(true) do |same,field|
-            same && other.send("#{field}").eql?(send("#{field}"))
-          end
-        end
-
-        def hash   # :nodoc:
-          self.class.schema.allowed_fields.inject(0) do |hsh,field|
-            hsh += send("#{field}").hash
-          end
-        end
-
-      end
-    end
-
-  end
-end

data/spec/data/jiak_data_hash_spec.rb

@@ -1,14 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-describe "JiakDataHash" do
-  Person = JiakDataHash.create(:name, :age)
-
-  before do
-  end
-
-  it "should create a fully usable JiakData class" do
-    Person.schema.should respond_to(:allowed_fields,:required_fields,
-                                    :read_mask,:write_mask)
-  end
-
-end