rsolr-footnotes 0.0.1

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "mocha"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end
+
+gem "activesupport"
+gem "rails"
+gem "rails-footnotes"
+gem "rsolr"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Beer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,29 @@
+= rsolr-footnotes
+
+This gem provides a rails-footnote (https://github.com/josevalim/rails-footnotes) pane that displays request/response information from RSolr (https://github.com/mwmitchell/rsolr) queries.
+
+Preliminary testing has only been performed in Blacklight (http://projectblacklight.org), but should presumably work with any Rails application that uses RSolr.
+
+= Installation
+
+=== Rails 3.x
+  
+  gem "rails-footnotes", ">= 3.7", :group => :development
+  gem "rsolr-footnotes", :group => :development
+
+
+== Contributing to rsolr-footnotes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Chris Beer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rsolr-footnotes"
+  gem.homepage = "http://github.com/cbeer/rsolr-footnotes"
+  gem.license = "MIT"
+  gem.summary = %Q{rails-footnotes for rsolr}
+  # gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "chris@cbeer.info"
+  gem.authors = ["Chris Beer"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rsolr-footnotes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/notes/rsolr_requests_note.rb

@@ -0,0 +1,94 @@
+module Footnotes::Notes
+  class RsolrRequestsNote < AbstractNote
+    def self.query_subscriber
+      @@query_subscriber ||= RsolrSubscriber.new
+    end
+
+    def self.start!(controller)
+      self.query_subscriber.reset!
+    end
+
+    def events
+      self.class.query_subscriber.events
+    end
+
+    def self.title
+      "Solr Requests"
+    end
+
+    def stylesheet
+      <<-CSS
+        .rsolr_response_note { margin-bottom: 1em }
+        .rsolr_response_note .response { padding-left: 50px; color: #777; }
+
+      CSS
+    end
+
+    def content
+      html = ''
+
+      events.each_with_index do |event, index|
+        html << <<-HTML
+        <div class="rsolr_response_note">
+          <b>#{event.method.to_s.upcase} #{event.path}</b> (<a href="#{ event.uri.to_s }">[link]</a>)
+          <span>(#{ event.duration } ms)</span><br />
+          <span><b>params:</b> #{ event.params.inspect }</span><br />
+          <span><b>header:</b> #{ event.response["responseHeader"].inspect }</span><br />
+          <a href=\"javascript:Footnotes.toggle('rsolr_response_#{index}')\" style=\"color:#00A;\">toggle response</a>
+          <p class="response" id="rsolr_response_#{index}" style="display:none;">#{ event.response.inspect }</p>
+        </div>
+        HTML
+      end
+
+      html
+    end
+  end
+
+  class RsolrSubscriberNotificationEvent < ActiveSupport::Notifications::Event
+    def initialize *args
+      super(*args)
+    end
+
+    def path
+      payload[:path]
+    end
+
+    def response
+      payload[:response]
+    end
+
+    def params
+      payload[:params]
+    end
+
+    def query
+      payload[:query]
+    end
+
+    def method
+      payload[:method]
+    end
+
+    def uri
+      payload[:uri]
+    end
+  end
+
+  class RsolrSubscriber < ActiveSupport::LogSubscriber
+    attr_accessor :events
+
+    def initialize
+      self.events = []
+
+      ActiveSupport::Notifications.subscribe("execute.rsolr_client") do |*args|
+        # args.last[:caller] = caller
+        @events << RsolrSubscriberNotificationEvent.new(*args)
+      end
+    end
+
+    def reset!
+      self.events.clear
+    end
+
+  end
+end

data/lib/rsolr-ext/notifications.rb

@@ -0,0 +1,25 @@
+module RSolr::Ext
+  module Notifications
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    def execute_with_notifications(*args)
+      payload = args.first.dup
+      ActiveSupport::Notifications.instrument("execute.rsolr_client", payload) do
+         payload[:response] = execute_without_notifications(*args)
+      end
+    end
+
+    module ClassMethods
+      def enable_notifications! 
+        self.class_exec do
+          unless method_defined?(:execute_without_notifications)
+            alias_method :execute_without_notifications, :execute 
+            alias_method :execute, :execute_with_notifications
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rsolr-footnotes/railtie.rb

@@ -0,0 +1,9 @@
+require 'rsolr-footnotes'
+require 'rails'
+
+module RsolrFootnotes
+  class Railtie < Rails::Railtie
+    RsolrFootnotes.load!
+    Footnotes::Filter.notes += [:rsolr_requests]
+  end
+end

data/lib/rsolr-footnotes.rb

@@ -0,0 +1,24 @@
+require 'rsolr'
+require 'rails-footnotes'
+require 'rails-footnotes/footnotes'
+require 'rails-footnotes/notes/abstract_note'
+require 'active_support/notifications'
+
+module RsolrFootnotes
+  # Load the plugin and footnote pane
+  def self.load!
+    Dir[File.join(File.dirname(__FILE__), 'notes', '*.rb')].each { |note| require note }
+    self.setup_rsolr_notifications!
+  end
+
+  # Inject notifications into RSolr
+  def self.setup_rsolr_notifications!
+    require 'rsolr-ext/notifications'
+
+    RSolr::Client.send(:include, RSolr::Ext::Notifications)
+    RSolr::Client.enable_notifications!
+  end
+
+  require File.join(File.dirname(__FILE__), 'rsolr-footnotes', 'railtie') if defined?(Rails)
+
+end

data/rsolr-footnotes.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rsolr-footnotes}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Beer"]
+  s.date = %q{2011-05-07}
+  s.email = %q{chris@cbeer.info}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/notes/rsolr_requests_note.rb",
+    "lib/rsolr-ext/notifications.rb",
+    "lib/rsolr-footnotes.rb",
+    "lib/rsolr-footnotes/railtie.rb",
+    "rsolr-footnotes.gemspec",
+    "test/helper.rb",
+    "test/test_rsolr-footnotes.rb",
+    "test/test_rsolr-notifications.rb"
+  ]
+  s.homepage = %q{http://github.com/cbeer/rsolr-footnotes}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{rails-footnotes for rsolr}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_rsolr-footnotes.rb",
+    "test/test_rsolr-notifications.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<rails-footnotes>, [">= 0"])
+      s.add_runtime_dependency(%q<rsolr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<rails-footnotes>, [">= 0"])
+      s.add_dependency(%q<rsolr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<rails-footnotes>, [">= 0"])
+    s.add_dependency(%q<rsolr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+require 'rails'
+require 'active_support'
+require 'active_support/all'
+require 'rails-footnotes'
+require 'rails-footnotes/notes/abstract_note'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rsolr-footnotes'
+
+class Test::Unit::TestCase
+end

data/test/test_rsolr-footnotes.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestRsolrFootnotes < Test::Unit::TestCase
+  def setup
+    @mock_controller = mock()
+    RsolrFootnotes.setup_rsolr_notifications!
+
+    Footnotes::Notes::RsolrRequestsNote.start!(@mock_controller)
+
+    @note = Footnotes::Notes::RsolrRequestsNote.new(@mock_controller)
+    @mock_connection = mock()
+    @mock_connection.expects(:execute).returns({:body => '{}', :headers => nil, :status => 200})
+
+    @solr = RSolr.connect :url => 'http://solrserver.example.com'
+    @solr.expects(:connection).returns(@mock_connection)
+
+  end
+
+  should "add notifications to rsolr" do
+    @solr.head("admin/ping")
+    assert_equal 1, @note.events.length
+    assert_equal "admin/ping", @note.events.first.path
+  end
+end

data/test/test_rsolr-notifications.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestRsolrNotifications < Test::Unit::TestCase
+  should "add notifications to rsolr" do
+    RsolrFootnotes.setup_rsolr_notifications!
+
+    @events = []
+    ActiveSupport::Notifications.subscribe("execute.rsolr_client") do |*args|
+      @events <<  ActiveSupport::Notifications::Event.new(*args)
+    end
+
+    solr = RSolr.connect :url => 'http://solrserver.example.com'
+
+    @mock_connection = mock()
+    @mock_connection.expects(:execute).returns({:body => '{}', :headers => nil, :status => 200})
+    solr.expects(:connection).returns(@mock_connection)
+
+    solr.head("admin/ping")
+
+    assert_equal 1, @events.length
+    assert_equal({}, @events.first.payload[:response])
+
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: rsolr-footnotes
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rails
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rails-footnotes
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rsolr
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mocha
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id009
+  prerelease: false
+description: 
+email: chris@cbeer.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/notes/rsolr_requests_note.rb
+- lib/rsolr-ext/notifications.rb
+- lib/rsolr-footnotes.rb
+- lib/rsolr-footnotes/railtie.rb
+- rsolr-footnotes.gemspec
+- test/helper.rb
+- test/test_rsolr-footnotes.rb
+- test/test_rsolr-notifications.rb
+has_rdoc: true
+homepage: http://github.com/cbeer/rsolr-footnotes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: rails-footnotes for rsolr
+test_files: 
+- test/helper.rb
+- test/test_rsolr-footnotes.rb
+- test/test_rsolr-notifications.rb