ShyCouch 0.6.0 → 0.7.0

data/lib/ShyCouch/data.rb

@@ -2,254 +2,456 @@ module ShyCouch
 
   module Data
   
-    class CouchDocument < Hash
-      class << self
-        # allows instance.class.requirements to be called
-      end
-      @@needs, @@suggests, @@views = [], [], []
-
-      def initialize(opts={})
-        # Assumes that the "kind" is the class name unless explicitly stated otherwise
-        # TODO - maybe just force it to be the class name no matter what tbh
-        
-        # this is messy.
-        # If there's some data given, see whether it has a kind.
-        if opts[:data]
-          if !opts[:data]["kind"]
-            # If there's no kind, give the 'kind' the class name as a value
-            opts[:data]["kind"] = self.class.to_s.split("::").last
-          end
-        else 
-          # if there's no data, give it data and a kind
-          opts[:data] = {"kind" => self.class.to_s.split("::").last}
-        end
-        
-        merge!(opts[:data])
-        @database = opts[:push_to] if opts[:push_to]
-        raise TypeError unless valid?
-        set_up_views
-      end
-    
-      def self.all
-        
-      end
-      
-      def self.needs(*requirements)
-        requirements.map { |requirement| @@needs << requirement } unless requirements.empty?
-        return @@needs
-      end
-      
-      def self.suggests(*suggestions)
-        suggestions.map { |suggestion| @@suggests << suggestion } unless suggestions.empty?
-        return @@suggests
-      end
-      
-      def needs;self.class.needs; end
-      def suggests; self.class.suggests; end
-      
-      def needs?(requirement)
-        @@needs.include?(requirement) ? true : false
-      end
-      
-      def suggests?(requirement)
-        @@suggests.include?(requirement) ? true : false
-      end
-      
-      def attr_keys
-        # returns the keys for all the attrs that aren't the id or rev
-        attr_keys = []
-        self.map { |k,v|
-          attr_keys << k unless k == "_id" or k == "_rev"
-        }
-        return attr_keys
-      end
-    
-      def _requirements
-        #TODO - hm
-        return self.class.requirements
-      end
-    
-      def pull(db = nil)
-        db ||= @database
-        new_doc = db.pull_document(self)
-        return new_doc
-      end
-      
-      def pull!(db = nil)
-        db ||= @database
-        new_doc = pull(db)
-        if new_doc
-          self.clear
-          self.merge! new_doc
-        end
-      end
-    
-      def push!(database=nil)
-        database ||= @database
-        res = database.push_document!(self)
-        self["_id"] = res["id"] unless self["_id"]
-        self["_rev"] = res["rev"]
-        return res
-      end
-    
-      def valid?; to_json ? true : false; end
-    
-      def to_json
-        JSON::generate(self)
-      rescue JSON::GeneratorError
-        false
-      end
-    
-      def method_missing(m, *a)
-        # Makes the object behave as if the hash keys are instance properties with attr_accessors
-        # Had a dozen lines or so for this and found a one-line implementation of the same thing in Camping.
-        m.to_s =~ /=$/ ? self[$`] = a[0] : a == [] ? self[m.to_s] : super
-      end
-    
-      def respond_to?(method)
-        # so that testing for whether it responds to a method is equivalent to testing for the existence of a key
-        self.key?(method.to_s) ? true : super
-      end
-    
-    end
-    
-    class View
-      attr_accessor :map, :reduce, :name
-      JS_MAP_FUNCTION_HEADER = "function ( doc ) { \n    "
-      JS_REDUCE_FUNCTION_HEADER = "function(key, values, rereduce) { \n    "
-      JS_FUNCTION_FOOTER = "}"
-      
-      def initialize(view_name, &block)
-        #O TODO - oh dear this is a nightmare
-        @parser = ShyRubyJS::ShySexpParser.new
-        sexp_check = block.to_sexp
-        sexp = block.to_sexp(:strip_enclosure=>true)
-
-        # make sure the two blocks inside are calls to "map" and "reduce"
-
-        @name = view_name.to_s        
-        if sexp[0] == :block
-          unless sexp_check[3][1][1][2] == :map and sexp_check[3][2][1][2] == :reduce
-            raise ShyCouchError, "view must be called with map block and optional reduce block" 
-          end
-          [1,2].each { |num|
-            2.times { sexp[num].delete_at(1) }
-          }
-          @map = JS_MAP_FUNCTION_HEADER + @parser.parse(sexp[1])[0] + JS_FUNCTION_FOOTER
-          @reduce = JS_REDUCE_FUNCTION_HEADER + @parser.parse(sexp[2])[0] + JS_FUNCTION_FOOTER
-        elsif sexp[0] == :iter
-          raise ShyCouchError, "view must be called with map block and optional reduce block" unless sexp[1][2] == :map
-          @map = JS_MAP_FUNCTION_HEADER + @parser.parse(sexp[3]) + JS_FUNCTION_FOOTER
-        end
-      end
-      
-      def as_hash
-        h = {}
-        h[@name] = {"map" => @map}
-        h.merge!({"reduce" => @reduce}) if @reduce
-        return h
-      end
-      
-      def functions
-        return {"map" => @map, "reduce" => @reduce}
-      end
-    end
-    
-    class ViewResult < Array
-      attr_accessor :total_rows, :offset
-      def initialize(res)
-        @total_rows = res["total_rows"]
-        @offset = res["offset"]
-        concat res["rows"]
-      end
-    end
-    
-    class CouchDocumentCollection < Array
-      def <<(obj)
-        raise TypeError unless obj.kind_of?(ShyCouch::Data::CouchDocument)
-        super
-      end
-      
-      def initialize(opts = {})
-        @database = opts[:push_to] if opts[:push_to]
+		class CouchDocument < Hash
+			class << self
+				# allows instance.class.requirements to be called
+				def constraints; @@constraints; end
+        def target_db; @@target_db[self]; end
+		  end
+		  
+		  # Constraints are a class variable hash keyed by subclass, with each of those keyed by "needs" and "suggests"
+		  # When there's a validation test, it cycles through each key and applies the constraints if the current class is
+		  # kind_of? the object reference stored in that key. This means you can do model inheritence for common required fields.
+		  # The way they're implemented might not be performant? But models should be defined at runtime so it should be fine.
+		  @@constraints = {}
+     
+      # @@target_db is a class variable storing the default database to push a document to if push! is called without an argument
+      # it's keyed by class name to allow different values for subclasses 
+      @@target_db = {}
+
+		  def initialize(opts={})
+				# Assumes that the "kind" is the class name unless explicitly stated otherwise
+				# TODO - maybe just force it to be the class name no matter what tbh
+				
+				# this is messy.
+				# If there's some data given, see whether it has a kind.
+				if opts[:data]
+				  if !opts[:data]["kind"]
+						# If there's no kind, give the 'kind' the class name as a value
+						opts[:data]["kind"] = self.class.to_s.split("::").last
+				  end
+				else 
+				  # if there's no data, give it data and a kind
+				  opts[:data] = {"kind" => self.class.to_s.split("::").last}
+				end
+				
+				merge!(opts[:data])
+				@database = opts[:push_to] if opts[:push_to]
+				raise TypeError unless valid?
+				# set_up_views
+		  end
+		
+		  def self.all
+        # TODO
+				raise Exception, "not yet implemented"
+		  end
+		  
+		  def self.needs(*needs)
+				# this is both a setter and a getter
+				# initialize suggests hash for current class if not done already
+				# is there a better way to do this initialization?
+				unless @@constraints.has_key?(self)
+				  @@constraints[self] = {}
+				end
+				unless @@constraints[self].has_key?(:needs)
+				  @@constraints[self][:needs] = []
+				end
+				
+				# Add the needs if any were passed in
+				if needs
+				  needs.each do |need|
+						@@constraints[self][:needs] << need
+				  end
+				end
+				# Return the array
+				return @@constraints[self][:needs]
+		  end
+		
+      def self.push_to database
+        raise TypeError, "push_to expects a ShyCouch::CouchDatabase object. Object received was a #{database.class}" unless database.kind_of? ShyCouch::CouchDatabase
+        @@target_db[self] = database
       end
-      
-      def pull_all(db = nil)
-        db ||= @database
-        collection = CouchDocumentCollection.new
-        each do |item|
-          collection << db.pull_document(item)
+
+		  def self.suggests(*suggestions)
+				# this is both a setter and a getter
+				# initialize suggests hash for current class if not done already
+				# is there a better way to do this initialization?
+				@@constraints[self] = {} unless @@constraints.has_key?(self)
+				@@constraints[self][:suggests] = [] unless @@constraints[self].has_key?(:suggests)
+				
+				# Add the suggestions if any were passed in
+				if !suggestions.empty?
+				  suggestions.each do |suggestion|
+						@@constraints[self][:suggests] << suggestion
+				  end
+				end
+				# Return the array
+				return @@constraints[self][:suggests]
+		  end
+		  
+		  def satisfies_needs?
+				# Check everything in constraints that is this class or a superclass of this class
+				self.class.constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey) and constraints[:needs]
+						constraints[:needs].each do |need|
+						  return false unless has_key?(need)
+						end
+				  end
+				end
+				return true
+		  end
+		  
+		  def satisfies_suggestions?(opts = {})
+				# Same as satisfies_needs? but can be passed options for suggestions being ignored.
+				raise ArgumentError if opts.has_key?(:ignore_suggestions) and opts.has_key?(:ignore_suggestion)
+				opts.has_key?(:ignore_suggestions) ? ign = opts[:ignore_suggestions] : 
+				opts.has_key?(:ignore_suggestion) ? ign = [opts[:ignore_suggestion]] : ign = []
+				
+				@@constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey) and constraints[:suggests]
+						constraints[:suggests].each do |suggestion|
+						  return false unless has_key?(suggestion) or ign.include?(suggestion)
+						end
+				  end
+				end
+				return true
+		  end
+
+	  def to_hash
+		h = {}
+		self.each do |k,v|
+			h[k] = v
+		end
+		return h
+	  end
+		  
+		  def missing_needs
+				missing = []
+				@@constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey)
+						constraints[:needs].each do |need|
+						  missing << need unless has_key?(:need)
+						end
+				  end
+				end
+				return missing
+		  end
+		  
+		  def missing_suggestions(opts = {})
+				missing = []
+				raise ArgumentError if opts.has_key?(:ignore_suggestions) and opts.has_key?(:ignore_suggestion)
+				opts.has_key?(:ignore_suggestions) ? ign = opts[:ignore_suggestions] : 
+				opts.has_key?(:ignore_suggestion) ? ign = [opts[:ignore_suggestion]] : ign = []
+				
+				@@constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey)
+						constraints[:suggests].each do |suggestion|
+						  missing << suggestion unless has_key?(:suggests) or ign.include?(suggestion)
+						end
+				  end
+				end
+				return missing
+		  end
+		  
+		  def needs?(need)
+				@@constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey)
+						return true if constraints[:needs].include?(need)
+				  end
+				end
+				return false
+		  end
+		  
+		  def suggests?(suggestion)
+				@@constraints.each do |classKey, constraints|
+				  if self.kind_of?(classKey)
+						return true if constraints[:suggests].include?(suggestion)
+				  end
+				end
+				return false
+		  end
+		  
+		  def suggests; self.class.suggests; end
+		  def needs; self.class.needs; end
+		  
+		  def attr_keys
+				# TODO - is this needed?
+				# returns the keys for all the attrs that aren't the id or rev
+				attr_keys = []
+				self.map { |k,v|
+				  attr_keys << k unless k == "_id" or k == "_rev"
+				}
+				return attr_keys
+		  end
+
+		  def pull(opts = {})
+        raise ShyCouch::DocumentValidationError, "Document has no ID - cannot pull from database" unless has_key? "_id"
+        if opts[:pull_from]
+          db = opts[:pull_from]
+        elsif @database
+          db = @database
+        elsif @@target_db.has_key? self.class
+          db = @@target_db[self.class]
+        else
+          raise ShyCouch::ShyCouchError, "No database defined for document pull operation"
         end
-        return collection
-      end
-      
-      def pull_all!(db = nil)
-        db ||= @database
-        each do |item|
-          item.pull!(db)
+
+				new_doc = db.pull_document(self)
+				return new_doc
+
+		  end
+		  
+		  def pull!(opts = {})
+        # TODO - just call pull and merge in the result
+        raise ShyCouch::DocumentValidationError, "Document has no ID - cannot pull from database" unless has_key? "_id"
+        if opts[:pull_from]
+          db = opts[:pull_from]
+        elsif @database
+          db = @database
+        elsif @@target_db.has_key? self.class
+          db = @@target_db[self.class]
+        else
+          raise ShyCouch::ShyCouchError, "No database defined for document pull operation"
         end
-      end
-      
-      def push_all!(db = nil)
-        db ||= @database
-        each do |item|
-          item.push!(db)
+				new_doc = pull(:pull_from => db)
+				if new_doc
+				  self.clear
+				  self.merge! new_doc
+				end
+		  end
+		
+		  def push!(opts = {})
+        if opts[:push_to]
+          db = opts[:push_to]
+        elsif @database
+          db = @database
+        elsif @@target_db.has_key? self.class
+          db = @@target_db[self.class]
+        else
+          raise ShyCouch::ShyCouchError, "No database defined for document push operation"
         end
-      end
+				res = db.push_document!(self, opts)
+				self["_id"] = res["id"] unless self["_id"]
+				self["_rev"] = res["rev"]
+				return res
+		  end
 
-    end
-
-    class Design < CouchDocument
-      # this is used to manage design documents
-      # In practise, the Controllers should be a list of classes corresponding to design documents
-      
-      def initialize(name, opts = {})
-        merge! "_id" => "_design/#{name.to_s}"
-        @parser = ShyRubyJS::ShySexpParser.new
-        views = opts[:views] if opts[:views]
-        merge_views(views) if views
-        @database = opts[:push_to] if opts[:push_to]
-      end
-      
-      def name
-        return self["_id"].split("_design/").drop(1).join
-      end
-      
-      def add_view(view)
-        raise TypeError unless view.kind_of?(ShyCouch::Data::View)
-        @views << view
-        merge_views
-      end
-      
-      def query_view(view, db = nil)
-        db ||= @database
-        raise ShyCouchError, "No CouchDB defined" unless db
-        view = view.name if view.kind_of?(ShyCouch::Data::View)
-        #TODO - something
-        db.query_view(self.name, view)
-      end
-      
-      def view(view_name, &block)
-        add_view(ShyCouch::Data::View.new(view_name, &block))
-      end
-      def push!(db = nil)
-        db ||= @database
-        raise ShyCouchError, "No CouchDB defined" unless db
-        db.add_design_and_push!(self)
-      end
-      
-      private
-      
-      def merge_views(views)
-        h = { "views" => {}}
-        views.each do |view|
-          h["views"][view.name] = view.functions
-        end
-        merge! h
-      end
-      
-    end
+			def delete!(opts = {})
+				opts[:from] ? db = opts[:from] : db = @database
+				raise ShyCouchError, "No database specified for delete" unless db
+				res = db.delete_document!(self, opts)
+				self["_id"] = res["id"] unless self["_id"]
+				self["_rev"] = res["rev"]
+				return res
+			end
+		
+		  def valid?; to_json ? true : false; end
+		
+		  def to_json
+				JSON::generate(self)
+		  rescue JSON::GeneratorError
+				false
+		  end
+		
+		  def method_missing(m, *a)
+				# Makes the object behave as if the hash keys are instance properties with attr_accessors
+				# m.to_s =~ /=$/ ? self[$`] = a[0] : a == [] ? self[m.to_s] : super
+				m.to_s=~/=$/?self[$`]=a[0]:a==[]?self[m.to_s]:super
+				if m.to_s =~ /=$/
+				  self[$`] = a[0]
+				else
+				  if a == []
+						if self[m.to_s]
+						  self[m.to_s]
+						else
+						  super
+						end
+				  else
+						super
+				  end
+				end
+		  end
+		
+		  def respond_to?(method)
+				# so that testing for whether it responds to a method is equivalent to testing for the existence of a key
+				self.key?(method.to_s) ? true : super
+		  end
+		
+		end
+		
+		class View
+		  attr_accessor :map, :reduce, :name
+		  JS_MAP_FUNCTION_HEADER = "function ( doc ) { \n		"
+		  JS_REDUCE_FUNCTION_HEADER = "function(key, values, rereduce) { \n		"
+		  JS_FUNCTION_FOOTER = "}"
+		  
+		  def initialize(view_name, &block)
+				#O TODO - oh dear this is a nightmare
+				@parser = ShyRubyJS::ShySexpParser.new
+				sexp_check = block.to_sexp
+				sexp = block.to_sexp(:strip_enclosure=>true)
+
+				# make sure the two blocks inside are calls to "map" and "reduce"
+
+				@name = view_name.to_s				
+				if sexp[0] == :block
+				  unless sexp_check[3][1][1][2] == :map and sexp_check[3][2][1][2] == :reduce
+						raise ShyCouchError, "view must be called with map block and optional reduce block" 
+				  end
+				  [1,2].each { |num|
+						2.times { sexp[num].delete_at(1) }
+				  }
+				  @map = JS_MAP_FUNCTION_HEADER + @parser.parse(sexp[1])[0] + JS_FUNCTION_FOOTER
+				  @reduce = JS_REDUCE_FUNCTION_HEADER + @parser.parse(sexp[2])[0] + JS_FUNCTION_FOOTER
+				elsif sexp[0] == :iter
+				  raise ShyCouchError, "view must be called with map block and optional reduce block" unless sexp[1][2] == :map
+				  @map = JS_MAP_FUNCTION_HEADER + @parser.parse(sexp[3]) + JS_FUNCTION_FOOTER
+				end
+		  end
+		  
+		  def functions
+				return {"map" => @map, "reduce" => @reduce}
+		  end
+		end	
+
+		class ViewResultHandler
+			def self.init res
+				if self.includes_docs res["rows"]
+          collection = ShyCouch::Data::CouchDocumentCollection.new
+					res["rows"].each do |row|
+             collection << ShyCouch::Data::CouchDocument.new(:data => row["doc"])
+					  end
+				  return collection
+				else
+					return ViewResult.new res
+				end
+			end
+			def self.includes_docs rows
+				return rows[0].has_key? "doc" if rows.length > 0
+			end
+		end
+
+		class ViewResult < Hash
+			# This is the result of a view query
+			# If the view was called with ?include_docs=true, initializing this object returns a DocumentCollection instead
+
+		  attr_accessor :total_rows, :offset
+		  def initialize res
+				@total_rows = res["total_rows"]
+				@offset = res["offset"]
+				
+				res["rows"].each do |row|
+					merge! row["key"] => ViewResultRow.new(row["value"], row["key"])
+				end
+		  end
+			class ViewResultRow
+				attr_reader :id
+				def initialize value, id
+					@_id = id
+					@value = value
+				end
+				def to_s
+					return @value
+				end
+				def inspect
+					return @value
+				end
+			end
+		end
+		
+
+		class CouchDocumentCollection < Array
+		  def << obj
+				raise TypeError unless obj.kind_of?(ShyCouch::Data::CouchDocument)
+				super
+		  end
+		  
+		  def initialize(opts = {})
+				@database = opts[:push_to] if opts[:push_to]
+		  end
+		  
+		  def pull_all(opts = {})
+				opts[:push_to] ? db = opts[:push_to] : db = @database
+				collection = CouchDocumentCollection.new
+				each do |item|
+				  collection << db.pull_document(item)
+				end
+				return collection
+		  end
+		  
+		  def pull_all!(opts = {})
+				opts[:push_to] ? db = opts[:push_to] : db = @database
+				each do |item|
+				  item.pull!(:pull_from => db)
+				end
+		  end
+
+		  def push_all!(opts = {})
+				opts[:push_to] ? db = opts[:push_to] : db = @database
+				each do |item|
+				  item.push!(:push_to => db)
+				end
+		  end
+
+		end
+
+		class Design < CouchDocument
+		  # this is used to manage design documents
+		  # In practise, the Controllers should be a list of classes corresponding to design documents
+		  
+		  def initialize(name, opts = {})
+				merge! "_id" => "_design/#{name.to_s}"
+				@parser = ShyRubyJS::ShySexpParser.new
+				views = opts[:views] if opts[:views]
+				merge_views(views) if views
+				@database = opts[:push_to] if opts[:push_to]
+				merge! "kind" => self.class.to_s.split("::").last
+			end
+
+		  def name
+				return self["_id"].split("_design/").drop(1).join
+		  end
+
+		  def add_view(view)
+				raise TypeError unless view.kind_of?(ShyCouch::Data::View)
+				@views << view
+				merge_views
+		  end
+
+		  def query_view(view, opts = {})
+				if opts[:from]
+					db = opts[:from]
+				else
+					db = @database
+				end
+				raise ShyCouchError, "No CouchDB defined" unless db
+				view = view.name if view.kind_of?(ShyCouch::Data::View)
+				#TODO - something
+				db.query_view(self.name, view, opts)
+		  end
+
+		  def view(view_name, &block)
+				add_view(ShyCouch::Data::View.new(view_name, &block))
+		  end
+
+		  def push!(opts = {})
+				opts[:push_to] ? db = opts[:push_to] : db = @database
+				raise ShyCouchError, "No CouchDB defined" unless db
+				db.add_design_and_push!(self)
+		  end
+
+		  private
+
+		  def merge_views(views)
+				h = { "views" => {}}
+				views.each do |view|
+				  h["views"][view.name] = view.functions
+				end
+				merge! h
+		  end
+
+		end
 
   end
 
-end
+end