divan 0.1.2 → 0.1.3

data/.gitignore

@@ -0,0 +1,5 @@
+# /doc/
+/doc/*
+
+# /drafts/
+/drafts/*

data/README.rdoc

@@ -0,0 +1,60 @@
+== Divan, are you insane?
+
+* Do you need to have CouchDB <b>easy access to revisions</b>?
+* *Sometimes* do you need to use just <b>one kind of document per database</b>? And sometimes don't?
+* Do you need to use CouchDB <b>without care about activesupport</b> dependencies?
+* Do you need to access <b>HTTP headers</b> of the request that returned your document object?
+
+So you are *insane*! Divan is a comfortable place for you to rest.
+
+== Look how it's easy!
+
+  # Model class
+  class InsanePerson < Divan::Models::InsanePerson
+    view_by :name
+    view_by :doctor
+  end
+
+  # Simple Usage
+  patient = InsanePeople.new :name => 'Hannibal', :doctor => 'House'
+  patient.problems = ['Sleepness', 'Headache', 'Alucinations']
+  patient.save
+
+  # Acessing HTTP header
+  patient.last_request.headers[:content_type]
+
+  # Easy accesso to revisions
+  patient.alive = true
+  patient.ttl   = 7
+  10.times.do
+    if patient.ttl > 0
+      patient.ttl -= 1
+    else
+      patient.alive = false
+      break
+    end
+    patient.save
+  end
+  patient.revision(2).rollback # Be carefull, he's back!
+
+  # Configuration file
+  insane_person:
+    host:     http://127.0.0.1
+    port:     5984
+    database: insane_person
+
+== FAQ
+
+  1. Why are you not using active_model?
+       Because ActiveModel depends on active_support, and sometimes we want a model library that could
+       be used with Rails 2, or any other project could have conflicted dependencies.
+       ActiveModel is a great library, but it'snt a silver bullet for model libraries.
+  2. Who needs access to HTTP headers?
+       Sometimes it's interesting to know exactly the time that each document is retuned by database,
+       you can do it calling method last_request in each document.
+  3. Why dont you use CouchRest?
+       With CouchRest isn't easy to have access to HTTP headers
+
+== TODO
+
+A better README, documentation and other details

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/init.rb

@@ -1,8 +1,11 @@
-require 'divan.rb'
+require "#{File.dirname(__FILE__)}/lib/divan.rb"
 
 #Lines below are used for debug purposes only
 Divan.load_database_configuration 'config/divan_config.yml'
 
+class ProofOfConcept < Divan::Models::ProofOfConcept
+end
+
 class POC < Divan::Models::ProofOfConcept
   view_by :mod
   view_by :value

data/lib/divan.rb

@@ -1,4 +1,4 @@
-divan_path = File.expand_path('../lib', __FILE__)
+divan_path = File.dirname(__FILE__)
 $:.unshift(divan_path) if File.directory?(divan_path) && !$:.include?(divan_path)
 
 require 'restclient'
@@ -64,7 +64,10 @@ module Divan
     attr_reader :new_document, :current_document
     def initialize(new_document)
       @new_document = new_document
-      @current_document = new_document.class.find new_document.id
+    end
+
+    def current_document
+      @current_document ||= new_document.class.find new_document.id
     end
   end
 end

data/lib/divan/base.rb

@@ -1,11 +1,15 @@
 module Divan
   class Base < Models::Base
-    attr_accessor :id, :rev, :attributes, :last_request
+    attr_accessor :id, :rev, :attributes, :meta_attributes, :last_request
 
     def initialize(opts = {})
       opts = opts.clone
       @id  = opts.delete(:id)  || opts.delete(:_id) || Divan::Utils.uuid
       @rev = opts.delete(:rev) || opts.delete(:_rev)
+      @meta_attributes = opts.find_all{ |k,v| k.to_s[0..0] == '_' }.inject({}) do |hash, (key, value)|
+        hash[key.to_s[1..-1].to_sym] = opts.delete key
+        hash
+      end
       @attributes = opts 
       @attributes[self.class.type_field.to_sym] = self.class.type_name unless self.class.top_level_model?
       self.class.properties.each{ |property| @attributes[property] ||= nil }
@@ -66,8 +70,9 @@ module Divan
         strs.delete ''
         subclass.model_name = strs.map{ |x| x.downcase }.join('_')
         if database
+          subclass.top_level_model! if database.name == subclass.model_name
+          subclass.define_view_all
           subclass.database = database
-          subclass.top_level_model! if subclass.database.name == subclass.model_name
         end
       end
 
@@ -87,6 +92,10 @@ module Divan
         @top_level_model ||= false
       end
 
+      def views
+        @views ||= {}
+      end
+
       def properties
         @properties ||= ( superclass.methods.include? :properties ) ? superclass.properties.clone : []
       end
@@ -98,7 +107,6 @@ module Divan
       def database=(database)
         undefine_views if( !@database.nil? && @database != database )
         @database = database
-        define_view_all
         define_views
         @database
       end
@@ -129,31 +137,31 @@ module Divan
         @views[param.to_sym] = functions
       end
 
-      def define_view!(param, functions)
-        database.views[model_name] ||= {}
-        database.views[model_name][param.to_sym] = functions
-      end
-
       def define_view_all
-        if database && model_name == database.name
-          define_view :all, :map => "function(doc){ if(doc._id.slice(0, 7) != \"_design\"){ emit(null, doc) } }"
+        if top_level_model?
+          define_view :all, :map => "function(doc){ if(doc._id[0] != \"_\"){ emit(null, doc) } }"
         else
           define_view :all, :map => "function(doc){ if(doc.#{type_field} == \"#{type_name}\"){ emit(null, doc) } }"
-        end        
+        end
       end
 
-      def query_view(view, key=nil, args={}, special={})
-        if key.is_a? Hash
-          special = args
-          args    = key
+      def query_view(view, args={})
+        args ||= {}
+        args = args.clone
+        [:key, :startkey, :endkey].each do |k|
+          args[k] = args[k].to_json if args[k]
+        end
+
+        if args[:keys]
+          keys = args.delete(:keys).to_json
+          view_path = Divan::Utils.formatted_path "_design/#{model_name}/_view/#{view}", args
+          last_request = database.client[view_path].post keys
         else
-          special = args
-          args    = {:key => key}
+          args[:key] = nil.to_json if args[:key].nil? && args[:startkey].nil? && args[:endkey].nil?
+          view_path = Divan::Utils.formatted_path "_design/#{model_name}/_view/#{view}", args
+          last_request = database.client[view_path].get
         end
 
-        args = args.inject({}){ |hash,(k,v)| hash[k] = v.to_json; hash }
-        view_path = Divan::Utils.formatted_path "_design/#{model_name}/_view/#{view}", args.merge(special)
-        last_request = database.client[view_path].get
         results = JSON.parse last_request, :symbolize_names => true
         results[:rows].map do |row|
           obj = self.new row[:value]
@@ -167,11 +175,22 @@ module Divan
       def view_by(param)
         @view_by_params ||= []
         @view_by_params << param
-        define_view! "by_#{param}", :map => "function(doc) { emit(doc.#{param}, doc) }"
+        if top_level_model?
+          define_view "by_#{param}", :map => "function(doc) { emit(doc.#{param}, doc) }"
+        else
+          define_view "by_#{param}", :map => "function(doc) { if(doc.#{type_field} == \"#{type_name}\"){ emit(doc.#{param}, doc) } }"
+        end
         eval <<-end_txt
           class << self
-            def all_by_#{param}(key, args={}, special={})
-              query_view :by_#{param}, key, args, special
+            def all_by_#{param}(args=nil)
+              unless args.is_a? Hash
+                if args.is_a? Array
+                  args = { :keys => args }
+                else
+                  args = { :key => args }
+                end
+              end
+              query_view :by_#{param}, args
             end
 
             def by_#{param}(key)
@@ -179,11 +198,11 @@ module Divan
             end
           end
         end_txt
+        define_views
       end
 
       def define_views
-        database.views[model_name] ||= {}
-        database.views[model_name].merge! @views if @views
+        database.views[model_name] = views
       end
 
       def undefine_views

data/lib/divan/database.rb

@@ -30,6 +30,14 @@ module Divan
       end
     end
 
+    def compact
+      begin
+        client['_compact'].post Hash.new, :'content-type' => 'application/json'
+      rescue RestClient::ResourceNotFound
+        raise Divan::DatabaseNotFound.new(self), "Database was not found"
+      end
+    end
+
     def create
       begin
         client.put Hash.new

data/lib/divan/models/base.rb

@@ -2,7 +2,7 @@ module Divan
   module Models
     class Base
 
-      def save
+      def save(strategy=nil, &block)
         self.class.execute_before_validate_callback(self) or return false
 
         validate or return false
@@ -10,7 +10,7 @@ module Divan
         self.class.execute_after_validate_callback(self)  or return false
         self.class.execute_before_save_callback(self)     or return false
 
-        execute_save
+        execute_save strategy, &block
 
         self.class.execute_after_save_callback(self)
         @last_request
@@ -38,27 +38,58 @@ module Divan
 
       def revision(index)
         revision!(index)
-      rescue Divan::Divan::DocumentRevisionNotAvailable
+      rescue Divan::DocumentRevisionMissing
         nil
       end
 
       def revision!(index)
-        r = revision_ids.find{ |rev| rev[0..1].to_i == index}
-        r.nil? and raise Divan::Divan::DocumentRevisionNotAvailable.new(self), "Revision with index #{index} missing"
+        r = revision_ids.find{ |rev| rev[0..1].to_i == index }
+        r.nil? and raise Divan::DocumentRevisionMissing.new(self), "Revision with index #{index} missing"
         return self if r == @rev
         self.class.find @id, :rev => r
       end
 
       protected
 
-      def execute_save
+      def execute_save(strategy=nil, &block)
+        previous_request = @last_request
         begin
           save_attrs = @attributes.clone
           save_attrs[:"_rev"] = @rev if @rev
+          save_attrs.delete(:id)
+          save_attrs.delete(:_id)
           @last_request = database.client[current_document_path].put save_attrs.to_json
           @rev = JSON.parse(@last_request, :symbolize_names => true )[:rev]
         rescue RestClient::Conflict
-          raise Divan::DocumentConflict.new(self), "Update race conflict"
+          if strategy && self.class.strategies[strategy.to_sym]
+            run_strategy_in_block &self.class.strategies[strategy.to_sym]
+          elsif block_given?
+            run_strategy_in_block &block 
+          else
+            raise Divan::DocumentConflict.new(self), "Update race conflict"
+          end
+        end
+      end
+
+      def run_strategy_in_function(strategy)
+        conflict_doc = self.class.find(id)
+        @rev         = conflict_doc.rev
+        if send( "#{strategy}_strategy", self.class.find(id) )
+          execute_save strategy
+        else
+          @attributes   = conflict_doc.attributes
+          @last_request = conflict_doc.last_request
+        end
+      end
+
+      def run_strategy_in_block(&block)
+        conflict_doc = self.class.find(id)
+        @rev         = conflict_doc.rev
+        if yield(self, conflict_doc)
+          self.execute_save(nil, &block)
+        else
+          @attributes   = conflict_doc.attributes
+          @last_request = conflict_doc.last_request
         end
       end
 
@@ -101,8 +132,16 @@ module Divan
           end
         end
 
+        def strategies
+          @strategies ||= superclass.respond_to?(:strategies) ? superclass.strategies.clone : {}
+        end
+
         protected
 
+        def strategy(name, &block)
+          strategies[name.to_sym] = block
+        end
+
         def single_create(opts = {})
           obj = self.new(opts)
           obj.save
@@ -118,9 +157,12 @@ module Divan
           end }
           last_request = database.client['_bulk_docs'].post( payload.to_json, :content_type => :json, :accept => :json )
         end
-
       end
 
+      strategy(:first_wins) { |here, in_database| false }
+      strategy(:last_wins)  { |here, in_database| true }
+      strategy(:merge)      { |here, in_database| here.attributes = in_database.attributes.merge here.attributes }
+
     end
   end
 end

data/lib/divan/models/revision.rb

@@ -0,0 +1,62 @@
+module Divan
+  module Models
+    class Revision < Models::Base
+      attr_reader :revisioned_doc, :revisioned_at, :revisioned_by
+
+      def initialize(*args)
+        super
+        @revisioned_doc = @meta_attributes.delete :revision_of
+        @revisioned_at  = @meta_attributes.delete :revisioned_at
+        @revisioned_by  = @meta_attributes.delete :revisioned_by
+      end
+
+      def rollback
+        revisioned_doc.attributes = @attributes.clone
+        revisioned_doc.save :last_wins
+      end
+
+      class << self
+        attr_reader :revisioned_class
+
+        def create_by_revisioned_doc(rev_doc, rev_by = nil)
+          self.new rev_doc.params
+          self.id         = URI.encode "_revision/#{rev_doc.rev}"
+          @revisioned_doc = rev_doc
+          # parsed_time     = Date._parse rev_doc.last_request.headers[:date]
+          # @revisioned_at  = Time.gm *[:year, :mon, :mday, :hour, :min, :sec].collect{ |k| parsed_time[k] }
+          @revisioned_at  = Divan::Utils.parse_time rev_doc.last_request.headers[:date]
+          @revisioned_by  = rev_by
+          self.save
+        end
+
+        def revisioned_class=(rev_class)
+          @revisioned_class = rev_class
+          self.database     = rev_class.database
+          self.model_name   = rev_class.model_name + '_revision'
+        end
+        alias :revision_of :'revisioned_class='
+
+        def type_name
+          revisioned_class.type_name
+        end
+
+        def type_field
+          revisioned_class.type_field
+        end
+
+        def top_level_model!(*args)
+          raise "Can't modify revision top level"
+        end
+
+        def top_level_model?
+          revisioned_class.top_level_model?
+        end
+
+        def inherithed(subclass)
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/divan/utils.rb

@@ -6,6 +6,11 @@ module Divan
       "%04x%04x%04x%04x%04x%06x%06x" % values
     end
 
+    def self.parse_time(string)
+      parsed_time     = Date._parse string
+      Time.gm *[:year, :mon, :mday, :hour, :min, :sec].collect{ |k| parsed_time[k] }
+    end
+
     def self.formatted_path(path = nil, opts = {})
       if opts.empty?
         CGI.escape path.to_s

data/test/unit/divan.rb

@@ -20,9 +20,14 @@ class ViewedModel < Divan::Models::ProofOfConcept
 end
 
 class ProofOfConcept < Divan::Models::ProofOfConcept
+  strategy(:add_conflicted_field_and_keep_this) { |here, in_db| here.conflict = "conflicted!"}
+
   property :first_name
 end
 
+Divan::Models::ProofOfConcept.database.create unless Divan::Models::ProofOfConcept.database.exists?
+Divan::Models::ProofOfConcept.database.create_views
+
 class TestDivan < Test::Unit::TestCase
   def test_dynamic_model
     m = Divan::Model(:teste)
@@ -132,7 +137,6 @@ class TestDivan < Test::Unit::TestCase
     10.times do |n|
       assert ProofOfConcept.new( :value => n ).save
     end
-    # assert_equal Divan[:proof_of_concept].views.count, 5
     assert Divan[:proof_of_concept].create_views
     assert_equal ProofOfConcept.delete_all(:limit => 6), 6
     assert_equal ProofOfConcept.all.first.class, ProofOfConcept
@@ -142,6 +146,7 @@ class TestDivan < Test::Unit::TestCase
   end
 
   def test_bulk_create
+    assert ProofOfConcept.top_level_model?
     assert ProofOfConcept.delete_all
     params = 10.times.map do |n|
       {:number => n, :double => 2*n}
@@ -195,4 +200,62 @@ class TestDivan < Test::Unit::TestCase
     assert_equal ViewedModel.delete_all, 1
     assert_equal ProofOfConcept.delete_all, 2
   end
+
+  def test_first_wins_save_strategy
+    first = ProofOfConcept.create :test => 123
+    last  = ProofOfConcept.new :id => first.id, :test => 321
+    assert last.save(:first_wins)
+    assert_equal ProofOfConcept.find(first.id).test, 123
+    assert_equal last.test, 123
+  end
+
+  def test_last_wins_save_strategy
+    first = ProofOfConcept.create :test => 123
+    last  = ProofOfConcept.new :id => first.id, :test => 321
+    assert last.save(:last_wins)
+    assert_equal ProofOfConcept.find(first.id).test, 321
+    assert_equal last.test, 321
+  end
+
+  def test_merge_save_strategy
+    first = ProofOfConcept.create :test_one => 1, :test => 'Working'
+    last  = ProofOfConcept.new :id => first.id, :test_one => 123, :test_two => 321
+    expected_attributes = first.attributes.merge last.attributes
+    assert last.save(:merge)
+    assert_equal ProofOfConcept.find(first.id).attributes, expected_attributes
+    assert_equal last.attributes, expected_attributes
+  end
+
+  def test_custom_save_strategy
+    first = ProofOfConcept.create :amount => 100
+    last  = ProofOfConcept.new :id => first.id, :amount => 200
+    expected_attributes = first.attributes.merge last.attributes
+    assert last.save(){ |here, in_database| here.amount += in_database.amount }
+    assert_equal ProofOfConcept.find(first.id).amount, 300
+    assert_equal last.amount, 300
+    assert first.save(){ |here, in_database| here.amount > in_database.amount }
+    assert_equal ProofOfConcept.find(first.id).amount, 300
+    assert_equal first.amount, 300
+  end
+
+  def test_finding_an_older_revision
+    older = ProofOfConcept.create :save_counts => 0
+    newer = ProofOfConcept.find older.id
+    newer.save_counts += 1
+    assert newer.save
+    older_back = ProofOfConcept.find older.id, :rev => older.rev
+    assert older_back
+    assert_equal older_back.rev, older.rev
+  end
+
+  def test_named_custom_strategy
+    first = ProofOfConcept.create :test => 123
+    last  = ProofOfConcept.new :id => first.id, :test => 321
+    assert last.save(:add_conflicted_field_and_keep_this)
+    assert_equal ProofOfConcept.find(first.id).test, 321
+    assert_equal last.test, 321
+    assert_equal ProofOfConcept.find(first.id).conflict, 'conflicted!'
+    viewed = ViewedModel.new :id => first.id, :will => 'raise errors'
+    assert_raise(Divan::DocumentConflict){ viewed.save }
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: divan
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Dalton Pinto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-18 00:00:00 -02:00
+date: 2010-10-25 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,9 +56,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
-- README
+- .gitignore
+- README.rdoc
 - Rakefile.rb
 - VERSION
 - init.rb
@@ -66,6 +67,7 @@ files:
 - lib/divan/base.rb
 - lib/divan/database.rb
 - lib/divan/models/base.rb
+- lib/divan/models/revision.rb
 - lib/divan/utils.rb
 - test/test_helper.rb
 - test/unit/divan.rb

data/README

@@ -1,3 +0,0 @@
-Divan, a Ruby CouchDB client for insane people
-
-TODO: README, documentation and other details