couchbase-orm 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30ece0939354be24d837389441c065a99526b79e
-  data.tar.gz: 152e0ab95ae5b843e8c3aeb4d697f863666759b2
+  metadata.gz: 6db6e76268e2d3e78fe6312014d51a81b78dc687
+  data.tar.gz: 976ea9856de874fcd427c3ed8a60c827a4244a21
 SHA512:
-  metadata.gz: 3a00046733b74236cb88e68075b1eecaa6c54a65696daace7847b643c871221647c07aff574d36b011a848142260f17ff54a8489d81c7a14b832603c503005b4
-  data.tar.gz: 92d43d339fb8af9c4d07113d55868d17c766a037d2cf3c7ec04ae5db6b33434df7a6dbf1a27135c66c2d9fc0466287848383e7d8e12be841446592d4389e481e
+  metadata.gz: e647737e707d8d49399c86ef6455c226a333b941ad1ea793c45e09bcc6a42ac5d05116ef4ecbb075a286f12bbbcf04b7b7fb8e722b44dcd7750839156561fb34
+  data.tar.gz: afb572be2ba020827f32c7e945f57522c9f9ce0a41f78f5b6bbede66db78fd9e7a78a1c7d01d1be09b26d17e2c93ef374e8729d319099ae28200724028e4f588

data/README.md

@@ -101,6 +101,15 @@ can then be used for filtering results or ordering.
       # * the by_author view above
       # * def find_by_author(author); end
       index_view :author
+      
+      # You can make compound keys by passing an array to :emit_key
+      # this allow to query by read/unread comments
+      view :by_read, emit_key: [:user_id, :read]
+      # this allow to query by view_count
+      view :by_view_count, emit_key: [:user_id, :view_count]
+       
+      
+      
 
       validates_presence_of :author, :body
     end
@@ -110,6 +119,20 @@ You can use `Comment.find_by_author('name')` to obtain all the comments by
 a particular author. The same thing, using the view directly would be:
 `Comment.by_author(key: 'name')`
 
+When using a compound key, the usage is the same, you just give the full key : 
+
+```ruby
+   Comment.by_read(key: '["'+user_id+'",false]') # gives all unread comments for one particular user
+   
+   # or even a range !
+   
+   Comment.by_view_count(startkey: '["'+user_id+'",10]', endkey: '["'+user_id+'",20]') # gives all comments that have been seen more than 10 times but less than 20
+```
+
+Check this couchbase help page to learn more on what's possible with compound keys : https://developer.couchbase.com/documentation/server/3.x/admin/Views/views-translateSQL.html
+
+Ex : Compound keys allows to decide the order of the results, and you can reverse it by passing `descending: true`
+
 ## Associations and Indexes
 
 There are common active record helpers available for use `belongs_to` and `has_many`
@@ -129,3 +152,22 @@ There are common active record helpers available for use `belongs_to` and `has_m
 ```
 
 
+## Performance Comparison with Couchbase-Ruby-Model
+
+Basically we migrated an application from [Couchbase Ruby Model](https://github.com/couchbase/couchbase-ruby-model)
+to [Couchbase-ORM](https://github.com/acaprojects/couchbase-orm) (this project)
+
+* Rails 5 production
+* Puma as the webserver
+* Running on a 2015 Macbook Pro
+* Performance test: `siege -c250 -r10  http://localhost:3000/auth/authority`
+
+The request above pulls the same database document each time and returns it. A simple O(1) operation.
+
+| Stat | Couchbase Ruby Model | Couchbase-ORM |
+| :--- | :---                 |   :---        |
+|Transactions|2500 hits|2500 hits|
+|Elapsed time|12.24 secs|8.20 secs|
+|Response time|0.88 secs|0.47 secs|
+|Transaction rate|204.25 trans/sec|304.88 trans/sec|
+|Request Code|[ruby-model-app](https://github.com/QuayPay/coauth/blob/95bbf5e5c3b3340e5af2da494b90c91c5e3d6eaa/app/controllers/auth/authorities_controller.rb#L6)|[couch-orm-app](https://github.com/QuayPay/coauth/blob/87f6fdeaab784ba252a5d38bbcf9e6b0477bb504/app/controllers/auth/authorities_controller.rb#L8)|

data/couchbase-orm.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |gem|
     gem.required_ruby_version = '>= 2.1.0'
     gem.require_paths = ["lib"]
 
-    gem.add_runtime_dependency     'libcouchbase', '~> 0.1'
-    gem.add_runtime_dependency     'activemodel',  '~> 5.0'
+    gem.add_runtime_dependency     'libcouchbase', '~> 0.2'
+    gem.add_runtime_dependency     'activemodel',  '>= 4.0', '< 6.0'
     gem.add_runtime_dependency     'radix',        '~> 2.2' # converting numbers to and from any base
 
     gem.add_development_dependency 'rake',         '~> 11.2'

data/lib/couchbase-orm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true, encoding: ASCII-8BIT
 
 module CouchbaseOrm
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
 end

data/lib/couchbase-orm/views.rb

@@ -23,7 +23,13 @@ module CouchbaseOrm
             #    # ...
             #  end
             def view(name, map: nil, emit_key: nil, reduce: nil, **options)
-                raise "unknown emit_key attribute for view :#{name}, emit_key: :#{emit_key}" if emit_key && @attributes[emit_key].nil?
+                if emit_key.class == Array
+                    emit_key.each do |key|
+                        raise "unknown emit_key attribute for view :#{name}, emit_key: :#{key}" if key && @attributes[key].nil?
+                    end
+                else
+                    raise "unknown emit_key attribute for view :#{name}, emit_key: :#{emit_key}" if emit_key && @attributes[emit_key].nil?
+                end
 
                 options = ViewDefaults.merge(options)
 
@@ -32,10 +38,19 @@ module CouchbaseOrm
                 method_opts[:reduce] = reduce if reduce
 
                 unless method_opts.has_key? :map
-                    emit_key = emit_key || :created_at
-
-                    if emit_key != :created_at && self.attributes[emit_key][:type].to_s == 'Array'
+                    if emit_key.class == Array
                         method_opts[:map] = <<-EMAP
+function(doc) {
+    if (doc.type === "{{design_document}}") {
+        emit([#{emit_key.map{|key| "doc."+key.to_s}.join(',')}], null);
+    }
+}
+EMAP
+                    else
+                        emit_key = emit_key || :created_at
+
+                        if emit_key != :created_at && self.attributes[emit_key][:type].to_s == 'Array'
+                            method_opts[:map] = <<-EMAP
 function(doc) {
     var i;
     if (doc.type === "{{design_document}}") {
@@ -45,14 +60,15 @@ function(doc) {
     }
 }
 EMAP
-                    else
-                        method_opts[:map] = <<-EMAP
+                        else
+                            method_opts[:map] = <<-EMAP
 function(doc) {
     if (doc.type === "{{design_document}}") {
         emit(doc.#{emit_key}, null);
     }
 }
 EMAP
+                        end
                     end
                 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase-orm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libcouchbase
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: radix
   requirement: !ruby/object:Gem::Requirement