cassanity 0.2.2 → 0.3.0

data/Changelog.md

@@ -2,6 +2,11 @@
 
 Not all changes will be here, but the important ones will be for sure.
 
+## 0.3.0
+
+* Changed [update counter value API](https://github.com/jnunemaker/cassanity/commit/a0f5a76)
+* Added [support for range queries](https://github.com/jnunemaker/cassanity/commit/5d89ada)
+
 ## 0.2.2
 
 * Added [Keyspace#column_families](https://github.com/jnunemaker/cassanity/commit/8101835)

data/Guardfile

@@ -6,7 +6,14 @@ guard 'bundler' do
   watch(/^.+\.gemspec/)
 end
 
-guard 'rspec', :version => 2 do
+rspec_options = {
+  version: 2,
+  all_after_pass: false,
+  all_on_start: false,
+  keep_failed: false
+}
+
+guard 'rspec', rspec_options do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) { |m| [
     "spec/unit/#{m[1]}_spec.rb",

data/README.md

@@ -84,6 +84,14 @@ apps.truncate
 apps.drop
 ```
 
+You can also do a lot more. Here are a few more [examples](https://github.com/jnunemaker/cassanity/tree/master/examples):
+
+* [Batch Operations](https://github.com/jnunemaker/cassanity/tree/master/examples/batch.rb)
+* [Counters](https://github.com/jnunemaker/cassanity/tree/master/examples/counters.rb)
+* [Keyspaces](https://github.com/jnunemaker/cassanity/tree/master/examples/keyspaces.rb)
+* [Column Families](https://github.com/jnunemaker/cassanity/tree/master/examples/column_families.rb)
+* [Select a Range](https://github.com/jnunemaker/cassanity/tree/master/examples/select_range.rb)
+
 ## Compatibility
 
 * Ruby 1.9.3

data/examples/_shared.rb

@@ -2,6 +2,7 @@
 # Sets up load path for examples and requires some stuff
 require 'pp'
 require 'pathname'
+require 'logger'
 
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
 lib_path  = root_path.join('lib')

data/examples/batch.rb

@@ -1,7 +1,10 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160')
+client = CassandraCQL::Database.new('127.0.0.1:9160', {
+  cql_version: '3.0.0',
+})
+
 executor = Cassanity::Executors::CassandraCql.new(client: client)
 
 connection = Cassanity::Connection.new(executor: executor)

data/examples/column_families.rb

@@ -1,7 +1,9 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160')
+client = CassandraCQL::Database.new('127.0.0.1:9160', {
+  cql_version: '3.0.0',
+})
 executor = Cassanity::Executors::CassandraCql.new(client: client)
 
 connection = Cassanity::Connection.new(executor: executor)

data/examples/counters.rb

@@ -0,0 +1,90 @@
+require_relative '_shared'
+require 'cassanity'
+
+client = CassandraCQL::Database.new('127.0.0.1:9160', {
+  cql_version: '3.0.0',
+})
+
+executor = Cassanity::Executors::CassandraCql.new({
+  client: client,
+  logger: Logger.new(STDOUT),
+})
+
+connection = Cassanity::Connection.new(executor: executor)
+keyspace = connection['cassanity_examples']
+keyspace.recreate
+
+rollups_schema = Cassanity::Schema.new({
+  primary_key: :id,
+  columns: {
+    id: :text,
+    value: :counter,
+  },
+})
+
+# get an instance of a column family, providing schema means it can create itself
+rollups = keyspace.column_family({
+  name: :rollups,
+  schema: rollups_schema,
+})
+
+# create column family based on schema
+rollups.create
+
+# increment by 1
+rollups.update({
+  set:   {value: Cassanity::Increment.new},
+  where: {id: :views},
+})
+
+# increment by 3
+rollups.update({
+  set:   {value: Cassanity::Increment.new(3)},
+  where: {id: :views},
+})
+
+# increment by 3
+rollups.update({
+  set:   {value: Cassanity::Increment(3)},
+  where: {id: :views},
+})
+
+# increment by 3
+# you can also use .incr and .increment
+rollups.update({
+  set:   {value: Cassanity.inc(3)},
+  where: {id: :views},
+})
+
+# returns 10
+pp rollups.select(where: {id: :views})[0]['value']
+
+# decrement by 1
+rollups.update({
+  set:   {value: Cassanity::Decrement.new},
+  where: {id: :views},
+})
+
+# decrement by 2
+rollups.update({
+  set:   {value: Cassanity::Decrement.new(2)},
+  where: {id: :views},
+})
+
+# decrement by 2
+rollups.update({
+  set:   {value: Cassanity::Decrement(2)},
+  where: {id: :views},
+})
+
+# decrement by 2
+# you can also use .decr and .decrement
+rollups.update({
+  set:   {value: Cassanity.dec(2)},
+  where: {id: :views},
+})
+
+# returns 3
+pp rollups.select(where: {id: :views})[0]['value']
+
+keyspace.drop

data/examples/keyspaces.rb

@@ -1,7 +1,9 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160')
+client = CassandraCQL::Database.new('127.0.0.1:9160', {
+  cql_version: '3.0.0',
+})
 executor = Cassanity::Executors::CassandraCql.new(client: client)
 
 connection = Cassanity::Connection.new(executor: executor)

data/examples/select_range.rb

@@ -0,0 +1,118 @@
+require_relative '_shared'
+require 'cassanity'
+
+client = CassandraCQL::Database.new('127.0.0.1:9160', {
+  cql_version: '3.0.0',
+})
+
+executor = Cassanity::Executors::CassandraCql.new({
+  client: client,
+  logger: Logger.new(STDOUT),
+})
+
+connection = Cassanity::Connection.new(executor: executor)
+keyspace = connection['cassanity_examples']
+keyspace.recreate
+
+rollups_schema = Cassanity::Schema.new({
+  primary_key: [:id, :timestamp],
+  columns: {
+    id: :text,
+    timestamp: :int,
+    value: :counter,
+  },
+})
+
+# get an instance of a column family, providing schema means it can create itself
+rollups = keyspace.column_family({
+  name: :rollups,
+  schema: rollups_schema,
+})
+
+# create column family based on schema
+rollups.create
+
+[
+  [1, rand(1_000)],
+  [2, rand(1_000)],
+  [3, rand(1_000)],
+  [4, rand(1_000)],
+  [5, rand(1_000)],
+].each do |pair|
+  timestamp, value = pair
+  rollups.update({
+    set: {value: Cassanity::Increment.new(value)},
+    where: {
+      id: :views,
+      timestamp: timestamp,
+    }
+  })
+end
+
+# returns timestamps 1, 2 and 3
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Range.new(1, 3),
+  }
+})
+
+# also works with exclusion of end ranges
+# returns 1 and 2
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Range.new(1, 3, true),
+  }
+})
+
+# also works with operators
+# returns 3, 4 and 5
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Operator.new(:>, 2),
+  }
+})
+
+# returns 2, 3, 4 and 5
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Operator.new(:>=, 2),
+  }
+})
+
+puts "\n\n ALL BELOW SHOULD RETURN 1 \n\n"
+
+# returns 1
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Operator.new(:<, 2),
+  }
+})
+
+# returns 1
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Operators::Lt.new(2),
+  }
+})
+
+# returns 1
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Operators::Lt(2),
+  }
+})
+
+# returns 1
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity.lt(2),
+  }
+})

data/lib/cassanity/argument_generators/set_clause.rb

@@ -1,3 +1,6 @@
+require 'cassanity/increment'
+require 'cassanity/decrement'
+
 module Cassanity
   module ArgumentGenerators
     class SetClause
@@ -8,8 +11,10 @@ module Cassanity
         cql, variables, sets = '', [], []
 
         set.each do |key, value|
-          if counter?(key, value)
-            sets << "#{key} = #{value}"
+          case value
+          when Cassanity::Increment, Cassanity::Decrement
+            sets << "#{key} = #{key} #{value.symbol} ?"
+            variables << value.value
           else
             sets << "#{key} = ?"
             variables << value
@@ -17,14 +22,8 @@ module Cassanity
         end
         cql << " SET #{sets.join(', ')}"
 
-
         [cql, *variables]
       end
-
-      # Private
-      def counter?(key, value)
-        value.is_a?(String) && value.match(/#{key}(\s+)?[\+\-](\s+)?\d/)
-      end
     end
   end
 end

data/lib/cassanity/argument_generators/where_clause.rb

@@ -1,3 +1,10 @@
+require 'cassanity/operator'
+require 'cassanity/operators/eq'
+require 'cassanity/operators/gt'
+require 'cassanity/operators/gte'
+require 'cassanity/operators/lt'
+require 'cassanity/operators/lte'
+
 module Cassanity
   module ArgumentGenerators
     class WhereClause
@@ -11,9 +18,20 @@ module Cassanity
         variables, wheres = [], []
 
         where.each do |key, value|
-          if value.is_a?(Array)
+          case value
+          when Array
             wheres << "#{key} IN (?)"
             variables << value
+          when Range
+            start, finish = value.begin, value.end
+            end_operator = value.exclude_end? ? '<' : '<='
+            wheres << "#{key} >= ?"
+            wheres << "#{key} #{end_operator} ?"
+            variables << start
+            variables << finish
+          when Cassanity::Operator
+            wheres << "#{key} #{value.symbol} ?"
+            variables << value.value
           else
             wheres << "#{key} = ?"
             variables << value

data/lib/cassanity/decrement.rb

@@ -0,0 +1,27 @@
+module Cassanity
+  def self.Decrement(*args)
+    Decrement.new(*args)
+  end
+
+  class Decrement
+    # Internal
+    attr_reader :symbol
+
+    # Internal
+    attr_reader :value
+
+    # Public: Returns an decrement instance
+    def initialize(value = 1)
+      raise ArgumentError.new("value cannot be nil") if value.nil?
+
+      @symbol = :-
+      @value = value
+    end
+
+    def eql?(other)
+      self.class.eql?(other.class) && value == other.value
+    end
+
+    alias_method :==, :eql?
+  end
+end

data/lib/cassanity/executors/cassandra_cql.rb

@@ -78,7 +78,7 @@ module Cassanity
       #
       # Examples
       #
-      #   client = CassandraCQL::Database.new('host')
+      #   client = CassandraCQL::Database.new('host', cql_version: '3.0.0')
       #   Cassanity::Executors::CassandraCql.new(client: client)
       #
       def initialize(args = {})

data/lib/cassanity/increment.rb

@@ -0,0 +1,27 @@
+module Cassanity
+  def self.Increment(*args)
+    Increment.new(*args)
+  end
+
+  class Increment
+    # Internal
+    attr_reader :symbol
+
+    # Internal
+    attr_reader :value
+
+    # Public: Returns an increment instance
+    def initialize(value = 1)
+      raise ArgumentError.new("value cannot be nil") if value.nil?
+
+      @symbol = :+
+      @value = value
+    end
+
+    def eql?(other)
+      self.class.eql?(other.class) && value == other.value
+    end
+
+    alias_method :==, :eql?
+  end
+end

data/lib/cassanity/operator.rb

@@ -0,0 +1,27 @@
+module Cassanity
+  def self.Operator(*args)
+    Operator.new(*args)
+  end
+
+  class Operator
+    # Internal
+    attr_reader :symbol
+
+    # Internal
+    attr_reader :value
+
+    # Public: Returns an operator instance
+    def initialize(symbol, value)
+      @symbol = symbol
+      @value = value
+    end
+
+    def eql?(other)
+      self.class.eql?(other.class) &&
+        value == other.value &&
+        symbol == other.symbol
+    end
+
+    alias_method :==, :eql?
+  end
+end

data/lib/cassanity/operators/eq.rb

@@ -0,0 +1,15 @@
+require 'cassanity/operator'
+
+module Cassanity
+  module Operators
+    def self.Eq(*args)
+      Eq.new(*args)
+    end
+
+    class Eq < Operator
+      def initialize(value)
+        super :"=", value
+      end
+    end
+  end
+end

data/lib/cassanity/operators/gt.rb

@@ -0,0 +1,15 @@
+require 'cassanity/operator'
+
+module Cassanity
+  module Operators
+    def self.Gt(*args)
+      Gt.new(*args)
+    end
+
+    class Gt < Operator
+      def initialize(value)
+        super(:>, value)
+      end
+    end
+  end
+end

data/lib/cassanity/operators/gte.rb

@@ -0,0 +1,15 @@
+require 'cassanity/operator'
+
+module Cassanity
+  module Operators
+    def self.Gte(*args)
+      Gte.new(*args)
+    end
+
+    class Gte < Operator
+      def initialize(value)
+        super(:>=, value)
+      end
+    end
+  end
+end

data/lib/cassanity/operators/lt.rb

@@ -0,0 +1,15 @@
+require 'cassanity/operator'
+
+module Cassanity
+  module Operators
+    def self.Lt(*args)
+      Lt.new(*args)
+    end
+
+    class Lt < Operator
+      def initialize(value)
+        super(:<, value)
+      end
+    end
+  end
+end

data/lib/cassanity/operators/lte.rb

@@ -0,0 +1,15 @@
+require 'cassanity/operator'
+
+module Cassanity
+  module Operators
+    def self.Lte(*args)
+      Lte.new(*args)
+    end
+
+    class Lte < Operator
+      def initialize(value)
+        super(:<=, value)
+      end
+    end
+  end
+end

data/lib/cassanity/version.rb

@@ -1,3 +1,3 @@
 module Cassanity
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/cassanity.rb

@@ -1,4 +1,88 @@
+require 'cassanity/operators/eq'
+require 'cassanity/operators/gt'
+require 'cassanity/operators/gte'
+require 'cassanity/operators/lt'
+require 'cassanity/operators/lte'
+
 module Cassanity
+  # Public: Shortcut for returning an equality operator.
+  #
+  # args - The arguments to pass to the initialize method of the operator.
+  #
+  # Returns a Cassanity::Operators::Eq instance.
+  def self.eq(*args)
+    Operators::Eq.new(*args)
+  end
+
+  # Public: Shortcut for returning a less than operator.
+  #
+  # args - The arguments to pass to the initialize method of the operator.
+  #
+  # Returns a Cassanity::Operators::Lt instance.
+  def self.lt(*args)
+    Operators::Lt.new(*args)
+  end
+
+  # Public: Shortcut for returning a less than or equal to operator.
+  #
+  # args - The arguments to pass to the initialize method of the operator.
+  #
+  # Returns a Cassanity::Operators::Lte instance.
+  def self.lte(*args)
+    Operators::Lte.new(*args)
+  end
+
+  # Public: Shortcut for returning a greater than operator.
+  #
+  # args - The arguments to pass to the initialize method of the operator.
+  #
+  # Returns a Cassanity::Operators::Gt instance.
+  def self.gt(*args)
+    Operators::Gt.new(*args)
+  end
+
+  # Public: Shortcut for returning a greater than or equal to operator.
+  #
+  # args - The arguments to pass to the initialize method of the operator.
+  #
+  # Returns a Cassanity::Operators::Gte instance.
+  def self.gte(*args)
+    Operators::Gte.new(*args)
+  end
+
+  # Public: Shortcut for returning an increment value for a counter update.
+  #
+  # value - The value to initialize the increment with (optional, default: 1).
+  #
+  # Returns a Cassanity::Increment instance.
+  def self.inc(value = 1)
+    Increment.new(value)
+  end
+
+  # Public: Shortcut for returning a decrement value for a counter update.
+  #
+  # value - The value to initialize the decrement with (optional, default: 1).
+  #
+  # Returns a Cassanity::Decrement instance.
+  def self.dec(value = 1)
+    Decrement.new(value)
+  end
+
+  class << self
+    alias_method :equal, :eq
+
+    alias_method :greater_than, :gt
+    alias_method :greater_than_or_equal_to, :gte
+
+    alias_method :less_than, :lt
+    alias_method :less_than_or_equal_to, :lte
+
+    alias_method :incr, :inc
+    alias_method :increment, :inc
+
+    alias_method :decr, :dec
+    alias_method :decrement, :dec
+  end
 end
 
 require 'cassanity/connection'