cassandro 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b622b89e04dbec6f3f700f5c85fc395c010b2930
-  data.tar.gz: c31e4c65fe75099e6cdf24ecbd571ce5d2435017
+  metadata.gz: 454e96452f040bc0fe75880ec95ab55da541ea75
+  data.tar.gz: c9d3980327a022d70e8524f53469c07810ea618b
 SHA512:
-  metadata.gz: 0ee2cbec11f800c0557ebf54f095b7e9c0e03fc6593401e7023c55aa58d47682ed12e0a07a7e9216db940c334706013d3fe28da35bae8f137404cf4f33364b0b
-  data.tar.gz: ee5966c8d96983de83c814ce06d2dd34b295a201afa814da887ee0f5584f10f47a67c64bf90796f6d0918ebb2ed4971e93c657fa0b34ee31bf4f750b88f96b09
+  metadata.gz: 2390fd1f15ba3d96885395bf5e207015c7779b2150872cd2060a93dfb450fe61e99f3318d8ad7c2cd2497b945a96d58b4b997354e1f32977dac073b88e9a53dc
+  data.tar.gz: 95e8324ad844c4f6fe2d298290cf8319f02fc9b49229b5e3ccbfc1b9e8d7b361f623c466ad7948395c49619926c0efd65ecc07b7dc15c01881d0937cabd99a50

data/cassandro.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cassandro"
-  s.version = "2.0.1"
+  s.version = "2.1.0"
   s.summary = "Ruby ORM for Apache Cassandra"
   s.license = "MIT"
   s.description = "Lightweight Apache Cassandra ORM for Ruby"

data/docs/advanced_features.md

@@ -51,9 +51,36 @@ end
 
 This will add an attribute `:delete` to your model. Next time you use `Model#destroy` your data will not be deleted from database but marked as deleted. You can then use `Model#restore` to unmark it.
 
-Data marked as deleted is not included within `Model#all` method by default. In order to include deleted records you have to send a boolean parameter to `all`.
+Data marked as deleted is not included within find methods by default. In order to include deleted records you have to send a boolean parameter:
+
+### All
 
 ```ruby
 Person.all # => list all but deleted
 Person.all(true) # => list all, deleted included
 ```
+
+### Where
+
+```ruby
+Person.where(:gender, "male") # => list "male" but deleted
+Person.where(:gender, "male", true) # => list "male", deleted included
+```
+
+### Count
+
+```ruby
+Person.count # => count all but deleted
+Person.count(true) # => count all deleted included
+
+# with filter
+Person.count(:gender, "female") # => count all "female" but deleted
+Person.count(:gender, "female", true) # => count all "female" deleted included
+```
+
+### Query
+
+```ruby
+Person.query("gender = ? AND admin = ?", "male", true) # => list "male" "admins" but deleted
+Person.query("gender = ? AND admin = ?", "male", true, true) # => list "male" "admins", deleted included
+```

data/docs/getting_started.md

@@ -14,6 +14,10 @@ Cassandro.connect(hosts: ['192.168.2.100', '192.168.2.101'], keyspace: 'some_key
 
 _For full list of options visit [Ruby Driver Documentation](http://datastax.github.io/ruby-driver/api/#cluster-class_method)_
 
+## Missing Connection
+
+If the connection is not established, the `Cassandra::Errors::ClientError` will be raised when trying to interact with Cassandro.
+
 ## Keyspace
 
 ### Create Keyspace
@@ -44,6 +48,13 @@ Cassandro.use('keyspace_name')
 ```ruby
 result = Cassandro.execute("SELECT * FROM table_name;")
 ```
+
+### Execute prepared statements
+```ruby
+st = Cassandro.prepare("SELECT * FROM table_name WHERE column1 = ?")
+result = Cassandro.execute(st, arguments: ['value1'])
+```
+
 ### Create table
 ```ruby
 table = <<-TABLEDEF                                                              

data/lib/cassandro/core.rb

@@ -24,7 +24,7 @@ module Cassandro
   end
 
   def self.use(keyspace)
-    @@session.execute("USE #{keyspace}") if @@session
+    execute("USE #{keyspace}")
   end
 
   def self.disconnect
@@ -32,8 +32,22 @@ module Cassandro
     @@session = nil
   end
 
-  def self.execute(cql_command)
-    @@session.execute(cql_command)
+  def self.connected?
+    !@@session.nil?
+  end
+
+  def self.check_connection!
+    raise Cassandra::Errors::ClientError.new("Database connection is not established") unless connected?
+  end
+
+  def self.execute(statement, options = nil)
+    check_connection!
+    @@session.execute(statement, options)
+  end
+
+  def self.prepare(statement, options = nil)
+    check_connection!
+    @@session.prepare(statement, options)
   end
 
   def self.create_keyspace(name, options = { replication: { class: 'SimpleStrategy', replication_factor: 1}} )
@@ -51,11 +65,11 @@ module Cassandro
       #{with}
     KSDEF
 
-    @@session.execute(keyspace_definition)
+    execute(keyspace_definition)
   end
 
   def self.truncate_table(table_name)
-    @@session.execute("TRUNCATE #{table_name}")
+    execute("TRUNCATE #{table_name}")
   end
 
   def self.register_table(table_def)
@@ -63,10 +77,11 @@ module Cassandro
   end
 
   def self.load_tables
+    check_connection!
     @@tables.each do |table_definition|
       queries = table_definition.split(";").map(&:strip)
       queries.each do |query|
-        @@session.execute(query) unless query.empty?
+        execute(query) unless query.empty?
       end
     end
   end

data/lib/cassandro/ext/migration.rb

@@ -7,7 +7,7 @@ module Cassandro
     def down; end
 
     def execute(query)
-      Cassandro.client.execute(query)
+      Cassandro.execute(query)
     end
 
     def self.version(version_number)

data/lib/cassandro/ext/migrator.rb

@@ -8,7 +8,7 @@ module Cassandro
       @migrations = Cassandro::Migration.migrations
       @logger = logger
 
-      Cassandro.client.execute CassandroMigration.schema
+      Cassandro.execute CassandroMigration.schema
 
       version = CassandroMigration[name: 'version'] || CassandroMigration.create(name: 'version', value: "0")
 

data/lib/cassandro/ext/soft_delete.rb

@@ -8,6 +8,36 @@ module Cassandro
 
         results
       end
+
+      def where(key, value, with_deleted = false)
+        results = super(key, value)
+
+        results.reject!{ |r| r.deleted } unless with_deleted
+
+        results
+      end
+
+      def count(key = nil, value = nil, with_deleted = false)
+        return super(key, value) if with_deleted || key === true
+
+        if key && !value.nil?
+          results = where(key, value)
+        else
+          results = all
+        end
+
+        results.size
+      end
+
+      def query(where, *values)
+        with_deleted = where.scan(/\?/).length < values.length && values.pop === true
+
+        results = super(where, *values)
+
+        results.reject!{ |r| r.deleted } unless with_deleted
+
+        results
+      end
     end
 
     def self.included(model)

data/lib/cassandro/model.rb

@@ -69,11 +69,12 @@ module Cassandro
       query += "WHERE #{p_keys.join(" AND ")}"
 
       begin
-        st = Cassandro.client.prepare(query)
-        Cassandro.client.execute(st, arguments: native_attributes(attrs))
+        st = Cassandro.prepare(query)
+        Cassandro.execute(st, arguments: native_attributes(attrs))
         @attributes.merge!(attrs)
         true
-      rescue Exception => e
+      rescue => e
+        raise unless Cassandro.connected?
         @errors[:update_error] = e.message
         false
       end
@@ -101,10 +102,11 @@ module Cassandro
       st = self.statement_for(:insert, :insert_check => insert_check)
 
       begin
-        r = Cassandro.client.execute(st, arguments: self.native_attributes)
+        r = Cassandro.execute(st, arguments: self.native_attributes)
         raise ModelException.new('not_applied') unless !insert_check || (insert_check && r.first["[applied]"])
         @persisted = true
       rescue => e
+        raise unless Cassandro.connected?
         @attributes[:id] = nil if !persisted? && @attributes.has_key?(:id)
         @errors[:save] = e.message
         false
@@ -187,8 +189,8 @@ module Cassandro
         WHERE #{where}
       QUERY
 
-      st = Cassandro.client.prepare(query)
-      result = Cassandro.client.execute(st, arguments: values)
+      st = Cassandro.prepare(query)
+      result = Cassandro.execute(st, arguments: values)
 
       return nil unless result.any?
 
@@ -229,8 +231,8 @@ module Cassandro
 
       query = "SELECT * FROM #{table_name} WHERE #{key} = ? ALLOW FILTERING"
 
-      st = Cassandro.client.prepare(query)
-      rows = Cassandro.client.execute(st, arguments: [value])
+      st = Cassandro.prepare(query)
+      rows = Cassandro.execute(st, arguments: [value])
 
       rows.each do |result|
         results << new(result, true)
@@ -245,10 +247,10 @@ module Cassandro
       if key && !value.nil?
         key = key.to_sym
         query << " WHERE #{key} = ? ALLOW FILTERING"
-        st = Cassandro.client.prepare(query)
-        results = Cassandro.client.execute(st, arguments: [value])
+        st = Cassandro.prepare(query)
+        results = Cassandro.execute(st, arguments: [value])
       else
-        results = Cassandro.client.execute(query)
+        results = Cassandro.execute(query)
       end
 
       results.first["count"]
@@ -259,7 +261,8 @@ module Cassandro
         query = "TRUNCATE #{table_name}"
         st = Cassandro.execute(query)
         st.is_a? Cassandra::Client::VoidResult
-      rescue e
+      rescue => e
+        raise unless Cassandro.connected?
         false
       end
     end
@@ -268,8 +271,8 @@ module Cassandro
       results = []
 
       query = "SELECT * FROM #{table_name} WHERE #{where} ALLOW FILTERING"
-      st = Cassandro.client.prepare(query)
-      rows = Cassandro.client.execute(st, arguments: values)
+      st = Cassandro.prepare(query)
+      rows = Cassandro.execute(st, arguments: values)
 
 
       rows.each do |result|
@@ -351,7 +354,7 @@ module Cassandro
         QUERY
         if @insert_statement.nil? ||
                       @insert_statement.params_metadata.count != @attributes.count
-          @insert_statement = Cassandro.client.prepare(query)
+          @insert_statement = Cassandro.prepare(query)
         else
           @insert_statement
         end

data/test/cassandro_check_connection_test.rb

@@ -0,0 +1,123 @@
+require_relative 'helper'
+
+Protest.describe "Cassandro Connection check" do
+  setup do
+    class Admin < Cassandro::Model
+      table :admins
+      attribute :nickname, :text
+      attribute :age, :integer
+
+      primary_key :nickname
+    end
+
+    Cassandro.disconnect
+  end
+
+  context "Core" do
+    test "raise Exception on #execute" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Cassandro.execute("USE test_keyspace")
+      end
+    end
+
+    test "raise Exception on #use" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Cassandro.use("test_keyspace")
+      end
+    end
+
+    test "raise Exception on #create_keyspace" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Cassandro.create_keyspace("test_keyspace")
+      end
+    end
+
+    test "raise Exception on #truncate_table" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Cassandro.truncate_table("tests")
+      end
+    end
+  end
+
+  context "Model" do
+    test "raise Exception on #create" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.create(nickname: "tarolandia")
+      end
+    end
+
+    test "raise Exception on #save" do
+      admin = Admin.new(nickname: "tarolandia")
+
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        admin.save
+      end
+    end
+
+    test "raise Exception on #update_attributes" do
+      admin = Admin.new(nickname: "tarolandia")
+
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        admin.update_attributes(age: 29)
+      end
+    end
+
+    test "raise Exception on #[]" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin[nickname: "tarolandia"]
+      end
+    end
+
+    test "raise Exception on #all" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.all
+      end
+    end
+
+    test "raise Exception on #where" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.where(:nickname, "tarolandia")
+      end
+    end
+
+    test "raise Exception on #count" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.count
+      end
+    end
+
+    test "raise Exception on #query" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.query("nickname = ?", "tarolandia")
+      end
+    end
+
+    test "raise Exception on #ttl" do
+      admin = Admin.new(nickname: "tarolandia")
+
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        admin.ttl
+      end
+    end
+
+    test "raise Exception on #create_with_ttl" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.create_with_ttl(20, nickname: "tarolandia", age: 29)
+      end
+    end
+
+    test "raise Exception on #destroy" do
+      admin = Admin.new(nickname: "tarolandia")
+
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        admin.destroy
+      end
+    end
+
+    test "raise Exception on #destroy_all" do
+      assert_raise(Cassandra::Errors::ClientError, "Database connection is not established") do
+        Admin.destroy_all
+      end
+    end
+  end
+end

data/test/cassandro_migrator_test.rb

@@ -1,12 +1,12 @@
 require_relative 'helper'
 
 Protest.describe "Cassandro Migrator" do
-  Cassandro.connect(hosts: ['127.0.0.1'], keyspace: 'cassandro_test')
   setup do
-    #Cassandro::Migration.cleaassandra::Errors::InvalidError
-    Cassandro.client.execute("DROP TABLE IF EXISTS users")
-    Cassandro.client.execute("DROP TABLE IF EXISTS animals")
-    Cassandro.client.execute("DROP TABLE IF EXISTS cassandro_migrations")
+    Cassandro.connect(hosts: ['127.0.0.1'], keyspace: 'cassandro_test')
+
+    Cassandro.execute("DROP TABLE IF EXISTS users")
+    Cassandro.execute("DROP TABLE IF EXISTS animals")
+    Cassandro.execute("DROP TABLE IF EXISTS cassandro_migrations")
     @migrator = Cassandro::Migrator.new("./test/support/migrations", Logger.new('/dev/null'))
   end
 

data/test/cassandro_soft_delete_test.rb

@@ -21,7 +21,6 @@ Protest.describe "Cassandro Model Soft Delete" do
   end
 
   test "all not include deleted" do
-
     me = Admin.create(:nickname => "k4nd4lf")
     other = Admin.create(:nickname => "Jim")
 
@@ -39,6 +38,78 @@ Protest.describe "Cassandro Model Soft Delete" do
     assert !Admin.all.include?(me)
 
   end
+
+  test "#where not includes deleted" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 0, Admin.where(:nickname, "tarolandia").size
+  end
+
+  test "#where should include deleted if asked" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 1, Admin.where(:nickname, "tarolandia", true).size
+  end
+
+  test "#count not includes deleted" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 1, Admin.count
+  end
+
+  test "#count should include deleted if asked" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 2, Admin.count(true)
+  end
+
+  test "#count should filter by key and exclude deleted" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 0, Admin.count(:nickname, "tarolandia")
+  end
+
+  test "#count should filter by key including deleted" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 1, Admin.count(:nickname, "tarolandia", true)
+  end
+
+  test "#query not includes deleted" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 0, Admin.query("nickname = ?", "tarolandia").size
+  end
+
+  test "#query should include deleted if asked" do
+    me = Admin.create(:nickname => "tarolandia")
+    other = Admin.create(:nickname => "Jim")
+
+    me.destroy
+
+    assert_equal 1, Admin.query("nickname = ?", "tarolandia", true).size
+  end
 end
 
 

data/test/cassandro_test.rb

@@ -3,6 +3,7 @@ require_relative 'helper'
 Protest.describe "Cassandro Module" do
   setup do
     SESSION.execute("DROP KEYSPACE IF EXISTS test_keyspace")
+    Cassandro.disconnect
   end
 
   test "connects to database" do
@@ -16,4 +17,3 @@ Protest.describe "Cassandro Module" do
     assert_equal Cassandra::Results::Void, Cassandro.use("test_keyspace").class
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cassandro
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Lautaro Orazi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -99,6 +99,7 @@ files:
 - lib/cassandro/model.rb
 - lib/cassandro/support/hash.rb
 - rakefile
+- test/cassandro_check_connection_test.rb
 - test/cassandro_migration_test.rb
 - test/cassandro_migrator_test.rb
 - test/cassandro_model_test.rb