couch_potato 0.7.1 → 1.0.0

data/.gitignore

@@ -3,3 +3,4 @@
 pkg
 .rvmrc
 *.swp
+*.lock

data/.travis.yml

@@ -1,11 +1,15 @@
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
 gemfile:
-  - active_support_3_0
-  - active_support_3_1
   - active_support_3_2
+  - active_support_4_0
 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
+matrix:
+  allow_failures:
+    - rvm: jruby

data/CHANGES.md

@@ -1,5 +1,19 @@
 ## Changes
 
+### 1.0.0
+
+* adds `reload` method (Alexander Lang)
+* removes `total_rows` from database results (Alexander Lang)
+* changes `==` to use ids instead of comparing all attributes (orders of magnitude faster) ([Jochen Kramer](https://github.com/freetwix))
+* fixes decoding JSON objects for newer versions of the JSON gem (Alexander Lang)
+* adds support for testing map/reduce/rereduce (Andy Morris)
+* fixes serializing dates in map/reduce specs (Andy Morris)
+* adds support for Rails4 forbidden attributes protection (Alexander Lang)
+* adds Rails4, drops 3.0/3.1 support (Alexander Lang)
+* adds property default values returned by Procs (Andy Morris)
+* adds suppot for BigDecimal properties (Fredrik Rubensson)
+* adds support for 2.0, Rubinius, 1.9.3, drops Ruby 1.8, 1.9.2
+
 ### 0.7.1
 
 * fixes a bug when trying to bulk-load non-existant documents

data/README.md

@@ -6,7 +6,7 @@
 
 [![Dependencies](https://gemnasium.com/langalex/couch_potato.png)](https://gemnasium.com/langalex/couch_potato)
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/langalex/couch_potato)
+[![Code Climate](https://codeclimate.com/github/langalex/couch_potato.png)](https://codeclimate.com/github/langalex/couch_potato)
 
 
 ### Mission
@@ -27,8 +27,9 @@ Lastly Couch Potato aims to provide a seamless integration with Ruby on Rails, e
 
 ### Supported Environments
 
-* Ruby 1.9.2
-* CouchDB 1.1.0
+* Ruby 1.9.3
+* CouchDB 1.2.0
+* ActiveSupport 3.2, 4.0
 
 (Supported means I run the specs against those before releasing a new gem.)
 
@@ -36,7 +37,7 @@ Lastly Couch Potato aims to provide a seamless integration with Ruby on Rails, e
 
 Couch Potato is hosted as a gem which you can install like this:
 
-    (sudo) gem install couch_potato
+    gem install couch_potato
 
 #### Using with your ruby application:
 
@@ -81,13 +82,6 @@ Create a config/couchdb.yml:
       <<: *default
       database: <%= ENV['DB_NAME'] %>
 
-#### Rails 2.x
-
-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_:
@@ -98,6 +92,7 @@ Add to your _Gemfile_:
     gem 'actionmailer'
     gem 'activemodel'
     gem "couch_potato"
+    gem 'tzinfo'
 
 Note: please make sure that when you run `Date.today.as_json` in the Rails console it returns something like `2010/12/10` and not `2010-12-10` - if it does another gem has overwritten Couch Potato's Date patches - in this case move Couch Potato further down in your Gemfile or whereever you load it.
 
@@ -153,6 +148,7 @@ Properties can have a default value:
       include CouchPotato::Persistence
 
       property :active, :default => true
+      property :signed_up, :default => Proc.new { Time.now }
     end
 
 Now you can save your objects. All database operations are encapsulated in the CouchPotato::Database class. This separates your domain logic from the database access logic which makes it easier to write tests and also keeps you models smaller and cleaner.
@@ -450,6 +446,9 @@ Couch Potato provides custom RSpec matchers for testing the map and reduce funct
 
       view :by_name, :key => :name
       view :by_age,  :key => :age
+      view :oldest_by_name,
+        :map => "function(doc) { emit(doc.name, doc.age); }",
+        :reduce => "function(keys, values, rereduce) { return Math.max.apply(this, values); }"
     end
 
     #RSpec
@@ -463,9 +462,15 @@ Couch Potato provides custom RSpec matchers for testing the map and reduce funct
       it "should reduce the users to the sum of their age" do
         User.by_age.should reduce([], [23, 22]).to(45)
       end
+
+      it "should map/reduce users to the oldest age by name" do
+        docs = [User.new(:name => "John", :age => 25), User.new(:name => "John", :age => 30), User.new(:name => "Jane", :age => 20)]
+        User.oldest_by_name.should map_reduce(docs).with_options(:group => true).to(
+          {"key" => "John", "value" => 30}, {"key" => "Jane", "value" => 20})
+      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).
+This will actually run your map/reduce functions in a JavaScript interpreter, passing the arguments as JSON and converting the results back to Ruby. ```map_reduce``` specs map the input documents, reduce the emitted keys/values, and rereduce the results while also respecting the ```:group``` and ```:group_level``` couchdb options. 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,11 +3,6 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 require "rspec/core/rake_task"
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rake/rdoctask'
-end
 
 task :default => :spec
 
@@ -29,7 +24,7 @@ task :spec do
     Rake::Task[:spec_unit].execute
     Rake::Task[:spec_functional].execute
   else
-    ['3_0', '3_1', '3_2'].each do |version|
+    ['3_2', '4_0'].each do |version|
       Bundler.with_clean_env do
         puts "Running tests with ActiveSupport #{version.sub('_', '.')}"
         sh "env BUNDLE_GEMFILE=active_support_#{version} bundle install"
@@ -37,15 +32,4 @@ task :spec do
       end
     end
   end
-
-end
-
-desc 'Generate documentation'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Couch Potato'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/couch_potato.rb')
-  rdoc.rdoc_files.include('lib/couch_potato/**/*.rb')
 end

data/active_support_3_2

@@ -1,4 +1,10 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'activemodel', '~>3.2'
+if RUBY_PLATFORM =~ /java/
+  gem 'therubyrhino'
+else
+   gem 'therubyracer'
+end
+
 gemspec

data/active_support_4_0

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~>4.0.0.rc1'
+gem 'rails', '~>4.0.0.rc1'
+if RUBY_PLATFORM =~ /java/
+  gem 'therubyrhino'
+else
+   gem 'therubyracer'
+end
+
+gemspec

data/couch_potato.gemspec

@@ -13,14 +13,13 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
 
   s.add_dependency 'json', '~> 1.6'
-  s.add_dependency 'couchrest', '>=1.0.1'
+  s.add_dependency 'couchrest', '~>1.2.0'
   s.add_dependency 'activemodel'
 
-  s.add_development_dependency 'rspec', '>=2.0'
+  s.add_development_dependency 'rspec', '~>2.11.0'
   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")

data/lib/couch_potato/database.rb

@@ -14,7 +14,6 @@ module CouchPotato
 
     # executes a view and return the results. you pass in a view spec
     # which is usually a result of a SomePersistentClass.some_view call.
-    # also return the total_rows returned by CouchDB as an accessor on the results.
     #
     # Example:
     #
@@ -26,7 +25,6 @@ module CouchPotato
     #   db = CouchPotato.database
     #
     #   db.view(User.all) # => [user1, user2]
-    #   db.view(User.all).total_rows # => 2
     #
     # You can pass the usual parameters you can pass to a couchdb view to the view:
     #
@@ -55,7 +53,6 @@ module CouchPotato
         spec.language
       ).query_view!(spec.view_parameters)
       processed_results = spec.process_results results
-      processed_results.instance_eval "def total_rows; #{results['total_rows']}; end" if results['total_rows']
       processed_results.each do |document|
         document.database = self if document.respond_to?(:database=)
       end if processed_results.respond_to?(:each)

data/lib/couch_potato/forbidden_attributes_protection.rb

@@ -0,0 +1,15 @@
+module CouchPotato
+  module ForbiddenAttributesProtection
+    def self.included(base)
+      base.class_eval do
+        if defined?(ActiveModel::ForbiddenAttributesProtection)
+          include ActiveModel::ForbiddenAttributesProtection
+
+          def attributes=(attributes)
+            super sanitize_for_mass_assignment(attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/simple_property.rb

@@ -56,7 +56,11 @@ module CouchPotato
             load_attribute_from_document(name) unless instance_variable_defined?("@#{name}")
             value = instance_variable_get("@#{name}")
             if value.nil? && !options[:default].nil?
-              default = clone_attribute(options[:default])
+              default = if options[:default].respond_to?(:call)
+                options[:default].call
+              else
+                clone_attribute(options[:default])
+              end
               self.instance_variable_set("@#{name}", default)
               default
             else

data/lib/couch_potato/persistence/type_caster.rb

@@ -32,6 +32,8 @@ module CouchPotato
             BigDecimal.new(value.to_s.scan(NUMBER_REGEX).join).round unless value.blank?
           elsif type == Float
             value.to_s.scan(NUMBER_REGEX).join.to_f unless value.blank?
+          elsif type == BigDecimal
+            BigDecimal.new(value.to_s) unless value.blank?
           else
             type.json_create value unless value.blank?
           end

data/lib/couch_potato/persistence.rb

@@ -9,6 +9,7 @@ require File.dirname(__FILE__) + '/persistence/dirty_attributes'
 require File.dirname(__FILE__) + '/persistence/ghost_attributes'
 require File.dirname(__FILE__) + '/persistence/attachments'
 require File.dirname(__FILE__) + '/persistence/type_caster'
+require File.dirname(__FILE__) + '/forbidden_attributes_protection'
 require File.dirname(__FILE__) + '/view/custom_views'
 require File.dirname(__FILE__) + '/view/lists'
 require File.dirname(__FILE__) + '/view/view_query'
@@ -20,7 +21,7 @@ module CouchPotato
     def self.included(base) #:nodoc:
       base.send :include, Properties, Callbacks, Json, CouchPotato::View::CustomViews, CouchPotato::View::Lists
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
-      base.send :include, MagicTimestamps, ActiveModelCompliance
+      base.send :include, MagicTimestamps, ActiveModelCompliance, ForbiddenAttributesProtection
       base.send :include, Validation
       base.class_eval do
         attr_accessor :_id, :_rev, :_deleted, :database
@@ -51,9 +52,7 @@ module CouchPotato
     def initialize(attributes = {})
       if attributes
         @skip_dirty_tracking = true
-        attributes.each do |name, value|
-          self.send("#{name}=", value)
-        end
+        self.attributes = attributes
         @skip_dirty_tracking = false
       end
       yield self if block_given?
@@ -121,7 +120,7 @@ module CouchPotato
     end
 
     def ==(other) #:nodoc:
-      other.class == self.class && self.to_json == other.to_json
+      super || (self.class == other.class && self._id.present? && self._id == other._id)
     end
 
     def eql?(other)
@@ -132,6 +131,11 @@ module CouchPotato
       _id.hash * (_id.hash.to_s.size ** 10) + _rev.hash
     end
 
+    # Returns a reloaded instance. Does not touch the original instance.
+    def reload
+      database.load id
+    end
+
     def inspect
       attributes_as_string = attributes.map {|attribute, value| "#{attribute}: #{value.inspect}"}.join(", ")
       %Q{#<#{self.class} _id: "#{_id}", _rev: "#{_rev}", #{attributes_as_string}>}

data/lib/couch_potato/rspec/matchers/list_as_matcher.rb

@@ -20,7 +20,6 @@ module CouchPotato
 
       def matches?(view_spec)
         js = <<-JS
-          #{File.read(File.dirname(__FILE__) + '/print_r.js')}
           #{File.read(File.dirname(__FILE__) + '/json2.js')}
           var results = #{@results_ruby.to_json};
           var listed = '';
@@ -33,7 +32,7 @@ module CouchPotato
             listed = listed + text;
           };
           list();
-          print_r(JSON.parse(listed));
+          JSON.stringify(JSON.parse(listed));
         JS
 
         @actual_ruby = JSON.parse(run_js(js))

data/lib/couch_potato/rspec/matchers/map_reduce_to_matcher.rb

@@ -0,0 +1,114 @@
+require 'json'
+
+module CouchPotato
+  module RSpec
+    class MapReduceToProxy
+      def initialize(*input_ruby)
+        @input_ruby, @options = input_ruby.flatten, {}
+      end
+
+      def with_options(options)
+        @options = options
+        self
+      end
+
+      def to(*expected_ruby)
+        MapReduceToMatcher.new(expected_ruby, @input_ruby, @options)
+      end
+    end
+
+    class MapReduceToMatcher
+      include RunJS
+
+      def initialize(expected_ruby, input_ruby, options)
+        @expected_ruby = expected_ruby
+        @input_ruby = input_ruby
+        @options = options
+      end
+
+      def matches?(view_spec)
+        js = <<-JS
+          var docs = #{@input_ruby.to_json};
+          var options = #{@options.to_json};
+          var map = #{view_spec.map_function};
+          var reduce = #{view_spec.reduce_function};
+
+          // Map the input docs
+          var mapResults = [];
+          var emit = function(key, value) {
+            mapResults.push({key: key, value: value});
+          };
+          for (var i in docs) {
+            map(docs[i]);
+          }
+
+          // Group the map results, honoring the group and group_level options
+          var grouped = [];
+          if (options.group || options.group_level) {
+            var groupLevel = options.group_level;
+            if (groupLevel == "exact" || options.group == true)
+              groupLevel = 9999;
+            var keysEqual = function(a, b) { return !(a < b || b < a); }
+
+            for (var mr in mapResults) {
+              var mapResult = mapResults[mr];
+              var groupedKey = mapResult.key.slice(0, groupLevel);
+              var groupFound = false;
+              for (var g in grouped) {
+                var group = grouped[g];
+                if (keysEqual(groupedKey, group.groupedKey)) {
+                  group.keys.push(mapResult.key);
+                  group.values.push(mapResult.value);
+                  groupFound = true;
+                  break;
+                }
+              }
+
+              if (!groupFound)
+                grouped.push({keys: [mapResult.key], groupedKey: groupedKey, values: [mapResult.value]});
+            }
+          } else {
+            var group = {keys: null, groupedKey: null, values: []};
+            for (var mr in mapResults)
+              group.values.push(mapResults[mr].value);
+            grouped.push(group);
+          }
+
+          // Reduce the grouped map results
+          var results = [];
+          for (var g in grouped) {
+            var group = grouped[g], reduced = null;
+            if (group.values.length >= 2) {
+              // Split the values into two parts, reduce each part, then rereduce those results
+              var mid = parseInt(group.values.length / 2);
+              var keys1 = (group.keys || []).slice(0, mid),
+                  values1 = group.values.slice(0, mid);
+              var reduced1 = reduce(keys1, values1, false);
+              var keys2 = (group.keys || []).slice(mid, group.values.length),
+                  values2 = group.values.slice(mid, group.values.length);
+              var reduced2 = reduce(keys2, values2, false);
+              reduced = reduce(null, [reduced1, reduced2], true);
+            } else {
+              // Not enough values to split, so just reduce, and then rereduce the single result
+              reduced = reduce(group.keys, group.values, false);
+              reduced = reduce(null, [reduced], true);
+            }
+            results.push({key: group.groupedKey, value: reduced});
+          }
+
+          JSON.stringify(results);
+        JS
+        @actual_ruby = JSON.parse(run_js(js))
+        @expected_ruby == @actual_ruby
+      end
+
+      def failure_message_for_should
+        "Expected to map/reduce to #{@expected_ruby.inspect} but got #{@actual_ruby.inspect}."
+      end
+
+      def failure_message_for_should_not
+        "Expected not to map/reduce to #{@actual_ruby.inspect} but did."
+      end      
+    end
+  end
+end

data/lib/couch_potato/rspec/matchers/map_to_matcher.rb

@@ -23,7 +23,6 @@ module CouchPotato
 
       def matches?(view_spec)
         js = <<-JS
-          #{File.read(File.dirname(__FILE__) + '/print_r.js')}
           var doc = #{@input_ruby.to_json};
           var map = #{view_spec.map_function};
           var result = [];
@@ -31,7 +30,7 @@ module CouchPotato
             result.push([key, value]);
           };
           map(doc);
-          print_r(result);
+          JSON.stringify(result);
         JS
         @actual_ruby = JSON.parse(run_js(js))
         @expected_ruby == @actual_ruby

data/lib/couch_potato/rspec/matchers/reduce_to_matcher.rb

@@ -1,26 +1,24 @@
 module CouchPotato
   module RSpec
     class ReduceToProxy
-      def initialize(docs, keys, rereduce = false)
-        @docs, @keys, @rereduce = docs, keys, rereduce
+      def initialize(keys, values, rereduce = false)
+        @keys, @values, @rereduce = keys, values, rereduce
       end
 
       def to(expected_ruby)
-        ReduceToMatcher.new(expected_ruby, @docs, @keys, @rereduce)
+        ReduceToMatcher.new(expected_ruby, @keys, @values, @rereduce)
       end
     end
 
     class ReduceToMatcher
       include RunJS
 
-      def initialize(expected_ruby, docs, keys, rereduce = false)
-        @expected_ruby, @docs, @keys, @rereduce = expected_ruby, docs, keys, rereduce
+      def initialize(expected_ruby, keys, values, rereduce = false)
+        @expected_ruby, @keys, @values, @rereduce = expected_ruby, keys, values, rereduce
       end
 
       def matches?(view_spec)
         js = <<-JS
-          #{File.read(File.dirname(__FILE__) + '/print_r.js')}
-
           sum = function(values) {
             var rv = 0;
             for (var i in values) {
@@ -29,10 +27,10 @@ module CouchPotato
             return rv;
           };
 
-          var docs = #{@docs.to_json};
           var keys = #{@keys.to_json};
+          var values = #{@values.to_json};
           var reduce = #{view_spec.reduce_function};
-          print_r({result: reduce(docs, keys, #{@rereduce})});
+          JSON.stringify({result: reduce(keys, values, #{@rereduce})});
         JS
         @actual_ruby = JSON.parse(run_js(js))['result']
         @expected_ruby == @actual_ruby

data/lib/couch_potato/rspec/matchers.rb

@@ -1,4 +1,12 @@
-require 'v8'
+begin
+  require 'v8'
+rescue LoadError
+  begin
+    require 'rhino'
+  rescue LoadError
+    STDERR.puts "You need to install therubyracer (or therhinoracer on jruby) to use matchers"
+  end
+end
 
 module CouchPotato
   module RSpec
@@ -6,8 +14,11 @@ module CouchPotato
       private
 
       def run_js(js)
-        cxt = V8::Context.new
-        cxt.eval(js)
+        if defined?(V8)
+          V8::Context.new.eval(js)
+        else
+          Rhino::Context.open{|cxt| cxt.eval(js)}
+        end
       end
     end
   end
@@ -16,6 +27,7 @@ end
 
 require 'couch_potato/rspec/matchers/map_to_matcher'
 require 'couch_potato/rspec/matchers/reduce_to_matcher'
+require 'couch_potato/rspec/matchers/map_reduce_to_matcher'
 require 'couch_potato/rspec/matchers/list_as_matcher'
 
 module RSpec
@@ -24,17 +36,21 @@ module RSpec
       CouchPotato::RSpec::MapToProxy.new(document)
     end
 
-    def reduce(docs, keys)
-      CouchPotato::RSpec::ReduceToProxy.new(docs, keys)
+    def reduce(keys, values)
+      CouchPotato::RSpec::ReduceToProxy.new(keys, values)
     end
 
-    def rereduce(docs, keys)
-      CouchPotato::RSpec::ReduceToProxy.new(docs, keys, true)
+    def rereduce(keys, values)
+      CouchPotato::RSpec::ReduceToProxy.new(keys, values, true)
     end
 
     def list(results)
       CouchPotato::RSpec::ListAsProxy.new(results)
     end
+
+    def map_reduce(*docs)
+      CouchPotato::RSpec::MapReduceToProxy.new(docs)
+    end
   end
 end
 

data/lib/couch_potato/version.rb

@@ -1,3 +1,3 @@
 module CouchPotato
-  VERSION = "0.7.1"
+  VERSION = "1.0.0"
 end

data/lib/couch_potato/view/base_view_spec.rb

@@ -3,7 +3,7 @@ module CouchPotato
     class BaseViewSpec
       attr_reader :reduce_function, :list_name, :list_function, :design_document, :view_name, :klass, :options, :language
       attr_accessor :view_parameters
-      
+
       private :klass, :options
 
       def initialize(klass, view_name, options, view_parameters)
@@ -27,7 +27,11 @@ module CouchPotato
       end
 
       def process_results(results)
-        results
+        if (filter = options[:results_filter])
+          filter.call results
+        else
+          results
+        end
       end
 
       private

data/lib/couch_potato/view/custom_view_spec.rb

@@ -8,35 +8,36 @@ module CouchPotato
       def map_function
         options[:map]
       end
-      
+
       def reduce_function
         options[:reduce]
       end
-      
+
       def view_parameters
         {:include_docs => options[:include_docs] || false}.merge(super)
       end
-      
+
       def process_results(results)
-        if count?
-          results['rows'].first.try(:[], 'value') || 0
-        else  
-          results['rows'].map do |row|
-            if row['doc'].instance_of?(klass)
-              row['doc']
-            else
-              klass.json_create row['doc'] || row['value'].merge(:_id => row['id'] || row['key'])
-            end
-          end
-        end
+        processed = if count?
+                      results['rows'].first.try(:[], 'value') || 0
+                    else
+                      results['rows'].map do |row|
+                        if row['doc'].instance_of?(klass)
+                          row['doc']
+                        else
+                          result = row['doc'] || (row['value'].merge(:_id => row['id'] || row['key']) unless view_parameters[:include_docs])
+                          klass.json_create result if result
+                        end
+                      end.compact
+                    end
+        super processed
       end
-      
-      private 
-      
+
+      private
+
       def count?
         view_parameters[:reduce]
       end
-      
     end
   end
-end
+end