adhoq 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e0a340afd6e9ff7f1d8ba89b6b85f206dcb7f74
-  data.tar.gz: 39043bf804ec87a7183aaa331a1858ea6fc27d86
+  metadata.gz: e44fcb3a79e299b2a337652f8439d58cd4babe71
+  data.tar.gz: 5312feb5fee5890cae4b27f48c541a36b937ef0e
 SHA512:
-  metadata.gz: fd569b25d51fff86895925ecf0774c01b6cf48f8a6b1ee533b230caf5f19ceaac35be0ea70ef9473fd8a9e82ba8cec21cd3bae58f1be30f1f0bc0ccdb805650e
-  data.tar.gz: 2bd75bfaaaee3ca6ede743e59b334f198ec74a4d8a2fed174e949ca2c9abdd113d0d0810be83e9a143e55ba4d542db660a2a5d27f3ef9c6a0abfbbcf97705c1d
+  metadata.gz: 19546d4c89ab4cbb7da38b46e02a7cc4bfe091d1d00bbd3110d186a26586f929cdccdab8bf2bf12f322cfaf052297d102eefcfe3660c47012da952a0464baae9
+  data.tar.gz: 914e24aabd3a6a896c62e3c276642f8a6ba37d85d8d6f285363e5c1dbf6b4a3025f714f065989475b4042edfb8ab513ef2462974fb45214fa754c5f640ef345e

data/README.md

@@ -1,4 +1,4 @@
-Adhoq [![Build Status](https://travis-ci.org/esminc/adhoq.svg)](https://travis-ci.org/esminc/adhoq) [![Code Climate](https://codeclimate.com/github/esminc/adhoq/badges/gpa.svg)](https://codeclimate.com/github/esminc/adhoq)
+Adhoq [![Build Status](https://travis-ci.org/esminc/adhoq.svg)](https://travis-ci.org/esminc/adhoq) [![Code Climate](https://codeclimate.com/github/esminc/adhoq/badges/gpa.svg)](https://codeclimate.com/github/esminc/adhoq) [![Test Coverage](https://codeclimate.com/github/esminc/adhoq/badges/coverage.svg)](https://codeclimate.com/github/esminc/adhoq/coverage)
 ====
 
 Rails engine to generate instant reports from adhoc SQL query.
@@ -7,16 +7,16 @@ Rails engine to generate instant reports from adhoc SQL query.
 
 ## Features
 
-- Export ad-hoc SQL result to .xlsx file
+- Export ad-hoc SQL reports in some formats:
+  - .csv
+  - .json
+  - .xlsx
 - Persist generated report as local file or in AWS S3
 - Rails 4.x & 3.2 support
 - Nice administration console with rails engine
 
 ### Future planning
 
-- Export reports in some formats:
-  - [ ] .csv
-  - [ ] .json
 - [ ] Label data substitution
 
 ## Installation
@@ -56,7 +56,7 @@ Rails.application.routes.draw do
 end
 ```
 
-Edit initialization file in `config/initializer/adhoq.rb`
+Edit initialization file in `config/initializers/adhoq.rb`
 
 ```ruby
 Adhoq.configure do |config|

data/app/assets/javascripts/adhoq/current_tables.js.coffee

@@ -1,4 +1,18 @@
-Adhoq.loadCurrentTableTabOnce = ($el)->
-  pane = $("#{$el.attr('href')}:has(.loading)")
+loadCurrentTableTabOnce = ($el)->
+  $el.load($el.find('a.loading').attr('href'))
+
+Adhoq.toggleCurrentTables = (action, elements)->
+  loadCurrentTableTabOnce($('#current-tables'))
+
+  $main   = $(elements.main)
+  $tables = $(elements.tables)
+
+  if action is 'show'
+    $main.addClass('col-md-6').removeClass('col-md-12')
+    $tables.addClass('col-md-6').show()
+  else
+    $main.addClass('col-md-12').removeClass('col-md-6')
+    $tables.addClass('col-md-6').hide()
+
+  true
 
-  pane.load(pane.find('a.loading').attr('href'))

data/app/assets/javascripts/adhoq/previewer.js.coffee

@@ -2,8 +2,10 @@ class Previewer
   constructor: (@el)->
 
   init: ->
+    @el.on 'adhoq:updatePreview', => @update()
+
     @el.on 'click', =>
-      @update()
+      @el.trigger 'adhoq:updatePreview'
       false
 
   update: ->
@@ -23,3 +25,10 @@ class Previewer
 
 Adhoq.enablePreview = ($el)->
   (new Previewer($el)).init()
+
+Adhoq.enablePreviewKeybordShortCut= ($textarea, previewSelector)->
+  $textarea.on 'keyup', (ev)->
+    if(ev.ctrlKey && ev.keyCode is 82)
+      $(previewSelector).trigger('adhoq:updatePreview')
+
+    false

data/app/assets/stylesheets/adhoq/adhoq.css.sass

@@ -21,22 +21,41 @@ $short-span:  $font-size-base / 2
     margin: 0 10px
     font-size: $font-size-base
 
-#sidebar
-  h2 a.new-query
-    float: right
+#queries
+  a.new-query
+    margin-bottom: $short-span
 
-  ul.queries
+  ol.queries-index
     li.panel
       margin-bottom: $short-span
 
-    .panel-heading h2
-      margin:   0
-      font-size: $font-size-base
+    .panel-heading
+      padding: $short-span $short-span * 2
+      h2
+        margin:   0
+        font-size: $font-size-base
 
     p.panel-body.description
       margin-bottom: 0
+      font-size: $font-size-base * 0.9
+
+#the-query
+  .page-header
+    margin-top: 0
+    h1
+      margin-top: 0
+
+      small
+        font-size: $font-size-base
 
 form.query-form
+  margin-bottom: 30px
+
+  h1
+    font-size: $font-size-base
+    margin-top: $font-size-base / 2
+    margin-bottom: $font-size-base / 4
+
   textarea#query_query
     font-family: monospace
 
@@ -57,10 +76,17 @@ form.query-form
   padding-left: $short-span / 2
 
 #current-tables
+  display: none
   font-size: $font-size-base * 0.9
 
+  h3
+    font-size: $font-size-base
+    margin-top: $font-size-base / 2
+    margin-bottom: $font-size-base / 4
+
+    small
+      margin-left: $font-size-base
   table
-    width: 800px
 
     caption
       text-align: left
@@ -95,7 +121,11 @@ form.query-form
 
   .tab-pane > h3
     font-size: $font-size-base * 1.5
+    margin-top: $font-size-base / 2
 
     small
       font-size: $font-size-base
       margin-left: $font-size-base
+
+.js-preview-result table, .js-explain-result pre
+  font-family: monospace

data/app/controllers/adhoq/application_controller.rb

@@ -1,5 +1,7 @@
 module Adhoq
   class ApplicationController < ::ApplicationController
+    layout 'adhoq/application'
+
     include Adhoq::AuthorizationMethods
   end
 end

data/app/controllers/adhoq/current_tables_controller.rb

@@ -3,8 +3,11 @@ module Adhoq
     before_filter :eager_load_models
 
     def index
+      hidden_model_names = Array(Adhoq.config.hidden_model_names)
+      hidden_model_names << 'ActiveRecord::SchemaMigration'
+
       @ar_classes = ActiveRecord::Base.subclasses.
-        reject {|klass| klass.name == 'ActiveRecord::SchemaMigration' }.
+        reject {|klass| hidden_model_names.include?(klass.name) }.
         sort_by(&:name)
 
       render layout: false

data/app/controllers/adhoq/executions_controller.rb

@@ -7,19 +7,40 @@ module Adhoq
     end
 
     def create
+      async_execution? ? asynced_create : synced_create
+    end
+
+    private
+
+    def synced_create
       @execution = current_query.execute!(params[:execution][:report_format])
 
-      redirect_to current_query
+      if @execution.report.on_the_fly?
+        respond_report(@execution.report)
+      else
+        redirect_to current_query
+      end
     end
 
-    private
+    def asynced_create
+      Adhoq::ExecuteJob.perform_later(current_query, params[:execution][:report_format])
+      redirect_to current_query
+    end
 
     def current_query
       @query ||= Adhoq::Query.find(params[:query_id])
     end
 
     def respond_report(report)
-      send_data report.data, type: report.mime_type, filename: report.name, disposition: 'attachment'
+      if Adhoq.current_storage.direct_download?
+        redirect_to report.data_url
+      else
+        send_data report.data, type: report.mime_type, filename: report.name, disposition: 'attachment'
+      end
+    end
+
+    def async_execution?
+      Adhoq.config.async_execution? && !Adhoq.current_storage.is_a?(Adhoq::Storage::OnTheFly)
     end
   end
 end

data/app/controllers/adhoq/explains_controller.rb

@@ -1,5 +1,5 @@
 module Adhoq
-  class ExplainsController < ApplicationController
+  class ExplainsController < Adhoq::ApplicationController
     layout false
 
     def create

data/app/controllers/adhoq/previews_controller.rb

@@ -1,5 +1,5 @@
 module Adhoq
-  class PreviewsController < ApplicationController
+  class PreviewsController < Adhoq::ApplicationController
     layout false
 
     def create

data/app/controllers/adhoq/queries_controller.rb

@@ -1,5 +1,5 @@
 module Adhoq
-  class QueriesController < ApplicationController
+  class QueriesController < Adhoq::ApplicationController
     def index
       @queries = Adhoq::Query.recent_first
     end

data/app/decorators/adhoq/execution_decorator.rb

@@ -0,0 +1,20 @@
+module Adhoq::ExecutionDecorator
+  def status_label
+    content_tag :span, class: ["label", status_label_class] do
+      status
+    end
+  end
+
+  def status_label_class
+    case status
+    when "success"
+      "label-success"
+    when "failure"
+      "label-danger"
+    when "requested"
+      "label-default"
+    else
+      "label-default"
+    end
+  end
+end

data/app/decorators/adhoq/query_decorator.rb

@@ -0,0 +1,9 @@
+require 'rouge'
+
+module Adhoq::QueryDecorator
+  def query_with_highlight
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight query')
+    lexer = Rouge::Lexers::SQL.new
+    formatter.format(lexer.lex(query))
+  end
+end

data/app/helpers/adhoq/application_helper.rb

@@ -16,9 +16,19 @@ module Adhoq
       if defined?(ActiveRecord::SchemaMigration)
         ActiveRecord::SchemaMigration.maximum(:version)
       else
-        result = Adhoq::Executor.select("SELECT MAX(version) AS current_version FROM #{ActiveRecord::Migrator.schema_migrations_table_name}")
-        result.rows.first
+        connection = Adhoq::Executor::ConnectionWrapper.new
+        result = connection.select("SELECT MAX(version) AS current_version FROM #{ActiveRecord::Migrator.schema_migrations_table_name}")
+        result.rows.first.first
       end
     end
+
+    # TODO extract into presenter
+    def query_friendly_name(query)
+      "Query: #{query.name}"
+    end
+
+    def table_order_key(ar_class)
+      ar_class.primary_key || ar_class.columns.first.name
+    end
   end
 end

data/app/jobs/adhoq/execute_job.rb

@@ -0,0 +1,11 @@
+if defined?(ActiveJob)
+  class Adhoq::ExecuteJob < ActiveJob::Base
+    queue_as do
+      Adhoq.config.job_queue_name.try(:to_sym) || :default
+    end
+
+    def perform(query, *args)
+      query.execute!(*args)
+    end
+  end
+end

data/app/models/adhoq/execution.rb

@@ -9,6 +9,9 @@ module Adhoq
 
     def generate_report!
       build_report.generate!
+      update_attributes(status: :success)
+    rescue
+      update_attributes(status: :failure)
     end
 
     def name
@@ -16,12 +19,7 @@ module Adhoq
     end
 
     def success?
-      report.try(:available?)
-    end
-
-    # TODO go decorator or view model or so
-    def status_label
-      success? ? :success : :failure
+      report.try(:available?) || status == "success"
     end
   end
 end

data/app/models/adhoq/report.rb

@@ -12,6 +12,10 @@ module Adhoq
       save!
     end
 
+    def on_the_fly?
+      storage.start_with?(Adhoq::Storage::OnTheFly::PREFIX)
+    end
+
     def available?
       identifier.present? && (storage == Adhoq.current_storage.identifier)
     end
@@ -20,6 +24,10 @@ module Adhoq
       storage.get(identifier)
     end
 
+    def data_url(storage = Adhoq.current_storage)
+      storage.get_url(self)
+    end
+
     def mime_type
       Adhoq::Reporter.lookup(execution.report_format).mime_type
     end

data/app/views/adhoq/current_tables/index.html.slim

@@ -1,10 +1,14 @@
 h3
-  | Current database schema
+  i.fa.fa-database.fa-pad-r
+  | Current tables
   small= "Version #{schema_version}"
+  .pull-right
+    button.close[data-trigger="toggleCurrentTables" role='close']
+      span[aria-hidden=true] ×
 
 ul.list-unstyled.tables
   - @ar_classes.each do |ar_class|
-    - first_record = ar_class.unscoped.order(:id).first
+    - first_record = ar_class.unscoped.order(table_order_key(ar_class)).first
 
     li.ar_class data-table-name=ar_class.table_name
       table.table.table-striped.table-hover.table-bordered
@@ -14,12 +18,11 @@ ul.list-unstyled.tables
         thead
           tr
             th.col-sm-1.pk PK
-            th.col-sm-2.name  Name
-            th.col-sm-1.type  Type
+            th.col-sm-3.name  Name
+            th.col-sm-2.type  Type
             th.col-sm-1.null  Non-Null
-            th.col-sm-1.limit Limit
-            th.col-sm-2.default  Default
-            th.col-sm-4.data  unscoped.first
+            th.col-sm-2.limit Limit
+            th.col-sm-3.default  Default
         tbody
           - ar_class.columns.each do |column|
             tr
@@ -29,4 +32,3 @@ ul.list-unstyled.tables
               td.null.icon= column.null ? '' : icon_fa('check')
               td.limit.number= column.limit
               td= column.default
-              td.monospace= first_record.try {|r| truncate(r.read_attribute_before_type_cast(column.name).to_s, length: 50) }

data/app/views/adhoq/queries/_current_tables_leftbar.html.slim

@@ -0,0 +1,9 @@
+#current-tables
+  a.loading[href=current_tables_path]
+
+javascript:
+  $(function() {
+    $(document).on('click', '[data-trigger="toggleCurrentTables"]', function($ev) {
+      Adhoq.toggleCurrentTables($($ev.target).attr('role'), {main: '#main', tables: '#current-tables'});
+    })
+  });

data/app/views/adhoq/queries/_execution.html.slim

@@ -0,0 +1,10 @@
+tr[exec]
+  td.wip
+  td.created_at= exec.created_at.localtime.iso8601
+  td.status
+    = exec.status_label
+  td.report
+    - if exec.success?
+      = link_to(query_execution_path(query, exec, format: exec.report_format), class: 'btn btn-sm btn-default') do
+        i.fa.fa-download.fa-pad-r
+        = exec.report_format

data/app/views/adhoq/queries/_form.html.slim

@@ -1,28 +1,54 @@
-= form_for query, html: {class: 'form form-horizontal query-form', role: 'form'} do |f|
+= form_for query, html: {class: 'form query-form', role: 'form'} do |f|
   .page-header
     h1
-      = title
-      .actions.btn-in-header
-        button.btn.btn-primary
-          i.fa.fa-floppy-o.fa-pad-r
-          | Save
-        - if f.object.persisted?
-          = link_to 'Cancel', f.object, class: 'btn btn-default'
+      = f.label :query, title, class: 'control-label'
+      .pull-right
+        a.btn.btn-default.btn-sm[href='#' data-trigger='toggleCurrentTables' role='show']
+          i.fa.fa-database.fa-pad-r
+          | Show tables
 
   .form-group
-    = f.label :name, class: 'col-sm-2 control-label'
-    .col-sm-8
-      = f.text_field :name, class: 'form-control', required: true
+    = f.text_area :query, class: 'form-control', rows: 15, required: true
 
-  .form-group
-    = f.label :description, class: 'col-sm-2 control-label'
-    .col-sm-8
-      = f.text_area :description, class: 'form-control', required: true
+  .modal.fade#nameAndDesc[role='dialog']
+    .modal-dialog
+      .modal-content
+        .modal-header
+          button.close[data-dismiss='modal' aria-label='Close']
+          button.close[type='button' data-dismiss='modal' aria-label='Close']
+            span[aria-hidden='true'] ×
 
-  .form-group
-    = f.label :query, class: 'col-sm-2 control-label'
-    .col-sm-8
-      = f.text_area :query, class: 'form-control', rows: 10, required: true
+          h4 Add name and description to query
+        .modal-body
+          .form-horizontal
+            .form-group
+              = f.label :name, class: 'control-label col-sm-2'
+              .col-sm-8
+                = f.text_field :name, class: 'form-control', required: true
+
+            .form-group
+              = f.label :description, class: 'control-label col-sm-2'
+              .col-sm-8
+                = f.text_area :description, class: 'form-control', required: true
+        .modal-footer
+          button.btn.btn-primary.center-block
+            i.fa.fa-floppy-o.fa-pad-r
+            | Save
+
+  .actions
+    - if query.persisted?
+      = link_to query do
+        i.fa.fa-arrow-left.fa-pad-r
+        | Cancel
+    - else
+      = link_to :queries do
+        i.fa.fa-arrow-left.fa-pad-r
+        | Back to Index
+
+    .pull-right
+      = link_to '#nameAndDesc', class: 'btn btn-default btn-sm', data: {toggle: 'modal', target: '#nameAndDesc'} do
+        i.fa.fa-floppy-o.fa-pad-r
+        | Save as...
 
 ul.nav.nav-tabs[role='tablist']
   li.active
@@ -33,19 +59,15 @@ ul.nav.nav-tabs[role='tablist']
     a[role='tab' data-toggle='tab' href='#explain' ]
       i.fa.fa-info.fa-pad-r
       | Explain
-  li
-    a[role='tab' data-toggle='tab' href='#current-tables']
-      i.fa.fa-database.fa-pad-r
-      | Tables
 
-.tab-content
+#previews.tab-content
   #preview.tab-pane.active
     h3
       | Query preview
       small
         = link_to preview_path, class: 'js-preview-button', data: {source: '#query_query', result: '.js-preview-result', remote: true, method: 'POST'} do
           i.fa.fa-refresh.fa-pad-r[data-title='Refresh preview']
-          | Reflesh
+          | Refresh
 
     .js-preview-result
       .alert.alert-info Preview is shown here
@@ -56,19 +78,16 @@ ul.nav.nav-tabs[role='tablist']
       small
         = link_to explain_path, class: 'js-explain-button', data: {source: '#query_query', result: '.js-explain-result', remote: true, method: 'POST'} do
           i.fa.fa-refresh.fa-pad-r[data-title='Refresh explain']
-          | Reflesh
+          | Refresh
 
     .js-explain-result
       .alert.alert-info Explain result is shown here
 
-  #current-tables.tab-pane
-    a.loading[href=current_tables_path]
-
 javascript:
   $(function() {
     Adhoq.enablePreview($('#preview a.js-preview-button'));
     Adhoq.enablePreview($('#explain a.js-explain-button'));
 
-    $('a[data-toggle="tab"]').on('show.bs.tab', function(ev) { Adhoq.loadCurrentTableTabOnce($(ev.target)) });
+    Adhoq.enablePreviewKeybordShortCut($('#query_query'), '#previews .tab-pane.active a:has(".fa-refresh")')
   });
 

data/app/views/adhoq/queries/_queries.html.slim

@@ -0,0 +1,14 @@
+- highlight ||= nil
+section
+  = link_to :root, class: 'btn btn-default new-query btn-sm center-block' do
+    i.fa.fa-plus-square.fa-pad-r
+    | New query
+
+  ol.queries-index.list-unstyled
+    - queries.each do |query|
+      - css = (query == highlight) ? 'panel-success' : 'panel-default'
+      li.panel[query, class= css]
+        .panel-heading
+          h2= link_to query.name, query_path(query)
+        p.panel-body.description= query.description
+

data/app/views/adhoq/queries/_query.html.slim

@@ -2,13 +2,18 @@ section.query
   .page-header
     h1
       = query.name
+      .pull-right
+        = link_to [:edit, query], class: 'btn btn-default btn-sm' do
+          i.fa.fa-pencil.fa-pad-r
+          | Edit
+      .clearfix
       small= "Updated at #{l(query.updated_at, format: :short)}"
-      = link_to [:edit, query], class: 'btn btn-default' do
-        i.fa.fa-pencil.fa-pad-r
-        | Edit
   p.description= query.description
 
-  pre.query= query.query
+  css:
+    #{Rouge::Themes::Github.render(scope: '.highlight')}
+
+  = raw query.query_with_highlight
 
   section.new-execution
     h2 Create report
@@ -21,23 +26,14 @@ section.query
 
   section.past-executions
     h2 Reports
-    .col-md-10
-      table.executions.table.table-striped.table-hover
-        thead
-          tr
-            th.wip  
-            th.created_at= human(Adhoq::Execution, :created_at)
-            th.status=     human(Adhoq::Execution, :status)
-            th.report
-        tbody
-          - query.executions.recent_first.each do |exec|
-            tr[exec]
-              td.wip
-              td.created_at= exec.created_at.localtime.iso8601
-              td.status
-                span.label[class=(exec.success? ? 'label-success' : 'label-danger')]= exec.status_label
-              td.report
-                - if exec.success?
-                  = link_to(adhoq.query_execution_path(query, exec, format: exec.report_format), class: 'btn btn-sm btn-default') do
-                    i.fa.fa-download.fa-pad-r
-                    = exec.report_format
+    table.executions.table.table-striped.table-hover
+      thead
+        tr
+          th.wip  
+          th.created_at= human(Adhoq::Execution, :created_at)
+          th.status=     human(Adhoq::Execution, :status)
+          th.report
+      tbody
+        - query.executions.recent_first.each do |exec|
+          - next if exec.report.try(:on_the_fly?)
+          = render 'execution', query: query, exec: exec

data/app/views/adhoq/queries/edit.html.slim

@@ -1,2 +1,11 @@
-section.edit-query
-  = render 'form', query: @query, title: 'Edit query'
+.col-md-12
+  ol.breadcrumb
+    li= link_to 'Index', :queries
+    li= link_to query_friendly_name(@query), @query
+    li.active  Edit
+
+#main.col-md-12
+  section.edit-query
+    = render 'form', query: @query, title: "Edit query > #{query_friendly_name(@query)}"
+
+= render 'current_tables_leftbar'

data/app/views/adhoq/queries/index.html.slim

@@ -1 +1,11 @@
-= render 'query', query: @queries.first
+.col-md-12
+  ol.breadcrumb
+    li.active Index
+
+#queries.col-md-3
+  section.queries
+    = render 'queries', queries: @queries
+
+#the-query.col-md-9
+  - if first_query = @queries.first
+    = render 'query', query: first_query

data/app/views/adhoq/queries/new.html.slim

@@ -1,2 +1,10 @@
-section.new-query
-  = render 'form', query: @query, title: 'New query'
+.col-md-12
+  ol.breadcrumb
+    li= link_to 'Index', :queries
+    li.active  New query
+
+#main.col-md-12
+  section.new-query
+    = render 'form', query: @query, title: 'New query'
+
+= render 'current_tables_leftbar'

data/app/views/adhoq/queries/show.html.slim

@@ -1 +1,11 @@
-= render 'query', query: @query
+.col-md-12
+  ol.breadcrumb
+    li= link_to 'Index', :queries
+    li.active= query_friendly_name(@query)
+
+#queries.col-md-3
+  section.queries
+    = render 'queries', queries: Adhoq::Query.recent_first, highlight: @query
+
+#the-query.col-md-9
+  = render 'query', query: @query

data/app/views/layouts/adhoq/application.html.slim

@@ -11,8 +11,5 @@ html
       = render 'global_nav'
 
       #contents.row
-        #sidebar.col-md-3
-          = render 'sidebar_queries_index'
-
-        #main.col-md-9= yield
+        = yield
 

data/db/migrate/20141003095645_create_adhoq_queries.rb

@@ -5,7 +5,7 @@ class CreateAdhoqQueries < ActiveRecord::Migration
       t.string :description
       t.text :query
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20141006014750_create_adhoq_executions.rb

@@ -7,7 +7,7 @@ class CreateAdhoqExecutions < ActiveRecord::Migration
       t.string     :status,         null: false, default: 'requested'
       t.text       :log
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20141007052308_create_adhoq_reports.rb

@@ -6,7 +6,7 @@ class CreateAdhoqReports < ActiveRecord::Migration
       t.time       :generated_at, null: false
       t.string     :storage,      null: false
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/lib/adhoq.rb

@@ -14,5 +14,6 @@ module Adhoq
 
   configure do |config|
     config.authorization = proc { true }
+    config.database_connection = proc { ActiveRecord::Base.connection }
   end
 end

data/lib/adhoq/configuration.rb

@@ -10,6 +10,12 @@ module Adhoq
 
     config_accessor :current_user
 
+    config_accessor :database_connection
+    config_accessor :hidden_model_names
+
+    config_accessor :async_execution
+    config_accessor :job_queue_name
+
     def callablize(name)
       if (c = config[name]).respond_to?(:call)
         c
@@ -17,5 +23,9 @@ module Adhoq
         c.to_proc
       end
     end
+
+    def async_execution?
+      defined?(ActiveJob) && Adhoq.config.async_execution
+    end
   end
 end

data/lib/adhoq/engine.rb

@@ -2,6 +2,7 @@
 require 'font-awesome-sass'
 require 'jquery-rails'
 require 'slim-rails'
+require 'active_decorator'
 
 module Adhoq
   class Engine < ::Rails::Engine

data/lib/adhoq/executor.rb

@@ -1,42 +1,18 @@
 module Adhoq
   class Executor
-    class << self
-      def select(query)
-        with_sandbox do
-          current_connection.exec_query(query)
-        end
-      end
-
-      def explain(query)
-        with_sandbox do
-          current_connection.explain(query)
-        end
-      end
-
-      def current_connection
-        ActiveRecord::Base.connection
-      end
-
-      def with_sandbox
-        result = nil
-        ActiveRecord::Base.transaction do
-          result = yield
-          raise ActiveRecord::Rollback
-        end
-        result
-      end
-    end
+    autoload 'ConnectionWrapper', 'adhoq/executor/connection_wrapper'
 
     def initialize(query)
+      @connection = ConnectionWrapper.new
       @query = query
     end
 
     def execute
-      wrap_result(self.class.select(@query))
+      wrap_result(@connection.select(@query))
     end
 
     def explain
-      self.class.explain(@query)
+      @connection.explain(@query)
     end
 
     private

data/lib/adhoq/executor/connection_wrapper.rb

@@ -0,0 +1,32 @@
+module Adhoq
+  class Executor
+    class ConnectionWrapper
+      attr_reader :connection
+
+      def initialize
+        @connection = Adhoq.config.callablize(:database_connection).call
+      end
+
+      def select(query)
+        with_sandbox do
+          connection.exec_query(query)
+        end
+      end
+
+      def explain(query)
+        with_sandbox do
+          connection.explain(query)
+        end
+      end
+
+      def with_sandbox
+        result = nil
+        connection.transaction do
+          result = yield
+          raise ActiveRecord::Rollback
+        end
+        result
+      end
+    end
+  end
+end

data/lib/adhoq/global_variable.rb

@@ -27,6 +27,7 @@ module Adhoq
         case type
         when :local_file then Adhoq::Storage::LocalFile
         when :s3         then Adhoq::Storage::S3
+        when :on_the_fly then Adhoq::Storage::OnTheFly
         else
           raise NotImplementedError
         end

data/lib/adhoq/storage.rb

@@ -3,6 +3,7 @@ module Adhoq
     autoload 'FogStorage', 'adhoq/storage/fog_storage'
     autoload 'LocalFile',  'adhoq/storage/local_file'
     autoload 'S3',         'adhoq/storage/s3'
+    autoload 'OnTheFly',   'adhoq/storage/on_the_fly'
 
     def with_new_identifier(suffix = nil, seed = Time.now)
       dirname, fname_seed = ['%Y-%m-%d', '%H%M%S.%L'].map {|f| seed.strftime(f) }

data/lib/adhoq/storage/fog_storage.rb

@@ -10,6 +10,10 @@ module Adhoq
         end
       end
 
+      def direct_download?
+        false
+      end
+
       def get(identifier)
         get_raw(identifier).body
       end

data/lib/adhoq/storage/on_the_fly.rb

@@ -0,0 +1,32 @@
+module Adhoq
+  module Storage
+    class OnTheFly
+      PREFIX = 'memory://adhoq-on-the-fly'
+
+      attr_reader :identifier, :reports
+
+      def initialize(id_base = Process.pid)
+        @identifier = "#{PREFIX}-#{id_base}"
+        @reports    = {}
+      end
+
+      def store(suffix = nil, seed = Time.now, &block)
+        Adhoq::Storage.with_new_identifier(suffix, seed) do |identifier|
+          @reports[identifier] = yield.tap(&:rewind)
+        end
+      end
+
+      def direct_download?
+        false
+      end
+
+      def get(identifier)
+        if item = @reports.delete(identifier)
+          item.read.tap { item.close }
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/adhoq/storage/s3.rb

@@ -4,14 +4,27 @@ module Adhoq
   module Storage
     class S3 < FogStorage
       def initialize(bucket, s3_options = {})
-        @bucket = bucket
-        @s3     = Fog::Storage.new({provider: 'AWS'}.merge(s3_options))
+        @bucket                  = bucket
+        @direct_download         = s3_options.delete(:direct_download)
+        @direct_download_options = s3_options.delete(:direct_download_options) || default_direct_download_options
+        @s3 = Fog::Storage.new({provider: 'AWS'}.merge(s3_options))
+      end
+
+      def direct_download?
+        @direct_download
       end
 
       def identifier
         "s3://#{@bucket}"
       end
 
+      def get_url(report)
+        get_raw(report.identifier).url(
+          1.minutes.from_now.to_i,
+          @direct_download_options.call(report)
+        )
+      end
+
       private
 
       def directory
@@ -19,6 +32,17 @@ module Adhoq
 
         @directory = @s3.directories.get(@bucket) || @s3.directories.create(key: @bucket, public: false)
       end
+
+      def default_direct_download_options
+        proc do |report|
+          {
+            query: {
+              'response-content-disposition' => "attachment; filename*=UTF-8''#{URI.encode_www_form_component(report.name)}",
+              'response-content-type' => report.mime_type,
+            }
+          }
+        end
+      end
     end
   end
 end

data/lib/adhoq/version.rb

@@ -1,3 +1,3 @@
 module Adhoq
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/adhoq/executor/connection_wrapper_spec.rb

@@ -0,0 +1,16 @@
+module Adhoq
+  RSpec.describe Executor::ConnectionWrapper, type: :model do
+    describe '.select' do
+      specify 'Do not reflect write access' do
+        expect {
+          Executor::ConnectionWrapper.new.select(<<-INSERT_SQL.strip_heredoc)
+            INSERT INTO "adhoq_queries"
+            ("description", "name", "query", "updated_at", "created_at")
+            VALUES
+            ("description", "name", "SELECT 1", "NOW", "NOW")
+          INSERT_SQL
+        }.not_to change(Adhoq::Query, :count)
+      end
+    end
+  end
+end

data/spec/adhoq/executor_spec.rb

@@ -7,18 +7,5 @@ module Adhoq
 
       specify { expect(executor.execute).to eq Adhoq::Result.new(%w[answer], [[42]]) }
     end
-
-    describe '.select' do
-      specify 'Do not reflect write access' do
-        expect {
-          Executor.select(<<-INSERT_SQL.strip_heredoc)
-            INSERT INTO "adhoq_queries"
-            ("description", "name", "query", "updated_at", "created_at")
-            VALUES
-            ("description", "name", "SELECT 1", "NOW", "NOW")
-          INSERT_SQL
-        }.not_to change(Adhoq::Query, :count)
-      end
-    end
   end
 end

data/spec/adhoq/storage_spec.rb

@@ -25,5 +25,19 @@ module Adhoq
 
       specify { expect(storage.get(identifier)).to eq "Hello adhoq!\n" }
     end
+
+    describe Storage::OnTheFly do
+      let(:storage) { Storage::OnTheFly.new }
+
+      let!(:identifier) do
+        storage.store('.txt') { StringIO.new("Hello adhoq!\n") }
+      end
+
+      specify { expect(storage.get(identifier)).to eq "Hello adhoq!\n" }
+
+      specify do
+        expect { storage.get(identifier) }.to change { storage.reports.size }.by(-1)
+      end
+    end
   end
 end

data/spec/models/adhoq/execution_spec.rb

@@ -1,4 +1,25 @@
 module Adhoq
   RSpec.describe Execution, :type => :model do
+    before do
+      storage = Adhoq::Storage::OnTheFly.new
+      allow(Adhoq).to receive(:current_storage) { storage }
+    end
+
+    let(:execution) do
+      query = create(:adhoq_query, query: 'SELECT name, description FROM adhoq_queries')
+      query.execute!('xlsx')
+    end
+
+    specify { expect(execution.report).to be_on_the_fly }
+
+    specify 'can get report only on execution' do
+      expect(execution.report.data).to have_values_in_xlsx_sheet([
+        ["name",    "description"],
+        ["A query", "Simple simple SELECT"]
+      ])
+
+      # Accessable only once
+      expect(execution.report.data).to be_nil
+    end
   end
 end

data/spec/support/activejob_helper.rb

@@ -0,0 +1,26 @@
+RSpec.configure do |config|
+  config.around(:each, async_execution: true) do |ex|
+    current_async_execution = Adhoq.config.async_execution
+
+    Adhoq.config.async_execution = true
+
+    ex.call
+
+    Adhoq.config.async_execution = current_async_execution
+  end
+
+  config.around(:each, active_job_test_adapter: true) do |ex|
+    current_active_job_queue_adapter = Adhoq::Engine.config.active_job.queue_adapter
+    current_execute_job_queue_adapter = Adhoq::ExecuteJob.queue_adapter
+
+    Adhoq::Engine.config.active_job.queue_adapter = :test
+    Adhoq::ExecuteJob.queue_adapter = ActiveJob::QueueAdapters::TestAdapter.new
+    Adhoq::ExecuteJob.queue_adapter.perform_enqueued_jobs = true
+
+    ex.call
+
+    Adhoq::ExecuteJob.queue_adapter.performed_jobs.clear
+    Adhoq::Engine.config.active_job.queue_adapter = current_active_job_queue_adapter
+    Adhoq::ExecuteJob.queue_adapter = current_execute_job_queue_adapter
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adhoq
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kyosuke MOROHASHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_decorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -372,19 +400,24 @@ files:
 - app/controllers/adhoq/explains_controller.rb
 - app/controllers/adhoq/previews_controller.rb
 - app/controllers/adhoq/queries_controller.rb
+- app/decorators/adhoq/execution_decorator.rb
+- app/decorators/adhoq/query_decorator.rb
 - app/helpers/adhoq/application_helper.rb
+- app/jobs/adhoq/execute_job.rb
 - app/models/adhoq/execution.rb
 - app/models/adhoq/query.rb
 - app/models/adhoq/report.rb
 - app/models/adhoq/time_based_orders.rb
 - app/views/adhoq/application/_global_nav.html.slim
-- app/views/adhoq/application/_sidebar_queries_index.html.slim
 - app/views/adhoq/current_tables/index.html.slim
 - app/views/adhoq/explains/create.html.slim
 - app/views/adhoq/explains/statement_invalid.html.slim
 - app/views/adhoq/previews/create.html.slim
 - app/views/adhoq/previews/statement_invalid.html.slim
+- app/views/adhoq/queries/_current_tables_leftbar.html.slim
+- app/views/adhoq/queries/_execution.html.slim
 - app/views/adhoq/queries/_form.html.slim
+- app/views/adhoq/queries/_queries.html.slim
 - app/views/adhoq/queries/_query.html.slim
 - app/views/adhoq/queries/edit.html.slim
 - app/views/adhoq/queries/index.html.slim
@@ -401,6 +434,7 @@ files:
 - lib/adhoq/engine.rb
 - lib/adhoq/error.rb
 - lib/adhoq/executor.rb
+- lib/adhoq/executor/connection_wrapper.rb
 - lib/adhoq/global_variable.rb
 - lib/adhoq/reporter.rb
 - lib/adhoq/reporter/csv.rb
@@ -410,9 +444,11 @@ files:
 - lib/adhoq/storage.rb
 - lib/adhoq/storage/fog_storage.rb
 - lib/adhoq/storage/local_file.rb
+- lib/adhoq/storage/on_the_fly.rb
 - lib/adhoq/storage/s3.rb
 - lib/adhoq/version.rb
 - lib/tasks/adhoq_tasks.rake
+- spec/adhoq/executor/connection_wrapper_spec.rb
 - spec/adhoq/executor_spec.rb
 - spec/adhoq/global_variable_spec.rb
 - spec/adhoq/reporter/csv_spec.rb
@@ -424,6 +460,7 @@ files:
 - spec/models/adhoq/query_spec.rb
 - spec/models/adhoq/report_spec.rb
 - spec/spec_helper.rb
+- spec/support/activejob_helper.rb
 - spec/support/codeclimate_reporter.rb
 - spec/support/feature_spec_helper.rb
 - spec/support/have_values_in_xlsx_sheet_matcher.rb
@@ -447,11 +484,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: DB management console in the wild.
 test_files:
+- spec/adhoq/executor/connection_wrapper_spec.rb
 - spec/adhoq/executor_spec.rb
 - spec/adhoq/global_variable_spec.rb
 - spec/adhoq/reporter/csv_spec.rb
@@ -462,6 +500,7 @@ test_files:
 - spec/models/adhoq/execution_spec.rb
 - spec/models/adhoq/query_spec.rb
 - spec/models/adhoq/report_spec.rb
+- spec/support/activejob_helper.rb
 - spec/support/codeclimate_reporter.rb
 - spec/support/feature_spec_helper.rb
 - spec/support/have_values_in_xlsx_sheet_matcher.rb

data/app/views/adhoq/application/_sidebar_queries_index.html.slim

@@ -1,10 +0,0 @@
-h2
-  | Queries
-  = link_to 'Create new', :root, class: 'btn btn-primary new-query'
-ul.queries.list-unstyled
-  - Adhoq::Query.recent_first.each do |query|
-    li.panel.panel-default[query]
-      .panel-heading
-        h2= link_to query.name, query_path(query)
-      p.panel-body.description= query.description
-