jchris-couchrest 0.2.2 → 0.7.99

data/THANKS.md

@@ -1,18 +0,0 @@
-CouchRest THANKS
-=====================
-
-CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
-and a number of other contributors. Many people further contributed to 
-CouchRest by reporting problems, suggesting various improvements or submitting
-changes. A list of these people is included below.
-
- * [Matt Aimonetti](http://merbist.com/about/)
- * [Greg Borenstein](http://ideasfordozens.com)
- * [Geoffrey Grosenbach](http://nubyonrails.com/)
- * [Jonathan S. Katz](http://github.com/jkatz)
- * [Matt Lyon](http://mattly.tumblr.com/)
- * Simon Rozet (simon /at/ rozet /dot/ name)
- 
-Patches are welcome. The primary source for this software project is [on Github](http://github.com/jchris/couchrest/tree/master)
-
-A lot of people have active forks - thank you all - even the patches I don't end up using are helpful.

data/examples/model/example.rb

@@ -1,144 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'couchrest')
-
-def show obj
-  puts obj.inspect
-  puts
-end
-
-SERVER = CouchRest.new
-SERVER.default_database = 'couchrest-extendeddoc-example'
-
-class Author < CouchRest::ExtendedDocument
-  use_database SERVER.default_database
-  property :name
-  
-  def drink_scotch
-    puts "... glug type glug ... I'm #{name} ... type glug glug ..."
-  end
-end
-
-class Post < CouchRest::ExtendedDocument
-  use_database SERVER.default_database
-  
-  property :title
-  property :body
-  property :author, :cast_as => 'Author'
-
-  timestamps!
-end
-
-class Comment < CouchRest::ExtendedDocument
-  use_database SERVER.default_database
-  
-  property :commenter, :cast_as => 'Author'
-  timestamps!
-  
-  def post= post
-    self["post_id"] = post.id
-  end
-  def post
-    Post.get(self['post_id']) if self['post_id']
-  end
-  
-end
-
-puts "Act I: CRUD"
-puts
-puts "(pause for dramatic effect)"
-puts
-sleep 2
-
-puts "Create an author."
-quentin = Author.new("name" => "Quentin Hazel")
-show quentin
-
-puts "Create a new post."
-post = Post.new(:title => "First Post", :body => "Lorem ipsum dolor sit amet, consectetur adipisicing elit...")
-show post
-
-puts "Add the author to the post."
-post.author = quentin
-show post
-
-puts "Save the post."
-post.save
-show post
-
-puts "Load the post."
-reloaded = Post.get(post.id)
-show reloaded
-
-puts "The author of the post is an instance of Author."
-reloaded.author.drink_scotch
-
-puts "\nAdd some comments to the post."
-comment_one = Comment.new :text => "Blah blah blah", :commenter => {:name => "Joe Sixpack"}
-comment_two = Comment.new :text => "Yeah yeah yeah", :commenter => {:name => "Jane Doe"}
-comment_three = Comment.new :text => "Whatever...", :commenter => {:name => "John Stewart"}
-
-# TODO - maybe add some magic here?
-comment_one.post = post
-comment_two.post = post
-comment_three.post = post
-comment_one.save
-comment_two.save
-comment_three.save
-
-show comment_one
-show comment_two
-show comment_three
-
-puts "We can load a post through its comment (no magic here)."
-show post = comment_one.post
-
-puts "Commenters are also authors."
-comment_two['commenter'].drink_scotch
-comment_one['commenter'].drink_scotch
-comment_three['commenter'].drink_scotch
-
-puts "\nLet's save an author to her own document."
-jane = comment_two['commenter']
-jane.save
-show jane
-
-puts "Oh, that's neat! Because Ruby passes hash valuee by reference, Jane's new id has been added to the comment she left."
-show comment_two
-
-puts "Of course, we'd better remember to save it."
-comment_two.save
-show comment_two
-
-puts "Oooh, denormalized... feel the burn!"
-puts
-puts
-puts
-puts "Act II: Views"
-puts
-puts
-sleep 2
-
-puts "Let's find all the comments that go with our post."
-puts "Our post has id #{post.id}, so lets find all the comments with that post_id."
-puts
-
-class Comment
-  view_by :post_id
-end
-
-comments = Comment.by_post_id :key => post.id
-show comments
-
-puts "That was too easy."
-puts "We can even wrap it up in a finder on the Post class."
-puts
-
-class Post
-  def comments
-    Comment.by_post_id :key => id
-  end
-end
-
-show post.comments
-puts "Gimme 5 minutes and I'll roll this into the framework. ;)"
-puts
-puts "There is a lot more that can be done with views, but a lot of the interesting stuff is joins, which of course range across types. We'll pick up where we left off, next time."

data/examples/word_count/markov

@@ -1,38 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(File.dirname(__FILE__)) + '/../../couchrest'
-
-cr = CouchRest.new("http://127.0.0.1:5984")
-@db = cr.database('word-count-example')
-@word_memoizer = {}
-
-def probable_follower_for(word)
-  @word_memoizer[word] ||= @db.view('markov/chain-reduce', :startkey => [word,nil], :endkey => [word,{}],:group_level => 2)
-  
-  # puts
-  # puts "search #{word} #{wprobs[word]['rows'].length}"
-  # @word_memoizer[word]['rows'].sort_by{|r|r['value']}.each{|r|puts [r['value'],r['key']].inspect}
-  
-  rows = @word_memoizer[word]['rows'].select{|r|(r['key'][1]!='')}.sort_by{|r|r['value']}
-  row = rows[(-1*[rows.length,5].min)..-1].sort_by{rand}[0]
-  row ? row['key'][1] : nil
-end
-
-
-word = ARGV[0]
-words = [word]
-
-while word
-  $stdout.print ' ' if words.length > 1
-  $stdout.print word
-  $stdout.flush
-  word = probable_follower_for(word)
-  words << word
-end
-
-$stdout.print '.'
-$stdout.flush
-puts
-
-# `say #{words.join(' ')}`
-

data/examples/word_count/views/books/chunked-map.js

@@ -1,3 +0,0 @@
-function(doc) {
-  doc.title && doc.chunk && emit([doc.title, doc.chunk],null);
-}

data/examples/word_count/views/books/united-map.js

@@ -1 +0,0 @@
-function(doc){if(doc.text && doc.text.match(/united/))  emit([doc.title, doc.chunk],null)}

data/examples/word_count/views/markov/chain-map.js

@@ -1,6 +0,0 @@
-function(doc){
-  var words = doc.text.split(/\W/).filter(function(w) {return w.length > 0}).map(function(w){return w.toLowerCase()});
-  for (var i = 0, l = words.length; i < l; i++) {
-    emit(words.slice(i,4),doc.title);
-  }
-}

data/examples/word_count/views/markov/chain-reduce.js

@@ -1,7 +0,0 @@
-function(key,vs,c){
-  if (c) {
-    return sum(vs);
-  } else {
-    return vs.length;
-  }
-}

data/examples/word_count/views/word_count/count-map.js

@@ -1,6 +0,0 @@
-function(doc){
-  var words = doc.text.split(/\W/).map(function(w){return w.toLowerCase()});
-  words.forEach(function(word){
-    if (word.length > 0) emit([word,doc.title],1);
-  });
-}

data/examples/word_count/views/word_count/count-reduce.js

@@ -1,3 +0,0 @@
-function(key,values){
-  return sum(values);
-}

data/examples/word_count/word_count.rb

@@ -1,46 +0,0 @@
-require 'rubygems'
-require 'couchrest'
-
-couch = CouchRest.new("http://127.0.0.1:5984")
-db = couch.database('word-count-example')
-db.delete! rescue nil
-db = couch.create_db('word-count-example')
-
-books = {
-  'outline-of-science.txt' => 'http://www.gutenberg.org/files/20417/20417.txt',
-  'ulysses.txt' => 'http://www.gutenberg.org/dirs/etext03/ulyss12.txt',
-  'america.txt' => 'http://www.gutenberg.org/files/16960/16960.txt',
-  'da-vinci.txt' => 'http://www.gutenberg.org/dirs/etext04/7ldv110.txt'
-}
-
-books.each do |file, url|
-  pathfile = File.join(File.dirname(__FILE__),file)
-  `curl #{url} > #{pathfile}` unless File.exists?(pathfile)  
-end
-
-
-books.keys.each do |book|
-  title = book.split('.')[0]
-  puts title
-  File.open(File.join(File.dirname(__FILE__),book),'r') do |file|
-    lines = []
-    chunk = 0
-    while line = file.gets
-      lines << line
-      if lines.length > 10
-        db.save({
-          :title => title,
-          :chunk => chunk, 
-          :text => lines.join('')
-        })
-        chunk += 1
-        puts chunk
-        lines = []
-      end
-    end
-  end
-end
-
-# puts "The books have been stored in your CouchDB. To initiate the MapReduce process, visit http://127.0.0.1:5984/_utils/ in your browser and click 'word-count-example', then select view 'words' or 'count'. The process could take about 15 minutes on an average MacBook."
-
-

data/examples/word_count/word_count_query.rb

@@ -1,40 +0,0 @@
-require 'rubygems'
-require 'couchrest'
-
-couch = CouchRest.new("http://127.0.0.1:5984")
-db = couch.database('word-count-example')
-
-puts "Now that we've parsed all those books into CouchDB, the queries we can run are incredibly flexible."
-puts "\nThe simplest query we can run is the total word count for all words in all documents:"
-puts "this will take a few minutes the first time. if it times out, just rerun this script in a few few minutes."
-puts db.view('word_count/words').inspect
-
-puts "\nWe can also narrow the query down to just one word, across all documents. Here is the count for 'flight' in all three books:"
-
-word = 'flight'
-params = {
-  :startkey => [word], 
-  :endkey => [word,{}]
-  }
-
-puts db.view('word_count/words',params).inspect
-
-puts "\nWe scope the query using startkey and endkey params to take advantage of CouchDB's collation ordering. Here are the params for the last query:"
-puts params.inspect
-
-puts "\nWe can also count words on a per-title basis."
-
-title = 'da-vinci'
-params = {
-  :key => [word, title]
-  }
-  
-puts db.view('word_count/words',params).inspect
-
-
-puts "\nHere are the params for 'flight' in the da-vinci book:"
-puts params.inspect
-puts
-puts 'The url looks like this:'
-puts 'http://127.0.0.1:5984/word-count-example/_view/word_count/count?key=["flight","da-vinci"]'
-puts "\nTry dropping that in your browser..."

data/examples/word_count/word_count_views.rb

@@ -1,26 +0,0 @@
-require 'rubygems'
-require 'couchrest'
-
-couch = CouchRest.new("http://127.0.0.1:5984")
-db = couch.database('word-count-example')
-
-word_count = {
-  :map => 'function(doc){
-    var words = doc.text.split(/\W/);
-    words.forEach(function(word){
-      if (word.length > 0) emit([word,doc.title],1);
-    });
-  }',
-  :reduce => 'function(key,combine){
-    return sum(combine);
-  }'
-}
-
-db.delete db.get("_design/word_count") rescue nil
-
-db.save({
-  "_id" => "_design/word_count",
-  :views => {
-    :words => word_count
-  }
-})

data/lib/couchrest/commands/generate.rb

@@ -1,71 +0,0 @@
-require 'fileutils'
-
-module CouchRest
-  module Commands
-    module Generate
-
-      def self.run(options)
-        directory    = options[:directory]
-        design_names = options[:trailing_args]
-
-        FileUtils.mkdir_p(directory)
-        filename = File.join(directory, "lib.js")
-        self.write(filename, <<-FUNC)
-        // Put global functions here.
-        // Include in your views with
-        //
-        //   //include-lib
-        FUNC
-
-        design_names.each do |design_name|
-          subdirectory = File.join(directory, design_name)
-          FileUtils.mkdir_p(subdirectory)
-          filename = File.join(subdirectory, "sample-map.js")
-          self.write(filename, <<-FUNC)
-          function(doc) {
-            // Keys is first letter of _id
-            emit(doc._id[0], doc);
-          }
-          FUNC
-
-          filename = File.join(subdirectory, "sample-reduce.js")
-          self.write(filename, <<-FUNC)
-          function(keys, values) {
-            // Count the number of keys starting with this letter
-            return values.length;
-          }
-          FUNC
-
-          filename = File.join(subdirectory, "lib.js")
-          self.write(filename, <<-FUNC)
-          // Put functions specific to '#{design_name}' here.
-          // Include in your views with
-          //
-          //   //include-lib
-          FUNC
-        end
-      end
-
-      def self.help
-        helpstring = <<-GEN
-
-        Usage: couchview generate directory design1 design2 design3 ...
-
-        Couchview will create directories and example views for the design documents you specify.
-
-        GEN
-        helpstring.gsub(/^        /, '')
-      end
-
-      def self.write(filename, contents)
-        puts "Writing #{filename}"
-        File.open(filename, "w") do |f|
-          # Remove leading spaces
-          contents.gsub!(/^        (  )?/, '')
-          f.write contents
-        end
-      end
-
-    end
-  end
-end

data/lib/couchrest/commands/push.rb

@@ -1,103 +0,0 @@
-module CouchRest
-
-  module Commands
-
-    module Push
-
-      def self.run(options)
-        directory = options[:directory]
-        database  = options[:trailing_args].first
-        
-        fm      = CouchRest::FileManager.new(database)
-        fm.loud = options[:loud]
-
-        if options[:loud]
-          puts "Pushing views from directory #{directory} to database #{fm.db}"
-        end
-
-        fm.push_views(directory)
-      end
-
-      def self.help
-        helpstring = <<-GEN
-
-        == Pushing views with Couchview ==
-
-        Usage: couchview push directory dbname
-
-        Couchview expects a specific filesystem layout for your CouchDB views (see
-        example below). It also supports advanced features like inlining of library
-        code (so you can keep DRY) as well as avoiding unnecessary document
-        modification.
-
-        Couchview also solves a problem with CouchDB's view API, which only provides
-        access to the final reduce side of any views which have both a map and a
-        reduce function defined. The intermediate map results are often useful for
-        development and production. CouchDB is smart enough to reuse map indexes for
-        functions duplicated across views within the same design document.
-
-        For views with a reduce function defined, Couchview creates both a reduce view
-        and a map-only view, so that you can browse and query the map side as well as
-        the reduction, with no performance penalty.
-
-        == Example ==
-
-        couchview push foo-project/bar-views baz-database
-
-        This will push the views defined in foo-project/bar-views into a database
-        called baz-database. Couchview expects the views to be defined in files with
-        names like:
-
-        foo-project/bar-views/my-design/viewname-map.js
-        foo-project/bar-views/my-design/viewname-reduce.js
-        foo-project/bar-views/my-design/noreduce-map.js
-
-        Pushed to => http://127.0.0.1:5984/baz-database/_design/my-design
-
-        And the design document:
-        {
-          "views" : {
-            "viewname-map" : {
-              "map" : "### contents of view-name-map.js ###"
-            },
-            "viewname-reduce" : {
-              "map" : "### contents of view-name-map.js ###",
-              "reduce" : "### contents of view-name-reduce.js ###"
-            },
-            "noreduce-map" : {
-              "map" : "### contents of noreduce-map.js ###"
-            }
-          }
-        }
-
-        Couchview will create a design document for each subdirectory of the views
-        directory specified on the command line.
-
-        == Library Inlining ==
-
-        Couchview can optionally inline library code into your views so you only have
-        to maintain it in one place. It looks for any files named lib.* in your
-        design-doc directory (for doc specific libs) and in the parent views directory
-        (for project global libs). These libraries are only inserted into views which
-        include the text
-
-        // !include lib
-
-        or
-
-        # !include lib
-
-        Couchview is a result of scratching my own itch. I'd be happy to make it more
-        general, so please contact me at jchris@grabb.it if you'd like to see anything
-        added or changed.
-
-        GEN
-        helpstring.gsub(/^        /, '')
-      end
-
-    end
-
-
-  end
-
-end