couchbase-model 0.5.3 → 0.5.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca53bd57fa7de8fb80866fb9aef809ff7c6e929a
+  data.tar.gz: adbaa8e5683b998e26bb3f15f102e049b50178d4
+SHA512:
+  metadata.gz: 65d95c35108dec976cd76f5c3f528b43a64b9753e96ab4a1be67c8ee7fb99c49008c14c5dc794a1ac3858d276d96abc5bf140f98037ef3bf6c40efaa561c038e
+  data.tar.gz: 8072842e1586925101d9515690036c58da7cec5fc1de46dc3aa23ff8ea80185d97cf9bbe3e2b8045f5a952ffa54201f47e86ad7d4d0eee2a3ce4236701ed7ebe

data/HISTORY.markdown

@@ -1,3 +1,8 @@
+## 0.5.4 / 2014-08-30
+
+* Improved ActiveModel support
+* Fixed stale CAS on model reload
+
 ## 0.5.3 / 2013-06-06
 
 * Prefer single-quoted strings (Andrey Koleshko)

data/couchbase-model.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'couchbase', '~> 1.3.0'
+  s.add_runtime_dependency 'couchbase', '~> 1.3.3'
+  s.add_runtime_dependency 'activemodel'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest'

data/lib/couchbase/active_model.rb

@@ -0,0 +1,70 @@
+module Couchbase
+  module ActiveModel
+
+    def self.included(base)
+      base.class_eval do
+        extend ::ActiveModel::Callbacks
+        extend ::ActiveModel::Naming
+        include ::ActiveModel::Conversion
+        include ::ActiveModel::Validations
+        include ::ActiveModel::Validations::Callbacks
+        include ::ActiveModel::Dirty
+
+        define_model_callbacks :create, :update, :delete, :save, :initialize
+        [:save, :create, :update, :delete, :initialize].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
+
+    # Public: Allows for access to ActiveModel functionality.
+    #
+    # Returns self.
+    def to_model
+      self
+    end
+
+    # Public: Hashes our unique key instead of the entire object.
+    # Ruby normally hashes an object to be used in comparisons.  In our case
+    # we may have two techincally different objects referencing the same entity id,
+    # so we will hash just the class and id (via to_key) to compare so we get the
+    # expected result
+    #
+    # Returns a string representing the unique key.
+    def hash
+      to_param.hash
+    end
+
+    # Public: Overrides eql? to use == in the comparison.
+    #
+    # other - Another object to compare to
+    #
+    # Returns a boolean.
+    def eql?(other)
+      self == other
+    end
+
+    # Public: Overrides == to compare via class and entity id.
+    #
+    # other - Another object to compare to
+    #
+    # Example
+    #
+    #     movie = Movie.find(1234)
+    #     movie.to_key
+    #     # => 'movie-1234'
+    #
+    # Returns a string representing the unique key.
+    def ==(other)
+      hash == other.hash
+    end
+
+  end
+end

data/lib/couchbase/model.rb

@@ -18,9 +18,11 @@
 require 'digest/md5'
 
 require 'couchbase'
+require 'couchbase/active_model'
 require 'couchbase/model/version'
 require 'couchbase/model/uuid'
 require 'couchbase/model/configuration'
+require 'active_model'
 
 unless Object.respond_to?(:singleton_class)
   require 'couchbase/model/ext/singleton_class'
@@ -100,6 +102,7 @@ module Couchbase
   #    connect :port => 80, :bucket => 'blog'
   #  end
   class Model
+
     # Each model must have identifier
     #
     # @since 0.0.1
@@ -217,7 +220,7 @@ module Couchbase
     #   |  |  `- reduce.js
     #
     # The directory structure above demonstrate layout for design document
-    # with id +_design/link+ and three views: +by_create_at+,
+    # with id +_design/link+ and three views: +by_created_at+,
     # +by_session_id` and `total_views`.
     def self.ensure_design_document!
       unless Configuration.design_documents_paths
@@ -288,10 +291,13 @@ module Couchbase
     def read_attribute(attr_name)
       @_attributes[attr_name]
     end
+    alias :[] :read_attribute
 
     def write_attribute(attr_name, value)
+      attribute_will_change!(attr_name) unless @_attributes[attr_name] == value
       @_attributes[attr_name] = value
     end
+    alias :[]= :write_attribute
 
     # Defines an attribute for the model
     #
@@ -383,7 +389,7 @@ module Couchbase
     def self.belongs_to(name, options = {})
       ref = "#{name}_id"
       attribute(ref)
-      assoc = name.to_s.camelize.constantize
+      assoc = (options[:class_name] || name).to_s.camelize.constantize
       define_method(name) do
         assoc.find(self.send(ref))
       end
@@ -482,7 +488,9 @@ module Couchbase
       case attrs
       when Hash
         if defined?(HashWithIndifferentAccess) && !attrs.is_a?(HashWithIndifferentAccess)
-          attrs = attrs.with_indifferent_access
+          if attrs.respond_to?(:with_indifferent_access)
+            attrs = attrs.with_indifferent_access
+          end
         end
         @id = attrs.delete(:id)
         @key = attrs.delete(:key)
@@ -491,6 +499,8 @@ module Couchbase
         @meta = attrs.delete(:meta)
         @raw = attrs.delete(:raw)
         update_attributes(@doc || attrs)
+        @previously_changed = nil
+        @changed_attributes.clear unless @changed_attributes.nil?
       else
         @raw = attrs
       end
@@ -563,6 +573,8 @@ module Couchbase
       options = model.defaults.merge(options)
       value = (options[:format] == :plain) ?  @raw : attributes_with_values
       @meta['cas'] = model.bucket.replace(@id, value, options)
+      @previously_changed = changes
+      @changed_attributes.clear unless @changed_attributes.nil?
       self
     end
 
@@ -695,7 +707,7 @@ module Couchbase
     #
     # @return [Hash]
     def attributes
-      @_attributes
+      @_attributes || {}
     end
 
     # Update all attributes without persisting the changes.
@@ -723,8 +735,9 @@ module Couchbase
     #   attribute
     def reload
       raise Couchbase::Error::MissingId, 'missing id attribute' unless @id
-      attrs = model.find(@id).attributes
-      update_attributes(attrs)
+      pristine = model.find(@id)
+      update_attributes(pristine.attributes)
+      @meta[:cas] = pristine.meta[:cas]
       self
     end
 
@@ -827,26 +840,7 @@ module Couchbase
       ret
     end
 
-    protected :attributes_with_values
-
-    if defined?(::ActiveModel)
-      extend ActiveModel::Callbacks
-      extend ActiveModel::Naming
-      include ActiveModel::Conversion
-      include ActiveModel::Validations
-
-      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
+    private :attributes_with_values
 
     # Redefine (if exists) #to_key to use #key if #id is missing
     def to_key
@@ -860,6 +854,10 @@ module Couchbase
         keys.join('-')
       end
     end
+
+    include Couchbase::ActiveModel
+    ActiveSupport.run_load_hooks :couchbase_model, self
   end
 
 end
+

data/lib/couchbase/model/version.rb

@@ -16,11 +16,7 @@
 #
 
 module Couchbase
-
   class Model
-
-    VERSION = '0.5.3'
-
+    VERSION = '0.5.4'
   end
-
 end

data/tasks/test.rake

@@ -19,7 +19,7 @@ require 'rake/testtask'
 require 'rake/clean'
 
 rule 'test/CouchbaseMock.jar' do |task|
-  jar_path = "0.5-SNAPSHOT/CouchbaseMock-0.5-20120726.220757-19.jar"
+  jar_path = "0.8-SNAPSHOT/CouchbaseMock-0.8-20140621.030439-1.jar"
   sh %{wget -q -O test/CouchbaseMock.jar http://files.couchbase.com/maven2/org/couchbase/mock/CouchbaseMock/#{jar_path}}
 end
 

data/test/setup.rb

@@ -163,6 +163,9 @@ class MiniTest::Unit::TestCase
   end
 
   def uniq_id(*suffixes)
-    [caller.first[/.*[` ](.*)'/, 1], suffixes].join('_')
+    test_id = [caller.first[/.*[` ](.*)'/, 1], suffixes].compact.join('_')
+    @ids ||= {}
+    @ids[test_id] ||= Time.now.to_f
+    [test_id, @ids[test_id]].join('_')
   end
 end

data/test/test_active_model_integration.rb

@@ -0,0 +1,146 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 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.
+#
+
+require File.join(File.dirname(__FILE__), 'setup')
+
+class ActiveUser < Couchbase::Model
+  attribute :name
+  attribute :email
+  attribute :role
+  attribute :created_at, :updated_at, :default => lambda { Time.now.utc }
+
+  validates_presence_of :email
+  validates :role, :presence => true, :inclusion => { :in => %w(admin editor) }
+
+  before_create :upcase_name
+
+  private
+
+  def upcase_name
+    self.name = self.name.upcase unless self.name.nil?
+  end
+end
+
+class ActiveObj < Couchbase::Model
+end
+
+class TestActiveModelIntegration < MiniTest::Unit::TestCase
+
+  include ActiveModel::Lint::Tests
+
+  def setup
+    @model = ActiveUser.new # used by ActiveModel::Lint::Tests
+    @mock = start_mock
+    bucket = Couchbase.connect(:hostname => @mock.host, :port => @mock.port)
+    ActiveObj.bucket = ActiveUser.bucket = bucket
+  end
+
+  def teardown
+    stop_mock(@mock)
+  end
+
+  def test_active_model_includes
+    [
+      ActiveModel::Conversion,
+      ActiveModel::Validations,
+      ActiveModel::Validations::Callbacks,
+      ActiveModel::Validations::HelperMethods
+    ].each do |mod|
+      assert ActiveUser.ancestors.include?(mod), "Model not including #{mod}"
+    end
+  end
+
+  def test_callbacks
+    [
+      :before_validation, :after_validation,
+      :after_initialize, :before_create, :around_create,
+      :after_create, :before_delete, :around_delete,
+      :after_delete, :before_save, :around_save, :after_save,
+      :before_update, :around_update, :after_update
+    ].each do |callback|
+      assert ActiveObj.respond_to?(callback), "Model doesn't support callback: #{callback}"
+    end
+  end
+
+  def test_active_model_validations
+    no_role = ActiveUser.new(:email => 'joe@example.com', :role => nil)
+    bad_role = ActiveUser.new(:email => 'joe@example.com', :role => 'bad')
+    good_role = ActiveUser.new(:email => 'joe@example.com', :role => 'admin')
+
+    refute no_role.valid?
+    refute bad_role.valid?
+    assert good_role.valid?
+  end
+
+  def test_active_model_validation_helpers
+    valid = ActiveUser.new(:email => 'joe@example.com', :role => 'editor')
+    invalid = ActiveUser.new(:name => 'Joe', :role => 'editor')
+
+    assert valid.valid?
+    refute invalid.valid?
+  end
+
+  def test_before_save_callback
+    assert user = ActiveUser.create(:name => 'joe', :role => 'admin', :email => 'joe@example.com')
+    assert_equal 'JOE', user.name
+  end
+
+  def test_model_name_exposes_singular_and_human_name
+    assert_equal 'active_user', @model.class.model_name.singular
+    assert_equal 'Active user', @model.class.model_name.human
+  end
+
+  def test_model_equality
+    obj1 = ActiveObj.create
+    obj2 = ActiveObj.find(obj1.id)
+
+    assert_equal obj1, obj2
+  end
+
+  def test_to_key
+    assert_equal ['the-id'], ActiveObj.new(:id => 'the-id').to_key
+    assert_equal ['the-key'], ActiveObj.new(:key => 'the-key').to_key
+  end
+
+  def test_to_param
+    assert_equal 'the-id', ActiveObj.new(:id => 'the-id').to_param
+    assert_equal 'the-key', ActiveObj.new(:key => ['the', 'key']).to_param
+  end
+
+  def test_dirty_tracking_on_attribute
+    tester = ActiveUser.create(:email => 'joe@example.com', :role => 'admin')
+    tester.email = 'bob@example.com'
+    assert tester.changed?
+    assert_equal tester.changed, ["email"]
+  end
+
+  def test_dirty_tracking_reset_on_save
+    tester = ActiveUser.create(:email => 'joe@example.com', :role => 'admin')
+    tester.email = 'bob@example.com'
+    assert tester.changed?
+    tester.save
+    refute tester.changed?
+  end
+
+  def test_dirty_tracking_previous_values
+    tester = ActiveUser.create(:email => 'joe@example.com', :role => 'admin')
+    tester.email = 'bob@example.com'
+    tester.save
+    assert_equal tester.previous_changes[:email], ['joe@example.com', 'bob@example.com']
+  end
+
+end

data/test/test_model.rb

@@ -41,6 +41,11 @@ class Beer < Couchbase::Model
   belongs_to :brewery
 end
 
+class Wine < Couchbase::Model
+  attribute :name
+  belongs_to :winery, :class_name => :Brewery
+end
+
 class Attachment < Couchbase::Model
   defaults :format => :plain
 end
@@ -59,7 +64,7 @@ class TestModel < MiniTest::Unit::TestCase
   def setup
     @mock = start_mock
     bucket = Couchbase.connect(:hostname => @mock.host, :port => @mock.port)
-    [Post, ValidPost, Brewery, Beer, Attachment].each do |model|
+    [Post, ValidPost, Brewery, Beer, Attachment, Wine].each do |model|
       model.bucket = bucket
     end
   end
@@ -100,6 +105,17 @@ class TestModel < MiniTest::Unit::TestCase
     assert_equal 'foo', post.title
   end
 
+  def test_access_attribute_by_key
+    post = Post.new(:title => 'Hello, world')
+    assert_equal 'Hello, world', post[:title]
+  end
+
+  def test_update_attribute_by_key
+    post = Post.new(:title => 'Hello, world')
+    post[:title] = 'world, Hello'
+    assert_equal 'world, Hello', post.title
+  end
+
   def test_assigns_attributes_from_the_hash
     post = Post.new(:title => 'Hello, world')
     assert_equal 'Hello, world', post.title
@@ -140,6 +156,15 @@ class TestModel < MiniTest::Unit::TestCase
     assert_equal 'Good bye, world', orig.title
   end
 
+  def test_reloads_cas_value_with_reload_method
+    orig = Post.create(:title => "Hello, world")
+    double = Post.find(orig.id)
+    orig.update(:title => "Good bye, world")
+    double.reload
+
+    assert_equal orig.meta[:cas], double.meta[:cas]
+  end
+
   def test_it_raises_not_found_exception
     assert_raises Couchbase::Error::NotFound do
       Post.find('missing_key')
@@ -208,6 +233,16 @@ class TestModel < MiniTest::Unit::TestCase
     end
   end
 
+  def test_belongs_to_with_class_name_assoc
+    brewery = Brewery.create(:name => "R Wines")
+    assert_includes Wine.attributes.keys, :winery_id
+    wine = Wine.create(:name => "Classy", :winery_id => brewery.id)
+    assert_respond_to wine, :winery
+    assoc = wine.winery
+    assert_instance_of Brewery, assoc
+    assert_equal "R Wines", assoc.name
+  end
+
   def test_fails_to_delete_model_without_id
     post = Post.new(:title => 'Hello')
     refute post.id

metadata

@@ -1,93 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: couchbase-model
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 3
-  version: 0.5.3
+version: !ruby/object:Gem::Version
+  version: 0.5.4
 platform: ruby
-authors: 
+authors:
 - Couchbase
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-06-06 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: couchbase
-  version_requirements: *id001
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: rake
-  version_requirements: *id002
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: minitest
-  version_requirements: *id003
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: *id004
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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: 
-- .gitignore
-- .travis.yml
-- .yardopts
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CONTRIBUTING.markdown
 - Gemfile
 - HISTORY.markdown
@@ -95,6 +96,7 @@ files:
 - Rakefile
 - couchbase-model.gemspec
 - lib/couchbase-model.rb
+- lib/couchbase/active_model.rb
 - lib/couchbase/model.rb
 - lib/couchbase/model/configuration.rb
 - lib/couchbase/model/ext/camelize.rb
@@ -113,42 +115,36 @@ files:
 - tasks/test.rake
 - tasks/util.rake
 - test/setup.rb
+- test/test_active_model_integration.rb
 - test/test_model.rb
 - test/test_model_rails_integration.rb
 - test/test_uuid.rb
-has_rdoc: true
 homepage: https://github.com/couchbase/couchbase-ruby-model
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.3.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Declarative interface to Couchbase
-test_files: []
-
+test_files:
+- test/setup.rb
+- test/test_active_model_integration.rb
+- test/test_model.rb
+- test/test_model_rails_integration.rb
+- test/test_uuid.rb