couch_potato 0.2.32 → 0.3.0

data/CHANGES.md

@@ -1,5 +1,8 @@
 ## Changes
 
+### 0.3.0
+* support for lists (langalex)
+
 ### 0.2.32
 * added persisted? and to_key for proper ActiveModel compliance (thilo)
 * id setter (jhohertz-work)

data/README.md

@@ -175,9 +175,9 @@ Couch Potato uses the validatable library for validation (http://validatable.rub
     user.valid? # => false
     user.errors.on(:name) # => [:name, 'can't be blank']
 
-#### Finding stuff
+#### Finding stuff / views / lists
 
-In order to find data in your CouchDB you have to create a view first. Couch Potato offers you to create and manage those views for you. All you have to do is declare them in your classes:
+In order to find data in your CouchDB you have to create a [view](http://books.couchdb.org/relax/design-documents/views) first. Couch Potato offers you to create and manage those views for you. All you have to do is declare them in your classes:
 
     class User
       include CouchPotato::Persistence
@@ -250,6 +250,39 @@ In this case querying the view would only return the emitted value for each row.
 
 You can pass in your own view specifications by passing in :type => MyViewSpecClass. Take a look at the CouchPotato::View::*ViewSpec classes to get an idea of how this works.
 
+##### Lists
+
+CouchPotato also supports [CouchDB lists](http://books.couchdb.org/relax/design-documents/lists). With lists you can process the result of a view query with another JavaScript function. This can be useful for example if you want to filter your results, or add some data to each document.
+
+Defining a list works similarly to views:
+
+    class User
+      include CouchPotato::Persistence
+      
+      property :first_name
+      view :with_full_name, key: first_namne, list: :add_last_name
+      view :all, key: :first_name
+      
+      list :add_last_name, <<-JS
+        function(head, req) {
+          var row;
+          send('{"rows": [');
+          while(row = getRow()) {
+            row.doc.name = row.doc.first_name + ' doe';
+            send(JSON.stringify(row));
+          };
+          send(']}');
+        }
+      JS
+    end
+    
+    CouchPotato.database.save User.new(first_name: 'joe')
+    CouchPotato.database.view(User.with_full_name).first.name # => 'joe doe'
+    
+You can also pass in the list at query time:
+
+    CouchPotato.database.view(User.all(list: :add_last_name))
+
 #### Associations
 
 Not supported. Not sure if they ever will be. You can implement those yourself using views and custom methods on your models.

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 2
-:patch: 32
+:minor: 3
+:patch: 0
 :build: 

data/lib/couch_potato/database.rb

@@ -44,9 +44,15 @@ module CouchPotato
     #
     #   db.view(User.all(keys: [1, 2, 3]))
     def view(spec)
-      results = CouchPotato::View::ViewQuery.new(database,
-        spec.design_document, spec.view_name, spec.map_function,
-        spec.reduce_function).query_view!(spec.view_parameters)
+      results = CouchPotato::View::ViewQuery.new(
+        database,
+        spec.design_document,
+        {spec.view_name => {
+          :map => spec.map_function,
+          :reduce => spec.reduce_function}
+        },
+        ({spec.list_name => spec.list_function} unless spec.list_name.nil?)
+      ).query_view!(spec.view_parameters)
       processed_results = spec.process_results results
       processed_results.instance_eval "def total_rows; #{results['total_rows']}; end" if results['total_rows']
       processed_results.each do |document|

data/lib/couch_potato/persistence/callbacks.rb

@@ -27,12 +27,12 @@ module CouchPotato
         end.flatten.compact.uniq
         
         callbacks.each do |callback|
-          if callback.is_a?(Symbol)
+          if [Symbol, String].include?(callback.class)
             send callback
           elsif callback.is_a?(Proc)
             callback.call self
           else
-            raise "Don't know how to handle callback of type #{name.class.name}"
+            raise "Don't know how to handle callback of type #{callback.class.name}"
           end
         end
       end

data/lib/couch_potato/persistence.rb

@@ -10,6 +10,7 @@ require File.dirname(__FILE__) + '/persistence/ghost_attributes'
 require File.dirname(__FILE__) + '/persistence/attachments'
 require File.dirname(__FILE__) + '/persistence/type_caster'
 require File.dirname(__FILE__) + '/view/custom_views'
+require File.dirname(__FILE__) + '/view/lists'
 require File.dirname(__FILE__) + '/view/view_query'
 
 
@@ -17,7 +18,7 @@ module CouchPotato
   module Persistence
     
     def self.included(base) #:nodoc:
-      base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews
+      base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews, CouchPotato::View::Lists
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
       base.send :include, MagicTimestamps, ActiveModelCompliance
       base.class_eval do

data/lib/couch_potato/rspec/matchers/json2.js

@@ -0,0 +1,482 @@
+/*
+    http://www.JSON.org/json2.js
+    2010-03-20
+
+    Public Domain.
+
+    NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
+
+    See http://www.JSON.org/js.html
+
+
+    This code should be minified before deployment.
+    See http://javascript.crockford.com/jsmin.html
+
+    USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
+    NOT CONTROL.
+
+
+    This file creates a global JSON object containing two methods: stringify
+    and parse.
+
+        JSON.stringify(value, replacer, space)
+            value       any JavaScript value, usually an object or array.
+
+            replacer    an optional parameter that determines how object
+                        values are stringified for objects. It can be a
+                        function or an array of strings.
+
+            space       an optional parameter that specifies the indentation
+                        of nested structures. If it is omitted, the text will
+                        be packed without extra whitespace. If it is a number,
+                        it will specify the number of spaces to indent at each
+                        level. If it is a string (such as '\t' or ' '),
+                        it contains the characters used to indent at each level.
+
+            This method produces a JSON text from a JavaScript value.
+
+            When an object value is found, if the object contains a toJSON
+            method, its toJSON method will be called and the result will be
+            stringified. A toJSON method does not serialize: it returns the
+            value represented by the name/value pair that should be serialized,
+            or undefined if nothing should be serialized. The toJSON method
+            will be passed the key associated with the value, and this will be
+            bound to the value
+
+            For example, this would serialize Dates as ISO strings.
+
+                Date.prototype.toJSON = function (key) {
+                    function f(n) {
+                        // Format integers to have at least two digits.
+                        return n < 10 ? '0' + n : n;
+                    }
+
+                    return this.getUTCFullYear()   + '-' +
+                         f(this.getUTCMonth() + 1) + '-' +
+                         f(this.getUTCDate())      + 'T' +
+                         f(this.getUTCHours())     + ':' +
+                         f(this.getUTCMinutes())   + ':' +
+                         f(this.getUTCSeconds())   + 'Z';
+                };
+
+            You can provide an optional replacer method. It will be passed the
+            key and value of each member, with this bound to the containing
+            object. The value that is returned from your method will be
+            serialized. If your method returns undefined, then the member will
+            be excluded from the serialization.
+
+            If the replacer parameter is an array of strings, then it will be
+            used to select the members to be serialized. It filters the results
+            such that only members with keys listed in the replacer array are
+            stringified.
+
+            Values that do not have JSON representations, such as undefined or
+            functions, will not be serialized. Such values in objects will be
+            dropped; in arrays they will be replaced with null. You can use
+            a replacer function to replace those with JSON values.
+            JSON.stringify(undefined) returns undefined.
+
+            The optional space parameter produces a stringification of the
+            value that is filled with line breaks and indentation to make it
+            easier to read.
+
+            If the space parameter is a non-empty string, then that string will
+            be used for indentation. If the space parameter is a number, then
+            the indentation will be that many spaces.
+
+            Example:
+
+            text = JSON.stringify(['e', {pluribus: 'unum'}]);
+            // text is '["e",{"pluribus":"unum"}]'
+
+
+            text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t');
+            // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'
+
+            text = JSON.stringify([new Date()], function (key, value) {
+                return this[key] instanceof Date ?
+                    'Date(' + this[key] + ')' : value;
+            });
+            // text is '["Date(---current time---)"]'
+
+
+        JSON.parse(text, reviver)
+            This method parses a JSON text to produce an object or array.
+            It can throw a SyntaxError exception.
+
+            The optional reviver parameter is a function that can filter and
+            transform the results. It receives each of the keys and values,
+            and its return value is used instead of the original value.
+            If it returns what it received, then the structure is not modified.
+            If it returns undefined then the member is deleted.
+
+            Example:
+
+            // Parse the text. Values that look like ISO date strings will
+            // be converted to Date objects.
+
+            myData = JSON.parse(text, function (key, value) {
+                var a;
+                if (typeof value === 'string') {
+                    a =
+/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
+                    if (a) {
+                        return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4],
+                            +a[5], +a[6]));
+                    }
+                }
+                return value;
+            });
+
+            myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) {
+                var d;
+                if (typeof value === 'string' &&
+                        value.slice(0, 5) === 'Date(' &&
+                        value.slice(-1) === ')') {
+                    d = new Date(value.slice(5, -1));
+                    if (d) {
+                        return d;
+                    }
+                }
+                return value;
+            });
+
+
+    This is a reference implementation. You are free to copy, modify, or
+    redistribute.
+*/
+
+/*jslint evil: true, strict: false */
+
+/*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply,
+    call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
+    getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
+    lastIndex, length, parse, prototype, push, replace, slice, stringify,
+    test, toJSON, toString, valueOf
+*/
+
+
+// Create a JSON object only if one does not already exist. We create the
+// methods in a closure to avoid creating global variables.
+
+if (!this.JSON) {
+    this.JSON = {};
+}
+
+(function () {
+
+    function f(n) {
+        // Format integers to have at least two digits.
+        return n < 10 ? '0' + n : n;
+    }
+
+    if (typeof Date.prototype.toJSON !== 'function') {
+
+        Date.prototype.toJSON = function (key) {
+
+            return isFinite(this.valueOf()) ?
+                   this.getUTCFullYear()   + '-' +
+                 f(this.getUTCMonth() + 1) + '-' +
+                 f(this.getUTCDate())      + 'T' +
+                 f(this.getUTCHours())     + ':' +
+                 f(this.getUTCMinutes())   + ':' +
+                 f(this.getUTCSeconds())   + 'Z' : null;
+        };
+
+        String.prototype.toJSON =
+        Number.prototype.toJSON =
+        Boolean.prototype.toJSON = function (key) {
+            return this.valueOf();
+        };
+    }
+
+    var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
+        escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
+        gap,
+        indent,
+        meta = {    // table of character substitutions
+            '\b': '\\b',
+            '\t': '\\t',
+            '\n': '\\n',
+            '\f': '\\f',
+            '\r': '\\r',
+            '"' : '\\"',
+            '\\': '\\\\'
+        },
+        rep;
+
+
+    function quote(string) {
+
+// If the string contains no control characters, no quote characters, and no
+// backslash characters, then we can safely slap some quotes around it.
+// Otherwise we must also replace the offending characters with safe escape
+// sequences.
+
+        escapable.lastIndex = 0;
+        return escapable.test(string) ?
+            '"' + string.replace(escapable, function (a) {
+                var c = meta[a];
+                return typeof c === 'string' ? c :
+                    '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
+            }) + '"' :
+            '"' + string + '"';
+    }
+
+
+    function str(key, holder) {
+
+// Produce a string from holder[key].
+
+        var i,          // The loop counter.
+            k,          // The member key.
+            v,          // The member value.
+            length,
+            mind = gap,
+            partial,
+            value = holder[key];
+
+// If the value has a toJSON method, call it to obtain a replacement value.
+
+        if (value && typeof value === 'object' &&
+                typeof value.toJSON === 'function') {
+            value = value.toJSON(key);
+        }
+
+// If we were called with a replacer function, then call the replacer to
+// obtain a replacement value.
+
+        if (typeof rep === 'function') {
+            value = rep.call(holder, key, value);
+        }
+
+// What happens next depends on the value's type.
+
+        switch (typeof value) {
+        case 'string':
+            return quote(value);
+
+        case 'number':
+
+// JSON numbers must be finite. Encode non-finite numbers as null.
+
+            return isFinite(value) ? String(value) : 'null';
+
+        case 'boolean':
+        case 'null':
+
+// If the value is a boolean or null, convert it to a string. Note:
+// typeof null does not produce 'null'. The case is included here in
+// the remote chance that this gets fixed someday.
+
+            return String(value);
+
+// If the type is 'object', we might be dealing with an object or an array or
+// null.
+
+        case 'object':
+
+// Due to a specification blunder in ECMAScript, typeof null is 'object',
+// so watch out for that case.
+
+            if (!value) {
+                return 'null';
+            }
+
+// Make an array to hold the partial results of stringifying this object value.
+
+            gap += indent;
+            partial = [];
+
+// Is the value an array?
+
+            if (Object.prototype.toString.apply(value) === '[object Array]') {
+
+// The value is an array. Stringify every element. Use null as a placeholder
+// for non-JSON values.
+
+                length = value.length;
+                for (i = 0; i < length; i += 1) {
+                    partial[i] = str(i, value) || 'null';
+                }
+
+// Join all of the elements together, separated with commas, and wrap them in
+// brackets.
+
+                v = partial.length === 0 ? '[]' :
+                    gap ? '[\n' + gap +
+                            partial.join(',\n' + gap) + '\n' +
+                                mind + ']' :
+                          '[' + partial.join(',') + ']';
+                gap = mind;
+                return v;
+            }
+
+// If the replacer is an array, use it to select the members to be stringified.
+
+            if (rep && typeof rep === 'object') {
+                length = rep.length;
+                for (i = 0; i < length; i += 1) {
+                    k = rep[i];
+                    if (typeof k === 'string') {
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ': ' : ':') + v);
+                        }
+                    }
+                }
+            } else {
+
+// Otherwise, iterate through all of the keys in the object.
+
+                for (k in value) {
+                    if (Object.hasOwnProperty.call(value, k)) {
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ': ' : ':') + v);
+                        }
+                    }
+                }
+            }
+
+// Join all of the member texts together, separated with commas,
+// and wrap them in braces.
+
+            v = partial.length === 0 ? '{}' :
+                gap ? '{\n' + gap + partial.join(',\n' + gap) + '\n' +
+                        mind + '}' : '{' + partial.join(',') + '}';
+            gap = mind;
+            return v;
+        }
+    }
+
+// If the JSON object does not yet have a stringify method, give it one.
+
+    if (typeof JSON.stringify !== 'function') {
+        JSON.stringify = function (value, replacer, space) {
+
+// The stringify method takes a value and an optional replacer, and an optional
+// space parameter, and returns a JSON text. The replacer can be a function
+// that can replace values, or an array of strings that will select the keys.
+// A default replacer method can be provided. Use of the space parameter can
+// produce text that is more easily readable.
+
+            var i;
+            gap = '';
+            indent = '';
+
+// If the space parameter is a number, make an indent string containing that
+// many spaces.
+
+            if (typeof space === 'number') {
+                for (i = 0; i < space; i += 1) {
+                    indent += ' ';
+                }
+
+// If the space parameter is a string, it will be used as the indent string.
+
+            } else if (typeof space === 'string') {
+                indent = space;
+            }
+
+// If there is a replacer, it must be a function or an array.
+// Otherwise, throw an error.
+
+            rep = replacer;
+            if (replacer && typeof replacer !== 'function' &&
+                    (typeof replacer !== 'object' ||
+                     typeof replacer.length !== 'number')) {
+                throw new Error('JSON.stringify');
+            }
+
+// Make a fake root object containing our value under the key of ''.
+// Return the result of stringifying the value.
+
+            return str('', {'': value});
+        };
+    }
+
+
+// If the JSON object does not yet have a parse method, give it one.
+
+    if (typeof JSON.parse !== 'function') {
+        JSON.parse = function (text, reviver) {
+
+// The parse method takes a text and an optional reviver function, and returns
+// a JavaScript value if the text is a valid JSON text.
+
+            var j;
+
+            function walk(holder, key) {
+
+// The walk method is used to recursively walk the resulting structure so
+// that modifications can be made.
+
+                var k, v, value = holder[key];
+                if (value && typeof value === 'object') {
+                    for (k in value) {
+                        if (Object.hasOwnProperty.call(value, k)) {
+                            v = walk(value, k);
+                            if (v !== undefined) {
+                                value[k] = v;
+                            } else {
+                                delete value[k];
+                            }
+                        }
+                    }
+                }
+                return reviver.call(holder, key, value);
+            }
+
+
+// Parsing happens in four stages. In the first stage, we replace certain
+// Unicode characters with escape sequences. JavaScript handles many characters
+// incorrectly, either silently deleting them, or treating them as line endings.
+
+            text = String(text);
+            cx.lastIndex = 0;
+            if (cx.test(text)) {
+                text = text.replace(cx, function (a) {
+                    return '\\u' +
+                        ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
+                });
+            }
+
+// In the second stage, we run the text against regular expressions that look
+// for non-JSON patterns. We are especially concerned with '()' and 'new'
+// because they can cause invocation, and '=' because it can cause mutation.
+// But just to be safe, we want to reject all unexpected forms.
+
+// We split the second stage into 4 regexp operations in order to work around
+// crippling inefficiencies in IE's and Safari's regexp engines. First we
+// replace the JSON backslash pairs with '@' (a non-JSON character). Second, we
+// replace all simple value tokens with ']' characters. Third, we delete all
+// open brackets that follow a colon or comma or that begin the text. Finally,
+// we look to see that the remaining characters are only whitespace or ']' or
+// ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval.
+
+            if (/^[\],:{}\s]*$/.
+test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@').
+replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']').
+replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
+
+// In the third stage we use the eval function to compile the text into a
+// JavaScript structure. The '{' operator is subject to a syntactic ambiguity
+// in JavaScript: it can begin a block or an object literal. We wrap the text
+// in parens to eliminate the ambiguity.
+
+                j = eval('(' + text + ')');
+
+// In the optional fourth stage, we recursively walk the new structure, passing
+// each name/value pair to a reviver function for possible transformation.
+
+                return typeof reviver === 'function' ?
+                    walk({'': j}, '') : j;
+            }
+
+// If the text is not JSON parseable, then a SyntaxError is thrown.
+
+            throw new SyntaxError('JSON.parse');
+        };
+    }
+}());

data/lib/couch_potato/rspec/matchers/list_as_matcher.rb

@@ -0,0 +1,54 @@
+module CouchPotato
+  module RSpec
+    class ListAsProxy
+      def initialize(results_ruby)
+        @results_ruby = results_ruby
+      end
+      
+      def as(expected_ruby)
+        ListAsMatcher.new(expected_ruby, @results_ruby)
+      end
+    end
+    
+    class ListAsMatcher
+      include RunJS
+      
+      def initialize(expected_ruby, results_ruby)
+        @expected_ruby = expected_ruby
+        @results_ruby = results_ruby
+      end
+      
+      def matches?(view_spec)
+        js = <<-JS
+          #{File.read(File.dirname(__FILE__) + '/print_r.js')}
+          #{File.read(File.dirname(__FILE__) + '/json2.js')}
+          var results = #{@results_ruby.to_json};
+          var listed = '';
+          var list = #{view_spec.list_function};
+          
+          var getRow = function() {
+            return results.rows.shift();
+          };
+          var send = function(text) {
+            listed = listed + text;
+          };
+          list();
+          print(print_r(JSON.parse(listed)));
+        JS
+        
+        @actual_ruby = JSON.parse(run_js(js))
+        
+        @expected_ruby == @actual_ruby
+      end
+      
+      def failure_message_for_should
+        "Expected to list as #{@expected_ruby.inspect} but got #{@actual_ruby.inspect}."
+      end
+      
+      def failure_message_for_should_not
+        "Expected to not list as #{@expected_ruby.inspect} but did."
+      end
+      
+    end
+  end
+end

data/lib/couch_potato/rspec/matchers.rb

@@ -15,6 +15,7 @@ end
 
 require 'couch_potato/rspec/matchers/map_to_matcher'
 require 'couch_potato/rspec/matchers/reduce_to_matcher'
+require 'couch_potato/rspec/matchers/list_as_matcher'
 
 module Spec
   module Matchers
@@ -29,6 +30,10 @@ module Spec
     def rereduce(docs, keys)
       CouchPotato::RSpec::ReduceToProxy.new(docs, keys, true)
     end
+    
+    def list(results)
+      CouchPotato::RSpec::ListAsProxy.new(results)
+    end
   end
 end
 

data/lib/couch_potato/view/base_view_spec.rb

@@ -1,16 +1,21 @@
 module CouchPotato
   module View
     class BaseViewSpec
-      attr_reader :reduce_function, :design_document, :view_name, :view_parameters, :klass, :options
+      attr_reader :reduce_function, :list_name, :list_function, :design_document, :view_name, :view_parameters, :klass, :options
       private :klass, :options
 
       def initialize(klass, view_name, options, view_parameters)
         normalized_view_parameters = normalize_view_parameters view_parameters
+        
+        @list_name = normalized_view_parameters.delete(:list) || options[:list]
+        
         assert_valid_view_parameters normalized_view_parameters
         @klass = klass
         @design_document = translate_to_design_doc_name(klass.to_s)
         @view_name = view_name
         @options = options
+        
+        @list_function = klass.lists(@list_name) if @list_name
         @view_parameters = {}
         [:group, :include_docs, :descending, :group_level, :limit].each do |key|
           @view_parameters[key] = options[key] if options.include?(key)

data/lib/couch_potato/view/custom_views.rb

@@ -44,8 +44,7 @@ module CouchPotato
         end
         
         def _find_view(view) #:nodoc:
-          return @views[view] if @views && @views[view]
-          superclass._find_view(view) if superclass && superclass.respond_to?(:_find_view)
+          (@views && @views[view]) || (superclass._find_view(view) if superclass.respond_to?(:_find_view))
         end
       end
     end

data/lib/couch_potato/view/lists.rb

@@ -0,0 +1,23 @@
+module CouchPotato
+  module View
+    module Lists
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+      
+      module ClassMethods
+        def list(name, function)
+          lists[name] = function
+        end
+        
+        def lists(name = nil)
+          if name.nil?
+            @lists ||= {}
+          else
+            (@lists && @lists[name]) || (superclass.lists(name) if superclass.respond_to?(:lists))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/view/view_query.rb

@@ -2,12 +2,16 @@ module CouchPotato
   module View
     # Used to query views (and create them if they don't exist). Usually you won't have to use this class directly. Instead it is used internally by the CouchPotato::Database.view method.
     class ViewQuery
-      def initialize(couchrest_database, design_document_name, view_name, map_function, reduce_function = nil)
+      def initialize(couchrest_database, design_document_name, view, list = nil)
         @database = couchrest_database
         @design_document_name = design_document_name
-        @view_name = view_name
-        @map_function = map_function
-        @reduce_function = reduce_function
+        @view_name = view.keys[0]
+        @map_function = view.values[0][:map]
+        @reduce_function = view.values[0][:reduce]
+        if list
+          @list_function = list.values[0]
+          @list_name = list.keys[0]
+        end
       end
 
       def query_view!(parameters = {})
@@ -25,10 +29,15 @@ module CouchPotato
       def update_view
         design_doc = @database.get "_design/#{@design_document_name}" rescue nil
         original_views = design_doc && design_doc['views'].dup
+        original_lists = design_doc && design_doc['lists'] && design_doc['lists'].dup
         view_updated unless design_doc.nil?
         design_doc ||= empty_design_document
         design_doc['views'][@view_name.to_s] = view_functions
-        @database.save_doc(design_doc) unless original_views == design_doc['views']
+        if @list_function
+          design_doc['lists'] ||= {}
+          design_doc['lists'][@list_name.to_s] = @list_function 
+        end
+        @database.save_doc(design_doc) if original_views != design_doc['views'] || original_lists != design_doc['lists']
       end
       
       def view_functions
@@ -36,7 +45,7 @@ module CouchPotato
       end
       
       def empty_design_document
-        {'views' => {}, "_id" => "_design/#{@design_document_name}", "language" => "javascript"}
+        {'views' => {}, 'lists' => {}, "_id" => "_design/#{@design_document_name}", "language" => "javascript"}
       end
       
       def view_has_been_updated?
@@ -53,7 +62,11 @@ module CouchPotato
       end
 
       def query_view(parameters)
-        @database.view view_url, parameters
+        if @list_name
+          CouchRest.get CouchRest.paramify_url(CouchPotato.full_url_to_database + "/_design/#{@design_document_name}/_list/#{@list_name}/#{@view_name}", parameters)
+        else
+          @database.view view_url, parameters
+        end
       end
 
       def view_url

data/spec/custom_view_spec.rb

@@ -160,7 +160,11 @@ describe 'view' do
 
   describe "with array as key" do
     it "should create a map function with the composite key" do
-      CouchPotato::View::ViewQuery.should_receive(:new).with(anything, anything, anything, string_matching(/emit\(\[doc\['time'\], doc\['state'\]\]/), anything).and_return(stub('view query', :query_view! => {'rows' => []}))
+      CouchPotato::View::ViewQuery.should_receive(:new) do |db, design_name, view, list|
+        view['key_array_timeline'][:map].should match(/emit\(\[doc\['time'\], doc\['state'\]\]/)
+        
+        stub('view query', :query_view! => {'rows' => []})
+      end
       @db.view Build.key_array_timeline
     end
   end
@@ -191,4 +195,38 @@ describe 'view' do
       @db.view(CustomBuild.timeline).first.should be_kind_of(CustomBuild)
     end
   end
+  
+  describe "list functions" do
+    class Coworker
+      include CouchPotato::Persistence
+      
+      property :name
+      
+      view :all_with_list, :key => :name, :list => :append_doe
+      view :all, :key => :name
+      
+      list :append_doe, <<-JS
+        function(head, req) {
+          var row;
+          send('{"rows": [');
+          while(row = getRow()) {
+            row.doc.name = row.doc.name + ' doe';
+            send(JSON.stringify(row));
+          };
+          send(']}');
+        }
+      JS
+    end
+    
+    it "should use the list function declared at class level" do
+      @db.save! Coworker.new(:name => 'joe')
+      @db.view(Coworker.all_with_list).first.name.should == 'joe doe'
+    end
+    
+    it "should use the list function passed at runtime" do
+      @db.save! Coworker.new(:name => 'joe')
+      @db.view(Coworker.all(:list => :append_doe)).first.name.should == 'joe doe'
+    end
+    
+  end
 end

data/spec/unit/base_view_spec_spec.rb

@@ -39,10 +39,32 @@ describe CouchPotato::View::BaseViewSpec, 'initialize' do
       spec.view_parameters.should == {:key => '2'}
     end
 
-    it "generates the design document path by snake_casing the class name but keeping double colons" do
+    it "should generate the design document path by snake_casing the class name but keeping double colons" do
       spec = CouchPotato::View::BaseViewSpec.new 'Foo::BarBaz', '', {}, ''
       spec.design_document.should == 'foo::bar_baz'
     end
+    
+    it "should extract the list name from the options" do
+      spec = CouchPotato::View::BaseViewSpec.new stub(:lists => nil), 'all', {:list => 'test_list'}, {}
+      spec.list_name.should == 'test_list'
+    end
+    
+    it "should extract the list from the view parameters" do
+      spec = CouchPotato::View::BaseViewSpec.new stub(:lists => nil), 'all', {}, {:list => 'test_list'}
+      spec.list_name.should == 'test_list'
+    end
+    
+    it "should prefer the list name from the view parameters over the one from the options" do
+      spec = CouchPotato::View::BaseViewSpec.new stub(:lists => nil), 'all', {:list => 'my_list'}, {:list => 'test_list'}
+      spec.list_name.should == 'test_list'
+    end
+    
+    it "should return the list function" do
+      klass = stub 'class'
+      klass.stub(:lists).with('test_list').and_return('<list_code>')
+      spec = CouchPotato::View::BaseViewSpec.new klass, 'all', {:list => 'test_list'}, {}
+      spec.list_function.should == '<list_code>'
+    end
 
   end
 

data/spec/unit/callbacks_spec.rb

@@ -4,15 +4,23 @@ describe 'callbacks' do
   class Tree
     include CouchPotato::Persistence
 
-    before_validation :grow_leaf, lambda {|tree| tree.root_count ||= 0; tree.root_count += 1 }
+    before_validation :grow_leaf, 'grow_branch', lambda {|tree| tree.root_count ||= 0; tree.root_count += 1 }
 
     property :leaf_count
     property :root_count
+    property :branch_count
+    property :watered
+    
 
     def grow_leaf
       self.leaf_count ||= 0
       self.leaf_count += 1
     end
+    
+    def grow_branch
+      self.branch_count ||= 0
+      self.branch_count += 1
+    end
   end
   
   class AppleTree < Tree
@@ -29,11 +37,17 @@ describe 'callbacks' do
     end
   end
 
-  it "should call a method when validated" do
+  it "should call a method from a symbol when validated" do
     tree = Tree.new(:leaf_count => 1, :root_count => 1)
     tree.valid?
     tree.leaf_count.should == 2
   end
+  
+  it "should call a method from a string when validated" do
+    tree = Tree.new(:branch_count => 0)
+    tree.valid?
+    tree.branch_count.should == 1
+  end
 
   it "should call a lambda when validated" do
     tree = Tree.new(:leaf_count => 1, :root_count => 1)

data/spec/unit/database_spec.rb

@@ -208,12 +208,42 @@ end
 
 describe CouchPotato::Database, 'view' do
   before(:each) do
-    @db = CouchPotato::Database.new(stub('couchrest db').as_null_object)
+    @couchrest_db = stub('couchrest db').as_null_object
+    @db = CouchPotato::Database.new(@couchrest_db)
     @result = stub('result')
     @spec = stub('view spec', :process_results => [@result]).as_null_object
     CouchPotato::View::ViewQuery.stub(:new => stub('view query', :query_view! => {'rows' => [@result]}))
   end
   
+  it "should initialze a view query with map/reduce/list funtions" do
+    @spec.stub(:design_document => 'design_doc', :view_name => 'my_view',
+      :map_function => '<map_code>', :reduce_function => '<reduce_code>',
+      :list_name => 'my_list', :list_function => '<list_code>')
+    CouchPotato::View::ViewQuery.should_receive(:new).with(
+      @couchrest_db,
+      'design_doc',
+      {'my_view' => {
+        :map => '<map_code>',
+        :reduce => '<reduce_code>'
+      }},
+      {'my_list' => '<list_code>'})
+    @db.view(@spec)
+  end
+  
+  it "should initialze a view query with only map/reduce functions" do
+    @spec.stub(:design_document => 'design_doc', :view_name => 'my_view',
+      :map_function => '<map_code>', :reduce_function => '<reduce_code>',
+      :list_name => nil, :list_function => nil)
+    CouchPotato::View::ViewQuery.should_receive(:new).with(
+      @couchrest_db,
+      'design_doc',
+      {'my_view' => {
+        :map => '<map_code>',
+        :reduce => '<reduce_code>'
+      }}, nil)
+    @db.view(@spec)
+  end
+  
   it "should set itself on returned results that have an accessor" do
     @result.stub(:respond_to?).with(:database=).and_return(true)
     @result.should_receive(:database=).with(@db)

data/spec/unit/lists_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe CouchPotato::View::Lists, '.list' do
+  it "should make the list function available via .lists" do
+    clazz = Class.new
+    clazz.send :include, CouchPotato::View::Lists
+    clazz.list 'my_list', '<list_code>'
+    
+    clazz.lists('my_list').should == '<list_code>'
+  end
+  
+  it "should make the list available to subclasses" do
+    clazz = Class.new
+    clazz.send :include, CouchPotato::View::Lists
+    clazz.list 'my_list', '<list_code>'
+    sub_clazz = Class.new clazz
+    
+    sub_clazz.lists('my_list').should == '<list_code>'
+  end
+end

data/spec/unit/rspec_matchers_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
 require 'couch_potato/rspec'
-require 'ostruct'
 
 describe CouchPotato::RSpec::MapToMatcher do
   
   describe "basic map function" do
     before(:each) do
-      @view_spec = OpenStruct.new(:map_function => "function(doc) {emit(doc.name, doc.tags.length);}")
+      @view_spec = stub(:map_function => "function(doc) {emit(doc.name, doc.tags.length);}")
     end
 
     it "should pass if the given function emits the expected javascript" do
@@ -20,7 +19,7 @@ describe CouchPotato::RSpec::MapToMatcher do
   
   describe "functions emitting multiple times" do
     before(:each) do
-      @view_spec = OpenStruct.new(:map_function => "function(doc) {emit(doc.name, doc.tags.length); emit(doc.tags[0], doc.tags[1])};")
+      @view_spec = stub(:map_function => "function(doc) {emit(doc.name, doc.tags.length); emit(doc.tags[0], doc.tags[1])};")
     end
     
     it "should pass if the given function emits the expected javascript" do
@@ -34,7 +33,7 @@ describe CouchPotato::RSpec::MapToMatcher do
   
   describe "failing specs" do
     before(:each) do
-      @view_spec = OpenStruct.new(:map_function => "function(doc) {emit(doc.name, null)}")
+      @view_spec = stub(:map_function => "function(doc) {emit(doc.name, null)}")
     end
     
     it "should have a nice error message for failing should" do
@@ -53,7 +52,7 @@ end
 
 describe CouchPotato::RSpec::ReduceToMatcher do
   before(:each) do
-    @view_spec = OpenStruct.new(:reduce_function => "function(docs, keys, rereduce) {
+    @view_spec = stub(:reduce_function => "function(docs, keys, rereduce) {
       if(rereduce) {
         return(sum(keys) * 2);
       } else {
@@ -94,4 +93,32 @@ describe CouchPotato::RSpec::ReduceToMatcher do
       }.should raise_error('Expected not to reduce to 6 but did.')
     end
   end
+end
+
+describe CouchPotato::RSpec::ListAsMatcher do
+  before(:each) do
+    @view_spec = stub(:list_function => "function() {var row = getRow(); send(JSON.stringify([{text: row.text + ' world'}]));}")
+  end
+  
+  it "should pass if the function return the expected json" do
+    @view_spec.should list({'rows' => [{:text => 'hello'}]}).as([{'text' => 'hello world'}])
+  end
+  
+  it "should not pass if the function does not return the expected json" do
+    @view_spec.should_not list({'rows' => [{:text => 'hello'}]}).as([{'text' => 'hello there'}])
+  end
+  
+  describe "failing specs" do
+    it "should have a nice error message for failing should" do
+      lambda {
+        @view_spec.should list({'rows' => [{:text => 'hello'}]}).as([{'text' => 'hello there'}])
+      }.should raise_error('Expected to list as [{"text"=>"hello there"}] but got [{"text"=>"hello world"}].')
+    end
+    
+    it "should have a nice error message for failing should not" do
+      lambda {
+        @view_spec.should_not list({'rows' => [{:text => 'hello'}]}).as([{'text' => 'hello world'}])
+      }.should raise_error('Expected to not list as [{"text"=>"hello world"}] but did.')
+    end
+  end
 end

data/spec/unit/view_query_spec.rb

@@ -1,21 +1,78 @@
 require 'spec_helper'
 
-describe CouchPotato::View::ViewQuery, 'query_view' do
+describe CouchPotato::View::ViewQuery, 'query_view!' do
+  before(:each) do
+    CouchRest.stub(:get => nil)
+  end
+  
   it "should not pass a key if conditions are empty" do
     db = mock 'db', :get => nil, :save_doc => nil
     db.should_receive(:view).with(anything, {})
-    CouchPotato::View::ViewQuery.new(db, '', '', '', '').query_view!
+    CouchPotato::View::ViewQuery.new(db, '', {:view0 => {}}).query_view!
+  end
+  
+  it "should not update a view when the map/reduce functions haven't changed" do
+    db = mock 'db', :get => {'views' => {'view' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
+    db.should_not_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', :view => {:map => '<map_code>', :reduce => '<reduce_code>'}).query_view!
   end
   
-  it "should not update a view when the functions haven't changed" do
-    db = mock 'db', :get => {'views' => {'view' => {'map' => 'map', 'reduce' => 'reduce'}}}, :view => nil
+  it "should not update a view when the list function hasn't changed" do
+    db = mock 'db', :get => {'views' => {'view' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}, 'lists' => {'list0' => '<list_code>'}}, :view => nil
     db.should_not_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', 'view', 'map', 'reduce').query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list0 => '<list_code>').query_view!
+  end
+  
+  it "should update a view when the map function has changed" do
+    db = mock 'db', :get => {'views' => {'view2' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
+    db.should_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', :view2 => {:map => '<new map_code>', :recude => '<reduce_code>'}).query_view!
+  end
+  
+  it "should update a view when the reduce function has changed" do
+    db = mock 'db', :get => {'views' => {'view3' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
+    db.should_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', :view3 => {:map => '<map_code>', :reduce => '<new reduce_code>'}).query_view!
   end
   
-  it "should update a view when the functions have changed" do
-    db = mock 'db', :get => {'views' => {'view2' => {'map' => 'map', 'reduce' => 'reduce'}}}, :view => nil
+  it "should update a view when the list function has changed" do
+    db = mock 'db', :get => {
+      'views' => {'view4' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
+      'lists' => {'list1' => '<list_code>'}
+      }, :view => nil
     db.should_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', 'view2', 'mapnew', 'reduce').query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view4 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
   end
+  
+  it "should update a view when there wasn't a list function but now there is one" do
+    db = mock 'db', :get => {
+      'views' => {'view5' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
+      }, :view => nil
+    db.should_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view5 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
+  end
+  
+  it "should not update a view when there is a list function but no list function is passed" do
+    db = mock 'db', :get => {
+      'views' => {'view6' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
+      'lists' => {'list1' => '<list_code>'}
+      }, :view => nil
+    db.should_not_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view6 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
+  end
+  
+  it "should not update a view when there were no lists before and no list function is passed" do
+    db = mock 'db', :get => {
+      'views' => {'view6' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
+      }, :view => nil
+    db.should_not_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view6 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
+  end
+  
+  it "should query CouchRest directly when querying a list" do
+    db = stub('db').as_null_object
+    CouchRest.should_receive(:get).with('http://127.0.0.1:5984/couch_potato_test/_design/my_design/_list/list1/view7?key=1')
+    CouchPotato::View::ViewQuery.new(db, 'my_design', {:view7 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!(:key => 1)
+  end
+  
 end

data/spec/view_updates_spec.rb

@@ -7,8 +7,8 @@ describe "automatic view updates" do
   end
   
   it "should update a view that doesn't match the given functions" do
-    CouchPotato::View::ViewQuery.new(@db, 'test_design1', 'test_view', 'function(doc) {}', 'function() {}').query_view! # create view
-    CouchPotato::View::ViewQuery.new(@db, 'test_design1', 'test_view', 'function(doc) {emit(doc.id, null)}', 'function(key, values) {return sum(values)}').query_view!
+    CouchPotato::View::ViewQuery.new(@db, 'test_design1', {'test_view' => {:map => 'function(doc) {}', :reduce => 'function() {}'}}, nil).query_view! # create view
+    CouchPotato::View::ViewQuery.new(@db, 'test_design1', {'test_view' => {:map => 'function(doc) {emit(doc.id, null)}', :reduce => 'function(key, values) {return sum(values)}'}}, nil).query_view!
     CouchPotato.database.load('_design/test_design1')['views']['test_view'].should == {
       'map' => 'function(doc) {emit(doc.id, null)}',
       'reduce' => 'function(key, values) {return sum(values)}'
@@ -16,9 +16,9 @@ describe "automatic view updates" do
   end
   
   it "should only update a view once to avoid writing the view for every request" do
-    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {}', 'function() {}').query_view! # create view
-    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {emit(doc.id, null)}', 'function(key, values) {return sum(values)}').query_view!
-    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {}', 'function() {}').query_view!
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', {'test_view' => {:map => 'function(doc) {}', :reduce => 'function() {}'}}, nil).query_view! # create view
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', {'test_view' => {:map => 'function(doc) {emit(doc.id, null)}', :reduce => 'function(key, values) {return sum(values)}'}}, nil).query_view!
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', {'test_view' => {:map => 'function(doc) {}', :reduce => 'function() {}'}}, nil).query_view!
     CouchPotato.database.load('_design/test_design2')['views']['test_view'].should == {
       'map' => 'function(doc) {emit(doc.id, null)}',
       'reduce' => 'function(key, values) {return sum(values)}'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 32
-  version: 0.2.32
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Alexander Lang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-13 00:00:00 +02:00
+date: 2010-07-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,8 @@ files:
 - lib/couch_potato/railtie.rb
 - lib/couch_potato/rspec.rb
 - lib/couch_potato/rspec/matchers.rb
+- lib/couch_potato/rspec/matchers/json2.js
+- lib/couch_potato/rspec/matchers/list_as_matcher.rb
 - lib/couch_potato/rspec/matchers/map_to_matcher.rb
 - lib/couch_potato/rspec/matchers/print_r.js
 - lib/couch_potato/rspec/matchers/reduce_to_matcher.rb
@@ -87,6 +89,7 @@ files:
 - lib/couch_potato/view/base_view_spec.rb
 - lib/couch_potato/view/custom_view_spec.rb
 - lib/couch_potato/view/custom_views.rb
+- lib/couch_potato/view/lists.rb
 - lib/couch_potato/view/model_view_spec.rb
 - lib/couch_potato/view/properties_view_spec.rb
 - lib/couch_potato/view/raw_view_spec.rb
@@ -116,6 +119,7 @@ files:
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb
 - spec/unit/json_create_id_spec.rb
+- spec/unit/lists_spec.rb
 - spec/unit/model_view_spec_spec.rb
 - spec/unit/properties_view_spec_spec.rb
 - spec/unit/rspec_matchers_spec.rb
@@ -179,6 +183,7 @@ test_files:
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb
 - spec/unit/json_create_id_spec.rb
+- spec/unit/lists_spec.rb
 - spec/unit/model_view_spec_spec.rb
 - spec/unit/properties_view_spec_spec.rb
 - spec/unit/rspec_matchers_spec.rb