libcouchbase 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 994ce5bef19d9b756a99b100151c0186c1196b1c
-  data.tar.gz: '04980977530cfe5f4c94f8eeb38c03546bcba541'
+  metadata.gz: 2e0fecefcadf6aba5e497d297195f7c75a8ac93d
+  data.tar.gz: 68a30faba8a468ab280aac7c8a7e387a0b59fbb1
 SHA512:
-  metadata.gz: 5f3bd4838cdb3fcbca7825fb0b0bade82b4054c72526ab82720adb1d5e536b0e0367bd65d55f012f52cd223c08d6e67a113616d4c8280d99169656362a204b25
-  data.tar.gz: 50a3ed477e3fa3e7faa06081343ab5a570e738e53d6f071a54629defa764f2a3a6aa40be9444c2e38e77470b9284a3aad40de1082e7338fa170ae441d4adb88f
+  metadata.gz: 362de9a1a26005ab3b5e0cc43afb28245a45a2f12f659c8cbd2c7f6e76cd14c2d4ec43abd6de670545411ccf84e14ed6ebe6124662faab5de2a6e088aa7b6725
+  data.tar.gz: be6115fcb1f03c7a8f55dffe186d6d74c564c6197d2228f72398592532b5bb982afc2c645b17595eeeadc7de152c937cd7dc0f2770bf4324f27d5dd7f67eb6a0

data/.gitignore

@@ -16,3 +16,5 @@ bin
 Gemfile-custom
 
 *.gem
+
+*.dll

data/README.md

@@ -64,7 +64,7 @@ Tested on the following Operating Systems:
 * OSX / MacOS
 * Linux
 * Windows
-  * NOTE:: windows support is not complete. This message will be removed once it is fully functional
+  * Ruby x64 2.4+ with MSYS2 DevKit
 
 
 ## Usage

data/Rakefile

@@ -27,8 +27,9 @@ 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}")
+    task :compile do
+        puts "See windows_build.md for build instructions"
+    end
 else
     task :compile => ["ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}"]
     CLOBBER.include("ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}")

data/ext/Rakefile

@@ -12,8 +12,7 @@ task :default => :libcouchbase
 
 desc "Compile libcouchbase from submodule"
 if FFI::Platform.windows?
-    task :libcouchbase => ["ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}"]
-    CLOBBER.include("ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}")
+    task :libcouchbase do; end
 else
     task :libcouchbase => ["ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}"]
     CLOBBER.include("ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}")

data/lib/libcouchbase/connection.rb

@@ -74,21 +74,13 @@ module Libcouchbase
             @reactor.on_program_interrupt { destroy }
             @io_ptr = FFI::MemoryPointer.new :pointer, 1
 
-            if FFI::Platform.windows?
-                @io_opts = Ext::IOOptions.new
-                @io_opts[:version] = 0
-                @io_opts[:type] = :IO_winIOCP
-
-                err = Ext.create_io_ops(@io_ptr, @io_opts)
-            else
-                @io_opts = Ext::Libuv::UVOptions.new
-                @io_opts[:version] = 0
-                @io_opts[:loop] = @reactor.handle
-                @io_opts[:start_stop_noop] = 1 # We want to control the start and stopping of the loop
-                
-                err = Ext::Libuv.create_libuv_io_opts(0, @io_ptr, @io_opts)
-            end
+            # Configure Libuv plugin
+            @io_opts = Ext::Libuv::UVOptions.new
+            @io_opts[:version] = 0
+            @io_opts[:loop] = @reactor.handle
+            @io_opts[:start_stop_noop] = 1 # We want to control the start and stopping of the loop
 
+            err = Ext::Libuv.create_libuv_io_opts(0, @io_ptr, @io_opts)
             if err != :success
                 raise Error.lookup(err), 'failed to allocate IO plugin'
             end

data/lib/libcouchbase/ext/libcouchbase.rb

@@ -4,13 +4,13 @@ require 'libcouchbase/ext/libcouchbase/enums'
 module Libcouchbase::Ext
   extend FFI::Library
   if FFI::Platform.windows?
-    ffi_lib ::File.expand_path("../../../../ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}", __FILE__)
-    require 'libcouchbase/ext/libcouchbase_iocp'
+    ffi_lib ::File.expand_path("../../../../ext/libcouchbase.dll", __FILE__)
   else
     ffi_lib ::File.expand_path("../../../../ext/libcouchbase/build/lib/libcouchbase.#{FFI::Platform::LIBSUFFIX}", __FILE__)
-    require 'libcouchbase/ext/libcouchbase_libuv'
   end
 
+  require 'libcouchbase/ext/libcouchbase_libuv'
+
   autoload :T, 'libcouchbase/ext/libcouchbase/t'
   autoload :HttpRequestT, 'libcouchbase/ext/libcouchbase/http_request_t'
   autoload :CONTIGBUF, 'libcouchbase/ext/libcouchbase/contigbuf'

data/lib/libcouchbase/ext/libcouchbase_libuv.rb

@@ -4,7 +4,11 @@
 
 module Libcouchbase::Ext::Libuv
     extend FFI::Library
-    ffi_lib ::File.expand_path("../../../../ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}", __FILE__)
+    if FFI::Platform.windows?
+        ffi_lib ::File.expand_path("../../../../ext/libcouchbase_libuv.dll", __FILE__)
+    else
+        ffi_lib ::File.expand_path("../../../../ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}", __FILE__)
+    end
 
     # ref: http://docs.couchbase.com/sdk-api/couchbase-c-client-2.4.8/group__lcb-libuv.html
     class UVOptions < FFI::Struct

data/lib/libcouchbase/ext/tasks.rb

@@ -13,79 +13,27 @@ module FFI::Platform
     end
 end
 
-if FFI::Platform.windows?
-    require 'net/http'
-
-    # Download a pre-built package
-    url = if FFI::Platform.x64?
-        "http://packages.couchbase.com/clients/c/libcouchbase-2.6.3_amd64_vc14.zip"
-    else
-        "http://packages.couchbase.com/clients/c/libcouchbase-2.6.3_x86_vc14.zip"
-    end
-    zip_file = File.expand_path("../../../../ext/libcouchbase.zip", __FILE__)
-
-    file zip_file do
-        print "downloading #{url}"
-        uri = URI(url)
-        Net::HTTP.start(uri.host, uri.port) do |http|
-            request = Net::HTTP::Get.new uri
-
-            http.request request do |response|
-                open File.expand_path("../../../../ext/libcouchbase.zip", __FILE__), 'wb' do |io|
-                    response.read_body do |chunk|
-                        io.write chunk
-                        print '.'
-                    end
-                end
-            end
-        end
-    end
-
-    # Extract the files
-    file 'ext/tmp' => zip_file do
-        begin
-            puts "\nextracting files..."
-            raise 'error extracting files' unless system(File.expand_path("../../../../ext/win-extract.bat", __FILE__))
-        ensure
-            # TODO:: remove dir
-        end
-    end
-
-    # Copy binary files to bin dir
-    file "ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}" => 'ext/tmp' do
-        Dir.chdir('ext/tmp') do |path|
-            dir = File.expand_path("../", Dir["**/libcouchbase.#{FFI::Platform::LIBSUFFIX}"].first)
-            FileUtils.mv dir, File.expand_path("../../../../ext/bin", __FILE__)
-        end
-        FileUtils.rm_rf(File.expand_path("../../../../ext/tmp", __FILE__))
-    end
-else
-    # -----------
-    # UNIX  BUILD
-    # -----------
-
-    # Ensure the submodule is cloned
-    file 'ext/libcouchbase/include' do
-        system 'git', 'submodule', 'update', '--init'
-    end
+# Ensure the submodule is cloned
+file 'ext/libcouchbase/include' do
+    system 'git', 'submodule', 'update', '--init'
+end
 
-    file 'ext/libcouchbase/build' => 'ext/libcouchbase/include' do
-        FileUtils.mkdir('ext/libcouchbase/build')
-    end
+file 'ext/libcouchbase/build' => 'ext/libcouchbase/include' do
+    FileUtils.mkdir('ext/libcouchbase/build')
+end
 
-    file 'ext/libcouchbase/build/makefile' => 'ext/libcouchbase/build' do
-        result = nil
-        Dir.chdir("ext/libcouchbase") do |path|
-            result = system './cmake/configure', '-with-libuv', ::File.expand_path('../../', ::Libuv::Ext.path_to_internal_libuv)
-        end
-        raise 'could not find cmake on path' unless result
+file 'ext/libcouchbase/build/makefile' => 'ext/libcouchbase/build' do
+    result = nil
+    Dir.chdir("ext/libcouchbase") do |path|
+        result = system './cmake/configure', '-with-libuv', ::File.expand_path('../../', ::Libuv::Ext.path_to_internal_libuv)
     end
+    raise 'could not find cmake on path' unless result
+end
 
-    file "ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}" => 'ext/libcouchbase/build/makefile' do
-        result = nil
-        Dir.chdir('ext/libcouchbase/build') do |path|
-            result = system 'make'
-        end
-        raise 'make failed' unless result
+file "ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}" => 'ext/libcouchbase/build/makefile' do
+    result = nil
+    Dir.chdir('ext/libcouchbase/build') do |path|
+        result = system 'make'
     end
+    raise 'make failed' unless result
 end

data/lib/libcouchbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true, encoding: ASCII-8BIT
 
 module Libcouchbase
-    VERSION = '1.2.3'
+    VERSION = '1.2.4'
 end

data/libcouchbase.gemspec

@@ -31,6 +31,10 @@ Gem::Specification.new do |gem|
     gem.files         = `git ls-files`.split("\n")
     gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
+    if File.exist? 'ext/libcouchbase.dll'
+        gem.files += ['ext/libcouchbase.dll', 'ext/libcouchbase_libuv.dll']
+    end 
+
     # Add the submodule to the gem
     relative_path = File.expand_path("../", __FILE__) + '/'
     `git submodule --quiet foreach pwd`.split($\).each do |submodule_path|
@@ -58,4 +62,7 @@ Gem::Specification.new do |gem|
             gem.files += submodule_files_paths
         end
     end
+
+    # Remove sym link (blows up on windows)
+    gem.files.delete('ext/libcouchbase/configure.pl')
 end

data/windows_build.md

@@ -0,0 +1,36 @@
+# Building libcouchbase on Windows
+
+NOTE:: we are currently not supporting 32bit Windows installations
+
+1. Install [Python 2.7 x64](https://www.python.org/downloads/)
+1. Install [cmake](https://cmake.org/download/)
+1. Install [OpenSSL x64 Dev](https://slproweb.com/products/Win32OpenSSL.html)
+1. Install [git](https://git-scm.com/downloads)
+1. `git clone https://github.com/libuv/libuv.git`
+1. Add libuv, openssl, cmake and python to Path ENV VAR
+1. Install [Build Tools for Visual Studio 2017](https://www.visualstudio.com/downloads/)
+   * Windows 10 SDK
+   * Visual C++ tools for cmake
+   * C++/CLI support
+1. Build libuv (or use `gem install libuv` to automate)
+   * `git clone https://chromium.googlesource.com/external/gyp build/gyp`
+   * `vcbuild.bat vs2017 shared debug x64` -- libcouchbase looks for a debug build
+   * `vcbuild.bat vs2017 shared release x64`
+1. `git clone https://github.com/couchbase/libcouchbase.git`
+   * `mkdir lcb-build`
+   * `cd lcb-build`
+   * `cmake -G "Visual Studio 15 Win64" ..\libcouchbase` (should include libuv + openssl)
+   * `cmake --build .`
+
+Seems to also support: https://github.com/google/snappy
+
+* `mkdir snappybuild && cd snappybuild && cmake -G "Visual Studio 15 Win64" ..\snappy`
+* I couldn't work out how to have libcouchbase include this in the build.
+
+I also had to modify `plugin-libuv.c` before this would compile on Windows
+
+* Installed the Visual Studio GUI using VS Installer
+* `#include "libcouchbase\plugins\io\bsdio-inl.c"`
+* The linker has some dependencies that need to be removed such as: `OPTIMIZED.lib` 
+
+A pre-compiled version of libcouchbase.dll is shipped with the GEM

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libcouchbase
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -146,6 +146,7 @@ files:
 - Rakefile
 - ext/README.md
 - ext/Rakefile
+- ext/libcouchbase.dll
 - ext/libcouchbase/.gitignore
 - ext/libcouchbase/CMakeLists.txt
 - ext/libcouchbase/CONTRIBUTING.md
@@ -170,7 +171,6 @@ files:
 - ext/libcouchbase/cmake/defs.mk.in
 - ext/libcouchbase/cmake/dtrace-instr-link.pl
 - ext/libcouchbase/cmake/source_files.cmake
-- ext/libcouchbase/configure.pl
 - ext/libcouchbase/contrib/cJSON/cJSON.c
 - ext/libcouchbase/contrib/cJSON/cJSON.h
 - ext/libcouchbase/contrib/cbsasl/CMakeLists.txt
@@ -659,6 +659,7 @@ files:
 - ext/libcouchbase/tools/docgen/seqgen.h
 - ext/libcouchbase/tools/linenoise/linenoise.c
 - ext/libcouchbase/tools/linenoise/linenoise.h
+- ext/libcouchbase_libuv.dll
 - lib/libcouchbase.rb
 - lib/libcouchbase/bucket.rb
 - lib/libcouchbase/callbacks.rb
@@ -723,7 +724,6 @@ files:
 - lib/libcouchbase/ext/libcouchbase/valbuf.rb
 - lib/libcouchbase/ext/libcouchbase/valbuf_u_buf.rb
 - lib/libcouchbase/ext/libcouchbase/viewhandle.rb
-- lib/libcouchbase/ext/libcouchbase_iocp.rb
 - lib/libcouchbase/ext/libcouchbase_libuv.rb
 - lib/libcouchbase/ext/tasks.rb
 - lib/libcouchbase/n1ql.rb
@@ -751,6 +751,7 @@ files:
 - spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/snapshot_markers.json
 - spec/subdoc_spec.rb
 - spec/view_spec.rb
+- windows_build.md
 homepage: https://github.com/cotag/libcouchbase
 licenses:
 - MIT

data/ext/libcouchbase/configure.pl

@@ -1 +0,0 @@
-ext/libcouchbase/cmake/configure

data/lib/libcouchbase/ext/libcouchbase_iocp.rb

@@ -1,26 +0,0 @@
-
-# This file contains the structures required to configure libcouchbase to use
-# windows IOCP for event IO
-
-module Libcouchbase::Ext
-
-    # ref: http://docs.couchbase.com/sdk-api/couchbase-c-client-2.6.2/group__lcb-io-plugin-api.html
-
-    IOType = enum [
-        :IO_libevent, 0x02,
-        :IO_winsock, 0x03,
-        :IO_libev, 0x04,
-        :IO_select, 0x05,
-        :IO_winIOCP, 0x06,
-        :IO_libuv, 0x07
-    ]
-
-    class IOOptions < FFI::Struct
-        layout :version, :int,      # Always 0
-               :type,    IOType,    # Always IO_winIOCP
-               :cookie,  :pointer
-    end
-
-    # pointer param returns IO opts structure
-    attach_function :create_io_ops, :lcb_create_io_ops, [:pointer, IOOptions.by_ref], ErrorT
-end