jmoses-couchbase-model 0.5.3

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

@@ -0,0 +1,40 @@
+// The map function is the most critical part of any view as it provides the
+// logical mapping between the input fields of the individual objects stored
+// within Couchbase to the information output when the view is accessed.
+//
+// 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, meta) {
+  emit(meta.id, null);
+}
+
+// You can also check out following examples
+//
+// The simplest example of a map function:
+//
+//   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, meta) {
+//     if (doc.type == "customer") {
+//       emit(meta.id, {last_name: doc.last_name, first_name: doc.first_name});
+//     }
+//   }
+//
+// To be able to filter or sort the view by some document property, you
+// would use that property for the key. For example, the following view
+// 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, meta) {
+//     if (doc.type == "customer") {
+//       emit(doc.last_name, {first_name: doc.first_name});
+//       emit(doc.first_name, {last_name: doc.last_name});
+//     }
+//   }
+//

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

@@ -0,0 +1,61 @@
+// If a view has a reduce function, it is used to produce aggregate results
+// for that view. A reduce function is passed a set of intermediate values
+// and combines them to a single value. Reduce functions must accept, as
+// input, results emitted by its corresponding map function as well as
+// results returned by the reduce function itself. The latter case is
+// referred to as a rereduce.
+//
+//   function (key, values, rereduce) {
+//     return sum(values);
+//   }
+//
+// Reduce functions must handle two cases:
+//
+// 1. When rereduce is false:
+//
+//   reduce([ [key1,id1], [key2,id2], [key3,id3] ], [value1,value2,value3], false)
+//
+//   * key will be an array whose elements are arrays of the form [key,id],
+//     where key is a key emitted by the map function and id is that of the
+//     document from which the key was generated.
+//   * values will be an array of the values emitted for the respective
+//     elements in keys
+//
+// 2. When rereduce is true:
+//
+//   reduce(null, [intermediate1,intermediate2,intermediate3], true)
+//
+//   * key will be null
+//   * values will be an array of values returned by previous calls to the
+//     reduce function
+//
+// Reduce functions should return a single value, suitable for both the
+// value field of the final view and as a member of the values array passed
+// to the reduce function.
+//
+// NOTE: If this file is empty, reduce part will be skipped in design document
+//
+// There is number of built-in functions, which could be used instead of
+// javascript implementation of reduce function.
+//
+// The _count function provides a simple count of the input rows from the
+// map function, using the keys and group level to provide to provide a
+// count of the correlated items. The values generated during the map()
+// stage are ignored.
+//
+//   _count
+//
+// The built-in _sum function collates the output from the map function
+// call. The information can either be a single number or an array of numbers.
+//
+//   _sum
+//
+// The _stats built-in produces statistical calculations for the input data.
+// Like the _sum call the source information should be a number. The
+// generated statistics include the sum, count, minimum (min), maximum (max)
+// and sum squared (sumsqr) of the input rows.
+//
+//   _stats
+//
+// Read more about how to write reduce functions at:
+// http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-reduce.html

data/lib/rails/generators/couchbase/view/view_generator.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+# 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 'rails/generators/couchbase_generator'
+
+module Couchbase
+  module Generators
+    class ViewGenerator < Rails::Generators::Base
+      desc 'Creates a Couchbase views skeletons for map/reduce functions'
+
+      argument :model_name, :type => :string
+      argument :view_name, :type => :string
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_map_reduce_files
+        template 'map.js', File.join('app', 'models', model_name, view_name, 'map.js')
+        template 'reduce.js', File.join('app', 'models', model_name, view_name, 'reduce.js')
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase_generator.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+#
+# 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 'rails/generators/named_base'
+require 'rails/generators/active_model'
+
+module Couchbase #:nodoc:
+  module Generators #:nodoc:
+
+    class Base < ::Rails::Generators::NamedBase #:nodoc:
+
+      def self.source_root
+        @_couchbase_source_root ||=
+          File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+
+      unless methods.include?(:module_namespacing)
+        def module_namespacing(&block)
+          yield if block
+        end
+      end
+
+    end
+
+  end
+end

data/tasks/package.rake

@@ -0,0 +1,27 @@
+# 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 'rubygems/package_task'
+
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../../couchbase-model.gemspec', __FILE__)))
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_tar = true
+end
+

data/tasks/test.rake

@@ -0,0 +1,34 @@
+# 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/testtask'
+require 'rake/clean'
+
+rule 'test/CouchbaseMock.jar' do |task|
+  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
+
+CLOBBER << 'test/CouchbaseMock.jar'
+
+Rake::TestTask.new do |test|
+  test.libs << "test" << "."
+  test.pattern = 'test/test_*.rb'
+  test.options = '--verbose'
+end
+
+Rake::Task['test'].prerequisites.unshift('test/CouchbaseMock.jar')

data/tasks/util.rake

@@ -0,0 +1,21 @@
+# 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.
+#
+
+desc 'Start an irb session and load the library.'
+task :console  do
+  exec "irb -I lib -rcouchbase-model"
+end

data/test/setup.rb

@@ -0,0 +1,168 @@
+# 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 'minitest/autorun'
+require 'couchbase'
+require 'couchbase/model'
+
+require 'socket'
+require 'open-uri'
+
+class CouchbaseServer
+  attr_accessor :host, :port, :num_nodes, :buckets_spec
+
+  def real?
+    true
+  end
+
+  def initialize(params = {})
+    @host, @port = ENV['COUCHBASE_SERVER'].split(':')
+    @port = @port.to_i
+
+    if @host.nil? || @host.empty? || @port == 0
+      raise ArgumentError, 'Check COUCHBASE_SERVER variable. It should be hostname:port'
+    end
+
+    @config = Yajl::Parser.parse(open("http://#{@host}:#{@port}/pools/default"))
+    @num_nodes = @config['nodes'].size
+    @buckets_spec = params[:buckets_spec] || 'default:'  # "default:,protected:secret,cache::memcache"
+  end
+
+  def start
+    # flush all buckets
+    @buckets_spec.split(',') do |bucket|
+      name, password, _ = bucket.split(':')
+      connection = Couchbase.new(:hostname => @host,
+                                 :port => @port,
+                                 :username => name,
+                                 :bucket => name,
+                                 :password => password)
+      connection.flush
+    end
+  end
+  def stop; end
+end
+
+class CouchbaseMock
+  Monitor = Struct.new(:pid, :client, :socket, :port)
+
+  attr_accessor :host, :port, :buckets_spec, :num_nodes, :num_vbuckets
+
+  def real?
+    false
+  end
+
+  def initialize(params = {})
+    @host = '127.0.0.1'
+    @port = 0
+    @num_nodes = 10
+    @num_vbuckets = 4096
+    @buckets_spec = 'default:'  # "default:,protected:secret,cache::memcache"
+    params.each do |key, value|
+      send("#{key}=", value)
+    end
+    yield self if block_given?
+    if @num_vbuckets < 1 || (@num_vbuckets & (@num_vbuckets - 1) != 0)
+      raise ArgumentError, 'Number of vbuckets should be a power of two and greater than zero'
+    end
+  end
+
+  def start
+    @monitor = Monitor.new
+    @monitor.socket = TCPServer.new(nil, 0)
+    @monitor.socket.listen(10)
+    _, @monitor.port, _, _ = @monitor.socket.addr
+    trap('CLD') do
+      puts 'CouchbaseMock.jar died unexpectedly during startup'
+      exit(1)
+    end
+    @monitor.pid = fork
+    if @monitor.pid.nil?
+      rc = exec(command_line("--harakiri-monitor=:#{@monitor.port}"))
+    else
+      trap('CLD', 'SIG_DFL')
+      @monitor.client, _ = @monitor.socket.accept
+      @port = @monitor.client.recv(100).to_i
+    end
+  end
+
+  def stop
+    @monitor.client.close
+    @monitor.socket.close
+    Process.kill('TERM', @monitor.pid)
+    Process.wait(@monitor.pid)
+  end
+
+  def failover_node(index, bucket = 'default')
+    @monitor.client.send("failover,#{index},#{bucket}", 0)
+  end
+
+  def respawn_node(index, bucket = 'default')
+    @monitor.client.send("respawn,#{index},#{bucket}", 0)
+  end
+
+  protected
+
+  def command_line(extra = nil)
+    cmd = "java -jar #{File.dirname(__FILE__)}/CouchbaseMock.jar"
+    cmd << " --host #{@host}" if @host
+    cmd << " --port #{@port}" if @port
+    cmd << " --nodes #{@num_nodes}" if @num_nodes
+    cmd << " --vbuckets #{@num_vbuckets}" if @num_vbuckets
+    cmd << " --buckets #{@buckets_spec}" if @buckets_spec
+    cmd << " #{extra}"
+    cmd
+  end
+end
+
+class MiniTest::Unit::TestCase
+
+  def start_mock(params = {})
+    mock = nil
+    if ENV['COUCHBASE_SERVER']
+      mock = CouchbaseServer.new(params)
+      if (params[:port] && mock.port != params[:port]) ||
+        (params[:host] && mock.host != params[:host]) ||
+        mock.buckets_spec != 'default:'
+        skip("Unable to configure real cluster. Requested config is: #{params.inspect}")
+      end
+    else
+      mock = CouchbaseMock.new(params)
+    end
+    mock.start
+    mock
+  end
+
+  def stop_mock(mock)
+    assert(mock)
+    mock.stop
+  end
+
+  def with_mock(params = {})
+    mock = nil
+    if block_given?
+      mock = start_mock(params)
+      yield mock
+    end
+  ensure
+    stop_mock(mock) if mock
+  end
+
+  def uniq_id(*suffixes)
+    [caller.first[/.*[` ](.*)'/, 1], suffixes].join('_')
+  end
+end

data/test/test_model.rb

@@ -0,0 +1,302 @@
+# 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 Post < Couchbase::Model
+  attribute :title
+  attribute :body
+  attribute :author, :default => 'Anonymous'
+  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
+
+class Beer < Couchbase::Model
+  attribute :name
+  belongs_to :brewery
+end
+
+class Attachment < Couchbase::Model
+  defaults :format => :plain
+end
+
+class Comments < Couchbase::Model
+  include Enumerable
+  attribute :comments, :default => []
+end
+
+class User < Couchbase::Model
+  design_document :people
+end
+
+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|
+      model.bucket = bucket
+    end
+  end
+
+  def teardown
+    stop_mock(@mock)
+  end
+
+  def test_design_document
+    assert_equal 'people', User.design_document
+    assert_equal 'new_people', User.design_document('new_people')
+    assert_equal 'post', Post.design_document
+  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
+    refute post.body
+    refute post.id
+  end
+
+  def test_uses_default_value_or_nil
+    post = Post.new(:title => 'Hello, world')
+    refute post.body
+    assert_equal 'Anonymous', post.author
+    assert_equal 'Anonymous', post.attributes[:author]
+  end
+
+  def test_allows_lambda_as_default_value
+    post = Post.new(:title => 'Hello, world')
+    expected = Time.utc('2010-01-01')
+    assert_equal expected, post.created_at
+    assert_equal expected, post.attributes[:created_at]
+  end
+
+  def test_assings_id_and_saves_the_object
+    post = Post.create(:title => 'Hello, world')
+    assert post.id
+  end
+
+  def test_updates_attributes
+    post = Post.create(:title => 'Hello, world')
+    post.update(:body => 'This is my first example')
+    assert_equal 'This is my first example', post.body
+  end
+
+  def test_refreshes_the_attributes_with_reload_method
+    orig = Post.create(:title => 'Hello, world')
+    double = Post.find(orig.id)
+    double.update(:title => 'Good bye, world')
+    orig.reload
+    assert_equal 'Good bye, world', orig.title
+  end
+
+  def test_it_raises_not_found_exception
+    assert_raises Couchbase::Error::NotFound do
+      Post.find('missing_key')
+    end
+  end
+
+  def test_it_returns_nil_when_key_not_found
+     refute Post.find_by_id('missing_key')
+  end
+
+  def test_doesnt_raise_if_the_attribute_redefined
+    eval <<-EOC
+      class RefinedPost < Couchbase::Model
+        attribute :title
+        attribute :title
+      end
+    EOC
+  end
+
+  def test_allows_to_define_several_attributes_at_once
+    eval <<-EOC
+      class Comment < Couchbase::Model
+        attribute :name, :email, :body
+      end
+    EOC
+
+    comment = Comment.new
+    assert_respond_to comment, :name
+    assert_respond_to comment, :email
+    assert_respond_to comment, :body
+  end
+
+  def test_allows_arbitrary_ids
+    Post.create(:id => uniq_id, :title => 'Foo')
+    assert_equal 'Foo', Post.find(uniq_id).title
+  end
+
+  def test_returns_an_instance_of_post
+    Post.bucket.set(uniq_id, {:title => 'foo'})
+    assert Post.find(uniq_id).kind_of?(Post)
+    assert_equal uniq_id, Post.find(uniq_id).id
+    assert_equal 'foo', Post.find(uniq_id).title
+  end
+
+  def test_changes_its_attributes
+    post = Post.create(:title => 'Hello, world')
+    post.title = 'Good bye, world'
+    post.save.reload
+    assert_equal 'Good bye, world', post.title
+  end
+
+  def test_assings_a_new_id_to_each_record
+    post1 = Post.create
+    post2 = Post.create
+
+    refute post1.new?
+    refute post2.new?
+    refute_equal post1.id, post2.id
+  end
+
+  def test_deletes_an_existent_model
+    post = Post.create(:id => uniq_id)
+    assert post.delete
+    assert_raises Couchbase::Error::NotFound do
+      Post.bucket.get(uniq_id)
+    end
+  end
+
+  def test_fails_to_delete_model_without_id
+    post = Post.new(:title => 'Hello')
+    refute post.id
+    assert_raises Couchbase::Error::MissingId do
+      post.delete
+    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
+
+  def test_to_key
+    assert_equal ['the-id'], Post.new(:id => 'the-id').to_key
+    assert_equal ['the-key'], Post.new(:key => 'the-key').to_key
+  end
+
+  def test_to_param
+    assert_equal 'the-id', Post.new(:id => 'the-id').to_param
+    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'
+    post.title = nil
+    refute post.save
+    assert_raises(Couchbase::Error::RecordInvalid) do
+      post.save!
+    end
+    refute ValidPost.create(:title => nil)
+    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
+
+  def test_couchbase_ancestor
+    assert_equal Couchbase::Model, Comments.couchbase_ancestor
+  end
+
+  def test_returns_multiple_instances_of_post
+    Post.create(:id => uniq_id('first'), :title => 'foo')
+    Post.create(:id => uniq_id('second'), :title => 'bar')
+
+    results = Post.find([uniq_id('first'), uniq_id('second')])
+    assert results.kind_of?(Array)
+    assert results.size == 2
+    assert results.detect { |post| post.id == uniq_id('first') }.title == 'foo'
+    assert results.detect { |post| post.id == uniq_id('second') }.title == 'bar'
+  end
+
+  def test_returns_array_for_array_of_ids
+    Post.create(:id => uniq_id('first'), :title => 'foo')
+
+    results = Post.find([uniq_id('first')])
+    assert results.kind_of?(Array)
+    assert results.size == 1
+    assert results[0].title == 'foo'
+  end
+
+  def test_returns_array_for_array_of_ids_using_find_by_id
+    Post.create(:id => uniq_id('first'), :title => 'foo')
+
+    results = Post.find_by_id([uniq_id('first')])
+    assert results.kind_of?(Array)
+    assert results.size == 1
+    assert results[0].title == 'foo'
+  end
+end