dm-riak-adapter 0.0.3 → 0.0.4

data/README.md

@@ -12,17 +12,17 @@ Install the **dm-riak-adapter** gem:
 
       gem install dm-riak-adapter
 
-## Usage
+## Synopsis
 
-Require **dm-core** and **dm-riak-adapter**. Tell DataMapper to use the Riak adapter and set a namespace for your app. This namespace will prefix each bucket like `myapp:projects` `myapp:tasks`. You can also skip setting a namespace and the buckets wont have any prefix.
+Require **dm-core** and **dm-riak-adapter**. Tell DataMapper to use the Riak adapter and set a namespace for your app. This namespace will prefix each bucket like `myapp:projects` `myapp:tasks`. Skip setting a namespace and the buckets will have no prefix.
 
       require 'dm-core'
       require 'dm-riak-adapter'
       
       DataMapper.setup :default, :adapter => 'riak', :namespace => 'myapp'
-      
-Continue Defining your models and properties as you normally would. Set the serial number as type **Key** to use Riak's server-assigned UUIDs.
-      
+
+Continue defining your models and properties as you normally would. Set a property as type `Key` to use Riak's server-assigned UUIDs.
+
       class Project
         include DataMapper::Resource
         
@@ -39,4 +39,10 @@ Continue Defining your models and properties as you normally would. Set the seri
         property :summary,  String
         
         belongs_to :project
-      end
+      end
+
+## Resources
+
+- [Documentation](http://yardoc.org/docs/mikeric-dm-riak-adapter/DataMapper/Adapters/RiakAdapter)
+- [Metrics](http://getcaliper.com/caliper/project?repo=http://rubygems.org/gems/dm-riak-adapter)
+- [Gems](http://rubygems.org/gems/dm-riak-adapter)

data/lib/dm-riak-adapter/adapter.rb

@@ -1,15 +1,52 @@
 module DataMapper::Adapters
   class RiakAdapter < AbstractAdapter
+    # Initializes a new RiakAdapter instance
+    # 
+    # @param [String, Symbol] name
+    #   Repository name
+    # 
+    # @param [Hash] options
+    #   Configuration options
+    # 
+    # @option options [String] :host ('127.0.0.1') Server hostname
+    # @option options [Integer] :port (8098) Server port
+    # @option options [String] :prefix ('riak') Path prefix to the HTTP endpoint
+    # @option options [String] :namespace ('') Bucket namespace
     def initialize(name, options)
       super
-      @riak = Riak::Client.new(:prefix => options[:prefix] || 'riak')
+      
+      @riak = Riak::Client.new(
+        :host   => options[:host],
+        :port   => options[:port],
+        :prefix => options[:prefix]
+      )
       @namespace = options[:namespace] ? options[:namespace] + ':' : ''
     end
     
+    # Persists one or many new resources
+    # 
+    # @example
+    #   adapter.create(collection)  # => 1
+    # 
+    # @param [Enumerable<Resource>] resources
+    #   List of resources (model instances) to create
+    # 
+    # @return [Integer]
+    #   Number of objects created
     def create(resources)
       create_objects(resources)
     end
     
+    # Reads one or many resources from a datastore
+    # 
+    # @example
+    #   adapter.read(query)  # => [{'title' => 'Lorem Ipsum'}]
+    # 
+    # @param [Query] query
+    #   Query to match objects in the datastore
+    # 
+    # @return [Enumerable<Hash>]
+    #   Array of hashes to become resources
     def read(query)
       query.filter_records(objects_for(query.model)).each do |object|
         query.fields.each do |property|
@@ -18,6 +55,19 @@ module DataMapper::Adapters
       end
     end
     
+    # Updates one or many existing resources
+    # 
+    # @example
+    #   adapter.update(attributes, collection)  # => 1
+    # 
+    # @param [Hash(Property => Object)] attributes
+    #   Hash of attribute values to set, keyed by Property
+    # 
+    # @param [Collection] collection
+    #   Collection of records to be updated
+    # 
+    # @return [Integer]
+    #   Number of records updated
     def update(attributes, collection)
       attributes = attributes_as_fields(attributes)
       
@@ -25,10 +75,30 @@ module DataMapper::Adapters
       update_objects(collection)
     end
     
+    # Deletes one or many existing resources
+    # 
+    # @example
+    #   adapter.delete(collection)  # => 1
+    # 
+    # @param [Collection] collection
+    #   Collection of records to be deleted
+    # 
+    # @return [Integer]
+    #   Number of records deleted
     def delete(collection)
       delete_objects(collection)
     end
     
+    # Flushes the bucket for the specified model
+    # 
+    # @example
+    #   adapter.flush(Post)  # => ["6moGsRVfutpG4wzibgwDBKc37Dd"]
+    # 
+    # @param [Class] model
+    #   Model to flush
+    # 
+    # @return [Array<String>]
+    #   Keys of the flushed objects
     def flush(model)
       bucket(model).keys.each {|key| bucket(model)[key].delete}
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Mike Richards
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -04:00
+date: 2010-04-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
-description: DataMapper adapter for Riak
+description: DataMapper Adapter for Riak
 email: mike22e@gmail.com
 executables: []
 
@@ -87,7 +87,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
-summary: DataMapper adapter for Riak
+summary: DataMapper Adapter for Riak
 test_files: 
 - spec/dm-riak-adapter_spec.rb
 - spec/spec_helper.rb