couchbase-model 0.4.4 → 0.5.0

data/HISTORY.markdown

@@ -1,3 +1,14 @@
+## 0.5.0 / 2012-11-21
+
+* Update template for map function
+* Use extended get for #find_by_id
+* Do not use HashWithIndifferentAccess class unless it defined
+* Pass options to #create method
+* Ensure validness on create
+* Fix storing raw data
+* Define read_attribute and write_attribute methods
+* Support couchbase 1.2.0.z.beta4
+
 ## 0.4.4 / 2012-10-17
 
 * Make #to_param aware about keys

data/lib/couchbase/model.rb

@@ -42,7 +42,11 @@ module Couchbase
     attr_reader :record
     def initialize(record)
       @record = record
-      super(@record.errors.full_messages.join(", "))
+      if @record.errors
+        super(@record.errors.full_messages.join(", "))
+      else
+        super("Record invalid")
+      end
     end
   end
 
@@ -113,6 +117,12 @@ module Couchbase
     # @since 0.2.0
     attr_reader :meta
 
+    # @since 0.4.5
+    attr_reader :errors
+
+    # @since 0.4.5
+    attr_reader :raw
+
     # @private Container for all attributes with defaults of all subclasses
     @@attributes = ::Hash.new {|hash, key| hash[key] = {}}
 
@@ -275,6 +285,14 @@ module Couchbase
       self.thread_storage[:uuid_algorithm] = algorithm
     end
 
+    def read_attribute(attr_name)
+      @_attributes[attr_name]
+    end
+
+    def write_attribute(attr_name, value)
+      @_attributes[attr_name] = value
+    end
+
     # Defines an attribute for the model
     #
     # @since 0.0.1
@@ -301,10 +319,10 @@ module Couchbase
         attributes[name] = options[:default]
         next if self.instance_methods.include?(name)
         define_method(name) do
-          @_attributes[name]
+          read_attribute(name)
         end
         define_method(:"#{name}=") do |value|
-          @_attributes[name] = value
+          write_attribute(name, value)
         end
       end
     end
@@ -384,6 +402,7 @@ module Couchbase
     def self.find(id)
       if id && (res = bucket.get(id, :quiet => false, :extended => true))
         obj, flags, cas = res
+        obj = {:raw => obj} unless obj.is_a?(Hash)
         new({:id => id, :meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
       end
     end
@@ -399,8 +418,9 @@ module Couchbase
     # @example Find model using +id+
     #   post = Post.find_by_id('the-id')
     def self.find_by_id(id)
-      if id && (res = bucket.get(id, :quiet => true))
+      if id && (res = bucket.get(id, :quiet => true, :extended => true))
         obj, flags, cas = res
+        obj = {:raw => obj} unless obj.is_a?(Hash)
         new({:id => id, :meta => {'flags' => flags, 'cas' => cas}}.merge(obj))
       end
     end
@@ -424,9 +444,17 @@ module Couchbase
     # @param [Hash] attrs attribute-value pairs
     def initialize(attrs = {})
       @errors = ::ActiveModel::Errors.new(self) if defined?(::ActiveModel)
+      @_attributes = ::Hash.new do |h, k|
+        default = self.class.attributes[k]
+        h[k] = if default.respond_to?(:call)
+                 default.call
+               else
+                 default
+               end
+      end
       case attrs
-      when Hash, HashWithIndifferentAccess
-        if attrs.respond_to?(:with_indifferent_access)
+      when Hash
+        if defined?(HashWithIndifferentAccess) && !attrs.is_a?(HashWithIndifferentAccess)
           attrs = attrs.with_indifferent_access
         end
         @id = attrs.delete(:id)
@@ -434,17 +462,10 @@ module Couchbase
         @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)
-                  default.call
-                else
-                  default
-                end
-        end
+        @raw = attrs.delete(:raw)
         update_attributes(@doc || attrs)
       else
-        @_raw = attrs
+        @raw = attrs
       end
     end
 
@@ -462,14 +483,18 @@ module Couchbase
     #   p.create
     def create(options = {})
       @id ||= Couchbase::Model::UUID.generator.next(1, model.thread_storage[:uuid_algorithm])
-      value = @_raw ? @_raw : attributes_with_values
+      if respond_to?(:valid?) && !valid?
+        raise Couchbase::Error::RecordInvalid.new(self)
+      end
+      options = model.defaults.merge(options)
+      value = (options[:format] == :plain) ?  @raw : attributes_with_values
       unless @meta
         @meta = {}
         if @meta.respond_to?(:with_indifferent_access)
           @meta = @meta.with_indifferent_access
         end
       end
-      @meta['cas'] = model.bucket.add(@id, value, model.defaults.merge(options))
+      @meta['cas'] = model.bucket.add(@id, value, options)
       self
     end
 
@@ -491,18 +516,13 @@ module Couchbase
     #   p.draft = false
     #   p.save('cas' => p.meta['cas'])
     def save(options = {})
+      return create(options) unless @meta
       if respond_to?(:valid?) && !valid?
         raise Couchbase::Error::RecordInvalid.new(self)
       end
-      return create unless meta
-      value = @_raw ? @_raw : attributes_with_values
-      unless @meta
-        @meta = {}
-        if @meta.respond_to?(:with_indifferent_access)
-          @meta = @meta.with_indifferent_access
-        end
-      end
-      @meta['cas'] = model.bucket.replace(@id, value, model.defaults.merge(options))
+      options = model.defaults.merge(options)
+      value = (options[:format] == :plain) ?  @raw : attributes_with_values
+      @meta['cas'] = model.bucket.replace(@id, value, options)
       self
     end
 
@@ -689,7 +709,7 @@ module Couchbase
       }
       if data['doc']
         doc[:meta] = data['doc']['meta']
-        doc[:doc] = data['doc']['json']
+        doc[:doc] = data['doc']['value'] || data['doc']['json']
       end
       new(doc)
     end
@@ -703,7 +723,7 @@ module Couchbase
       attrs << ["key", @key.inspect] unless @key.nil?
       attrs << ["value", @value.inspect] unless @value.nil?
       model.attributes.map do |attr, default|
-        val = @_attributes[attr]
+        val = read_attribute(attr)
         attrs << [attr.to_s, val.inspect] unless val.nil?
       end
       attrs.sort!
@@ -725,7 +745,7 @@ module Couchbase
     def attributes_with_values
       ret = {:type => model.design_document}
       model.attributes.keys.each do |attr|
-        ret[attr] = @_attributes[attr]
+        ret[attr] = read_attribute(attr)
       end
       ret
     end

data/lib/couchbase/model/version.rb

@@ -19,7 +19,7 @@ module Couchbase
 
   class Model
 
-    VERSION = "0.4.4"
+    VERSION = "0.5.0"
 
   end
 

data/lib/rails/generators/couchbase/view/templates/map.js

@@ -5,24 +5,24 @@
 // Read more about how to write map functions at:
 // http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-map.html
 
-function(doc) {
-  emit(doc._id, null);
+function(doc, meta) {
+  emit(meta.id, null);
 }
 
 // You can also check out following examples
 //
 // The simplest example of a map function:
 //
-//   function(doc) {
-//     emit(doc._id, doc);
+//   function(doc, meta) {
+//     emit(meta.id, doc);
 //   }
 //
 // Slightly more complex example of a function that defines a view on values
 // computed from customer documents:
 //
-//   function(doc) {
+//   function(doc, meta) {
 //     if (doc.type == "customer") {
-//       emit(doc._id, {last_name: doc.last_name, first_name: doc.first_name});
+//       emit(meta.id, {last_name: doc.last_name, first_name: doc.first_name});
 //     }
 //   }
 //
@@ -31,7 +31,7 @@ function(doc) {
 // would allow you to lookup customer documents by the last_name or
 // first_name fields (your keys could be compound, e.g. arrays):
 //
-//   function(doc) {
+//   function(doc, meta) {
 //     if (doc.type == "customer") {
 //       emit(doc.last_name, {first_name: doc.first_name});
 //       emit(doc.first_name, {last_name: doc.last_name});

data/test/test_model.rb

@@ -24,6 +24,14 @@ class Post < Couchbase::Model
   attribute :created_at, :default => lambda { Time.utc("2010-01-01") }
 end
 
+class ValidPost < Couchbase::Model
+  attribute :title
+
+  def valid?
+    title && !title.empty?
+  end
+end
+
 class Brewery < Couchbase::Model
   attribute :name
 end
@@ -33,18 +41,50 @@ class Beer < Couchbase::Model
   belongs_to :brewery
 end
 
+class Attachment < Couchbase::Model
+  defaults :format => :plain
+end
+
 class TestModel < MiniTest::Unit::TestCase
 
   def setup
     @mock = start_mock
-    Post.bucket = Couchbase.connect(:hostname => @mock.host,
-                                    :port => @mock.port)
+    bucket = Couchbase.connect(:hostname => @mock.host, :port => @mock.port)
+    [Post, ValidPost, Brewery, Beer, Attachment].each do |model|
+      model.bucket = bucket
+    end
   end
 
   def teardown
     stop_mock(@mock)
   end
 
+  def test_it_supports_value_property
+    doc = {
+      "id" => "x",
+      "key" => "x",
+      "value" => "x",
+      "doc" => {
+        "value" => {"title" => "foo"}
+      }
+    }
+    post = Post.wrap(Post.bucket, doc)
+    assert_equal "foo", post.title
+  end
+
+  def test_it_supports_json_property
+    doc = {
+      "id" => "x",
+      "key" => "x",
+      "value" => "x",
+      "doc" => {
+        "json" => {"title" => "foo"}
+      }
+    }
+    post = Post.wrap(Post.bucket, doc)
+    assert_equal "foo", post.title
+  end
+
   def test_assigns_attributes_from_the_hash
     post = Post.new(:title => "Hello, world")
     assert_equal "Hello, world", post.title
@@ -181,4 +221,23 @@ class TestModel < MiniTest::Unit::TestCase
     assert_equal "the-key", Post.new(:key => ["the", "key"]).to_param
   end
 
+  def test_validation
+    post = ValidPost.create(:title => 'Hello, World!')
+    assert post.valid?, "post with title should be valid"
+    post.title = nil
+    assert_raises(Couchbase::Error::RecordInvalid) do
+      post.save
+    end
+    assert_raises(Couchbase::Error::RecordInvalid) do
+      ValidPost.create(:title => nil)
+    end
+  end
+
+  def test_blob_documents
+    contents = File.read(__FILE__)
+    id = Attachment.create(:raw => contents).id
+    blob = Attachment.find(id)
+    assert_equal contents, blob.raw
+  end
+
 end

metadata

@@ -1,118 +1,121 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: couchbase-model
-version: !ruby/object:Gem::Version
-  version: 0.4.4
+version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
-authors:
+authors: 
 - Couchbase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: couchbase
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0.dp
+
+date: 2012-11-21 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: -168919795
+        segments: 
+        - 1
+        - 2
+        - 0
+        - dp
         version: 1.2.0.dp
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+  name: couchbase
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-  type: :development
+  name: rake
+  version_requirements: *id002
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  version_requirements: *id003
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: rdiscount
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  version_requirements: *id004
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  version_requirements: *id005
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  version_requirements: *id006
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: ORM-like interface allows you to persist your models to Couchbase
 email: support@couchbase.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - .yardopts
@@ -143,31 +146,41 @@ files:
 - test/setup.rb
 - test/test_model.rb
 - test/test_uuid.rb
+has_rdoc: true
 homepage: https://github.com/couchbase/couchbase-ruby-model
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Declarative interface to Couchbase
-test_files:
+test_files: 
 - test/setup.rb
 - test/test_model.rb
 - test/test_uuid.rb