adhoq 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9fac13cfa25151dce3d5c579c39ba8098f07b6f
-  data.tar.gz: 23f822e233cc7977a2461dbe681a30d2426fffd5
+  metadata.gz: fbc8da6ce746ea5888241cae9f548cd431c84ac6
+  data.tar.gz: 8bda628674e5dba8625e09b9be76d728b79f714f
 SHA512:
-  metadata.gz: f6d1804945abba5952f20f671f68e5fab9141d474dfdcc70aab8a6317cd3c975296e244b6d480a27a2e19066ec2c56eeaadde874ddd3617281275b23c08de6bb
-  data.tar.gz: 25dac12d074dff4dead41cb23271447737f237103aa494f4148b509b0a6f8cb30be2c1bd3aff9e63fe83763836c744be5249e48422d78d290afdd26685473904
+  metadata.gz: 7d606c2dabc3d3b92952355f688d57d9c5abc402502347654130079b52575d81b5ad00efb72fe5725019129b251c28b271ef044ce48b66c010b03abae939d361
+  data.tar.gz: 51b8b0c6c041d6034dbb7f7450c2586225a116755cd64fa644a9928a0be0086efd543982dfd9b132891bb417644e1ab2ad7432e794b6248b72022fd5988a2f4b

data/app/controllers/adhoq/explains_controller.rb

@@ -0,0 +1,13 @@
+module Adhoq
+  class ExplainsController < ApplicationController
+    layout false
+
+    def create
+      begin
+        @result = Adhoq::Executor.new(params[:query]).explain
+      rescue ActiveRecord::StatementInvalid => @statement_invalid
+        render 'statement_invalid', status: :unprocessable_entity
+      end
+    end
+  end
+end

data/app/models/adhoq/execution.rb

@@ -5,9 +5,7 @@ module Adhoq
     belongs_to :query
     has_one    :report, dependent: :destroy, inverse_of: :execution
 
-    def supported_formats
-      %w[xlsx]
-    end
+    delegate   :supported_formats, to: Adhoq::Reporter
 
     def generate_report!
       build_report.generate!

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

@@ -23,7 +23,7 @@ ul.list-unstyled.tables
         tbody
           - ar_class.columns.each do |column|
             tr
-              td.pk.icon= column.primary ? icon_fa('check-circle') : ''
+              td.pk.icon= column.name == ar_class.primary_key ? icon_fa('check-circle') : ''
               td.monospace= column.name
               td= column.type
               td.null.icon= column.null ? '' : icon_fa('check')

data/app/views/adhoq/explains/create.html.slim

@@ -0,0 +1,2 @@
+pre
+  = @result

data/app/views/adhoq/explains/statement_invalid.html.slim

@@ -0,0 +1,5 @@
+p.statement-invalid.alert.alert-danger
+  strong= @statement_invalid.original_exception.class
+  br
+  = @statement_invalid.original_exception.message
+

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

@@ -29,6 +29,10 @@ ul.nav.nav-tabs[role='tablist']
     a[role='tab' data-toggle='tab' href='#preview' ]
       i.fa.fa-eye.fa-pad-r
       | Preview
+  li
+    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
@@ -46,12 +50,24 @@ ul.nav.nav-tabs[role='tablist']
     .js-preview-result
       .alert.alert-info Preview is shown here
 
+  #explain.tab-pane
+    h3
+      | Query explain
+      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
+
+    .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)) });
   });

data/config/routes.rb

@@ -6,5 +6,6 @@ Adhoq::Engine.routes.draw do
   end
 
   resource  :preview,        only: 'create'
+  resource  :explain,        only: 'create'
   resources :current_tables, only: 'index'
 end

data/lib/adhoq/executor.rb

@@ -7,6 +7,12 @@ module Adhoq
         end
       end
 
+      def explain(query)
+        with_sandbox do
+          current_connection.explain(query)
+        end
+      end
+
       def current_connection
         ActiveRecord::Base.connection
       end
@@ -29,6 +35,10 @@ module Adhoq
       wrap_result(self.class.select(@query))
     end
 
+    def explain
+      self.class.explain(@query)
+    end
+
     private
 
     def wrap_result(ar_result)

data/lib/adhoq/reporter.rb

@@ -1,5 +1,9 @@
 module Adhoq
   module Reporter
+    class UnsupportedFormat < Adhoq::Error; end
+
+    autoload 'Csv',  'adhoq/reporter/csv'
+    autoload 'Json', 'adhoq/reporter/json'
     autoload 'Xlsx', 'adhoq/reporter/xlsx'
 
     class << self
@@ -11,8 +15,21 @@ module Adhoq
       end
 
       def lookup(format)
-        @map ||= {'xlsx' => Adhoq::Reporter::Xlsx}
-        @map[format]
+        reporters[format.to_s] || raise(UnsupportedFormat)
+      end
+
+      def supported_formats
+        reporters.keys.sort
+      end
+
+      private
+
+      def reporters
+        @reporters ||= {
+          'csv'  => Adhoq::Reporter::Csv,
+          'json' => Adhoq::Reporter::Json,
+          'xlsx' => Adhoq::Reporter::Xlsx,
+        }
       end
     end
   end

data/lib/adhoq/reporter/csv.rb

@@ -0,0 +1,26 @@
+require 'csv'
+
+module Adhoq
+  module Reporter
+    class Csv
+
+      def self.mime_type
+        'text/csv; charset=UTF-8'
+      end
+
+      def initialize(result)
+        @result = result
+      end
+
+      def build_report
+        file = Tempfile.new(['adhoq-reporter', '.csv'], Dir.tmpdir, encoding: 'UTF-8')
+        csv  = CSV.new(file)
+
+        csv << @result.header
+        @result.rows.each {|row| csv << row }
+
+        file.tap(&:rewind)
+      end
+    end
+  end
+end

data/lib/adhoq/reporter/json.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+module Adhoq
+  module Reporter
+    class Json
+
+      def self.mime_type
+        'application/json'
+      end
+
+      def initialize(result)
+        @result = result
+      end
+
+      def build_report
+        file = Tempfile.new(['adhoq-reporter', '.csv'], Dir.tmpdir, encoding: 'UTF-8')
+        write_content!(file)
+
+        file.tap(&:rewind)
+      end
+
+      private
+
+      def write_content!(file)
+        json_objects = @result.rows.map {|row| Hash[*@result.header.zip(row).flatten] }
+
+        file.write(JSON.dump(json_objects))
+      end
+    end
+  end
+end

data/lib/adhoq/version.rb

@@ -1,3 +1,3 @@
 module Adhoq
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/adhoq/reporter/csv_spec.rb

@@ -0,0 +1,25 @@
+require 'csv'
+
+module Adhoq
+  RSpec.describe Reporter::Csv, type: :model do
+    describe '.mime_type' do
+      specify { expect(Adhoq::Reporter::Csv.mime_type).to eq 'text/csv; charset=UTF-8' }
+    end
+
+    context 'create xlsx report' do
+      let(:report_data) do
+        ex = Adhoq::AdhocExecution.new('csv', attributes_for(:adhoq_query, :greeting)[:query])
+
+        Adhoq::Reporter.generate(ex)
+      end
+
+      specify do
+        expect(CSV.parse(report_data.read)).to eq [
+          %w[name description],
+          ['hello', 'English greeting message']
+        ]
+      end
+    end
+  end
+end
+

data/spec/adhoq/reporter/json_spec.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Adhoq
+  RSpec.describe Reporter::Json, type: :model do
+    describe '.mime_type' do
+      specify { expect(Adhoq::Reporter::Json.mime_type).to eq 'application/json' }
+    end
+
+    context 'create xlsx report' do
+      let(:report_data) do
+        ex = Adhoq::AdhocExecution.new('json', attributes_for(:adhoq_query, :greeting)[:query])
+
+        Adhoq::Reporter.generate(ex)
+      end
+
+      specify do
+        expect(JSON.parse(report_data.read)).to eq [
+          {
+            'name'        => 'hello',
+            'description' =>  'English greeting message'
+          }
+        ]
+      end
+    end
+  end
+end
+
+

data/spec/adhoq/reporter/xlsx_spec.rb

@@ -2,9 +2,9 @@ module Adhoq
   RSpec.describe Reporter::Xlsx, type: :model do
     context 'create xlsx report' do
       let(:report_data) do
-        Adhoq::Reporter.generate(Adhoq::AdhocExecution.new('xlsx', <<-SQL.strip_heredoc))
-          SELECT "hello" AS name ,"English greeting message" AS description
-        SQL
+        ex = Adhoq::AdhocExecution.new('xlsx', attributes_for(:adhoq_query, :greeting)[:query])
+
+        Adhoq::Reporter.generate(ex)
       end
 
       specify do

data/spec/factories/adhoq_queries.rb

@@ -25,5 +25,11 @@ FactoryGirl.define do
           use_count DESC, id ASC
       SQL
     end
+
+    trait :greeting do
+      name        'greeting'
+      description 'Static query for testing data'
+      query       'SELECT "hello" AS name ,"English greeting message" AS description'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adhoq
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kyosuke MOROHASHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -369,6 +369,7 @@ files:
 - app/controllers/adhoq/authorization_methods.rb
 - app/controllers/adhoq/current_tables_controller.rb
 - app/controllers/adhoq/executions_controller.rb
+- app/controllers/adhoq/explains_controller.rb
 - app/controllers/adhoq/previews_controller.rb
 - app/controllers/adhoq/queries_controller.rb
 - app/helpers/adhoq/application_helper.rb
@@ -379,6 +380,8 @@ files:
 - 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/_form.html.slim
@@ -400,6 +403,8 @@ files:
 - lib/adhoq/executor.rb
 - lib/adhoq/global_variable.rb
 - lib/adhoq/reporter.rb
+- lib/adhoq/reporter/csv.rb
+- lib/adhoq/reporter/json.rb
 - lib/adhoq/reporter/xlsx.rb
 - lib/adhoq/result.rb
 - lib/adhoq/storage.rb
@@ -410,6 +415,8 @@ files:
 - lib/tasks/adhoq_tasks.rake
 - spec/adhoq/executor_spec.rb
 - spec/adhoq/global_variable_spec.rb
+- spec/adhoq/reporter/csv_spec.rb
+- spec/adhoq/reporter/json_spec.rb
 - spec/adhoq/reporter/xlsx_spec.rb
 - spec/adhoq/storage_spec.rb
 - spec/factories/adhoq_queries.rb
@@ -447,6 +454,8 @@ summary: DB management console in the wild.
 test_files:
 - spec/adhoq/executor_spec.rb
 - spec/adhoq/global_variable_spec.rb
+- spec/adhoq/reporter/csv_spec.rb
+- spec/adhoq/reporter/json_spec.rb
 - spec/adhoq/reporter/xlsx_spec.rb
 - spec/adhoq/storage_spec.rb
 - spec/factories/adhoq_queries.rb