old_sql 1.10.0 → 1.11.0

data/README.rdoc

@@ -2,7 +2,36 @@
 
 Old SQL is a Rails Engine database reporting gem that uses plain old SQL.
 
-= Installation
+Some features of Old SQL are:
+
+* Reports can be created using little or no Ruby code.
+  - This allows the 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 and report processor can parse the SQL.
+  - This also makes it simple to convert legacy reports into Old SQL reports.  
+* Multiple report views (jqGrid, HTML table) that can be configured using the old_sql initializer.
+* 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).
+* 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.
+
+== Quick Setup and Demo
+
+1. Add gem 'old_sql', and gem 'devise' to your Gemfile.
+2. bundle instal
+3. rails g old_sql:install, or rails g old_sql:install <model>
+4. rake db:migrate
+5. Ensure you have at least one user record, and that old_sql_admin=true.
+6. if you didn't previously have Devise installed open rails console, and select your old_sql_admin user, and set password and password_confirmation. Save, and exit.
+7. Type rails s to start your rails server.
+8. Navigate to http://localhost:3000/sql/reports
+9. Authenticate using your old_sql_admin user.
+10. Select user from the Reports drop down list. Click run.
+
+== Installation
 
 To install Old SQL type:
 
@@ -13,8 +42,43 @@ This will create the following directories:
 * config/old_sql
 * lib/old_sql
 
-Configure your reports config/old_sql/report.yml. 
+This generator will also create a migration that will add a old_sql_admin column to the model used for authentication (by default users).
+
+If not already installed Devise is setup. 
+
+== Setup
+
+Configure your reports config/old_sql/report.yml. An example configuration is created when you run the old_sql:install generator.
+
+	# Old SQL Reports YAML
+	# This is an example report. Replace it with your actual reports.
+	#
+	# 'description' is the value displayed in the 'SELECT A REPORT' drop down list.
+	#
+	# The 'report_sql' file should be located under config/old_sql/report_sql.
+	# See config/old_sql/report_sql/user_old_sql_demo.sql for an example.
+	#
+	# The 'processor' parameter is optional, and should point to a class in lib/old_sql.
+	# See lib/old_sql/user_old_sql_demo_processor.rb for an example.
+	# 
+	# 'report_processor' names should be capitalized and separated with underscores. The file
+	# itself should follow normal ruby class naming conventions.
+	#
+	# 'report_design' is also optional, and should point to a file in config/old_sql/report_design.
+	# See config/old_sql/report_design/user_old_sql_demo.csv for an example.
+	#
+	# The 'fields' are the headers for the report.
+
+	user:
+  	  description: User
+  	  report_sql: user_old_sql_demo
+  	  report_design: user_old_sql_demo
+  	  #report_processor: User_Old_Sql_Demo_Processor
+  	  fields: 
+		- 'id'
+		- 'name'
 
+== Customize 
 
 == Contributing to old_sql
  

data/app/controllers/old_sql/report_controller.rb

@@ -2,7 +2,7 @@ require 'csv'
 
 module OldSql
   class ReportController < ApplicationController
-    before_filter :authenticate_user!
+    before_filter :"authenticate_#{OldSql.devise_model}!"
     before_filter :ensure_old_sql_admin!
     before_filter :_init
     before_filter :_reports
@@ -22,7 +22,6 @@ module OldSql
     def jqgrid
       @start_date = params[:start_date]
       @end_date = params[:end_date]
-      @generation = params[:generation]
       @report_name = params[:report]
       @report_sql = params[:report_sql]
       
@@ -37,7 +36,6 @@ module OldSql
     def table
       @start_date = params[:start_date]
       @end_date = params[:end_date]
-      @generation = params[:generation]
       @report_name = params[:report]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
@@ -45,10 +43,6 @@ module OldSql
       @width = OldSql.report_width
       @height = OldSql.report_height
       
-      if !@generation.nil? && @generation.to_i >= 0
-        @report_sql << "_gen_#{@generation}"
-      end
-      
       processor = load_base_processor
       @report = processor.execute_query(@report_sql,@start_date,@end_date,query_vars(@report_name),@reports[@report_name]['report_design'],
                                         @reports[@report_name]['report_processor'])
@@ -59,15 +53,10 @@ module OldSql
     def query
       @start_date = params[:start_date]
       @end_date = params[:end_date]
-      @generation = params[:generation]
       @report_name = params[:report]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
       
-      if !@generation.nil? && @generation.to_i >= 0
-        @report_sql << "_gen_#{@generation}"
-      end
-      
       processor = load_base_processor
       @report = processor.execute_query(@report_sql,@start_date,@end_date,query_vars(@report_name),@reports[@report_name]['report_design'],
                                         @reports[@report_name]['report_processor'])
@@ -101,16 +90,11 @@ module OldSql
     def print
       @start_date = params[:start_date]
       @end_date = params[:end_date]
-      @generation = params[:generation]
       @report_name = params[:report]
       @desc = params[:desc]
       @report_sql = params[:report_sql].downcase
       @report_sql_orig = params[:report_sql].downcase
       
-      if !@generation.nil? && @generation.to_i >= 0
-        @report_sql << "_gen_#{@generation}"
-      end
-      
       processor = load_base_processor
       @report = processor.execute_query(@report_sql,@start_date,@end_date,query_vars(@report_name),@reports[@report_name]['report_design'],
                                         @reports[@report_name]['report_processor'])
@@ -121,7 +105,7 @@ module OldSql
 
     private
       def ensure_old_sql_admin!
-        render_error(Exception.new "Old SQL Access Denied.") unless current_user.old_sql_admin?
+        render_error(Exception.new "Old SQL Access Denied.") unless eval("current_user.old_sql_admin?")
       end
       
       def _init
@@ -166,6 +150,8 @@ module OldSql
       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

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

@@ -6,7 +6,7 @@
 <script>
 jQuery(document).ready(function(){
   jQuery("#rowed1").jqGrid({
-    url:"http://<%=@host%>:<%=@port%>/sql/reports/query.json/?report=<%=@report_name%>&report_sql=<%=@report_sql%>&generation=<%=@generation%>&start_date=<%=@start_date%>&end_date=<%=@end_date%>",
+    url:"http://<%=@host%>:<%=@port%>/sql/reports/query.json/?report=<%=@report_name%>&report_sql=<%=@report_sql%>&start_date=<%=@start_date%>&end_date=<%=@end_date%>",
   	datatype: "json",
   	pager: false,
     colNames: <%=jqgrid_col_names%>,

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

@@ -17,24 +17,12 @@ var report_view = "<%=@report_view%>";
 					onchange="report_selected()">
 					<option></option>		
 					<% @reports.each do |report, data| %>
-					<option value="<%= data['name'] %>" virality="<%= data['virality'] %>" report_sql="<%= data['report_sql'] %>" desc="<%= data['value'] %>"><%= data['value'] %></option>
+					<option value="<%= data['name'] %>" report_sql="<%= data['report_sql'] %>" desc="<%= data['description'] %>" name="<%=report%>"><%= data['description'] %></option>
 					<% end %>
 				</select>
 			</div>
 		</div>
 		
-		<div class="report-form-row">
-			<div class="report-form-label">GENERATION:</div>
-			<div class="report-form-input">
-				<select name="generation" id="select-generation">
-					<option value="-1"></option>
-					<option value="0">0</option>
-					<option value="1">1</option>
-					<option value="2">2</option>
-				</select>
-			</div>
-		</div>
-		
 		<div class="report-form-row">
 			<div class="report-form-label">START DATE:</div>
 			<div class="report-form-input">

data/lib/generators/old_sql/copy_assets_generator.rb

@@ -15,6 +15,7 @@ module OldSql
     
     def copy_old_sql_files
       copy_file "#{gem_path}/public/stylesheets/old_sql/old_sql.css", "#{app_path}/public/stylesheets/old_sql/old_sql.css"
+      copy_file "#{gem_path}/public/stylesheets/old_sql/old_sql.css", "#{app_path}/public/stylesheets/old_sql/table.css"
       copy_file "#{gem_path}/app/views/layouts/old_sql/report.html.erb", "#{app_path}/app/views/layouts/old_sql/report.html.erb"
     end
     

data/lib/generators/old_sql/install_generator.rb

@@ -61,6 +61,11 @@ module OldSql
       copy_file "user_design_template.csv", "#{app_path}/config/old_sql/report_design/user_old_sql_demo.csv"
     end
     
+    def configure_initializer
+      initializer_path = "#{app_path}/config/initializers/old_sql.rb"
+      gsub_file initializer_path, /DeviseModel/, "#{model_name.downcase}"
+    end
+    
     ################ PRIVATE ################
 
     private

data/lib/generators/old_sql/templates/old_sql.rb

@@ -1,5 +1,8 @@
 # Use this hook to configure the default report view, etc.
 OldSql.setup do |config|
+  # The model used by devise. Ensure that the devise columns are installed in the model.
+  config.devise_model = 'DeviseModel'
+  
   # ==> Default Report View Configuration
   # The title of the Report Selection View.
   config.report_select_page_title = 'Old SQL Reports'

data/lib/generators/old_sql/templates/reports.yml.example

@@ -1,14 +1,25 @@
 # Old SQL Reports YAML
 # This is an example report. Replace it with your actual reports.
 #
-# 'processor:' is optional, and should point to a class in lib/old_sql.
-# See lib/old_sql/user_processor.rb for an example.
+# 'description' is the value displayed in the 'SELECT A REPORT' drop down list.
+#
+# The 'report_sql' file should be located under config/old_sql/report_sql.
+# See config/old_sql/report_sql/user_old_sql_demo.sql for an example.
+#
+# The 'processor' parameter is optional, and should point to a class in lib/old_sql.
+# See lib/old_sql/user_old_sql_demo_processor.rb for an example.
+# 
+# 'report_processor' names should be capitalized and separated with underscores. The file
+# itself should follow normal ruby class naming conventions.
+#
+# 'report_design' is also optional, and should point to a file in config/old_sql/report_design.
+# See config/old_sql/report_design/user_old_sql_demo.csv for an example.
+#
+# The 'fields' are the headers for the report.
 
 user:
-  name: user
-  value: User
+  description: User
   report_sql: user_old_sql_demo
-  virality: false
   report_design: user_old_sql_demo
   #report_processor: User_Old_Sql_Demo_Processor
   fields: 

data/lib/old_sql.rb

@@ -1,6 +1,10 @@
 module OldSql
   require 'old_sql/engine' if defined?(Rails)
   
+  # The model used by devise. Ensure that the devise columns are installed in the model.
+  mattr_accessor :devise_model
+  @@devise_model = 'user'
+  
   # The title of the Report Selection View.
   mattr_accessor :report_select_page_title
   @@report_select_page_title = 'Old SQL Reports'

data/public/javascripts/old_sql/old_sql.js

@@ -1,28 +1,13 @@
-var _report_sql = '';
-var _report_loaded = false;
-
-function report_selected()
-{
-	var virality = jQuery("#report option:selected").attr('virality');
-	_report_sql = jQuery("#report option:selected").attr('report_sql');
-	
-  	if (virality == 'true')
-	{
-		jQuery("#select-generation").removeAttr('disabled');
-	}
-	else
-	{
-		jQuery("#select-generation").attr('disabled', 'disabled');
-		jQuery("#select-generation option:first").attr('selected','selected');
-	}
-}
-
 function load_report()
 {	
-	var src = "http://"+host+":"+port+"/sql/reports/"+report_view+"/?report="+jQuery("#report").val()+
-	"&start_date="+jQuery("#datepicker-start").val()+"&end_date="+jQuery("#datepicker-end").val()+"&generation="+
-	jQuery("#select-generation").val()+"&report_sql="+
-	_report_sql;
+  report_name = jQuery("#report option:selected").attr('name');
+  report_sql = jQuery("#report option:selected").attr('report_sql');
+
+  if (!reported_selected(report_name)) return;
+  
+	var src = "http://"+host+":"+port+"/sql/reports/"+report_view+"/?report="+report_name+
+	"&start_date="+jQuery("#datepicker-start").val()+"&end_date="+jQuery("#datepicker-end").val()+"&report_sql="+
+	report_sql;
 	
 	jQuery('iframe').attr('src', src);
 	
@@ -31,40 +16,45 @@ function load_report()
 
 function print_report()
 {
-	if(_report_loaded == false) 
-	{
-		alert("You must select a report, and run it before continuing.");
-		return;
-	}
+	report_name = jQuery("#report option:selected").attr('name');
+  report_sql = jQuery("#report option:selected").attr('report_sql');
+	
+	if (!reported_selected(report_name)) return;
 	
-	var src = "http://"+host+":"+port+"/sql/reports/print/?report="+jQuery("#report").val()+
-		"&start_date="+jQuery("#datepicker-start").val()+"&end_date="+jQuery("#datepicker-end").val()+"&generation="+
-		jQuery("#select-generation").val()+"&report_sql="+_report_sql+"&desc="+jQuery("#report option:selected").attr('desc');
+	var src = "http://"+host+":"+port+"/sql/reports/print/?report="+report_name+
+		"&start_date="+jQuery("#datepicker-start").val()+"&end_date="+jQuery("#datepicker-end").val()+
+		"&report_sql="+report_sql+"&desc="+jQuery("#report option:selected").attr('desc');
 	window.open(src,'Old SQL Report')
 }
 
 function export_report_to_excel()
 {
-	if(_report_loaded == false) 
-	{
-		alert("You must select a report, and run it before continuing.");
-		return;
-	}
+	report_name = jQuery("#report option:selected").attr('name');
+  report_sql = jQuery("#report option:selected").attr('report_sql');
+	
+	if (!reported_selected(report_name)) return;
 	
-	var src = "http://"+host+":"+port+"/sql/reports/query.csv/?report="+jQuery("#report").val()+
+	var src = "http://"+host+":"+port+"/sql/reports/query.csv/?report="+report_name+
 		"&start_date="+jQuery("#datepicker-start").val()+"&end_date="+jQuery("#datepicker-end").val()+
-		"&generation="+jQuery("#select-generation").val()+"&report_sql="+
-		_report_sql+"&desc="+jQuery("#report option:selected").attr('desc');
+		"&report_sql="+ report_sql+"&desc="+jQuery("#report option:selected").attr('desc');
 	window.open(src,'DB Report')
 }
 
+function reported_selected(report_name) 
+{
+  if (!report_name) {
+    alert("You must select a report, and run it before continuing.");
+    return false;
+  } else {
+    return true;
+  }
+}
+
 jQuery(document).ready(function($){
 	jQuery("#datepicker-start").datetimepicker();
 	jQuery("#datepicker-start").datetimepicker( "option", "dateFormat", "yy/mm/dd" );
 	jQuery("#datepicker-end").datetimepicker();
 	jQuery("#datepicker-end").datetimepicker( "option", "dateFormat", "yy/mm/dd" );
-
-	jQuery("#select-generation").attr('disabled', 'disabled');
 	
 	var now = new Date();
 	var tomorrow = new Date();

metadata

@@ -2,7 +2,7 @@
 name: old_sql
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors: 
 - Eddie Gonzales
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1338027586824661245
+      hash: 780971945359697670
       segments: 
       - 0
       version: "0"