cassie 1.0.0.beta.12 → 1.0.0.beta.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cc848c2d95df8ae4b40ca89c5e0caf669702a03
-  data.tar.gz: 24e4e0ae4ac0126188989b7bb1df546a2b30a4e2
+  metadata.gz: 0e721aa1ae662ceda68b8697144f11d97f34dba6
+  data.tar.gz: 3d20bae28f27b55de84ad4e09fae5d1784f56c56
 SHA512:
-  metadata.gz: 7bda8956589af26de1c044ad5a58e91f59f9720f13a62418da490eeb597b6c14effd688cc7a49a24e189a7b7d81ae7503b12dc421bcefa15c0597ab144d4f017
-  data.tar.gz: 429db02e54722fc845026787ee565fef40fb9a808b44b7cee89a3540225f0e8de91d8df6ce65f7652292c5d91b239d578ecc8a75cc8808e0c4a1db8f355a0bb4
+  metadata.gz: 943b14b4e9cf8ce70aef2a68b5867491ea9f1beb8bd8c2b15927c292f68b74e7b77d34c5577bbb29ab88f3b83a876e4a03598a7d473d94083c852b480068fa0b
+  data.tar.gz: 228d3abb2b48ca6c4e846ae3d130293c2134d51a5292552df7b541639361bec3d874d4c6a3b82b7738e15af4953eceb072285be883b646cf4a1af38b11007c54

data/bin/cassie

@@ -1,11 +1,10 @@
 #! ruby
-require_relative '../lib/cassie/configuration/generator'
-
 def color(message)
   "\e[1;31m#{message}\e[0m"
 end
 
 def generate_config
+  require_relative '../lib/cassie'
   opts = {}
   if ARGV[1]
     opts[:destination_path] = if ARGV[1][0] == "/"
@@ -18,12 +17,49 @@ def generate_config
   end
   opts[:app_name]         = ARGV[2] if ARGV[2]
 
-  Cassie::Configuration::Generator.new(opts).save
+  generator = Cassie::Configuration::Generator.new(opts)
+  generator.save
+  puts "[✓] Cassandra configuration written to #{generator.destination_path}"
+end
+
+def dump_structure
+  require_relative '../lib/cassie'
+  opts = {}
+  opts[:destination_path] = Cassie.paths[:schema_structure]
+
+  args = ["-e", "'DESCRIBE SCHEMA'"]
+
+  runner = Cassie::Support::CommandRunner.new("cqlsh", args)
+  runner.run!
+
+  dir = File.dirname(opts[:destination_path])
+  Dir.mkdir(dir) unless File.directory?(dir)
+  File.open(opts[:destination_path], "w+") do |f|
+    f.write(runner.output)
+  end
+  puts "[✓] Cassandra schema written to #{opts[:destination_path]}"
+end
+
+def load_structure
+  require_relative '../lib/cassie'
+  opts = {}
+  opts[:source_path] = Cassie.paths[:schema_structure]
+
+  args = ["-f", opts[:source_path]]
+
+  runner = Cassie::Support::CommandRunner.new("cqlsh", args)
+  runner.run!
+
+  puts "[✓] Cassandra schema loaded from #{opts[:source_path]}"
 end
 
 case ARGV[0]
 when "configuration:generate"
   generate_config
+when "structure:dump"
+  dump_structure
+when "structure:load"
+  load_structure
 else
-  puts color("`#{ARGV[0]}` is not a supported command. Did you mean `cassie configuration:generate`?")
+  puts color("`#{ARGV[0]}` is not a supported command.")
 end

data/lib/cassie.rb

@@ -12,6 +12,7 @@ require 'active_support'
 require 'cassandra'
 
 module Cassie
+  require_relative 'cassie/support'
   require_relative 'cassie/logger'
   require_relative 'cassie/configuration'
   require_relative 'cassie/connection_handler'

data/lib/cassie/configuration/core.rb

@@ -10,6 +10,7 @@ module Cassie::Configuration
 
     def self.extended(extender)
       extender.paths["cluster_configurations"] = "config/cassandra.yml"
+      extender.paths["schema_structure"] = "db/structure.cql"
     end
 
     def env

data/lib/cassie/queries/README.md

@@ -421,19 +421,38 @@ end
 
 #### Logging
 
-Set the log level to debug to log execution details.
+Cassie Query objects use the Cassie logger unless overridden. This logs to STDOUT by default. Set any log stream you wish.
 
 ```ruby
-Cassie::Queries::Logging.logger.level = Logger::DEBUG
+  Cassie.logger = my_app.config.logger
 ```
 
+Set the log level to `debug` in order to log execution details.
+
+```ruby
+Cassie::Query.logger.level = Logger::DEBUG
+```
+
+#### Execution Time
+
+Cassie Queries instrument execution time as `cassie.cql.execution` and logs a debug message.
+
 ```ruby
 SelectUserByUsernameQuery.new('some_user').execute
-(2.9ms) SELECT * FROM users_by_username WHERE username = ? LIMIT 1; [["some_user"]]
+(5.5ms) SELECT * FROM users_by_username WHERE username = ? LIMIT 1; ["some_user"] [LOCAL_ONE]
 ```
+This measures the time to build the CQL query (statement and bindings), transmit the query to the cassandra coordinator, receive the result from the cassandra coordinator, and have the cassandra ruby driver build the ruby representation of the results. It does not include the time it takes for the Cassie Query to build its resource objects.
+
+#### Resource Loading
 
-Logs to STDOUT by default. Set any log stream you wish.
+Cassie Queries instrument resource building as `cassie.building_resources` and logs a debug message.
 
 ```ruby
-  Cassie::Queries::Logging.logger = my_app.config.logger
+SelectUserByUsernameQuery.new('some_user').fetch
+(5.5ms) SELECT * FROM users_by_username WHERE username = ? LIMIT 1; ["some_user"] [LOCAL_ONE]
+(0.2ms) 1 resource object built from Cassandra query result
 ```
+
+This measures the time it takes Cassie to build the resource objects (e.g. your domain objects) and is in addition to the execution time.
+
+> fetch time = `cassie.cql.execution` time + `cassie.building_resources` time

data/lib/cassie/support.rb

@@ -0,0 +1,5 @@
+module Cassie
+  module Support
+    require_relative 'support/command_runner'
+  end
+end

data/lib/cassie/support/command_runner.rb

@@ -0,0 +1,73 @@
+module Cassie::Support
+  class CommandRunner
+    attr_reader :binary, :args, :command, :process, :duration, :output
+
+    # When a block is given, the command runs before yielding
+    def initialize(binary, args=[])
+      @binary = binary
+      @args = args
+      @command = (Array(binary) + args).join(" ")
+      @command = command + " 2>&1" unless command =~ / > /
+
+      if block_given?
+        run
+        yield self
+      end
+    end
+
+    # Runs the command
+    def run
+      t1=Time.now
+
+      IO.popen(command) do |io|
+        @output=io.read
+        @process=Process.waitpid2(io.pid)[1]
+      end
+
+      @duration=Time.now-t1
+      exitcode == 0
+    end
+
+    # Runs the command and raises if doesn't exit 0
+    def run!
+      Kernel.fail error_message unless exitcode == 0
+    end
+
+    # Returns false if the command hasn't been executed yet
+    def run?
+      !!process
+    end
+
+    # Returns the exit code for the command. Runs the command if it hasn't run yet.
+    def exitcode
+      ensure_run
+      process.exitstatus
+    end
+
+    # Returns true if the command completed execution.
+    # Will return false if the command hasn't been executed
+    def finished?
+      return false unless process
+      process.success?
+    end
+
+    protected
+
+    def ensure_run
+      run unless process
+    end
+
+    def error_message
+      msg = "\n"
+      msg << color(output)
+      msg << "\n---------------------"
+      msg << "\n\nfailed to execute `#{command}`.\n"
+      msg << "Please check the output above for any errors and make sure that `#{binary}` is installed in your PATH with proper permissions.\n"
+      msg
+    end
+
+    def color(message)
+      "\e[1m\e[31m#{message}\e[0m\e[22m"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.12
+  version: 1.0.0.beta.15
 platform: ruby
 authors:
 - Evan Prothro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -157,6 +157,8 @@ files:
 - lib/cassie/queries/statement/selection.rb
 - lib/cassie/queries/statement/updating.rb
 - lib/cassie/query.rb
+- lib/cassie/support.rb
+- lib/cassie/support/command_runner.rb
 - lib/cassie/testing.rb
 - lib/cassie/testing/README.md
 - lib/cassie/testing/fake/execution_info.rb