dossier 2.0.0 → 2.0.1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Adam Hunter
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,6 +1,11 @@
 # Dossier
 
-Dossier is a Rails engine that turns SQL into reports. Reports can be easily rendered in various formats, like HTML, CSV, and JSON. The SQL can be written by hand or generated by another tool, like ActiveRecord.
+Dossier is a Rails engine that turns SQL into reports. Reports can be easily rendered in various formats, like HTML, CSV, 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.
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/adamhunter/dossier)
 
 ## Setup
 
@@ -19,29 +24,34 @@ For example:
 ```ruby
 # app/reports/fancy_ketchup_report.rb
 class FancyKetchupReport < Dossier::Report
-  def sql 
+  def sql
     'SELECT * FROM ketchups WHERE fancy = true'
   end
 
   # Or, if you're using ActiveRecord and hate writing SQL:
-  def sql 
+  def sql
     Ketchup.where(fancy: true).to_sql
   end
 
 end
 ```
 
-If you need dynamic values that may be influenced by the user, [do not interpolate them directly](http://xkcd.com/327/). Dossier provides a safer way to add them: any symbols in the query will be replaced by calling methods of the same name in the report. Return values other than numerics will be coerced to strings and **escaped by the database**.
-  
+If you need dynamic values that may be influenced by the user, **[do not interpolate them directly](http://xkcd.com/327/)**. Dossier provides a safer way to add them: any symbols in the query will be replaced by calling methods of the same name in the report. Return values will be **escaped by the database connection**.  Arrays will have all of their contents escaped, joined with a "," and wrapped in parentheses.
+
 ```ruby
 # app/reports/fancy_ketchup_report.rb
 class FancyKetchupReport < Dossier::Report
   def sql
-    'SELECT * FROM ketchups WHERE brand = :brand'
+    "SELECT * FROM ketchups WHERE price <= :max_price and brand IN :brands"
+    # => "SELECT * FROM ketchups WHERE price <= 7 and brand IN ('Acme', 'Generic', 'SoylentRed')"
+  end
+
+  def max_price
+    7
   end
 
-  def brand
-    'Acme'
+  def brands
+    %w[Acme Generic SoylentRed]
   end
 end
 ```
@@ -65,7 +75,7 @@ Dossier also provides a `formatter` with access to all the standard Rails format
 class MoneyLaunderingReport < Dossier::Report
   #...
   def format_payment(value)
-    formatter.number_to_currency
+    formatter.number_to_currency(value)
   end
 end
 ```
@@ -73,14 +83,19 @@ end
 In addition, the formatter provides Rails' URL helpers for use in your reports. For example, in a report of your least profitable accounts, you might want to add a link to change the salesperson assigned to that account.
 
 ```ruby
-formatter.url_helpers.edit_accounts_path(3)
+class LeastProfitableAccountsReport < Dossier::Report
+  #...
+  def format_account_id(value)
+    formatter.link_to value, formatter.url_helpers.edit_accounts_path(value)
+  end
+end
 ```
 
 The built-in `ReportsController` uses this formatting when rendering the HTML and JSON representations, but not when rendering the CSV.
 
 ## Report Options and Footers
 
-You may want to specify parameters for a report: which columns to show, a range of dates, etc. Dossier supports this via URL parameters, which will be passed into your report's `initialize` method and made available via the `options` reader.
+You may want to specify parameters for a report: which columns to show, a range of dates, etc. Dossier supports this via URL parameters, anything in `params[:options]` will be passed into your report's `initialize` method and made available via the `options` reader.
 
 You can pass these options by hardcoding them into a link, or you can allow users to customize a report with a form. For example:
 
@@ -88,7 +103,6 @@ You can pass these options by hardcoding them into a link, or you can allow user
 # app/views/dossier/reports/employee.html.haml
 
 = form_for report, as: :options, url: url_for, html: {method: :get} do |f|
-
   = f.label "Salary greater than:"
   = f.text_field :salary_greater_than
   = f.label "In Division:"
@@ -98,7 +112,7 @@ You can pass these options by hardcoding them into a link, or you can allow user
 = render template: 'dossier/dossier/reports/show', locals: {report: report}
 ```
 
-It's up to you to use these options in generating your SQL query. 
+It's up to you to use these options in generating your SQL query.
 
 However, Dossier does support one URL parameter natively: if you supply a `footer` parameter with an integer value, the last N rows will be accesible via `report.results.footers` instead of `report.results.body`. The built-in `show` view renders those rows inside an HTML footer. This is an easy way to display a totals row or something similar.
 
@@ -154,7 +168,11 @@ end
 
 ## Advanced Usage
 
-To see a report with all the bells and whistles, check out `spec/support/reports/employee_report.rb`.
+To see a report with all the bells and whistles, check out `spec/support/reports/employee_report.rb` or other reports in `spec/support/reports`.
+
+## Compatibility
+
+Dossier currently supports all databases supported by ActiveRecord; it comes with `Dossier::Adapter::ActiveRecord`, which uses ActiveRecord connections for escaping and executing queries. However, as the `Dossier::Adapter` namespace implies, it was written to allow for other connection adapters. See `CONTRIBUTING.md` if you'd like to add one.
 
 ## Running the Tests
 
@@ -162,20 +180,19 @@ Note: when you run the tests, Dossier will **make and/or truncate** some tables
 
 - Run `bundle`
 - `cp spec/dummy/config/database.yml{.example,}` and edit it so that it can connect to the test database.
+- `cp spec/fixtures/db/mysql2.yml{.example,}`
+- `cp spec/fixtures/db/sqlite3.yml{.example,}`
 - `rspec spec`
 
-## TODO
-
-### Features
-
-- Support more databases
-
-### Moar Dokumentationz pleaze
+## Moar Dokumentationz pleaze
 
+- How Dossier uses ORM adapters to connect to databases, currently only AR's are used.
+- Examples of connecting to different databases, of the same type or a different one
 - Document using hooks and what methods are available in them
-- callbacks
-  - stored procedures
-  - reformat results
-- linking to reports
-  - linking to formats
+- Callbacks, eg:
+  - Stored procedures
+  - Reformat results
+- Linking 
+  - To other reports
+  - To other formats
 - Extending the formatter

data/app/controllers/dossier/reports_controller.rb

@@ -27,7 +27,7 @@ module Dossier
     private
 
     def report_class
-      "#{params[:report].classify}Report".constantize
+      "#{params[:report].split('_').map(&:capitalize).join}Report".constantize
     end
 
   end

data/lib/dossier/version.rb

@@ -1,3 +1,3 @@
 module Dossier
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/dossier_spec.rb

@@ -16,11 +16,11 @@ describe Dossier do
   end
 
   it "allows configuration via a block" do
-    @mysql_client = Mysql2::Client.new
+    some_client = Object.new
     Dossier.configure do |config|
-      config.client = @mysql_client
+      config.client = some_client
     end
-    Dossier.configuration.client.should eq(@mysql_client)
+    Dossier.configuration.client.should eq(some_client)
   end
 
   it "exposes the configurations client via Dossier.client" do

data/spec/dummy/config/database.yml

@@ -0,0 +1,13 @@
+defaults: &defaults
+  adapter: mysql2
+  database: dossier_test
+  host: localhost
+  username: root
+  password: yePassworde
+  
+development:
+  <<: *defaults
+test:
+  <<: *defaults
+production:
+  <<: *defaults

data/spec/dummy/config/environment.rb

@@ -3,7 +3,3 @@ require File.expand_path('../application', __FILE__)
 
 # Initialize the rails application
 Dummy::Application.initialize!
-
-%w[employee total].each do |report|
-  require File.expand_path("../../../support/reports/#{report}_report", __FILE__)
-end

data/spec/dummy/log/development.log

@@ -0,0 +1,33 @@
+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