jchris-couchrest 0.2

data/spec/couchrest/more/property_spec.rb

@@ -0,0 +1,129 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require File.join(FIXTURE_PATH, 'more', 'card')
+require File.join(FIXTURE_PATH, 'more', 'invoice')
+require File.join(FIXTURE_PATH, 'more', 'service')
+require File.join(FIXTURE_PATH, 'more', 'event')
+
+
+describe "ExtendedDocument properties" do
+  
+  before(:each) do
+    @card = Card.new(:first_name => "matt")
+  end
+  
+  it "should be accessible from the object" do
+    @card.properties.should be_an_instance_of(Array)
+    @card.properties.map{|p| p.name}.should include("first_name")
+  end
+  
+  it "should let you access a property value (getter)" do
+    @card.first_name.should == "matt"
+  end
+  
+  it "should let you set a property value (setter)" do
+    @card.last_name = "Aimonetti"
+    @card.last_name.should == "Aimonetti"
+  end
+  
+  it "should not let you set a property value if it's read only" do
+    lambda{@card.read_only_value = "test"}.should raise_error
+  end
+  
+  it "should let you use an alias for an attribute" do
+    @card.last_name = "Aimonetti"
+    @card.family_name.should == "Aimonetti"
+    @card.family_name.should == @card.last_name
+  end
+  
+  it "should be auto timestamped" do
+    @card.created_at.should be_nil
+    @card.updated_at.should be_nil
+    @card.save.should be_true
+    @card.created_at.should_not be_nil
+    @card.updated_at.should_not be_nil
+  end
+  
+  describe "validation" do
+    before(:each) do
+      @invoice = Invoice.new(:client_name => "matt", :employee_name => "Chris", :location => "San Diego, CA")
+    end
+    
+    it "should be able to be validated" do
+      @card.valid?.should == true
+    end
+
+    it "should let you validate the presence of an attribute" do
+      @card.first_name = nil
+      @card.should_not be_valid
+      @card.errors.should_not be_empty
+      @card.errors.on(:first_name).should == ["First name must not be blank"]
+    end
+
+    it "should validate the presence of 2 attributes" do
+      @invoice.clear
+      @invoice.should_not be_valid
+      @invoice.errors.should_not be_empty
+      @invoice.errors.on(:client_name).first.should == "Client name must not be blank"
+      @invoice.errors.on(:employee_name).should_not be_empty
+    end
+    
+    it "should let you set an error message" do
+      @invoice.location = nil
+      @invoice.valid?
+      @invoice.errors.on(:location).should == ["Hey stupid!, you forgot the location"]
+    end
+    
+    it "should validate before saving" do
+      @invoice.location = nil
+      @invoice.should_not be_valid
+      @invoice.save.should be_false
+      @invoice.should be_new_document
+    end
+  end
+  
+  describe "autovalidation" do
+    before(:each) do
+      @service = Service.new(:name => "Coumpound analysis", :price => 3_000)
+    end
+    
+    it "should be valid" do
+      @service.should be_valid
+    end
+    
+    it "should not respond to properties not setup" do
+      @service.respond_to?(:client_name).should be_false
+    end
+    
+    describe "property :name, :length => 4...20" do
+      
+      it "should autovalidate the presence when length is set" do
+        @service.name = nil
+        @service.should_not be_valid
+        @service.errors.should_not be_nil
+        @service.errors.on(:name).first.should == "Name must be between 4 and 19 characters long"
+      end
+    
+      it "should autovalidate the correct length" do
+        @service.name = "a"
+        @service.should_not be_valid
+        @service.errors.should_not be_nil
+        @service.errors.on(:name).first.should == "Name must be between 4 and 19 characters long"
+      end
+    end
+  end
+  
+  describe "casting" do
+    describe "cast keys to any type" do
+      before(:all) do
+        event_doc = { :subject => "Some event", :occurs_at => Time.now }
+        e = Event.database.save_doc event_doc
+
+        @event = Event.get e['id']
+      end
+      it "should cast created_at to Time" do
+        @event['occurs_at'].should be_an_instance_of(Time)
+      end
+    end
+  end
+  
+end

data/spec/fixtures/attachments/README

@@ -0,0 +1,3 @@
+This is an example README file.
+
+More of the README, whee.

data/spec/fixtures/attachments/test.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test</title>
+  </head>
+  <body>
+    <p>
+      Test
+    </p>
+  </body>
+</html>

data/spec/fixtures/more/article.rb

@@ -0,0 +1,34 @@
+class Article < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  unique_id :slug
+  
+  view_by :date, :descending => true
+  view_by :user_id, :date
+    
+  view_by :tags,
+    :map => 
+      "function(doc) {
+        if (doc['couchrest-type'] == 'Article' && doc.tags) {
+          doc.tags.forEach(function(tag){
+            emit(tag, 1);
+          });
+        }
+      }",
+    :reduce => 
+      "function(keys, values, rereduce) {
+        return sum(values);
+      }"  
+
+  property :date
+  property :slug, :read_only => true
+  property :title
+  property :tags
+
+  timestamps!
+  
+  save_callback :before, :generate_slug_from_title
+  
+  def generate_slug_from_title
+    self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'') if new_document?
+  end
+end

data/spec/fixtures/more/card.rb

@@ -0,0 +1,20 @@
+class Card < CouchRest::ExtendedDocument  
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  # set the auto_validation before defining the properties
+  auto_validate!
+  
+  # Set the default database to use
+  use_database TEST_SERVER.default_database
+  
+  # Official Schema
+  property :first_name
+  property :last_name,        :alias     => :family_name
+  property :read_only_value,  :read_only => true
+  
+  timestamps!
+  
+  # Validation
+  validates_present :first_name
+  
+end

data/spec/fixtures/more/course.rb

@@ -0,0 +1,14 @@
+require File.join(FIXTURE_PATH, 'more', 'question')
+require File.join(FIXTURE_PATH, 'more', 'person')
+
+class Course < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  
+  property :title
+  property :questions,      :cast_as => ['Question']
+  property :professor,      :cast_as => 'Person'
+  property :final_test_at,  :cast_as => 'Time'
+  
+  view_by :title
+  view_by :dept, :ducktype => true
+end

data/spec/fixtures/more/event.rb

@@ -0,0 +1,6 @@
+class Event < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  
+  property :subject
+  property :occurs_at, :cast_as => 'Time', :send => 'parse'
+end

data/spec/fixtures/more/invoice.rb

@@ -0,0 +1,17 @@
+class Invoice < CouchRest::ExtendedDocument  
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  
+  # Set the default database to use
+  use_database TEST_SERVER.default_database
+  
+  # Official Schema
+  property :client_name
+  property :employee_name
+  property :location
+  
+  # Validation
+  validates_present :client_name, :employee_name
+  validates_present :location, :message => "Hey stupid!, you forgot the location"
+  
+end

data/spec/fixtures/more/person.rb

@@ -0,0 +1,8 @@
+class Person < Hash
+  include ::CouchRest::CastedModel
+  property :name
+  
+  def last_name
+    name.last
+  end
+end

data/spec/fixtures/more/question.rb

@@ -0,0 +1,6 @@
+class Question < Hash
+  include ::CouchRest::CastedModel
+  
+  property :q
+  property :a
+end

data/spec/fixtures/more/service.rb

@@ -0,0 +1,12 @@
+class Service < CouchRest::ExtendedDocument  
+  # Include the validation module to get access to the validation methods
+  include CouchRest::Validation
+  auto_validate!
+  # Set the default database to use
+  use_database TEST_SERVER.default_database
+  
+  # Official Schema
+  property :name, :length => 4...20
+  property :price, :type => Integer
+  
+end

data/spec/fixtures/views/lib.js

@@ -0,0 +1,3 @@
+function globalLib() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/lib.js

@@ -0,0 +1,3 @@
+function justThisView() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/only-map.js

@@ -0,0 +1,4 @@
+function(doc) {
+  //include-lib
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-map.js

@@ -0,0 +1,3 @@
+function(doc) {
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-reduce.js

@@ -0,0 +1,3 @@
+function(ks,vs,co) {
+  return vs.length;
+};

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "spec" # Satisfies Autotest and anyone else not using the Rake tasks
+
+require File.join(File.dirname(__FILE__), '..','lib','couchrest')
+# check the following file to see how to use the spec'd features.
+
+unless defined?(FIXTURE_PATH)
+  FIXTURE_PATH = File.join(File.dirname(__FILE__), '/fixtures')
+  SCRATCH_PATH = File.join(File.dirname(__FILE__), '/tmp')
+
+  COUCHHOST = "http://127.0.0.1:5984"
+  TESTDB    = 'couchrest-test'
+  TEST_SERVER    = CouchRest.new
+  TEST_SERVER.default_database = TESTDB
+end
+
+class Basic < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+end
+
+def reset_test_db!
+  cr = TEST_SERVER
+  db = cr.database(TESTDB)
+  db.recreate! rescue nil
+  db
+end

data/utils/remap.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'couchrest'
+
+# set the source db and map view
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
+source_view = 'mydesign/view-map'
+
+# set the target db
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
+
+
+pager = CouchRest::Pager.new(source)
+
+# pager will yield once per uniq key in the source view
+
+pager.key_reduce(source_view, 10000) do |key, values|
+  # create a doc from the key and the values
+  example_doc = {
+    :key => key,
+    :values => values.uniq
+  }
+
+  target.save(example_doc)
+  
+  # keep us up to date with progress
+  puts k if (rand > 0.9)
+end

data/utils/subset.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'couchrest'
+
+# subset.rb replicates a percentage of a database to a fresh database.
+# use it to create a smaller dataset on which to prototype views.
+
+# specify the source database
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
+
+# specify the target database
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
+
+# pager efficiently yields all view rows
+pager = CouchRest::Pager.new(source)
+
+pager.all_docs(1000) do |rows|  
+  docs = rows.collect do |r|
+    # the percentage of docs to clone
+    next if rand > 0.1 
+    doc = source.get(r['id'])
+    doc.delete('_rev')
+    doc      
+  end.compact
+  puts docs.length
+  next if docs.empty?
+
+  puts docs.first['_id']
+  target.bulk_save(docs)
+end
+

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification 
+name: jchris-couchrest
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- J. Chris Anderson
+- Matt Aimonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+description: CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.
+email: jchris@apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+- THANKS.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- THANKS.md
+- examples/model
+- examples/model/example.rb
+- examples/word_count
+- examples/word_count/markov
+- examples/word_count/views
+- examples/word_count/views/books
+- examples/word_count/views/books/chunked-map.js
+- examples/word_count/views/books/united-map.js
+- examples/word_count/views/markov
+- examples/word_count/views/markov/chain-map.js
+- examples/word_count/views/markov/chain-reduce.js
+- examples/word_count/views/word_count
+- examples/word_count/views/word_count/count-map.js
+- examples/word_count/views/word_count/count-reduce.js
+- examples/word_count/word_count.rb
+- examples/word_count/word_count_query.rb
+- examples/word_count/word_count_views.rb
+- lib/couchrest
+- lib/couchrest/commands
+- lib/couchrest/commands/generate.rb
+- lib/couchrest/commands/push.rb
+- lib/couchrest/core
+- lib/couchrest/core/database.rb
+- lib/couchrest/core/design.rb
+- lib/couchrest/core/document.rb
+- lib/couchrest/core/response.rb
+- lib/couchrest/core/server.rb
+- lib/couchrest/core/view.rb
+- lib/couchrest/helper
+- lib/couchrest/helper/pager.rb
+- lib/couchrest/helper/streamer.rb
+- lib/couchrest/mixins
+- lib/couchrest/mixins/attachments.rb
+- lib/couchrest/mixins/callbacks.rb
+- lib/couchrest/mixins/design_doc.rb
+- lib/couchrest/mixins/document_queries.rb
+- lib/couchrest/mixins/extended_attachments.rb
+- lib/couchrest/mixins/extended_document_mixins.rb
+- lib/couchrest/mixins/properties.rb
+- lib/couchrest/mixins/validation.rb
+- lib/couchrest/mixins/views.rb
+- lib/couchrest/mixins.rb
+- lib/couchrest/monkeypatches.rb
+- lib/couchrest/more
+- lib/couchrest/more/casted_model.rb
+- lib/couchrest/more/extended_document.rb
+- lib/couchrest/more/property.rb
+- lib/couchrest/support
+- lib/couchrest/support/blank.rb
+- lib/couchrest/support/class.rb
+- lib/couchrest/validation
+- lib/couchrest/validation/auto_validate.rb
+- lib/couchrest/validation/contextual_validators.rb
+- lib/couchrest/validation/validation_errors.rb
+- lib/couchrest/validation/validators
+- lib/couchrest/validation/validators/absent_field_validator.rb
+- lib/couchrest/validation/validators/confirmation_validator.rb
+- lib/couchrest/validation/validators/format_validator.rb
+- lib/couchrest/validation/validators/formats
+- lib/couchrest/validation/validators/formats/email.rb
+- lib/couchrest/validation/validators/formats/url.rb
+- lib/couchrest/validation/validators/generic_validator.rb
+- lib/couchrest/validation/validators/length_validator.rb
+- lib/couchrest/validation/validators/method_validator.rb
+- lib/couchrest/validation/validators/numeric_validator.rb
+- lib/couchrest/validation/validators/required_field_validator.rb
+- lib/couchrest.rb
+- spec/couchrest
+- spec/couchrest/core
+- spec/couchrest/core/couchrest_spec.rb
+- spec/couchrest/core/database_spec.rb
+- spec/couchrest/core/design_spec.rb
+- spec/couchrest/core/document_spec.rb
+- spec/couchrest/core/server_spec.rb
+- spec/couchrest/helpers
+- spec/couchrest/helpers/pager_spec.rb
+- spec/couchrest/helpers/streamer_spec.rb
+- spec/couchrest/more
+- spec/couchrest/more/casted_extended_doc_spec.rb
+- spec/couchrest/more/casted_model_spec.rb
+- spec/couchrest/more/extended_doc_attachment_spec.rb
+- spec/couchrest/more/extended_doc_spec.rb
+- spec/couchrest/more/extended_doc_view_spec.rb
+- spec/couchrest/more/property_spec.rb
+- spec/fixtures
+- spec/fixtures/attachments
+- spec/fixtures/attachments/couchdb.png
+- spec/fixtures/attachments/README
+- spec/fixtures/attachments/test.html
+- spec/fixtures/couchapp
+- spec/fixtures/couchapp/_attachments
+- spec/fixtures/couchapp/_attachments/index.html
+- spec/fixtures/couchapp/doc.json
+- spec/fixtures/couchapp/foo
+- spec/fixtures/couchapp/foo/bar.txt
+- spec/fixtures/couchapp/foo/test.json
+- spec/fixtures/couchapp/test.json
+- spec/fixtures/couchapp/views
+- spec/fixtures/couchapp/views/example-map.js
+- spec/fixtures/couchapp/views/example-reduce.js
+- spec/fixtures/couchapp-test
+- spec/fixtures/couchapp-test/my-app
+- spec/fixtures/couchapp-test/my-app/_attachments
+- spec/fixtures/couchapp-test/my-app/_attachments/index.html
+- spec/fixtures/couchapp-test/my-app/foo
+- spec/fixtures/couchapp-test/my-app/foo/bar.txt
+- spec/fixtures/couchapp-test/my-app/views
+- spec/fixtures/couchapp-test/my-app/views/example-map.js
+- spec/fixtures/couchapp-test/my-app/views/example-reduce.js
+- spec/fixtures/more
+- spec/fixtures/more/article.rb
+- spec/fixtures/more/card.rb
+- spec/fixtures/more/course.rb
+- spec/fixtures/more/event.rb
+- spec/fixtures/more/invoice.rb
+- spec/fixtures/more/person.rb
+- spec/fixtures/more/question.rb
+- spec/fixtures/more/service.rb
+- spec/fixtures/views
+- spec/fixtures/views/lib.js
+- spec/fixtures/views/test_view
+- spec/fixtures/views/test_view/lib.js
+- spec/fixtures/views/test_view/only-map.js
+- spec/fixtures/views/test_view/test-map.js
+- spec/fixtures/views/test_view/test-reduce.js
+- spec/spec.opts
+- spec/spec_helper.rb
+- utils/remap.rb
+- utils/subset.rb
+has_rdoc: true
+homepage: http://github.com/jchris/couchrest
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Lean and RESTful interface to CouchDB.
+test_files: []
+