RubyGems - couchapp - Versions diffs - 0.1.4 → 0.1.6 - Mend

couchapp 0.1.4 → 0.1.6

Files changed (13) hide show

data/README.md +87 -3
data/Rakefile +20 -38
data/app-template/foo/bar.txt +2 -4
data/app-template/lib/helpers/math.js +1 -0
data/app-template/lib/templates/example.html +1 -1
data/app-template/lists/feed.js +30 -0
data/app-template/{show/docs → shows}/example-show.js +0 -0
data/ruby/bin/couchapp +4 -0
data/ruby/lib/couchapp.rb +1 -1
data/ruby/lib/file_manager.rb +2 -1
data/ruby/spec/couchapp_spec.rb +104 -37
data/ruby/spec/spec_helper.rb +10 -2
metadata +7 -6

data/README.md CHANGED

@@ -4,20 +4,104 @@ CouchApp is a set of helpers and a [jQuery](http://jquery.com) plugin that consp
 CouchApp *is by no means the only way to use CouchDB*. CouchDB's technical roots make it well suited for **very large installations**. CouchApp concentrates instead on a more personal use case: **developing and deploying standalone applications to CouchDB instances around the web.** There are apps you can build with server-side components that you can't build with just CouchApp. But by the same token, there are apps you can build on CouchApp alone that you can't build any other way.
+## Installation
+    sudo gem install couchapp
+If this gives you trouble, see the INSTALLING file for more options.
 ## Begin Here
 Once you run `couchapp generate relax && cd relax`, you're ready to get started. Views are found in the `views` directory, attachments are stored in the `_attachments` directory,  forms are stored in `forms`, and the generation script drops some more files in with additional information about how you can build `_design/` docs using your text editor.
 ## Usage
-about push... and db syntax
+To upload your application to a CouchDB database, run this command from within you application directory.
-!code and !json
+    couchapp push . mydb
-There are a few apps out there already using CouchApp. Please send a pull request adding yours to the list if you're using it too.
+You can expand `mydb` to be as complex as `http://login:password@my.couchapp.com:5984/mydb` if you need to.
+CouchApp provides some neat helpers for getting code into your view and render functions. Look in the view files created by a generated app to see the usage for the `!code` and `!json` preprocessor macros. They are basically just two different ways to get more code into your functions.
+### !code
+The `!code path.to.code` macro inserts the string value found at `path.to.code` of the design document, into the current file, at the position of the macro. Here's an example:
+    function(doc) {
+      // !code lib.parser.html
+      var parsed = new parseHTML(doc.html);
+      emit(doc.key, parsed);
+    }
+When you run `couchapp push` the `!code` line will be replaced with the contents of the file found at `lib/parser/html.js`. Simple as that.
+#### Standard Library
+As we begin to see more apps built using CouchApp, we plan to include helpful functions in the standard library (as supplied by `couchapp generate`). Thank you for helping us expand this section! :)
+### !json
+After all the `!code` includes have been processed (insuring that they may also use the `!json` macro), `couchapp push` does another pass through the function, running the `!json path.to.json` macro. This accumulates the data found at `path.to.json` into a single object for inclusion. After all the `!json` macros have been processed, the accumlated object is serialized to json and stored in a variable with a name corresponding to the path root.
+Here's an example. It's a lot of code to look at, but the principles are simple. Also, if you think you can explain it better than I have, please send a patch.
+#### A Subset of the Design Doc Fields (for context)
+    {
+      "lib" : {
+        "templates" : {
+          "post" : "<html> ... </html>",
+          "comment" : "<html> ... </html>"
+        },
+        "render" : {
+          "html" : "function(template, object){...}"
+        }
+      },
+      "blog" : {
+        "title" : "My Rad Blog"
+      }
+    }
+#### The Function
+    function(doc) {
+      // !json lib.templates.post
+      // !json blog.title
+      ...
+      doSomething(lib.templates.post, blog.title);
+    }
+#### The Result
+    function(doc) {
+      var lib = {
+        "templates" : {
+          "post" : "<html> ... </html>"
+        }
+      };
+      var blog = {
+        "title" : "My Rad Blog"
+      };
+      ...
+      doSomething(lib.templates.post, blog.title);
+    }
+The upshot is that only the requested fields are included in the function. This allows you to put as many templates and libraries in your design doc as you wish, without creating overlong functions.
+#### Silly Counter-example
+    function(doc) {
+      // !json lib
+      // !json lib.templates.post
+    }
+In this example, the second usage of the macro is redundant, as the first usage will include the entire `lib` field as a JSON macro.
 ## Apps Using CouchApp
+There are a few apps out there already using CouchApp. Please send a pull request adding yours to the list if you're using it too.
 * [Sofa](http://github.com/jchris/sofa)
 * [Couch-Wiki](http://github.com/janl/couch-wiki)
 * [CouchDB Twitter Client](http://github.com/jchris/couchdb-twitter-client)

data/Rakefile CHANGED

@@ -1,11 +1,20 @@
 require 'rake'
 require "rake/rdoctask"
-require 'spec/rake/spectask'
 require 'rake/gempackagetask'
 require File.join(File.expand_path(File.dirname(__FILE__)),
   'ruby','lib','couchapp')
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
 spec = Gem::Specification.new do |s|
   s.name = "couchapp"
   s.version = CouchApp::VERSION
@@ -43,11 +52,6 @@ spec = Gem::Specification.new do |s|
     "
-  #   mime-types
-  #   MIME Types manages a MIME Content-Type that will return the Content-Type for a given filename.
-  #   http://mime-types.rubyforge.org/
-  #   >=1.15.0
   dependencies = dependencies.strip.gsub(/^ +/,'').split(/\n\n/).map{|x|x.split(/\n/)}
   dependencies.each{|d|
@@ -64,6 +68,11 @@ Spec::Rake::SpecTask.new('spec') do |t|
 	t.spec_files = FileList['ruby/spec/**/*_spec.rb']
 end
+desc "Run Ruby specs on the Python version"
+task :python do
+  system "ruby ruby/spec/couchapp_spec.rb -- python"
+end
 desc "Print specdocs"
 Spec::Rake::SpecTask.new(:doc) do |t|
 	t.spec_opts = ["--format", "specdoc"]
@@ -82,37 +91,10 @@ end
 desc "Run the rspec"
 task :default => :spec
-desc "Update Github Gemspec"
+desc "create .gemspec file (useful for github)"
 task :gemspec do
-  skip_fields = %w(new_platform original_platform)
-  integer_fields = %w(specification_version)
-  result = "Gem::Specification.new do |s|\n"
-  spec.instance_variables.each do |ivar|
-    value = spec.instance_variable_get(ivar)
-    name  = ivar.split("@").last
-    next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
-    if name == "dependencies"
-      value.each do |d|
-        dep, *ver = d.to_s.split(" ")
-        result <<  "  s.add_dependency #{dep.inspect}, #{ /\(([^\,]*)/ . match(ver.join(" "))[1].inspect}\n"
-      end
-    else
-      case value
-      when Array
-        value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
-      when Fixnum
-        # leave as-is
-      when String
-        value = value.to_i if integer_fields.include?(name)
-        value = value.inspect
-      else
-        value = value.to_s.inspect
-      end
-      result << "  s.#{name} = #{value}\n"
-    end
+  filename = "#{spec.name}.gemspec"
+  File.open(filename, "w") do |f|
+    f.puts spec.to_ruby
   end
-  result << "end"
-  File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
 end

data/app-template/foo/bar.txt CHANGED

@@ -2,10 +2,8 @@ Couchapp will create a field on your document corresponding to any directories y
 Also, any files that end in .json will be treated as json rather than text, and put in the corresponding field. Also note that file.json, file.js, or file.txt will be stored under the "file" key, so don't make collisions in the filesystem unless you want unpredictable results.
-Of course you know that the views directory will be treated specially and -map and -reduce files will be mapped to the map and reduce functions. And the _attachments directory will be treated strangely as well.
+Of course you know that the views, shows, and lists directories will be treated specially, as those files are processed with the !code and !json macros.
-doc.json is a special case, it is treated as json and its keys are applied to the document root; eg it does not result in a "doc" field on your design document. If you need a doc field on the design document, you'll have to define it with a doc.json like so: {"doc":"value for doc field"}
-ps: each design document only has one language key: it will be set based on the file extensions in the views directory. CouchDB defaults to Javascript, so that's what you'll get if you don't define any views. You can override it with the doc.json file, but don't say we didn't warn you.
+ps: each design document only has one language key: CouchDB defaults to Javascript, so that's what you'll get if you don't express otherwise. The way to switch to a different langauge is to edit the file in the approot called "language", changing "javascript" for instance into "python".
 Oh yeah it's recommended that you delete this file.

data/app-template/lib/helpers/math.js CHANGED

	@@ -1 +1,2 @@
1	+ // this is just a placeholder for example purposes
1 2	function stddev() {};

data/app-template/lib/templates/example.html CHANGED

@@ -14,7 +14,7 @@
   <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 src="jquery.couchapp.js"></script>
+  <script src="<% attachPath %>/jquery.couchapp.js"></script>
   <script src="blog.js"></script>
   <script type="text/javascript" charset="utf-8">
   $.CouchApp(function(app) {

data/app-template/lists/feed.js ADDED

@@ -0,0 +1,30 @@
+function(head, row, req) {
+  respondWith(req, {
+    html : function() {
+      if (head) {
+        return '<html><h1>Listing</h1> total rows: '+head.row_count+'<ul/>';
+      } else if (row) {
+        return '\n<li>Id:' + row.id + '</li>';
+      } else {
+        return '</ul></html>';
+      }
+    },
+    xml : function() {
+      if (head) {
+        return {body:'<feed xmlns="http://www.w3.org/2005/Atom">'
+          +'<title>Test XML Feed</title>'};
+      } else if (row) {
+        // Becase Safari can't stand to see that dastardly
+        // E4X outside of a string. Outside of tests you
+        // can just use E4X literals.
+        var entry = new XML('<entry/>');
+        entry.id = row.id;
+        entry.title = row.key;
+        entry.content = row.value;
+        return {body:entry};
+      } else {
+        return {body : "</feed>"};
+      }
+    }
+  })
+};

data/app-template/{show/docs → shows}/example-show.js RENAMED

File without changes

data/ruby/bin/couchapp CHANGED

@@ -18,6 +18,10 @@ opts = OptionParser.new do |opts|
     puts opts
     exit
   end
+  opts.on_tail('-v', '--version', "Display version number") do
+    puts CouchApp::VERSION
+    exit
+  end
 end
 opts.parse!(ARGV)

data/ruby/lib/couchapp.rb CHANGED

@@ -4,7 +4,7 @@ require 'digest/md5'
 module CouchApp
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/ruby/lib/file_manager.rb CHANGED

@@ -39,7 +39,8 @@ module CouchApp
       attachdir = File.join(appdir,"_attachments")
       @doc = dir_to_fields(appdir)
-      package_shows(@doc["show"]["docs"]) if (@doc["show"] && @doc["show"]["docs"])
+      package_shows(@doc["shows"]) if @doc["shows"]
+      package_shows(@doc["lists"]) if @doc["lists"]
       package_views(@doc["views"]) if @doc['views']
       docid = "_design/#{appname}"

data/ruby/spec/couchapp_spec.rb CHANGED

@@ -17,26 +17,27 @@ describe "couchapp" do
   describe "generate my-app" do
     before(:all) do
       `#{@run} generate my-app`.should match(/generating/i)
+      @files = Dir["#{@fixdir}/my-app/**/*"]
     end
     it "should create an app directory" do
-      Dir["#{@fixdir}/*"].select{|x|x =~ /my-app/}.length.should == 1
+      @files.select{|x|x =~ /my-app/}.should_not be_empty
     end
     it "should create a views directory" do
-      Dir["#{@fixdir}/my-app/*"].select{|x|x =~ /views/}.length.should == 1
+      @files.select{|x|x =~ /views\Z/}.length.should == 1
     end
     it "should create an _attachments directory" do
-      Dir["#{@fixdir}/my-app/*"].select{|x|x =~ /_attachments/}.length.should == 1
-      Dir["#{@fixdir}/my-app/_attachments/*"].select{|x|x =~ /index.html/}.length.should == 1
+      @files.select{|x|x =~ /_attachments\Z/}.length.should == 1
+      @files.select{|x|x =~ /_attachments\/index.html/}.length.should == 1
     end
-    it "should create a show directory" do
-      Dir["#{@fixdir}/my-app/*"].select{|x|x =~ /show/}.length.should == 1
+    it "should create a shows directory" do
+      @files.select{|x|x =~ /shows\Z/}.length.should == 1
+      @files.select{|x|x =~ /example-show.js/}.length.should == 1
     end
-    it "should create a forms and libs" do
-      Dir["#{@fixdir}/my-app/show/docs/*"].select{|x|x =~ /example-show.js/}.length.should == 1
-      Dir["#{@fixdir}/my-app/lib/templates/*"].select{|x|x =~ /example.html/}.length.should == 1
+    it "should create a libs" do
+      @files.select{|x|x =~ /templates\/example.html/}.length.should == 1
     end
     it "should show deep attachment capabilities" do
-      Dir["#{@fixdir}/my-app/_attachments/**/*"].select{|x|x =~ /main.css/}.
+      @files.select{|x|x =~ /main.css/}.
         first.should include('style')
     end
   end
@@ -48,6 +49,8 @@ describe "couchapp" do
       @db.delete! rescue nil
       @db = @cr.create_db(TESTDB) rescue nil
       `#{@run} generate my-app`
+      `mkdir -p #{@fixdir}/my-app/views/more`
+      `echo 'moremap' > #{@fixdir}/my-app/views/more/map.js`
       `#{@run} push my-app #{TESTDB}`
       @doc = @db.get("_design/my-app")
     end
@@ -59,56 +62,120 @@ describe "couchapp" do
     end
     it "should create the view libs" do
       @doc['views']['example']['map'].should match(/stddev/)
-      @doc['show']['docs']['example-show'].should_not match(/\"helpers\"/)
+      @doc['shows']['example-show'].should match(/ejohn\.org/)
     end
     it "should create view for all the views" do
-      `mkdir -p #{@fixdir}/my-app/views/more`
-      `echo 'moremap' > #{@fixdir}/my-app/views/more/map.js`
-      `#{@run} push my-app #{TESTDB}`
-      doc = @db.get("_design/my-app")
-      doc['views']['more']['map'].should match(/moremap/)
+      @doc['views']['more']['map'].should match(/moremap/)
     end
     it "should create the index" do
       @doc['_attachments']['index.html']["content_type"].should == 'text/html'
     end
-    it "should push the forms" do
-      @doc['show']['docs']['example-show'].should match(/Generated CouchApp Form Template/)
+    it "should create the manifest" do
+      @doc['app_meta']['manifest'][0].should match(/foo\//)
+    end
+    it "should push and macro the doc shows" do
+      @doc['shows']['example-show'].should match(/Generated CouchApp Form Template/)
+    end
+    it "should push and macro the view lists" do
+      @doc['lists']['feed'].should match(/Test XML Feed/)
+    end
+    it "should include lib stuff" do
+      @doc['lib']['templates']['example'].should match(/Generated CouchApp Form Template/)
     end
     it "should allow deeper includes" do
-      @doc['show']['docs']['example-show'].should_not match(/\"helpers\"/)
+      @doc['shows']['example-show'].should_not match(/\"helpers\"/)
     end
-    it "deep requires" do
-      @doc['show']['docs']['example-show'].should_not match(/\"template\"/)
-      @doc['show']['docs']['example-show'].should match(/Resig/)
+    it "deep require macros" do
+      @doc['shows']['example-show'].should_not match(/\"template\"/)
+      @doc['shows']['example-show'].should match(/Resig/)
     end
-  end
-  describe "push . #{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`
+    it "should push to other design docs" do
+      lambda{@db.get("_design/my-design")}.should raise_error
+      `#{@run} push my-app my-design #{TESTDB}`
+      lambda{@db.get("_design/my-design")}.should_not raise_error
     end
-    it "should create the design document" do
+    # cd should be last
+    it "should work on . dir as well" do
+      @db = reset_test_db!
+      lambda{@db.get("_design/my-app")}.should raise_error
       `cd #{@fixdir}/my-app && #{COUCHAPP} push . #{TESTDB}`
       lambda{@db.get("_design/my-app")}.should_not raise_error
     end
   end
-  describe "push my-app my-design #{TESTDB}" do
+  describe "clone #{TESTDB}/_design/my-app" 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`
+      `#{@run} push my-app #{TESTDB}`
+      @doc = @db.get("_design/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
+    describe "normally" do
+      before(:all) do
+        `rm -rf #{@fixdir}/my-app`
+        `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      end
+      it "should clone the views" do
+        File.exist?("#{@fixdir}/my-app/views").should == true
+      end
+      it "should create foo/bar.txt file" do
+        File.exist?("#{@fixdir}/my-app/foo/bar.txt").should == true
+      end
+      it "should create lib/helpers/math.js file" do
+        File.exist?("#{@fixdir}/my-app/lib/helpers/math.js").should == true
+      end
     end
+    it "should work when design doc is edited manually" do
+      @doc['test.txt'] = "essai"
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/test.txt").should == true
+    end
+    it "should work when a view is added manually" do
+      @doc["views"]["more"] = { "map" => "function(doc) { emit(null, doc); }" }
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/views/more/map.js").should == true
+    end
+    it "should create view even if file dir is missing in manifest" do
+      @doc['app_meta']["manifest"].delete_at(12)
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/views/example/map.js").should == true
+    end
+    it "should work without manifest" do
+      @doc['app_meta'].delete('manifest')
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/views").should == true
+    end
+    it "should create foo/bar.txt without manifest" do
+      @doc['app_meta'].delete('manifest')
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/foo/bar.txt").should == true
+    end
+    it "should create lib/helpers.json without manifest" do
+      @doc['app_meta'].delete('manifest')
+      @doc.save()
+      `rm -rf #{@fixdir}/my-app`
+      `cd #{@fixdir} && #{COUCHAPP} clone http://127.0.0.1:5984/#{TESTDB}/_design/my-app`
+      File.exist?("#{@fixdir}/my-app/lib/helpers.json").should == true
+    end
   end
 end

data/ruby/spec/spec_helper.rb CHANGED

@@ -4,7 +4,15 @@ require "couchrest"
 require File.expand_path(File.dirname(__FILE__)) + '/../lib/couchapp'
-COUCHAPP = ARGV[0] || File.expand_path(File.dirname(__FILE__)) + '/../bin/couchapp'
+COUCHAPP = if (ARGV[1] == 'python')
+  puts "testing Python version"
+  ENV['PYTHONPATH'] = File.expand_path(File.dirname(__FILE__)) + '/../../python'
+  File.expand_path(File.dirname(__FILE__)) + '/../../python/couchapp/bin/couchapp_cli.py'
+else
+  puts "testing Ruby version"
+  File.expand_path(File.dirname(__FILE__)) + '/../bin/couchapp'
+end
 SCRATCH_PATH = File.dirname(__FILE__) + '/scratch'
 COUCHHOST = "http://127.0.0.1:5984"
 TESTDB = 'couchapp-test'
@@ -15,4 +23,4 @@ def reset_test_db!
   db.delete! rescue nil
   db = cr.create_db(TESTDB) rescue nin
   db
-end
+end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchapp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - J Chris Anderson
@@ -11,8 +11,8 @@ autorequire:
 bindir: ruby/bin
 cert_chain: []
-date: 2009-01-13 00:00:00 -08:00
-default_executable:
+date: 2009-01-23 00:00:00 -08:00
+default_executable: couchapp
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -35,7 +35,7 @@ dependencies:
         version: 1.1.3
     version:
 - !ruby/object:Gem::Dependency
-  name: couchrest
+  name: "couchrest "
   type: :runtime
   version_requirement:
   version_requirements: !ruby/object:Gem::Requirement
@@ -64,7 +64,8 @@ files:
 - app-template/lib/helpers/math.js
 - app-template/lib/helpers/template.js
 - app-template/lib/templates/example.html
-- app-template/show/docs/example-show.js
+- app-template/lists/feed.js
+- app-template/shows/example-show.js
 - app-template/views/example/map.js
 - app-template/views/example/reduce.js
 - ruby/lib/couchapp.rb
@@ -73,7 +74,7 @@ files:
 - ruby/spec/file_manager_spec.rb
 - ruby/spec/spec.opts
 - ruby/spec/spec_helper.rb
-has_rdoc: "true"
+has_rdoc: true
 homepage: http://github.com/jchris/couchapp
 post_install_message:
 rdoc_options: []