query_report 0.1.2 → 1.0.0

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2013 A.K.M. Ashrafuzzaman
-
-MIT License
+Copyright 2013 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,74 +1,53 @@
-# QueryReport
-The purpose of this gem is to create reports with just the basic query with the built in following features,
-*   Pagination (with Kaminari)
-*   Basic filters (with Ransack)
-*   Custom filter
-*   Export with html, PDF (with Prawn PDF), CSV, JSON
+[Query report](http://ashrafuzzaman.github.io/query_report/) By [Ashrafuzzaman](http://www.ashrafuzzaman.com).
 
-The gem is still in infant stage. So I would just ask you to keep an eye on this for now.
+Query report is a reporting tool, which does the following:
 
-## Installation
+* Generate paginated HTML view with filters, defined columns with sorting
+* Generate PDF, CSV, JSON
+* Provide feature to define re usable custom filter
 
-Add this line to your application's Gemfile:
+As built in filter I have used [ransack](https://github.com/ernie/ransack) and pagination with [kaminari](https://github.com/amatsuda/kaminari)
 
-    gem 'query_report'
+## The purpose
+The purpose of this gem is to produce consistent reports quickly and manage them easily. Because all we need to
+concentrate in a report is the query and filter.
 
-And then execute:
+## Getting started
+Query report is tested with Rails 3. You can add it to your Gemfile with:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install query_report
-
-## Usage
-
-In your controller add,
 ```ruby
-require 'query_report/helper'
+gem 'query_report'
 ```
 
-And include,
-```ruby
-include QueryReport::Helper
-```
+Run the bundle command to install it.
 
-Then add
+Here is a sample controller which uses query report. And that is all you need, query report will generate all the view for you.
 
 ```ruby
-def invoice
-  query = Invoice.includes(:invoiced_to => {:user => :profile})
-  reporter(query) do
-    scope :unpaid
+require 'query_report/helper'  #need to require the helper
 
-    filter :invoiced_on, type: :date
-    filter :title, type: :text
-    filter :invoiced_to, type: :user
+class InvoicesController < ApplicationController
+  include QueryReport::Helper  #need to include it
 
-    column :id, as: 'Invoice#'
-    column :title
-    column 'Invoiced to' do |invoice|
-      invoice.invoiced_to.user.name
-    end
-    column :total_charged, as: 'Charged'
-    column :total_paid, as: 'Paid'
+  def index
+    @invoices = Invoice.scoped
 
-    pie_chart('Charged VS Paid') do
-      add 'Total un paid charge' do |query|
-        query.sum(:total_charged) - query.sum(:total_paid)
-      end
-      add 'Total paid' do |query|
-        query.sum(:total_paid)
+    reporter(@invoices) do
+      filter :title, type: :text
+      filter :created_at, type: :date, default: [5.months.ago.to_date.to_s(:db),
+                                                 1.months.from_now.to_date.to_s(:db)]
+      filter :paid, type: :boolean, default: false
+
+      column :title do |invoice|
+        link_to invoice.title, invoice
       end
+      column :total_paid
+      column :total_charged
+      column :paid
     end
   end
 end
 ```
 
-## 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
+## License
+MIT License. Copyright © 2013 [Ashrafuzzaman](http://www.ashrafuzzaman.com). See MIT-LICENSE for further details.

data/Rakefile

@@ -1 +1,51 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QueryReport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+#require 'rake/testtask'
+#
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib'
+#  t.libs << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = false
+#end
+#
+#
+#task :default => :test
+
+
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+task :default => :test

data/app/helpers/query_report_filter_helper.rb

@@ -0,0 +1,22 @@
+module QueryReportFilterHelper
+  def query_report_text_filter(name, value, options={})
+    text_field_tag name, value, options
+  end
+
+  def query_report_date_filter(name, value, options={})
+    text_field_tag name, value, options.merge(type: :date)
+  end
+
+  def query_report_boolean_filter(name, value, options={})
+    concat(label_tag options[:placeholder])
+    select_tag name, options_for_select([['', ''], ['true', 'true'], ['false', 'false']], value)
+  end
+
+  def link_to_download_report_pdf
+    link_to t('views.links.pdf'), export_report_url_with_format('pdf'), :target => "_blank"
+  end
+
+  def link_to_download_report_csv
+    link_to t('views.links.csv'), export_report_url_with_format('csv'), :target => "_blank"
+  end
+end

data/app/helpers/query_report_helper.rb

@@ -0,0 +1,31 @@
+require 'query_report/errors'
+
+module QueryReportHelper
+  def query_report_render_filter(filter, comparator)
+    hint = comparator.name
+    #search_key = comparator.search_key
+    search_tag_name = comparator.search_tag_name #"#{filter.params_key}[#{search_key}]"
+    value = comparator.param_value #params[filter.params_key] ? params[filter.params_key][comparator.search_key] : comparator.default
+
+    method_name = :"query_report_#{filter.type.to_s}_filter"
+    if main_app.respond_to? method_name
+      main_app.send method_name, search_tag_name, value, :placeholder => hint
+    elsif self.respond_to? method_name
+      self.send method_name, search_tag_name, value, :placeholder => hint
+    else
+      raise QueryReport::FilterNotDefined, "#{filter.type.to_s} filter is not defined"
+    end
+  end
+
+  def export_report_url_with_format(format)
+    url = request.url
+    if url.match(/(\.\w*\?)/)
+      url = url.gsub(/(\?)/, ".#{format}?")
+    elsif url.match(/(\?)/)
+      url = url.gsub(/(\?)/, ".#{format}?")
+    else
+      url = "#{url}.#{format}"
+    end
+    url.gsub(/format=(\w*)/, 'format=#{format}')
+  end
+end

data/app/views/query_report/_charts.html.erb

@@ -0,0 +1,10 @@
+<div class="row-fluid">
+  <% report.charts.each_with_index do |chart, i| %>
+      <% chart_id = "chart#{i}" %>
+      <div class="span6">
+        <div id="<%= chart_id %>" style="text-align: center;"></div>
+      </div>
+      <%= render_chart(chart.prepare_visualr, chart_id) %>
+  <% end %>
+  <div class="clearfix"></div>
+</div>

data/app/views/query_report/_search.html.erb

@@ -0,0 +1,8 @@
+<%= search_form_for report.search, :url => url_for, :html => {:method => :get, :class => 'form-inline'} do |f| %>
+    <% report.filters.each do |filter| %>
+        <% filter.comparators.each do |comparator| %>
+            <%= query_report_render_filter(filter, comparator) %>
+        <% end %>
+    <% end %>
+    <%= f.submit 'Search', :class => 'btn btn-blue' %>
+<% end %>

data/app/views/query_report/list.html.erb

@@ -1,55 +1,36 @@
-<%= search_form_for @record.search, :url => url_for, :html => {:method => :get, :class => 'form-inline'} do |f| %>
-    <% @record.filters.each do |filter| %>
-        <% if filter.class.supported_types.include?(filter.type) %>
-            <% filter.comparators.each do |key, hint| %>
-                <% search_key = "#{filter.column}_#{key}" %>
-                <% if filter.date? %>
-                    <%= f.date_field search_key, :placeholder => hint %>
-                <% elsif filter.text? %>
-                    <%= f.text_field search_key, placeholder: hint %>
-                <% end %>
-            <% end %>
-        <% else %>
-            <%= render :partial => "query_report/custom_filters", locals: {f: f, filter: filter} %>
-        <% end %>
-    <% end %>
-
-    <%= f.submit 'Search', :class => 'btn' %>
-<% end %>
-
+<%= render :partial => "query_report/search", locals: {report: @report} %>
 <br/>
+
 <%= link_to_download_report_pdf %>
 <%= link_to_download_report_csv %>
-<br/>
-<br/>
-
-<script type="text/javascript" src="https://www.google.com/jsapi"></script>
-<div id='chart' style="margin-left:auto;margin-right:auto;width:600px;"></div>
-<%= render_chart(@record.chart.prepare, 'chart') if @record.chart %>
 
-<br/>
-<% if @record.scopes.size > 0 %>
-    <%= link_to_with_scope('all', @record.current_scope) %>
-    <% @record.scopes.each do |scope| %>
-        <%= link_to_with_scope(scope, @record.current_scope) %>
-    <% end %>
+<% if @report.has_chart? and @report.enable_chart? and @report.chart_on_web? %>
+    <script type="text/javascript" src="https://www.google.com/jsapi"></script>
+    <%= render :partial => "query_report/charts", locals: {report: @report} %>
 <% end %>
+
 <br/>
+<%# if @report.scopes.size > 0 %>
+<%#= link_to_with_scope('all', @report.current_scope) %>
+<%# @report.scopes.each do |scope| %>
+<%#= link_to_with_scope(scope, @report.current_scope) %>
+<%# end %>
+<%# end %>
 <br/>
 
-<% if @record.column_names %>
+<% if @report.records.size > 0 %>
     <table class="table table-bordered table-striped">
       <thead>
-      <% @record.column_names.each do |column| %>
-          <th><%= column.humanize %></th>
+      <% @report.columns.each do |column| %>
+          <th><%= sort_link(@report.search, column.name) %></th>
       <% end %>
       </thead>
 
       <tbody>
-      <% @record.records.each do |record| %>
+      <% @report.records.each do |record| %>
           <tr>
-            <% @record.column_names.each do |column| %>
-                <td><%= record[column] %></td>
+            <% @report.columns.each do |column| %>
+                <td><%= record[column.humanize] %></td>
             <% end %>
           </tr>
       <% end %>
@@ -59,4 +40,4 @@
     <p>No record found</p>
 <% end %>
 
-<%= paginate @report.query if @report.paginate? %>
+<%= paginate @report.paginated_query if @report.paginate? %>

data/config/locales/query_report.yml

@@ -0,0 +1,7 @@
+# Sample localization file for Kaminari. You can override these values in your app's locales file if you want.
+
+en:
+  query_report:
+    filters:
+      from: 'From'
+      to: 'To'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/schema.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20130630132513) do
+
+  create_table "invoices", :force => true do |t|
+    t.string   "title"
+    t.float    "total_paid"
+    t.float    "total_charged"
+    t.boolean  "paid"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.boolean  "single"
+    t.date     "dob"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end

data/lib/query_report.rb

@@ -1,19 +1,26 @@
-require 'query_report/version'
-require 'query_report/report'
-require 'query_report/chart/pie_chart'
-require 'query_report/chart/custom_chart'
+require "query_report/engine"
 
 module QueryReport
-  #autoload :VERSION, 'query_report/version'
-  #autoload :Helper, 'query_report/helper'
-  #autoload :Views, 'query_report/views'
-  #autoload :Report, 'query_report/report'
-  #autoload :Filter, 'query_report/filter'
-  #autoload :Column, 'query_report/column'
+  autoload :Configuration, "query_report/config"
 
-  #mattr_accessor :chart_on_pdf
-  #self.chart_on_pdf = true
-  #
-  #mattr_accessor :paginate
-  #self.paginate = true
+  def self.configure(&block)
+    yield @config ||= QueryReport::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  configure do |config|
+    config.pdf_options = {
+        template_class: nil,
+        color: '000000',
+        font_size: 12,
+        table: {
+            row: {odd_bg_color: "DDDDDD", even_bg_color: "FFFFFF"},
+            header: {bg_color: 'AAAAAA', font_size: 12}
+        },
+        chart: { height: 160, width: 200 }
+    }
+  end
 end

data/lib/query_report/chart/chart_base.rb

@@ -0,0 +1,60 @@
+require 'query_report/chart/chart_column'
+require 'query_report/chart/themes'
+
+module QueryReport
+  module Chart
+    class ChartBase
+      attr_reader :title, :options, :columns, :data
+
+      def initialize(title, query, options={})
+        @title = title
+        @query = query
+        @options = {:width => 500, :height => 240}.merge(options)
+      end
+
+      def add(column_title, &block)
+        val = block.call(@query)
+        @columns ||= []
+        @columns << QueryReport::Chart::Column.new(column_title, val.kind_of?(String) ? :string : :number)
+        @data ||= []
+        @data << val
+      end
+
+      def prepare_visualr(type)
+        @data_table = GoogleVisualr::DataTable.new
+
+        ##### Adding column header #####
+        @data_table.new_column('string', '') if type == :column
+        @columns.each do |col|
+          @data_table.new_column(col.type.to_s, col.title)
+        end
+        ##### Adding column header #####
+
+        ##### Adding value #####
+        chart_row_data = type == :column ? [''] + @data : @data
+        @data_table.add_row(chart_row_data)
+        ##### Adding value #####
+
+        options = {:title => title, backgroundColor: 'transparent'}.merge(@options)
+        chart_type = "#{type}_chart".classify
+        chart_type = "GoogleVisualr::Interactive::#{chart_type}".constantize
+        ap @data_table.as_json
+        chart_type.new(@data_table, options)
+      end
+
+      def to_blob(type)
+        chart_type = type.to_s.classify
+        chart_type = "Gruff::#{chart_type}".constantize
+
+        @gruff = chart_type.new(@options[:width])
+        @gruff.title = title
+        @gruff.theme = QueryReport::Chart::Themes::GOOGLE_CHART
+        @data.each_with_index do |value, i|
+          @gruff.data(@columns[i].title, value)
+        end
+
+        @gruff.to_blob
+      end
+    end
+  end
+end