couchmodel 0.1.0.beta2

data/lib/couch_model/collection.rb

@@ -0,0 +1,84 @@
+require File.join(File.dirname(__FILE__), "configuration")
+require File.join(File.dirname(__FILE__), "transport")
+require 'json'
+
+module CouchModel
+
+  class Collection
+
+    REQUEST_PARAMETER_KEYS = [
+      :key, :startkey, :startkey_docid, :endkey, :endkey_docid,
+      :limit, :stale, :descending, :skip, :group, :group_level,
+      :reduce, :inclusive_end
+    ].freeze unless defined?(REQUEST_PARAMETER_KEYS)
+
+    ARRAY_METHOD_NAMES = [
+      :[], :at, :collect, :compact, :count, :cycle, :each, :each_index,
+      :empty?, :fetch, :index, :first, :flatten, :include?, :join, :last,
+      :length, :map, :pack, :reject, :reverse, :reverse_each, :rindex,
+      :sample, :shuffle, :size, :slice, :sort, :take, :to_a, :to_ary,
+      :values_at, :zip
+    ].freeze unless defined?(ARRAY_METHOD_NAMES)
+
+    attr_reader :url
+    attr_reader :options
+
+    def initialize(url, options = { })
+      @url, @options = url, options
+    end
+
+    def total_count
+      fetch :meta => true unless @total_count
+      @total_count
+    end
+
+    def respond_to?(method_name)
+      ARRAY_METHOD_NAMES.include?(method_name) || super
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if ARRAY_METHOD_NAMES.include?(method_name)
+        fetch
+        @entries.send method_name, *arguments, &block
+      else
+        super
+      end
+    end
+
+    private
+
+    def fetch(options = { })
+      meta = options[:meta] || false
+
+      evaluate Transport.request(
+        :get, url,
+        :parameters            => request_parameters.merge(meta ? { "limit" => "0" } : { }),
+        :expected_status_code  => 200
+      )
+      
+      true
+    end
+
+    def evaluate(response)
+      @total_count = response["total_rows"]
+      @entries = response["rows"].select do |row|
+        row["doc"].has_key?(Configuration::CLASS_KEY) && Object.const_defined?(row["doc"][Configuration::CLASS_KEY])
+      end.map do |row|
+        model_class = Object.const_get row["doc"][Configuration::CLASS_KEY]
+        model = model_class.new
+        model.instance_variable_set :@attributes, row["doc"]
+        model
+      end
+    end
+
+    def request_parameters
+      parameters = { "include_docs" => "true" }
+      REQUEST_PARAMETER_KEYS.each do |key|
+        parameters[ key.to_s ] = @options[key].is_a?(Array) ? JSON.dump(@options[key]) : @options[key].to_s if @options[key]
+      end
+      parameters
+    end
+
+  end
+
+end

data/lib/couch_model/configuration.rb

@@ -0,0 +1,68 @@
+
+module CouchModel
+
+  class 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         = [ ]
+
+      def fake_transport=(value)
+        @@fake_transport = value        
+      end
+
+      def fake_transport
+        @@fake_transport
+      end
+
+      def design_directory=(value)
+        @@design_directory = value
+      end
+
+      def design_directory
+        class_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
+      end
+
+      def databases
+        @@databases
+      end
+
+      def setup_databases(options = { })
+        @@databases.each do |database|
+          database.setup! options
+        end
+      end
+
+      def register_design(design)
+        @@designs << design
+      end
+
+      def designs
+        @@designs
+      end
+
+      def setup_designs
+        @@designs.each do |design|
+          design.push
+        end
+      end
+      
+    end
+
+  end
+
+end

data/lib/couch_model/database.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), "transport")
+require File.join(File.dirname(__FILE__), "server")
+require File.join(File.dirname(__FILE__), "collection")
+
+module CouchModel
+
+  class Database
+
+    class Error < StandardError; end
+
+    attr_reader :server
+    attr_reader :name
+
+    def initialize(options = { })
+      @name   = options[:name]    || raise(ArgumentError, "no database was given")
+      @server = options[:server]  || Server.new
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && @name == other.name && @server == other.server
+    end
+
+    def ===(other)
+      object_id == other.object_id
+    end
+
+    def create!
+      Transport.request :put, url, :expected_status_code => 201
+    end
+
+    def delete!
+      Transport.request :delete, url, :expected_status_code => 200
+    end
+
+    def setup!(options = { })
+      delete_if_exists = options[:delete_if_exists] || false
+
+      if delete_if_exists
+        delete! if exists?
+        create!
+      else
+        create! unless exists?
+      end
+    end
+
+    def informations
+      Transport.request :get, url, :expected_status_code => 200
+    end
+
+    def exists?
+      @server.database_names.include? @name
+    end
+
+    def url
+      "#{@server.url}/#{@name}"
+    end
+
+    def documents(options = { })
+      Collection.new url + "/_all_docs", options
+    end
+
+  end
+
+end

data/lib/couch_model/design.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), "configuration")
+require File.join(File.dirname(__FILE__), "transport")
+require File.join(File.dirname(__FILE__), "base")
+require File.join(File.dirname(__FILE__), "view")
+require 'yaml'
+
+module CouchModel
+
+  class Design
+
+    attr_reader   :database
+    attr_reader   :model_class
+    attr_accessor :id
+    attr_reader   :rev
+    attr_accessor :language
+    attr_reader   :views
+
+    def initialize(database, model_class, attributes = { })
+      @database     = database
+      @model_class  = model_class
+      @language     = "javascript"
+      @views        = [ ]
+
+      load_file
+      self.id       = attributes[:id]       if attributes[:id]
+      self.language = attributes[:language] if attributes[:language]
+      self.views    = attributes[:views]    if attributes[:views]
+    end
+
+    def filename
+      @filename ||= File.join(CouchModel::Configuration.design_directory, "#{model_class.to_s.underscore}.design")
+    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]
+      true
+    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)
+      end if view_hash.is_a?(Hash)
+    end
+
+    def generate_view(name, options = { })
+      view = View.new self, options.merge(:name => name)
+      @views.insert 0, view
+      view
+    end
+
+    def to_hash
+      hash = {
+        "_id"       => "_design/#{self.id}",
+        "language"  => self.language,
+        "views"     => { }
+      }
+      hash.merge! "_rev" => self.rev if self.rev
+      @views.each { |view| hash["views"].merge! view.to_hash }
+      hash
+    end
+
+    def exists?
+      Transport.request :get, self.url, :expected_status_code => 200
+      true
+    rescue Transport::UnexpectedStatusCodeError
+      false
+    end
+
+    def push
+      response = Transport.request :get, self.url
+      self.rev = response["_rev"] if response["_rev"]
+
+      Transport.request :put, self.url, :json => self.to_hash, :expected_status_code => 201
+      true
+    end
+
+    def url
+      "#{@database.url}/_design/#{self.id}"
+    end
+
+    private
+
+    attr_writer :rev
+
+  end
+
+end

data/lib/couch_model/server.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), "transport")
+
+module CouchModel
+
+  class Server
+
+    class Error < StandardError; end
+
+    attr_reader :host
+    attr_reader :port
+
+    def initialize(options = { })
+      @host = options[:host] || "localhost"
+      @port = options[:port] || "5984"
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && @host == other.host && @port == other.port
+    end
+
+    def informations
+      Transport.request :get, url + "/", :expected_status_code => 200
+    end
+
+    def statistics
+      Transport.request :get, url + "/_stats", :expected_status_code => 200
+    end
+
+    def database_names
+      Transport.request :get, url + "/_all_dbs", :expected_status_code => 200
+    end
+
+    def uuids(count = 1)
+      response = Transport.request :get, url + "/_uuids", :expected_status_code => 200, :parameters => { :count => count }
+      response["uuids"]
+    end
+
+    def url
+      "http://#{@host}:#{@port}"
+    end
+
+  end
+
+end

data/lib/couch_model/transport.rb

@@ -0,0 +1,68 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module CouchModel
+
+  module Transport
+
+    class Error < StandardError; end
+
+    class UnexpectedStatusCodeError < StandardError
+
+      attr_reader :status_code
+
+      def initialize(status_code)
+        @status_code = status_code
+      end
+
+      def to_s
+        "#{super} received status code #{self.status_code}"
+      end
+
+    end
+
+    class << self
+
+      def request(http_method, url, options = { })
+        expected_status_code = options[:expected_status_code]
+        
+        uri = URI.parse @base_url ? @base_url + url : url
+
+        request_class = request_class http_method
+        request = request_object request_class, uri, options
+
+        response = Net::HTTP.start(uri.host, uri.port) { |connection| connection.request request }
+
+        raise UnexpectedStatusCodeError, response.code.to_i if expected_status_code && expected_status_code.to_s != response.code
+        JSON.parse response.body
+      end
+
+      private
+
+      def request_class(http_method)
+        Net::HTTP.const_get http_method.capitalize
+      end
+
+      def request_object(request_class, uri, options)
+        parameters  = options[:parameters] || { }
+        json        = options[:json]
+
+        case request_class.to_s
+          when "Net::HTTP::Get"
+            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
+      end
+
+    end
+    
+  end
+
+end

data/lib/couch_model/view.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), "configuration")
+require File.join(File.dirname(__FILE__), "collection")
+
+module CouchModel
+
+  class View
+
+    attr_reader   :design
+    attr_accessor :name
+    attr_accessor :map
+    attr_accessor :reduce
+
+    def initialize(design, attributes = { })
+      @design = design
+      @name   = attributes[:name]
+
+      generate_functions attributes
+      @map    = attributes[:map]    if attributes[:map]
+      @reduce = attributes[:reduce] if attributes[:reduce]
+    end
+
+    def collection(options = { })
+      Collection.new url, options
+    end
+
+    def to_hash
+      { self.name => { "map" => self.map, "reduce" => self.reduce } }
+    end
+
+    def url
+      "#{@design.url}/_view/#{@name}"
+    end
+
+    def generate_functions(options = { })
+      keys = [ (options[:keys] || "_id") ].flatten
+
+      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(" && ")}) {
+    emit(#{emit_values.size == 1 ? emit_values.first : "[ " + emit_values.join(", ") + " ]"}, null);
+  }
+}
+"""
+      @reduce = nil
+    end
+
+  end
+
+end

data/lib/couch_model.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+require File.join(File.dirname(__FILE__), "couch_model", "configuration")
+require File.join(File.dirname(__FILE__), "couch_model", "base")
+
+begin
+  gem 'activemodel'
+  require 'active_model'
+
+  require File.join(File.dirname(__FILE__), "couch_model", "active_model")
+
+  # ActiveModel support is activated
+rescue Gem::LoadError
+  # ActiveModel support is deactivated
+end

data/spec/fake_transport.yml

@@ -0,0 +1,202 @@
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/"
+  :response:
+    :code:      "200"
+    :json:
+      "couchdb":  "Welcome"
+      "version":  "0.10.0"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/_stats"
+  :response:
+    :code:      "200"
+    :json:
+      "httpd_status_codes":     "..."
+      "httpd_request_methods":  "..."
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/_all_dbs"
+  :response:
+    :code:      "200"
+    :json:      [ "development", "test" ]
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/_uuids"
+  :parameters:
+    :count:     3
+  :response:
+    :code:      "200"
+    :json:
+      "uuids":  [ "uuid_1", "uuid_2", "uuid_3" ]
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test"
+  :response:
+    :code:      "200"
+    :json:
+      "db_name":    "test"
+      "doc_count":  "0"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/new_database"
+  :response:
+    :code:      "404"
+    :json:
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/test_model_1"
+  :response:
+    :code:      "200"
+    :json:
+      "_id":          "test_model_1"
+      "_rev":         "0"
+      "model_class":  "BaseTestModel"
+      "name":         "phil"
+      "related_id":   "test_model_2"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/test_model_2"
+  :response:
+    :code:      "200"
+    :json:
+      "_id":          "test_model_2"
+      "_rev":         "0"
+      "model_class":  "BaseTestModel"
+      "name":         "keppla"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/invalid"
+  :response:
+    :code:      "404"
+-
+  :http_method: "post"
+  :url:         "http://localhost:5984/test"
+  :response:
+    :code:      "201"
+    :json:
+      "ok":   true
+      "id":   "test_model_2"
+      "rev":  "0"
+-
+  :http_method: "put"
+  :url:         "http://localhost:5984/test/test_model_1"
+  :response:
+    :code:      "200"
+    :json:
+      "ok":   true
+      "id":   "test_model_1"
+      "rev":  "1"
+-
+  :http_method: "delete"
+  :url:         "http://localhost:5984/test/test_model_1"
+  :parameters:
+    "rev":  "0"
+  :response:
+    :code:      "200"
+    :json:
+      "ok":   true
+      "id":   "test_model_1"
+      "rev":  "1"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/_design/test_design"
+  :response:
+    :code:      "200"
+    :json:
+      "_id":      "_design/test_design"
+      "_rev":     "0"
+      "language": "javascript"
+      "views":
+        "test_view":
+          "map":    "function(document) { };"
+          "reduce": "function(key, values, rereduce) { };"
+-
+  :http_method: "put"
+  :url:         "http://localhost:5984/test/_design/test_design"
+  :response:
+    :code:      "201"
+    :json:
+      "ok":   true
+      "id":   "_design/test_design"
+      "rev":  "1"
+-
+  :http_method: "get"
+  :url:         "http://localhost:5984/test/_all_docs"
+  :parameters:
+    "include_docs": "true"
+    "limit":        "1"
+  :response:
+    :code:      "200"
+    :json:
+      "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"
+    :json:
+      "total_rows":   1
+      "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\",{}]"
+  :response:
+    :code:      "200"
+    :json:
+      "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:
+      "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"