old_sql 1.26.0 → 1.27.0

data/README.md

@@ -1,28 +1,22 @@
-# Old SQL
+# Old SQL [pronounced /skuːl/]
 
 Old SQL is a Rails Engine database reporting gem that uses plain old SQL.
 
-Some features of Old SQL are:
-
-* Reports can be created using little or no Ruby code.
-  - SQL for the report to be designed by a DBA, or other database developer independent of Ruby.
-  - Reports can be designed using a design file that mocks the reports. This file can contain data 
-    from the SQL, as well as String literals, and formulas (that can also use numeric literals).
-  - The design documents, which are nothing more than CSV files, can also serve as documentation, 
-    and describe the layout of the report in an intuitive way.
-  - If you want more fine grained control, a custom report processor can parse the SQL.
-  - Simple to convert legacy reports into Old SQL reports.  
-* Multiple report views (jqGrid, HTML table, and chart).
-* Bar and Pie charts using Google Charts.
-* In the report design all data is rounded to a precision that can be set in the old_sql initializer. 
-  This feature can also be disabled in the initializer.
-* Old SQL has rake tasks for running the reports and outputting the result as CSV. This can simplify testing. 
-  It also allows reports to be run as a cron task.
-* The look of Old SQL can be customized.
-* Support for printing and exporting to CSV.
-* Old SQL uses Devise for authentication, and will install it for you. It can
-  even add Devise support to an existing model (by default users).
+* Write reports in plain old SQL with little or no coding. 
+* Layout reports using CSV and YAML.
+* Reports can be displayed using jqGrid, plain HTML, or as a chart (using the Google Charts API).
+* Automatic rounding of all values. Can be controlled via an initializer.
+* Rake tasks for running reports from the command line.
+* Devise for authentication. Which is installed and configured for you using the old_sql
+  generator._
+* Printing and exporting to CSV.
 * Support for multiple database connections.
+* Interface for running Ad hoc queries.
+
+## Coming Soon
+
+* Schema browser
+* Google docs integration
 
 ## Quick Setup and Demo
 

data/app/controllers/old_sql/report_controller.rb

@@ -12,83 +12,105 @@ module OldSql
     helper_method :strip_html
     helper_method :chart_type
     helper_method :chart_data
+    helper_method :db_list
 
     layout "old_sql/report.html.erb"
-    
+
     BASE_PROCESSOR = "base"
 
     def index
       @report_view = OldSql.default_report_view
     end
-    
+
     def jqgrid
       @start_date = params[:start_date]
       @end_date = params[:end_date]
       @report_name = params[:report]
       @report_sql = params[:report_sql]
+      @query = params[:query]
+      @db = params[:db]
+      @caption = params[:caption] 
+      w = params[:w]
       
       #todo allow these to be overridden in the report config
       @row_num = OldSql.jqgrid_row_num
-      @width = OldSql.report_width
+      @width =  w.nil? ? OldSql.report_width : w
       @height = OldSql.report_height
-      
-      render :template => "old_sql/report/datagrid.html.erb"
+
+      render :template => "old_sql/report/jqgrid.html.erb"
     end
-    
+
     def table
       @start_date = params[:start_date]
       @end_date = params[:end_date]
       @report_name = params[:report]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
-      
+
       @width = OldSql.report_width
       @height = OldSql.report_height
-      
+
       processor = load_base_processor
       @report = processor.execute_query(@reports[@report_name],@start_date,@end_date,query_vars(@report_name))
-      
+
       render :template => "old_sql/report/table.html.erb"
     end
-    
+
     def chart
       @start_date = params[:start_date]
       @end_date = params[:end_date]
       @report_name = params[:report]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
-      
+
       @width = 800
       @height = 500
       @google_chart_colors = google_chart_colors
-      
+
       processor = load_base_processor
       @report = processor.execute_query(@reports[@report_name],@start_date,@end_date,query_vars(@report_name))
-      
+
       render :layout => 'old_sql/chart.html.erb', :template => "old_sql/report/chart.html.erb"
     end
-    
-    def query
+
+    def print
       @start_date = params[:start_date]
       @end_date = params[:end_date]
       @report_name = params[:report]
+      @desc = params[:desc]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
-      
+
       processor = load_base_processor
       @report = processor.execute_query(@reports[@report_name],@start_date,@end_date,query_vars(@report_name))
-      
+
+      render :template => "old_sql/report/print.html.erb"
+    end
+    
+    #ajax call
+    def query
+      start_date = params[:start_date]
+      end_date = params[:end_date]
+      report_name = params[:report]
+      report_sql = params[:report_sql].downcase
+      report_sql_orig = params[:report_sql].downcase
+      query = params[:query]
+      db = params[:db]
+
+      @processor = load_base_processor
+      report = @processor.execute_query(@reports[report_name],start_date,end_date,query_vars(report_name),query,db)
+
       respond_to do |format|
-        format.json { render :json => @report.to_json}
-        format.xml { render :xml => @report.to_xml }
+        format.json { render :json => report.to_json}
+        format.xml { render :xml => report.to_xml }
         format.csv {
           csv_string = CSV.generate do |csv|
             # header row
-            csv << ['Start Date', @start_date,'End Date', @end_date]
-            csv << @reports[@report_name]['fields']
+            csv << ['Start Date', start_date,'End Date', end_date]
+            csv << @reports[report_name]['fields']
 
             # data rows
-            @report[:rows].each do |row|
+            report[:rows].each do |row|
               rec = []
               row[:cell].each do |cell|
                 rec << strip_html(cell.to_s).gsub("\n","")
@@ -98,113 +120,112 @@ module OldSql
           end
 
           send_data csv_string,
-            :type => 'text/csv; charset=iso-8859-1; header=present',
-            :disposition => "attachment; filename=#{@report_sql}_#{@start_date.gsub(' ','_')}_#{@end_date.gsub(' ','_')}.csv"
+          :type => 'text/csv; charset=iso-8859-1; header=present',
+          :disposition => "attachment; filename=#{report_sql}_#{start_date.gsub(' ','_')}_#{end_date.gsub(' ','_')}.csv"
         }
       end
     end
-    
-    def print
-      @start_date = params[:start_date]
-      @end_date = params[:end_date]
-      @report_name = params[:report]
-      @desc = params[:desc]
-      @report_sql = params[:report_sql].downcase
-      @report_sql_orig = params[:report_sql].downcase
-      
-      processor = load_base_processor
-      @report = processor.execute_query(@reports[@report_name],@start_date,@end_date,query_vars(@report_name))
-      
-      render :template => "old_sql/report/print.html.erb"
-    end
-    
+
 
     private
-      def ensure_old_sql_admin!
-        render_error(Exception.new "Old SQL Access Denied.") unless eval("current_user.old_sql_admin?")
-      end
-      
-      def _init
-        @host = self.request.host
-        @port = self.request.port
-      end
-      
-      def _reports
-        template = File.read("#{Rails.root}/config/old_sql/reports.yml")
-        @reports = YAML.load(Erubis::Eruby.new(template).result)
-      end
-      
-      def load_base_processor
-        require "old_sql/report_processor/base"
-        OldSql::ReportProcessor::Base.new
-      end
-      
-      def jqgrid_col_model
-        @fields = []
-        field_num = 1
-        
-        # [
-        #   {name:'id',index:'id', width:55},
-        #   {name:'invdate',index:'invdate', width:90, editable:true},
-        #   {name:'name',index:'name', width:100,editable:true},
-        #   {name:'amount',index:'amount', width:80, align:"right",editable:true},
-        #   {name:'tax',index:'tax', width:80, align:"right",editable:true},    
-        #   {name:'total',index:'total', width:80,align:"right",editable:true},   
-        #   {name:'note',index:'note', width:150, sortable:false,editable:true}   
-        # ]
-
-        @reports[@report_name]['fields'].each do |field|
-          if field_num == 1
-            @fields << { :name=>field }
-          else
-            @fields << { :name=>field, :align=>"center" }
-          end
-          field_num+=1
-        end
-        
-        @fields.to_json.html_safe
-      end
-      
-      def jqgrid_col_names
-        logger.info @reports
-        logger.info "REPORT NAME #{@report_name}"
-        json = @reports[@report_name]['fields'].to_json
-        json.html_safe
-      end
-      
-      def query_vars report
-        query_vars = @reports[report]['query_vars']
-        if !query_vars.nil? && query_vars.size > 0
-          return query_vars[0]
+    def ensure_old_sql_admin!
+      render_error(Exception.new "Old SQL Access Denied.") unless eval("current_user.old_sql_admin?")
+    end
+
+    def _init
+      @host = self.request.host
+      @port = self.request.port
+    end
+
+    def _reports
+      template = File.read("#{Rails.root}/config/old_sql/reports.yml")
+      @reports = YAML.load(Erubis::Eruby.new(template).result)
+    end
+
+    def load_base_processor
+      require "old_sql/report_processor/base"
+      OldSql::ReportProcessor::Base.new
+    end
+
+    def jqgrid_col_model
+      @fields = []
+      field_num = 1
+
+      # [
+      #   {name:'id',index:'id', width:55},
+      #   {name:'invdate',index:'invdate', width:90, editable:true},
+      #   {name:'name',index:'name', width:100,editable:true},
+      #   {name:'amount',index:'amount', width:80, align:"right",editable:true},
+      #   {name:'tax',index:'tax', width:80, align:"right",editable:true},    
+      #   {name:'total',index:'total', width:80,align:"right",editable:true},   
+      #   {name:'note',index:'note', width:150, sortable:false,editable:true}   
+      # ]
+      
+      qf = query_fields
+      return if qf.nil?
+
+      qf.each do |field|
+        if field_num == 1
+          @fields << { :name=>field }
         else
-          return nil
+          @fields << { :name=>field, :align=>"center" }
         end
+        field_num+=1
       end
-      
-      def render_error(exception)
-        logger.error(exception)
-        render :template => "old_sql/errors/401.html.erb", :status => 401
-      end
-      
-      def strip_html html
-        OldSql.strip_html html
-      end
-      
-      def chart_data
-        return nil if @report.nil?
-        json = @report.values.first.to_json
-        json.html_safe
-      end
-      
-      def chart_type
-        return nil if @report.nil?
-        @report.keys.first
-      end
-      
-      def google_chart_colors
-        json = OldSql.google_chart_colors.to_json
-        json.html_safe
+
+      @fields.to_json.html_safe
+    end
+
+    def jqgrid_col_names
+      json = query_fields.to_json
+      json.html_safe
+    end
+    
+    def query_fields
+      fields = load_base_processor.fields(@reports[@report_name],@start_date,@end_date,query_vars(@report_name),@query,@db)
+      logger.info "FIELDS #{fields}"
+      fields
+    end
+
+    def query_vars report
+      return nil if report.nil? || report.length<=0
+      query_vars = @reports[report]['query_vars']
+      if !query_vars.nil? && query_vars.size > 0
+        return query_vars[0]
+      else
+        return nil
       end
+    end
+
+    def render_error(exception)
+      logger.error(exception)
+      render :template => "old_sql/errors/401.html.erb", :status => 401
+    end
+
+    def strip_html html
+      OldSql.strip_html html
+    end
+
+    def chart_data
+      return nil if @report.nil?
+      json = @report.values.first.to_json
+      json.html_safe
+    end
+
+    def chart_type
+      return nil if @report.nil?
+      @report.keys.first
+    end
+
+    def google_chart_colors
+      json = OldSql.google_chart_colors.to_json
+      json.html_safe
+    end
+
+    def db_list
+      db = []
+      db << {name: Rails.env.capitalize, db_class: "active_record/base"}
+    end
   end
 end
 

data/app/views/old_sql/report/_query.html.erb

@@ -0,0 +1,49 @@
+<script>
+jQuery(document).ready(function($){
+	$('#query-button').bind('click', function() {
+      	query();
+    });
+
+	$('#delete-saved-queries').bind('click', function() {
+      	deleted_saved_queries();
+    });
+
+	$('#saved-queries-list').bind('click', function() {
+		$('#query-text').val($("#saved-queries-list option:selected").val()); 
+    });
+});
+</script>
+
+<div class="query">
+	<div>
+		DATABASE: 
+		<select name="query-db" id="query-db" onchange="db_selected()">
+		<% db_list.each do |db| %>
+			<option value="<%=db[:name]%>" class_name="<%=db[:class_name]%>"><%=db[:name]%></option>
+		<% end %>
+		</select>
+	</div>
+
+	<div>
+		<textarea id="query-text" rows="12" cols="120"></textarea>
+	</div>
+
+	<div>
+		<input id="query-button" type="button" value="Run" onclick="return true;" /> or press ctrl-enter
+	</div>
+</div>                        
+
+<div id="saved_queries">
+	<div>
+		SAVED QUERIES:
+	</div>
+	
+	<div>
+		<select id="saved-queries-list" size="14">
+		</select>
+	</div>
+	
+	<div>
+		<input id="delete-saved-queries" type="button" value="Clear" onclick="return true;" />
+	</div>
+</div>

data/app/views/old_sql/report/_reports.html.erb

@@ -0,0 +1,40 @@
+<form id="report-form" name="report-form" action="/oldsql/reports/query" method="POST">
+	<div class="report-form-row">
+		<div class="report-form-label">SELECT A REPORT:</div>
+		<div class="report-form-input">
+			<select name="report" id="report" 
+				onchange="report_selected()">
+				<option></option>		
+				<% @reports.each do |report, data| %>
+				<option value="<%= data['name'] %>" report_sql="<%= data['report_sql'] %>" 
+				 desc="<%= data['description'] %>" name="<%=report%>" 
+				 report_view="<%=data['report_view']%>"><%= data['description'] %></option>
+				<% end %>
+			</select>
+		</div>
+	</div>
+
+	<div class="report-form-row">
+		<div class="report-form-label">START DATE:</div>
+		<div class="report-form-input">
+			<input type="text" id="datepicker-start" name="start_date" value="">
+		</div>
+	</div>
+
+	<div class="report-form-row">
+		<div class="report-form-label">END DATE:</div>
+		<div class="report-form-input">
+			<input type="text" id="datepicker-end" name="end_date" value="">
+		</div>
+	</div>
+
+	<div class="report-form-row">
+		<div class="report-form-label"></div>
+		<input type="button" value="Run" onclick="load_report();"/>
+	</div>
+</form>
+
+<div id="links">
+	<div><%= link_to_function("Print Report", "javascript:print_report()") %></div>
+	<div><%= link_to_function("Export To Excel", "javascript:export_report_to_excel()") %></div>
+</div>