chill 8 → 8.1.0

data/examples/benchmark.rb

@@ -0,0 +1,20 @@
+require '../lib/chill'
+require 'benchmark'
+# A little benchmark to illustrate the performance difference between a bulk commit and individual commits
+ChillDB.goes :BulkCommitBenchmark
+Documents = 1000 # benchmark 1000 documents
+
+puts "Bulk Commit of #{Documents}"
+puts(bulk = Benchmark.realtime {
+  BulkCommitBenchmark.commit! Documents.times.map { { random_number: rand(50) } }
+})
+
+puts "Single Commit of #{Documents}"
+puts(single = Benchmark.realtime {
+  Documents.times do 
+    { random_number: rand(50) }
+    BulkCommitBenchmark.document( random_number: rand(50) ).commit! 
+  end
+})
+
+puts "Bulk Commit was #{ ((single / bulk) * 100).round(2) }% faster!"

data/examples/bulk-commit.rb

@@ -0,0 +1,17 @@
+require '../lib/chill.rb'
+# A simple test to check the new bulk commit api works as intended
+# by Bluebie
+
+ChillDB.goes :BulkBag
+
+BulkBag.delete! BulkBag.everything # clear out our test database, using new bulk delete api
+
+BulkBag.commit!(
+  { _id: 'brother1', name: "Lucky" },
+  { _id: 'brother2', name: "Fyr" }
+);
+
+raise "fail" unless BulkBag['brother1'].name == 'Lucky'
+raise "fail" unless BulkBag['brother2'].name == 'Fyr'
+
+puts "Success! Brother1's name is #{ BulkBag['brother1'].name }"

data/examples/find-app.rb

@@ -0,0 +1,118 @@
+# Find App is a simple little fulltext search engine, to lookup documents containing words
+require '../lib/chill.rb'
+require 'pp'
+
+ChillDB.goes :FindApp
+
+# delete everything in the database so we have a nice fresh start while experimenting
+FindApp.everything.delete!
+
+# a view which will list all the words in our stories
+FindApp.design(:search).views(
+  # words view splits up all the words then adds them as keys to this document
+  words: %q(
+    function(doc) {
+      if (doc.kind != "story") return;
+      var words = doc.text.split(/[^a-z0-9\']+/i);
+      for (id in words) {
+        emit(words[id].toLowerCase(), {_rev: doc._rev, word: words[id]})
+      }
+    }
+  )
+).commit!
+
+# a little template for stories
+FindApp.templates(
+  story: {
+    text: "",
+    name: "no name"
+  }
+)
+
+# add in some stories
+FindApp.template(:story).merge(
+  name: "Charlotte and the Penguin Exhibit",
+  text: %(Charlotte was a computer hacker. Legendary in the scene. She was one of the few people ever to find an SSH vulnerability. Of course, being a girl she was often ignored by the other hackers, which usually worked out to her advantage. And so begins the tale of Charlotte's Big Hack. It was a sunny friday evening in antarctica, where the days are pitch black and the nights are bright as snow. Charlotte was just getting back from a whale riding expedition when she heard the familliar sound of digitized raindrops falling on sheets of glass. Someone was sending her a message!
+
+She ran inside, throwing her big wooly coat away rushing to her computer. Dit dit dit! Each letter suspensfully appeared on her screen. "Wake up neo...". "Blargh" she announced. "This looser keeps bugging me, and I don't even know who this Neo guy is!"
+
+After carefully typing in a sentence so masterfully cutting it best not be repeated, she sighed and flopped back on her fluffy bed with a squeak.
+
+...
+  )
+).commit!
+
+FindApp.template(:story).merge(
+  name: "The origin of life",
+  text: "The cats said let there be life, and so there was life, and it was good."
+).commit!
+
+FindApp.template(:story).merge(
+  name: "Dearest Fiona",
+  text: "Dearest Fiona,
+
+Mary Pebblesworth was an unusual child. Born of parents who fled to Siam, escaping conscription in The Great War. She was never the same after returning. Insisting on eating the most horrifying of foods. Thought to be unwell from the stress of her childhood. Something unusual occurred with this patient. When placed under the care of Sir Pennyworth's Halfway House, it was noted several of her peers began craving and demanding these terrible concoctions just as she had.
+
+At first it was thought there were some terrible joke being played, however it soon became clear we were dealing with the beginnings of a truly terrifying disease on par with childhood legends of African Zombies craving flesh and brain! In a panic Mary was brought by carriage to our estate and provided a room. We were all terribly careful of the risk of infection, and thankfully, we were fine this night.
+
+Two weeks and three days in to my investigation, I foolishly decided on an experiment. I provided the woman with the fishes she had requested, along with exotic beans at no short expense. Carefully observing her 'cooking', so convinced of my immunity to her infectiveity, I witnessed her truly horrifying ritual. Whole fish liquefied before my very eyes, exotic beans ground to a seemingly worthless paste, then set as if by witchcraft in to what I can only describe as cheese. The smells, oh-how they defy words...
+
+We couldn't help ourselves.
+
+I'm terribly sorry.
+
+Yours Faithfully,
+Joseph South"
+).commit!
+
+# brightens text in terminals which do ANSI codes
+def highlight text
+  color_code = 7
+  "\e[#{color_code}m#{text}\e[0m"
+end
+
+
+# find a story with the word 'it' in it, or a word you specify when calling
+# the program
+if ARGV.empty?
+  print "Search: "
+  words = gets.split(/[^a-z0-9']+/i)
+  raise "No words entered" if words.empty?
+else
+  words = ARGV
+end
+
+puts "Searching for #{ words.map { |w| highlight(w.capitalize) }.join ' ' }:\n\n"
+
+stories = []
+
+# lookup each word and add the stories to our collection
+first_word = true
+words.each do |word|
+  # you could make this faster by doing a single request using 'keys' instead
+  # of looping through each word doing a bunch of queries.
+  found = FindApp.design(:search).query(:words, key: word.downcase, include_docs: true)
+  
+  if first_word
+    stories += found.docs # add all the stories we found
+  else
+    stories &= found.docs # remove stories which don't also have this word!
+  end
+  
+  first_word = false # done being the first word now.
+end
+
+stories.uniq.each do |story|
+  puts "{ #{story.name.upcase} }".center(`tput cols`.to_i, '~')
+  
+  text = story.text
+  # create a regexp which finds any of the words we're after
+  searcher = Regexp.new("\\b(#{words.map { |word| Regexp.escape(word)}.join('|')})\\b", 'i')
+  text.gsub!(searcher) { |found| highlight(found) } # underline all the search words
+  
+  # underline all the search words
+  puts text
+  puts "\n\n" # blank lines
+end
+
+puts "[ SEARCH FINISHED ]".center(`tput cols`.to_i, '=')

data/examples/kittens-app.rb

@@ -0,0 +1,48 @@
+require '../lib/chill.rb'
+require 'pp'
+
+# make a database or connect to one
+ChillDB.goes :KittensApp
+
+# delete everything and start fresh
+KittensApp.everything.delete!
+
+# add a template (just in ruby instance)
+KittensApp.templates(
+  cat: {
+    color: 'invisible',
+    softness: 5,
+    likes: %w{water food flying spaceships sunlight tictacs hugs exploding},
+    dislikes: %w{mysql}
+  }
+)
+
+# add a view
+KittensApp.design(:lists).views(
+  soft_cats: 'function(doc) {
+    if (doc.kind == "cat" && doc.softness > 1) emit(doc._id, null);
+  }'
+).commit!
+
+# add kittens
+KittensApp.template(:cat).merge(_id: 'fredrick', softness: 16, dislikes: ['silly business']).commit!
+KittensApp.template(:cat).merge(_id: 'bobby', softness: 2, dislikes: ['mice']).commit!
+KittensApp.template(:cat).merge(_id: 'cheezly', softness: 1, dislikes: ['soy cheese products']).commit!
+
+# use the view to get a list of non-hard cats
+puts "Kitten Database lookup - soft cats:"
+soft_ones = KittensApp.design(:lists).query(:soft_cats, include_docs: true)
+soft_ones.docs.each do |cat|
+  puts "#{cat['_id']} is #{cat['softness']} soft"
+end
+
+# just load fredrick
+fredrick = KittensApp['fredrick']
+puts "Fredrick's stats:"
+fredrick.each do |item, value|
+  puts "#{item.rjust(10)}- #{value}"
+end
+
+# get the nonsoft cats the slow way - in ruby instead of with a view
+nonsofties = (KittensApp.everything.docs - soft_ones.docs).select { |i| i['kind'] == 'cat' }
+puts "Nonsoft cats: #{nonsofties.map { |cat| cat['_id'] }.join(', ')}"

data/{library → lib}/chill.rb

@@ -1,7 +1,9 @@
 # Bluebie's silly little CouchDB abstraction
-require 'json'
-require 'uuid'
-require 'rest-client'
+#
+#   :include:../readme.txt
+require 'json' # gem dependancy
+require 'rest-client' # gem dependancy
+require 'securerandom'
 require 'uri'
 
 # The main ChillDB module - This is where it all starts
@@ -28,10 +30,23 @@ module ChillDB
   #   # load 'frederick' from the KittensApp database
   #   # on the locally installed couch server
   #   KittensApp['frederick'] #=> <ChillDB::Document>
-  def self.goes database_name, *args
+  #
+  # Options:
+  #   user: 'couchdb_user'
+  #   pass: 'couchdb_password'
+  #   host: 'my-couch-server.com'
+  #   port: 5984
+  #   path: '/my-database/'
+  #
+  # Default options: ChillDB connects to
+  # http://localhost:5984/db-name-hyphenated/. When couch is freshly
+  # installed on a server, defaults will will work without any extra setup.
+  # You might want to add authentication if your server has multiple users,
+  # or you maybe allowing remote web access to couchdb.
+  def self.goes database_name, options = {}
     submod = Module.new do
       extend ChillDB
-      @@database = ChillDB::Database.new database_name, *args
+      @@database = ChillDB::Database.new database_name, options
       @@templates = {}
     end
     self.constants(false).each do |const|
@@ -85,8 +100,21 @@ module ChillDB
   end
 
   # Loads or creates a document with a specified _id. If no _id is specified
-  # a new blank document is created which will be assigned a fresh UUID as
-  # it's _id when saved unless you specify one before committing it.
+  # a new blank document is created which will be assigned a fresh UUID when
+  # unless you specify one before committing it. You can optionally provide values
+  # for a new document as a hash argument. Note that documents created in this
+  # way are not saved to the database unless you use ChillDB::Document#commit!
+  # or pass them to #commit!
+  #
+  # Example:
+  #   KittensApp['fredrick']
+  #     #=> {"_id"=>"cheezly", "color"=>"invisible", "dislikes"=>["silly business"], ... }
+  #   KittensApp[['fredrick', 'cheezly']] 
+  #     #=> [{"_id"=>"fredrick", ... }, {"_id"=>"cheezly", ... }]
+  #   KittensApp[]
+  #     #=> {}
+  #   KittensApp[billy: 'cool', margret: 'not cool']
+  #     #=> {"billy"=>"cool", "margret"=>"not cool", "_id"=>"df2c3d11-d50a-4db9-8f57-04fd4d511ded"}
   #
   # Returns a ChillDB::Document
   def document id = false
@@ -96,7 +124,9 @@ module ChillDB
       ChillDB::List.load(JSON.parse(response), database: @@database)
     elsif id.respond_to? :to_str
       ChillDB::Document.load(@@database, id.to_str)
-    else
+    elsif id.respond_to? :to_hash
+      ChillDB::Document.new(@@database).reset(id)
+    else # just make a new blank document
       ChillDB::Document.new(@@database)
     end
   end
@@ -126,7 +156,7 @@ module ChillDB
   # time. All documents which can be committed will be, and any which cause
   # errors will be reported via a raised ChillDB::BulkUpdateErrors.
   def commit! *documents
-    list(documents.flatten).commit!
+    list(documents.map { |arg| arg.respond_to?(:docs)? arg.docs : arg }.flatten(1)).commit!
   end
   
   # A shortcut for #commit! which marks the documents for deletion before
@@ -134,7 +164,7 @@ module ChillDB
   # a ChillDB::BulkUpdateErrors will be raised with info. All deletions which
   # can succeed, will.
   def delete! *documents
-    list(documents.flatten).delete!
+    list(documents.map { |arg| arg.respond_to?(:docs)? arg.docs : arg }.flatten(1)).delete!
   end
   
   # creates a new ChillDB::List from an array of ChillDB::Documents and
@@ -197,11 +227,15 @@ class ChillDB::Database
   # ChillDB.goes, and shouldn't be used directly
   def initialize name, settings = {} # :nodoc:
     @meta = {} # little place to store our things
+    # a magical constant you can define to change the defaults for magical web hosting
+    # where the web server wants to configure an app's chill connection details
+    # dynamically without bothering the user with such things
+    settings = ChillDBConnectionDefaults.merge(settings) if Kernel.const_defined? :ChillDBConnectionDefaults
     @url = URI::HTTP.build(
       host: settings[:host] || 'localhost',
       port: settings[:port] || 5984,
       userinfo: [settings[:user], settings[:pass]],
-      path: "/#{URI.escape hyphenate(name)}/"
+      path: settings[:path] || "/#{settings[:database_name_prefix]}#{URI.escape hyphenate(name)}/"
     )
     
     # make this database if it doesn't exist yet
@@ -357,7 +391,8 @@ class ChillDB::Document < ChillDB::IndifferentHash
   def reset values
     raise "Argument must be a Hash" unless values.respond_to? :to_hash
     self.replace values.to_hash
-    self['_id'] ||= UUID.new.generate # generate an _id if we don't have one already
+    self['_id'] ||= SecureRandom.uuid # generate an _id if we don't have one already
+    self
   end
   
   # load a documet from a ChillDB::Database, with a specific document id, and
@@ -509,9 +544,9 @@ class ChillDB::List < Array
   # to make a list from a simple array (not a couchdb response...)
   def self.from_array array # :nodoc:
     new_list = self.new
-    new_list.replace array.map do |item|
-      { 'id'=> item['_id'], 'key'=> item['_id'], 'value'=> item, 'doc'=> item }
-    end
+    new_list.replace(array.map { |item|
+      { 'id'=> item['_id'] || item[:_id], 'key'=> item['_id'] || item[:_id], 'value'=> item, 'doc'=> item }
+    })
   end
   
   # store rows nicely in mah belleh
@@ -653,11 +688,21 @@ class ChillDB::List < Array
   # get the list, with any non-ChillDB::Document's converted in to those
   def convert
     map do |item|
-      document = item['doc'] || item['value']
+      if item['doc']
+        document = item['doc']
+      elsif item['id']
+        document = { _id: item['id'] }
+        revision = item['value']['rev'] || item['value']['_rev']
+        document['_rev'] ||= revision if revision
+      else
+        raise "Couldn't find _id for document in list #{item.inspect}"
+      end
+      
       if document.is_a? ChillDB::Document
         document
       elsif document.respond_to? :to_hash
-        document['_rev'] ||= item['value']['_rev'] || item['value']['rev'] || item['doc']['_rev']
+        revision = item['value']['_rev'] || item['value']['rev'] || item['doc']['_rev']
+        document['_rev'] ||= revision if revision
         document = ChillDB::Document.new(@database, document.to_hash)
       else
         raise "Cannot convert #{document.inspect}"
@@ -667,7 +712,9 @@ class ChillDB::List < Array
   
   # commit an array of documents to the server
   def commit_documents! documents
-    response = @database.http('_bulk_docs').post(JSON.generate(docs: documents.to_a))
+    return if documents.empty?
+    body = JSON.generate(docs: documents.to_a)
+    response = @database.http('_bulk_docs').post(body)
     raise response.body unless (200..299).include? response.code
     json = JSON.parse(response.body)
     errors = []
@@ -675,6 +722,7 @@ class ChillDB::List < Array
     documents.each_index do |index|
       self[index]['id'] = json[index]['id']
       self[index]['value']['rev'] = json[index]['rev'] if json[index]['rev']
+      self[index]['doc']['_rev'] = json[index]['rev'] if json[index]['rev'] and self[index]['doc']
       errors.push [self[index], json[index]] if json[index]['error']
     end
     

data/license.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012, Jenna Fox
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the chilldb nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/readme.txt

@@ -0,0 +1,61 @@
+.oOo. .oOo. .oOo. chill .oOo. .oOo. .oOo.
+
+chill plugs ruby code in to CouchDB
+
+
+~~~ USAGE ~~~
+require 'pp'
+require 'chill'
+
+# make a database or connect to one
+ChillDB.goes :KittensApp
+
+# add a template (just in ruby instance)
+KittensApp.templates(
+  cat: {
+    color: 'invisible',
+    softness: 5,
+    likes: %w{water food flying spaceships sunlight tictacs hugs exploding},
+    dislikes: %w{mysql}
+  }
+)
+
+# get a copy of a template, change some things, and save it
+KittensApp.template(:cat).merge(
+  color: 'green',
+  softness: 8,
+  dislikes: %w{stylesheets},
+  _id: 'fredrick'
+)
+
+# add a view
+KittensApp.design(:lists).views(
+  soft_cats: 'function(doc) {
+    if (doc.kind == "cat" && doc.softness > 1) emit(doc._id, null);
+  }'
+).commit!
+
+# add a kitten
+KittensApp.template(:cat).merge(
+  _id: 'fredrick',
+  softness: 16,
+  dislikes: ['silly business']
+).commit!
+
+# use the view to get a list of non-hard cats
+soft_ones = KittensApp.design(:lists).query(:soft_cats)
+soft_ones.each do |cat|
+  pp cat
+end
+
+# just load fredrick
+fredrick = KittensApp['fredrick']
+
+
+~~~ MORE INFORMATION THAN YOU REQUIRE ~~~
+You can see a more fully baked version of the KittensApp database in
+examples/kittens-app.rb. There you will see how to do all sorts of things.
+It's the start of a really great kitten database you could use to keep
+track of your cats. It's web scale and cloud ready.
+
+                                                          --- <3 Bluebie

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chill
 version: !ruby/object:Gem::Version
-  version: '8'
+  version: 8.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.7
-- !ruby/object:Gem::Dependency
-  name: uuid
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.4
 description: A little library to talk to a couchdb. I made it skinny, because couchdb
   is very simple. I think that's a good thing.
 email: a@creativepony.com
@@ -66,13 +50,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- library/chill.rb
-homepage: http://github.com/Bluebie/chill
+- lib/chill.rb
+- readme.txt
+- license.txt
+- examples/benchmark.rb
+- examples/bulk-commit.rb
+- examples/find-app.rb
+- examples/kittens-app.rb
+homepage: http://creativepony.com/chill/
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- lib/chill.rb
 require_paths:
-- library
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements: