couchbase-orm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc28632e30fe3d518b6fb10fe892a9a51fae2229
+  data.tar.gz: c794c256004e9550f88dd2e760df80d0e35ad6b6
+SHA512:
+  metadata.gz: 8cfd1a37baac0d5ff3045165d6a723b1d91814fe20790511e1a242839917de1b04de3806af038f2bcb34ea90445bfd73d0869bea2b0eb77ab12cf326b7f722dc
+  data.tar.gz: eaa78cf644bb41f50b4e465931308174394589c89ca46b6569e485d7311a17ee27c6a4a42071fa1bd499a4a09ffaec9e7c37913af9fd2e3f8707af441d3f189c

data/.gitignore

@@ -0,0 +1,18 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+html
+pkg
+doc
+tmp
+rerun.txt
+Gemfile.lock
+.bundle
+.idea
+*.rbc
+.yardoc
+bin
+Gemfile-custom
+
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--format progress

data/.travis.yml

@@ -0,0 +1,34 @@
+language: ruby
+rvm:
+  - ruby-2.3.1
+  - ruby-2.2.5
+  - ruby-head
+  - rubinius-3.62
+  - rubinius
+  - jruby-9.1.5.0
+  - jruby-head
+branches:
+  only:
+    - master
+before_install:
+  - git submodule update --init --recursive
+  - gem install ffi
+  - sudo apt-get install libev-dev
+  - sudo wget http://packages.couchbase.com/releases/4.5.1/couchbase-server-enterprise_4.5.1-ubuntu14.04_amd64.deb
+  - sudo dpkg -i couchbase-server-enterprise_4.5.1-ubuntu14.04_amd64.deb
+  - sleep 4
+  - sudo service couchbase-server status
+  - /opt/couchbase/bin/couchbase-cli cluster-init -c 127.0.0.1:8091 --cluster-username=admin --cluster-password=password --cluster-ramsize=320 --cluster-index-ramsize=256 --cluster-fts-ramsize=256 --services=data,index,query,fts
+  - sleep 4
+  - /opt/couchbase/bin/couchbase-cli server-info   -c 127.0.0.1:8091 -u admin -p password
+  - /opt/couchbase/bin/couchbase-cli bucket-create -c 127.0.0.1:8091 -u admin -p password --bucket=default --bucket-type=couchbase --bucket-ramsize=160 --bucket-replica=0 --wait
+before_script:
+  - rake compile
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: rubinius
+    - rvm: rubinius-3.62
+sudo: required
+dist: trusty

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rubysl", :platform => :rbx

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2016 ACAProjects
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+===
+
+This license applies to all parts of the libcouchbase gem (Ruby FFI bindings for libcouchbase only)
+Libcouchbase itself [is using the Couchbase license](https://github.com/couchbase/libcouchbase/blob/master/LICENSE)

data/README.md

@@ -0,0 +1,131 @@
+# Couchbase ORM for Rails
+
+## Rails integration
+
+To generate config you can use `rails generate couchbase_orm:config`:
+
+    $ rails generate couchbase_orm:config
+    create  config/couchbase.yml
+
+It will generate this `config/couchbase.yml` for you:
+
+    common: &common
+      hosts: localhost
+      password:
+
+    development:
+      <<: *common
+      bucket: default
+
+    test:
+      <<: *common
+      bucket: app_name_test
+      password: for_test_bucket
+
+    # set these environment variables on your production server
+    production:
+      hosts: <%= ENV['COUCHBASE_HOST'] || ENV['COUCHBASE_HOSTS'] %>
+      bucket: <%= ENV['COUCHBASE_BUCKET'] %>
+      password: <%= ENV['COUCHBASE_PASSWORD'] %>
+
+
+## Examples
+
+```ruby
+    require 'couchbase-orm'
+
+    class Post < CouchbaseOrm::Base
+      attribute :title, type: String
+      attribute :body,  type: String
+      attribute :draft, type: Boolean
+    end
+
+    p = Post.new(id: 'hello-world',
+                 title: 'Hello world',
+                 draft: true)
+    p.save
+    p = Post.find('hello-world')
+    p.body = "Once upon the times...."
+    p.save
+    p.update(draft: false)
+    Post.bucket.get('hello-world')  #=> {"title"=>"Hello world", "draft"=>false,
+                                    #    "body"=>"Once upon the times...."}
+```
+
+You can also let the library generate the unique identifier for you:
+
+```ruby
+    p = Post.create(title: 'How to generate ID',
+                    body: 'Open up the editor...')
+    p.id        #=> "post-abcDE34"
+```
+
+You can define connection options on per model basis:
+
+```ruby
+    class Post < CouchbaseOrm::Base
+      attribute :title, type: String
+      attribute :body,  type: String
+      attribute :draft, type: Boolean
+
+      connect bucket: 'blog', password: ENV['BLOG_BUCKET_PASSWORD']
+    end
+```
+
+## Validations
+
+There are all methods from ActiveModel::Validations accessible in
+context of rails application. You can also enforce types using ruby
+[conversion methods](http://www.virtuouscode.com/2012/05/07/a-ruby-conversion-idiom/)
+
+```ruby
+    class Comment < Couchbase::Model
+      attribute :author, :body, type: String
+
+      validates_presence_of :author, :body
+    end
+```
+
+## Views (aka Map/Reduce indexes)
+
+Views are defined in the model and typically just emit an attribute that
+can then be used for filtering results or ordering.
+
+```ruby
+    class Comment < CouchbaseOrm::Base
+      attribute :author, :body, type: String
+      view :all # => emits :id and will return all comments
+      view :by_author, emit_key: :author
+
+      # Generates two functions:
+      # * the by_author view above
+      # * def find_by_author(author); end
+      index_view :author
+
+      validates_presence_of :author, :body
+    end
+```
+
+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')`
+
+## Associations and Indexes
+
+There are common active record helpers available for use `belongs_to` and `has_many`
+
+```ruby
+    class Comment < CouchbaseOrm::Base
+        belongs_to :author
+    end
+
+    class Author < CouchbaseOrm::Base
+        has_many :comments, dependent: :destroy
+
+        # You can ensure an attribute is unique for this model
+        attribute :email, type: String
+        ensure_unique :email
+    end
+```
+
+

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'rspec/core/rake_task'  # testing framework
+require 'yard'                  # yard documentation
+require 'ffi'                   # loads the extension
+require 'rake/clean'            # for the :clobber rake task
+require File.expand_path('../lib/libcouchbase/ext/tasks', __FILE__)    # platform specific rake tasks used by compile
+
+
+
+# By default we don't run network tests
+task :default => :limited_spec
+RSpec::Core::RakeTask.new(:limited_spec) do |t|
+    # Exclude full text search tests until we can automate index creation
+    t.rspec_opts = "--tag ~full_text_search --tag ~n1ql_query"
+end
+RSpec::Core::RakeTask.new(:spec)
+
+
+desc 'Run all tests'
+task :test => [:spec]
+
+
+YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', '-', 'ext/README.md', 'README.md']
+end
+
+
+desc 'Compile libcouchbase from submodule'
+if FFI::Platform.windows?
+    task :compile => ["ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}"]
+    CLOBBER.include("ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}")
+else
+    task :compile => ["ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}"]
+    CLOBBER.include("ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}")
+end
+
+
+# NOTE:: Generated on OSX
+desc 'Generate the FFI bindings'
+task :generate_bindings do
+    require "ffi/gen"
+
+    # NOTE:: you must export the include dir:
+    # export CPATH=./ext/libcouchbase/include/
+    #
+    # Once generated we need to:
+    # * adjust the ffi_lib path:
+    #   ffi_lib ::File.expand_path("../../../../ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}", __FILE__)
+    # * Rename some structs strings to pointers
+    #   create_st3.rb -> connstr, username, passwd
+    #   cmdhttp.rb -> body, reqhandle, content_type, username, password, host
+    #   cmdfts.rb -> query
+    #   respfts.rb -> row
+    #   respviewquery.rb -> value, geometry, docid
+    #   respn1ql.rb -> row
+
+    FFI::Gen.generate(
+        module_name: "Libcouchbase::Ext",
+        ffi_lib:     "libcouchbase",
+        require_path: "libcouchbase/ext/libcouchbase",
+        headers:     [
+            "./ext/libcouchbase/include/libcouchbase/couchbase.h",
+            "./ext/libcouchbase/include/libcouchbase/error.h",
+            "./ext/libcouchbase/include/libcouchbase/views.h",
+            "./ext/libcouchbase/include/libcouchbase/subdoc.h",
+            "./ext/libcouchbase/include/libcouchbase/n1ql.h",
+            "./ext/libcouchbase/include/libcouchbase/cbft.h",
+            "./ext/libcouchbase/include/libcouchbase/kvbuf.h"
+        ],
+        # Searching for stdarg.h
+        cflags:      ["-I/System/Library/Frameworks/Kernel.framework/Versions/A/Headers"],
+        prefixes:    ["LCB_", "lcb_"],
+        output:      "libcouchbase.rb"
+    )
+end

data/couchbase-orm.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path("../lib/couchbase-orm/version", __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name          = "couchbase-orm"
+    gem.version       = CouchbaseOrm::VERSION
+    gem.license       = 'MIT'
+    gem.authors       = ["Stephen von Takach"]
+    gem.email         = ["steve@cotag.me"]
+    gem.homepage      = "https://github.com/cotag/couchbase-orm"
+    gem.summary       = "Couchbase ORM for Rails"
+    gem.description   = "A Couchbase ORM for Rails"
+
+    gem.required_ruby_version = '>= 2.1.0'
+    gem.require_paths = ["lib"]
+
+    gem.add_runtime_dependency     'libcouchbase', '~> 0.0'
+    gem.add_runtime_dependency     'activemodel',  '~> 5.0'
+    gem.add_runtime_dependency     'radix',        '~> 2.2' # converting numbers to and from any base
+
+    gem.add_development_dependency 'rake',         '~> 11.2'
+    gem.add_development_dependency 'rspec',        '~> 3.5'
+    gem.add_development_dependency 'yard',         '~> 0.9'
+    gem.add_development_dependency 'minitest',     '~> 5.9'
+
+    gem.files         = `git ls-files`.split("\n")
+    gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/couchbase-orm.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+require 'libcouchbase'
+
+module CouchbaseOrm
+    autoload :Error,       'couchbase-orm/error'
+    autoload :Connection,  'couchbase-orm/connection'
+    autoload :IdGenerator, 'couchbase-orm/id_generator'
+    autoload :Base,        'couchbase-orm/base'
+end
+
+# Provide Boolean conversion function
+# See: http://www.virtuouscode.com/2012/05/07/a-ruby-conversion-idiom/
+module Conversions
+    private
+
+    def Boolean(value)
+        case value
+        when String, Symbol
+            case value.to_s.strip.downcase
+            when 'true'
+                return true
+            when 'false'
+                return false
+            end
+        when Integer
+            return value != 0
+        when false, nil
+            return false
+        when true
+            return true
+        end
+
+        raise ArgumentError, "invalid value for Boolean(): \"#{value.inspect}\""
+    end
+end
+class Boolean < TrueClass; end
+
+# If we are using Rails then we will include the Couchbase railtie.
+if defined?(Rails)
+    require 'couchbase-orm/railtie'
+end
+

data/lib/couchbase-orm/associations.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+require 'active_model'
+
+module CouchbaseOrm
+    module Associations
+        extend ActiveSupport::Concern
+
+
+        module ClassMethods
+            # Defines a belongs_to association for the model
+            def belongs_to(name, **options)
+                @associations ||= []
+                @associations << [name.to_sym, options[:dependent]]
+
+                ref = options[:foreign_key] || :"#{name}_id"
+                ref_ass = :"#{ref}="
+                instance_var = :"@__assoc_#{name}"
+
+                # Class reference
+                assoc = (options[:class_name] || name.to_s.camelize).to_s
+
+                # Create the local setter / getter
+                attribute(ref) { |value|
+                    remove_instance_variable(instance_var) if instance_variable_defined?(instance_var)
+                    value
+                }
+
+                # Define reader
+                define_method(name) do
+                    return instance_variable_get(instance_var) if instance_variable_defined?(instance_var)
+                    val = assoc.constantize.find(self.send(ref), quiet: true)
+                    instance_variable_set(instance_var, val)
+                    val
+                end
+
+                # Define writer
+                attr_writer name
+                define_method(:"#{name}=") do |value|
+                    if value
+                        self.send(ref_ass, value.id)
+                    else
+                        self.send(ref_ass, nil)
+                    end
+
+                    instance_variable_set(instance_var, value)
+                end
+            end
+
+            def associations
+                @associations || []
+            end
+        end
+
+
+        def destroy_associations!
+            assoc = self.class.associations
+            assoc.each do |name, dependent|
+                next unless dependent
+
+                model = self.__send__(name)
+                if model.present?
+                    case dependent
+                    when :destroy, :delete
+                        if model.respond_to?(:stream)
+                            model.stream { |mod| mod.__send__(dependent) }
+                        else
+                            model.__send__(dependent)
+                        end
+                    when :restrict_with_exception
+                        raise RecordExists.new("#{self.class.name} instance maintains a restricted reference to #{name}", self)
+                    when :restrict_with_error
+                        # TODO::
+                    end
+                end
+            end
+        end
+
+        def reset_associations
+            assoc = self.class.associations
+            assoc.each do |name, _|
+                instance_var = :"@__assoc_#{name}"
+                remove_instance_variable(instance_var) if instance_variable_defined?(instance_var)
+            end
+        end
+    end
+end