yssk22-couch_resource 0.1.0

data/lib/couch_resource/view.rb

@@ -0,0 +1,228 @@
+require 'digest/md5'
+require 'rubygems'
+require 'active_support'
+require 'json'
+
+#
+# == Synchronization of design documents
+#
+# Synchronization mechanism of design documents is controlled by <tt>check_design_revision_every_time</tt>.
+# The value is true, the finder methods of views always check the revision of the design document.
+# When false, the finder methods only check at first time.
+#
+module CouchResource
+  module View
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+      # base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      # Returns the design path specified by the <tt>design</tt> and <tt>view</tt> name.
+      def design_path(design, query_options=nil)
+        design_fullname = get_design_fullname(design)
+        # document_path("_design%2F#{design_fullname}", query_options)
+        document_path("_design/#{design_fullname}", query_options)
+      end
+
+      # returns the view path specified by the <tt>design</tt> and <tt>view</tt> name.
+      def view_path(design, view, query_options=nil)
+        design_fullname = get_design_fullname(design)
+        view_options = {}
+        if query_options
+          # convert query args to json value
+          [:key, :startkey, :endkey].each do |arg|
+            view_options[arg] = query_options[arg].to_json if query_options.has_key?(arg)
+          end
+
+          # do not care
+          [:include_docs, :update, :descending, :group, :startkey_docid, :endkey_docid, :count, :skip, :group_level].each do |arg|
+            view_options[arg] = query_options[arg] if query_options.has_key?(arg)
+          end
+        end
+        document_path(File.join("_view", design_fullname, view.to_s), view_options)
+      end
+
+      # Returns the full name of design document.
+      def get_design_fullname(design)
+        "#{self.to_s}_#{design}"
+      end
+
+      # Returns the view definition hash which contains :map key and :reduce key (optional).
+      def get_view_definition(design, view)
+        design_documents = read_inheritable_attribute(:design_documents) || {}
+        design_doc = design_documents[design.to_s]
+        return nil unless design_doc
+        return design_doc[:views][view]
+      end
+
+
+      # Define view on the server  access method for this class.
+      #
+      # for example, the following code defines a design_document at _design/SomeDocument_my_design ::
+      #
+      #   class SomeDocument
+      #     view :my_design, :sample_view => {
+      #       :map    => include_js("path/to/map.js")
+      #       :reduce => include_js("path/to/reduce.js")
+      #     }
+      #   end
+      #
+      # The design document include one view whose name is 'sample_view'.
+      # And following 4 methods will be available in SomeDocument class.
+      #
+      #   SomeDocument.find_my_design_sample_view()
+      #   SomeDocument.find_my_design_sample_view_first()
+      #   SomeDocument.find_my_design_sample_view_last()
+      #   SomeDocument.find_my_design_sample_view_all()
+      #
+      # The design document actually stored on the server at the first time when the above methods are invoked.
+      #
+      def view(design, views)
+        # append prefix to design
+        # Klass_design is a proper design document name
+        design_fullname = get_design_fullname(design)
+
+        design_document = {
+          :_id       => "_design/#{design_fullname}",
+          :language => "javascript",
+          :views    => views
+        }
+        # Get the design document revision if already exists.
+        logger.debug "Design Doc: get the existance revision."
+        rev = connection.get(design_path(design))[:_rev] rescue nil
+        design_document[:_rev] = rev if rev
+        logger.debug "Design Doc: revision: #{rev || 'not found'}"
+
+        # Update inheritable attribute for design_documents
+        design_documents = read_inheritable_attribute(:design_documents) || {}
+        design_documents[design.to_s] = design_document
+        write_inheritable_attribute(:design_documents, design_documents)
+
+        # define query method for each views
+        # find_{design}_{view}(*args)   -- key is one of :all, :first, :last
+        # find_{design}_{view}_all(options)
+        # find_{design}_{view}_first(options)
+        # find_{design}_{view}_last(options)
+        views.each do |viewname, functions|
+          define_view_method(design, viewname)
+        end
+      end
+
+      # Returns the string of the javascript file stored in the <tt>path</tt>
+      # The <tt>path</tt> is the relative path, root of which is the directory of the caller.
+      # The <tt>root</tt> can be also specified in the second argument.
+      def include_js(path, root = nil)
+        # set root the current directory of the caller.
+        if root.nil?
+          from = caller.first
+          if from =~ /^(.+?):(\d+)/
+            root = File.dirname($1)
+          else
+            root = RAILS_ROOT
+          end
+        end
+        fullpath = File.join(root, path)
+        ERB.new(File.read(fullpath)).result(binding)
+      end
+
+      def define_view_method(design, view)
+        method = <<-EOS
+        def self.find_#{design}_#{view}(*args)
+          options = args.extract_options!
+          define_design_document("#{design.to_s}")
+          case args.first
+          when :first
+            find_#{design}_#{view}_first(options)
+          when :last
+            find_#{design}_#{view}_last(options)
+          else
+            find_#{design}_#{view}_all(options)
+          end
+        end
+EOS
+        class_eval(method, __FILE__, __LINE__)
+
+        [:all, :first, :last].each do |key|
+          method = <<-EOS
+          def self.find_#{design}_#{view}_#{key}(options = {})
+            define_design_document("#{design.to_s}")
+            find_#{key}("#{design}", :#{view}, options)
+          end
+EOS
+          class_eval(method, __FILE__, __LINE__)
+        end
+      end
+
+      def get_design_document_from_server(design)
+        path = design_path(design)
+        logger.debug "CouchResource::Connection#get #{path}"
+        connection.get(path) rescue nil
+      end
+
+      # Define design document if it does not exist on the server.
+      def define_design_document(design)
+        path = design_path(design)
+        design_document         = read_inheritable_attribute(:design_documents)[design]
+        design_revision_checked = read_inheritable_attribute(:design_revision_checked) || false
+        logger.debug "Design Document Check"
+        logger.debug "  check_design_revision_every_time = #{check_design_revision_every_time}"
+        logger.debug "  design_revision_checked          = #{design_revision_checked}"
+        #if self.check_view_every_access
+        if self.check_design_revision_every_time || !design_revision_checked
+          current_doc = get_design_document_from_server(design)
+          # already exists
+          if current_doc
+            logger.debug "Design document is found and updates are being checked."
+            logger.debug current_doc.to_json
+            if match_views?(design_document[:views], current_doc[:views])
+              logger.debug "Design document(#{path}) is the latest."
+            else
+              logger.debug "Design document(#{path}) is not the latest, should be updated."
+              design_document[:_rev] = current_doc[:_rev]
+              logger.debug "CouchResource::Connection#put #{path}"
+              hash = connection.put(path, design_document.to_json)
+              logger.debug hash.to_json
+              design_document[:_rev] = hash[:rev]
+            end
+          else
+            logger.debug "Design document not found so to put."
+            design_document.delete(:_rev)
+            logger.debug "CouchResource::Connection#put #{path}"
+            logger.debug design_document.to_json
+            hash = connection.put(path, design_document.to_json)
+            logger.debug hash.to_json
+            design_document[:_rev] = hash["rev"]
+          end
+          design_revision_checked = true
+        else
+          if design_document[:_rev].nil?
+            begin
+              hash = connection.put(design_path(design), design_document.to_json)
+              design_document[:_rev] = hash[:rev]
+            rescue CouchResource::PreconditionFailed
+              # through the error.
+              design_document[:_rev] = connection.get(design_path(design))[:_rev]
+            end
+          end
+        end
+      end
+
+      private
+      def match_views?(views1, views2)
+        # {
+        #   :view_name => {:map => ..., :reduce => ...},
+        #   ...
+        # }
+        views1.each do |key, mapred1|
+          return false unless views2.has_key?(key)
+          mapred2 = views2[key]
+          redhex = [Digest::MD5.hexdigest(mapred1[:reduce].to_s), Digest::MD5.hexdigest(mapred2[:reduce].to_s)]
+          return false  unless Digest::MD5.hexdigest(mapred1[:map].to_s) == Digest::MD5.hexdigest(mapred2[:map].to_s)
+          return false  unless Digest::MD5.hexdigest(mapred1[:reduce].to_s) == Digest::MD5.hexdigest(mapred2[:reduce].to_s)
+        end
+        true
+      end
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,384 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "../lib/couch_resource")
+
+TEST_DB_PATH  = "couch_resource_base_test"
+
+CouchResource::Base.logger = Logger.new("/dev/null")
+CouchResource::Base.check_design_revision_every_time = true
+# CouchResource::Base.logger = Logger.new(STDOUT)
+
+class SimpleDocument < CouchResource::Base
+  self.database = "http://localhost:5984/#{TEST_DB_PATH}"
+  string :title
+  string :content
+
+  view :simple_document, {
+    :all_by_id => {
+      :map => "function(doc){ emit(doc._id, doc); }"
+    },
+    :all_by_title => {
+      :map => "function(doc){ emit(doc.title, doc); }"
+    }
+  }
+end
+
+class StrictDocument < CouchResource::Base
+  self.database = "http://localhost:5984/#{TEST_DB_PATH}"
+  string :title, :validates => [
+    [:length_of, {:maximum => 20}],
+    [:length_of, {:on => :create, :minimum => 5}],
+    [:length_of, {:on => :update, :minimum => 10}]
+  ]
+end
+
+class MagicAttributesTest < CouchResource::Base
+  self.database = "http://localhost:5984/#{TEST_DB_PATH}"
+  datetime :created_at
+  datetime :created_on
+  datetime :updated_at
+  datetime :updated_on
+end
+
+class TestBase < Test::Unit::TestCase
+  def setup
+    res = SimpleDocument.connection.put(SimpleDocument.database.path)
+    unless res[:ok]
+      puts "Failed to create test database. Check couchdb server running."
+    end
+  end
+
+  def teardown
+    res = SimpleDocument.connection.delete(SimpleDocument.database.path)
+    unless res[:ok]
+      puts "Failed to drop test database. Delete manually before you test next time."
+    end
+  end
+
+
+  def test_new?
+    doc = SimpleDocument.new(:title => "title", :content => "content")
+    assert doc.new?
+    doc = SimpleDocument.new(:_id => "simple_document", :title => "title", :content => "content")
+    assert doc.new?
+    doc = SimpleDocument.new(:_id => "simple_document", :_rev => "1234",
+                             :title => "title", :content => "content")
+    assert !doc.new?
+  end
+
+  def test_create_without_id
+    doc = SimpleDocument.new(:title => "title", :content => "content")
+    assert doc.save
+    assert_not_nil doc.id
+    assert_not_nil doc.rev
+  end
+
+  def test_create_with_id
+    doc = SimpleDocument.new(:_id => "simple_document", :title => "title", :content => "content")
+    assert doc.save
+    assert_equal "simple_document", doc.id
+    assert_not_nil doc.rev
+  end
+
+  def test_create_with_validation_failed
+    doc = StrictDocument.new(:_id => "simple_document", :title => "123", :content => "content")
+    assert !doc.save
+    assert_raise(CouchResource::ResourceNotFound) { StrictDocument.find("simple_document")}
+    doc.title = "1" * 5
+    assert doc.save
+    doc = StrictDocument.find("simple_document")
+    assert_not_nil doc
+    assert !doc.save
+    doc.title = "1" * 11
+    assert doc.save
+    doc.title = "1" * 25
+    assert !doc.save
+  end
+
+  def test_update
+    doc1 = SimpleDocument.new(:title => "title", :content => "content")
+    assert doc1.save
+    old_rev = doc1.rev
+    assert_not_nil doc1.id
+    assert_not_nil doc1.rev
+    doc1.content = "updated"
+    doc1.save
+    doc2 = SimpleDocument.find(doc1.id)
+    assert_equal "updated", doc2.content
+    assert_not_equal old_rev, doc2.rev
+  end
+
+  def test_destroy
+    doc1 = SimpleDocument.new(:title => "title", :content => "content")
+    doc1.save
+    old_id  = doc1.id
+    old_rev = doc1.rev
+    assert_not_nil doc1.id
+    assert_not_nil doc1.rev
+    doc1.destroy
+    assert_not_nil doc1.id
+    assert_nil doc1.rev
+    assert_raise(CouchResource::ResourceNotFound) { SimpleDocument.find(old_id) }
+    doc1.save
+    doc1 = SimpleDocument.find(old_id)
+    assert_equal old_id, doc1.id
+    assert_not_equal old_rev, doc1.rev
+  end
+
+  def test_revs
+    doc1 = SimpleDocument.new(:title => "title", :content => "content")
+    revs = []
+    5.times do
+      assert doc1.save
+      revs << doc1.rev
+    end
+    revs.reverse!
+    retrieved = doc1.revs
+    assert_equal 5, retrieved.length
+    assert_equal revs, retrieved
+    retrieved = doc1.revs(true)
+    retrieved.each_with_index do |revinfo, i|
+      assert_not_nil revinfo
+      assert_equal revs[i], revinfo[:rev]
+      assert_equal "available", revinfo[:status]
+    end
+  end
+
+  def test_find_from_ids()
+    doc1 = SimpleDocument.new(:title => "title", :content => "content")
+    doc1.save
+    # find an document
+    doc2 = SimpleDocument.find(doc1.id)
+    assert_equal "title", doc2.title
+    assert_equal "content",  doc2.content
+    assert_equal doc1.rev, doc2.rev
+    assert_equal doc1.id,  doc2.id
+    # find multiple documents
+    docs = SimpleDocument.find(doc1.id, doc2.id)
+    docs.each do |doc|
+      assert_equal "title",  doc.title
+      assert_equal "content",  doc2.content
+      assert_equal doc1.rev, doc.rev
+      assert_equal doc1.id,  doc.id
+    end
+    # find with :rev option
+    doc2 = SimpleDocument.find(doc1.id, :rev => doc1.rev)
+    doc2 = SimpleDocument.find(doc1.id)
+    assert_equal "title", doc2.title
+    assert_equal "content",  doc2.content
+    assert_equal doc1.rev, doc2.rev
+    assert_equal doc1.id,  doc2.id
+  end
+
+  def test_find_first
+    register_simple_documents()
+    # without any options
+    doc = SimpleDocument.find_simple_document_all_by_title_first
+    assert_not_nil doc
+    assert_equal "title_0", doc.title
+    assert_equal "content_0", doc.content
+
+    # with descending option (same as SimpleDocument.last without descending option)
+    doc = SimpleDocument.find_simple_document_all_by_title_first(:descending => true)
+    assert_not_nil doc
+    assert_equal "title_9", doc.title
+    assert_equal "content_9", doc.content
+
+    # with offset option
+    doc = SimpleDocument.find_simple_document_all_by_title_first(:skip => 1)
+    assert_not_nil doc
+    assert_equal "title_1", doc.title
+    assert_equal "content_1", doc.content
+
+    # with key options
+    doc = SimpleDocument.find_simple_document_all_by_title_first(:key => "title_2")
+    assert_not_nil doc
+    assert_equal "title_2", doc.title
+    assert_equal "content_2", doc.content
+  end
+
+  def test_find_last
+    register_simple_documents()
+    # without any options
+    doc = SimpleDocument.find_simple_document_all_by_title_last
+    assert_not_nil doc
+    assert_equal "title_9", doc.title
+    assert_equal "content_9", doc.content
+
+    # with descending option (same as SimpleDocument.last without descending option)
+    doc = SimpleDocument.find_simple_document_all_by_title_last(:descending => true)
+    assert_not_nil doc
+    assert_equal "title_0", doc.title
+    assert_equal "content_0", doc.content
+
+    # with key option
+    doc = SimpleDocument.find_simple_document_all_by_title_last(:key => "title_2")
+    assert_not_nil doc
+    assert_equal "title_2", doc.title
+    assert_equal "content_2", doc.content
+  end
+
+  def test_find_all
+    register_simple_documents()
+    # without any options
+    docs = SimpleDocument.find_simple_document_all_by_title
+    assert_not_nil docs
+    (0..9).each do |i|
+      doc = docs[:rows][i]
+      assert_not_nil doc
+      assert_equal "title_#{i}", doc.title
+      assert_equal "content_#{i}", doc.content
+    end
+
+    # with descending option
+    docs = SimpleDocument.find_simple_document_all_by_title(:descending => true)
+    (0..9).each do |i|
+      doc = docs[:rows][i]
+      assert_equal "title_#{9-i}", doc.title
+      assert_equal "content_#{9-i}", doc.content
+    end
+
+    # with key option
+    docs = SimpleDocument.find_simple_document_all_by_title(:key => "title_1")
+    assert_equal 1, docs[:rows].length
+    assert_equal "title_1", docs[:rows].first.title
+    assert_equal "content_1", docs[:rows].first.content
+    # with key option (no matching)
+    docs = SimpleDocument.find_simple_document_all_by_title(:key => "1")
+    assert_equal 0, docs[:rows].length
+
+    # with startkey option
+    docs = SimpleDocument.find_simple_document_all_by_title(:startkey => "title_5")
+    assert_equal 5, docs[:rows].length
+    (5..9).each do |i|
+      doc = docs[:rows][i-5]
+      assert_not_nil doc
+      assert_equal "title_#{i}", doc.title
+      assert_equal "content_#{i}", doc.content
+    end
+
+    # with endkey option
+    docs = SimpleDocument.find_simple_document_all_by_title(:endkey => "title_4")
+    assert_equal 5, docs[:rows].length
+    (0..4).each do |i|
+      doc = docs[:rows][i]
+      assert_not_nil doc
+      assert_equal "title_#{i}", doc.title
+      assert_equal "content_#{i}", doc.content
+    end
+
+    # with startkey and endkey option
+    docs = SimpleDocument.find_simple_document_all_by_title(:startkey => "title_3", :endkey => "title_6")
+    assert_equal 4, docs[:rows].length
+    (3..6).each do |i|
+      doc = docs[:rows][i-3]
+      assert_not_nil doc
+      assert_equal "title_#{i}", doc.title
+      assert_equal "content_#{i}", doc.content
+    end
+  end
+
+
+  def test_paginate
+    register_simple_documents()
+
+    # retrieve all documentes
+    docs = SimpleDocument.find_simple_document_all_by_title(:count => 10)
+    assert_nil  docs[:previous]
+    assert_nil  docs[:next]
+    assert_equal "title_0", docs[:rows].first.title
+    assert_equal "title_9", docs[:rows].last.title
+
+    # retrive documents per 4 docs.
+    # 0..3
+    docs = SimpleDocument.find_simple_document_all_by_title(:count => 4)
+    assert_equal -1, docs[:previous][:expected_offset]
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_0", docs[:rows].first.title
+    assert_equal "title_3", docs[:rows].last.title
+
+    # next
+    # 4..7
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:next])
+    assert docs[:previous][:expected_offset] > 0
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_4", docs[:rows].first.title
+    assert_equal "title_7", docs[:rows].last.title
+
+    # next (it remains only 2 docs);
+    # 8..9
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:next])
+    assert docs[:previous][:expected_offset] > 0
+    assert_equal -1, docs[:next][:expected_offset]
+    assert_equal "title_8", docs[:rows].first.title
+    assert_equal "title_9", docs[:rows].last.title
+
+    # previous (should return 4 docs before title_8)
+    # 4..7
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:previous])
+    assert docs[:previous][:expected_offset] > 0
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_4", docs[:rows].first.title
+    assert_equal "title_7", docs[:rows].last.title
+
+    # previous (should return 4 docs before title_4)
+    # 0..3
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:previous])
+    assert docs[:previous][:expected_offset] > 0
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_0", docs[:rows].first.title
+    assert_equal "title_3", docs[:rows].last.title
+
+    # previous over reached
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:previous])
+    assert_equal -1, docs[:previous][:expected_offset]
+    assert_nil docs[:next][:expected_offset]
+    assert_equal 0, docs[:rows].length
+
+    # more complex case
+    # fetch more than half documents at first access and with descending option
+    # retrieve 9 documentes (from 9 to 1)
+    docs = SimpleDocument.find_simple_document_all_by_title(:descending => true, :count => 9)
+    assert_equal -1, docs[:previous][:expected_offset]
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_9", docs[:rows].first.title
+    assert_equal "title_1", docs[:rows].last.title
+
+    # next
+    # only 0
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:next])
+    assert docs[:previous][:expected_offset] > 0
+    assert_equal -1, docs[:next][:expected_offset]
+    assert_equal "title_0", docs[:rows].first.title
+
+    # previous
+    # 9..1
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:previous])
+    assert docs[:previous][:expected_offset] > 0
+    assert docs[:next][:expected_offset] > 0
+    assert_equal "title_9", docs[:rows].first.title
+    assert_equal "title_1", docs[:rows].last.title
+
+    # previous over reached
+    docs = SimpleDocument.find_simple_document_all_by_title(docs[:previous])
+    assert_equal -1, docs[:previous][:expected_offset]
+    assert_nil docs[:next][:expected_offset]
+    assert_equal 0, docs[:rows].length
+  end
+
+  private
+  def register_simple_documents
+    0.upto(9) do |i|
+      doc = SimpleDocument.new(:title => "title_#{i}", :content => "content_#{i}")
+      doc.save
+    end
+  end
+
+  def test_magic_attributes
+    obj = MagicAttributesTest
+    obj.save
+    assert_not_nil obj.created_at
+    assert_not_nil obj.created_on
+    assert_not_nil obj.updated_at
+    assert_not_nil obj.updated_on
+  end
+end