whi-cassie 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f85b689086bd176a805cd0fcdd9ba9cab4980d75
-  data.tar.gz: e596bacb6ddd3393c5d1fd93d49da61d1898333b
+  metadata.gz: d3ebdf5f386202ccb62aa4e9f4c10599111f18f6
+  data.tar.gz: 15e6f8b61b24160a946f5fd521b0f20bfc258366
 SHA512:
-  metadata.gz: de080c2f8d0a523d754dbfa0aee4215cc64923e1f122c6ddce85a58c7becb97b02616540cdc880b1dd2c993aed89396f91123393cd374f4b90189da5fc571871
-  data.tar.gz: 2bc5d0e2ea0aa0e8ee43cbe86789b497ad8e421bda9365bcf4d5493e1ddeec647b22383e89ca35c8f254d9e5d5056389cd4fafd346de8ede7a9493792c546fae
+  metadata.gz: 8d8e4275b346070a0549d52a782d3a0c403cf13c3b3d7e332469d6fa93b2335ce368e3243b2dce4b9dc49ac339bff3c7d3172095ad39298752b3eaf8808fa462
+  data.tar.gz: f6a73b42ef8301d095b9fa2a6910169cbfb7b42fd9b0fc1d1584c5a959b5350a1829893843179b0b8ab09116591157493778e485d544d5d39ae41c4846c9228b

data/HISTORY.txt

@@ -1,3 +1,7 @@
+1.0.7
+
+Add find_subscribers to Cassie::Model for instrumenting model find calls.
+
 1.0.6
 
 Wrap raw CQL in a Simple statement for code consistency in subscribers.

data/README.md

@@ -212,6 +212,11 @@ You can add instrumentation via subscribers to the `Cassie.instance`. Subscriber
 Cassie.instance.subscribers << lambda{|message| logger.warn("CQL: #{message.statement.cql} with #{message.options} took #{message.elapsed_time}s") if message.elapsed_time > 0.5 && message.statement.cql}
 ```
 
+You can instrument the finding code on your model by adding a find subscriber either to the model or to Cassie::Model. These subscribers take a block which is yielded to with the CQL, arguments, options, elapsed time, and rows returned.
+```
+Cassie::Model.find_subscribers << lambda{|message| logger.warn("CQL: #{message.cql}; Rows: #{message.rows}; Time: #{message.elapsed_time}")
+```
+
 ### Limitations
 
 Ruby 2.0 (or compatible) required.

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.7

data/lib/cassie/model.rb

@@ -47,10 +47,33 @@ module Cassie::Model
     class_attribute :_column_aliases, :instance_reader => false, :instance_writer => false
     class_attribute :_ordering_keys, :instance_reader => false, :instance_writer => false
     class_attribute :_counter_table, :instance_reader => false, :instance_writer => false
+    class_attribute :find_subscribers, :instance_reader => false, :instance_writer => false
     define_model_callbacks :create, :update, :save, :destroy
     self._columns = {}
     self._column_aliases = HashWithIndifferentAccess.new
     self._ordering_keys = {}
+    self.find_subscribers = Cassie::Subscribers.new(Cassie::Model.find_subscribers)
+  end
+  
+  class << self
+    @@find_subscribers = Cassie::Subscribers.new
+    
+    def find_subscribers
+      @@find_subscribers
+    end
+  end
+  
+  # Message sent to find subscribers for instrumenting find operations.
+  class FindMessage
+    attr_reader :cql, :args, :options, :elapsed_time, :rows
+    
+    def initialize(cql, args, options, elapsed_time, rows)
+      @cql = cql
+      @args = args
+      @options = options
+      @elapsed_time = elapsed_time
+      @rows = rows
+    end
   end
   
   module ClassMethods    
@@ -186,6 +209,7 @@ module Cassie::Model
     # You can provide a block to this method in which case it will yield each
     # record as it is foundto the block instead of returning them.
     def find_all(where:, select: nil, order: nil, limit: nil, options: nil)
+      start_time = Time.now
       columns = (select ? Array(select).collect{|c| column_name(c)} : column_names)
       cql = "SELECT #{columns.join(', ')} FROM #{full_table_name}"
       values = nil
@@ -209,7 +233,9 @@ module Cassie::Model
     
       results = connection.find(cql, values, options)
       records = [] unless block_given?
+      row_count = 0
       loop do
+        row_count += results.size
         results.each do |row|
           record = new(row)
           record.instance_variable_set(:@persisted, true)
@@ -222,6 +248,12 @@ module Cassie::Model
         break if results.last_page?
         results = results.next_page
       end
+      
+      if find_subscribers && !find_subscribers.empty?
+        payload = FindMessage.new(cql, values, options, Time.now - start_time, row_count)
+        find_subscribers.each{|subscriber| subscriber.call(payload)}
+      end
+      
       records
     end
     

data/lib/cassie/subscribers.rb

@@ -0,0 +1,53 @@
+# Thread safe list of subscribers. Each subscriber must respond to the :call method.
+class Cassie::Subscribers
+  
+  def initialize(parent_subscribers = nil)
+    @array = [].freeze
+    @lock = Mutex.new
+    @parent_subscribers = parent_subscribers
+  end
+  
+  def add(subscriber)
+    @lock.synchronize do
+      new_array = @array.dup
+      new_array << subscriber
+      @array = new_array
+    end
+  end
+  alias_method :<<, :add
+  
+  def remove(subscriber)
+    removed = nil
+    @lock.synchronize do
+      new_array = @array.dup
+      removed = new_array.delete(subscriber)
+      @array = new_array
+    end
+    removed
+  end
+  alias_method :delete, :remove
+  
+  def clear
+    @array = []
+  end
+  
+  def size
+    @array.size + (@parent_subscribers ? @parent_subscribers.size : 0)
+  end
+  
+  def empty?
+    size == 0
+  end
+  
+  def each(&block)
+    @array.each(&block)
+    if @parent_subscribers
+      @parent_subscribers.each(&block)
+    end
+  end
+  
+  def include?(subscriber)
+    @array.include?(subscriber)
+  end
+  
+end

data/lib/cassie.rb

@@ -4,6 +4,7 @@ require 'cassandra'
 # a foundation for maintaining a connection and constructing CQL statements.
 class Cassie
   require File.expand_path("../cassie/config.rb", __FILE__)
+  require File.expand_path("../cassie/subscribers.rb", __FILE__)
   require File.expand_path("../cassie/model.rb", __FILE__)
   require File.expand_path("../cassie/schema.rb", __FILE__)
   require File.expand_path("../cassie/testing.rb", __FILE__)
@@ -88,7 +89,7 @@ class Cassie
     @session = nil
     @prepared_statements = {}
     @last_prepare_warning = Time.now
-    @subscribers = []
+    @subscribers = Subscribers.new
   end
   
   # Open a connection to the Cassandra cluster.

data/spec/cassie/model_spec.rb

@@ -100,6 +100,16 @@ describe Cassie::Model do
       expect{ Cassie::Thing.find_all(where: {}) }.to raise_error(ArgumentError)
       Cassie::Thing.find_all(where: :all).size.should == 3
     end
+    
+    it "should be able to add subscribers" do
+      global = nil
+      local = nil
+      Cassie::Model.find_subscribers << lambda{|info| global = info.rows}
+      Cassie::Thing.find_subscribers << lambda{|info| local = info.rows}
+      Cassie::Thing.find_all(where: {:owner => 1}).size.should == 2
+      global.should == 2
+      local.should == 2
+    end
   end
   
   describe "offset_to_id" do

data/spec/cassie/subscribers_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Cassie::Subscribers do
+  
+  it "should be able to add and remove a subscriber" do
+    subscribers = Cassie::Subscribers.new
+    expect(subscribers.empty?).to eq true
+    data_1 = []
+    data_2 = []
+    subscriber_1 = lambda{|info| data_1 << info}
+    subscriber_2 = lambda{|info| data_2 << info}
+    subscribers.add(subscriber_1)
+    subscribers << subscriber_2
+    expect(subscribers.empty?).to eq false
+    expect(subscribers.size).to eq 2
+    expect(subscribers.include?(subscriber_1)).to eq true
+    expect(subscribers.include?(subscriber_2)).to eq true
+    
+    subscribers.each{|s| s.call(:payload)}
+    expect(data_1).to eq [:payload]
+    expect(data_2).to eq [:payload]
+    
+    subscribers.remove(subscriber_2)
+    expect(subscribers.size).to eq 1
+    expect(subscribers.include?(subscriber_1)).to eq true
+    expect(subscribers.include?(subscriber_2)).to eq false
+    
+    subscribers.each{|s| s.call(:more)}
+    expect(data_1).to eq [:payload, :more]
+    expect(data_2).to eq [:payload]
+    
+    subscribers.delete(subscriber_1)
+    expect(subscribers.size).to eq 0
+  end
+  
+  it "should have a hierarchy of subscribers" do
+    subscribers_1 = Cassie::Subscribers.new
+    subscribers_2 = Cassie::Subscribers.new(subscribers_1)
+    subscribers_3 = Cassie::Subscribers.new(subscribers_1)
+    data_1 = []
+    data_2 = []
+    data_3 = []
+    subscribers_1 << lambda{|info| data_1 << info}
+    subscribers_2 << lambda{|info| data_2 << info}
+    
+    expect(subscribers_1.size).to eq 1
+    expect(subscribers_2.size).to eq 2
+    expect(subscribers_3.size).to eq 1
+    
+    subscribers_1.each{|subscriber| subscriber.call(:payload_1)}
+    subscribers_2.each{|subscriber| subscriber.call(:payload_2)}
+    subscribers_3.each{|subscriber| subscriber.call(:payload_3)}
+    
+    expect(data_1).to eq [:payload_1, :payload_2, :payload_3]
+    expect(data_2).to eq [:payload_2]
+    
+    subscribers_2.clear
+    expect(subscribers_2.size).to eq 1
+    subscribers_1.clear
+    expect(subscribers_2.size).to eq 0
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whi-cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - We Heart It
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -99,10 +99,12 @@ files:
 - lib/cassie/model.rb
 - lib/cassie/railtie.rb
 - lib/cassie/schema.rb
+- lib/cassie/subscribers.rb
 - lib/cassie/testing.rb
 - lib/whi-cassie.rb
 - spec/cassie/config_spec.rb
 - spec/cassie/model_spec.rb
+- spec/cassie/subscribers_spec.rb
 - spec/cassie_spec.rb
 - spec/models/thing.rb
 - spec/models/type_tester.rb
@@ -137,6 +139,7 @@ summary: Simple object mapper for Cassandra data tables specifically designed to
 test_files:
 - spec/cassie/config_spec.rb
 - spec/cassie/model_spec.rb
+- spec/cassie/subscribers_spec.rb
 - spec/cassie_spec.rb
 - spec/models/thing.rb
 - spec/models/type_tester.rb