rack-insight 0.5.26 → 0.5.27

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9014b272efd1a4dacfded3cd104d90138f3e862c
+  data.tar.gz: 737f8d87ce64751c2d453cef210c2ba104cf022a
+SHA512:
+  metadata.gz: 0e824b8ff9e415506009c9445d938dda476b3b9c6effb38f7c9b74d6e11936f92df929017b51bcd4ecb0a05c8c5999a0c42dc29d8c9fa78f42807d8c4b6a60a3
+  data.tar.gz: f92a70fa12747312cc057ddcbb40ae29123d541fb9f5a2fc5d33d9046456c1086e9932e07d8d6b2f3981da79c17341a67157e3739cab7ca29493f9178a6a1461

data/.ruby-gemset

@@ -0,0 +1 @@
+foss

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p448

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - jruby-19mode
-  - rbx-19mode
-  - ruby-head
-  - jruby-head
-bundler_args: "--binstubs --without documentation"
+#  - jruby-19mode  # Fails to install sqlite3
+#  - rbx-19mode
+#  - ruby-head    # Fails to download rubygems.org/latest_specs.4.8.gz
+#  - jruby-head   # Fails to install sqlite3
+bundler_args: "--binstubs --without documentation"

data/CHANGELOG

@@ -1,14 +1,36 @@
+== 0.5.27 / 2013-09-03
+
+  * Other
+
+    * Improved configuration of logging and verbosity by Peter Boling
+
+      * Moved VERBOSITY from Logging module into Config class
+
+    * gemspec email should reflect who the current contacts are for the gem by Peter Boling
+
+    * Removed unused development dependencies by Peter Boling
+
+    * All specs passing! by Peter Boling
+
+    * Fixing deprecations by Peter Boling
+
+    * Require the standard Ruby Logger by Peter Boling
+
+    * Convert to .ruby-version by Peter Boling
+
+    * Add license and platform to gemspec by Peter Boling
+
 == 0.5.26 / 2013-08-06
 
   * Bug Fixes
 
-    * Dont reload page, just close panel by Harry Walter (5 months ago)
-    * Allow panels to scroll when fixed to bottom by Harry Walter (5 months ago)
-    * Set position to fixed to keep toolbar at bottom by Harry Walter (5 months ago)
+    * Dont reload page, just close panel by Harry Walter
+    * Allow panels to scroll when fixed to bottom by Harry Walter
+    * Set position to fixed to keep toolbar at bottom by Harry Walter
 
   * Other
 
-    * Update README.md by Agis Anastasopoulos (5 months ago)
+    * Update README.md by Agis Anastasopoulos
 
 == 0.5.25 / 2013-03-15
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-insight (0.5.25)
+    rack-insight (0.5.26)
       rack
       sqlite3 (>= 1.3.3)
       uuidtools (>= 2.1.2)
@@ -9,23 +9,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    columnize (0.3.6)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
-    diff-lcs (1.2.1)
-    gem-release (0.5.2)
-    nokogiri (1.5.6)
+    diff-lcs (1.2.4)
+    gem-release (0.6.0)
+    mini_portile (0.5.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.0.3)
-    redcarpet (2.2.2)
+    rake (10.1.0)
     reek (1.2.13)
       ripper_ruby_parser (~> 0.0.7)
       ruby2ruby (~> 1.2.5)
@@ -35,27 +29,27 @@ GEM
       sexp_processor (~> 3.0)
     roodi (2.2.0)
       ruby_parser (~> 2.3.0)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
+    rspec-mocks (2.14.2)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
     sexp_processor (3.2.0)
-    sinatra (1.4.1)
-      rack (~> 1.5, >= 1.5.2)
+    sinatra (1.4.3)
+      rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     sqlite3 (1.3.7)
-    tilt (1.3.5)
-    uuidtools (2.1.3)
+    tilt (1.4.1)
+    uuidtools (2.1.4)
     webrat (0.7.3)
       nokogiri (>= 1.2.0)
       rack (>= 1.0)
@@ -65,13 +59,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  debugger (>= 1.5.0)
-  gem-release (>= 0.5.2)
+  gem-release (>= 0.6.0)
   rack-insight!
-  rake
-  redcarpet
-  reek (>= 1.2.8)
-  roodi (>= 2.1.0)
-  rspec (>= 2.11.0)
-  sinatra
-  webrat
+  rake (>= 10.1.0)
+  reek (>= 1.2.13)
+  roodi (>= 2.2.0)
+  rspec (>= 2.14.1)
+  sinatra (>= 1.4.3)
+  webrat (>= 0.7.3)

data/README.md

@@ -8,7 +8,7 @@ Description
 -----------
 
 Rack::Insight adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
-allowing exploration of logging, database queries, template rendering times, etc.   Rack::Insight
+allowing exploration of logging, database queries, template rendering times, etc.  Rack::Insight
 stores debugging info over many requests, incuding AJAX requests.
 
 Features
@@ -25,7 +25,7 @@ Features
         * Templates
         * Log               (can configure which loggers to watch!)
         * Memory
-        * SQL               (Failing specs, and I don't use it, someone please pull me a fix!)
+        * SQL
         * Active Record     (Thanks to [Kevin Glowacz](https://github.com/kjg) for the fix!)
     * Other bundled panels:
         * Sphinx (thanks to Oggy for updating this to the rack-insight panel API)
@@ -59,7 +59,7 @@ In config/environments/development.rb, add:
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
 
 Any environment with Rack::Insight loaded will have a link to "Rack::Insight" added to as
-the last child of BODY to normal responses.  Clicking that link will load the
+the last child of `<body>` to normal responses.  Clicking that link will load the
 toolbar.  It's set with an id of "rack-insight-enabler", so it can be styled
 to go somewhere more noticeable.  E.g. "position: absolute; top: 0; left: 0"
 
@@ -69,9 +69,6 @@ Using with non-Rails Rack apps
 Just 'use Rack::Insight' as any other middleware.  See the SampleApp in the
 spec/fixtures folder for an example Sinatra app.
 
-If you wish to use the logger panel define the LOGGER constant that is a ruby
-Logger or ActiveSupport::BufferedLogger
-
 Configure Rack::Insight
 ---------------------
 
@@ -91,11 +88,11 @@ Options:
 
     :rails_log_copy - If you are setting :logger to the Rails Logger, you should set this to false (default is true).
 
-    :verbosity - true is default .
+    :verbosity - true is default.
                true is equivalent to relying soley on the logger's log level to determine if a message is logged.
                Other potential values are:
                   anything falsey => no logging at all
-                  Rack::Insight::Logging::VERBOSITY[*level*] where *level* is one of:
+                  Rack::Insight::Config::VERBOSITY[*level*] where *level* is one of:
                     :debug, :high, :med, :low, :silent
 
     :panel_load_paths => [File::join('rack', 'insight', 'panels')] (default)
@@ -206,10 +203,12 @@ Restrict access using a password:
 
 #### custom file path for the request recording database ####
 
-Rack::Insight uses SQLite to store data from requests, and outputs a database
+Rack::Insight uses SQLite to store data across requests, and outputs a database
 file in the root directory. If you need the file to be created at another
 location (i.e. Heroku), you can pass a custom file path.
 
+Please report back if you have success with this on Heroku!
+
     ActionController::Dispatcher.middleware.use "Rack::Insight::App"
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
       :database_path => "tmp/my_insight_db.sqlite"

data/lib/rack/insight/config.rb

@@ -1,5 +1,18 @@
+require 'logger' # Require the standard Ruby Logger
+
 module Rack::Insight
   class Config
+
+    VERBOSITY = {
+      :debug => Logger::DEBUG,
+      :high => Logger::INFO,
+      :med => Logger::WARN,
+      :low => Logger::ERROR,
+      # Silent can be used with unless instead of if.  Example:
+      #   logger.info("some message") unless app.verbose(:silent)
+      :silent => Logger::FATAL
+    }
+
     class << self
       attr_reader :config, :verbosity, :log_file, :log_level, :rails_log_copy,
                   :filtered_backtrace, :panel_configs, :silence_magic_insight_warnings,
@@ -8,7 +21,7 @@ module Rack::Insight
     @log_file = STDOUT
     @log_level = ::Logger::DEBUG
     @logger = nil
-    @verbosity = Rack::Insight::Logging::VERBOSITY[:silent]
+    @verbosity = nil
     @rails_log_copy = true
     @filtered_backtrace = true
     @panel_configs = {
@@ -24,7 +37,11 @@ module Rack::Insight
                   Mysql2Adapter OracleEnhancedAdapter }.map do |adapter|
                     ["ActiveRecord::ConnectionAdapters::#{adapter}", [:instance, :execute]]
                   end ] },
-      :templates => {:probes => {'ActionView::Template' => [:instance, :render]}}
+      :templates => {:probes => {'ActionView::Template' => [:instance, :render]}},
+      :redis => {:probes => defined?(Redis::Client) ?
+        { 'Redis::Client' => [:instance, :call] } : # Redis >= 3.0.0
+        { 'Redis' => [:instance, :call_command] } # Redis < 3.0.0
+      }
     }
     @silence_magic_insight_warnings = false
     @database = {
@@ -43,6 +60,7 @@ module Rack::Insight
       #   end
       :panel_load_paths => [File::join('rack', 'insight', 'panels')],
       :logger => @logger,
+      :verbosity => @verbosity,
       :log_file => @log_file,
       :log_level => @log_level,
       :rails_log_copy => @rails_log_copy, # Only has effect when logger is the Rack::Insight::Logger, or a logger behaving like it
@@ -74,6 +92,9 @@ module Rack::Insight
         logger.warn("Rack::Insight::Config#configure: when logger is set, log_level and log_file have no effect, and will only confuse you.")
       end
       @verbosity = config[:verbosity]
+      if @verbosity.nil?
+        @verbosity = Rack::Insight::Config::VERBOSITY[:silent]
+      end
       @filtered_backtrace = config[:filtered_backtrace]
       @silence_magic_insight_warnings = config[:silence_magic_insight_warnings]
       @database = config[:database]
@@ -105,6 +126,10 @@ module Rack::Insight
       self.config[:panel_configs][panel_name_sym] = @panel_configs[panel_name_sym]
     end
 
+    def self.verbosity
+      @verbosity ||= self.config[:verbosity]
+    end
+
     def self.logger
       @logger ||= begin
         logga = self.config[:logger]

data/lib/rack/insight/database.rb

@@ -5,6 +5,13 @@ require 'base64'
 module Rack::Insight
   class Database
 
+    module EigenClient
+      def self.included(base)
+        base.send(:attr_accessor, :table)
+        base.send(:attr_accessor, :key_sql_template)
+      end
+    end
+
     # Classes including this module must define the following structure:
     #    class FooBar
     #      include Rack::Insight::Database
@@ -17,15 +24,16 @@ module Rack::Insight
     # TODO: Move the has_table definition into this module's included hook.
     module RequestDataClient
       def key_sql_template(sql)
-        @key_sql_template = sql
+        self.class.key_sql_template = sql
       end
 
       def table_setup(name, *keys)
         self.class.has_table = true
-        @table = DataTable.new(name, *keys)
+        self.class.table = DataTable.new(name, *keys)
         if keys.empty?
-          @key_sql_template = ''
+          self.class.key_sql_template = ''
         end
+        self.class.table
       end
 
       def store(env, *keys_and_value)
@@ -36,19 +44,24 @@ module Rack::Insight
         value = keys_and_value[-1]
         keys = keys_and_value[0...-1]
 
-        @table.store(request_id, value, @key_sql_template % keys)
+        #puts "value: #{value}"
+        #puts "keys: #{keys}"
+        #puts "table: #{self.class.table.inspect}"
+        #puts "@key_sql_template: #{self.class.key_sql_template}"
+        #puts "class: #{self.class.inspect}"
+        self.class.table.store(request_id, value, self.class.key_sql_template % keys)
       end
 
       def retrieve(request_id)
-        @table.for_request(request_id)
+        self.class.table.for_request(request_id)
       end
 
       def count(request_id)
-        @table.count_for_request(request_id)
+        self.class.table.count_for_request(request_id)
       end
 
       def table_length
-        @table.length
+        self.class.table.length
       end
     end
 

data/lib/rack/insight/instrumentation.rb

@@ -4,6 +4,7 @@ end
 require 'rack/insight/instrumentation/instrument'
 require 'rack/insight/instrumentation/probe'
 require 'rack/insight/instrumentation/client'
+require 'rack/insight/instrumentation/eigen_client'
 require 'rack/insight/instrumentation/setup'
 require 'rack/insight/instrumentation/package-definition'
 require 'rack/insight/instrumentation/probe-definition'

data/lib/rack/insight/instrumentation/eigen_client.rb

@@ -0,0 +1,16 @@
+module Rack::Insight::Instrumentation
+  module EigenClient
+
+    def self.included(base)
+      # Once a panel is probed self.is_probing should be set to true
+      # Panels without tables override with self.has_table = false
+      # check is_magic to wrap any functionality targeted at magic panels.
+      base.send(:attr_accessor, :is_probing)
+      base.send(:attr_accessor, :has_table)
+      base.send(:attr_accessor, :table)
+      base.send(:attr_accessor, :is_magic)
+      base.send(:attr_accessor, :template_root)
+    end
+
+  end
+end

data/lib/rack/insight/logging.rb

@@ -1,14 +1,12 @@
+require 'rack/insight/config'
+
 module Rack::Insight
   module Logging
-    VERBOSITY = {
-      :debug => Logger::DEBUG,
-      :high => Logger::INFO,
-      :med => Logger::WARN,
-      :low => Logger::ERROR,
-      # Silent can be used with unless instead of if.  Example:
-      #   logger.info("some message") unless app.verbose(:silent)
-      :silent => Logger::FATAL
-    }
+
+    def verbosity
+      Rack::Insight::Config.verbosity
+    end
+    module_function :verbosity
 
     def logger
       Rack::Insight::Config.logger
@@ -18,15 +16,15 @@ module Rack::Insight
     # max_level is confusing because the 'level' of output goes up (and this is what max refers to)
     # when the integer value goes DOWN
     def verbose(max_level = false)
-      #logger.unknown "Rack::Insight::Config.verbosity: #{Rack::Insight::Config.verbosity} <= max_level: #{VERBOSITY[max_level]}" #for debugging the logger
-      return false if (!Rack::Insight::Config.verbosity) # false results in Exactly Zero output!
-      return true if (Rack::Insight::Config.verbosity == true) # Not checking truthy because need to check against max_level...
+      #logger.unknown "Rack::Insight::Logging.verbosity: #{Rack::Insight::Logging.verbosity} <= max_level: #{VERBOSITY[max_level]}" #for debugging the logger
+      return false if (!verbosity) # false results in Exactly Zero output!
+      return true if (verbosity == true) # Not checking truthy because need to check against max_level...
       # Example: if configured log spam level is high (1) logger should get all messages that are not :debug (0)
       #          so, if a log statement has if verbose(:low) (:low is 3)
       #          1 <= 3 # true => Message sent to logger
       #          then, if a log statement has if verbose(:debug) (:debug is 0)
       #          1 <= 0 # false => Nothing sent to logger
-      return true if Rack::Insight::Config.verbosity <= (VERBOSITY[max_level]) # Integers!
+      return true if verbosity <= (Rack::Insight::Config::VERBOSITY[max_level]) # Integers!
     end
     module_function :verbose
   end

data/lib/rack/insight/panel.rb

@@ -16,14 +16,19 @@ module Rack::Insight
 
     attr_reader :request
 
+    # has table defaults to true for panels.
+    def self.has_table
+      self.has_table.nil? ? true : self.class.table.nil?
+    end
+
     class << self
 
       include Rack::Insight::Logging
-
-      attr_accessor :template_root, :is_probing, :has_table, :is_magic
-      @is_probing = false  # Once a panel is probed this should be set to true
-      @has_table = true   # default to true.  Panels without tables override with self.has_table = false
-      @is_magic = false   # check this to wrap any functionality targeted at magic panels.
+      # This will allow the following:
+      # p = Panel.new
+      # p.class.is_probing = true
+      include Rack::Insight::Instrumentation::EigenClient
+      include Rack::Insight::Database::EigenClient
 
       def file_index
         return @file_index ||= Hash.new do |h,k|
@@ -113,13 +118,15 @@ module Rack::Insight
       #   end
       panel_name = self.underscored_name.to_sym
       if self.has_custom_probes?(panel_name)
+        # Both formats are valid and must be supported
+        #config[:panel_configs][:log] = {:probes => {'Logger' => [:instance, :add]}}
+        #config[:panel_configs][:log] = {:probes => ['Logger', :instance, :add]}
         custom_probes = Rack::Insight::Config.config[:panel_configs][panel_name][:probes]
         if custom_probes.kind_of?(Hash)
           probe(self) do
             custom_probes.each do |klass, method_probes|
-              probe_type = method_probes.shift
               instrument klass do
-                self.send("#{probe_type}_probe", *method_probes)
+                self.send("#{method_probes[0]}_probe", *(method_probes[1..-1]))
               end
             end
           end