old_sql 1.14.0 → 1.15.0

data/{README.rdoc → README.md}

@@ -1,37 +1,52 @@
-= Old SQL
+Old SQL
+=======
 
 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.
-  - 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.  
+  - 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) 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.
+* 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.
+* Support for printing and exporting to CSV.
 
-== Quick Setup and Demo
+Quick Setup and Demo
+--------------------
 
 1. Add gem 'old_sql', and gem 'devise' to your Gemfile.
-2. bundle instal
+2. bundle install
 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.
+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
+Screenshots
+-----------
+
+![jqGrid view](https://github.com/egonz/old_sql/raw/master/screenshots/jqgrid.png "jqGrid view")
+![table view](https://github.com/egonz/old_sql/raw/master/screenshots/table.png "Table view")
+![table view](https://github.com/egonz/old_sql/raw/master/screenshots/chart.png "Chart view")
+
+Installation
+------------
 
 To install Old SQL type:
 
@@ -44,9 +59,10 @@ This will create the following directories:
 
 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. 
+If not already installed Devise is setup.
 
-== Creating Reports
+Creating Reports
+----------------
 
 Configure your reports config/old_sql/report.yml. An example configuration is created when you run the old_sql:install generator.
 
@@ -65,7 +81,7 @@ Configure your reports config/old_sql/report.yml. An example configuration is cr
 	# 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.
+	# See config/old_sql/report_design/user_old_sql_demo.CSV for an example.
 	#
 	# 'report_view' is optional. It overrides the default_report_view defined in the initializer. It
 	# can be set to jqgrid, table, or chart.
@@ -73,31 +89,31 @@ Configure your reports config/old_sql/report.yml. An example configuration is cr
 	# The 'fields' are the headers for the report.
 
 	user_jqgrid:
-	description: User jqGrid
-	report_sql: user_old_sql_demo
-	report_design: user_old_sql_demo.csv
-	report_view: jqgrid
-	fields: 
-    	- 'id'
-    	- 'name'
+	  description: User jqGrid
+	  report_sql: user_old_sql_demo
+	  report_design: user_old_sql_demo.CSV
+	  report_view: jqgrid
+	  fields: 
+        - 'id'
+        - 'name'
     
 	user_table:
-	description: User HTML Table
-	report_sql: user_old_sql_demo
-	report_processor: User_Old_Sql_Demo_Processor
-	report_view: table
-	fields: 
-		- 'id'
-		- 'name'
+	  description: User HTML Table
+	  report_sql: user_old_sql_demo
+	  report_processor: User_Old_Sql_Demo_Processor
+	  report_view: table
+	  fields: 
+	    - 'id'
+	    - 'name'
     
 	user_chart:
-	description: User Chart
-	report_sql: user_old_sql_demo
-	report_design: user_old_sql_demo.yml
-	report_view: chart
-	fields: 
-		- 'id'
-		- 'name'
+	  description: User Chart
+	  report_sql: user_old_sql_demo
+	  report_design: user_old_sql_demo.yml
+	  report_view: chart
+	  fields: 
+	    - 'id'
+	    - 'name'
 
 Create a sql file under config/old_sql/report_sql. The following example is included:
 
@@ -106,7 +122,7 @@ Create a sql file under config/old_sql/report_sql. The following example is incl
 	WHERE u.created_at > date('<%=start_date.gsub('/','-')%>')
 	AND u.created_at < date('<%=end_date.gsub('/','-')%>')
 
-Optionally create a design file under config/old_sql/report_design:
+Optionally create a CSV DESIGN file under config/old_sql/report_design:
 
 	# Old SQL:
 	# Example Report Design Document
@@ -135,6 +151,22 @@ Optionally create a design file under config/old_sql/report_design:
 	"Divide by Zero 3",0.0 / 0.0
 	"Rounding",200.0 / 43.0
 
+Optionally create a CHART DESIGN file under config/old_sql/report_design:
+	
+	# Old SQL Chart Design Example
+	#
+	# The key can either be pie or bar.
+	# Items should be numbered from 0 to n.
+	# The value of each item can be either a column name, or
+	# a formula.
+
+	pie:
+  	  0: id + 10
+	  1: id + 20
+	  2: id + 50
+	  3: id + 70
+	  4: id + 100
+
 Optionally create a processor under lib/old_sql_report_processor:
 
 	require 'old_sql/report_processor/base'
@@ -148,8 +180,8 @@ Optionally create a processor under lib/old_sql_report_processor:
      
 	        Rails.logger.debug "REC: #{@rec}"
      
-	        add_row(nil, [@rec['id'], @rec['name']])
-	        add_row('Totals', ['...'])
+	        add_row([@rec['id'], @rec['name']])
+	        add_row(['Totals', '...'])
      
 	        @data
 	      end
@@ -157,7 +189,27 @@ Optionally create a processor under lib/old_sql_report_processor:
 	  end
 	end
 
-== Customize 
+Design File Tips
+----------------
+
+Design files, both CSV and CHART, work best (only?) with queries that return a single record.
+Ideally the query returns aggregate results, form one or more tables. For example:
+
+	SELECT
+		IFNULL(SUM(f.total),0) AS foo_total,
+		IFNULL(SUM(CASE WHEN f.attempts IS NOT NULL THEN 1 ELSE 0 END),0) AS foo_attempts,
+		IFNULL(bar_totals.bar_count,0) AS bar_count
+	FROM
+		foo f
+	JOIN
+		(SELECT COUNT(id) AS bar_count FROM bar) AS bar_totals
+	WHERE
+		1=1
+		AND f.created_at > '<%=start_date%>'
+		AND f.created_at < '<%=end_date%>'
+		
+Customize
+---------
 
 All css and html template files can be copied to your installation by executing: 
 
@@ -165,7 +217,8 @@ All css and html template files can be copied to your installation by executing:
 	
 Settings for Old SQL can be configured in config/initializers/old_sql.rb.
 
-== Rake Examples
+Rake Examples
+-------------
 
 	rake old_sql:print:range[user_table,'development','2011-03-01','2011-09-01']
 
@@ -173,7 +226,8 @@ Settings for Old SQL can be configured in config/initializers/old_sql.rb.
 
 	rake old_sql:print:week[user_table,'development']
 
-== Contributing to old_sql
+Contributing to old_sql
+-----------------------
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -183,7 +237,8 @@ Settings for Old SQL can be configured in config/initializers/old_sql.rb.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+Copyright
+---------
 
 Copyright (c) 2011 Eddie Gonzales. See LICENSE.txt for
 further details.

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

@@ -8,6 +8,7 @@
 var options = {
    "IECanvasHTC": "/plotkit/iecanvas.htc",
    "colorScheme": PlotKit.Base.palette(PlotKit.Base.baseColors()[0]),
+   "backgroundColor": Color.whiteColor(),
    "xTicks": <%=chart_fields%>,
    "drawYAxis": true
 };

data/lib/generators/old_sql/templates/user_old_sql_demo_chart_design.yml

@@ -1,4 +1,9 @@
 # Old SQL Chart Design Example
+#
+# The key can either be pie or bar.
+# Items should be numbered from 0 to n.
+# The value of each item can be either a column name, or
+# a formula.
 
 pie:
   0: id + 10

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

@@ -9,8 +9,8 @@ module OldSql
      
         Rails.logger.debug "REC: #{@rec}"
      
-        add_row(nil, [@rec['id'], @rec['name']])
-        add_row('Totals', ['...'])
+        add_row([@rec['id'], @rec['name']])
+        add_row(['Totals', '...'])
      
         @data
       end

data/lib/old_sql/report_processor/base.rb

@@ -182,11 +182,7 @@ module OldSql
         @data[:rows] = []
       end
   
-      def add_row(title = nil, cell_data = [], id = @id+1)        
-        if !title.nil?
-          cell_data.unshift "<b>#{title}</b>"
-        end
-    
+      def add_row(cell_data = [], id = @id+1)        
         @data[:rows] << {id: id, cell: cell_data}
       end
   

metadata

@@ -2,7 +2,7 @@
 name: old_sql
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors: 
 - Eddie Gonzales
@@ -42,11 +42,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - Gemfile
 - LICENSE.txt
-- README.rdoc
 - Rakefile
 - app/controllers/old_sql/report_controller.rb
 - app/views/layouts/old_sql/report.html.erb
@@ -440,6 +439,7 @@ files:
 - public/stylesheets/old_sql/ui-lightness/images/ui-icons_ffd27a_256x240.png
 - public/stylesheets/old_sql/ui-lightness/images/ui-icons_ffffff_256x240.png
 - public/stylesheets/old_sql/ui-lightness/jquery-ui-1.8.13.custom.css
+- README.md
 homepage: http://github.com/egonz/old_sql
 licenses: 
 - MIT
@@ -453,7 +453,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1769007801397558054
+      hash: 3219166271632423260
       segments: 
       - 0
       version: "0"