rufus-doric 0.1.2 → 0.1.3

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-doric CHANGELOG.txt
 
 
+== rufus-doric - 0.1.3    released 2010/04/06
+
+- Rufus::Doric::Value now has h_shortcut
+- some kind of full-text indexing (.text_index / .texts) for Model
+- preventing infinite loop when doing Model.by_x and db is not created
+
+
 == rufus-doric - 0.1.2    released 2010/03/23
 
 - person.belongings() returns all the object whose person_id is person._id

data/README.rdoc

@@ -1,16 +1,162 @@
 
 = rufus-doric
 
-something at the intersection of Rails3, CouchDB and rufus-jig.
+some Ruby lib at the intersection of Rails3, CouchDB and rufus-jig.
+
+
+== how does rufus-doric determine which Couch database to use ?
+
+At first it determines which CouchDB server to use via this code :
+
+  def self.couch_url
+
+    if defined?(Rails) # rails config/couch_url.txt
+      return File.read(Rails.root.join('config', 'couch_url.txt')).strip
+    end
+    if File.exist?('couch_url.txt') # current working directory
+      return File.read('couch_url.txt').strip
+    end
+
+    'http://127.0.0.1:5984' # the default
+  end
+
+Then the database is determined by calling Rufus::Doric.db(name)
+
+  p Rufus::Doric.db('mydb', :url_only => true)
+    # => "http://127.0.0.1:5984/mydb_test"
+
+  p Rufus::Doric.db('mydb', :env => 'camelia', :url_only => true)
+    # => "http://127.0.0.1:5984/mydb_camelia"
+
+  p Rufus::Doric.db('mydb', :env => 'camelia')
+    # => #<Rufus::Jig::Couch:0x00000102325120 @http=#<Rufus::Jig::Http:0x00000102324908 @host="127.0.0.1", @port=5984, @path="/toot_test", ...>...> 
+
+In summary, you only have to create a couch_url.txt file that contains the http:://{host}:{port} of your couch server. The rest is taken care of.
 
 
 == Rufus::Doric::Model usage
 
-see tests
+One document per instance.
+
+  class Item < Rufus::Doric::Model
+
+    db :doric
+      # in which db it goes (remember that an _env suffix is added)
+
+    doric_type :items
+      # 'doric_type' field
+
+    _id_field :name
+      # _id field is determined from field 'name'
+
+    h_accessor :name
+    h_accessor :supplier
+
+    validates :supplier, :presence => true
+  end
+
+There is more, please look at the test/ directory to discover Model.
+
 
 == Rufus::Doric::OneDocModel usage
 
-see tests
+I use this for 'users' models.
+
+  class User < Rufus::Doric::OneDocModel
+
+    db 'doric'
+    doc_id :users
+
+    h_accessor :locale
+    h_accessor :email
+    h_reader :password
+
+    validates :password, :presence => true
+  end
+
+It places all the users in one document (whereas Rufus::Doric::Model has 1 document per instance/record).
+
+Look at the test/ directory to learn more about OneDocModel.
+
+
+== Rufus::Doric::Value usage
+
+Value is about Couch documents containing a single 'value' field (apart from _id and _rev)
+
+Given
+
+  class Tuples < Rufus::Doric::Value
+
+    doc_id :tuples
+    db :doric
+
+    def to_s
+      value.sort.join(' ')
+    end
+  end
+
+and a document 'tuples' in the database 'doric' :
+
+  {
+    "_id": "tuples",
+    "value": [ "alpha", "bravo", "charly" ]
+  }
+
+this can be done :
+
+  p Tuples.load.to_s
+    # => "alpha bravo charly"
+
+  tuples = Tuples.load
+  tuples.value << 'borneo'
+  tuples.save!
+
+  p Tuples.load.to_s
+    # => "alpha borneo bravo charly"
+
+Also :
+
+  tuples = Tuples.new(
+    '_id' => 'tuples', 'value' => %w[ alpha beta delta gamma ]).save!
+
+  p Tuples.load.to_s
+    # => "alpha beta delta gamma"
+
+
+== Rufus::Doric::Value and h_shortcut
+
+Most of the time, I use Rufus::Doric::Value to store a hash of things :
+
+  class Misc < Rufus::Doric::Value
+
+    doc_id :misc
+    db :doric
+
+    h_shortcut :product_lines
+    h_shortcut :purposes
+  end
+
+with :
+
+  {
+    "_id": "misc",
+    "value": {
+      "product_lines" : [
+        "blue_coat", "ulticom", "znyx"
+      ],
+      "purposes": [
+        "stock", "non_stock", "replace", "rma", "loan"
+      ]
+    }
+  }
+
+then in my app, I just do
+
+  p Misc.product_lines
+    # => [ "blue_coat", "ulticom", "znyx" ]
+
+  p Misc.purposes
+    # => [ "stock", "non_stock", "replace", "rma", "loan" ]
 
 
 == 'fixtures' usage

data/TODO.txt

@@ -2,8 +2,13 @@
 [o] one_doc_model : validation
 [o] model : validation
 [o] destroy/delete
+[o] fix Amedeo's infinite loop (model.rb l438)
 
 [x] lsof check (jig / patron)
 
 [ ] all, by : limit and skip (pagination)
 
+[ ] eventually : cache the text index
+[ ] eventually : pagination for the text index
+[ ] pagination for everybody in Model (DRY)
+

data/lib/rufus/doric/model.rb

@@ -115,6 +115,11 @@ module Doric
       }
     end
 
+    def self.text_index (*keys)
+
+      @text_index = keys
+    end
+
     include WithH
     include WithDb
 
@@ -369,6 +374,22 @@ module Doric
       "_design/doric_#{name}"
     end
 
+    # Well... Returns a map { 'word' => [ docid0, docid1 ] }
+    #
+    def self.texts (key=nil)
+
+      return nil unless @text_index
+
+      path = "#{design_path}/_view/text_index"
+      path = "#{path}?key=%22#{key}%22" if key
+
+      m = get_result(path, :text_index)
+
+      m = m['rows'].inject({}) { |h, r| (h[r['key']] ||= []) << r['id']; h }
+
+      key ? m[key] : m
+    end
+
     protected
 
     def self.put_design_doc (key=nil)
@@ -384,15 +405,42 @@ module Doric
         'views' => {}
       }
 
-      ddoc['views']["by_#{key}"] = {
-        'map' => %{
-          function(doc) {
-            if (doc.doric_type == '#{@doric_type}') {
-              emit(doc['#{key}'], null);
+      if key == :text_index
+
+        # I wish I could write keys.forEach(...) directly
+
+        # do no word removing, it depends on languages, and can be
+        # done on the client side
+
+        ddoc['views']['text_index'] = {
+          'map' => %{
+            function(doc) {
+              if (doc.doric_type == '#{@doric_type}') {
+                var keys = #{Rufus::Json.encode(@text_index)};
+                for (var key in doc) {
+                  if (keys.indexOf(key) < 0) continue;
+                  if (doc[key] == undefined) continue;
+                  var words = doc[key].split(/[\s,;\.]/);
+                  words.forEach(function (word) {
+                    if (word != '') emit(word, null);
+                  });
+                }
+              }
             }
           }
         }
-      }
+      else
+
+        ddoc['views']["by_#{key}"] = {
+          'map' => %{
+            function(doc) {
+              if (doc.doric_type == '#{@doric_type}') {
+                emit(doc['#{key}'], null);
+              }
+            }
+          }
+        }
+      end
 
       db.put(ddoc)
     end
@@ -405,18 +453,7 @@ module Doric
         "_design/doric/_view/by_doric_type?key=%22#{@doric_type}%22" +
         "&include_docs=true"
 
-      result = db.get(path)
-
-      unless result
-
-        # insert design doc
-
-        r = put_design_doc
-        raise(
-          "failed to insert design_doc in db '#{db.name}'"
-        ) if r == true
-        return get_all(opts)
-      end
+      result = get_result(path)
 
       result['rows'].collect { |r| r['doc'] }
     end
@@ -431,14 +468,34 @@ module Doric
 
       path = "#{design_path}/_view/by_#{key}?key=#{v}&include_docs=true"
 
+      result = get_result(path, key)
+
+      result['rows'].collect { |r| self.new(r['doc']) }
+    end
+
+    # Ensures the necessary design_doc is loaded (if first query failed)
+    # and then returns the raw result.
+    #
+    # Will raise if the design_doc can't be inserted (probably the underlying
+    # db is missing).
+    #
+    def self.get_result (path, design_doc_key=nil)
+
       result = db.get(path)
 
-      unless result
-        put_design_doc(key)
-        return by(key, val, opts)
-      end
+      return result if result
 
-      result['rows'].collect { |r| self.new(r['doc']) }
+      # insert design doc
+
+      r = put_design_doc(design_doc_key)
+
+      raise(
+        "failed to insert 'any' design_doc in db '#{db.name}'"
+      ) if r == true
+
+      # re-get
+
+      get_result(path, design_doc_key)
     end
   end
 end

data/lib/rufus/doric/value.rb

@@ -40,6 +40,16 @@ module Doric
       @doc_id
     end
 
+    def self.h_shortcut (*keys)
+      keys.each do |k|
+        self.instance_eval %{
+          def #{k}
+            load.value[#{k.to_s.inspect}]
+          end
+        }
+      end
+    end
+
     include WithDb
 
     #

data/lib/rufus/doric/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Doric
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end
 end
 

data/rufus-doric.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-doric}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-04-06}
   s.description = %q{
 something at the intersection of Rails3, CouchDB and rufus-jig
   }
@@ -53,7 +53,8 @@ something at the intersection of Rails3, CouchDB and rufus-jig
      "test/ut_5_value.rb",
      "test/ut_6_model_associations.rb",
      "test/ut_7_looser_associations.rb",
-     "test/ut_8_belongings.rb"
+     "test/ut_8_belongings.rb",
+     "test/ut_9_any.rb"
   ]
   s.homepage = %q{http://github.com/jmettraux/rufus-doric/}
   s.rdoc_options = ["--charset=UTF-8"]

data/test/ut_2_model_view.rb

@@ -64,5 +64,14 @@ class UtModelTest < Test::Unit::TestCase
 
     assert_not_nil Nada::Thing.db.get('_design/doric_nada__thing')
   end
+
+  def test_no_infinite_loop_when_missing_db
+
+    Rufus::Doric.db('doric').delete('.')
+
+    assert_raise RuntimeError do
+      Nada::Thing.by_colour('blue').size
+    end
+  end
 end
 

data/test/ut_5_value.rb

@@ -21,6 +21,14 @@ class Tuples < Rufus::Doric::Value
   end
 end
 
+class Misc < Rufus::Doric::Value
+
+  doc_id :misc
+  db :doric
+
+  h_shortcut :product_lines
+end
+
 
 class UtValueTest < Test::Unit::TestCase
 
@@ -65,5 +73,13 @@ class UtValueTest < Test::Unit::TestCase
 
     assert_equal 'alpha beta delta gamma', Tuples.load.to_s
   end
+
+  def test_h_shortcut
+
+    Misc.new(
+      '_id' => 'misc', 'value' => { 'product_lines' => %w[ a b c ]}).save!
+
+    assert_equal %w[ a b c ], Misc.product_lines
+  end
 end
 

data/test/ut_9_any.rb

@@ -0,0 +1,115 @@
+
+#
+# testing rufus-doric
+#
+# Thu Apr  1 10:32:57 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'rufus/doric'
+
+
+class Product < Rufus::Doric::Model
+
+  db :doric
+  doric_type :products
+
+  _id_field :serial_number
+
+  property :serial_number
+  property :name
+  property :brand
+  property :category
+  property :comment
+
+  text_index :serial_number, :name, :brand
+end
+
+class Whatever < Rufus::Doric::Model
+
+  db :doric
+  doric_type :whatevers
+
+  _id_field :name
+
+  property :name
+end
+
+
+class UtAnyTest < Test::Unit::TestCase
+
+  def setup
+
+    Rufus::Doric.db('doric').delete('.')
+    Rufus::Doric.db('doric').put('.')
+
+    Rufus::Doric.db('doric').http.cache.clear
+      # CouchDB feeds the same etags for views, even after a db has
+      # been deleted and put back, so have to do that 'forgetting'
+
+    Product.new(
+      :serial_number => 'h2o',
+      :name => 'water',
+      :brand => 'earth',
+      :category => 'drink',
+      :comment => nil
+    ).save!
+    Product.new(
+      :serial_number => '951',
+      :name => 'seamaster professional',
+      :brand => 'omega',
+      :category => 'watches',
+      :comment => 'want as well'
+    ).save!
+    Product.new(
+      :serial_number => 'lv52',
+      :name => 'leather bag, for men',
+      :brand => 'lv',
+      :category => 'bags',
+      :comment => nil
+    ).save!
+    Product.new(
+      :serial_number => '0kcal',
+      :name => 'zero',
+      :brand => 'coca-cola',
+      :category => 'drink',
+      :comment => nil
+    ).save!
+    Product.new(
+      :serial_number => 'tell2',
+      :name => 'tell bag',
+      :brand => 'victorinox',
+      :category => 'bags',
+      :comment => nil
+    ).save!
+
+    Whatever.new(
+      :name => 'whatever'
+    ).save!
+  end
+
+  #def teardown
+  #end
+
+  def test_no_texts
+
+    assert_nil Whatever.texts
+  end
+
+  def test_texts
+
+    index = Product.texts
+
+    #p index
+
+    assert_equal %w[ lv52 tell2 ], index['bag'].sort
+    assert_equal nil, index['products']
+  end
+
+  def test_texts_key
+
+    assert_equal [ '951' ], Product.texts('omega')
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 +09:00
+date: 2010-04-06 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -141,6 +141,7 @@ files:
 - test/ut_6_model_associations.rb
 - test/ut_7_looser_associations.rb
 - test/ut_8_belongings.rb
+- test/ut_9_any.rb
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-doric/
 licenses: []