ShyCouch 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,6 +1,6 @@
 = ShyCouch
 
-ShyCouch is a Ruby library for CouchDB. It's a data persistence layer that uses native objects and a simple query language, designed primarily to replace ActiveRecord in micro-frameworks like Camping. A Python version is forthcoming.
+ShyCouch is a Ruby library for CouchDB. It's a data persistence layer that uses native objects and a simple query language, designed primarily to replace ActiveRecord in Camping. A Python version is forthcoming.
 
 I'm mainly putting this up for feedback at the moment. It's a complete mess, I haven't figured out where 
 
@@ -8,18 +8,82 @@ ShyCouch does not come with an elaborate query language. It'll automatically cre
 
 = Usage
 
-erghgrehg TODO
+put this in your helpers (this isn't entiiiirely working yet):
+
+== Models
+
+You don't need to define entity relationships or anything. Your models can just look like this:
+
+	module Food::Models
+	  class Recipe < CouchDocument; end
+	end
+
+You can do a bit more if you want:
+
+	module Food::Models
+	  class Recipe < CouchDocument
+	    needs :ingredients
+	    needs :directions
+	    suggests :cost
+	  end
+	end
+	
+== Helpers
+
+You define your map & reduce functions - your Couch views - in your Helpers.
+
+	module Food::Helpers
+
+	  design do
+	    view all_recipes do
+	      map do
+	        def function(doc)
+	          if doc.kind == "recipe"
+	            emit(doc)
+  	        end
+	      end
+    
+	     reduce do
+	        # whatever
+	      end
+
+	    end
+
+	    view ingredients do
+	      # a different view
+	    end
+	  end
+
+You can then call your views by name in your controllers:
+
+	module Food::Controllers
+	  class Recipes < R '/recipes/'
+	    @recipes = View.all_recipes
+	    render :recipes
+	  end
+	end
+	
+Views give you back a special JSON hash where you can treat the keys as object attributes and all that:
+	
+	module Food::Views
+	  recipes.each do |recipe|
+	    h2 recipe.title
+	    recipe.ingredients.each do |ingredient|
+	      p "#{ingredient.name}: #{ingredient.quantity}"
+	    end
+	  end
+	end
 
 = Map/Reduce
 
 ShyCouch uses the related ShyRubyJS library to parse Ruby blocks as JavaScript. This means you can do this:
 
-	map {
+	map do
 	  def function(doc)
 	    if doc.kind == "post" and !doc.hidden
 	      emit(doc)
 	  end
-	}
+	end
 
 and you'll get this:
 

data/ShyCouch.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ShyCouch}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Shy Inc.}, %q{Daniel Bryan}, %q{Cerales}]

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ShyCouch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-08-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70094608804280 !ruby/object:Gem::Requirement
+  requirement: &70261252696540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70094608804280
+  version_requirements: *70261252696540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70094608801900 !ruby/object:Gem::Requirement
+  requirement: &70261252694020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70094608801900
+  version_requirements: *70261252694020
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70094608799800 !ruby/object:Gem::Requirement
+  requirement: &70261252691920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094608799800
+  version_requirements: *70261252691920
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70094608797500 !ruby/object:Gem::Requirement
+  requirement: &70261252689660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70094608797500
+  version_requirements: *70261252689660
 - !ruby/object:Gem::Dependency
   name: ShyRubyJS
-  requirement: &70094608795700 !ruby/object:Gem::Requirement
+  requirement: &70261252687980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094608795700
+  version_requirements: *70261252687980
 - !ruby/object:Gem::Dependency
   name: ShyRubyJS
-  requirement: &70094608794440 !ruby/object:Gem::Requirement
+  requirement: &70261252686580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094608794440
+  version_requirements: *70261252686580
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70094608793120 !ruby/object:Gem::Requirement
+  requirement: &70261252685280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094608793120
+  version_requirements: *70261252685280
 description: Ruby API for CouchDB, designed to work with the Camping micro-framework.
 email: danbryan@gmail.com
 executables: []
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2635305617772024091
+      hash: 1342729704681637371
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: