dossier 2.1.1 → 2.2.0

data/README.markdown

@@ -1,20 +1,31 @@
 # Dossier
 
-Dossier is a Rails engine that turns SQL into reports. Reports can be easily rendered in various formats, like HTML, CSV, and JSON.
+Dossier is a Rails engine that turns SQL into reports. Reports can be easily rendered in various formats, like HTML, CSV, XLS, and JSON.
 
 - If you **hate** SQL, you can use whatever tool you like to generate it; for example, ActiveRecord's `to_sql`.
-- If you **love** SQL, you can use every feature feature your database supports.
+- If you **love** SQL, you can use every feature your database supports.
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/adamhunter/dossier)
 
 ## Setup
 
-Install the Dossier gem and create `config/dossier.yml`. This has the same format as Rails' `database.yml`, and can actually just be a symlink: `ln -s config/{database,dossier}.yml`.
+Install the Dossier gem and create `config/dossier.yml`. This has the same format as Rails' `database.yml`, and can actually just be a symlink (from your `Rails.root`: `ln -s database.yml config/dossier.yml`).
 
 ## Routing
 
 Dossier will add a route to your app so that `reports/fancy_ketchup` will instantiate and run a `FancyKetchupReport`. It will respond with whatever format was requested; for example `reports/fancy_ketchup.csv` will render the results as CSV.
 
+## Formats
+
+Dossier currently supports outputting to the following formats:
+
+- HTML
+- CSV
+- XLS
+- JSON
+
+Any of these formats can be requested by using the appropriate format extension on the end of the report's URL.
+
 ## Basic Reports
 
 In your app, create report classes under `app/reports`, with `Report` as the end of the class name. Define a `sql` method that returns the sql string to be sent to the database.
@@ -91,7 +102,7 @@ class LeastProfitableAccountsReport < Dossier::Report
 end
 ```
 
-The built-in `ReportsController` uses this formatting when rendering the HTML and JSON representations, but not when rendering the CSV.
+The built-in `ReportsController` uses this formatting when rendering the HTML and JSON representations, but not when rendering the CSV or XLS.
 
 If your formatting method takes a second argment, it will be given a hash of the values in the row.
 
@@ -209,3 +220,8 @@ Note: when you run the tests, Dossier will **make and/or truncate** some tables
   - To other formats
 - Extending the formatter
 - Show how to do "crosstab" reports (preliminary query to determine columns, then build SQL case statements?)
+
+## Roadmap
+
+- Moar Dokumentationz pleaze
+- Use the [`roo`](https://github.com/hmcgowan/roo) gem to generate a variety of output formats

data/app/controllers/dossier/reports_controller.rb

@@ -21,6 +21,11 @@ module Dossier
           headers["Content-Disposition"] = %[attachment;filename=#{params[:report]}-report_#{Time.now.strftime('%m-%d-%Y-%H%M%S')}.csv]
           self.response_body = StreamCSV.new(report.raw_results.arrays)
         end
+
+        format.xls do
+          headers["Content-Disposition"] = %[attachment;filename=#{params[:report]}-report_#{Time.now.strftime('%m-%d-%Y-%H%M%S')}.xls]
+          self.response_body = Xls.new(report.raw_results.arrays)
+        end
       end
     end
 

data/config/initializers/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/xls", :xls

data/lib/dossier/version.rb

@@ -1,3 +1,3 @@
 module Dossier
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/lib/dossier/xls.rb

@@ -0,0 +1,34 @@
+module Dossier
+  class Xls
+
+    HEADER = %Q{<?xml version="1.0" encoding="UTF-8"?>\n<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet" xmlns:html="http://www.w3.org/TR/REC-html40">\n<Worksheet ss:Name="Sheet1">\n<Table>\n}
+    FOOTER = %Q{</Table>\n</Worksheet>\n</Workbook>\n}
+
+    def initialize(collection, headers = nil)
+      @headers    = headers || collection.shift
+      @collection = collection
+    end
+
+    def each
+      yield HEADER
+      yield headers_as_row
+      @collection.each { |record| yield as_row(record) }
+      yield FOOTER
+    end
+
+    private
+
+    def as_cel(el)
+      %{<Cell><Data ss:Type="String">#{el}</Data></Cell>}
+    end
+
+    def as_row(array)
+      my_array = array.map{|a| as_cel(a)}.join("\n")
+      "<Row>\n" + my_array + "\n</Row>\n"
+    end
+
+    def headers_as_row
+      as_row(@headers.map { |header| Dossier::Formatter.titleize(header) })
+    end
+  end
+end

data/lib/dossier.rb

@@ -29,3 +29,4 @@ require "dossier/query"
 require "dossier/report"
 require "dossier/result"
 require "dossier/stream_csv"
+require "dossier/xls"

data/spec/dummy/config/database.yml

@@ -3,7 +3,7 @@ defaults: &defaults
   database: dossier_test
   host: localhost
   username: root
-  password: yePassworde
+  password: rubyr3d!
   
 development:
   <<: *defaults

data/spec/dummy/log/development.log

@@ -1,33 +1 @@
-Connecting to database specified by database.yml
-   (45.0ms)  CREATE TABLE `employees` (`id` int(11) DEFAULT NULL auto_increment PRIMARY KEY, `name` varchar(255), `hired_on` date, `suspended` tinyint(1)) ENGINE=InnoDB
-   (217.3ms)  CREATE TABLE `schema_migrations` (`version` varchar(255) NOT NULL) ENGINE=InnoDB
-   (141.9ms)  CREATE UNIQUE INDEX `unique_schema_migrations` ON `schema_migrations` (`version`)
-   (0.2ms)  SELECT version FROM `schema_migrations`
-   (0.3ms)  INSERT INTO `schema_migrations` (version) VALUES ('20130110141950')
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (1.5ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Migrating to CreateEmployees (20130110141950)
-Migrating to AddDivisionToEmployees (20130110221932)
-   (109.6ms)  ALTER TABLE `employees` ADD `division` varchar(255)
-   (0.5ms)  INSERT INTO `schema_migrations` (`version`) VALUES ('20130110221932')
-   (0.2ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Connecting to database specified by database.yml
-   (1.7ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-   (0.3ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Migrating to AddDivisionToEmployees (20130110221932)
-   (85.8ms)  ALTER TABLE `employees` DROP `division`
-   (0.6ms)  DELETE FROM `schema_migrations` WHERE `schema_migrations`.`version` = '20130110221932'
-   (0.1ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Connecting to database specified by database.yml
-   (1.6ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Migrating to CreateEmployees (20130110141950)
-Migrating to AddDivisionToEmployees (20130110221932)
-   (50.1ms)  ALTER TABLE `employees` ADD `division` varchar(255)
-   (238.4ms)  ALTER TABLE `employees` ADD `salary` int(11)
-   (0.4ms)  INSERT INTO `schema_migrations` (`version`) VALUES ('20130110221932')
-   (0.3ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` 
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
 Connecting to database specified by database.yml