couchbase-model 0.2.0 → 0.3.0

data/HISTORY.markdown

@@ -1,3 +1,12 @@
+## 0.3.0 / 2012-09-22
+
+* Implement belongs_to asscociation
+* Use ActiveModel naming and conversion
+* Define persisted? method
+* Allow optional CAS value for mutators
+* Use replace in save method. Thanks to @scalabl3
+* Add callbacks for :save, :create, :update and :delete methods
+
 ## 0.2.0 / 2012-09-18
 
 * Add Rails 3 configuration possibilities, allow configuring

data/lib/couchbase-model.rb

@@ -20,4 +20,9 @@ require 'couchbase/model'
 # If we are using Rails then we will include the Couchbase railtie.
 if defined?(Rails)
   require "couchbase/railtie"
+
+  class Couchbase::Model
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+  end
 end

data/lib/couchbase/model.rb

@@ -25,6 +25,12 @@ require 'couchbase/model/configuration'
 unless Object.respond_to?(:singleton_class)
   require 'couchbase/model/ext/singleton_class'
 end
+unless "".respond_to?(:constantize)
+  require 'couchbase/model/ext/constantize'
+end
+unless "".respond_to?(:camelize)
+  require 'couchbase/model/ext/camelize'
+end
 
 module Couchbase
 
@@ -274,8 +280,8 @@ module Couchbase
         options = names.pop
       end
       names.each do |name|
-        attributes[name] = options[:default]
         name = name.to_sym
+        attributes[name] = options[:default]
         next if self.instance_methods.include?(name)
         define_method(name) do
           @_attributes[name]
@@ -319,6 +325,35 @@ module Couchbase
       end
     end
 
+    # Defines a belongs_to association for the model
+    #
+    # @since 0.3.0
+    #
+    # @param [Symbol, String] name name of the associated model
+    # @param [Hash] options association options
+    # @option options [String, Symbol] :class_name the name of the
+    #   association class
+    #
+    # @example Define some association for a model
+    #  class Brewery < Couchbase::Model
+    #    attribute :name
+    #  end
+    #
+    #  class Beer < Couchbase::Model
+    #    attribute :name, :brewery_id
+    #    belongs_to :brewery
+    #  end
+    #
+    #  Beer.find("heineken").brewery.name
+    def self.belongs_to(name, options = {})
+      ref = "#{name}_id"
+      attribute(ref)
+      assoc = name.to_s.camelize.constantize
+      define_method(name) do
+        assoc.find(self.send(ref))
+      end
+    end
+
     # Find the model using +id+ attribute
     #
     # @since 0.0.1
@@ -412,15 +447,16 @@ module Couchbase
     #
     # @since 0.0.1
     #
+    # @param [Bignum] cas CAS value
     # @return [Couchbase::Model] The saved object
     #
     # @example Update the Post model
     #   p = Post.find('hello-world')
     #   p.draft = false
     #   p.save
-    def save
+    def save(cas = nil)
       return create if new?
-      model.bucket.set(@id, attributes_with_values)
+      model.bucket.replace(@id, attributes_with_values, :cas => cas)
       self
     end
 
@@ -430,10 +466,11 @@ module Couchbase
     #
     # @param [Hash] attrs Attribute value pairs to use for the updated
     #               version
+    # @param [Bignum] cas CAS value
     # @return [Couchbase::Model] The updated object
-    def update(attrs)
+    def update(attrs, cas = nil)
       update_attributes(attrs)
-      save
+      save(cas)
     end
 
     # Delete this object from the bucket
@@ -442,12 +479,13 @@ module Couchbase
     #
     # @note This method will reset +id+ attribute
     #
+    # @param [Bignum] cas CAS value
     # @return [Couchbase::Model] Returns a reference of itself.
     #
     # @example Delete the Post model
     #   p = Post.find('hello-world')
     #   p.delete
-    def delete
+    def delete(cas = nil)
       raise Couchbase::Error::MissingId, "missing id attribute" unless @id
       model.bucket.delete(@id)
       @id = nil
@@ -467,6 +505,11 @@ module Couchbase
       !@id
     end
 
+    # @return [true, false] Where on on this object persisted in the storage
+    def persisted?
+      !!@id
+    end
+
     # Check if the key exists in the bucket
     #
     # @since 0.0.1
@@ -627,8 +670,6 @@ module Couchbase
       buf
     end
 
-    protected
-
     # @private Returns a hash with model attributes
     #
     # @since 0.1.0
@@ -639,6 +680,24 @@ module Couchbase
       end
       ret
     end
+
+    protected :attributes_with_values
+
+    if defined?(::Rails)
+      extend ActiveModel::Callbacks
+      define_model_callbacks :create, :update, :delete, :save
+      [:save, :create, :update, :delete].each do |meth|
+        class_eval <<-EOC
+          alias #{meth}_without_callbacks #{meth}
+          def #{meth}(*args, &block)
+            run_callbacks(:#{meth}) do
+              #{meth}_without_callbacks(*args, &block)
+            end
+          end
+        EOC
+      end
+    end
+
   end
 
 end

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

@@ -0,0 +1,23 @@
+# 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 String
+  def camelize
+    res = self.sub(/^[a-z\d]*/) { $&.capitalize }
+    res.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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 String
+  def constantize
+    names = self.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end

data/lib/couchbase/model/version.rb

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

data/test/test_model.rb

@@ -24,6 +24,15 @@ class Post < Couchbase::Model
   attribute :created_at, :default => lambda { Time.utc("2010-01-01") }
 end
 
+class Brewery < Couchbase::Model
+  attribute :name
+end
+
+class Beer < Couchbase::Model
+  attribute :name
+  belongs_to :brewery
+end
+
 class TestModel < MiniTest::Unit::TestCase
 
   def setup
@@ -103,9 +112,9 @@ class TestModel < MiniTest::Unit::TestCase
     EOC
 
     comment = Comment.new
-    assert comment.respond_to?(:name)
-    assert comment.respond_to?(:email)
-    assert comment.respond_to?(:body)
+    assert_respond_to comment, :name
+    assert_respond_to comment, :email
+    assert_respond_to comment, :body
   end
 
   def test_allows_arbitrary_ids
@@ -152,4 +161,14 @@ class TestModel < MiniTest::Unit::TestCase
     end
   end
 
+  def test_belongs_to_assoc
+    brewery = Brewery.create(:name => "Anheuser-Busch")
+    assert_includes Beer.attributes.keys, :brewery_id
+    beer = Beer.create(:name => "Budweiser", :brewery_id => brewery.id)
+    assert_respond_to beer, :brewery
+    assoc = beer.brewery
+    assert_instance_of Brewery, assoc
+    assert_equal "Anheuser-Busch", assoc.name
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchbase-model
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-18 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couchbase
@@ -124,6 +124,8 @@ files:
 - lib/couchbase-model.rb
 - lib/couchbase/model.rb
 - lib/couchbase/model/configuration.rb
+- lib/couchbase/model/ext/camelize.rb
+- lib/couchbase/model/ext/constantize.rb
 - lib/couchbase/model/ext/singleton_class.rb
 - lib/couchbase/model/uuid.rb
 - lib/couchbase/model/version.rb