jchris-couchrest 0.9.5 → 0.9.6

data/Rakefile

@@ -5,7 +5,7 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = "couchrest"
-  s.version = "0.9.5"
+  s.version = "0.9.7"
   s.date = "2008-09-11"
   s.summary = "Lean and RESTful interface to CouchDB."
   s.email = "jchris@grabb.it"
@@ -36,7 +36,6 @@ namespace :github do # thanks merb!
       next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
       if name == "dependencies"
         value.each do |d|
-          puts d.to_s
           dep, *ver = d.to_s.split(" ")
           result <<  "  s.add_dependency #{dep.inspect}, [#{ /\(([^\,]*)/ . match(ver.join(" "))[1].inspect}]\n"
         end

data/bin/couchapp

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/couchrest'
+
+options = {
+  :loud => true,
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #$0 [options] (push|pull|generate)"
+  opts.on('-q', '--quiet', "Omit extra debug info") do
+    options[:loud] = false
+  end
+  opts.on_tail('-h', '--help', "Display detailed help and exit") do
+    puts opts
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+case ARGV.shift
+when /generate/
+  appname = ARGV.shift
+  current = Dir.getwd 
+  appdir = File.join(current, appname)
+  puts "generating couchapp in #{appdir}"
+  CouchRest::FileManager.generate_app(appdir)
+  
+when /push/
+  dirname = ARGV.shift
+  if ARGV.length == 2
+    appname = ARGV.shift
+    dbstring = ARGV.shift
+  elsif ARGV.length == 1
+    appname = dirname
+    dbstring = ARGV.shift    
+  else
+    puts opts
+    puts "push dirname [appname] database"
+    exit(0)
+  end
+  dbspec = CouchRest.parse(dbstring)
+  fm = CouchRest::FileManager.new(dbspec[:database], dbspec[:host])
+  fm.push_app(dirname, appname)
+when /pull/
+
+else
+  puts opts
+  puts "please specify a command"
+end

data/lib/couchrest/helper/file_manager.rb

@@ -47,10 +47,12 @@ module CouchRest
         return
       end
 
+      doc["signatures"] ||= {}
+      doc["_attachments"] ||= {}
       # remove deleted docs
       to_be_removed = doc["signatures"].keys.select do |d| 
         !pushfiles.collect{|p| p.keys.first}.include?(d) 
-      end
+      end 
 
       to_be_removed.each do |p|
         say "deleting #{p}"
@@ -69,7 +71,6 @@ module CouchRest
           doc["_attachments"][path].delete("length")    
           doc["_attachments"][path]["data"] = @attachments[path]["data"]
           doc["_attachments"][path].merge!({"data" => @attachments[path]["data"]} )
-
         end
       end
 
@@ -185,9 +186,70 @@ module CouchRest
       
     end
     
+    def push_app(appdir, appname)
+      libs = []
+      viewdir = File.join(appdir,"views")
+      attachdir = File.join(appdir,"attachments")
+      views, lang = read_design_views(viewdir)
+      # attachments = read_attachments(attachdir)
+      docid = "_design/#{appname}"
+      design = @db.get(docid) rescue {}
+      design['_id'] = docid
+      design['views'] = views
+      design['language'] = lang
+      @db.save(design)
+      push_directory(attachdir, docid)
+      # puts views.inspect
+    end
+    
+    # Generate an application in the given directory.
+    # This is a class method because it doesn't depend on 
+    # specifying a database.
+    def self.generate_app(app_dir)
+      FileUtils.mkdir_p(app_dir)
+      FileUtils.mkdir_p(File.join(app_dir,"attachments"))      
+      FileUtils.mkdir_p(File.join(app_dir,"views"))
+      
+      index_template = File.join(File.expand_path(File.dirname(__FILE__)), 'templates','index.html')
+      index_dest = File.join(app_dir,"attachments","index.html")
+      FileUtils.cp(index_template, index_dest)
+      
+      map_template = File.join(File.expand_path(File.dirname(__FILE__)), 'templates','example-map.js')
+      map_dest = File.join(app_dir,"views","example-map.js")
+      FileUtils.cp(map_template, map_dest)
+      
+      rereduce_template = File.join(File.expand_path(File.dirname(__FILE__)), 'templates','example-reduce.js')
+      rereduce_dest = File.join(app_dir,"views","example-reduce.js")
+      FileUtils.cp(rereduce_template, rereduce_dest)
+    end
     
     private
     
+    def read_design_views(viewdir)
+      libs = []
+      language = nil
+      views = {}
+      Dir["#{viewdir}/*.*"].each do |viewfile|
+        view_parts = viewfile.split('/')
+        viewfile_name = view_parts.last
+        # example-map.js
+        viewfile_name_parts = viewfile_name.split('.')
+        viewfile_ext = viewfile_name_parts.last
+        view_name_parts = viewfile_name_parts.first.split('-')
+        func_type = view_name_parts.pop
+        view_name = view_name_parts.join('-')
+        contents = File.open(viewfile).read
+        if /^lib\..*$/.match viewfile_name
+          libs.push(contents)
+        else
+          views[view_name] ||= {}
+          language = LANGS[viewfile_ext]
+          views[view_name][func_type] = contents.sub(/(\/\/|#)include-lib/,libs.join("\n"))
+        end
+      end
+      [views, language]
+    end
+    
     def say words
       puts words if @loud
     end
@@ -206,7 +268,7 @@ module CouchRest
       existing = @db.get(id) rescue nil
 
       if existing
-        updated = fields.merge({"_id" => id, "_rev" => existing["_rev"]})
+        updated = existing.merge(fields)
         if existing != updated
           say "replacing #{id}"
           db.save(updated)

data/lib/couchrest/helper/templates/example-map.js

@@ -0,0 +1,8 @@
+// an example map function, emits the doc id 
+// and the list of keys it contains
+
+function(doc) {
+  var k, keys = []
+  for (k in doc) keys.push(k);
+  emit(doc._id, keys);
+};

data/lib/couchrest/helper/templates/example-reduce.js

@@ -0,0 +1,10 @@
+// example reduce function to count the
+// number of rows in a given key range.
+
+function(keys, value, rereduce) {
+  if (rereduce) {
+    return sum(values);
+  } else {
+    return values.length;
+  }
+};

data/lib/couchrest/helper/templates/index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Generated CouchApp</title>
+    <link rel="stylesheet" href="screen.css" type="text/css">
+  </head>
+  <body>
+    <h1>Generated CouchApp</h1>
+    <ul id="view"></ul>
+  </body>
+  <script src="/_utils/script/json2.js"></script>
+  <script src="/_utils/script/jquery.js?1.2.6"></script>
+  <script src="/_utils/script/jquery.couch.js?0.8.0"></script>
+  <script type="text/javascript" charset="utf-8">
+    $(function() {
+      var dbname = document.location.href.split('/')[3];
+      var design = unescape(document.location.href.split('/')[4]).split('/')[1];
+      var DB = $.couch.db(dbname);
+      DB.view(design+"/example-map",{success: function(json) {
+        $("#view").html(json.rows.map(function(row) {
+          return '<li>'+row.key+'</li>';
+        }).join(''));
+      }});
+    });
+  </script>
+</html>

data/lib/couchrest.rb

@@ -41,6 +41,37 @@ module CouchRest
       Server.new(*opts)
     end
     
+    def parse url
+      case url
+      when /^http:\/\/(.*)\/(.*)\/(.*)/
+        host = $1
+        db = $2
+        docid = $3
+      when /^http:\/\/(.*)\/(.*)/
+        host = $1
+        db = $2
+      when /^http:\/\/(.*)/
+        host = $1
+      when /(.*)\/(.*)\/(.*)/
+        host = $1
+        db = $2
+        docid = $3
+      when /(.*)\/(.*)/
+        host = $1
+        db = $2
+      else
+        db = url
+      end
+
+      db = nil if db && db.empty?
+
+      {
+        :host => host || "localhost:5984",
+        :database => db,
+        :doc => docid
+      }
+    end
+
     # ensure that a database exists
     # creates it if it isn't already there
     # returns it after it's been created

data/spec/couchapp_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "couchapp" do
+  before(:all) do
+    @fixdir = File.expand_path(File.dirname(__FILE__)) + '/fixtures/couchapp-test'
+    @couchapp = File.expand_path(File.dirname(__FILE__)) + '/../bin/couchapp'
+    `rm -rf #{@fixdir}`
+    `mkdir -p #{@fixdir}`
+    @run = "cd #{@fixdir} && #{@couchapp}"
+    
+  end
+
+  describe "--help" do
+    it "should output the opts" do
+      `#{@run} --help`.should match(/Usage/)
+    end
+  end
+
+  describe "generate my-app" do
+    it "should create an app directory" do
+      `#{@run} generate my-app`.should match(/generating/i)
+      Dir["#{@fixdir}/*"].select{|x|x =~ /my-app/}.length.should == 1
+    end
+    it "should create a views directory" do
+      `#{@run} generate my-app`.should match(/generating/i)
+      Dir["#{@fixdir}/my-app/*"].select{|x|x =~ /views/}.length.should == 1
+    end
+  end
+  
+  describe "push my-app #{TESTDB}" do
+    before(:all) do
+      @cr = CouchRest.new(COUCHHOST)
+      @db = @cr.database(TESTDB)
+      @db.delete! rescue nil
+      @db = @cr.create_db(TESTDB) rescue nil
+      `#{@run} generate my-app`
+    end
+    it "should create the design document with the app name" do
+      `#{@run} push my-app #{TESTDB}`
+      lambda{@db.get("_design/my-app")}.should_not raise_error
+    end
+    it "should create the views" do
+      `#{@run} push my-app #{TESTDB}`
+      doc = @db.get("_design/my-app")
+      doc['views']['example']['map'].should match(/function/)
+    end
+    it "should create the index" do
+      `#{@run} push my-app #{TESTDB}`
+      doc = @db.get("_design/my-app")
+      doc['_attachments']['index.html']["content_type"].should == 'text/html'
+    end
+  end
+  
+  describe "push my-app my-design #{TESTDB}" do
+    before(:all) do
+      @cr = CouchRest.new(COUCHHOST)
+      @db = @cr.database(TESTDB)
+      @db.delete! rescue nil
+      @db = @cr.create_db(TESTDB) rescue nil
+      `#{@run} generate my-app`
+    end
+    it "should create the design document" do
+      `#{@run} push my-app my-design #{TESTDB}`
+      lambda{@db.get("_design/my-design")}.should_not raise_error
+    end
+  end
+end
+

data/spec/couchrest_spec.rb

@@ -42,6 +42,99 @@ describe CouchRest do
     end
   end
 
+  describe "parsing urls" do
+    it "should parse just a dbname" do
+      db = CouchRest.parse "my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost:5984"
+    end
+    it "should parse a host and db" do
+      db = CouchRest.parse "localhost/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost"
+    end
+    it "should parse a host and db with http" do
+      db = CouchRest.parse "http://localhost/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost"
+    end
+    it "should parse a host with a port and db" do
+      db = CouchRest.parse "localhost:5555/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost:5555"
+    end
+    it "should parse a host with a port and db with http" do
+      db = CouchRest.parse "http://localhost:5555/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost:5555"
+    end
+    it "should parse just a host" do
+      db = CouchRest.parse "http://localhost:5555/"
+      db[:database].should be_nil
+      db[:host].should == "localhost:5555"
+    end
+    it "should parse just a host no slash" do
+      db = CouchRest.parse "http://localhost:5555"
+      db[:host].should == "localhost:5555"
+      db[:database].should be_nil
+    end
+    it "should get docid" do
+      db = CouchRest.parse "localhost:5555/my-db/my-doc"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost:5555"
+      db[:doc].should == "my-doc"
+    end
+    it "should get docid with http" do
+      db = CouchRest.parse "http://localhost:5555/my-db/my-doc"
+      db[:database].should == "my-db"
+      db[:host].should == "localhost:5555"
+      db[:doc].should == "my-doc"
+    end
+
+    it "should parse a host and db" do
+      db = CouchRest.parse "127.0.0.1/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1"
+    end
+    it "should parse a host and db with http" do
+      db = CouchRest.parse "http://127.0.0.1/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1"
+    end
+    it "should parse a host with a port and db" do
+      db = CouchRest.parse "127.0.0.1:5555/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1:5555"
+    end
+    it "should parse a host with a port and db with http" do
+      db = CouchRest.parse "http://127.0.0.1:5555/my-db"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1:5555"
+    end
+    it "should parse just a host" do
+      db = CouchRest.parse "http://127.0.0.1:5555/"
+      db[:database].should be_nil
+      db[:host].should == "127.0.0.1:5555"
+    end
+    it "should parse just a host no slash" do
+      db = CouchRest.parse "http://127.0.0.1:5555"
+      db[:host].should == "127.0.0.1:5555"
+      db[:database].should be_nil
+    end
+    it "should get docid" do
+      db = CouchRest.parse "127.0.0.1:5555/my-db/my-doc"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1:5555"
+      db[:doc].should == "my-doc"
+    end
+    it "should get docid with http" do
+      db = CouchRest.parse "http://127.0.0.1:5555/my-db/my-doc"
+      db[:database].should == "my-db"
+      db[:host].should == "127.0.0.1:5555"
+      db[:doc].should == "my-doc"
+    end
+  end
+
   describe "easy initializing a database adapter" do
     it "should be possible without an explicit CouchRest instantiation" do
       db = CouchRest.database "http://localhost:5984/couchrest-test"

data/spec/file_manager_spec.rb

@@ -24,6 +24,60 @@ describe CouchRest::FileManager do
   end
 end
 
+describe CouchRest::FileManager, "generating an app" do
+  before(:all) do
+    @appdir = File.expand_path(File.dirname(__FILE__)) + '/fixtures/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 index.html" do
+    html = File.open("#{@appdir}/attachments/index.html").read
+    html.should match(/DOCTYPE/)
+  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 = File.expand_path(File.dirname(__FILE__)) + '/fixtures/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
+end
+
+
 describe CouchRest::FileManager, "pushing views" do
   before(:all) do
     @cr = CouchRest.new(COUCHHOST)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jchris-couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors: 
 - J. Chris Anderson
@@ -46,6 +46,7 @@ files:
 - README.rdoc
 - Rakefile
 - THANKS
+- bin/couchapp
 - bin/couchdir
 - bin/couchview
 - examples/word_count
@@ -73,14 +74,26 @@ files:
 - lib/couchrest/helper/file_manager.rb
 - lib/couchrest/helper/pager.rb
 - lib/couchrest/helper/streamer.rb
+- lib/couchrest/helper/templates
+- 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.rb
 - spec/database_spec.rb
 - spec/file_manager_spec.rb
 - spec/fixtures
 - spec/fixtures/attachments
 - spec/fixtures/attachments/test.html
+- spec/fixtures/couchapp
+- spec/fixtures/couchapp/attachments
+- spec/fixtures/couchapp/attachments/index.html
+- spec/fixtures/couchapp/views
+- spec/fixtures/couchapp/views/example-map.js
+- spec/fixtures/couchapp/views/example-reduce.js
+- spec/fixtures/couchapp-test
 - spec/fixtures/views
 - spec/fixtures/views/lib.js
 - spec/fixtures/views/test_view