cassie-queries 0.0.1.a1 → 0.0.1.a2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 616d830ce0e5af7de3bae56c7d8b0375e628bfbb
-  data.tar.gz: 0a2971a05512cc8038dff5a4ae2aad8c0ffdb7d6
+  metadata.gz: 292e17b52cc92a211e404495ca0835bd2a3bb368
+  data.tar.gz: edede8b8ef33b3625cba57ce64699ee11556ad86
 SHA512:
-  metadata.gz: 605d2082d4d825745d1f565fd1e4d5f8ac58798d688506ceaa8f184861eb52b33c5a55fe075ddfbf307da7f63b7f3edadd41a91f6a9e3d7478a6d78e7de17cdf
-  data.tar.gz: 0af76ba1a61bb514cce49bdc7b6968939f4f20ff939276549c8e6ef9db895de822a6e1581b39f52d08af63c8ad465e587f57163558d15f9c9ea4b816d42bf239
+  metadata.gz: 813f15ce1672f5f0a7cfb3adced562b0ee94a2f3a4e523a048e5b6973d22d38562068059a1cbc53fc0353c24fd20a1685b9246b19a9e9c03a24cd01327e98f28
+  data.tar.gz: b063aba0e91ef6bdb58bf68f732ec1bb5a490ffe37c63ac5b4c22f60e664c11fdf2a85ea787bc451fb3cf30d2d347e33a35f65929fa4b486932cf09821b8b3d7

data/lib/cassie/queries/instrumentation.rb

@@ -0,0 +1,23 @@
+module Cassie::Queries
+  module Instrumentation
+    extend ::ActiveSupport::Concern
+
+    def execute
+      instrument { super }
+    end
+
+    def instrument #:nodoc:
+      instrumenter.instrument("cql.execute") do |payload|
+        execution_val = yield # execution populates #result
+        payload[:execution_info] = result.try(:execution_info)
+        execution_val
+      end
+    end
+
+    protected
+
+    def instrumenter
+      ActiveSupport::Notifications
+    end
+  end
+end

data/lib/cassie/queries/log_subscription/cql_execution_event.rb

@@ -0,0 +1,40 @@
+module Cassie::Queries::LogSubscription
+  class CqlExecutionEvent < ActiveSupport::Notifications::Event
+
+    def duration # in milliseconds
+      return super unless traced?
+
+      # trace duration is in microseconds
+      trace.duration / 1000.0
+    end
+
+    def message
+      color "(#{duration.round(1)}ms) #{statement}"
+    end
+
+    protected
+
+    def execution_info
+      payload[:execution_info]
+    end
+
+    def statement
+      statement = execution_info.statement
+      str = statement.cql
+      str += " [#{statement.params}]" if statement.respond_to? :params
+      str
+    end
+
+    def traced?
+      execution_info && !!trace
+    end
+
+    def trace
+      execution_info.trace
+    end
+
+    def color(message)
+      "\e[1m\e[37m#{message}\e[0m\e[22m"
+    end
+  end
+end

data/lib/cassie/queries/log_subscription.rb

@@ -0,0 +1,31 @@
+require_relative 'log_subscription/cql_execution_event'
+
+module Cassie::Queries
+  module LogSubscription
+    extend ::ActiveSupport::Concern
+
+    included do
+      ActiveSupport::Notifications.subscribe('cql.execute') do |*args|
+        # args:
+        # name    # => String, name of the event (such as 'render' from above)
+        # start   # => Time, when the instrumented block started execution
+        # finish  # => Time, when the instrumented block ended execution
+        # id      # => String, unique ID for this notification
+        # payload # => Hash, the payload
+        unless args.last[:exception]
+          logger.debug(CqlExecutionEvent.new(*args).message)
+        end
+      end
+    end
+
+    module ClassMethods
+      def logger
+        @logger ||= begin
+          l = Logger.new(STDOUT)
+          l.formatter = ActiveSupport::Logger::SimpleFormatter.new
+          l
+        end
+      end
+    end
+  end
+end

data/lib/cassie/queries/prepared_statement.rb

@@ -0,0 +1,42 @@
+require 'active_support/core_ext/string/filters'
+
+module Cassie::Queries
+  module PreparedStatement
+    extend ::ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_accessor :prepare
+      end
+      self.prepare = true
+    end
+
+    module ClassMethods
+      def inherited(subclass)
+        subclass.prepare = prepare
+      end
+
+      def prepare?
+        !!prepare
+      end
+
+      def prepared_statement
+        # use class instance variable to esnure only 1
+        # statement is prepared per process
+        # no mutex required in MRI because of GIL
+        #
+        # note: cassandra-driver handles the case
+        #       of executing a prepared statement
+        #       on a host where it has not been prepared
+        #       yet, by re-preparing.
+        @prepared_statement ||= begin
+          session.prepare(statement)
+        end
+      end
+    end
+
+    def statement
+      self.class.prepare? ? self.class.prepared_statement : super
+    end
+  end
+end

data/lib/cassie/queries/session.rb

@@ -0,0 +1,22 @@
+module Cassie::Queries
+  module Session
+    extend ::ActiveSupport::Concern
+
+    module ClassMethods
+      def session
+        # until cassie-configuration exists,
+        # we're relying on the client to
+        # supply the session
+        if defined?(super)
+          super
+        else
+          raise "Oops! Cassie::Queries doesn't manage a Cassandra session for you, yet. You must provide a .session class method that returns a valid session."
+        end
+      end
+    end
+
+    def session
+      self.class.session
+    end
+  end
+end

data/lib/cassie/queries/statement.rb

@@ -19,26 +19,14 @@ module Cassie::Queries
 
       def statement
         self.const_get(:STATEMENT)
-      end
-
-      def prepared_statement
-        # use class instance variable to esnure only 1
-        # statement is prepared per process
-        # no mutex required in MRI because of GIL
-        #
-        # note: cassandra-driver handles the case
-        #       of executing a prepared statement
-        #       on a host where it has not been prepared
-        #       yet, by re-preparing.
-        @prepared_statement ||= begin
-          session.prepare(statement)
-        end
+      rescue NameError
       end
     end
 
+    # Executes the statment, populates result
+    # returns true or false indicating a successful execution or not
     def execute
-      @result = session.execute(prepared_statement, arguments: bindings)
-
+      @result = session.execute(statement, arguments: bindings)
       execution_successful?
     end
 
@@ -46,10 +34,6 @@ module Cassie::Queries
       self.class.statement
     end
 
-    def prepared_statement
-      self.class.prepared_statement
-    end
-
     protected
 
     def bindings

data/lib/cassie/query.rb

@@ -1,8 +1,16 @@
 module Cassie
   # think about ActiveSupport autoloading
+  require_relative 'queries/session'
   require_relative 'queries/statement'
+  require_relative 'queries/prepared_statement'
+  require_relative 'queries/instrumentation'
+  require_relative 'queries/log_subscription'
 
   class Query
-    include Cassie::Queries::Statement
+    include Queries::Session
+    include Queries::Statement
+    include Queries::PreparedStatement
+    include Queries::Instrumentation
+    include Queries::LogSubscription
   end
 end

data/lib/cassie-queries.rb

@@ -3,4 +3,4 @@ require 'active_support'
 # cassie directory instead of cassie_queries
 # to allow sharing of cassie module with other libraries
 # but maintain folder/file/module/class naming conventions
-require 'cassie/query'
+require_relative 'cassie/query'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cassie-queries
 version: !ruby/object:Gem::Version
-  version: 0.0.1.a1
+  version: 0.0.1.a2
 platform: ruby
 authors:
 - Evan Prothro
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: '`cassie-queries` is a lightweight interface adapter allowing easy use
   of the functionality provided by the `cassandra-driver`.'
 email: evan.prothro@gmail.com
@@ -59,6 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/cassie/queries/instrumentation.rb
+- lib/cassie/queries/log_subscription/cql_execution_event.rb
+- lib/cassie/queries/log_subscription.rb
+- lib/cassie/queries/prepared_statement.rb
+- lib/cassie/queries/session.rb
 - lib/cassie/queries/statement.rb
 - lib/cassie/query.rb
 - lib/cassie-queries.rb