addywaddy-couch_surfer 0.0.1

data/README.md

@@ -0,0 +1,73 @@
+CouchSurfer
+===========
+
+Description
+-----------
+CouchSurfer is an extraction of CouchRest::Model from the excellent [CouchRest](http://github.com/jchris/couchrest/ "CouchRest") gem by J. Chris Anderson.
+
+Features
+--------
+- ORM (Extracted from CouchRest::Model)
+- Associations
+  - `has_ many`
+  - `belongs_to`
+
+- Validations
+  - All validations from the [Validatable](http://github.com/jrun/validatable/ "Validatable") gem
+  - `validates_uniqueness_of`
+
+Examples
+--------
+    class Account
+      include CouchSurfer::Model
+      include CouchSurfer::Associations
+  
+      key_accessor :name
+      
+      # Will use the Project.by_account_id view with {:key => account_instance.id}
+      has_many :projects
+      
+      # Uses a custom view and key
+      has_many :employees, :view => {:name => :by_account_id_and_email, 
+          :query => lambda{ {:startkey => [id, nil], :endkey => [id, {}]} }}
+
+    end
+
+    class Project
+      include CouchSurfer::Model
+      include CouchSurfer::Associations
+  
+      key_accessor :name, :account_id
+  
+      belongs_to :account
+  
+      view_by :account_id
+    end
+
+
+    class Employee
+      include CouchSurfer::Model
+      include CouchSurfer::Associations
+      include CouchSurfer::Validations
+  
+      key_accessor :email, :account_id
+      belongs_to :account
+  
+      view_by :account_id, :email
+      view_by :name
+
+      validates_presence_of :name
+      validates_format_of   :email, 
+        :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+      validates_length_of :postcode, :is => 7, :message => "not the correct length"
+      
+      # Will use the Employee.by_name view with {:key => employee_instance.name}
+      validates_uniqueness_of :name, :message => "No two Beatles have the same name"
+      
+      # Uses a custom view and key
+      validates_uniqueness_of :email, :view => {:name => :by_account_id_and_email,
+        :query => lambda{ {:key => [account_id, email]} }}, :message => "Already taken!"
+  
+    end
+    
+Please check out the specs as well :)

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couch_surfer')
+
+
+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 = "couch_surfer"
+  s.version = CouchSurfer::VERSION
+  s.date = "2009-01-22"
+  s.summary = "ORM based on CouchRest::Model"
+  s.email = "jchris@apache.org"
+  s.homepage = "http://github.com/addywaddy/couchsurfer"
+  s.description = "CouchSurfer provides an ORM for CouchDB, as well as supporting association and validation declarations."
+  s.has_rdoc = true
+  s.authors = ["Adam Groves"]
+  s.files = %w( LICENSE README.md Rakefile ) + 
+    Dir["{lib,spec}/**/*"] - 
+    Dir["spec/tmp"]
+  s.extra_rdoc_files = %w( README.md LICENSE )
+  s.require_path = "lib"
+  s.add_dependency("json", ">= 1.1.2")
+  s.add_dependency("rest-client", ">= 0.5")
+  s.add_dependency('jchris-couchrest', ">= 0.12.2")
+end
+
+
+desc "create .gemspec file (useful for github)"
+task :gemspec do
+  filename = "#{spec.name}.gemspec"
+  File.open(filename, "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+	t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+	t.spec_opts = ["--format", "specdoc"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+end
+
+desc "Run the rspec"
+task :default => :spec
+

data/lib/couch_surfer/associations.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'extlib'
+
+module CouchSurfer
+  module Associations
+    module ClassMethods
+      def has_many *args
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        children = args.first
+        define_method children do |*args|
+          query_params = args.last.is_a?(Hash) ? args.pop : nil
+          name =  ::Extlib::Inflection.camelize(children.to_s.singular)
+          klass = ::Extlib::Inflection.constantize(name)
+          if options[:view].is_a?(Hash)
+            view_name = options[:view][:name]
+            query     = options[:view][:query].is_a?(Proc) ? self.instance_eval(&options[:view][:query]) : nil
+          end
+          view_name ||= "by_#{self.class.name.downcase}_id"
+          query ||= {:key => self.id}
+          klass.send(view_name, query)
+        end
+      end
+      
+      def belongs_to *args
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        parent = args.first
+        # view_key = "#{parent}_id".to_sym
+        # if options[:identifiers]
+        #   if options[:prepend]
+        #     view_key = options[:identifiers] << view_key
+        #   else 
+        #     view_key = options[:identifiers].unshift(view_key)
+        #   end
+        # end
+        # class_eval do
+        #   view_by *view_key
+        # end
+        define_method parent do
+          name = ::Extlib::Inflection.camelize(parent.to_s)
+          klass = ::Extlib::Inflection.constantize(name)
+          parent_id = self["#{parent.to_s}_id"]
+          if parent_id
+            klass.send(:get, self["#{parent.to_s}_id"])
+          end
+        end
+
+        define_method "#{parent}=".to_sym do |parent_obj|
+          self["#{parent_obj.class.name.downcase}_id"] = parent_obj.id
+        end
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+    end
+  end
+end