rufus-doric 0.1.7 → 0.1.8

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-doric CHANGELOG.txt
 
 
+== rufus-doric - 0.1.8    released 2010/04/16
+
+- view_by 'funcname', 'func' creates a 'funcname' method, not a 'by_funcname'
+- ranges must now be specified with :start[key] and/or :end[key]
+
+
 == rufus-doric - 0.1.7    released 2010/04/16
 
 - view_by 'tysec', "emit(doc.type + '__' + doc.security_level, null);"

data/TODO.txt

@@ -6,12 +6,12 @@
 [o] all, by : limit and skip (pagination)
 [o] pagination for everybody in Model (DRY)
 [o] eventually : pagination for the text index
+[o] view_by 'name', %{ emit(doc.nada) }
+[o] start and end key should be by_x(:start => a, :end => b)
 
 [x] lsof check (jig / patron)
 
 [ ] eventually : cache the text index
 
-[ ] view_by 'name' do
-      %{ emit(doc.nada) }
-    end
+[ ] view_by 'x', 'emit' ==> view 'x', 'emit' ==> Model.x(key)...
 

data/lib/rufus/doric/model.rb

@@ -103,6 +103,49 @@ module Doric
       @_id_field
     end
 
+    # Creates a by_{key} method.
+    #
+    # If a func (a String) is passed, a {key} method is created that
+    # uses the given view function fragment.
+    #
+    # == example
+    #
+    #   class Task < Rufus::Doric::Model
+    #
+    #     property :user
+    #     property :status
+    #     property :date_terminated
+    #
+    #     view_by :user
+    #
+    #     view_by 'open_tasks', %{
+    #       if (doc.date_terminated) return;
+    #       if (doc.status == 'suspended') return;
+    #       emit(doc.user, null);
+    #     }
+    #   end
+    #
+    # will thus have a by_user method and a open_tasks method
+    #
+    #   Task.by_user('john')
+    #     # lists all the tasks for the user 'john'
+    #
+    #   Task.open_tasks('john')
+    #     # lists all the open tasks for the user 'john'
+    #
+    #   Task.open_tasks('john', :skip => 5, :limit => 10)
+    #     # lists 10 open tasks for the user 'john' (skipping the first 5)
+    #
+    # == options
+    #
+    # The methods generated by view_by support the following options :
+    #
+    #   :limit, :skip, :inclusive_end, :descending, :start[key], :end[key]
+    #
+    # See http://wiki.apache.org/couchdb/HTTP_view_API#Querying_Options
+    #
+    # The all method supports the same options.
+    #
     def self.view_by (key, func=nil)
 
       if func
@@ -110,7 +153,7 @@ module Doric
         k = { key => func }
 
         instance_eval %{
-          def by_#{key} (val, opts={})
+          def #{key} (val, opts={})
             by(#{k.inspect}, val, opts)
           end
         }
@@ -534,20 +577,36 @@ module Doric
       result['rows'].collect { |r| r['doc'] }
     end
 
-    def self.by (key, val, opts)
+    # A helper method for .by
+    #
+    def self.is_option_hash (h)
 
-      qs = [ 'include_docs=true' ]
+      return false unless h.is_a?(Hash)
+      h.keys.each { |k| return false unless k.is_a?(Symbol) }
+      true
+    end
 
-      if val.is_a?(Array) && ( ! key.is_a?(Array))
+    # view_by uses this .by method in the background
+    #
+    def self.by (key, val, opts={})
 
-        st, en = val
-        qs << "startkey=#{Rufus::Doric.escape(st)}" if st
-        qs << "endkey=#{Rufus::Doric.escape(en)}" if en
-      else
+      #p [ key, val, opts ]
 
+      qs = [ 'include_docs=true' ]
+
+      if is_option_hash(val)
+        opts = val
+      else
         qs << "key=#{Rufus::Doric.escape(val)}"
       end
 
+      if st = opts[:start] || opts[:startkey]
+        qs << "startkey=#{Rufus::Doric.escape(st)}"
+      end
+      if en = opts[:end] || opts[:endkey]
+        qs << "endkey=#{Rufus::Doric.escape(en)}"
+      end
+
       add_common_options(qs, opts)
 
       skey = case key

data/lib/rufus/doric/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Doric
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end
 end
 

data/rufus-doric.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-doric}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]

data/test/ut_11_model_view_range.rb

@@ -50,18 +50,21 @@ class UtModelViewRangeTest < Test::Unit::TestCase
 
     assert_equal(
       %w[ climbing drinking ],
-      Schedule.by_day([ '20101226', nil ]).collect { |s| s.name })
+      Schedule.by_day(:start => '20101226').collect { |s| s.name })
     assert_equal(
       %w[ climbing drinking ],
-      Schedule.by_day([ '20101226' ]).collect { |s| s.name })
+      Schedule.by_day(:start => '20101226', :end => nil).collect { |s| s.name })
 
     assert_equal(
       %w[ shopping wrestling cooking ],
-      Schedule.by_day([ nil, '20101225' ]).collect { |s| s.name })
+      Schedule.by_day(:end => '20101225').collect { |s| s.name })
+    assert_equal(
+      %w[ shopping wrestling cooking ],
+      Schedule.by_day(:start => nil, :end => '20101225').collect { |s| s.name })
 
     assert_equal(
       %w[ drinking climbing cooking ],
-      Schedule.by_day([ nil, '20101225' ], :descending => true).collect { |s| s.name })
+      Schedule.by_day(:end => '20101225', :descending => true).collect { |s| s.name })
   end
 
   def test_view_limit
@@ -72,10 +75,10 @@ class UtModelViewRangeTest < Test::Unit::TestCase
 
     assert_equal(
       %w[ climbing ],
-      Schedule.by_day([ '20101226', nil ], :limit => 1).collect { |s| s.name })
+      Schedule.by_day(:start => '20101226', :limit => 1).collect { |s| s.name })
     assert_equal(
       %w[ drinking ],
-      Schedule.by_day([ '20101226', nil ], :skip => 1).collect { |s| s.name })
+      Schedule.by_day(:start => '20101226', :skip => 1).collect { |s| s.name })
   end
 
   def test_all_opts

data/test/ut_16_model_custom_view.rb

@@ -22,6 +22,9 @@ class Team < Rufus::Doric::Model
   view_by 'tysec', %{
     emit(doc.type + '__' + doc.security_level, null);
   }
+  view_by 'tysec2', %{
+    emit([ doc.type, doc.security_level ], null);
+  }
 end
 
 
@@ -40,7 +43,7 @@ class UtModelCustomViewTest < Test::Unit::TestCase
   #def teardown
   #end
 
-  def test_view_by_and
+  def test_views
 
     Team.new(
       'type' => 'rifle',
@@ -63,8 +66,10 @@ class UtModelCustomViewTest < Test::Unit::TestCase
       'security_level' => 'c'
     ).save!
 
-    assert_equal 2, Team.by_tysec('rifle__a').size
-    assert_equal 1, Team.by_tysec('rifle__b').size
+    assert_equal 2, Team.tysec('rifle__a').size
+    assert_equal 1, Team.tysec('rifle__b').size
+
+    assert_equal 2, Team.tysec2(%w[ rifle a ]).size
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - John Mettraux