query_report 1.0.4 → 1.0.5

data/README.md

@@ -1,4 +1,4 @@
-[Query report](http://ashrafuzzaman.github.io/query_report/) By [Ashrafuzzaman](http://www.ashrafuzzaman.com).
+[Query report](http://ashrafuzzaman.github.io/query_report/) By [Ashrafuzzaman](http://ashrafuzzaman.github.io/site).
 
 [![Build Status](https://api.travis-ci.org/ashrafuzzaman/query_report.png?branch=master)](http://travis-ci.org/ashrafuzzaman/query_report)
 
@@ -9,6 +9,7 @@ Query report is a reporting tool, which does the following:
 * Provide feature to define re usable custom filter
 
 As built in filter I have used [ransack](https://github.com/ernie/ransack) and pagination with [kaminari](https://github.com/amatsuda/kaminari)
+
 For a demo see [here](http://query-report-demo.herokuapp.com)
 
 ## The purpose
@@ -19,7 +20,7 @@ concentrate in a report is the query and filter.
 Query report is tested with Rails 3. You can add it to your Gemfile with:
 
 ```ruby
-gem "query_report", "~> 1.0.3"
+gem "query_report", "~> 1.0.4"
 ```
 
 Run the bundle command to install it.
@@ -53,4 +54,4 @@ end
 ```
 
 ## License
-MIT License. Copyright © 2013 [Ashrafuzzaman](http://www.ashrafuzzaman.com). See MIT-LICENSE for further details.
+MIT License. Copyright © 2013 [Ashrafuzzaman](http://ashrafuzzaman.github.io/site). See MIT-LICENSE for further details.

data/app/helpers/query_report_link_helper.rb

@@ -6,4 +6,8 @@ module QueryReportLinkHelper
   def link_to_download_report_csv
     link_to t('views.links.csv'), export_report_url_with_format('csv'), :target => "_blank"
   end
+
+  def link_to_email_query_report(target_dom_id)
+    link_to t('views.labels.email'), 'javascript:void(0)', :onclick => "QueryReportEmail.openEmailModal('#{target_dom_id}');" if QueryReport.config.allow_email_report
+  end
 end

data/app/mailers/report_mailer.rb

@@ -0,0 +1,10 @@
+class ReportMailer < ActionMailer::Base
+  default from: QueryReport.config.email_from
+
+  def send_report(user, to, subject, message, file_name, attachment)
+    @user = user
+    @message = message
+    attachments["#{file_name}.pdf"] = attachment
+    mail(:to => to, :subject => subject)
+  end
+end

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

@@ -0,0 +1,9 @@
+<div class="query_report_charts">
+  <%= render :partial => "query_report/charts", locals: {report: report} %>
+</div>
+<div class="query_report_records">
+  <%= render :partial => "query_report/records", locals: {report: report} %>
+</div>
+<div class="query_report_pagination">
+  <%= paginate report.paginated_query, remote: @remote if report.paginate? %>
+</div>

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

@@ -1,2 +1,3 @@
 <%= link_to_download_report_pdf %>
-<%= link_to_download_report_csv %>
+<%= link_to_download_report_csv %>
+<%= link_to_email_query_report(@target_dom_id) %>

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

@@ -0,0 +1,15 @@
+<% uuid = Time.now.to_i
+   @target_dom_id = params[:target_dom_id] || "report_#{uuid}" %>
+<div class="query_report" id="<%= @target_dom_id %>">
+  <div class="query_report_header">
+    <div class="query_report_search_form" style="<%= report.has_filter? ? '' : 'display: none;' %>">
+      <%= render :partial => "query_report/search", locals: {report: report} %>
+    </div>
+    <div class="query_report_links">
+      <%= render :partial => "query_report/links", locals: {report: report} %>
+    </div>
+  </div>
+  <div class="query_report_content">
+    <%= render :partial => "query_report/content", locals: {report: report} %>
+  </div>
+</div>

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

@@ -0,0 +1,9 @@
+<% if report.has_total? %>
+    <tfoot>
+    <tr>
+      <% report.column_total_with_colspan.each do |total_with_colspan| %>
+          <td colspan="<%= total_with_colspan[:colspan] %>"><%= total_with_colspan[:content] %></td>
+      <% end %>
+    </tr>
+    </tfoot>
+<% end %>

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

@@ -1,8 +1,8 @@
 <% if report.records.size > 0 %>
-    <table class="table table-bordered table-striped">
+    <table class="<%= QueryReport.config.record_table_class %>" cellpadding="0" cellspacing="0">
       <thead>
       <% report.columns.each do |column| %>
-          <th><%= sort_link(report.search, column.name) %></th>
+          <th><%= column.sortable? ? sort_link(report.search, column.name, {}, remote: @remote) : column.name %></th>
       <% end %>
       </thead>
 
@@ -14,6 +14,7 @@
             <% end %>
           </tr>
       <% end %>
+      <%= render :partial => "query_report/record_footer", locals: {report: report} %>
       </tbody>
     </table>
 <% else %>

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

@@ -1,10 +1,13 @@
-<% if report.has_filter? %>
-    <%= 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 %>
+<%= search_form_for report.search, url: url_for, remote: @remote, 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 %>
-        <%= f.submit 'Search', :class => 'btn btn-blue' %>
     <% end %>
+    <%= hidden_field_tag :send_as_email, false %>
+    <%= hidden_field_tag :email_to %>
+    <%= hidden_field_tag :subject %>
+    <%= hidden_field_tag :message %>
+    <%= hidden_field_tag :target_dom_id, @target_dom_id %>
+    <%= f.submit 'Search', :class => QueryReport.config.search_button_class, :onclick => "$('#{@target_dom_id} #send_as_email').val(0);" %>
 <% end %>

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

@@ -1,14 +1 @@
-<%= render :partial => "query_report/search", locals: {report: @report} %>
-<br/>
-<%= render :partial => "query_report/links", locals: {report: @report} %>
-<%= render :partial => "query_report/charts", locals: {report: @report} %>
-<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 %>
-
-<%= render :partial => "query_report/records", locals: {report: @report} %>
-<%= paginate @report.paginated_query if @report.paginate? %>
+<%= render :partial => "query_report/_list", locals: {report: @report} %>

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

@@ -0,0 +1,9 @@
+<%if params['target_dom_id'].present?%>
+if ($('#<%=params['target_dom_id']%> .query_report_content').length == 0) {
+    $('#<%=params['target_dom_id']%>').html('<%= escape_javascript(render :partial => 'query_report/list', locals: {report: @report})%>');
+} else {
+    $('#<%=params['target_dom_id']%> .query_report_content').html('<%= escape_javascript(render :partial => 'query_report/content', locals: {report: @report})%>');
+}
+<% else %>
+console.log("target_dom_id was not defined");
+<% end %>

data/app/views/report_mailer/send_report.html.erb

@@ -0,0 +1 @@
+<%= @message.gsub(/\n/, '<br />').html_safe %>

data/config/locales/query_report.yml

@@ -4,4 +4,6 @@ en:
   query_report:
     filters:
       from: 'From'
-      to: 'To'
+      to: 'To'
+    total:
+      Total

data/lib/query_report.rb

@@ -15,14 +15,18 @@ module QueryReport
     config.pdf_options = {
         template_class: nil,
         color: '000000',
-        font_size: 12,
+        font_size: 8,
         table: {
             row: {odd_bg_color: "DDDDDD", even_bg_color: "FFFFFF"},
-            header: {bg_color: 'AAAAAA', font_size: 12}
+            header: {bg_color: 'AAAAAA', font_size: 8}
         },
         chart: { height: 160, width: 200 }
     }
-    config.date_format = :default
+    config.date_format     = :default
     config.datetime_format = :default
+    config.email_from      = "from@example.com"
+    config.allow_email_report  = true
+    config.record_table_class  = 'table table-bordered table-striped'
+    config.search_button_class = 'btn btn-blue'
   end
 end

data/lib/query_report/column.rb

@@ -13,11 +13,35 @@ module QueryReport
     # +options+:: Options can have the following,
     #             options[:type] => date | text | whatever
     #             options[:comp] => the comparators used for ransack search, [:gteq, :lteq]
+    #             options[:show_total] => set true to calculate total for that column
     #             options[:only_on_web] => the column will appear on the web and not appear in PDF or csv if set to true
     def column(name, options={}, &block)
       @columns << Column.new(self, name, options, block)
     end
 
+    def column_total_with_colspan
+      total_with_colspan = []
+      colspan = 0
+      total_text_printed = false
+      columns.each do |column|
+        if column.has_total?
+          if colspan > 0
+            title = total_text_printed ? '' : I18n.t('query_report.total')
+            total_with_colspan << (colspan == 1 ? {content: title} : {content: title, colspan: colspan})
+          end
+          total_with_colspan << {content: column.total}
+          total_text_printed = true
+          colspan = 0
+        else
+          colspan += 1
+        end
+      end
+      if colspan > 0
+        total_with_colspan << {content: '', colspan: colspan}
+      end
+      total_with_colspan
+    end
+
     class Column
       attr_reader :report, :name, :options, :type, :data
 
@@ -31,6 +55,10 @@ module QueryReport
         @options[:only_on_web] == true
       end
 
+      def sortable?
+        @options[:sortable] == true
+      end
+
       def humanize
         @humanize ||= options[:as] || @report.model_class.human_attribute_name(name)
       end
@@ -38,6 +66,14 @@ module QueryReport
       def value(record)
         self.data.kind_of?(Symbol) ? record.send(self.name) : self.data.call(record)
       end
+
+      def has_total?
+        @options[:show_total] == true
+      end
+
+      def total
+        @total ||= has_total? ? report.records.inject(0) {|sum, r| sum + r[humanize] } : nil
+      end
     end
   end
 end

data/lib/query_report/comparator.rb

@@ -41,9 +41,9 @@ module QueryReport
       def objectified_param_value
         @stringified_default ||= case @filter.type
                                    when :date
-                                     Date.current.parse(@default)
+                                     @default.kind_of?(String) ? Date.current.parse(@default) : @default
                                    when :datetime
-                                     Time.zone.parse(@default)
+                                     @default.kind_of?(String) ? Time.zone.parse(@default) : @default
                                    when :boolean
                                      @default.to_boolean
                                    else

data/lib/query_report/config.rb

@@ -4,5 +4,9 @@ module QueryReport
     config_accessor :pdf_options
     config_accessor :date_format
     config_accessor :datetime_format
+    config_accessor :email_from
+    config_accessor :allow_email_report
+    config_accessor :record_table_class
+    config_accessor :search_button_class
   end
 end

data/lib/query_report/helper.rb

@@ -17,15 +17,27 @@ module QueryReport
     end
 
     def render_report(options)
+      if (params[:send_as_email].to_i > 0)
+        send_pdf_email(params[:email_to], params[:subject], params[:message], action_name, pdf_for_report(options))
+      end
+
+      @remote = false
       respond_to do |format|
-        format.js { render 'query_report/list' }
+        format.js do
+          @remote = true
+          render 'query_report/list'
+        end
         format.html { render 'query_report/list' }
         format.json { render json: @report.all_records }
         format.csv { send_data generate_csv_for_report(@report.all_records), :disposition => "attachment;" }
-        format.pdf { send_data query_report_pdf_template_class(options).new(@report).to_pdf.render }
+        format.pdf { send_data pdf_for_report(options) }
       end
     end
 
+    def pdf_for_report(options)
+      query_report_pdf_template_class(options).new(@report).to_pdf.render
+    end
+
     def query_report_pdf_template_class(options)
       options = QueryReport.config.pdf_options.merge(options)
       if options[:template_class]
@@ -48,5 +60,11 @@ module QueryReport
         nil
       end
     end
+
+    def send_pdf_email(email, subject, message, file_name, attachment)
+      @user = current_user
+      to = email.split(',')
+      ReportMailer.send_report(@user, to, subject, message, file_name, attachment).deliver
+    end
   end
 end

data/lib/query_report/report.rb

@@ -38,6 +38,10 @@ module QueryReport
       !@charts.empty?
     end
 
+    def has_total?
+      @columns.any?(&:has_total?)
+    end
+
     # to support the helper methods
     def method_missing(meth, *args, &block)
       if @template.respond_to?(meth)

data/lib/query_report/report_pdf.rb

@@ -26,8 +26,9 @@ module QueryReport
     private
     def render_charts_with(report)
       return if report.charts.empty? #or !report.chart_on_pdf?
-      height = options[:chart][:height] * (report.charts.size.to_f/2).ceil
-      pdf.column_box([0, pdf.cursor], :columns => 2, :width => pdf.bounds.width, :height => height) do
+      num_of_column = 2
+      height = (pdf.bounds.width/num_of_column - 50) * (report.charts.size.to_f/num_of_column).ceil
+      pdf.column_box([0, pdf.cursor], :columns => num_of_column, :width => pdf.bounds.width, :height => height) do
         report.charts.each do |chart|
           render_chart(chart)
         end
@@ -38,9 +39,9 @@ module QueryReport
       if chart.respond_to?(:to_blob)
         blob = chart.to_blob
         data = StringIO.new(blob)
-        pdf.pad_top(10) do
-          pdf.image(data, :width => options[:chart][:width])
-        end
+        #pdf.pad_top(10) do
+        pdf.image(data, :width => pdf.bounds.width)
+        #end
       end
     end
 
@@ -54,7 +55,7 @@ module QueryReport
 
     def table_content_for(report)
       table_items = report.all_records
-      table_items.map do |item|
+      items = table_items.map do |item|
         item_values = []
 
         report_columns.collect(&:humanize).each do |column|
@@ -62,6 +63,13 @@ module QueryReport
         end
         item_values
       end
+
+      if report.has_total?
+        items = items << report.column_total_with_colspan.collect do |total|
+          total[:colspan] ? total : total[:content]
+        end
+      end
+      items
     end
 
     def render_table_with(report)

data/lib/query_report/version.rb

@@ -1,3 +1,3 @@
 module QueryReport
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/test/dummy/app/controllers/invoices_controller.rb

@@ -15,28 +15,28 @@ class InvoicesController < ApplicationController
       column :title do |invoice|
         link_to invoice.title, invoice
       end
-      column :total_paid
-      column :total_charged
+      column :total_paid, show_total: true
+      column :total_charged, show_total: true
       column :paid
       column :received_by
 
-      #column_chart('Unpaid VS Paid') do
-      #  add 'Unpaid' do |query|
-      #    (query.sum('total_charged').to_f - query.sum('total_paid').to_f).to_f
-      #  end
-      #  add 'Paid' do |query|
-      #    query.sum('total_paid').to_f
-      #  end
-      #end
-      #
-      #pie_chart('Unpaid VS Paid') do
-      #  add 'Unpaid' do |query|
-      #    (query.sum('total_charged').to_f - query.sum('total_paid').to_f).to_f
-      #  end
-      #  add 'Paid' do |query|
-      #    query.sum('total_paid').to_f
-      #  end
-      #end
+      column_chart('Unpaid VS Paid') do
+        add 'Unpaid' do |query|
+          (query.sum('total_charged').to_f - query.sum('total_paid').to_f).to_f
+        end
+        add 'Paid' do |query|
+          query.sum('total_paid').to_f
+        end
+      end
+
+      pie_chart('Unpaid VS Paid') do
+        add 'Unpaid' do |query|
+          (query.sum('total_charged').to_f - query.sum('total_paid').to_f).to_f
+        end
+        add 'Paid' do |query|
+          query.sum('total_paid').to_f
+        end
+      end
     end
     #ap @report.filters.last.comparators.first.default
     #ap @report.filters.last.comparators.first.param_value