reporta-modules 0.0.1

data/spec/dummy/app/assets/stylesheets/style.css

@@ -0,0 +1,57 @@
+body { padding: 20px 0; }
+.highlight { background: rgb(255, 255, 187); }
+.chart {
+  width: 100%;
+  height: 300px;
+}
+.filters {
+  margin-bottom: 10px;
+  padding: 10px;
+  background: rgb(243, 243, 243);
+  -webkit-border-radius: 6px;
+  -moz-border-radius: 6px;
+  border-radius: 6px;
+}
+
+.no-bootstap select { width: auto; }
+
+/* The .bs-docs-sidenav styles a lovingly stolen from the Bootstrap demo site. */
+.bs-docs-sidenav {
+  width: 228px;
+  margin: 20px 0 0 0;;
+  padding: 0;
+  background-color: #fff;
+  -webkit-border-radius: 6px;
+  -moz-border-radius: 6px;
+  border-radius: 6px;
+  -webkit-box-shadow: 0 1px 4px rgba(0,0,0,.065);
+  -moz-box-shadow: 0 1px 4px rgba(0,0,0,.065);
+  box-shadow: 0 1px 4px rgba(0,0,0,.065);
+}
+.bs-docs-sidenav > li > a {
+  display: block;
+  width: 190px \9;
+  margin: 0 0 -1px;
+  padding: 8px 14px;
+  border: 1px solid #e5e5e5;
+}
+.bs-docs-sidenav > li:first-child > a {
+  -webkit-border-radius: 6px 6px 0 0;
+  -moz-border-radius: 6px 6px 0 0;
+  border-radius: 6px 6px 0 0;
+}
+.bs-docs-sidenav > li:last-child > a {
+  -webkit-border-radius: 0 0 6px 6px;
+  -moz-border-radius: 0 0 6px 6px;
+  border-radius: 0 0 6px 6px;
+}
+.bs-docs-sidenav > .active > a {
+  position: relative;
+  z-index: 2;
+  padding: 9px 15px;
+  border: 0;
+  text-shadow: 0 1px 0 rgba(0,0,0,.15);
+  -webkit-box-shadow: inset 1px 0 0 rgba(0,0,0,.1), inset -1px 0 0 rgba(0,0,0,.1);
+  -moz-box-shadow: inset 1px 0 0 rgba(0,0,0,.1), inset -1px 0 0 rgba(0,0,0,.1);
+  box-shadow: inset 1px 0 0 rgba(0,0,0,.1), inset -1px 0 0 rgba(0,0,0,.1);
+}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/reports_controller.rb

@@ -0,0 +1,18 @@
+class ReportsController < ApplicationController
+
+  def table
+    @report = AccountReport.new(params[:form])
+  end
+
+  def dynamic_table
+    @report = AccountReport.new(params[:form])
+  end
+
+  def dynamic_table_with_bootstrap
+    @report = AccountReport.new(params[:form])
+  end
+
+  def chart
+    @report = AccountChart.new(params[:form])
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def mailto(record)
+    mail_to record
+  end
+end

data/spec/dummy/app/models/account.rb

@@ -0,0 +1,3 @@
+class Account < ActiveRecord::Base
+  has_many :users
+end

data/spec/dummy/app/models/account_chart.rb

@@ -0,0 +1,41 @@
+class AccountChart
+  include Reporta::Report
+
+  filter :gender, collection: %w(Any Male Female), include_blank: false
+
+  x_axis :months, as: :date, format: "%Y-%m-%d"
+  y_axis :accounts, title: 'Total Accounts'
+
+  line_chart :sign_ups
+  column_chart :average_age, line_width: 20, align: :left
+
+  def months
+    @months ||= (1..12).map { |month| Date.new(Date.today.year, month) }
+  end
+
+  def sign_ups(month)
+    total = accounts_by_month[month.to_date].to_a.size
+    [month.to_time.to_i * 1000, total]
+  end
+
+  def average_age(month)
+    accounts = accounts_by_month[month.to_date]
+    average = accounts.sum(&:age) / accounts.size
+    [month.to_time.to_i * 1000, average]
+  end
+
+  private
+
+  def accounts_by_month
+    @accounts_by_month ||= begin
+      users = User.all
+      if gender.present? && gender != 'Any'
+        users = users.where(gender: gender)
+      end
+      users.group_by do |account|
+        account.created_at.beginning_of_month.to_date
+      end
+    end
+  end
+
+end

data/spec/dummy/app/models/account_report.rb

@@ -0,0 +1,39 @@
+class AccountReport
+  include Reporta::Report
+
+  filter :first_name
+  filter :age
+  filter :gender, collection: %w(Any Male Female), include_blank: false
+  filter :active, as: :boolean
+
+  column :first_name, helper: :mailto
+  column :last_name
+  column :age, class_names: 'highlight'
+  column :gender
+  column :active, title: 'Enabled'
+  column :account, data_chain: 'account.name'
+  column :created
+
+  def rows
+    users = User.where(active: active)
+
+    # Filter by substring match on first_name
+    if first_name.present?
+      users = users.where("LOWER(users.first_name) LIKE '%#{first_name.downcase}%'")
+    end
+
+    # Filter by selecte age
+    users = users.where(age: age) if age.present?
+
+    # Filter by gender unless the 'Any' option is selected
+    if gender.present? && gender != 'Any'
+      users = users.where(gender: gender)
+    end
+
+    users
+  end
+
+  def created(user)
+    user.created_at.strftime("%b %d, %Y")
+  end
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,8 @@
+class User < ActiveRecord::Base
+  belongs_to :account
+  GENDER = %w/male female/
+
+  def to_s
+    first_name
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= content_for :head %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="container">
+    <div class="row">
+      <div class="span3">
+        <ul class="nav nav-list bs-docs-sidenav affix">
+          <li><%= link_to 'Overview', '/' %></li>
+          <li><%= link_to 'Basic Table', '/table' %></li>
+          <li><%= link_to 'Dynamic Table', '/dynamic_table' %></li>
+          <li><%= link_to 'Dynamic Table With Bootstrap', '/dynamic_table_with_bootstrap' %></li>
+          <li><%= link_to 'Basic Chart', '/chart' %></li>
+        </ul>
+      </div>
+      <div class="span9">
+        <%= yield %>
+      </div>
+    </div>
+  </div>
+</body>
+</html>

data/spec/dummy/app/views/reports/chart.html.erb

@@ -0,0 +1,6 @@
+<h2>Basic Chart</h2>
+
+<div class="filters">
+  <%= filters_for(@report) %>
+</div>
+<%= chart_for(@report, class_name: 'table') %>

data/spec/dummy/app/views/reports/dynamic_table.html.erb

@@ -0,0 +1,33 @@
+<h2>Dynamic Table</h2>
+<p>To create a table with client side pagination, inline filtering and other dynamic goodies you first need to include some Javascript files. The Reporta dynamic tables use <%= link_to 'DataTables', 'http://datatables.net/index' %> under the hood so anything you can do with DataTables you can do here as well.</p>
+<p>If you don't already have it you will need a copy of <%= link_to 'jQuery', 'http://jquery.com/' %> and <%= link_to 'DataTables', 'http://datatables.net/download/' %> in your app/assets/javascripts directory</p>
+<p>In your application.js file make sure you have the following lines in this order:</p>
+<blockquote>#= require jquery<br/>
+#= require jquery.dataTables<br/>
+#= require reporta/dataTables
+</blockquote>
+<p>Now the dependencies are loaded we can display the report below like this:</p>
+<blockquote><%%= filters_for(@report) %><br />
+<%%= table_for(@report, class_name: 'table') %><br />
+&lt;script type="text/javascript" charset="utf-8"&gt;<br />
+&#160;&#160;$(function() {<br />
+&#160;&#160;&#160;&#160;new Reporta.DynamicTable('.table');<br />
+&#160;&#160;});<br />
+&lt;/script&gt;<br />
+</blockquote>
+<p>The only difference between this and the <%= link_to 'Basic Table', '/table' %> is we added the extra Javascript that is called after the page is loaded to make the table dynamic.</p>
+<p><strong>Note:</strong> As we are using Bootstrap here on the demo page the styling below is not quite right. It should look more like a deafult DataTable on your page. If you are using Bootstrap checkout the <%= link_to 'Dynamic Table With Bootstrap', '/dynamic_table_with_bootstrap' %> page.</p>
+
+<h3>Example</h3>
+<div class="filters">
+  <%= filters_for(@report) %>
+</div>
+<div class="no-bootstap">
+  <%= table_for(@report, class_name: 'table') %>
+</div>
+
+<script type="text/javascript" charset="utf-8">
+  $(function() {
+    new Reporta.DynamicTable('.table');
+  });
+</script>

data/spec/dummy/app/views/reports/dynamic_table_with_bootstrap.html.erb

@@ -0,0 +1,37 @@
+<%= content_for :head do %>
+  <%= javascript_include_tag "reporta/dataTables.bootstrap" %>
+<% end %>
+
+<h2>Dynamic Table With Bootstrap</h2>
+<p>To get the data table looking nice with Bootstrap there is a few things that need to happen. First we need to make sure the following in you application.js file (note the extra dataTables.bootstrap file)</p>
+<blockquote>#= require jquery<br />
+#= require jquery.dataTables<br />
+#= require reporta/dataTables<br />
+#= require reporta/dataTables.bootstrap<br />
+</blockquote>
+<p>Now you can display the report like this:</p>
+<blockquote><%%= filters_for(@report) %><br />
+<%%= table_for(@report, class_name: 'table') %><br />
+&lt;script type="text/javascript" charset="utf-8"&gt;<br />
+&#160;&#160;$(function() {<br />
+&#160;&#160;&#160;&#160;new Reporta.DynamicTable('.table.dynamic', { bootstrap: true });<br />
+&#160;&#160;});<br />
+&lt;/script&gt;<br />
+</blockquote>
+<p>The only difference between this and the <%= link_to 'Dynamic Table', '/dynamic_table'  %> example is the extra Javascript file and passing bootstrap: true to Reporta.DynamicTable.</p>
+<h3>Example</h3>
+<div class="filters">
+  <%= filters_for(@report) %>
+</div>
+<div class="no-bootstap">
+  <%= table_for(@report, class_name: 'table dynamic') %>
+</div>
+
+<script type="text/javascript" charset="utf-8">
+  $(function() {
+    new Reporta.DynamicTable('.table.dynamic', {
+      bootstrap: true
+    });
+  });
+</script>
+

data/spec/dummy/app/views/reports/overview.html.erb

@@ -0,0 +1,4 @@
+<h2>Installing</h2>
+<blockquote>
+  gem 'reporta'
+</blockquote>

data/spec/dummy/app/views/reports/table.html.erb

@@ -0,0 +1,12 @@
+<h2>Basic Table</h2>
+<p>To output your report as a table you must define a method named <strong>rows</strong> and at least 1 <strong>column</strong> within you report class. This method should return an array (or other enumerable object) with each item representing a row in the table.</p>
+<p>The filtering form and the table below are output using the following 2 helpers.</p>
+<blockquote><%%= filters_for(@report) %><br />
+<%%= table_for(@report, class_name: 'table') %>
+</blockquote>
+<p>The class_name option sets the class of the generated table, here we are setting it to "table" so Bootstrap will add some basic styling</p>
+<h3>Example</h3>
+<div class="filters">
+  <%= filters_for(@report) %>
+</div>
+<%= table_for(@report, class_name: 'table') %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "reporta-modules"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end