Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

More documentation

  • Loading branch information...
commit bce5b32feae048968e2b3dfa70e62bb327230b64 1 parent 4672249
@nathanl nathanl authored
Showing with 23 additions and 13 deletions.
  1. +11 −0 CONTRIBUTING.md
  2. +12 −13 README.markdown
View
11 CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing to Dossier
+
+All contributions to Dossier must come well-tested.
+
+## Adapters
+
+Dossier currently has `Dossier::Adapter::ActiveRecord`, which allows it to get an ActiveRecord connection and use it for escaping queries, and executing them. It wraps the returned result object in a `Dossier::Adapter::ActiveRecord::Result`, which simply provides a standard way of getting headers and rows.
+
+If you'd like to add the ability to use a different ORM's connections, you'd need to add a new adapter class and a new adapter result class.
+
+You'd also need to update `Client#loaded_orms` to check for the presence of your ORM.
View
25 README.markdown
@@ -165,6 +165,10 @@ end
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
Note: when you run the tests, Dossier will **make and/or truncate** some tables in the `dossier_test` database.
@@ -175,19 +179,14 @@ Note: when you run the tests, Dossier will **make and/or truncate** some tables
- `cp spec/fixtures/db/sqlite3.yml{.example,}`
- `rspec spec`
-## TODO
-
-### Features
-
-- Support more orm adapters
-
-### Moar Dokumentationz pleaze
+## Moar Dokumentationz pleaze
-- Document how Dossier uses ORM adapters to connect to databases, currently only AR's are used.
+- How Dossier uses ORM adapters to connect to databases, currently only AR's are used.
- 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
Please sign in to comment.
Something went wrong with that request. Please try again.