[RUBY-119] allow avoiding namespace conflicts

Author: Bulat Shakirzyanov

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 Features:
 
+* [RUBY-119] Use `require 'datastax/cassandra'` to avoid namespace conflicts
 * [RUBY-90] Add support for disabling nagle algorithm (tcp nodelay), enabled by default.
 * [RUBY-70] Add support for client-side timestamps, disabled by default.
 * [RUBY-114] Add support for serial consistency in batch requests.

features/README.md

@@ -389,6 +389,10 @@ DSE before 3.1 uses a non-standard protocol and is not currently supported.
 
 Port 9160 is the old Thrift interface, the binary protocol runs on 9042. This is also the default port for ruby-driver, so unless you've changed the port in `cassandra.yaml`, don't override the port.
 
+### I get namespace conflicts with another gem
+
+Use `require 'datastax/cassandra'` and `DataStax::Cassandra` to get a namespaced version of the gem and prevent conflicts with other gems that use top level `Cassandra` namespace.
+
 ### Something else is not working
 
 Open an issue and someone will try to help you out. Please include the gem version, Casandra version and Ruby version, and explain as much about what you're doing as you can, preferably the smallest piece of code that reliably triggers the problem. The more information you give, the better the chances you will get help.

lib/datastax/cassandra.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2015 DataStax, Inc.
+#
+# 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.
+#++
+
+module DataStax
+  @base = __FILE__ + '/../..'
+
+  def self.require(path)
+    if path.start_with?('cassandra/')
+      include(path)
+    else
+      ::Kernel.require(path)
+    end
+  end
+
+  def self.include(path)
+    path = File.expand_path(path + '.rb', @base)
+    class_eval(File.read(path), path, 1)
+  end
+
+  include 'cassandra'
+end