ShyCouch 0.3.5 → 0.4.0

data/Gemfile.lock

@@ -10,7 +10,7 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
+    rake (0.9.2)
     rcov (0.9.10)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)

data/README

@@ -1,15 +1,29 @@
 = 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 Camping. A Python version is forthcoming.
+ShyCouch is a Ruby library for CouchDB. It's a data persistence layer that uses native objects and lets you write native Ruby blocks that'll be parsed into MapReduce JavaScript functions.
 
-I'm mainly putting this up for feedback at the moment. It's a complete mess.
+The structure is a bit of a mess, but essentially it provides:
 
-Eventually I'm gonna re-release it with all of Camping's code, with AR and stuff removed and this stuff put in.
+- a database object
+- a CouchDocument object, which is a glorified hash
+- a Design object representing the Design document for an app in CouchDB
 
-ShyCouch does not come with an elaborate query language. It'll automatically create an 'all' query for all your models (don't use it unless you have a really good excuse not to write a custom query, doing the filtering at the application layer is hell slow), but aside from that you have to write your own map and reduce functions.
+At the moment, all views have to be written manually. I'm currently evaluating the wisdom of building a query language to dynamically write views and cache them in Couch.
 
 = Usage
 
+	require 'shycouch'
+	settings = {
+	  "db"=> {
+	      "host" => "ramponeau.local",
+	      "port" => 5984,
+	      "name" => "food",
+	      "user" => "cerales",
+	      "password" => "password"
+	    },
+	}
+	db = ShyCouch::CouchDatabase()
+
 == Models
 
 You don't need to define entity relationships or anything. Your models can just look like this:

data/Rakefile

@@ -44,7 +44,8 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+# require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/ShyCouch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ShyCouch}
-  s.version = "0.3.5"
+  s.version = "0.4.0"
 
   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}]
-  s.date = %q{2011-08-20}
+  s.date = %q{2011-08-28}
   s.description = %q{Ruby API for CouchDB, designed to work with the Camping micro-framework.}
   s.email = %q{danbryan@gmail.com}
   s.extra_rdoc_files = [
@@ -37,7 +37,8 @@ Gem::Specification.new do |s|
     "test/test_couchdb_api.rb",
     "test/test_couchdb_factory.rb",
     "test/test_design_documents.rb",
-    "test/test_fields.rb"
+    "test/test_fields.rb",
+    "test/test_views.rb"
   ]
   s.homepage = %q{http://github.com/Cerales/ShyCouch}
   s.licenses = [%q{MIT}]

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/lib/ShyCouch.rb

@@ -11,63 +11,37 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'net/http'
 require 'json'
 require 'resolv'
-require 'shyrubyjs'
+# require 'shyrubyjs'
+require '~/dev/gems/ShyRubyJS/lib/ShyRubyJS'
 # require everything from the 'ShyCouch' subdirectory
 Dir.new(File.dirname(__FILE__)+'/ShyCouch').each { |f| require 'shycouch/' + f.split('.')[0] unless f == '.' or f == '..' }
 
 
 module ShyCouch
   class << self
-    def goes(m)
-      Camping.goes m
-      c = %{
-        #{m.to_s}::Models::CouchDocument = ShyCouch::Data::CouchDocument
-      }
-      eval(c)
-      ShyCouch.create
-    end
     
-    def create(settings=nil)
+    def create(settings=nil) #TODO - change this
       $couchdb = ShyCouch.getDB(settings)
     end
     
     def getDB(settings=nil)
-      settings = $settings unless settings
-      database = CouchDBAPI.new(settings["db"]["host"], settings["db"]["port"], settings["db"]["name"], settings["db"]["user"], settings["db"]["password"])
-      puts database.connect unless database.connect["ok"]
+      settings = $couch_settings unless settings
+      database = CouchDatabase.new(settings)
+      puts database.connect unless database.connect["ok"] #TODO - hm
       database.create unless database.on_server?
       return database
     end
     
   end
   attr_accessor :database
-  
-  class Connection
-    # Test that the database is accessible and give back a CouchDBAPI object if so.
-    # Doesn't actually gets instantiated - is just here to allow nice ShyCouch::Connection.Create syntax
-    # def self.Create(settings=nil)
-    #   settings = $settings unless settings
-    #   database = CouchDBAPI.new(settings["db"]["host"], settings["db"]["port"], settings["db"]["name"], settings["db"]["user"], settings["db"]["password"])
-    #   puts database.connect unless database.connect["ok"]
-    #   database.create unless database.on_server?
-    #   return database
-    # end
-    
-    def push_generic_views
-      #TODO 
-    end
-  end
 
-  class CouchDBAPI
-  	def initialize(host, port, name, user, password)
-  		@host, @port, @name, @user, @password = host, port, name, user, password
-  		@views = []
-  		@server = CouchServerConnection.allocate
+  class ShyCouchError < StandardError; end
+
+  class CouchDatabase
+  	def initialize(settings)
+      # args = explode_settings(args) if args.size == 1
+	    init(settings)
   	end
-    # 
-    # def initialize(*settings)
-    #   @host, @port, @name, @user, @password = settings["db"]["host"], settings["db"]["port"], settings["db"]["name"], settings["db"]["user"], settings["db"]["password"]
-    #     end
 
   	attr_accessor :server, :name, :host, :port, :views
 
@@ -134,6 +108,14 @@ module ShyCouch
     end
     
     private 
+    
+    def init(settings)
+		  db_settings = settings["db"]
+  		@host, @port, @name, @user, @password = db_settings["host"],db_settings["port"], db_settings["name"],db_settings["user"], db_settings["password"]
+  		@views = []
+  		@server = CouchServerConnection.allocate
+    end
+    
     class CouchServerConnection
     	def initialize(args, options=nil)#host, port, user, password, options = nil)
     		@host = args["host"]
@@ -237,9 +219,13 @@ module ShyCouch
 
     	private
 
-    	def handle_error(req, res)
+    	def handle_failure(req, res)
     		raise RuntimeError.new("#{res.code}:#{res.message}\nMETHOD:#{req.method}\nURI:#{req.path}\n#{res.body}")
     	end
+    	
+    	def handle_error(e)
+    	  raise RuntimeError.new("#{e.inspect}\n Maybe be due to illegal rev or id change")
+  	  end
 
     	def request(req)
     		res = Net::HTTP.start(@host, @port) { |http|
@@ -247,11 +233,13 @@ module ShyCouch
     		  http.request(req)
     		  }
     		unless res.kind_of?(Net::HTTPSuccess)
-    			handle_error(req, res)
+    			handle_failure(req, res)
     		end
     		res
+  		rescue Errno::ECONNRESET => e
+  		  handle_error(e)
     	end
     end
-  
+
   end
 end

data/lib/ShyCouch/data.rb

@@ -5,9 +5,9 @@ module ShyCouch
     class CouchDocument < Hash
       class << self
         # allows instance.class.requirements to be called
-        attr_accessor :requirements
       end
-    
+      @@needs, @@suggests = [], []
+
       def initialize(hash={})
         # Assumes that the "kind" is the class name unless explicitly stated otherwise
         # TODO - maybe just force it to be the class name no matter what tbh
@@ -17,27 +17,30 @@ module ShyCouch
         # super(hash)
       end
     
-      # def initialize(hash=nil, requirements)
-      #   @requirements = requirements
-      #   merge!(hash) if hash
-      #   raise TypeError unless valid? #TODO - should raise a more specific and useful error
-      # end
-    
       def self.all
-        database = CouchDatabase.new($settings)
-        database.get()
       end
-    
-      def self.requires(*requirements)
-        @requirements = requirements
+      
+      def self.needs(*requirements)
+        requirements.map { |requirement| @@needs << requirement } unless requirements.empty?
+        return @@needs
       end
-    
-      def add_key(key, value=nil)
-        # The attr value assignment operator has been overriden, but it checks for the existence of a key.
-        # And therefore the user has to explicitly call this method first.
-        self[key] = value
+      
+      def self.suggests(*suggestions)
+        suggestions.map { |suggestion| @@suggests << suggestion } unless suggestions.empty?
+        return @@suggests
       end
-    
+      
+      def needs;self.class.needs; end
+      def suggests; self.class.suggests; end
+      
+      def needs?(requirement)
+        @@needs.include?(requirement) ? true : false
+      end
+      
+      def suggests?(requirement)
+        @@suggests.include?(requirement) ? true : false
+      end
+      
       def attr_keys
         # returns the keys for all the attrs that aren't the id or rev
         attr_keys = []
@@ -90,15 +93,54 @@ module ShyCouch
       end
     
     end
+    
+    class View
+      attr_accessor :map, :reduce, :name
+      
+      def initialize(view_name, &block)
+        @parser = ShyRubyJS::ShySexpParser.new
+        sexp_check = block.to_sexp
+        sexp = block.to_sexp(:strip_enclosure=>true)
+
+        # make sure the two blocks inside are calls to "map" and "reduce"
+
+        @name = view_name.to_s        
+        if sexp[0] == :block
+          unless sexp_check[3][1][1][2] == :map and sexp_check[3][2][1][2] == :reduce
+            raise ShyCouchError, "view must be called with map block and optional reduce block" 
+          end
+          [1,2].each { |num|
+            2.times { sexp[num].delete_at(1) }
+          }
+          @map = @parser.parse(sexp[1])[0]
+          @reduce = @parser.parse(sexp[2]) if sexp[2].length > 1
+        elsif sexp[0] == :iter
+          raise ShyCouchError, "view must be called with map block and optional reduce block" unless sexp[1][2] == :map
+          @map = @parser.parse(sexp[3])
+        end
+      end
+      
+      def as_hash
+        h = {}
+        h[@name] = {"map" => @map}
+        h.merge!({"reduce" => @reduce}) if @reduce
+        return h
+      end
+    end
 
     class Design < CouchDocument
       # this is used to manage design documents
       # In practise, the Controllers should be a list of classes corresponding to design documents
-
-      def map(&block);end
-
-      def reduce(&block);end
-
+      
+      def initialize(name)
+        merge! "_id" => "_design/#{name.to_s}"
+        @parser = ShyRubyJS::ShySexpParser.new
+      end
+      
+      def self.setup
+        # setup_all_view
+      end
+         
       def push;end #must override push in order to set the ID
     end
 

data/test/test_ShyCouch.rb

@@ -7,7 +7,8 @@ require_relative '../lib/ShyCouch'
 # Settings for a database that is set up and working, with an admin user
 $settings = {
   "db"=> {
-      "host" => "localhost",
+      "host" => "ramponeau.local",
+      # "host" => "localhost",
       "port" => 5984,
       "name" => "test",
       "user" => "cerales",
@@ -29,4 +30,6 @@ require_relative 'test_camping_integration'
 
 require_relative 'test_couchdb_factory'
 
-require_relative 'test_design_documents'
+require_relative 'test_design_documents'
+
+require_relative 'test_views'

data/test/test_couch_document.rb

@@ -38,7 +38,7 @@ class CouchDocumentTests# < Test::Unit::TestCase
     def test_create_from_fixnum
       # Ensure no doc creation with fixnum argument
       fixnum = 1
-      assert_raises TypeError do
+      assert_raise TypeError do
         doc = ShyCouch::Data::CouchDocument.new(fixnum)
       end
     end
@@ -110,9 +110,9 @@ class CouchDocumentTests# < Test::Unit::TestCase
       @existing_valid_documents.each { |doc| 
         # add some more attributes
         assert(doc._rev)
-        doc.add_key("owner", "the guvvmint")
-        doc.add_key("buttonCount")
-        doc.add_key("friends")
+        doc["owner"] = "the guvvmint"
+        doc["buttonCount"] = nil
+        doc["friends"] = nil
         doc.buttonCount = 5
         doc.friends = ["alan", "alex", "all me other mates"]
         
@@ -132,7 +132,7 @@ class CouchDocumentTests# < Test::Unit::TestCase
     def test_illegal_change_to_rev
       @existing_valid_documents.each { |doc|
         doc._rev = "hurr"
-        assert_raises RuntimeError do
+        assert_raise RuntimeError do
           res = doc.push
         end
       }

data/test/test_views.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+require_relative '../lib/ShyCouch.rb'
+
+class CouchViewTests < Test::Unit::TestCase
+  JS_MAP_FUNCTION_HEADER = "function ( doc ) { \n    "
+  JS_REDUCE_FUNCTION_HEADER = "function(key, values, rereduce)"
+  JS_FUNCTION_FOOTER = "}"
+  def setup
+    @couch_views = []
+  end
+  
+  def view(view_name, &block)
+    @couch_views << ShyCouch::Data::View.new(view_name, &block)
+  end
+  def teardown; end
+  
+  def test_define_map_view
+    view :five_star_butts do
+      map do
+        def function(doc)
+          emit(doc) if doc.kind == "butt" and doc.star_rating == 5
+        end
+      end
+    end
+    expected_js = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == "butt" && doc.star_rating == 5 ) {\n  emit(doc)\n} \n } + JS_FUNCTION_FOOTER
+    assert_equal(expected_js, @couch_views[0].map)
+    # puts @couch_views[0].map
+  end
+  
+  def test_define_map_and_reduce_view
+    view :beggar_count do
+      map do
+        def function(doc)
+          emit(doc) if doc.kind == "beggar"
+        end
+      end
+      reduce do
+        def function(key, values, rereduce)
+          return sum(values)
+        end
+      end
+    end
+    puts @couch_views[0].map
+    puts @couch_views[0].reduce
+    expected_map = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == "beggar" ) {\n  emit(doc)\n} \n } + JS_FUNCTION_FOOTER
+    expected_rejuce = JS_REDUCE_FUNCTION_HEADER
+    assert_equal(expected_map, @couch_views[0].map)
+
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ShyCouch
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2011-08-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70214897246860 !ruby/object:Gem::Requirement
+  requirement: &70288155812040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70214897246860
+  version_requirements: *70288155812040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70214897243320 !ruby/object:Gem::Requirement
+  requirement: &70288155810560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70214897243320
+  version_requirements: *70288155810560
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70214897240520 !ruby/object:Gem::Requirement
+  requirement: &70288155807920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214897240520
+  version_requirements: *70288155807920
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70214897238760 !ruby/object:Gem::Requirement
+  requirement: &70288155806340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70214897238760
+  version_requirements: *70288155806340
 - !ruby/object:Gem::Dependency
   name: ShyRubyJS
-  requirement: &70214897237620 !ruby/object:Gem::Requirement
+  requirement: &70288155792060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214897237620
+  version_requirements: *70288155792060
 - !ruby/object:Gem::Dependency
   name: ShyRubyJS
-  requirement: &70214897236100 !ruby/object:Gem::Requirement
+  requirement: &70288155790660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214897236100
+  version_requirements: *70288155790660
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70214897235140 !ruby/object:Gem::Requirement
+  requirement: &70288155789540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214897235140
+  version_requirements: *70288155789540
 description: Ruby API for CouchDB, designed to work with the Camping micro-framework.
 email: danbryan@gmail.com
 executables: []
@@ -119,6 +119,7 @@ files:
 - test/test_couchdb_factory.rb
 - test/test_design_documents.rb
 - test/test_fields.rb
+- test/test_views.rb
 homepage: http://github.com/Cerales/ShyCouch
 licenses:
 - MIT
@@ -134,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3382610228249582822
+      hash: 1563418179645536452
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: