couch_view 0.0.1

data/features/setup/env.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift './lib'
+
+require 'couch_view'
+require 'couchrest_model_config'
+require 'cucumber/rspec/doubles'
+
+CouchRest::Model::Config.edit do
+  database do
+    default "http://admin:password@localhost:5984/couch_view_test"
+  end
+end
+
+Before("@db") do
+  CouchRest::Model::Config.default_database.recreate!
+end

data/features/setup/hooks.rb

@@ -0,0 +1,7 @@
+Before do
+  Object.class_eval do
+    if defined? Article
+      remove_const "Article"
+    end
+  end
+end

data/features/step_definitions/couch_view.array.rb

@@ -0,0 +1,7 @@
+Given /^an array of 3 elements:$/ do |code|
+  eval code
+end
+
+Then /^I should receive all of the subsets of my array:$/ do |code|
+  eval code
+end

data/features/step_definitions/couch_view.config.rb

@@ -0,0 +1,11 @@
+When /^I (?:create a |change the).*:$/ do |code|
+  eval code
+end
+
+When /^I add the Published and Visible conditions to it:$/ do |code|
+  eval code
+end
+
+When /^I give it a base name of .*:$/ do |code|
+  eval code
+end

data/features/step_definitions/couch_view.count.proxy.rb

@@ -0,0 +1,23 @@
+Given /^an Article model that maps ByLabel:$/ do |code|
+  eval code
+end
+
+Given /^several articles:$/ do |code|
+  eval code
+end
+
+When /^I set the CouchDB.*query option to.*:$/ do |code|
+  eval code
+end
+
+Then /^.* should raise an exception:$/ do |code|
+  eval code
+end
+
+Then /^.* should not raise an exception:$/ do |code|
+  eval code
+end
+
+Given /^there are .*articles:$/ do |code|
+  eval code
+end

data/features/step_definitions/couch_view.map.rb

@@ -0,0 +1,19 @@
+Given /^the .*$/ do |code|
+  eval code
+end
+
+When /^I instantiate .*$/ do |code|
+  @response = eval code
+end
+
+Then /^I should not be able to call .*$/ do |code|
+  eval code
+end
+
+Then /^I should receive a map proxy:$/ do |code|
+  eval code
+end
+
+Then /^I should receive (?:a CouchDB|the following).*$/ do |response|
+  @response.strip.gsub(/\n[\ ]*/, "").should == response.strip.gsub(/\n[\ ]*/, "")
+end

data/features/step_definitions/couch_view.proxy.rb

@@ -0,0 +1,15 @@
+Given /^an Article model with a view .*:$/ do |code|
+  eval code
+end
+
+When /^I (?:destructively )?limit the results to \d+:$/ do |code|
+  eval code
+end
+
+When /^I call the .*/ do |code|
+  eval code
+end
+
+Then /^@new_proxy should (?:not )?be a new object:$/ do |code|
+  eval code
+end

data/features/step_definitions/couch_view.rb

@@ -0,0 +1,87 @@
+When /^I mix .*:$/ do |code|
+  eval code
+end
+
+Then /^my model should respond to .*:$/ do |code|
+  eval code
+end
+
+When /^I create an Article:$/ do |code|
+  eval code
+end
+
+Then /^`.*` should return the article$/ do |code|
+  eval code
+end
+
+Then /^my proxy should map .*$/ do |code|
+  eval code
+end
+
+Then /^I should receive a.*proxy:$/ do |code|
+  eval code
+end
+
+When /^I create.*articles:$/ do |code|
+  eval code
+end
+
+Then /^`count_by_id!` should return .*:$/ do |code|
+  eval code
+end
+
+When /^I pass :label to the `map` class method:$/ do |code|
+  eval code
+end
+
+When /^I create some articles with labels:$/ do |code|
+  eval code
+end
+
+Then /^they should be indexed in my label map:$/ do |code|
+  eval code
+end
+
+When /^I add them as conditions to a map over my model's label property:$/ do |code|
+  eval code
+end
+
+When /^I create visible and published documents:$/ do |code|
+  eval code
+end
+
+Then /^I should be able to query them through my query proxy:$/ do |code|
+  eval code
+end
+
+Given /^a.*model:$/ do |code|
+  eval code
+end
+
+When /^I define a map over labels with a custom reduce that always returns .*:$/ do |code|
+  eval code
+end
+
+When /^I create two articles with the same label:$/ do |code|
+  eval code
+end
+
+Then /^`reduce_by_label` should return.*:$/ do |code|
+  eval code
+end
+
+When /^I call.*with.*:$/ do |code|
+  eval code
+end
+
+Then /^my model should not respond to .*:$/ do |code|
+  eval code
+end
+
+When /^I create two articles with labels:$/ do |code|
+  eval code
+end
+
+Then /^".*" should return.*:$/ do |code|
+  eval code
+end

data/lib/couch_view/array.rb

@@ -0,0 +1,9 @@
+class Array
+  def all_combinations
+    (0..self.length).map do |i| 
+      (combination i).to_a 
+    end.inject([]) do |sum, value| 
+      sum += value 
+    end
+  end
+end

data/lib/couch_view/config.rb

@@ -0,0 +1,89 @@
+module CouchView
+  class Config
+    attr_reader :map_class, :model, :properties, :conditions
+
+    def initialize(model_class)
+      @model     = model_class
+      @conditions = []
+    end
+
+    def map(*args, &block)
+      @map_class, @properties = extract_map_class_data args
+      self.instance_eval &block if block
+    end
+
+    def reduce(function=nil)
+      if function
+        @reduce = function
+      else
+        @reduce ||= "_count"
+      end
+    end
+
+    def conditions(*args)
+      if args.empty?
+        @conditions
+      else
+        @conditions += args
+      end
+    end
+
+    def view_names 
+      views.keys.map &:to_s
+    end
+    
+    def views
+      all_views = {}
+      all_views[base_view_name.to_sym] = {
+        :map => @map_class.new(@model, *@properties).map,
+        :reduce => reduce
+      }
+      all_views.merge! condition_views
+      all_views
+    end
+
+    def base_view_name(name=nil)
+      if name
+        @base_view_name = name
+      elsif @base_view_name
+        @base_view_name
+      elsif @properties.empty?
+        @base_view_name = @map_class.to_s.underscore
+      else
+        @base_view_name = "by_" + @properties.map(&:to_s).map(&:underscore).join("_and_")
+      end
+    end
+
+    private
+    def condition_views
+      all_condition_subsets = @conditions.all_combinations.reject &:empty?
+
+      all_condition_subsets.reject(&:empty?).inject({}) do |result, condition_combination|
+        condition_combination.sort! {|a,b| a.to_s <=> b.to_s}
+        
+        view_name = 
+          "#{base_view_name}_" + 
+          condition_combination.map {|condition| condition.to_s.underscore}.join("_")
+
+        map_instance = @map_class.new @model, *@properties
+        condition_combination.map { |condition| map_instance.extend condition }
+
+        result[view_name.to_sym] = {
+          :map => map_instance.map,
+          :reduce => reduce
+        }
+
+        result
+      end
+    end
+
+    def extract_map_class_data(map)
+      if map.first.class == Symbol
+        properties = [map].flatten
+        return CouchView::Map::Property, properties 
+      else
+        return map.first, []
+      end
+    end
+  end
+end

data/lib/couch_view/couch_view.rb

@@ -0,0 +1,61 @@
+module CouchView
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def map(*args, &block)
+      couch_view do
+        map *args, &block
+      end
+    end
+
+    def couch_view(name=nil, &block) 
+      view_config = CouchView::Config.new self
+      view_config.instance_eval &block
+      view_config.base_view_name name if name
+      view_config.views.each do |view_name, view|  
+        view_by view_name, :map => view[:map], :reduce => view[:reduce]
+      end
+
+      base_view_name = view_config.base_view_name
+
+      instance_eval <<-METHODS
+        def map_#{base_view_name}!
+          generate_view_proxy_for("#{base_view_name}").get!
+        end
+
+        def map_#{base_view_name}
+          generate_view_proxy_for "#{base_view_name}"
+        end
+
+        def reduce_#{base_view_name}!
+          generate_view_proxy_for("#{base_view_name}").reduce(true).get!
+        end
+
+        def reduce_#{base_view_name}
+          generate_view_proxy_for("#{base_view_name}").reduce(true)
+        end
+      METHODS
+      
+      if view_config.reduce == "_count"
+        instance_eval <<-METHODS
+          def count_#{base_view_name}!
+            generate_count_proxy_for("#{base_view_name}").get!
+          end
+
+          def count_#{base_view_name}
+            generate_count_proxy_for "#{base_view_name}"
+          end
+        METHODS
+      end
+    end
+
+    private
+    def generate_count_proxy_for(view)
+      CouchView::Count::Proxy.new self, "by_#{view}".to_sym
+    end
+
+    def generate_view_proxy_for(view)
+      CouchView::Proxy.new self, "by_#{view}".to_sym
+    end
+  end
+end

data/lib/couch_view/count_proxy.rb

@@ -0,0 +1,27 @@
+module CouchView
+  module Count
+    class Proxy < CouchView::Proxy
+      def each(&block)
+        raise "You can't call 'each' on a count proxy that doesn't set 'group' to 'true'." unless _options[:group]
+        results = self.get!['rows']
+        results.each do |row|
+          block.call row['key'], row['value']
+        end
+      end
+
+      def get!
+        if _options[:group]
+          super
+        else
+          result = super['rows'].first
+          result ? result['value'] : 0
+        end
+      end
+
+      private
+      def default_query_options
+        CouchView::QueryOptions.new self, :reduce => true
+      end
+    end
+  end
+end

data/lib/couch_view/map.rb

@@ -0,0 +1,45 @@
+module CouchView
+  module Map
+    attr_accessor :model
+
+    def initialize(model=nil, *properties)
+      @model = model
+      @properties = properties.empty? ? ["_id"] : properties 
+    end
+
+    def map
+      if conditions != "true"
+        "
+          function(doc){
+            if (#{conditions})
+              emit(#{key}, null)
+          }
+        "
+      else
+        "
+          function(doc){
+            emit(#{key}, null)
+          }
+        "
+      end
+    end
+
+    def conditions
+      if @model
+        "doc['couchrest-type'] == '#{@model}'" 
+      else
+        "true"
+      end
+    end
+    
+    private
+    def key
+      properties = @properties.map {|p| "doc.#{p}"}
+      if properties.length == 1
+        properties
+      else
+        "[#{properties.join ", "}]"
+      end
+    end
+  end
+end

data/lib/couch_view/map_property.rb

@@ -0,0 +1,7 @@
+module CouchView
+  module Map
+    class Property
+      include CouchView::Map
+    end
+  end
+end

data/lib/couch_view/proxy.rb

@@ -0,0 +1,70 @@
+module CouchView
+  class Proxy
+    extend Forwardable
+    
+    attr_reader   :_model, :_map
+    attr_accessor :_query_options
+    
+    # Supported CouchDB Query Options
+    def_delegators :@_query_options, 
+      :limit,          :limit!,                         
+      :skip,           :skip!,
+      :startkey,       :startkey!,
+      :endkey,         :endkey!,
+      :startkey_docid, :startkey_docid!,
+      :endkey_docid,   :endkey_docid!,
+      :stale,          :stale!,
+      :descending,     :descending!,
+      :group,          :group!,
+      :group_level,    :group_level!,
+      :reduce,         :reduce!,
+      :include_docs,   :include_docs!,
+      :update_seq,     :update_seq!
+      
+    def initialize(model, map)
+      @_model         = model
+      @_map           = map
+      @_conditions    = []
+      @_query_options = default_query_options
+    end
+
+    def _options
+      @_query_options.to_hash
+    end
+
+    def _map
+      map = [@_map.to_s, @_conditions.sort.join("_")]
+      map.reject! &:blank?
+      map.join("_").to_sym
+    end
+
+    def method_missing(condition, *args, &block)
+      condition = remove_exclamation(condition)
+      @_conditions << condition
+      self
+    end
+
+    def each(&block)
+      _model.send(_map, _options).each &block
+    end
+
+    def get!
+      _model.send _map, _options
+    end
+
+    private
+    def default_query_options
+      CouchView::QueryOptions.new self, :reduce => false
+    end
+
+    def remove_exclamation(condition)
+      condition = condition.to_s
+
+      if condition[-1..-1] == "!"
+        condition[0...-1]
+      else
+        condition
+      end
+    end
+  end
+end

data/lib/couch_view/query_options.rb

@@ -0,0 +1,43 @@
+module CouchView
+  class QueryOptions
+    attr_reader :options
+    
+    def initialize(view_proxy, options={})
+      @view_proxy = view_proxy
+      @options    = options
+    end
+    
+    def method_missing(option_name, *args, &block)
+      set_query_option option_name.to_s, args.first
+    end
+
+    def to_hash
+      @options
+    end
+    
+    private
+    def ends_in_exclamation?(option_name="")
+      option_name.to_s[-1..-1] == "!"
+    end
+
+    def set_query_option(option_name, option_value)
+      if ends_in_exclamation? option_name 
+        destructively_update_option option_name, option_value
+      else
+        update_option_and_return_new_proxy option_name, option_value
+      end
+    end
+
+    def destructively_update_option(option_name, option_value)
+      @options[option_name[0...-1].to_sym] = option_value
+      @view_proxy
+    end
+
+    def update_option_and_return_new_proxy(option_name, option_value)
+      new_proxy                = @view_proxy.dup
+      new_options              = @options.dup.merge option_name.to_sym => option_value
+      new_proxy._query_options = CouchView::QueryOptions.new new_proxy, new_options
+      new_proxy
+    end
+  end
+end

data/lib/couch_view.rb

@@ -0,0 +1,10 @@
+require 'forwardable'
+require 'couchrest_model'
+require 'couch_view/map'
+require 'couch_view/config'
+require 'couch_view/couch_view'
+require 'couch_view/proxy'
+require 'couch_view/map_property'
+require 'couch_view/count_proxy'
+require 'couch_view/query_options'
+require 'couch_view/array'