couchmodel 0.1.0.beta3 → 0.1.0.beta4

data/lib/couch_model/configuration.rb

@@ -1,70 +1,66 @@
 
 module CouchModel
 
-  class Configuration
+  module Configuration
 
     CLASS_KEY       = "model_class".freeze unless defined?(CLASS_KEY)
     CLASS_VIEW_NAME = "all".freeze unless defined?(CLASS_VIEW_NAME)
     
-    class << self
+    @fake_transport  = false
+    @databases       = [ ]
+    @designs         = [ ]
 
-      @@fake_transport  = false
-      @@databases       = [ ]
-      @@designs         = [ ]
-
-      def fake_transport=(value)
-        @@fake_transport = value        
-      end
+    def self.fake_transport=(value)
+      @fake_transport = value
+    end
 
-      def fake_transport
-        @@fake_transport
-      end
+    def self.fake_transport
+      @fake_transport
+    end
 
-      def design_directory=(value)
-        @@design_directory = value
-      end
+    def self.design_directory=(value)
+      @design_directory = value
+    end
 
-      def design_directory
-        class_variable_defined?(:@@design_directory) ? @@design_directory : ""
-      end
+    def self.design_directory
+      instance_variable_defined?(:@design_directory) ? @design_directory : ""
+    end
 
-      def register_database(database)
-        result = @@databases.select{ |element| element == database }.first
-        unless result
-          @@databases << database
-          result = database
-        end
-        result
+    def self.register_database(database)
+      result = @databases.select{ |element| element == database }.first
+      unless result
+        @databases << database
+        result = database
       end
+      result
+    end
 
-      def databases
-        @@databases
-      end
+    def self.databases
+      @databases
+    end
 
-      def setup_databases(options = { })
-        delete_if_exists  = options[:delete_if_exists]  || false
-        create_if_missing = options[:create_if_missing] || false
+    def self.setup_databases(options = { })
+      delete_if_exists  = options[:delete_if_exists]  || false
+      create_if_missing = options[:create_if_missing] || false
 
-        @@databases.each do |database|
-          database.delete_if_exists!  if delete_if_exists
-          database.create_if_missing! if create_if_missing
-        end
+      @databases.each do |database|
+        database.delete_if_exists!  if delete_if_exists
+        database.create_if_missing! if create_if_missing
       end
+    end
 
-      def register_design(design)
-        @@designs << design
-      end
+    def self.register_design(design)
+      @designs << design
+    end
 
-      def designs
-        @@designs
-      end
+    def self.designs
+      @designs
+    end
 
-      def setup_designs
-        @@designs.each do |design|
-          design.push
-        end
+    def self.setup_designs
+      @designs.each do |design|
+        design.push
       end
-      
     end
 
   end

data/lib/couch_model/database.rb

@@ -4,10 +4,10 @@ require File.join(File.dirname(__FILE__), "collection")
 
 module CouchModel
 
+  # The Database class provides methods create, delete and retrieve informations
+  # of a CouchDB database.
   class Database
 
-    class Error < StandardError; end
-
     attr_reader :server
     attr_reader :name
 

data/lib/couch_model/design.rb

@@ -6,6 +6,7 @@ require 'yaml'
 
 module CouchModel
 
+  # The Design class acts as a wrapper for CouchDB design documents.
   class Design
 
     attr_reader   :database
@@ -22,9 +23,9 @@ module CouchModel
       @views        = [ ]
 
       load_file
-      self.id       = attributes[:id]       if attributes[:id]
-      self.language = attributes[:language] if attributes[:language]
-      self.views    = attributes[:views]    if attributes[:views]
+      self.id       = attributes[:id]       if attributes.has_key?(:id)
+      self.language = attributes[:language] if attributes.has_key?(:language)
+      self.views    = attributes[:views]    if attributes.has_key?(:views)
     end
 
     def filename
@@ -32,34 +33,33 @@ module CouchModel
     end
 
     def load_file
-      return false unless File.exists?(filename)
-      attributes = YAML::load_file filename
-      self.id       = attributes[:id]
-      self.language = attributes[:language]
-      self.views    = attributes[:views]
+      self.id, self.language, self.views = YAML::load_file(self.filename).values_at(:id, :language, :views)
       true
+    rescue Errno::ENOENT
+      false
     end
 
     def views=(view_hash)
       @views = [ ]
       view_hash.each do |view_name, view|
-        @views << View.new(self, view.merge(:name => view_name)) if view.is_a?(Hash)
+        @views << View.new(self, view.merge(:name => view_name.to_s)) if view.is_a?(Hash)
       end if view_hash.is_a?(Hash)
     end
 
     def generate_view(name, options = { })
-      view = View.new self, options.merge(:name => name)
+      view = View.new self, options.merge(:name => name.to_s)
       @views.insert 0, view
       view
     end
 
     def to_hash
+      rev = self.rev
       hash = {
         "_id"       => "_design/#{self.id}",
         "language"  => self.language,
         "views"     => { }
       }
-      hash.merge! "_rev" => self.rev if self.rev
+      hash.merge! "_rev" => rev if rev
       @views.each { |view| hash["views"].merge! view.to_hash }
       hash
     end
@@ -72,10 +72,10 @@ module CouchModel
     end
 
     def push
-      response = Transport.request :get, self.url
-      self.rev = response["_rev"] if response["_rev"]
+      url = self.url
+      evaluate Transport.request(:get, url)
 
-      Transport.request :put, self.url, :json => self.to_hash, :expected_status_code => 201
+      Transport.request :put, url, :body => self.to_hash, :expected_status_code => 201
       true
     end
 
@@ -87,6 +87,10 @@ module CouchModel
 
     attr_writer :rev
 
+    def evaluate(response)
+      self.rev = response["_rev"] if response.has_key?("_rev")
+    end
+
   end
 
 end

data/lib/couch_model/row.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), "configuration")
+
+module CouchModel
+
+  # The Row class acts as a wrapper for a CouchDB view result row.
+  class Row
+
+    attr_reader :id
+    attr_reader :key
+    attr_reader :value
+    attr_reader :document
+
+    def initialize(attributes = { })
+      @id, @key, @value, @document = attributes.values_at "id", "key", "value", "doc"
+    end
+
+    def model
+      return nil unless @document && @document.has_key?(Configuration::CLASS_KEY)
+
+      model_class_name = document[Configuration::CLASS_KEY]
+      raise StandardError, "no class defined with name [#{model_class_name}]" unless Object.const_defined?(model_class_name)
+      instanciate_model model_class_name
+    end
+
+    def instanciate_model(model_class_name)
+      model_class = Object.const_get model_class_name
+      model = model_class.new
+      model.instance_variable_set :@attributes, @document
+      model
+    end
+    
+  end
+
+end

data/lib/couch_model/server.rb

@@ -2,10 +2,10 @@ require File.join(File.dirname(__FILE__), "transport")
 
 module CouchModel
 
+  # The Server class provides methods to retrieve informations and statistics
+  # of a CouchDB server.
   class Server
 
-    class Error < StandardError; end
-
     attr_reader :host
     attr_reader :port
 

data/lib/couch_model/transport.rb

@@ -6,8 +6,8 @@ module CouchModel
 
   module Transport
 
-    class Error < StandardError; end
-
+    # The UnexpectedStatusCodeError is raised if the :expected_status_code option is given to
+    # the :request method and the responded status code is different from the expected one.
     class UnexpectedStatusCodeError < StandardError
 
       attr_reader :status_code
@@ -22,47 +22,68 @@ module CouchModel
 
     end
 
-    class << self
+    def self.request(http_method, url, options = { })
+      expected_status_code = options[:expected_status_code]
 
-      def request(http_method, url, options = { })
-        expected_status_code = options[:expected_status_code]
-        
-        uri = URI.parse @base_url ? @base_url + url : url
+      uri = URI.parse url
+      response = perform request_object(http_method, uri, options), uri
 
-        request_class = request_class http_method
-        request = request_object request_class, uri, options
+      check_status_code response, expected_status_code if expected_status_code
+      parse response
+    end
 
-        response = Net::HTTP.start(uri.host, uri.port) { |connection| connection.request request }
+    def self.request_object(http_method, uri, options)
+      raise NotImplementedError, "the request method #{http_method} is not implemented" unless
+        self.respond_to?(:"#{http_method}_request_object")
 
-        raise UnexpectedStatusCodeError, response.code.to_i if expected_status_code && expected_status_code.to_s != response.code
-        JSON.parse response.body
-      end
+      request_object = send :"#{http_method}_request_object", uri.path, (options[:parameters] || { }), (options[:headers] || { })
+      request_object.body = options[:body].to_json if options.has_key?(:body)
+      request_object
+    end
 
-      private
+    def self.get_request_object(path, parameters, headers)
+      Net::HTTP::Get.new path + serialize_parameters(parameters),
+                         headers
+    end
 
-      def request_class(http_method)
-        Net::HTTP.const_get http_method.capitalize
-      end
+    def self.post_request_object(path, parameters, headers)
+      Net::HTTP::Post.new path + serialize_parameters(parameters),
+                          { "Content-Type" => "application/json" }.merge(headers)
+    end
+
+    def self.put_request_object(path, parameters, headers)
+      Net::HTTP::Put.new path + serialize_parameters(parameters),
+                         { "Content-Type" => "application/json" }.merge(headers)
+    end
 
-      def request_object(request_class, uri, options)
-        parameters  = options[:parameters] || { }
-        json        = options[:json]
-
-        case request_class.to_s
-          when "Net::HTTP::Get", "Net::HTTP::Delete"
-            request_class.new uri.path +
-              (parameters.empty? ? "" : "?" + parameters.collect{ |key, value| "#{key}=#{URI.escape(value.to_s)}" }.reverse.join("&"))
-          when "Net::HTTP::Post", "Net::HTTP::Put"
-            request = request_class.new uri.path, { "Content-Type" => "application/json" }
-            request.body = JSON.dump(json) if json
-            request
-          else
-            request_class.new uri.path
-        end
+    def self.delete_request_object(path, parameters, headers)
+      Net::HTTP::Delete.new path + serialize_parameters(parameters),
+                            headers
+    end
+
+    def self.serialize_parameters(parameters)
+      return "" if parameters.empty?
+      "?" + parameters.collect do |key, value|
+        value = value.respond_to?(:to_json) ? value.to_json : value.to_s
+        "#{key}=#{URI.escape(value)}"
+      end.reverse.join("&")
+    end
+
+    def self.perform(request, uri)
+      Net::HTTP.start(uri.host, uri.port) do |connection|
+        connection.request request
       end
+    end
+
+    def self.check_status_code(response, expected_status_code)
+      response_code = response.code
+      raise UnexpectedStatusCodeError, response_code.to_i if expected_status_code.to_s != response_code
+    end
 
+    def self.parse(response)
+      JSON.parse response.body
     end
-    
+
   end
 
-end
+end

data/lib/couch_model/view.rb

@@ -3,6 +3,8 @@ require File.join(File.dirname(__FILE__), "collection")
 
 module CouchModel
 
+  # The View class acts as a wrapper for the views that are in the CouchDB design document. It also
+  # provides methods to generate simple view javascript functions.
   class View
 
     attr_reader   :design
@@ -15,8 +17,8 @@ module CouchModel
       @name   = attributes[:name]
 
       generate_functions attributes
-      @map    = attributes[:map]    if attributes[:map]
-      @reduce = attributes[:reduce] if attributes[:reduce]
+      @map    = attributes[:map]    if attributes.has_key?(:map)
+      @reduce = attributes[:reduce] if attributes.has_key?(:reduce)
     end
 
     def collection(options = { })
@@ -33,18 +35,20 @@ module CouchModel
 
     def generate_functions(options = { })
       keys = [ (options[:keys] || "_id") ].flatten
+      @map = self.class.generate_map_function @design.model_class, keys
+      @reduce = nil
+    end
 
+    def self.generate_map_function(model_class, keys)
       emit_values  = keys.map{ |key| "document['#{key}']" }
       check_values = emit_values.select{ |value| value != "document['_id']" }
 
-      @map =
 """function(document) {
-  if (document['#{Configuration::CLASS_KEY}'] == '#{@design.model_class.to_s}'#{check_values.empty? ? "" : " && " + check_values.join(" && ")}) {
+  if (document['#{Configuration::CLASS_KEY}'] == '#{model_class.to_s}'#{check_values.empty? ? "" : " && " + check_values.join(" && ")}) {
     emit(#{emit_values.size == 1 ? emit_values.first : "[ " + emit_values.join(", ") + " ]"}, null);
   }
 }
 """
-      @reduce = nil
     end
 
   end

data/spec/fake_transport.yml

@@ -3,7 +3,7 @@
   :url:         "http://localhost:5984/"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "couchdb":  "Welcome"
       "version":  "0.10.0"
 -
@@ -11,7 +11,7 @@
   :url:         "http://localhost:5984/_stats"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "httpd_status_codes":     "..."
       "httpd_request_methods":  "..."
 -
@@ -19,7 +19,7 @@
   :url:         "http://localhost:5984/_all_dbs"
   :response:
     :code:      "200"
-    :json:      [ "development", "test" ]
+    :body:      [ "development", "test" ]
 -
   :http_method: "get"
   :url:         "http://localhost:5984/_uuids"
@@ -27,14 +27,14 @@
     :count:     3
   :response:
     :code:      "200"
-    :json:
+    :body:
       "uuids":  [ "uuid_1", "uuid_2", "uuid_3" ]
 -
   :http_method: "get"
   :url:         "http://localhost:5984/test"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "db_name":    "test"
       "doc_count":  "0"
 -
@@ -42,13 +42,13 @@
   :url:         "http://localhost:5984/new_database"
   :response:
     :code:      "404"
-    :json:
+    :body:
 -
   :http_method: "get"
   :url:         "http://localhost:5984/test/test_model_1"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "_id":          "test_model_1"
       "_rev":         "0"
       "model_class":  "BaseTestModel"
@@ -59,7 +59,7 @@
   :url:         "http://localhost:5984/test/test_model_2"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "_id":          "test_model_2"
       "_rev":         "0"
       "model_class":  "BaseTestModel"
@@ -74,7 +74,7 @@
   :url:         "http://localhost:5984/test"
   :response:
     :code:      "201"
-    :json:
+    :body:
       "ok":   true
       "id":   "test_model_2"
       "rev":  "0"
@@ -83,18 +83,18 @@
   :url:         "http://localhost:5984/test/test_model_1"
   :response:
     :code:      "201"
-    :json:
+    :body:
       "ok":   true
       "id":   "test_model_1"
       "rev":  "1"
 -
   :http_method: "delete"
   :url:         "http://localhost:5984/test/test_model_1"
-  :parameters:
-    "rev":  "0"
+  :headers:
+    "If-Match": "0"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "ok":   true
       "id":   "test_model_1"
       "rev":  "1"
@@ -103,7 +103,7 @@
   :url:         "http://localhost:5984/test/_design/test_design"
   :response:
     :code:      "200"
-    :json:
+    :body:
       "_id":      "_design/test_design"
       "_rev":     "0"
       "language": "javascript"
@@ -116,7 +116,7 @@
   :url:         "http://localhost:5984/test/_design/test_design"
   :response:
     :code:      "201"
-    :json:
+    :body:
       "ok":   true
       "id":   "_design/test_design"
       "rev":  "1"
@@ -124,11 +124,11 @@
   :http_method: "get"
   :url:         "http://localhost:5984/test/_all_docs"
   :parameters:
-    "include_docs": "true"
-    "limit":        "1"
+    :include_docs: true
+    :limit:        1
   :response:
     :code:      "200"
-    :json:
+    :body:
       "total_rows":   1
       "offset":       0
       "rows":
@@ -146,24 +146,80 @@
   :http_method: "get"
   :url:         "http://localhost:5984/test/_all_docs"
   :parameters:
-    "include_docs": "true"
-    "limit":        "0"
+    :limit:        1
   :response:
     :code:      "200"
-    :json:
+    :body:
       "total_rows":   1
       "offset":       0
+      "rows":
+        -
+          "id":   "test_model_1"
+          "key":  "test_model_1"
+          "value":
+            "rev":  "0"
+          "doc":
+            "_id":          "test_model_1"
+            "_rev":         "0"
+            "model_class":  "CollectionTestModel"
+            "name":         "phil"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/_all_docs"
+  :parameters:
+    :include_docs: true
+    :limit:        0
+  :response:
+    :code:      "200"
+    :body:
+      "total_rows":   1
+      "offset":       0
+      "rows":         [ ]
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/_design/setup_test_model/_view/all"
+  :parameters:
+    :include_docs: true
+    :limit:        0
+  :response:
+    :code:      "200"
+    :body:
+      "total_rows":   14
+      "offset":       0
       "rows":         [ ]
 -
   :http_method: "get"
   :url:         "http://localhost:5984/test/_design/association_test_model_one/_view/by_related_id_and_name"
   :parameters:
-    "include_docs": "true"
-    "startkey":     "[\"test_model_2\",null]"
-    "endkey":       "[\"test_model_2\",{}]"
+    :include_docs: true
+    :startkey:     [ "test_model_2", null ]
+    :endkey:       [ "test_model_2", { } ]
+  :response:
+    :code:      "200"
+    :body:
+      "total_rows":   1
+      "offset":       0
+      "rows":
+        -
+          "id":   "test_model_1"
+          "key":  "test_model_2"
+          "value":
+            "rev":  "0"
+          "doc":
+            "_id":          "test_model_1"
+            "_rev":         "0"
+            "model_class":  "AssociationTestModelOne"
+            "name":         "phil"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/_design/association_test_model_one/_view/by_related_id_and_name"
+  :parameters:
+    :include_docs: true
+    :startkey:     [ "test_model_2", "phil" ]
+    :endkey:       [ "test_model_2", "phil" ]
   :response:
     :code:      "200"
-    :json:
+    :body:
       "total_rows":   1
       "offset":       0
       "rows":
@@ -181,12 +237,11 @@
   :http_method: "get"
   :url:         "http://localhost:5984/test/_design/association_test_model_one/_view/by_related_id_and_name"
   :parameters:
-    "include_docs": "true"
-    "startkey":     "[\"test_model_2\",\"phil\"]"
-    "endkey":       "[\"test_model_2\",\"phil\"]"
+    :startkey:     [ "test_model_2", "phil" ]
+    :endkey:       [ "test_model_2", "phil" ]
   :response:
     :code:      "200"
-    :json:
+    :body:
       "total_rows":   1
       "offset":       0
       "rows":

data/spec/fake_transport_helper.rb

@@ -9,16 +9,18 @@ module CouchModel
       self.stub!(:request).and_return do |http_method, url, options|
         options ||= { }
         parameters            = options[:parameters]
+        headers               = options[:headers]
         expected_status_code  = options[:expected_status_code]
 
         request = @@fake.detect do |hash|
           hash[:http_method].to_s == http_method.to_s &&
             hash[:url].to_s == url.to_s &&
-            hash[:parameters] == parameters
+            hash[:parameters] == parameters &&
+            hash[:headers] == headers
         end
-        raise StandardError, "no fake request found for [#{http_method} #{url} #{parameters.inspect}]" unless request
+        raise StandardError, "no fake request found for [#{http_method} #{url} #{parameters.inspect} #{headers.inspect}]" unless request
         raise UnexpectedStatusCodeError, request[:response][:code].to_i if expected_status_code && expected_status_code.to_s != request[:response][:code]
-        request[:response][:json].dup
+        request[:response][:body].dup
       end
     end