couchbase-model 0.1.0 → 0.2.0

data/HISTORY.markdown

@@ -0,0 +1,44 @@
+## 0.2.0 / 2012-09-18
+
+* Add Rails 3 configuration possibilities, allow configuring
+  ensure_design_documents to disable/enable the auto view upgrade
+  (thanks to David Rice)
+* Ensure views directory is always set (thanks to David Rice)
+* Fix tests for ruby 1.8.7
+* Reword header in README
+* Merge pull request #3 from davidjrice/master
+* Use debugger gem
+* Update Model wrapper to match latest API changes
+* Strip contents of the JS file
+* Do not submit empty views
+* Allow to specify default view options
+* Display only non-nil values
+* Rename underscored methods
+* Load spatial views into design document
+
+## 0.1.0 / 2012-04-10
+
+* Allows to define several attributes at once
+* Allow to specify default value
+* Add missing @since and @return tags
+* Add railtie
+* Add config generator
+* Use verbose mode by default for GET operation
+* Add views generators
+* Update document wrapper
+* Add code to upgrade design docs automatically
+* Cache design document signature in memory
+* Use symbols for attribute hash
+* Skip connection errors during start up
+* Don't show config warning for config generator
+* Calculate mtime of the design document
+* Assign current_doc after creation
+* Update readme file
+* Use preview repository for travis
+* Do not make zipball
+* Show model attributes with model class
+* Update test. The couchbase gem is using new defaults
+
+## 0.0.1/ 2012-03-17
+
+* Initial version

data/README.markdown

@@ -83,7 +83,7 @@ You can define connection options on per model basis:
       connect :port => 80, :bucket => 'blog'
     end
 
-## Views (aka Map/Reduce queries to Couchbase)
+## Views (aka Map/Reduce indexes)
 
 Views are stored in models directory in subdirectory named after the
 model (to be precious `design_document` attribute of the model class).

data/couchbase-model.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rdiscount'
   s.add_development_dependency 'yard'
-  s.add_development_dependency RUBY_VERSION =~ /^1\.9/ ? 'ruby-debug19' : 'ruby-debug'
+  s.add_development_dependency 'debugger'
 end

data/lib/couchbase/model.rb

@@ -22,6 +22,10 @@ require 'couchbase/model/version'
 require 'couchbase/model/uuid'
 require 'couchbase/model/configuration'
 
+unless Object.respond_to?(:singleton_class)
+  require 'couchbase/model/ext/singleton_class'
+end
+
 module Couchbase
 
   # @since 0.0.1
@@ -82,23 +86,23 @@ module Couchbase
     # @since 0.0.1
     attr_accessor :id
 
-    # @since 0.1.0
-    attr_reader :_key
+    # @since 0.2.0
+    attr_reader :key
 
-    # @since 0.1.0
-    attr_reader :_value
+    # @since 0.2.0
+    attr_reader :value
 
-    # @since 0.1.0
-    attr_reader :_doc
+    # @since 0.2.0
+    attr_reader :doc
 
-    # @since 0.1.0
-    attr_reader :_meta
+    # @since 0.2.0
+    attr_reader :meta
 
     # @private Container for all attributes with defaults of all subclasses
     @@attributes = ::Hash.new {|hash, key| hash[key] = {}}
 
     # @private Container for all view names of all subclasses
-    @@views = ::Hash.new {|hash, key| hash[key] = []}
+    @@views = ::Hash.new {|hash, key| hash[key] = {}}
 
     # Use custom connection options
     #
@@ -190,20 +194,31 @@ module Couchbase
       doc = {'_id' => "_design/#{design_document}", 'views' => {}}
       digest = Digest::MD5.new
       mtime = 0
-      views.each do |name|
-        doc['views'][name] = view = {}
-        ['map', 'reduce'].each do |type|
+      views.each do |name, _|
+        doc['views'][name] = {}
+        doc['spatial'] = {}
+        ['map', 'reduce', 'spatial'].each do |type|
           Configuration.design_documents_paths.each do |path|
             ff = File.join(path, design_document.to_s, name.to_s, "#{type}.js")
             if File.file?(ff)
-              view[type] = File.read(ff)
+              contents = File.read(ff).strip
+              next if contents.empty?
               mtime = [mtime, File.mtime(ff).to_i].max
-              digest << view[type]
+              digest << contents
+              case type
+              when 'map', 'reduce'
+                doc['views'][name][type] = contents
+              when 'spatial'
+                doc['spatial'][name] = contents
+              end
               break # pick first matching file
             end
           end
         end
       end
+
+      doc['views'].delete_if {|_, v| v.empty? }
+      doc.delete('spatial') if doc['spatial'].empty?
       doc['signature'] = digest.to_s
       doc['timestamp'] = mtime
       if doc['signature'] != thread_storage[:signature] && doc['timestamp'] > thread_storage[:timestamp].to_i
@@ -259,30 +274,48 @@ module Couchbase
         options = names.pop
       end
       names.each do |name|
+        attributes[name] = options[:default]
         name = name.to_sym
+        next if self.instance_methods.include?(name)
         define_method(name) do
           @_attributes[name]
         end
         define_method(:"#{name}=") do |value|
           @_attributes[name] = value
         end
-        attributes[name] = options[:default]
       end
     end
 
+    # Defines a view for the model
+    #
+    # @since 0.0.1
+    #
+    # @param [Symbol, String, Array] names names of the views
+    # @param [Hash] options options passed to the {Couchbase::View}
+    #
+    # @example Define some views for a model
+    #  class Post < Couchbase::Model
+    #    view :all, :published
+    #    view :by_rating, :include_docs => false
+    #  end
+    #
+    #  post = Post.find("hello")
+    #  post.by_rating.each do |r|
+    #    # ...
+    #  end
     def self.view(*names)
-      options = {}
+      options = {:wrapper_class => self, :include_docs => true}
       if names.last.is_a?(Hash)
-        options = names.pop
+        options.update(names.pop)
       end
+      is_spatial = options.delete(:spatial)
       names.each do |name|
-        views << name
-        self.instance_eval <<-EOV, __FILE__, __LINE__ + 1
-          def #{name}(params = {})
-            View.new(bucket, "_design/\#{design_document}/_view/#{name}",
-                     params.merge(:wrapper_class => self, :include_docs => true))
-          end
-        EOV
+        path = "_design/%s/_%s/%s" % [design_document, is_spatial ? "spatial" : "view", name]
+        views[name] = lambda do |*params|
+          params = options.merge(params.first || {})
+          View.new(bucket, path, params)
+        end
+        singleton_class.send(:define_method, name, &views[name])
       end
     end
 
@@ -299,7 +332,7 @@ module Couchbase
     def self.find(id)
       if id && (res = bucket.get(id, :quiet => false, :extended => true))
         obj, flags, cas = res
-        new({:id => id, :_meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
+        new({:id => id, :meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
       end
     end
 
@@ -316,7 +349,7 @@ module Couchbase
     def self.find_by_id(id)
       if id && (res = bucket.get(id, :quiet => true))
         obj, flags, cas = res
-        new({:id => id, :_meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
+        new({:id => id, :meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
       end
     end
 
@@ -342,10 +375,10 @@ module Couchbase
         attrs = attrs.with_indifferent_access
       end
       @id = attrs.delete(:id)
-      @_key = attrs.delete(:_key)
-      @_value = attrs.delete(:_value)
-      @_doc = attrs.delete(:_doc)
-      @_meta = attrs.delete(:_meta)
+      @key = attrs.delete(:key)
+      @value = attrs.delete(:value)
+      @doc = attrs.delete(:doc)
+      @meta = attrs.delete(:meta)
       @_attributes = ::Hash.new do |h, k|
         default = self.class.attributes[k]
         h[k] = if default.respond_to?(:call)
@@ -354,7 +387,7 @@ module Couchbase
                  default
                end
       end
-      update_attributes(@_doc || attrs)
+      update_attributes(@doc || attrs)
     end
 
     # Create this model and assign new id if necessary
@@ -558,21 +591,13 @@ module Couchbase
     # @return [Model]
     def self.wrap(bucket, data)
       doc = {
-        :_key => data['key'],
-        :_value => data['value'],
-        :_meta => {},
-        :id => data['id']
+        :id => data['id'],
+        :key => data['key'],
+        :value => data['value']
       }
-      if doc[:_value].is_a?(Hash) && (_id = doc[:_value]['_id'])
-        doc[:id] = _id
-      end
       if data['doc']
-        data['doc'].keys.each do |key|
-          if key.start_with?("$")
-            doc[:_meta][key.sub(/^\$/, '')] = data['doc'].delete(key)
-          end
-        end
-        doc.update(data['doc'])
+        doc[:meta] = data['doc']['meta']
+        doc[:doc] = data['doc']['json']
       end
       new(doc)
     end
@@ -582,12 +607,16 @@ module Couchbase
     #
     # @since 0.0.1
     def inspect
-      attrs = model.attributes.map do |attr, default|
-        [attr.to_s, @_attributes[attr].inspect]
-      end.sort
-      sprintf("#<%s:%s %s>",
-              model, new? ? "?" : id,
-              attrs.map{|a| a.join("=")}.join(", "))
+      attrs = []
+      attrs << ["key", @key.inspect] unless @key.nil?
+      attrs << ["value", @value.inspect] unless @value.nil?
+      model.attributes.map do |attr, default|
+        val = @_attributes[attr]
+        attrs << [attr.to_s, val.inspect] unless val.nil?
+      end
+      attrs.sort!
+      attrs.unshift([:id, id]) unless new?
+      sprintf("#<%s %s>", model, attrs.map{|a| a.join(": ")}.join(", "))
     end
 
     def self.inspect

data/lib/couchbase/model/ext/singleton_class.rb

@@ -0,0 +1,24 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Object
+  def singleton_class
+    class << self
+      self
+    end
+  end
+end

data/lib/couchbase/model/version.rb

@@ -19,7 +19,7 @@ module Couchbase
 
   class Model
 
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
 
   end
 

data/lib/couchbase/railtie.rb

@@ -23,6 +23,9 @@ module Rails #:nodoc:
   module Couchbase #:nodoc:
     class Railtie < Rails::Railtie #:nodoc:
 
+      config.couchbase = ActiveSupport::OrderedOptions.new
+      config.couchbase.ensure_design_documents ||= true
+
       # Determine which generator to use. app_generators was introduced after
       # 3.0.0.
       #
@@ -104,19 +107,21 @@ module Rails #:nodoc:
 
       # Check (and upgrade if needed) all design documents
       initializer "couchbase.upgrade_design_documents", :after =>"couchbase.setup_connection"  do |app|
-        config.to_prepare do
-          ::Couchbase::Model::Configuration.design_documents_paths ||= app.config.paths["app/models"]
-          app.config.paths["app/models"].each do |path|
-            Dir.glob("#{path}/**/*.rb").sort.each do |file|
-              require_dependency(file.gsub("#{path}/" , "").gsub(".rb", ""))
+        ::Couchbase::Model::Configuration.design_documents_paths ||= app.config.paths["app/models"]
+        if config.couchbase.ensure_design_documents
+          config.to_prepare do
+            app.config.paths["app/models"].each do |path|
+              Dir.glob("#{path}/**/*.rb").sort.each do |file|
+                require_dependency(file.gsub("#{path}/" , "").gsub(".rb", ""))
+              end
             end
-          end
-          begin
-            ::Couchbase::Model.descendants.each do |model|
-              model.ensure_design_document!
+            begin
+              ::Couchbase::Model.descendants.each do |model|
+                model.ensure_design_document!
+              end
+            rescue ::Couchbase::Error::Timeout, ::Couchbase::Error::Connect
+              # skip connection errors for now
             end
-          rescue ::Couchbase::Error::Timeout, ::Couchbase::Error::Connect
-            # skip connection errors for now
           end
         end
       end

data/test/test_model.rb

@@ -21,7 +21,7 @@ class Post < Couchbase::Model
   attribute :title
   attribute :body
   attribute :author, :default => 'Anonymous'
-  attribute :created_at, :default => lambda { Time.new("2010-01-01") }
+  attribute :created_at, :default => lambda { Time.utc("2010-01-01") }
 end
 
 class TestModel < MiniTest::Unit::TestCase
@@ -52,7 +52,7 @@ class TestModel < MiniTest::Unit::TestCase
 
   def test_allows_lambda_as_default_value
     post = Post.new(:title => "Hello, world")
-    expected = Time.new("2010-01-01")
+    expected = Time.utc("2010-01-01")
     assert_equal expected, post.created_at
     assert_equal expected, post.attributes[:created_at]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchbase-model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couchbase
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-debug19
+  name: debugger
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -117,12 +117,14 @@ files:
 - .travis.yml
 - .yardopts
 - Gemfile
+- HISTORY.markdown
 - README.markdown
 - Rakefile
 - couchbase-model.gemspec
 - lib/couchbase-model.rb
 - lib/couchbase/model.rb
 - lib/couchbase/model/configuration.rb
+- lib/couchbase/model/ext/singleton_class.rb
 - lib/couchbase/model/uuid.rb
 - lib/couchbase/model/version.rb
 - lib/couchbase/railtie.rb
@@ -159,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Declarative interface to Couchbase