couch_potato 0.6.0 → 0.7.0.pre.1

data/.gitignore

@@ -1,6 +1,5 @@
 *.gem
 .bundle
-couch_potato_js_runner.js
 pkg
 .rvmrc
 *.swp

data/.travis.yml

@@ -1,5 +1,13 @@
 rvm:
   - 1.9.2
+  - 1.9.3
   - 1.8.7
   - ree
-env: "DATABASE='http://couchpotato.iriscouch.com/couch_potato_test' "
+gemfile:
+  - active_support_3_0
+  - active_support_3_1
+  - active_support_3_2
+before_script:
+  - sudo sh -c 'echo "[native_query_servers]" >> /etc/couchdb/local.ini'
+  - sudo sh -c 'echo "erlang = {couch_native_process, start_link, []}" >> /etc/couchdb/local.ini'
+  - sudo /etc/init.d/couchdb restart

data/CHANGES.md

@@ -1,5 +1,17 @@
 ## Changes
 
+### 0.7.0
+
+* ActiveSupport/Rails 3.2 compatibility  (Alexander Lang)
+* removed Object#try, String#blank? as they are part of ActiveSupport - ActiveSupport's try behaves differently than the couch potato implementation so this change might break your app (now calling a non-existant method on a non-nil raises a NoMethodError, before it did not)  (Alexander Lang)
+* bulk document loading (Matthias Jakel)
+* multi db support (Peter Schröder)
+* hash-style access to attributes (Peter Schröder)
+* support for properties of type Array, e.g. :type => [User] (Peter Schröder)
+* improve compatibility with state_machine (Alexander Lang)
+* allow false as default value for properties (Matthias Jakel)
+* support for Erlang views (Alexander Lang)
+
 ### 0.6.0
 
 * ActiveSupport/Rails 3.1 compatibility (Maximilian Mack)

data/Gemfile.lock

@@ -1,41 +1,46 @@
 PATH
   remote: .
   specs:
-    couch_potato (0.5.7)
+    couch_potato (0.6.0)
       activemodel
       couchrest (>= 1.0.1)
-      json
+      json (~> 1.6.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.6)
-      activesupport (= 3.0.6)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.6)
-    builder (2.1.2)
-    couchrest (1.0.2)
-      json (~> 1.5.1)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    couchrest (1.1.2)
       mime-types (~> 1.15)
+      multi_json (~> 1.0.0)
       rest-client (~> 1.6.1)
-    diff-lcs (1.1.2)
-    i18n (0.5.0)
-    json (1.5.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    json (1.6.1)
+    libv8 (3.3.10.4)
     mime-types (1.16)
-    rake (0.8.7)
-    rest-client (1.6.1)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
+    therubyracer (0.10.1)
+      libv8 (~> 3.3.10)
     timecop (0.3.5)
-    tzinfo (0.3.26)
+    tzinfo (0.3.30)
 
 PLATFORMS
   ruby
@@ -44,5 +49,6 @@ DEPENDENCIES
   couch_potato!
   rake
   rspec (>= 2.0)
+  therubyracer
   timecop
   tzinfo

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Bryan Helmkamp, Seth Fitzsimmons
+Copyright (c) 2012 Alexander Lang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,6 +2,8 @@
 
 ... is a persistence layer written in ruby for CouchDB.
 
+[![Build Status](https://secure.travis-ci.org/langalex/couch_potato.png?branch=master)](http://travis-ci.org/langalex/couch_potato)
+
 ### Mission
 
 The goal of Couch Potato is to create a minimal framework in order to store and retrieve Ruby objects to/from CouchDB and create and query views.
@@ -43,15 +45,15 @@ After that you configure the name of the database:
 The server URL will default to http://localhost:5984/ unless specified:
 
     CouchPotato::Config.database_name = "http://example.com:5984/name_of_the_db"
-    
+
 Or with authentication
-  
+
     CouchPotato::Config.database_name = "http://username:password@example.com:5984/name_of_the_db"
-  
-Optionally you can configure which framework you want to use for validations (either validatable or ActiveModel (default))
 
-    CouchPotato::Config.validation_framework = :validatable | :active_model
-    
+Optionally you can configure the default language for design documents (:javascript (default) or :erlang).
+
+    CouchPotato::Config.default_language = :javascript | :erlang
+
 Another switch allows you to store each CouchDB view in its own design document. Otherwise views are grouped by model.
 
     CouchPotato::Config.split_design_documents_per_view = true
@@ -61,8 +63,8 @@ Another switch allows you to store each CouchDB view in its own design document.
 Create a config/couchdb.yml:
 
     default: &default
-      validation_framework: :active_model # optional
       split_design_documents_per_view: true # optional
+      default_language: :erlang # optional
 
     development:
       <<: *default
@@ -80,7 +82,7 @@ Add to your _config/environment.rb_:
 
     config.gem 'couch_potato', :source => 'http://gemcutter.org'
     config.frameworks -= [:active_record] # if you switch completely
-    
+
 #### Rails 3.x
 
 Add to your _Gemfile_:
@@ -126,8 +128,8 @@ Properties can be typed:
 
       property :address, :type => Address
     end
-    
-In this case Address also implements CouchPotato::Persistence which means its JSON representation will be added to the user document.  
+
+In this case Address also implements CouchPotato::Persistence which means its JSON representation will be added to the user document.
 Couch Potato also has support for the basic types (right now Fixnum, Date, Time and :boolean are supported):
 
     class User
@@ -138,7 +140,7 @@ Couch Potato also has support for the basic types (right now Fixnum, Date, Time
     end
 
 With this in place when you set the user's age as a String (e.g. using an hTML form) it will be converted into a Fixnum automatically.
-    
+
 
 Properties can have a default value:
 
@@ -157,6 +159,11 @@ You can of course also retrieve your instance:
 
     CouchPotato.database.load_document "id_of_the_user_document" # => <#User 0x3075>
 
+#### Operations on multiple documents
+
+You can also load a bunch of documents with one request.
+
+    CouchPotato.database.load ['user1', 'user2', 'user3'] # => [<#User 0x3075>, <#User 0x3076>, <#User 0x3077>]
 
 #### Properties
 
@@ -178,6 +185,12 @@ If you want to have properties that don't map to any JSON type, i.e. other than
 
 The date_of_birth property is now automatically serialized to JSON and back when storing/retrieving objects.
 
+If you want to store an Array of objects, just pass the definiton as an Array of Dates:
+
+    class User
+      property :birthdays, :type => [Date]
+    end
+
 #### Dirty tracking
 
 CouchPotato tracks the dirty state of attributes in the same way ActiveRecord does:
@@ -208,8 +221,6 @@ Couch Potato by default uses ActiveModel for validation
     user = User.new
     user.valid? # => false
     user.errors[:name] # => ['can't be blank']
-  
-If you want you can use [Validatable](http://validatable.rubyforge.org/) by setting `CouchPotato::Config.validation(http://validatable.rubyforge.org/)\_framework = :validatable`
 
 #### Finding stuff / views / lists
 
@@ -240,6 +251,16 @@ Composite keys are also possible:
       view :all, :key => [:created_at, :name]
     end
 
+You can let Couch Potato generate these map/reduce functions in Erlang, which reslts in much faster view generation:
+
+    class User
+      property :name
+
+      view :all, :key => [:created_at, :name], :language => :erlang
+    end
+
+So far only very simple views like the above work with Erlang.
+
 You can also pass conditions as a JavaScript string:
 
     class User
@@ -261,12 +282,12 @@ If you have larger structures and you only want to load some attributes you can
 
     CouchPotato.database.view(User.everyone).first.name # => "joe"
     CouchPotato.database.view(User.everyone).first.bio # => nil
-  
+
     CouchPotato.database.first(User.everyone).name # => "joe" # convenience function, returns nil if nothing found
     CouchPotato.database.first!(User.everyone) # would raise CouchPotato::NotFound if nothing was found
 
 If you want Rails to automatically show a 404 page when `CouchPotato::NotFound` is raised add this to your `ApplicationController`:
-    
+
     rescue_from CouchPotato::NotFound do
       render(:file => 'public/404.html', :status => :not_found, :layout => false)
     end
@@ -303,11 +324,11 @@ Defining a list works similarly to views:
 
     class User
       include CouchPotato::Persistence
-      
+
       property :first_name
       view :with_full_name, key: first_namne, list: :add_last_name
       view :all, key: :first_name
-      
+
       list :add_last_name, <<-JS
         function(head, req) {
           var row;
@@ -320,10 +341,10 @@ Defining a list works similarly to views:
         }
       JS
     end
-    
+
     CouchPotato.database.save User.new(first_name: 'joe')
     CouchPotato.database.view(User.with_full_name).first.name # => 'joe doe'
-    
+
 You can also pass in the list at query time:
 
     CouchPotato.database.view(User.all(list: :add_last_name))
@@ -356,16 +377,26 @@ There is basic attachment support: if you want to store any attachments set the
     class User
       include CouchPotato::Persistence
     end
-    
+
     data = File.read('some_file.text') # or from upload
     user = User.new
     user._attachments = {'photo' => {'data' => data, 'content_type' => 'image/png'}}
-    
+
 When saving this object an attachment with the name _photo_ will be uploaded into CouchDB. It will be available under the url of the user object + _/photo_. When loading the user at a later time you still have access to the _content_type_ and additionally to the _length_ of the attachment:
 
     user_reloaded = CouchPotato.database.load user.id
     user_reloaded._attachments['photo'] # => {'content_type' => 'image/png', 'length' => 37861}
 
+#### Multi DB Support
+
+Couch Potato supports accessing multiple CouchDBs:
+
+    CouchPotato.with_database('couch_customer') do |couch|
+      couch.save @customer
+    end
+
+Unless configured otherwise this would save the customer model to _http://127.0.0.1:5984/couch_customer_.
+
 #### Testing
 
 To make testing easier and faster database logic has been put into its own class, which you can replace and stub out in whatever way you want:
@@ -392,13 +423,13 @@ For stubbing out the database couch potato offers some helpers:
     class Comment
       view :by_commenter_id, :key => :commenter_id
     end
-    
+
     # RSpec
     require 'couch_potato/rspec'
-    
+
     db = stub_db # stubs CouchPotato.database
     db.stub_view(Comment, :by_commenter_id).with('23').and_return([:comment1, :comment2])
-    
+
     CouchPotato.database.view(Comment.by_commenter_id('23)) # => [:comment1, :comment2]
     CouchPotato.database.first(Comment.by_commenter_id('23)) # => :comment1
 
@@ -406,30 +437,29 @@ For stubbing out the database couch potato offers some helpers:
 
 Couch Potato provides custom RSpec matchers for testing the map and reduce functions of your views. For example you can do this:
 
-    Class User
+    class User
       include CouchPotato::Persistence
-      
+
+      property :name
+      property :age, :type => Fixnum
+
       view :by_name, :key => :name
-      view :by_age, :key => :age
+      view :by_age,  :key => :age
     end
-    
+
     #RSpec
     require 'couch_potato/rspec'
-    
-    describe User, 'by_name' do
+
+    describe User, 'views' do
       it "should map users to their name" do
-        User.by_name.should map(User.new(:name => 'bill', :age => 23)).to(['bill', null])
+        User.by_name.should map(User.new(:name => 'bill', :age => 23)).to(['bill', 1])
       end
-      
+
       it "should reduce the users to the sum of their age" do
-        User.by_age.should reduce([], [[23], [22]]).to(45)
-      end
-      
-      it "should rereduce" do
-        User.by_age.should rereduce([], [[23], [22]]).to(45)
+        User.by_age.should reduce([], [23, 22]).to(45)
       end
     end
-    
+
 This will actually run your map/reduce functions in a JavaScript interpreter, passing the arguments as JSON and converting the results back to Ruby. For more examples see the [spec](http://github.com/langalex/couch_potato/blob/master/spec/unit/rspec_matchers_spec.rb).
 
 In order for this to work you must have the `js` executable in your PATH. This is usually part of the _spidermonkey_ package/port. (On MacPorts that's _spidemonkey_, on Linux it could be one of _libjs_, _libmozjs_ or _libspidermonkey_). When you installed CouchDB via your packet manager Spidermonkey should already be there.

data/Rakefile

@@ -3,82 +3,41 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 require "rspec/core/rake_task"
-require 'rake/rdoctask'
-
-def with_validatable(&block)
-  begin
-    require 'validatable'
-    
-    ENV['VALIDATION_FRAMEWORK'] = 'validatable'
-    puts "Running task with Validatable validation framework."
-    yield block
-  rescue LoadError
-    STDERR.puts "WARNING: Validatable not available, skipping task."
-  end
-end
-
-def with_active_model(&block)
-  begin
-    require 'active_model'
-    
-    ENV['VALIDATION_FRAMEWORK'] = 'active_model'
-    puts "Running task with ActiveModel validation framework."
-    yield block
-  rescue LoadError
-    STDERR.puts "WARNING: ActiveModel not available, skipping task."
-  end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
 end
 
 task :default => :spec
 
-task :spec_functional_validatable do
-  with_validatable { Rake::Task['spec_functional_default'].execute }
-end
-
-task :spec_functional_active_model do
-  with_active_model { Rake::Task['spec_functional_default'].execute }
-end
-
-task :spec_unit_validatable do
-  with_validatable { Rake::Task['spec_unit_default'].execute }
-end
-
-task :spec_unit_active_model do
-  with_active_model { Rake::Task['spec_unit_default'].execute }
-end
-
-desc "Run functional specs with default validation framework, override with VALIDATION_FRAMEWORK"
-RSpec::Core::RakeTask.new(:spec_functional_default) do |spec|
+desc "Run functional specs"
+RSpec::Core::RakeTask.new(:spec_functional) do |spec|
   spec.pattern = 'spec/*_spec.rb'
   spec.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
 end
 
-desc "Run unit specs with default validation framework, override with VALIDATION_FRAMEWORK"
-RSpec::Core::RakeTask.new(:spec_unit_default) do |spec|
+desc "Run unit specs"
+RSpec::Core::RakeTask.new(:spec_unit) do |spec|
   spec.pattern = 'spec/unit/*_spec.rb'
   spec.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
 end
 
-desc "Run functional specs with all validation frameworks"
-task :spec_functional => [:spec_functional_validatable, :spec_functional_active_model] do
-end
-
-desc "Run unit specs with all validation frameworks"
-task :spec_unit => [:spec_unit_validatable, :spec_unit_active_model] do
-end
-
 desc "Run all specs"
 task :spec do
-  ['3_0', '3_1'].each do |version|
-    Bundler.with_clean_env do
-      ENV['BUNDLE_GEMFILE'] = "active_support_#{version}"
-      sh "bundle install"
-      Rake::Task[:spec_unit_active_model].execute
-      Rake::Task[:spec_functional_active_model].execute
-      Rake::Task[:spec_unit_validatable].execute
-      Rake::Task[:spec_functional_validatable].execute
+  if ENV['TRAVIS'] # travis handles the environments for us
+    Rake::Task[:spec_unit].execute
+    Rake::Task[:spec_functional].execute
+  else
+    ['3_0', '3_1', '3_2'].each do |version|
+      Bundler.with_clean_env do
+        puts "Running tests with ActiveSupport #{version.sub('_', '.')}"
+        sh "env BUNDLE_GEMFILE=active_support_#{version} bundle install"
+        sh "env BUNDLE_GEMFILE=active_support_#{version} bundle exec rake spec_unit spec_functional"
+      end
     end
   end
+
 end
 
 desc 'Generate documentation'

data/active_support_3_0.lock

@@ -22,6 +22,7 @@ GEM
     diff-lcs (1.1.2)
     i18n (0.5.0)
     json (1.6.1)
+    libv8 (3.3.10.4)
     mime-types (1.16)
     multi_json (1.0.3)
     rake (0.8.7)
@@ -35,6 +36,8 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
+    therubyracer (0.10.1)
+      libv8 (~> 3.3.10)
     timecop (0.3.5)
     tzinfo (0.3.26)
 
@@ -46,5 +49,6 @@ DEPENDENCIES
   couch_potato!
   rake
   rspec (>= 2.0)
+  therubyracer
   timecop
   tzinfo

data/active_support_3_1.lock

@@ -25,6 +25,7 @@ GEM
     diff-lcs (1.1.2)
     i18n (0.6.0)
     json (1.6.1)
+    libv8 (3.3.10.4)
     mime-types (1.16)
     multi_json (1.0.3)
     rake (0.9.2)
@@ -38,6 +39,8 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
+    therubyracer (0.10.1)
+      libv8 (~> 3.3.10)
     timecop (0.3.5)
     tzinfo (0.3.29)
 
@@ -49,5 +52,6 @@ DEPENDENCIES
   couch_potato!
   rake
   rspec (>= 2.0)
+  therubyracer
   timecop
   tzinfo

data/active_support_3_2

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'activemodel', '~>3.2'
+gemspec

data/active_support_3_2.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    couch_potato (0.6.0)
+      activemodel
+      couchrest (>= 1.0.1)
+      json (~> 1.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    couchrest (1.1.2)
+      mime-types (~> 1.15)
+      multi_json (~> 1.0.0)
+      rest-client (~> 1.6.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    json (1.6.5)
+    libv8 (3.3.10.4)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    therubyracer (0.10.1)
+      libv8 (~> 3.3.10)
+    timecop (0.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.2)
+  couch_potato!
+  rake
+  rspec (>= 2.0)
+  therubyracer
+  timecop
+  tzinfo

data/couch_potato.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'tzinfo'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'therubyracer'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")