juozasg-couchrest 0.10.1

data/spec/couchrest/helpers/file_manager_spec.rb

@@ -0,0 +1,203 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe CouchRest::FileManager do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+  end
+  it "should initialize" do
+    @fm = CouchRest::FileManager.new(TESTDB)
+    @fm.should_not be_nil
+  end
+  it "should require a db name" do
+    lambda{CouchRest::FileManager.new}.should raise_error
+  end
+  it "should accept a db name" do
+    @fm = CouchRest::FileManager.new(TESTDB, 'http://localhost')
+    @fm.db.name.should == TESTDB
+  end
+  it "should default to localhost couchdb" do
+    @fm = CouchRest::FileManager.new(TESTDB)
+    @fm.db.host.should == 'http://localhost:5984'
+  end
+end
+
+describe CouchRest::FileManager, "generating an app" do
+  before(:all) do
+    @appdir = FIXTURE_PATH + '/couchapp'
+    `rm -rf #{@appdir}`
+    `mkdir -p #{@appdir}`
+    CouchRest::FileManager.generate_app(@appdir)
+  end
+  it "should create an attachments directory" do
+    Dir["#{@appdir}/*"].select{|x|x =~ /attachments/}.length.should == 1  
+  end
+  it "should create a views directory" do
+    Dir["#{@appdir}/*"].select{|x|x =~ /views/}.length.should == 1  
+  end
+  it "should create a foo directory" do
+    Dir["#{@appdir}/*"].select{|x|x =~ /foo/}.length.should == 1  
+  end
+  it "should create index.html" do
+    html = File.open("#{@appdir}/_attachments/index.html").read
+    html.should match(/DOCTYPE/)
+  end
+  it "should create bar.txt" do
+    html = File.open("#{@appdir}/foo/bar.txt").read
+    html.should match(/Couchapp will/)
+  end
+  it "should create an example view" do
+    map = File.open("#{@appdir}/views/example-map.js").read
+    map.should match(/function\(doc\)/)
+    reduce = File.open("#{@appdir}/views/example-reduce.js").read
+    reduce.should match(/rereduce/)
+  end
+end
+
+describe CouchRest::FileManager, "pushing an app" do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    
+    @appdir = FIXTURE_PATH + '/couchapp'
+    `rm -rf #{@appdir}`
+    `mkdir -p #{@appdir}`
+    CouchRest::FileManager.generate_app(@appdir)
+
+    @fm = CouchRest::FileManager.new(TESTDB, COUCHHOST)
+    r = @fm.push_app(@appdir, "couchapp")
+  end
+  it "should create a design document" do
+    lambda{@db.get("_design/couchapp")}.should_not raise_error
+  end
+  it "should create the views" do
+    doc = @db.get("_design/couchapp")
+    doc['views']['example']['map'].should match(/function/)
+  end
+  it "should create the index" do
+    doc = @db.get("_design/couchapp")
+    doc['_attachments']['index.html']["content_type"].should == 'text/html'
+  end
+  it "should push bar.txt and pals" do
+    File.open("#{@appdir}/foo/test.json",'w') do |f|
+      f.write("[1,2,3,4]")
+    end
+    r = @fm.push_app(@appdir, "couchapp")
+    doc = @db.get("_design/couchapp")
+    doc["foo"].should_not be_nil
+    doc["foo"]["bar"].should include("Couchapp will")
+    doc["foo"]["test"].should == [1,2,3,4]
+  end
+  it "should push json as json" do
+    File.open("#{@appdir}/test.json",'w') do |f|
+      f.write("[1,2,3,4]")
+    end
+    r = @fm.push_app(@appdir, "couchapp")
+    doc = @db.get("_design/couchapp")
+    doc['test'].should == [1,2,3,4]
+  end
+  it "should apply keys from doc.json directly to the doc" do
+    File.open("#{@appdir}/doc.json",'w') do |f|
+      f.write('{"magical":"so magic"}')
+    end
+    r = @fm.push_app(@appdir, "couchapp")
+    doc = @db.get("_design/couchapp")
+    doc['magical'].should == "so magic"
+  end
+end
+
+
+describe CouchRest::FileManager, "pushing views" do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    
+    @fm = CouchRest::FileManager.new(TESTDB, COUCHHOST)
+    @view_dir = FIXTURE_PATH + '/views'
+    ds = @fm.push_views(@view_dir)
+    @design = @db.get("_design/test_view")
+  end
+  it "should create a design document for each folder" do
+    @design["views"].should_not be_nil
+  end
+  it "should push a map and reduce view" do
+    @design["views"]["test-map"].should_not be_nil
+    @design["views"]["test-reduce"].should_not be_nil
+  end
+  it "should push a map only view" do
+    @design["views"]["only-map"].should_not be_nil
+    @design["views"]["only-reduce"].should be_nil
+  end
+  it "should include library files" do
+    @design["views"]["only-map"]["map"].should include("globalLib")
+    @design["views"]["only-map"]["map"].should include("justThisView")
+  end
+  it "should not create extra design docs" do
+    docs = @db.documents(:startkey => '_design', :endkey => '_design/ZZZZZZ')
+    docs['total_rows'].should == 1
+  end
+end
+
+describe CouchRest::FileManager, "pushing a directory with id" do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    
+    @fm = CouchRest::FileManager.new(TESTDB, COUCHHOST)
+    @push_dir = FIXTURE_PATH + '/attachments'
+    ds = @fm.push_directory(@push_dir, 'attached')
+  end
+  it "should create a document for the folder" do
+    @db.get("attached")
+  end
+  it "should make attachments" do
+    doc = @db.get("attached")
+    doc["_attachments"]["test.html"].should_not be_nil
+  end
+  it "should set the content type" do
+    doc = @db.get("attached")
+    doc["_attachments"]["test.html"]["content_type"].should == "text/html"
+  end
+end
+
+describe CouchRest::FileManager, "pushing a directory without id" do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    
+    @fm = CouchRest::FileManager.new(TESTDB, COUCHHOST)
+    @push_dir = FIXTURE_PATH + '/attachments'
+    ds = @fm.push_directory(@push_dir)
+  end
+  it "should use the dirname" do
+    doc = @db.get("attachments")
+    doc["_attachments"]["test.html"].should_not be_nil
+  end
+end
+
+describe CouchRest::FileManager, "pushing a directory/ without id" do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    
+    @fm = CouchRest::FileManager.new(TESTDB, COUCHHOST)
+    @push_dir = FIXTURE_PATH + '/attachments/'
+    ds = @fm.push_directory(@push_dir)
+  end
+  it "should use the dirname" do
+    doc = @db.get("attachments")
+    doc["_attachments"]["test.html"].should_not be_nil
+  end
+end

data/spec/couchrest/helpers/pager_spec.rb

@@ -0,0 +1,122 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe CouchRest::Pager do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    @pager = CouchRest::Pager.new(@db)
+  end
+  
+  after(:all) do
+    begin
+      @db.delete!
+    rescue RestClient::Request::RequestFailed
+    end
+  end
+  
+  it "should store the db" do
+    @pager.db.should == @db
+  end
+  
+  describe "paging all docs" do
+    before(:all) do
+      @docs = []
+      100.times do |i|
+        @docs << ({:number => (i % 10)})
+      end
+      @db.bulk_save(@docs)
+    end
+    it "should yield total_docs / count times" do
+      n = 0
+      @pager.all_docs(10) do |doc|
+        n += 1
+      end
+      n.should == 10
+    end
+    it "should yield each docrow group without duplicate docs" do
+      docids = {}
+      @pager.all_docs(10) do |docrows|
+        docrows.each do |row|
+          docids[row['id']].should be_nil
+          docids[row['id']] = true
+        end
+      end      
+      docids.keys.length.should == 100
+    end
+    it "should yield each docrow group" do
+      @pager.all_docs(10) do |docrows|
+        doc = @db.get(docrows[0]['id'])
+        doc['number'].class.should == Fixnum
+      end      
+    end
+  end
+  
+  describe "Pager with a view and docs" do
+    before(:all) do
+      @docs = []
+      100.times do |i|
+        @docs << ({:number => (i % 10)})
+      end
+      @db.bulk_save(@docs)
+      @db.save({
+        '_id' => '_design/magic',
+        'views' => {
+          'number' => {
+            'map' => 'function(doc){emit(doc.number,null)}'
+          }
+        }
+      })
+    end
+    
+    it "should have docs" do
+      @docs.length.should == 100
+      @db.documents['rows'].length.should == 101
+    end
+    
+    it "should have a view" do
+      @db.view('magic/number', :count => 10)['rows'][0]['key'].should == 0
+    end
+    
+    it "should yield once per key" do
+      results = {}
+      @pager.key_reduce('magic/number', 20) do |k,vs|
+        results[k] = vs.length
+      end
+      results[0].should == 10
+      results[3].should == 10
+    end
+    
+    it "with a small step size should yield once per key" do
+      results = {}
+      @pager.key_reduce('magic/number', 7) do |k,vs|
+        results[k] = vs.length
+      end
+      results[0].should == 10
+      results[3].should == 10
+      results[9].should == 10
+    end
+    it "with a large step size should yield once per key" do
+      results = {}
+      @pager.key_reduce('magic/number', 1000) do |k,vs|
+        results[k] = vs.length
+      end
+      results[0].should == 10
+      results[3].should == 10
+      results[9].should == 10
+    end
+    it "with a begin and end should only yield in the range (and leave out the lastkey)" do
+      results = {}
+      @pager.key_reduce('magic/number', 1000, 4, 7) do |k,vs|
+        results[k] = vs.length
+      end
+      results[0].should be_nil
+      results[4].should == 10
+      results[6].should == 10
+      results[7].should be_nil
+      results[8].should be_nil
+      results[9].should be_nil
+    end
+  end
+end

data/spec/couchrest/helpers/streamer_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe CouchRest::Streamer do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    @streamer = CouchRest::Streamer.new(@db)
+    @docs = (1..1000).collect{|i| {:integer => i, :string => i.to_s}}
+    @db.bulk_save(@docs)
+  end
+  
+  it "should yield each row in a view" do
+    count = 0
+    sum = 0
+    @streamer.view("_all_docs") do |row|
+      count += 1
+    end
+    count.should == 1001
+  end
+  
+end

data/spec/fixtures/attachments/test.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test</title>
+  </head>
+  <body>
+    <p>
+      Test
+    </p>
+  </body>
+</html>

data/spec/fixtures/views/lib.js

@@ -0,0 +1,3 @@
+function globalLib() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/lib.js

@@ -0,0 +1,3 @@
+function justThisView() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/only-map.js

@@ -0,0 +1,4 @@
+function(doc) {
+  //include-lib
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-map.js

@@ -0,0 +1,3 @@
+function(doc) {
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-reduce.js

@@ -0,0 +1,3 @@
+function(ks,vs,co) {
+  return vs.length;
+};

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../lib/couchrest'
+
+FIXTURE_PATH = File.dirname(__FILE__) + '/fixtures'
+
+COUCHHOST = "http://localhost:5984"
+TESTDB = 'couchrest-test'
+
+def reset_test_db!
+  cr = CouchRest.new(COUCHHOST)
+  db = cr.database(TESTDB)
+  db.delete! rescue nil
+  db = cr.create_db(TESTDB) rescue nin
+  db
+end

data/utils/remap.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'couchrest'
+
+# set the source db and map view
+source = CouchRest.new("http://localhost:5984").database('source-db')
+source_view = 'mydesign/view-map'
+
+# set the target db
+target = CouchRest.new("http://localhost:5984").database('target-db')
+
+
+pager = CouchRest::Pager.new(source)
+
+# pager will yield once per uniq key in the source view
+
+pager.key_reduce(source_view, 10000) do |key, values|
+  # create a doc from the key and the values
+  example_doc = {
+    :key => key,
+    :values => values.uniq
+  }
+
+  target.save(example_doc)
+  
+  # keep us up to date with progress
+  puts k if (rand > 0.9)
+end

data/utils/subset.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'couchrest'
+
+# subset.rb replicates a percentage of a database to a fresh database.
+# use it to create a smaller dataset on which to prototype views.
+
+# specify the source database
+source = CouchRest.new("http://localhost:5984").database('source-db')
+
+# specify the target database
+target = CouchRest.new("http://localhost:5984").database('target-db')
+
+# pager efficiently yields all view rows
+pager = CouchRest::Pager.new(source)
+
+pager.all_docs(1000) do |rows|  
+  docs = rows.collect do |r|
+    # the percentage of docs to clone
+    next if rand > 0.1 
+    doc = source.get(r['id'])
+    doc.delete('_rev')
+    doc      
+  end.compact
+  puts docs.length
+  next if docs.empty?
+
+  puts docs.first['_id']
+  target.bulk_save(docs)
+end
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: juozasg-couchrest
+version: !ruby/object:Gem::Version 
+  version: 0.10.1
+platform: ruby
+authors: 
+- J. Chris Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+description: CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.
+email: jchris@grabb.it
+executables: 
+- couchview
+- couchdir
+- couchapp
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- THANKS
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- THANKS
+- bin/couchapp
+- bin/couchdir
+- bin/couchview
+- examples/model
+- examples/model/example.rb
+- examples/word_count
+- examples/word_count/markov
+- examples/word_count/views
+- examples/word_count/views/books
+- examples/word_count/views/books/chunked-map.js
+- examples/word_count/views/books/united-map.js
+- examples/word_count/views/markov
+- examples/word_count/views/markov/chain-map.js
+- examples/word_count/views/markov/chain-reduce.js
+- examples/word_count/views/word_count
+- examples/word_count/views/word_count/count-map.js
+- examples/word_count/views/word_count/count-reduce.js
+- examples/word_count/word_count.rb
+- examples/word_count/word_count_query.rb
+- lib/couchrest
+- lib/couchrest/commands
+- lib/couchrest/commands/generate.rb
+- lib/couchrest/commands/push.rb
+- lib/couchrest/core
+- lib/couchrest/core/database.rb
+- lib/couchrest/core/design.rb
+- lib/couchrest/core/document.rb
+- lib/couchrest/core/model.rb
+- lib/couchrest/core/server.rb
+- lib/couchrest/core/view.rb
+- lib/couchrest/helper
+- lib/couchrest/helper/file_manager.rb
+- lib/couchrest/helper/pager.rb
+- lib/couchrest/helper/streamer.rb
+- lib/couchrest/helper/templates
+- lib/couchrest/helper/templates/bar.txt
+- lib/couchrest/helper/templates/example-map.js
+- lib/couchrest/helper/templates/example-reduce.js
+- lib/couchrest/helper/templates/index.html
+- lib/couchrest/monkeypatches.rb
+- lib/couchrest.rb
+- spec/couchapp_spec.rb
+- spec/couchrest
+- spec/couchrest/core
+- spec/couchrest/core/couchrest_spec.rb
+- spec/couchrest/core/database_spec.rb
+- spec/couchrest/core/design_spec.rb
+- spec/couchrest/core/document_spec.rb
+- spec/couchrest/core/model_spec.rb
+- spec/couchrest/helpers
+- spec/couchrest/helpers/file_manager_spec.rb
+- spec/couchrest/helpers/pager_spec.rb
+- spec/couchrest/helpers/streamer_spec.rb
+- spec/fixtures
+- spec/fixtures/attachments
+- spec/fixtures/attachments/couchdb.png
+- spec/fixtures/attachments/test.html
+- spec/fixtures/views
+- spec/fixtures/views/lib.js
+- spec/fixtures/views/test_view
+- spec/fixtures/views/test_view/lib.js
+- spec/fixtures/views/test_view/only-map.js
+- spec/fixtures/views/test_view/test-map.js
+- spec/fixtures/views/test_view/test-reduce.js
+- spec/spec.opts
+- spec/spec_helper.rb
+- utils/remap.rb
+- utils/subset.rb
+has_rdoc: "true"
+homepage: http://github.com/jchris/couchrest
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Lean and RESTful interface to CouchDB.
+test_files: []
+