sequel-reporter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-reporter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pete Keen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Sequel::Reporter
+
+`Sequel::Reporter` is a small opinionated framework for writing web-based reports using the [Sequel](http://sequel.rubyforge.org) database toolkit. It provides a simple structure and helpers for easily writing reports.
+
+## Installation
+
+    $ gem install sequel-reporter
+
+## Usage
+
+Generate a new reporting project using the sequel-reporter binary:
+
+    $ sequel-reporter new foo
+    $ cd foo
+    $ bundle install
+    $ bundle exec rackup
+    
+Then navigate your browser to http://localhost:9292
+
+## Writing Reports
+
+Reports are `erb` files located in `views/reports`. Here's a very simple example report:
+
+    <% @query = query do %>
+      select "pete" as name, 28 as age
+    <% end %>
+    <%= table @query %>
+    
+### Helpers
+
+The `query` helper takes a block of SQL and returns a `Sequel::Reporter::Report` instance. It can take a few options:
+
+* `:pivot` is the name of a column to pivot the report on. 
+* `:pivot_sort_order` says how to order the resulting pivoted columns. Can be `asc` or `desc`. Defaults to `asc`.
+
+Sequel Reporter uses [Twitter Bootstrap](http://twitter.github.com/bootstrap) for formatting, so you can use whatever you want to format your reports from there. 
+
+The `table` helper takes a query produced by the `query` helper and some options and builds an HTML table. Also, it can take a `:links` option which will linkify values in the table. Here's an example:
+
+    :links => {"Account" => "/reports/register?account=:1"}
+    
+This says that every value in the `Account` column will be surrounded with an `<a>` tag pointing at `/reports/register?account=:1`, where `:1` will be replaced by the value in column 1 of that particular row. You can also use `:title` in a link template. It will get replaced with the title of the column that is currently getting linked. In this case, `:title` would get replaced with `Account`.
+
+### Reports as Classes
+
+Sometimes writing a report in a `erb` file isn't the most convenient thing. If you want, you can write the query portion of a report as a class and put it in the `lib` directory. All `.rb` files in `lib` and subdirectories will be loaded at application start up. The idiom to use is to construct a class with a class-level `run` method which takes a `db`, which is then passed to `from_query`. Here's an example:
+
+    class SomeComplicatedReport < Sequel::Reporter::Report
+      def self.run(db)
+        from_query(db, """
+          select "something complicated" as foo
+        """)
+      end
+    end
+
+Then in your `erb` report you'd use it like this:
+
+    <%= table SomeComplicatedReport.run(@db) %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :test do
+  system 'rspec --color --format=documentation test'
+end

data/bin/sequel-reporter

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require "sequel-reporter"
+rescue LoadError => e
+  path = File.expand_path '../../lib', __FILE__
+  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
+  require 'sequel-reporter'
+end
+
+Sequel::Reporter::CLI.start  

data/data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'sequel-reporter'
+
+# Uncomment the appropriate database gem or add your own for
+# your database
+
+#gem 'pg'
+#gem 'mysql2'
+#gem 'sqlite3-ruby'

data/data/Rakefile.tt

@@ -0,0 +1,10 @@
+require 'rubygems'
+require './application'
+require 'sequel/extensions/migration'
+
+namespace :db do
+  task :migrate => :environment do
+    app = <%= @name.capitalize %>::Application.new
+    Sequel::Migrator.apply(app.db, 'migrate')
+  end
+end

data/data/application.rb.tt

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'sequel-reporter'
+
+module <%= @name.capitalize %>
+  class Application < Sequel::Reporter::Application
+    # Set this to the URL for your database. Remember to
+    # uncomment the correct gem in the Gemfile for your
+    # sequel adapter.
+    set :database_url, 'sqlite:///'
+
+    # Set this to the report that should be used for your index
+    set :index_report, :dashboard
+
+    # Set this to the base directory for the app
+    set :root, File.expand_path("..", __FILE__)
+  end
+end

data/data/config.ru

@@ -0,0 +1,3 @@
+require './application'
+
+run <%= @name.capitalize %>::Application