cassanity 0.3.0 → 0.4.0

data/lib/cassanity/column_family.rb

@@ -27,7 +27,13 @@ module Cassanity
       @name = args.fetch(:name)
       @keyspace = args.fetch(:keyspace)
       @executor = args.fetch(:executor) { @keyspace.executor }
-      @schema = args[:schema]
+
+      schema = args[:schema]
+      @schema = if schema.is_a?(Hash)
+        Cassanity::Schema.new(schema)
+      else
+        schema
+      end
     end
 
     # Public: Returns true or false depending on if column family exists in
@@ -56,7 +62,7 @@ module Cassanity
     # Public: Creates the column family in the keyspace based on the schema.
     #
     # args - The Hash of arguments to pass to the executor. Always passes
-    #        :name and :keyspace_name.
+    #        :column_family_name and :keyspace_name.
     #        :schema - The Schema to use to create the column family
     #                  (defaults to schema provided during initialization).
     #
@@ -70,7 +76,7 @@ module Cassanity
     #   not passed in via arguments.
     def create(args = {})
       forced_arguments = {
-        name: @name,
+        column_family_name: @name,
         keyspace_name: @keyspace.name,
       }
       arguments = args.merge(forced_arguments)
@@ -85,7 +91,8 @@ module Cassanity
     # Public: Truncates the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Examples
     #
@@ -96,7 +103,7 @@ module Cassanity
       @executor.call({
         command: :column_family_truncate,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
@@ -105,7 +112,8 @@ module Cassanity
     # Public: Drops the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Examples
     #
@@ -116,7 +124,7 @@ module Cassanity
       @executor.call({
         command: :column_family_drop,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
@@ -125,7 +133,8 @@ module Cassanity
     # Public: Alters the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Examples
     #
@@ -139,7 +148,7 @@ module Cassanity
       @executor.call({
         command: :column_family_alter,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
@@ -187,14 +196,15 @@ module Cassanity
     # Public: Makes it possible to query data from the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Returns whatever is returned by executor.
     def select(args = {})
       @executor.call({
         command: :column_family_select,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         })
       })
@@ -203,14 +213,15 @@ module Cassanity
     # Public: Makes it possible to insert data into the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Returns whatever is returned by executor.
     def insert(args = {})
       @executor.call({
         command: :column_family_insert,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
@@ -219,14 +230,15 @@ module Cassanity
     # Public: Makes it possible to update data in the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Returns whatever is returned by executor.
     def update(args = {})
       @executor.call({
         command: :column_family_update,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
@@ -235,22 +247,63 @@ module Cassanity
     # Public: Makes it possible to delete data from the column family.
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name and :keyspace_name are always included.
+    #        (default: {}). :column_family_name and :keyspace_name are
+    #        always included.
     #
     # Returns whatever is returned by executor.
     def delete(args = {})
       @executor.call({
         command: :column_family_delete,
         arguments: args.merge({
-          name: @name,
+          column_family_name: @name,
           keyspace_name: @keyspace.name,
         }),
       })
     end
 
+    # Public: Group multiple statements into a batch.
+    #
+    # args - The Hash of arguments to pass to the argument generator
+    #        (default: {}).
+    #
+    # Examples
+    #
+    #   batch({
+    #     modifications: [
+    #       [:insert, column_family_name: 'apps', data: {id: '1', name: 'github'}],
+    #       [:insert, column_family_name: 'apps', data: {id: '2', name: 'gist'}],
+    #       [:update, column_family_name: 'apps', set: {name: 'github.com'}, where: {id: '1'}],
+    #       [:delete, column_family_name: 'apps', where: {id: '2'}],
+    #     ]
+    #   })
+    #
+    # Returns whatever is returned by executor.
+    def batch(args = {})
+      default_arguments = {
+        keyspace_name: @keyspace.name,
+        column_family_name: @name,
+      }
+
+      @executor.call({
+        command: :batch,
+        arguments: default_arguments.merge(args),
+      })
+    end
+
     # Internal
     def schema
       @schema || raise(Cassanity::Error.new(message: "No schema found to create #{@name} column family. Please set :schema during initialization or include it as a key in #create call."))
     end
+
+    # Public
+    def inspect
+      attributes = [
+        "name=#{@name.inspect}",
+        "keyspace=#{@keyspace.inspect}",
+        "executor=#{@executor.inspect}",
+        "schema=#{@schema.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
   end
 end

data/lib/cassanity/connection.rb

@@ -73,5 +73,13 @@ module Cassanity
     end
 
     alias_method :[], :keyspace
+
+    # Public
+    def inspect
+      attributes = [
+        "executor=#{@executor.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
   end
 end

data/lib/cassanity/decrement.rb

@@ -3,25 +3,12 @@ module Cassanity
     Decrement.new(*args)
   end
 
-  class Decrement
-    # Internal
-    attr_reader :symbol
-
-    # Internal
-    attr_reader :value
-
+  class Decrement < Operator
     # Public: Returns an decrement instance
     def initialize(value = 1)
       raise ArgumentError.new("value cannot be nil") if value.nil?
 
-      @symbol = :-
-      @value = value
+      super :-, 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

@@ -1,5 +1,7 @@
+require 'forwardable'
 require 'cassandra-cql'
 require 'cassanity/error'
+require 'cassanity/instrumenters/noop'
 require 'cassanity/argument_generators/keyspaces'
 require 'cassanity/argument_generators/keyspace_create'
 require 'cassanity/argument_generators/keyspace_drop'
@@ -22,6 +24,7 @@ require 'cassanity/result_transformers/mirror'
 module Cassanity
   module Executors
     class CassandraCql
+      extend Forwardable
 
       # Private: Hash of commands to related argument generators.
       ArgumentGenerators = {
@@ -53,6 +56,9 @@ module Cassanity
       # Private: Default result transformer for commands that do not have one.
       Mirror = Cassanity::ResultTransformers::Mirror.new
 
+      # Private: Forward #instrument to instrumenter.
+      def_delegator :@instrumenter, :instrument
+
       # Private
       attr_reader :client
 
@@ -62,11 +68,15 @@ module Cassanity
       # Private
       attr_reader :result_transformers
 
+      # Private: What should be used to instrument all the things.
+      attr_reader :instrumenter
+
       # Internal: Initializes a cassandra-cql based CQL executor.
       #
       # args - The Hash of arguments.
       #        :client - The CassandraCQL::Database connection instance.
-      #        :logger - What to use to log the cql and such being executed.
+      #        :instrumenter - What should be used to instrument all the things
+      #                        (default: Cassanity::Instrumenters::Noop).
       #        :argument_generators - A Hash where each key is a command name
       #                               and each value is the related argument
       #                               generator that responds to `call`
@@ -83,7 +93,7 @@ module Cassanity
       #
       def initialize(args = {})
         @client = args.fetch(:client)
-        @logger = args[:logger]
+        @instrumenter = args[:instrumenter] || Instrumenters::Noop
         @argument_generators = args.fetch(:argument_generators) { ArgumentGenerators }
         @result_transformers = args.fetch(:result_transformers) { ResultTransformers }
       end
@@ -108,23 +118,39 @@ module Cassanity
       # Returns the result of execution.
       # Raises Cassanity::Error if anything goes wrong during execution.
       def call(args = {})
-        command = args.fetch(:command)
-        generator = @argument_generators.fetch(command)
-        execute_arguments = generator.call(args[:arguments])
+        instrument('cql.cassanity', {}) do |payload|
+          command = args.fetch(:command)
+          generator = @argument_generators.fetch(command)
+          arguments = args[:arguments]
+          execute_arguments = generator.call(arguments)
 
-        if @logger
-          @logger.debug { "#{self.class} executing #{execute_arguments.inspect}" }
-        end
+          result = @client.execute(*execute_arguments)
+
+          transformer = @result_transformers.fetch(command) { Mirror }
+          transformed_result = transformer.call(result)
 
-        result = @client.execute(*execute_arguments)
+          payload[:command] = command
+          payload[:generator] = generator
+          payload[:arguments] = arguments
+          payload[:execute_arguments] = execute_arguments
+          payload[:result] = result
+          payload[:transformer] = transformer
 
-        transformer = @result_transformers.fetch(command) { Mirror }
-        transformer.call(result)
+          transformed_result
+        end
       rescue KeyError
         raise Cassanity::UnknownCommand
       rescue Exception => e
         raise Cassanity::Error
       end
+
+      # Public
+      def inspect
+        attributes = [
+          "client=#{@client.inspect}",
+        ]
+        "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+      end
     end
   end
 end

data/lib/cassanity/increment.rb

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

data/lib/cassanity/instrumentation/log_subscriber.rb

@@ -0,0 +1,27 @@
+require 'securerandom'
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+
+module Cassanity
+  module Instrumentation
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      def cql(event)
+        return unless logger.debug?
+
+        name = '%s (%.1fms)' % ["CQL Query", event.duration]
+
+        # execute arguments are always an array where the first element is the
+        # cql string and the rest are the bound variables.
+        cql, *args = event.payload[:execute_arguments]
+        arguments = args.map { |arg| arg.inspect }.join(', ')
+
+        query = "#{cql}"
+        query += " (#{arguments})" unless arguments.empty?
+
+        debug "  #{color(name, CYAN, true)}  [ #{query} ]"
+      end
+    end
+  end
+end
+
+Cassanity::Instrumentation::LogSubscriber.attach_to :cassanity

data/lib/cassanity/instrumenters/memory.rb

@@ -0,0 +1,27 @@
+module Cassanity
+  module Instrumenters
+    # Instrumentor that is useful for tests as it stores each of the events that
+    # are instrumented.
+    class Memory
+      Event = Struct.new(:name, :payload, :result)
+
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def instrument(name, payload = {})
+        result = if block_given?
+          yield payload
+        else
+          nil
+        end
+
+        @events << Event.new(name, payload, result)
+
+        result
+      end
+    end
+  end
+end

data/lib/cassanity/instrumenters/noop.rb

@@ -0,0 +1,9 @@
+module Cassanity
+  module Instrumenters
+    class Noop
+      def self.instrument(name, payload = {})
+        yield payload if block_given?
+      end
+    end
+  end
+end

data/lib/cassanity/keyspace.rb

@@ -45,7 +45,7 @@ module Cassanity
     # Public: Creates the keyspace
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name is always included.
+    #        (default: {}). :keyspace_name is always included.
     #
     # Examples
     #
@@ -65,7 +65,7 @@ module Cassanity
       @executor.call({
         command: :keyspace_create,
         arguments: args.merge({
-          name: @name,
+          keyspace_name: @name,
         })
       })
     end
@@ -81,7 +81,7 @@ module Cassanity
     # Public: Uses a keyspace
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name is always included.
+    #        (default: {}). :keyspace_name is always included.
     #
     # Examples
     #
@@ -92,7 +92,7 @@ module Cassanity
       @executor.call({
         command: :keyspace_use,
         arguments: args.merge({
-          name: @name,
+          keyspace_name: @name,
         }),
       })
     end
@@ -100,7 +100,7 @@ module Cassanity
     # Public: Drops a keyspace
     #
     # args - The Hash of arguments to pass to the argument generator
-    #        (default: {}). :name is always included.
+    #        (default: {}). :keyspace_name is always included.
     #
     # Examples
     #
@@ -111,7 +111,7 @@ module Cassanity
       @executor.call({
         command: :keyspace_drop,
         arguments: args.merge({
-          name: @name,
+          keyspace_name: @name,
         }),
       })
     end
@@ -152,5 +152,41 @@ module Cassanity
     end
     alias_method :table, :column_family
     alias_method :[], :column_family
+
+    # Public: Group multiple statements into a batch.
+    #
+    # args - The Hash of arguments to pass to the argument generator
+    #        (default: {}).
+    #
+    # Examples
+    #
+    #   batch({
+    #     modifications: [
+    #       [:insert, name: 'apps', data: {id: '1', name: 'github'}],
+    #       [:insert, name: 'apps', data: {id: '2', name: 'gist'}],
+    #       [:update, name: 'apps', set: {name: 'github.com'}, where: {id: '1'}],
+    #       [:delete, name: 'apps', where: {id: '2'}],
+    #     ]
+    #   })
+    #
+    # Returns whatever is returned by executor.
+    def batch(args = {})
+      default_arguments = {
+        keyspace_name: @name,
+      }
+
+      @executor.call({
+        command: :batch,
+        arguments: default_arguments.merge(args),
+      })
+    end
+
+    # Public
+    def inspect
+      attributes = [
+        "name=#{@name.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
   end
 end

data/lib/cassanity/operator.rb

@@ -23,5 +23,14 @@ module Cassanity
     end
 
     alias_method :==, :eql?
+
+    # Public
+    def inspect
+      attributes = [
+        "symbol=#{symbol.inspect}",
+        "value=#{value.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
   end
 end

data/lib/cassanity/range.rb

@@ -0,0 +1,4 @@
+module Cassanity
+  # For now, cassanity's range can just be a core range.
+  Range = ::Range
+end

data/lib/cassanity/schema.rb

@@ -20,6 +20,7 @@ module Cassanity
     #        :columns - The Hash of columns where the name is the column name
     #                   and the value is the column type.
     #        :with - The Hash of options for the WITH clause.
+    #
     # Raises KeyError if missing required argument key.
     # Raises ArgumentError if primary key is not included in the columns.
     def initialize(args = {})
@@ -59,5 +60,25 @@ module Cassanity
       shared_columns = column_names & @primary_keys
       shared_columns == @primary_keys
     end
+
+    # Public
+    def inspect
+      attributes = [
+        "primary_keys=#{primary_keys.inspect}",
+        "columns=#{columns.inspect}",
+        "with=#{with.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
+
+    # Public: Is this schema equal to another object.
+    def eql?(other)
+      self.class.eql?(other.class) &&
+        @primary_keys == other.primary_keys &&
+        @columns == other.columns &&
+        @with == other.with
+    end
+
+    alias_method :==, :eql?
   end
 end

data/lib/cassanity/version.rb

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

data/lib/cassanity.rb

@@ -3,6 +3,9 @@ require 'cassanity/operators/gt'
 require 'cassanity/operators/gte'
 require 'cassanity/operators/lt'
 require 'cassanity/operators/lte'
+require 'cassanity/increment'
+require 'cassanity/decrement'
+require 'cassanity/range'
 
 module Cassanity
   # Public: Shortcut for returning an equality operator.
@@ -68,6 +71,18 @@ module Cassanity
     Decrement.new(value)
   end
 
+  # Public: Shortcut for returning a range value.
+  #
+  # start - The start value for the range.
+  # finish - The finish value for the range.
+  # exclusive - The Boolean value for whether or not to include the finish of
+  #             the range.
+  #
+  # Returns a Cassanity::Range instance.
+  def self.range(start, finish, exclusive = false)
+    Cassanity::Range.new(start, finish, exclusive)
+  end
+
   class << self
     alias_method :equal, :eq
 
@@ -85,5 +100,4 @@ module Cassanity
   end
 end
 
-require 'cassanity/connection'
-require 'cassanity/executors/cassandra_cql'
+require 'cassanity/client'