couchbase-model 0.5.1 → 0.5.2

data/CONTRIBUTING.markdown

@@ -0,0 +1,75 @@
+We've decided to use "gerrit" for our code review system, making it
+easier for all of us to contribute with code and comments.
+
+  1. Visit http://review.couchbase.org and "Register" for an account
+  2. Review http://review.couchbase.org/static/individual_agreement.html
+  3. Agree to agreement by visiting http://review.couchbase.org/#/settings/agreements
+  4. If you do not receive an email, please contact us
+  5. Check out the `couchbase-ruby-model` area http://review.couchbase.org/#/q/status:open+project:couchbase-ruby-model,n,z
+  6. Join us on IRC at #libcouchbase on Freenode :-)
+
+We normally don't go looking for stuff in gerrit, so you should add at
+least me `"Sergey Avseyev" <sergey.avseyev@gmail.com>` as a reviewer
+for your patch (and I'll know who else to add and add them for you).
+
+## Contributing Using Repo Tool
+
+Follow ["Uploading Changes" guide][1] on the site if you have some code to contribute.
+
+All you should need to set up your development environment should be:
+
+    ~ % mkdir couchbase-ruby
+    ~ % cd couchbase-ruby
+    ~/couchbase-ruby % repo init -u git://github.com/trondn/manifests.git -m ruby.xml
+    ~/couchbase-ruby % repo sync
+    ~/couchbase-ruby % repo start my-branch-name --all
+    ~/couchbase-ruby % make
+
+This will build the latest version of `libcouchbase`,
+`couchbase-ruby-client` and `couchbase-ruby-model` libraries. You must
+have a C and C++ compiler installed, automake, autoconf.
+
+If you have to make any changes just commit them before you upload
+them to gerrit with the following command:
+
+    ~/couchbase-ruby/model % repo upload
+
+You might experience a problem trying to upload the patches if you've
+selected a different login name at http://review.couchbase.org than
+your login name. Don't worry, all you need to do is to add the
+following to your ~/.gitconfig file:
+
+    [review "review.couchbase.org"]
+        username = YOURNAME
+
+## Contributing Using Plain Git
+
+If you not so familiar with repo tool and its workflow there is
+alternative way to do the same job. Lets assume you have installed
+couchbase gem and libcouchbase from official packages and would you to
+contribute to couchbase-model gem only. Then you just need to complete
+gerrit registration steps above and clone the source repository
+(remember the repository on github.com is just a mirror):
+
+    ~ % git clone ssh://YOURNAME@review.couchbase.org:29418/couchbase-ruby-model.git
+
+Install [`commit-msg` hook][2]:
+
+    ~/couchbase-ruby-model % scp -p -P 29418 YOURNAME@review.couchbase.org:hooks/commit-msg .git/hooks/
+
+Make your changes and upload them for review:
+
+    ~/couchbase-ruby-model % git commit
+    ~/couchbase-ruby-model % git push origin HEAD:refs/for/master
+
+If you need to fix or add something to your patch, do it and re-upload
+the changes (all you need is to keep `Change-Id:` line the same to
+allow gerrit to track the patch.
+
+    ~/couchbase-ruby-model % git commit --amend
+    ~/couchbase-ruby-model % git push origin HEAD:refs/for/master
+
+Happy hacking!
+
+[1]: http://review.couchbase.org/Documentation/user-upload.html
+[2]: http://review.couchbase.org/Documentation/user-changeid.html

data/HISTORY.markdown

@@ -1,3 +1,12 @@
+## 0.5.1 / 2013-02-25
+
+* Fix attribute inheritance when subclassing (Mike Evans)
+* Added as_json method for rails JSON responses (Stephen von Takach)
+* Add contributing document
+* Fix test hiding
+* Remove comments from the javascript sources
+* Reduce development dependencies and update jar version
+
 ## 0.5.1 / 2012-11-29
 
 * Introduce save! and create! methods and raise RecordInvalid only from them

data/README.markdown

@@ -125,7 +125,7 @@ To generate view you can use yet another generator `rails generate
 couchbase:view DESIGNDOCNAME VIEWNAME`. For example how `total_count`
 view could be generated:
 
-    $ rails generate link total_count
+    $ rails generate couchbase:view link total_count
 
 The generated files contains useful info and links about how to write
 map and reduce functions, you can take a look at them in the [templates
@@ -155,6 +155,6 @@ And request them later:
 
 
 [1]: https://github.com/couchbase/couchbase-ruby-client/
-[2]: https://github.com/couchbaselabs/ruby-couchbase-model/tree/master/lib/rails/generators/couchbase/view/templates/
+[2]: https://github.com/couchbase/couchbase-ruby-model/blob/master/lib/rails/generators/couchbase/view/templates/
 [3]: http://couchbase.com/issues/browse/RCBC
 [4]: http://freenode.net/irc_servers.shtml

data/couchbase-model.gemspec

@@ -18,9 +18,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'couchbase', '~> 1.2.0.dp'
 
-  s.add_development_dependency 'rake', '~> 0.8.7'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest'
-  s.add_development_dependency 'rdiscount'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'debugger'
 end

data/lib/couchbase/model.rb

@@ -124,10 +124,10 @@ module Couchbase
     attr_reader :raw
 
     # @private Container for all attributes with defaults of all subclasses
-    @@attributes = ::Hash.new {|hash, key| hash[key] = {}}
+    @@attributes = {}
 
     # @private Container for all view names of all subclasses
-    @@views = ::Hash.new {|hash, key| hash[key] = {}}
+    @@views = {}
 
     # Use custom connection options
     #
@@ -234,7 +234,7 @@ module Couchbase
           Configuration.design_documents_paths.each do |path|
             ff = File.join(path, design_document.to_s, name.to_s, "#{type}.js")
             if File.file?(ff)
-              contents = File.read(ff).strip
+              contents = File.read(ff).gsub(/^\s*\/\/.*$\n\r?/, '').strip
               next if contents.empty?
               mtime = [mtime, File.mtime(ff).to_i].max
               digest << contents
@@ -640,7 +640,11 @@ module Couchbase
     #
     # @return [Hash]
     def self.attributes
-      @@attributes[self]
+      @attributes ||= if self == Model
+                        @@attributes.dup
+                      else
+                        couchbase_ancestor.attributes.dup
+                      end
     end
 
     # All defined views within a class.
@@ -651,7 +655,20 @@ module Couchbase
     #
     # @return [Array]
     def self.views
-      @@views[self]
+      @views ||= if self == Model
+                   @@views.dup
+                 else
+                   couchbase_ancestor.views.dup
+                 end
+    end
+
+    # Returns the first ancestor that is also a Couchbase::Model ancestor.
+    #
+    # @return Class
+    def self.couchbase_ancestor
+      ancestors[1..-1].each do |ancestor|
+        return ancestor if ancestor.ancestors.include?(Couchbase::Model)
+      end
     end
 
     # All the attributes of the current instance
@@ -693,6 +710,16 @@ module Couchbase
       self
     end
 
+    # Format the model for use in a JSON response
+    #
+    # @since 0.5.2
+    #
+    # @return [Hash] a JSON representation of the model for REST APIs
+    #
+    def as_json(options = {})
+      attributes.merge({:id => @id}).as_json(options)
+    end
+
     # @private The thread local storage for model specific stuff
     #
     # @since 0.0.1

data/lib/couchbase/model/version.rb

@@ -19,7 +19,7 @@ module Couchbase
 
   class Model
 
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
 
   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-20120222.060643-15.jar"
+  jar_path = "0.5-SNAPSHOT/CouchbaseMock-0.5-20120726.220757-19.jar"
   sh %{wget -q -O test/CouchbaseMock.jar http://files.couchbase.com/maven2/org/couchbase/mock/CouchbaseMock/#{jar_path}}
 end
 
@@ -27,7 +27,6 @@ CLOBBER << 'test/CouchbaseMock.jar'
 
 Rake::TestTask.new do |test|
   test.libs << "test" << "."
-  test.ruby_opts << "-rruby-debug" if ENV['DEBUG']
   test.pattern = 'test/test_*.rb'
   test.options = '--verbose'
 end

data/tasks/util.rake

@@ -17,5 +17,5 @@
 
 desc 'Start an irb session and load the library.'
 task :console  do
-  exec "irb -I lib -rruby-debug -rcouchbase-model"
+  exec "irb -I lib -rcouchbase-model"
 end

data/test/test_model.rb

@@ -45,6 +45,11 @@ class Attachment < Couchbase::Model
   defaults :format => :plain
 end
 
+class Comments < Couchbase::Model
+  include Enumerable
+  attribute :comments, :default => []
+end
+
 class TestModel < MiniTest::Unit::TestCase
 
   def setup
@@ -126,12 +131,12 @@ class TestModel < MiniTest::Unit::TestCase
   end
 
   def test_it_raises_not_found_exception
-    assert_raises Couchbase::Error::MissingId do
+    assert_raises Couchbase::Error::NotFound do
       Post.find("missing_key")
     end
   end
 
-  def test_it_raises_not_found_exception
+  def test_it_returns_nil_when_key_not_found
      refute Post.find_by_id("missing_key")
   end
 
@@ -221,6 +226,16 @@ class TestModel < MiniTest::Unit::TestCase
     assert_equal "the-key", Post.new(:key => ["the", "key"]).to_param
   end
 
+  def test_as_json
+    require 'active_support/json/encoding'
+
+    response = {'id' => 'the-id'}
+    assert_equal response, Post.new(:id => "the-id").as_json
+
+    response = {}
+    assert_equal response, Post.new(:id => "the-id").as_json(:except => :id)
+  end
+
   def test_validation
     post = ValidPost.create(:title => 'Hello, World!')
     assert post.valid?, "post with title should be valid"
@@ -242,4 +257,8 @@ class TestModel < MiniTest::Unit::TestCase
     assert_equal contents, blob.raw
   end
 
+  def test_couchbase_ancestor
+    assert_equal Couchbase::Model, Comments.couchbase_ancestor
+  end
+
 end

data/test/test_model_rails_integration.rb

@@ -0,0 +1,76 @@
+# 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 Program < Couchbase::Model
+  attribute :title
+  attribute :genres, :default => []
+end
+
+class Movie < Program
+  attribute :mpaa_rating
+  attribute :runtime
+end
+
+class Series < Program
+  attribute :vchip_rating
+end
+
+class Episode < Series
+  attribute :runtime
+end
+
+class TestModelRailsIntegration < MiniTest::Unit::TestCase
+
+  def test_class_attributes_are_inheritable
+    program_attributes = [:title, :genres]
+    movie_attributes   = [:mpaa_rating, :runtime]
+    series_attributes  = [:vchip_rating]
+    episode_attributes = [:runtime]
+
+    assert_equal program_attributes, Program.attributes.keys
+    assert_equal program_attributes + movie_attributes, Movie.attributes.keys
+    assert_equal program_attributes + series_attributes, Series.attributes.keys
+    assert_equal program_attributes + series_attributes + episode_attributes, Episode.attributes.keys
+  end
+
+  def test_default_attributes_are_inheritable
+    assert_equal nil, Movie.attributes[:title]
+    assert_equal [],  Movie.attributes[:genres]
+  end
+
+  def test_instance_attributes_are_inheritable
+    episode = Episode.new(:title => 'Family Guy', :genres => ['Comedy'], :vchip_rating => 'TVPG', :runtime => 30)
+
+    assert_equal [:title, :genres, :vchip_rating, :runtime], episode.attributes.keys
+    assert_equal 'Family Guy', episode.title
+    assert_equal ['Comedy'], episode.genres
+    assert_equal 30, episode.runtime
+    assert_equal 'TVPG', episode.vchip_rating
+  end
+
+  def test_class_attributes_from_subclasses_do_not_propogate_up_ancestor_chain
+    assert_equal [:title, :genres, :vchip_rating], Series.attributes.keys
+  end
+
+  def test_instance_attributes_from_subclasses_do_not_propogate_up_ancestor_chain
+    series = Series.new(:title => 'Family Guy', :genres => ['Comedy'], :vchip_rating => 'TVPG')
+    assert_equal [:title, :genres, :vchip_rating], series.attributes.keys
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchbase-model
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: couchbase
@@ -29,22 +29,6 @@ dependencies:
         version: 1.2.0.dp
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
-  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,39 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdiscount
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -116,6 +68,7 @@ files:
 - .gitignore
 - .travis.yml
 - .yardopts
+- CONTRIBUTING.markdown
 - Gemfile
 - HISTORY.markdown
 - README.markdown
@@ -136,12 +89,12 @@ files:
 - lib/rails/generators/couchbase/view/templates/reduce.js
 - lib/rails/generators/couchbase/view/view_generator.rb
 - lib/rails/generators/couchbase_generator.rb
-- tasks/doc.rake
 - tasks/package.rake
 - tasks/test.rake
 - tasks/util.rake
 - test/setup.rb
 - test/test_model.rb
+- test/test_model_rails_integration.rb
 - test/test_uuid.rb
 homepage: https://github.com/couchbase/couchbase-ruby-model
 licenses: []

data/tasks/doc.rake

@@ -1,25 +0,0 @@
-# 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.
-#
-
-require 'rake/clean'
-require 'yard'
-require 'yard/rake/yardoc_task'
-
-YARD::Rake::YardocTask.new do |t|
-  t.options = %w(--protected --no-private)
-  t.files.push('-', 'README.markdown', 'HISTORY.markdown')
-end