visual_query 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f6ebced1d88f4c21c01c14427dceadcac9de2a6
+  data.tar.gz: f0342d2ef8f5ba11c3c1d1d94966c9764b19d262
+SHA512:
+  metadata.gz: 447b93ac237dd1a7c061df09414d2056462e3ae55d09b8ff07a94540423cedf6f797f4a97a5704c72642c08b354f562f00eeeba5e4220b35d5191e5db6480b0e
+  data.tar.gz: fa314c031ebacb20ab219a14cbd7981666c4a6b4ab6a2b0962a048376f05f4e43504e9015e4162f6fe0f40faaf5527ac0c27966e138fa945bbd3a1fa122fc793

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.md

@@ -0,0 +1,59 @@
+VisualQuery
+===========
+
+Browser-based report generator with intuitive user interface for constructing simple database queries by end users with no SQL knowledge. It is implemented as a Rails engine, so you can drop it in your application (with caution, continue reading).
+
+Installation
+============
+
+In your Gemfile:
+
+    gem 'visual_query'
+    gem 'jquery-ui-rails'
+
+In your `config/routes.rb:`
+
+```ruby
+    mount VisualQuery::Engine => "/admin/queries", :as => "visual_query"
+```
+
+You can change the mount point path to whatever you want.
+
+Create `config/initializers/visual_query`:
+
+```ruby
+    VisualQuery::BaseController = ApplicationController # or whatever controller you want to inherit from
+    QueriesController.layout('admin') # optional
+```
+
+Add the following to your `application.js`:
+
+```javascript
+//= require jquery.ui.datepicker
+//= require visual_query
+```
+
+and `application.css`:
+
+```css
+/*
+ *= require jquery.ui.datepicker
+ */
+
+Word of Caution
+===============
+
+VisualQuery is not implemented as an isolated namespace as Rails team suggests. Thus it imports some methods in your helpers which can lead to conflicts in case
+you use default Rails behaviour of including them all with `helper :all`. In case it conflicts with some method defined in your helper you can put in `config/application.rb`
+`config.action_controller.include_all_helpers = false` and specify for each controller which helpers should be used.
+
+Testing
+=======
+You need postgresql for testing
+
+```ruby
+    rake db:create
+    RAILS_ENV=test rake db:schema:load
+    rake test
+```
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = 'VisualQuery'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Rake::TestTask.new(:test => 'app:db:test:prepare') do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/app/assets/javascripts/visual_query/index.js

@@ -0,0 +1,288 @@
+var $jq = jQuery;
+
+Tutuf = {};
+
+Tutuf.append_and_appear = function(parent,child){
+  $jq(child).css('style', 'display:none;');
+  $jq(parent).append(child);
+  $jq(child).fadeIn(1500);
+  return child;
+};
+
+Tutuf.VisualQuery = {};
+
+Tutuf.VisualQuery.get_current_row_index = function() {
+  return $jq('span.current_relation').parent('li.relation').parent('ul.relation_path').prevAll('ul.relation_path').length;
+};
+
+Tutuf.VisualQuery.current_relation_path = function() {
+  return '#joined_relations_container ul.relation_path:eq('+ Tutuf.VisualQuery.get_current_row_index() +') ';
+};
+
+Tutuf.VisualQuery.list_joinable = function(args) {
+  args.el.on('click', function(event) {
+                      $jq.ajax({url:    Tutuf.VisualQuery.url_root + '/list_joinable/' + args.klass,
+                                async:   false,
+                                success: function(data, text_status, jq_xhr) {
+                                    $jq('#relations_container').html(data);
+                                    Tutuf.VisualQuery.join_relations(args.klass, args.relations, args.join_conditions);
+                                 }
+                                });
+            });
+};
+
+Tutuf.VisualQuery.join_relations = function(klass,relations,join_conditions){
+  var rel_el = $jq(Tutuf.VisualQuery.current_relation_path() + 'input[name="klass"][value="' + klass + '"]').siblings('span.relation');
+  if (rel_el.length === 0) {
+    $jq.ajax({url:      Tutuf.VisualQuery.url_root + '/join_data/' + klass,
+              async:    false,
+              dataType: 'json',
+              success:  function(data, text_status, jq_xhr) {
+                  var relation = data.relation_human_name;
+                  var li = $jq('<li class="relation"</li>');
+                  li.html('<span class="relation current_relation">' + relation + '</span>');
+                  Tutuf.VisualQuery.add_join_conditions(li,join_conditions);
+                  li.append('<input type="hidden" disabled="disabled" name="klass" value="' + klass + '"/>');
+                  $jq.each(relations, function() {
+                    li.append('<input type="hidden" name="relations[][rel_name]" value="' + this + '"/>');
+                    li.append('<input type="hidden" name="relations[][row]" value="' +  Tutuf.VisualQuery.get_current_row_index() + '"/>');
+                  });
+                  if ($jq('input[name="klass"][value="' + klass + '"]').siblings('span.relation').length < 1) {
+                    $jq.each($jq(data.columns).filter("th"), function(){Tutuf.append_and_appear($jq('#' + this.className), this);});
+                  }
+                  var current_relation_path = Tutuf.VisualQuery.current_relation_path();
+                  $jq('.current_relation').removeClass('current_relation');
+                  Tutuf.append_and_appear($jq(current_relation_path), li);
+                  li.children("span.relation").bind("click", function(el){Tutuf.VisualQuery.show_relation(this);});
+              },
+              error: function(jq_xhr, text_status, error_thrown){
+                 alert("Грешка при добавяне на таблицата " + relations);
+               }
+              });
+  } else {
+    $jq('.current_relation').removeClass('current_relation');
+    rel_el.addClass('current_relation');
+  }
+};
+
+Tutuf.VisualQuery.add_join_conditions = function(li,join_conditions){
+  if (join_conditions === "") {
+    return;
+  }
+  var i,j;
+  for (i=0; i<join_conditions.length; i++){
+    for (j=0; j<2; j++){
+      var pos = (j === 0 ? 'left' : 'right');
+      li.append('<input type="hidden" name="join_conditions[]['+ pos +'_rel_name]" value="' + join_conditions[i][j].rel_name + '"/>' +
+                '<input type="hidden" name="join_conditions[]['+ pos +'_col_name]" value="' + join_conditions[i][j].col_name + '"/>');
+    }
+    if (join_conditions.length === 2) {
+      li.append('<input type="hidden" name="join_conditions[][type]" value="" />');
+    } else {
+      li.prepend('<select name="join_conditions[][type]'+ '">' +
+                        '<option value="INNER" selected="selected">&mdash;</option>'+
+                        '<option value="LEFT">|-</option>' +
+                        '<option value="RIGHT">-|</option>'+
+                        '<option value="FULL">&ndash;_</option>' +
+                      '</select>');
+    }
+    li.append('<input type="hidden" name="join_conditions[][row]" value="' + Tutuf.VisualQuery.get_current_row_index() + '"/>');
+  }
+};
+
+Tutuf.VisualQuery.add_filter = function(el, params){
+  $jq.ajax({url:    Tutuf.VisualQuery.url_root + '/filter',
+            data:    params,
+            success: function(data, text_status, jq_xhr){$jq(el).replaceWith(data);}
+          });
+};
+
+Tutuf.VisualQuery.remove_filter = function(el, params){
+  $jq.ajax({url:     Tutuf.VisualQuery.url_root + '/remove_filter',
+            data:    params,
+            success: function(data, text_status, jq_xhr){$jq(el.parentNode).replaceWith(data);}
+          });
+};
+
+Tutuf.VisualQuery.result_table_rows = ['#hide', '#filter', '#relation_column'];
+
+Tutuf.VisualQuery.th_index = function(el){
+  var th = el.parentNode;
+  return $jq(th).prevAll().length;
+};
+
+Tutuf.VisualQuery.toggle = function(el){
+  if ($jq(el).parent().hasClass('hidden_column')) {
+    Tutuf.VisualQuery.show(el);
+  } else {
+    Tutuf.VisualQuery.hide(el);
+  }
+};
+
+Tutuf.VisualQuery.hide = function(el){
+  var index = this.th_index(el);
+  jQuery.each(this.result_table_rows, function(){
+    $jq(this + ' th:eq('+ index +')').addClass('hidden_column');
+  });
+  $jq(el).text("показване");
+  $jq("#relation_column th:eq("+ index +") input[name^='columns[]']").attr("disabled","disabled");
+};
+
+Tutuf.VisualQuery.show = function(el){
+  var index = Tutuf.VisualQuery.th_index(el);
+  jQuery.each(this.result_table_rows, function(){
+    $jq(this + ' th:eq('+ index +')').removeClass('hidden_column');
+  });
+  $jq(el).text("скриване");
+  $jq('#relation_column th:eq('+ index +') input').removeAttr("disabled");
+};
+
+Tutuf.VisualQuery.show_relation = function(rel_el){
+  rel_el = $jq(rel_el);
+  $jq('.current_relation').removeClass('current_relation');
+  rel_el.addClass('current_relation');
+  $jq.get(Tutuf.VisualQuery.url_root + '/list_joinable/' + rel_el.siblings('input[name="klass"]').attr('value'), function(html){$jq('#relations_container').empty().append(html)});
+};
+
+Tutuf.VisualQuery.columns = function (klass,a){
+  var cols_el = $jq(a).siblings(".columns");
+  if (cols_el.length ===  0) {
+    $jq.get(Tutuf.VisualQuery.url_root + '/columns/' + klass, function(html){$jq(a).parent().append(html);});
+  } else {
+    cols_el.toggle();
+  }
+};
+
+$jq(function(){
+  Tutuf.VisualQuery.bind_enter_in_query_name_input();
+});
+
+Tutuf.VisualQuery.bind_enter_in_query_name_input = function() {
+  $jq('#query_name').keypress(function(e){
+    var key;
+    if(window.event) {
+        key = window.event.keyCode;     //IE
+    } else {
+        key = e.which;     //firefox
+    }
+    if (key === 13){
+      Tutuf.VisualQuery.create();
+      return false;
+    }
+  });
+};
+
+Tutuf.VisualQuery.create = function(){
+  $jq.ajax({url:      Tutuf.VisualQuery.url_root + '/',
+            type:     'POST',
+            data:     $jq('#query').serialize(),
+            dataType: 'html',
+            success:  function(data, text_status, jq_xhr){
+              $jq('#query_name_container').replaceWith(data);
+              Tutuf.VisualQuery.bind_enter_in_query_name_input();
+            },
+            error: function(jq_xhr, text_status, error_thrown){
+              if (jq_xhr.status === 409){
+                 $jq('#query_name_container').replaceWith(jq_xhr.responseText);
+                 $jq('#query_name').focus();
+                 Tutuf.VisualQuery.bind_enter_in_query_name_input();
+              } else {
+                alert("Възникна непредвидена грешка при записа на справката :-(.");
+              }
+            }
+           });
+};
+
+Tutuf.VisualQuery.update_sql = function(){
+  $jq.ajax({url:  Tutuf.VisualQuery.url_root + '/update_sql/' + $jq('[name="name"]').attr('value'),
+            type: 'PUT',
+            data: $jq('#query').serialize(),
+            dataType: 'html',
+            success: function(data, text_status, jq_xhr){
+              $jq('.notice').html(data);
+            },
+            error: function(jq_xhr, text_status, error_thrown){
+              Tutuf.VisualQuery.display_error(jq_xhr.responseText);
+            }
+           });
+};
+
+Tutuf.VisualQuery.add_balanced_query = function(){
+  var row_index = $jq('ul.relation_path').length;
+  $jq('#joined_relations_container').append('<ul class="relation_path">'+
+                                                '<li>' +
+                                                  '<input type="hidden" name="rows[]" value="' + row_index + '" />' +
+                                                  '<input type="button" style="visibility:hidden;" name="remove_balanced_query" value="-" onclick="Tutuf.VisualQuery.remove_balanced_query_row()"></input>'+
+                                                '</li>' +
+                                             '</ul>');
+  var copied_row = '#joined_relations_container ul.relation_path:eq(0) ';
+  if ($jq(copied_row + 'li.balancing_relation').length === 0) {
+    $jq(copied_row + 'li.relation').addClass("balancing_relation");
+  }
+  $jq('#joined_relations_container ul.relation_path:last').append($jq(copied_row + 'li.balancing_relation').clone(true));
+  $jq('#joined_relations_container ul.relation_path:last .current_relation').removeClass('current_relation');
+  $jq('#joined_relations_container ul.relation_path:last input[name$="[row]"]').attr('value', row_index);
+};
+
+// TODO: remove balanced query row
+Tutuf.VisualQuery.remove_balanced_query_row = function(){
+  //remove columns of relations that are only in this ul
+  //remove ul
+};
+
+Tutuf.VisualQuery.results = function(){
+  $jq('body').prepend('<div id="synchronous_overlay"><p>Моля, изчакайте обработването на справката<br/><img src="/assets/visual_query/ajax-loader.gif"/></p></div>');
+  $jq.ajax({url:     Tutuf.VisualQuery.url_root + '/results/' + $jq('#name').val(),
+            type:   'POST',
+            data:    $jq('#query').serializeArray(),
+            success: function(data, text_status, jq_xhr){
+              $jq('#results tbody').html(data);
+              $jq('#synchronous_overlay').remove();
+             },
+            error: function(jq_xhr, text_status, error_thrown){
+               $jq('#synchronous_overlay').remove();
+               if ($jq('#sql')) {
+                 Tutuf.VisualQuery.display_error(jq_xhr.responseText);
+               } else {
+                 Tutuf.VisualQuery.display_error('Грешка при четене на резултата. Проверете какво сте попълнили във филтрите.');
+               }
+             }
+           });
+};
+
+Tutuf.VisualQuery.display_error = function(msg){
+  $jq('#results tbody').html('<tr><td class="error" colspan="'+ $jq('#results th.relation_column').length + '">'+ msg +'</td></tr>');
+};
+
+Tutuf.VisualQuery.sort_condition_counter = 0;
+
+Tutuf.VisualQuery.add_sort_condition = function(el){
+  Tutuf.VisualQuery.sort_condition_counter += 1;
+  $jq.ajax({url:      Tutuf.VisualQuery.url_root + '/sort_condition',
+            data:     {index: Tutuf.VisualQuery.sort_condition_counter},
+            dataType: 'html',
+            success:  function(data, text_status, jq_xhr){ $jq(el).parent().parent().append(data); },
+            error:    function(jq_xhr, text_status, error_thrown){ alert("Грешка при добавяне на критерий за сортиране :("); }
+           });
+};
+
+Tutuf.VisualQuery.remove_sort_condition = function(el){
+  if ($jq(el).parent().siblings().size() > 0) { $jq(el).parent().remove(); }
+};
+
+Tutuf.VisualQuery.sort_options = function(el) {
+  if ($jq(el).children('option').size() === $jq('.relation_column').size() + 1) { return; }
+  var options = '<option value="o={rel_name:\'\', col_name:\'\'}">';
+  $jq('.relation_column').each(function() {
+    var rel_name = $jq(this).children('[name="columns[][rel_name]"]').val();
+    var col_name = $jq(this).children('[name="columns[][col_name]"]').val();
+    options += "<option value=\"o={'rel_name':'" + rel_name + "', 'col_name':'" + col_name + '\'}">' + $jq(this).text() + '</option>';
+  });
+  $jq(el).html(options);
+};
+
+Tutuf.VisualQuery.select_sort_option = function(el) {
+  var obj = eval($jq(el).children('option:selected').val());
+  $jq(el).siblings("[name$='[rel_name]']").val(obj.rel_name);
+  $jq(el).siblings("[name$='[col_name]']").val(obj.col_name);
+};

data/app/assets/stylesheets/visual_query/visual_query.css

@@ -0,0 +1,161 @@
+#query h1 {
+  font-size: 120%;
+  margin: 0 0 0.5em 0;
+}
+
+#relations_container {
+  height: 20ex;
+  overflow-y: auto;
+}
+
+#relations_container,
+#joined_relations_container {
+  width: 100%;
+  margin: 0;
+  padding: 0;
+  border: 1px solid black;
+}
+
+#joined_relations_container {
+  border-top: none;
+  padding: 0.7ex 0 0.7ex 0;
+}
+#command {
+  clear:both;
+  padding: 0.5em;
+}
+
+ul#relations {
+  list-style-type:none;
+  margin: 0;
+  padding: 0 0 0 1em;
+}
+
+ul.columns {
+  list-style-type:none;
+  margin: 0 0 0 1em;
+  padding: 0;
+}
+.columns li {
+  display: inline;
+  color: black;
+  background-color:#D3D3D3;
+  border-left: 1px solid #000;
+  border-right: 1px solid #000;
+  line-height: 1.1em;
+  margin: 0 0 0 -.4em;
+  padding: 0 .5em 0 .5em;
+}
+
+ul.relation_path {
+  list-style-type:none;
+  margin: 0.7ex 0 0.1em 1em;
+  padding: 0;
+}
+
+.relation_path li {
+   display:inline;
+}
+
+.relation_path span.relation {
+  margin: 0 0 0 0.5em;
+  border: 1px solid #000;
+  cursor: pointer;
+}
+
+.relation_path span.current_relation {
+  border: 5px solid #777;
+}
+
+.balancing_relation span.relation {
+  color: white;
+  background-color: purple;
+}
+
+table#results,
+table#results tr,
+table#results th,
+table#results td {
+  border-collapse: collapse;
+  border: 1px solid #000;
+}
+
+table#results td {
+  white-space: pre-wrap;
+}
+
+.warning {
+  font-size: 160%;
+  font-weight: bold;
+  color: #E57F2E;
+  background-color: white;
+}
+
+#results .error {
+  font-size: 160%;
+  font-weight: bold;
+}
+
+.hidden_column, .hidden_column a {
+  background-color:#999;
+}
+
+#hide .hidden_column, #hide .hidden_column a {
+  background-color:#E8E8E8;
+}
+
+.filter_condition{
+  white-space:nowrap;
+}
+
+#synchronous_overlay {
+  width: 100%;
+  height: 100%;
+  position: fixed;
+  margin: 0;
+  z-index: 1000;
+  background-color: gray;
+  color: black;
+  opacity: 0.9;
+  filter:alpha(opacity=90);
+}
+
+#synchronous_overlay p {
+  margin-top: 16%;
+  width:100%;
+  text-align: center;
+  height: 100%;
+  vertical-align:middle;
+  z-index: 1000;
+  font-size: 4em;
+}
+
+#sort {
+  margin: 0.5em 0 0.5em 0;
+}
+
+#sort, #sort tr, #sort td {
+  border-style: none;
+  vertical-align: middle;
+  padding: 0;
+}
+
+ul#sort_conditions {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+}
+
+#sort_conditions li,
+#sort_conditions select {
+  vertical-align: middle;
+}
+
+#sort_conditions select  {
+  margin-right: 0.5em;
+}
+
+#sort input[type="radio"],
+#sort label {
+  margin-right: 0.2em;
+}