oculus 0.9.2 → 0.9.3

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+## 0.9.3 (June 19, 2012)
+
+Breaking Changes:
+
+* `Oculus.cache_path` removed, please use `Oculus.storage_options[:cache_path]`
+  instead.
+
+Features:
+
+* Support for database-backed result storage (SequelStore). Usage:
+
+        Oculus.storage_options = {
+          adapter: 'sequel',
+          uri:     'mysql://localhost/your_db',
+          table:   'your_table'                 # default: oculus
+        }
+
+  *Jonathan Rudenberg*
+
+* Hover actions for the SQL statement on the query detail page, to send it to
+  the editor or rerun it.
+
+* Command-R/Ctrl-R executes the query instead of reloading the page in most
+  browsers.
+
+Bugfixes:
+
+* Escape special characters in query results.
+
+  *Jonathan Rudenberg*
+
+## 0.9.2 (June 2, 2012)
+
+Initial public release

data/README.md

@@ -10,7 +10,7 @@ and the results they returned, so your research is always at hand, easy to share
 and easy to repeat or reproduce in the future.
 
 **Oculus will not prevent you from doing stupid things! I recommend using a
-readonly MySQL account.**
+readonly SQL account.**
 
 ## Installation
 

data/Rakefile

@@ -9,7 +9,7 @@ require 'pg'
 desc 'Run RSpec tests'
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = %w[--color --format documentation]
-  task.pattern    = 'spec/*_spec.rb'
+  task.pattern    = 'spec/**/*_spec.rb'
 end
 
 desc 'Run Cucumber features'
@@ -44,12 +44,12 @@ namespace :db do
 
       # Postgres
       #
-      client = PG::Connection.new(:host => "localhost", :dbname => "postgres")
+      client = PG::Connection.new(:host => "localhost", :user => "postgres", :dbname => "postgres")
       client.query "DROP DATABASE IF EXISTS oculus_test"
       client.query "CREATE DATABASE oculus_test"
       client.close
 
-      client = PG::Connection.new(:host => "localhost", :dbname => "oculus_test")
+      client = PG::Connection.new(:host => "localhost", :user => "postgres", :dbname => "oculus_test")
       client.query %[
         CREATE TABLE oculus_users (
           id INT NOT NULL UNIQUE,

data/bin/oculus

@@ -31,6 +31,7 @@ Vegas::Runner.new(Oculus::Server, 'oculus') do |runner, opts, app|
     Oculus.connection_options[:adapter] = adapter
   end
   opts.on("-d", "--data DIRECTORY", "Data cache path (default: tmp/data)") do |path|
-    Oculus.cache_path = path
+    Oculus.storage_options[:adapter] = "file"
+    Oculus.storage_options[:cache_path] = path
   end
 end

data/features/support/env.rb

@@ -7,7 +7,11 @@ require 'capybara/cucumber'
 Capybara.app = Oculus::Server
 Capybara.default_wait_time = 10
 
-Oculus.cache_path = 'tmp/test_cache'
+Oculus.storage_options = {
+  :adapter => 'file',
+  :cache_path => 'tmp/test_cache'
+}
+
 Oculus.connection_options = {
   :adapter => 'mysql',
   :host => 'localhost',

data/lib/oculus.rb

@@ -7,17 +7,18 @@ module Oculus
   extend self
 
   DEFAULT_CONNECTION_OPTIONS = { :adapter => 'mysql', :host => 'localhost' }
+  DEFAULT_STORAGE_OPTIONS = { :adapter => 'file', :host => 'localhost' }
 
-  attr_writer :cache_path
+  attr_writer :data_store
 
-  def cache_path
-    @cache_path ||= 'tmp/data'
+  def data_store
+    @data_store ||= Oculus::Storage.create(Oculus.storage_options)
   end
 
-  attr_writer :data_store
+  attr_writer :storage_options
 
-  def data_store
-    @data_store ||= Oculus::Storage::FileStore.new(Oculus.cache_path)
+  def storage_options
+    @storage_options ||= DEFAULT_STORAGE_OPTIONS
   end
 
   attr_writer :connection_options

data/lib/oculus/query.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 module Oculus
   class Query
     attr_accessor :id

data/lib/oculus/server/public/css/style.css

@@ -118,6 +118,21 @@ button.starred .unstarred-contents {
   display: none;
 }
 
+#query-sql-container {
+  position: relative;
+}
+
+#query-sql-actions {
+  display:none;
+  position: absolute;
+  top: 4px;
+  right: 5px;
+}
+
+#query-sql-container:hover #query-sql-actions {
+  display: block;
+}
+
 #loading .cancel-container {
   float: right;
   margin: -1px -26px 0 0;

data/lib/oculus/server/public/js/application.js

@@ -165,7 +165,7 @@ QueryEditor.prototype.initCodeMirror = function() {
 QueryEditor.prototype.bindEvents = function() {
   var self = this;
   $(document).on('keydown', 'form', function(e) {
-    if ((e.keyCode === 13 && (e.ctrlKey || e.metaKey)) || (e.metaKey && e.altKey && e.keyCode === 82)) {
+    if ((e.keyCode === 13 || e.keyCode === 82) && (e.ctrlKey || e.metaKey)) {
       e.preventDefault();
 
       // CodeMirror normally saves itself automatically, but since there is no

data/lib/oculus/server/views/index.erb

@@ -2,7 +2,7 @@
 
 <form id="query-form" method="POST" action="/queries">
   <div id="editor-container">
-    <textarea name="query" id="query-field"></textarea>
+    <textarea name="query" id="query-field"><%= h(params[:q]) %></textarea>
   </div>
   <div class="form-actions">
     <input type="submit" class="btn" name="submit" value="Run" />
@@ -86,7 +86,7 @@
         var row = $('<tr></tr>');
 
         for (var j = 0; j < result.length; j++) {
-          row.append('<td>' + result[j] + '</td>');
+          row.append($('<td></td>').text(result[j]));
         }
 
         container.append(row);
@@ -102,4 +102,8 @@
   });
 
   editor.focus();
+
+  <% if params[:run] %>
+  editor.submit();
+  <% end %>
 </script>

data/lib/oculus/server/views/show.erb

@@ -38,7 +38,13 @@
   <input type="submit" class="btn" name="submit" value="Save" />
 </form>
 
-<pre class="cm-s-default"><%= @query.query %></pre>
+<div id="query-sql-container">
+  <div id="query-sql-actions">
+    <a class="btn btn-mini" href="/?q=<%= URI.escape(@query.query) %>"><i class="icon-edit"></i> Send to editor</a>
+    <a class="btn btn-mini" href="/?q=<%= URI.escape(@query.query) %>&run=1"><i class="icon-repeat"></i> Rerun</a>
+  </div>
+  <pre class="cm-s-default"><%= @query.query %></pre>
+</div>
 
 <div id="loading">
   <div class="alert">
@@ -96,7 +102,7 @@
         var row = $('<tr></tr>');
 
         for (var j = 0; j < result.length; j++) {
-          row.append('<td>' + result[j] + '</td>');
+          row.append($('<td></td>').text(result[j]));
         }
 
         container.append(row);

data/lib/oculus/storage.rb

@@ -1,7 +1,19 @@
-require 'oculus/storage/file_store'
-
 module Oculus
   module Storage
     class QueryNotFound < RuntimeError; end
+    class AdapterNotFound < StandardError; end
+
+    def self.create(options)
+      case options[:adapter]
+      when 'file'
+        require 'oculus/storage/file_store'
+        FileStore
+      when 'sequel'
+        require 'oculus/storage/sequel_store'
+        SequelStore
+      else
+        raise AdapterNotFound, "#{options[:adapter]} is not currently implemented. You should write it!"
+      end.new(options)
+    end
   end
 end

data/lib/oculus/storage/file_store.rb

@@ -5,8 +5,8 @@ require 'fileutils'
 module Oculus
   module Storage
     class FileStore
-      def initialize(root)
-        @root = root
+      def initialize(options)
+        @root = options[:cache_path] || 'tmp/data'
       end
 
       def all_queries

data/lib/oculus/storage/sequel_store.rb

@@ -0,0 +1,108 @@
+require 'sequel'
+require 'csv'
+
+module Oculus
+  module Storage
+    class SequelStore
+      attr_reader :table_name
+
+      def initialize(options = {})
+        raise ArgumentError, "URI is required" unless options[:uri]
+        @uri = options[:uri]
+        @table_name = options[:table] || :oculus
+        create_table
+      end
+
+      def with_db
+        db = Sequel.connect(@uri, :encoding => 'utf8')
+        result = yield db
+        db.disconnect
+        result
+      end
+
+      def with_table
+        with_db { |db| yield db.from(@table_name) }
+      end
+
+      def all_queries
+        with_table do |table|
+          to_queries table.order(:id.desc)
+        end
+      end
+
+      def starred_queries
+        with_table do |table|
+          to_queries table.where(:starred => true).order(:id.desc)
+        end
+      end
+
+      def save_query(query)
+        attrs = serialize(query)
+        with_table do |table|
+          if query.id
+            table.where(:id => query.id).update(attrs)
+          else
+            query.id = table.insert(attrs)
+          end
+        end
+      end
+
+      def load_query(id)
+        with_table do |table|
+          if query = table.where(:id => id).first
+            deserialize query
+          else
+            raise QueryNotFound, id
+          end
+        end
+      end
+
+      def delete_query(id)
+        with_table do |table|
+          raise ArgumentError unless id.to_i > 0
+          raise QueryNotFound, id unless table.where(:id => id).delete == 1
+        end
+      end
+
+      def create_table
+        with_db do |db|
+          db.create_table?(table_name) do
+            primary_key :id
+            Integer :thread_id
+            String :name
+            String :author
+            String :query
+            String :results
+            Time :started_at
+            Time :finished_at
+            TrueClass :starred
+            String :error
+          end
+        end
+      end
+
+      def drop_table
+        with_db { |db| db.drop_table(table_name) }
+      end
+
+      private
+
+      def to_queries(rows)
+        rows.map { |r| Query.new deserialize(r) }
+      end
+
+      def deserialize(row)
+        row[:results] = row[:results] ? CSV.new(row[:results]).to_a : []
+        row.delete(:error) unless row[:error]
+        row
+      end
+
+      def serialize(query)
+        attrs = query.attributes
+        attrs[:starred] ||= false
+        attrs[:results] = query.to_csv if query.results
+        attrs
+      end
+    end
+  end
+end

data/lib/oculus/version.rb

@@ -1,3 +1,3 @@
 module Oculus
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/oculus.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "mysql2",  [">= 0.3.11"]
   gem.add_development_dependency "pg",      [">= 0.13.2"]
+  gem.add_development_dependency "sequel",  [">= 3"]
 end

data/spec/connection/postgres_spec.rb

@@ -2,7 +2,7 @@ require 'oculus'
 require 'oculus/connection/postgres'
 
 describe Oculus::Connection::Postgres do
-  subject { Oculus::Connection::Postgres.new(:host => 'localhost', :database => 'oculus_test') }
+  subject { Oculus::Connection::Postgres.new(:host => 'localhost', :username => 'postgres', :database => 'oculus_test') }
 
   it "fetches a result set" do
     subject.execute("SELECT * FROM oculus_users").should == [['id', 'name'],

data/spec/connection_spec.rb

@@ -18,14 +18,14 @@ describe Oculus::Connection do
 
   describe "postgres adapter option" do
     it "returns a new instance of Postgres adapter" do
-      adapter = Oculus::Connection.connect adapter: 'postgres', database: 'oculus_test'
+      adapter = Oculus::Connection.connect adapter: 'postgres', database: 'oculus_test', :host => 'localhost', :username => 'postgres'
       adapter.should be_an_instance_of Oculus::Connection::Postgres
     end
   end
 
   describe "pg adapter alias" do
     it "returns a new instance of Postgres adapter" do
-      adapter = Oculus::Connection.connect adapter: 'pg', database: 'oculus_test'
+      adapter = Oculus::Connection.connect adapter: 'pg', database: 'oculus_test', :host => 'localhost', :username => 'postgres'
       adapter.should be_an_instance_of Oculus::Connection::Postgres
     end
   end

data/spec/{file_store_spec.rb → storage_spec.rb}

@@ -1,8 +1,28 @@
 require 'oculus'
+require 'oculus/storage/file_store'
+require 'oculus/storage/sequel_store'
+
+describe Oculus::Storage do
+  describe "#create" do
+    it "should initialize FileStore" do
+      Oculus::Storage::FileStore.should_receive(:new)
+      Oculus::Storage.create(:adapter => 'file')
+    end
 
-describe Oculus::Storage::FileStore do
-  subject { Oculus::Storage::FileStore.new('tmp/test_cache') }
+    it "should initialize SequelStore" do
+      Oculus::Storage::SequelStore.should_receive(:new)
+      Oculus::Storage.create(:adapter => 'sequel')
+    end
 
+    it "should forward its options to the storage" do
+      opts = { :adapter => 'file' }
+      Oculus::Storage::FileStore.should_receive(:new).with(opts)
+      Oculus::Storage.create(opts)
+    end
+  end
+end
+
+shared_examples "storage" do |subject|
   let(:query) do
     Oculus::Query.new(:name      => "All users",
                       :query     => "SELECT * FROM oculus_users",
@@ -27,18 +47,10 @@ describe Oculus::Storage::FileStore do
                       :error     => "You have an error in your SQL syntax")
   end
 
-  before do
-    FileUtils.mkdir_p('tmp/test_cache')
-  end
-
-  after do
-    FileUtils.rm_r('tmp/test_cache')
-  end
-
-  it "round-trips a query with no results to disk" do
+  it "round-trips a query with no results" do
     query = Oculus::Query.new(:name => "Unfinished query", :author => "Me")
-    subject.save_query(query)
-    subject.load_query(query.id).should == {
+    storage.save_query(query)
+    storage.load_query(query.id).should == {
       :id => query.id,
       :name => query.name,
       :author => query.author,
@@ -51,9 +63,9 @@ describe Oculus::Storage::FileStore do
     }
   end
 
-  it "round-trips a query with an error to disk" do
-    subject.save_query(broken_query)
-    subject.load_query(broken_query.id).should == {
+  it "round-trips a query with an error" do
+    storage.save_query(broken_query)
+    storage.load_query(broken_query.id).should == {
       :id => broken_query.id,
       :name => broken_query.name,
       :error => broken_query.error,
@@ -67,9 +79,9 @@ describe Oculus::Storage::FileStore do
     }
   end
 
-  it "round-trips a query to disk" do
-    subject.save_query(query)
-    subject.load_query(query.id).should == {
+  it "round-trips a query" do
+    storage.save_query(query)
+    storage.load_query(query.id).should == {
       :id => query.id,
       :name => query.name,
       :author => query.author,
@@ -83,75 +95,100 @@ describe Oculus::Storage::FileStore do
   end
 
   it "doesn't overwrite an existing query id when saving" do
-    subject.save_query(query)
+    storage.save_query(query)
     original_id = query.id
-    subject.save_query(query)
+    storage.save_query(query)
     query.id.should == original_id
   end
 
   it "raises QueryNotFound for missing queries" do
     lambda {
-      subject.load_query(39827493)
+      storage.load_query(39827493)
     }.should raise_error(Oculus::Storage::QueryNotFound)
   end
 
   it "fetches all queries in reverse chronological order" do
-    subject.save_query(query)
-    subject.save_query(other_query)
+    storage.save_query(query)
+    storage.save_query(other_query)
 
-    subject.all_queries.map(&:results).should == [other_query.results, query.results]
+    storage.all_queries.map(&:results).should == [other_query.results, query.results]
   end
 
   it "fetches starred queries" do
     query.starred = true
-    subject.save_query(query)
-    subject.save_query(other_query)
+    storage.save_query(query)
+    storage.save_query(other_query)
 
-    results = subject.starred_queries
+    results = storage.starred_queries
     results.map(&:results).should == [query.results]
     results.first.starred.should be true
   end
 
   it "deletes queries" do
-    subject.save_query(query)
-    subject.load_query(query.id)[:name].should == query.name
-    subject.delete_query(query.id)
+    storage.save_query(query)
+    storage.load_query(query.id)[:name].should == query.name
+    storage.delete_query(query.id)
 
     lambda {
-      subject.load_query(query.id)
+      storage.load_query(query.id)
     }.should raise_error(Oculus::Storage::QueryNotFound)
   end
 
   it "raises QueryNotFound when deleting a nonexistent query" do
     lambda {
-      subject.delete_query(10983645)
+      storage.delete_query(10983645)
     }.should raise_error(Oculus::Storage::QueryNotFound)
   end
 
   it "sanitizes query IDs" do
     lambda {
-      subject.delete_query('..')
+      storage.delete_query('..')
     }.should raise_error(ArgumentError)
   end
+end
+
+describe Oculus::Storage::FileStore do
+  it_behaves_like "storage" do
+    let(:storage) { Oculus::Storage::FileStore.new(:cache_path => 'tmp/test_cache') }
 
-  context "when cache dir does not exist (like for a new install)" do
     before do
+      FileUtils.mkdir_p('tmp/test_cache')
+    end
+
+    after do
       FileUtils.rm_r('tmp/test_cache')
     end
 
-    it "round-trips a query to disk" do
-      subject.save_query(query)
-      subject.load_query(query.id).should == {
-        :id => query.id,
-        :name => query.name,
-        :author => query.author,
-        :query => query.query,
-        :results => query.results,
-        :thread_id => query.thread_id,
-        :starred => false,
-        :started_at => query.started_at,
-        :finished_at => query.finished_at
-      }
+    context "when cache dir does not exist (like for a new install)" do
+      before do
+        FileUtils.rm_r('tmp/test_cache')
+      end
+
+      it "round-trips a query to disk" do
+        storage.save_query(query)
+        storage.load_query(query.id).should == {
+          :id => query.id,
+          :name => query.name,
+          :author => query.author,
+          :query => query.query,
+          :results => query.results,
+          :thread_id => query.thread_id,
+          :starred => false,
+          :started_at => query.started_at,
+          :finished_at => query.finished_at
+        }
+      end
+    end
+  end
+end
+
+describe Oculus::Storage::SequelStore do
+  it_behaves_like "storage" do
+    let(:storage) { Oculus::Storage::SequelStore.new(:uri => 'postgres://postgres@localhost/oculus_test') }
+
+    before do
+      storage.drop_table
+      storage.create_table
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oculus
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -139,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Oculus is a web-based logging SQL client.  It keeps a history of your
   queries and the results they returned, so your research is always at hand, easy
   to share and easy to repeat or reproduce in the future.
@@ -151,6 +167,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -186,14 +203,15 @@ files:
 - lib/oculus/server/views/starred.erb
 - lib/oculus/storage.rb
 - lib/oculus/storage/file_store.rb
+- lib/oculus/storage/sequel_store.rb
 - lib/oculus/version.rb
 - oculus.gemspec
 - spec/connection/mysql2_spec.rb
 - spec/connection/postgres_spec.rb
 - spec/connection_spec.rb
-- spec/file_store_spec.rb
 - spec/query_presenter_spec.rb
 - spec/query_spec.rb
+- spec/storage_spec.rb
 homepage: http://oculusapp.com
 licenses: []
 post_install_message: