hyphy 0.0.0 → 0.0.1

data/spec/filters/duration_filter_spec.rb

@@ -1,31 +1,43 @@
 require 'spec_helper'
 
-describe Hyphy::DurationFilter do
+describe Hyphy::Filters::DurationFilter do
 
-  let!(:sql_statement1) { Hyphy::SQLStatement.create(:statement => 'select count(*) from table1',
-                                                     :start_time => 1.0,
-                                                     :end_time => 1.1) }
+  before(:each) do
+    @sql_statement1 = Hyphy::SQLStatement.new(:statement => 'select count(*) from table1',
+                                              :start_time => 1.0,
+                                              :end_time => 1.1)
 
-  let!(:sql_statement2) { Hyphy::SQLStatement.create(:statement => 'select count(*) from table2',
-                                                     :start_time => 2.0,
-                                                     :end_time => 2.1) }
+    @sql_statement2 = Hyphy::SQLStatement.new(:statement => 'select count(*) from table2',
+                                              :start_time => 2.0,
+                                              :end_time => 2.1)
 
-  let!(:sql_statement3) { Hyphy::SQLStatement.create(:statement => 'select count(*) from table3',
-                                                     :start_time => 2.0,
-                                                     :end_time => 3.0) }
+    @sql_statement3 = Hyphy::SQLStatement.new(:statement => 'select count(*) from table3',
+                                              :start_time => 2.0,
+                                              :end_time => 3.0)
 
-  let!(:sql_statement4) { Hyphy::SQLStatement.create(:statement => 'select count(*) from table4',
-                                                     :start_time => 3.0,
-                                                     :end_time => 10.0) }
+    @sql_statement4 = Hyphy::SQLStatement.new(:statement => 'select count(*) from table4',
+                                              :start_time => 3.0,
+                                              :end_time => 10.0)
+    @sql_statement4.benchmark_time = 7
 
-  let(:dataset) { Hyphy::Dataset.new }
+    @sampler = Hyphy::Sampler.new
+    @sampler.dataset = [@sql_statement1, @sql_statement2, @sql_statement3, @sql_statement4]
+  end
 
   describe "#filter" do
 
     it 'only returns the sql statements that last longer than one second' do
-      dataset.apply_filter(Hyphy::DurationFilter, :duration_min => 1.0)
+      @sampler.apply_filter(Hyphy::Filters::DurationFilter, :duration_min => 1.0)
+
+      @sampler.dataset.should == [@sql_statement4, @sql_statement3]
+    end
+
+    it 'returns the sql statements that have a benchmark time longer than one second' do
+      @sampler.apply_filter(Hyphy::Filters::DurationFilter,
+                           :benchmark => true,
+                           :duration_min => 1.0)
 
-      dataset.data.should == [sql_statement4, sql_statement3]
+      @sampler.dataset.should == [@sql_statement4]
     end
 
   end

data/spec/filters/limit_filter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Hyphy::Filters::LimitFilter do
+
+  before(:each) do
+    @limit = 3
+    @data = [0, 1, 2, 3]
+  end
+
+  describe "#filter" do
+
+    it 'strips the data to a length of the specified limit' do
+      limit_filter = Hyphy::Filters::LimitFilter.new(@data, :limit => @limit)
+      limit_filter.filter
+
+      limit_filter.data.should == [0, 1, 2]
+    end
+
+  end
+
+end

data/spec/filters/sql_filter_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Hyphy::Filters::SQLFilter do
+
+  before(:each) do
+    @sql_statement1 = Hyphy::SQLStatement.new(:statement => "select * from table")
+    @sql_statement2 = Hyphy::SQLStatement.new(:statement => "insert into table values 1, 2, 3")
+    @data = [@sql_statement1, @sql_statement2]
+  end
+
+  describe "#initialize" do
+
+    it "throws an exception when an incorrect SQL statement type is provided" do
+      expect { Hyphy::Filters::SQLFilter.new(@data, :type => :lol) }
+        .to raise_error(Hyphy::Filters::SQLFilter::IncorrectSQLTypeException)
+    end
+
+  end
+
+  describe "#filter" do
+
+    it "filters the data to include SQL statements of the right type" do
+      sql_filter = Hyphy::Filters::SQLFilter.new(@data, :type => :select)
+      sql_filter.filter
+
+      @data.should == [@sql_statement1]
+    end
+
+  end
+
+end

data/spec/models/sql_statement_spec.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 require "spec_helper"
 
 describe Hyphy::SQLStatement do
@@ -8,8 +6,8 @@ describe Hyphy::SQLStatement do
   let(:sql_statement) { Hyphy::SQLStatement.new(:statement => statement,
                                                 :start_time => 2,
                                                 :end_time => 3.001,
-                                                :trace_json => JSON(["hello!"]),
-                                                :metadata_json => JSON({ "hello!" => "hi!" })) }
+                                                :trace => ["hello!"],
+                                                :metadata => { "hello!" => "hi!" }) }
 
   describe "#duration" do
 
@@ -48,14 +46,13 @@ describe Hyphy::SQLStatement do
 
   end
 
-  describe ".truncate_table" do
+  describe "#application_trace" do
 
-    it 'should clear all sql_statements rows' do
-      Hyphy::SQLStatement.create
-      Hyphy::SQLStatement.all.count.should == 1
+    it "returns the trace lines that are related to the running application" do
+      sql_statement.stub(:trace).and_return(['/1', '/2', '/3'])
+      Dir.stub(:pwd).and_return('/1')
 
-      Hyphy::SQLStatement.truncate_table
-      Hyphy::SQLStatement.all.count.should == 0
+      sql_statement.application_trace.should == ['/1']
     end
 
   end
@@ -71,11 +68,36 @@ describe Hyphy::SQLStatement do
   describe "#add_metadata" do
 
     it "should store the key, value pair in the metadata" do
-      sql_statement.add_metadata("key", "value")
+      sql_statement.metadata["key"] = "value"
 
       sql_statement.metadata["key"].should == "value"
     end
 
   end
 
+  describe "statement methods" do
+
+    let(:sql_statement1) { Hyphy::SQLStatement.new(:statement => "select * from table") }
+    let(:sql_statement2) { Hyphy::SQLStatement.new(:statement => "insert into table values 1, 2, 3") }
+
+    describe "#select?" do
+
+      it "is true for a select statement" do
+        sql_statement1.select?.should be_true
+        sql_statement2.select?.should be_false
+      end
+
+    end
+
+    describe "#insert?" do
+
+      it "is true for a insert statement" do
+        sql_statement1.insert?.should be_false
+        sql_statement2.insert?.should be_true
+      end
+
+    end
+
+  end
+
 end

data/spec/orm_adapters/activerecord_orm_adapter_spec.rb

@@ -3,6 +3,7 @@ require "spec_helper"
 describe Hyphy::ActiveRecordAdapter do
 
   let(:sql_statement) { 'select count(*) from victims' }
+  let(:sampler) { Hyphy::Sampler.new }
   let(:start_time) { 1.0001 }
   let(:end_time) { 1.0002 }
 
@@ -10,13 +11,44 @@ describe Hyphy::ActiveRecordAdapter do
 
     it "should catch sql.active_record notifications" do
       ActiveSupport::Notifications.should_receive(:subscribe)
-        .and_yield(nil, start_time, end_time, nil, { :sql => sql_statement })
+        .and_yield(nil,
+                   start_time,
+                   end_time,
+                   nil, { :sql => sql_statement,
+                          :binds => [] })
 
-      callback = lambda { |a, b, c| }
+      callback = sampler.method(:sample)
 
       Hyphy::ActiveRecordAdapter.subscribe_to_sql_notifications(callback)
     end
 
   end
 
+  describe ".unsubscribe_to_sql_notifications" do
+
+    it "unsubscribes subscriber notifications from ActiveSupport"do
+      subscriber = double()
+      ActiveSupport::Notifications.should_receive(:unsubscribe)
+        .with(subscriber)
+
+      Hyphy::ActiveRecordAdapter.unsubscribe_to_sql_notifications(subscriber)
+    end
+
+  end
+
+  describe ".time_statement" do
+
+    it "Returns a float time value that represents the duration of a statement" do
+      ActiveRecord::Base.stub_chain(:connection, :clear_query_cache)
+
+      Benchmark.stub(:realtime).and_return(3.0)
+      Marshal.stub(:load).and_return([])
+      sql_statement = Hyphy::SQLStatement.new(:statement => 'select * from table')
+
+      Hyphy::ActiveRecordAdapter.time_statement(sql_statement)
+        .should == 3.0
+    end
+
+  end
+
 end

data/spec/sampler_spec.rb

@@ -30,13 +30,15 @@ describe Hyphy::Sampler do
     it 'creates a new SQLStatement row' do
       sampler.log_sql(statement,
                       start_time,
-                      end_time)
+                      end_time,
+                      Hyphy::ActiveRecordAdapter)
 
-      sql_statement = Hyphy::SQLStatement.last
+      sql_statement = sampler.dataset.last
       sql_statement.statement.should == statement
       sql_statement.start_time.should == start_time
       sql_statement.end_time.should == end_time
       sql_statement.trace.class.should == Array
+      sql_statement.orm_adapter.should == Hyphy::ActiveRecordAdapter
     end
 
   end
@@ -44,7 +46,11 @@ describe Hyphy::Sampler do
   describe "#sample" do
 
     it "logs the SQL statement and adds metadata" do
-      sampler.should_receive(:log_sql).with(statement, start_time, end_time)
+      sampler.should_receive(:log_sql).with(statement,
+                                            start_time,
+                                            end_time,
+                                            Hyphy::ActiveRecordAdapter)
+
       sampler.should_receive(:process_metadata)
 
       sampler.sample(statement, start_time, end_time)
@@ -64,7 +70,7 @@ describe Hyphy::Sampler do
 
   describe "#process_metadata" do
 
-    let(:sql_statement) { Hyphy::SQLStatement.create }
+    let(:sql_statement) { Hyphy::SQLStatement.new }
 
     it "adds metadata from a proc to a SQLStatement" do
       sampler.add_metadata("test") { "this is just a test!" }
@@ -75,4 +81,49 @@ describe Hyphy::Sampler do
 
   end
 
+  describe "#stop" do
+
+    it 'unsubscribes SQL notifications' do
+      subscriber = sampler.begin
+      Hyphy::ActiveRecordAdapter.should_receive(:unsubscribe_to_sql_notifications)
+        .with(subscriber)
+
+      sampler.stop
+    end
+
+  end
+
+  describe "#apply_filter" do
+
+    before(:each) do
+      @sampler = Hyphy::Sampler.new
+      @sql_statement1 = Hyphy::SQLStatement.new(:statement => "select * from table1",
+                                                :start_time => 1.001,
+                                                :end_time => 2.002)
+
+      @sql_statement2 = Hyphy::SQLStatement.new(:statement => "select * from table2",
+                                                :start_time => 1.001,
+                                                :end_time => 3.002)
+
+      @sampler.dataset << @sql_statement1
+      @sampler.dataset << @sql_statement2
+    end
+
+    it "filters the in memory dataset" do
+      @sampler.apply_filter(Hyphy::Filters::DurationFilter, :duration_min => 1.5)
+      @sampler.dataset.should == [@sql_statement2]
+    end
+
+  end
+
+  describe "#profile" do
+
+    it "starts and stops the sampling"do
+      sampler.should_receive(:begin)
+      sampler.should_receive(:stop)
+      sampler.profile {}
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ SimpleCov.start
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'database_cleaner'
 require 'pry-nav'
 require 'rspec'
 require 'hyphy'
@@ -15,15 +14,12 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
 
   config.before(:suite) do
-    DatabaseCleaner.strategy = :transaction
   end
 
   config.before(:each) do
-    DatabaseCleaner.start
   end
 
   config.after(:each) do
-    DatabaseCleaner.clean
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyphy
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,42 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sequel
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -75,22 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +139,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Identify SQL bottlenecks in tests
+description: ! 'Hyphy is a toolkit for identifying SQL bottlenecks in Ruby applications.
+  Given
+
+  an adapter for an ORM and a Ruby block, Hyphy collects all executed queries in
+
+  a dataset. Afterward, it can filter the dataset and even benchmark the queries.'
 email: david@nationbuilder.com
 executables: []
 extensions: []
@@ -179,7 +152,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
 - .rspec
 - .ruby-gemset
 - .ruby-version
@@ -191,24 +163,24 @@ files:
 - VERSION
 - hyphy.gemspec
 - lib/hyphy.rb
-- lib/hyphy/database.rb
-- lib/hyphy/dataset.rb
-- lib/hyphy/dataset_collection.rb
 - lib/hyphy/filters/abstract_filter.rb
+- lib/hyphy/filters/benchmark_filter.rb
 - lib/hyphy/filters/duration_filter.rb
-- lib/hyphy/models/sql_statement.rb
+- lib/hyphy/filters/limit_filter.rb
+- lib/hyphy/filters/sql_filter.rb
 - lib/hyphy/orm_adapters/abstract_orm_adapter.rb
 - lib/hyphy/orm_adapters/activerecord_adapter.rb
 - lib/hyphy/sampler.rb
-- spec/dataset_collection_spec.rb
-- spec/dataset_spec.rb
+- lib/hyphy/sql_statement.rb
 - spec/filters/abstract_filter_spec.rb
+- spec/filters/benchmark_filter_spec.rb
 - spec/filters/duration_filter_spec.rb
+- spec/filters/limit_filter_spec.rb
+- spec/filters/sql_filter_spec.rb
 - spec/models/sql_statement_spec.rb
 - spec/orm_adapters/activerecord_orm_adapter_spec.rb
 - spec/sampler_spec.rb
 - spec/spec_helper.rb
-- specification.txt
 homepage: http://github.com/3dna/hyphy
 licenses:
 - MIT
@@ -224,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1377831420524407634
+      hash: -2790169902531096751
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -236,5 +208,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Identify SQL bottlenecks in tests
+summary: A SQL bottleneck toolkit
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/lib/hyphy/database.rb

@@ -1,3 +0,0 @@
-require 'sequel'
-
-Hyphy::DB = Sequel.sqlite

data/lib/hyphy/dataset.rb

@@ -1,14 +0,0 @@
-class Hyphy::Dataset
-
-  attr_reader :data
-
-  def initialize(data=nil)
-    @data = data || Hyphy::SQLStatement.all
-  end
-
-  def apply_filter(filter_class, opts={})
-    filter = filter_class.new(@data, opts)
-    filter.filter
-  end
-
-end

data/lib/hyphy/dataset_collection.rb

@@ -1,35 +0,0 @@
-class Hyphy::DatasetCollection
-
-  class InvalidKeyException < Exception; end
-
-  attr_reader :dataset_collection
-
-  def initialize(dataset, key)
-    raise InvalidKeyException unless Hyphy::SQLStatement.method_defined?(key)
-
-    @key = key
-    @dataset = dataset
-    @dataset_collection = {}
-  end
-
-  def process_dataset
-    collection = Hash.new { |hash, key| hash[key] = [] }
-
-    @dataset.data.each do |sql_statement|
-      collection[sql_statement.send(@key)] << sql_statement
-    end
-
-    collection.each { |key, value| @dataset_collection[key] = Hyphy::Dataset.new(value) }
-  end
-
-  def counts_hash
-    key_to_count = {}
-
-    @dataset_collection.map do |key, dataset|
-      key_to_count[key] = dataset.data.count
-    end
-
-    key_to_count
-  end
-
-end

data/lib/hyphy/models/sql_statement.rb

@@ -1,49 +0,0 @@
-require 'json'
-
-Hyphy::DB.create_table(:sql_statements) do
-  primary_key :id
-
-  String :statement, :text => true
-  String :trace_json, :text => true
-  String :metadata_json, :text => true
-  Float :start_time
-  Float :end_time
-end
-
-class Hyphy::SQLStatement < Sequel::Model
-
-  DIGIT_MARKER = '<digit>'
-
-  def duration
-    @duration ||= (end_time - start_time)
-  end
-
-  def stripped_statement
-    statement.strip
-  end
-
-  def digitless
-    without_digits = stripped_statement.gsub(/\d+/, DIGIT_MARKER)
-  end
-
-  def trace
-    JSON.parse(trace_json)
-  end
-
-  def metadata
-    return {} unless metadata_json
-    JSON.parse(metadata_json)
-  end
-
-  def add_metadata(key, value)
-    new_metadata = metadata
-    new_metadata[key] = value
-    self.metadata_json = JSON(new_metadata)
-    save
-  end
-
-  def self.truncate_table
-    Hyphy::DB[:sql_statements].truncate
-  end
-
-end

data/spec/dataset_collection_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-describe Hyphy::DatasetCollection do
-
-  before(:each) do
-    Hyphy::SQLStatement.create :statement => 'select * from table where id = 4'
-    Hyphy::SQLStatement.create :statement => 'select * from table where id = 7'
-    Hyphy::SQLStatement.create :statement => 'select * from table'
-  end
-
-  let(:dataset) { Hyphy::Dataset.new }
-  let(:dataset_collection) { Hyphy::DatasetCollection.new(dataset, :statement) }
-
-  describe "#process_dataset" do
-
-    before(:each) { dataset_collection.process_dataset }
-
-    it "creates a collection with each statement having a unique key" do
-      dataset_collection.dataset_collection.keys.uniq.count.should == 3
-      dataset_collection.dataset_collection.values.uniq.count.should == 3
-    end
-
-  end
-
-  describe "#counts_hash" do
-
-    before(:each) { dataset_collection.process_dataset }
-
-    it "maps the correct statements to counts" do
-      puts dataset_collection.counts_hash.should ==
-        { "select * from table where id = 4" => 1,
-        "select * from table where id = 7" => 1,
-        "select * from table" => 1 }
-    end
-
-  end
-
-end