query_report 1.0.23 → 1.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c09663de9764af4df12bdbe7da6cecbae1c7ca0
-  data.tar.gz: b7e286d433248e29f8b078632f8f18ddbde73a57
+  metadata.gz: 38e6dd09227f6ad51d81593b879ded5928ab3c27
+  data.tar.gz: 72ef9413da84d9e5d0f5f802c5b7dd8e4cd4aba0
 SHA512:
-  metadata.gz: 92ea49358da764dbd315424074025e665f933a2e8c4e7cc96fa02af0ad1b31b27bf8f926a097146d6edf85d64c127ab19ffe3cc6d8f993a73e0c245738186156
-  data.tar.gz: c713b7bb180db57c9a55c612768d86032740152177bd802961241a047098705f11768d3b04bed3f362b307f8a8378b3007aeb7ad9ca15577bf521d435f9e2b0d
+  metadata.gz: aad743d74172a389cc058f6354d819b7e1263fcea268bffcecd1c4d3a2928e38c1b02563cc8f75ff2571472300ee7a2709669cd42cc02d7a8963534599a611d3
+  data.tar.gz: 8d5c76e9381b2df6a078f133a82d02ac459f483e93c7afa9281011a58eceb4e50fe800e33ce5add15a104a01c7f2e3da909188ae2fe5e55431c22044f1ecb209

data/README.md

@@ -2,14 +2,50 @@
 
 [![Build Status](https://api.travis-ci.org/ashrafuzzaman/query_report.png?branch=master)](http://travis-ci.org/ashrafuzzaman/query_report)
 [![Gem Version](https://badge.fury.io/rb/query_report.png)](http://badge.fury.io/rb/query_report)
-
-Query report is a reporting tool, which does the following:
-
-* Generate paginated HTML view with filters, defined columns with sorting
-* Generate PDF, CSV, JSON
-* 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)
+[![Code Climate](https://codeclimate.com/github/ashrafuzzaman/query_report.png)](https://codeclimate.com/github/ashrafuzzaman/query_report)
+[![Code coverage](https://codeclimate.com/github/ashrafuzzaman/query_report/coverage.png)](https://codeclimate.com/github/ashrafuzzaman/query_report)
+
+###Write the action with a simple DSL and get a report with PDF and CSV export, gorgeous charts, out of box filters, with I18n support, etc...  
+
+Create a report in Rails
+------------------------
+
+You would have to do the following tasks to create a report in rails,
+
+- Create a route
+- Create an action with following logic
+    - Logic for filters
+    - Logic for pagination
+- Create a view
+    - Write code to show HTML
+    - Write code to generate Graph
+- Generate PDF with prawn pdf and graph
+- Logic to send that PDF file as email
+
+Create a report with query report
+---------------------------------
+
+- Create a route
+- Create an action with following logic
+    - ~~Logic for filters~~
+    - ~~Logic for pagination~~
+- ~~Create a view~~
+    - ~~Write code to show HTML~~
+    - ~~Write code to generate Graph~~
+- ~~Generate PDF with prawn pdf and graph~~
+- ~~Logic to send that PDF file as email~~
+
+For email, you have to implement the popup once.
+
+Features
+--------
+
+- Allow to use and reuse filters using [ransack](https://github.com/activerecord-hackery/ransack), and also with custom query
+- Paginates [kaminari](https://github.com/amatsuda/kaminari)
+- Supports ajax out of box 
+- Exports to PDF [prawn](https://github.com/prawnpdf/prawn), csv, json
+- Supports to send report pdf as email
+- Supports I18N
 
 For a demo see [here](http://query-report-demo.herokuapp.com)
 
@@ -45,8 +81,8 @@ 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
     end
   end

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

@@ -2,7 +2,7 @@
     <table class="<%= QueryReport.config.record_table_class %>" cellpadding="0" cellspacing="0">
       <thead>
       <% report.columns.each do |column| %>
-          <th><%= column.sortable? ? sort_link(report.search, column.name, params, remote: @remote) : column.humanize %></th>
+          <th><%= column.sortable? ? sort_link(report.search, column.sort_link_attribute, column.humanize, params, remote: @remote) : column.humanize %></th>
       <% end %>
       </thead>
 

data/lib/query_report/column.rb

@@ -8,14 +8,52 @@ module QueryReport
     attr_accessor :columns
 
     # Creates a filter and adds to the filters
-    # Params:
-    # +column+:: the column on which the filter is done on
-    # +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
-    #             options[:rowspan] => the rows with same values in the same column will span if set to true
+    # @param name the column on which the filter is done on
+    # @option options [Symbol] :type date | text | whatever
+    # @option options [String] :as The title of the column, by default it fetches from the I18n column translation, Model.human_attribute_name(column_name)
+    # @option options [Boolean] :show_total set true to calculate total for that column. It will render the total in the footer.
+    # @option options [Boolean] :only_on_web the column will appear on the web and not appear in PDF, CSV or JSON if set to true
+    # @option options [Boolean] :sortable if set to true then sorts on that column, but if the sorting has to be on a joint table then you have to specify the column on which the sorting will happen
+    # @option options :rowspan the rows with same values in the same column will span if set to true
+    #
+    # @example Row span
+    #   column :invoiced_to_name, rowspan: true
+    #   column :invoice_title
+    #   column :invoice_date, rowspan: :invoiced_to_name
+    #   ┌───────────┬────────────┬─────────────────┐
+    #   │ Name      │  Invoice   │   Invoiced on   │
+    #   ├───────────┼────────────┼─────────────────┤
+    #   │           │  Invoice1  │                 │
+    #   │ Jitu      ├────────────┤    2-2-2014     │
+    #   │           │  Invoice2  │                 │
+    #   ├───────────┼────────────┼─────────────────┤
+    #   │ Setu      │  Invoice3  │    2-2-2014     │
+    #   └───────────┴────────────┴─────────────────┘
+    #
+    # @example Show total
+    #   column :invoiced_to_name, rowspan: true
+    #   column :invoice_title
+    #   column :total_charged, show_total: true
+    #   ┌───────────┬────────────┬─────────────────┐
+    #   │ Name      │  Invoice   │   Total charge  │
+    #   ├───────────┼────────────┼─────────────────┤
+    #   │           │  Invoice1  │      100        │
+    #   │ Jitu      ├────────────┼─────────────────┤
+    #   │           │  Invoice2  │      120        │
+    #   ├───────────┼────────────┼─────────────────┤
+    #   │ Setu      │  Invoice3  │       80        │
+    #   ├───────────┴────────────┼─────────────────┤
+    #   │                  Total │      300        │
+    #   └────────────────────────┴─────────────────┘
+    #
+    # @example Sorting
+    #  column :invoice_date, sortable: true
+    #  column :invoice_to, sortable: 'users.name'
+    #
+    # If you want to sort a column which is a column of the active record model that the query returns,
+    # then just set true to make the column sortable.
+    # If the column is from another table then you have to specify the column name.
+    #
     def column(name, options={}, &block)
       @columns << Column.new(self, name, options, block)
     end
@@ -59,7 +97,11 @@ module QueryReport
       end
 
       def sortable?
-        @options[:sortable] == true
+        @options[:sortable].present? && @options[:sortable] != false
+      end
+
+      def sort_link_attribute
+        @options[:sortable] == true ? name : @options[:sortable]
       end
 
       def rowspan?
@@ -67,12 +109,16 @@ module QueryReport
       end
 
       def rowspan_column_humanized
+        return @rowspan_column_humanized if @rowspan_column_humanized
         rowspan_column_name = @options[:rowspan].kind_of?(Symbol) ? @options[:rowspan] : self.name
 
         report.columns.each do |column|
-          return column.humanize if column.name == rowspan_column_name
+          if column.name == rowspan_column_name
+            @rowspan_column_humanized = column.humanize
+            return @rowspan_column_humanized
+          end
         end
-        return self.humanize
+        @rowspan_column_humanized = self.humanize
       end
 
       def humanize
@@ -104,7 +150,6 @@ module QueryReport
           end
         end
       end
-
     end
   end
 end

data/lib/query_report/filter.rb

@@ -10,29 +10,38 @@ module QueryReport
   module FilterModule
     attr_accessor :filters, :search
 
-    # Creates a filter and adds to the filters
-    # Params:
-    # +column+:: the column on which the filter is done on
-    # +options+:: Options can have the following,
-    #             options[:type] => date | text | whatever
-    #             options[:comp] => the comparators used for ransack search, [:gteq, :lteq]
-    #             options[:manual] => if set to true then that filter will not be applied, only will appear and can be used for custom application
-    #             options[:default] => support default filter value, can be one value or for range filter can be array
+    # Creates a filter
+    # @param column the column on which the filter is done on, for manual filter the column name can be anything
+    # @option options [Symbol] :type date | text | whatever
+    # @option options [Array] :comp the comparators used for ransack search, [:gteq, :lteq]
+    # @option options [Boolean] :manual if set to true then that filter will not be applied, only will appear and can be used for custom application
+    # @option options :default support default filter value, can be one value or for range filter can be array
+    #
+    # @example Custom type
+    #  filter :invoiced_to_id, type: :user
+    #
+    #  # In a helper file define method
+    #  def query_report_user_filter(name, user_id, options={})
+    #    user = User.find(user_id)
+    #    concat hidden_field_tag name, user_id, options
+    #    text_field_tag "#{name}", user.name, class: 'user_search' #implement the filter, it can be autocomplete
+    #  end
+    #
+
     def filter(column, options={}, &block)
       @filters ||= []
       @filters << Filter.new(@params, column, options, &block)
     end
 
-    def has_filter?
-      filters.present?
-    end
-
     def apply_filters(query, http_params)
       # apply default filter
       params = load_default_values_in_param(http_params) #need for ransack filter
       @search = query.ransack(params[:q])
       query = @search.result
 
+      #this is to fix a bug from ransack, as for ransack when the sorting is done from a joined table it does not sort by default
+      query = query.order(params[:q][:s]) if params[:q][:s]
+
       #apply custom filter
       @filters.select(&:custom?).each do |filter|
         ordered_custom_param_values = ordered_param_value_objects(filter)
@@ -42,24 +51,6 @@ module QueryReport
       query
     end
 
-    def ordered_param_value_objects(filter)
-      filter.comparators.collect do |comp|
-        comp.objectified_param_value
-      end
-    end
-
-    def load_default_values_in_param(http_params)
-      params = http_params.clone
-      params = params.merge(q: {}) unless params[:q]
-      params = params.merge(custom_search: {}) unless params[:custom_search]
-      @filters.each do |filter|
-        filter.comparators.each do |comparator|
-          params[filter.params_key][comparator.search_key] ||= comparator.param_value
-        end
-      end
-      params
-    end
-
     class Filter
       attr_reader :params, :column, :type, :comparators, :block, :options
 
@@ -120,5 +111,27 @@ module QueryReport
         end
       end
     end
+
+    def has_filter?
+      filters.present?
+    end
+
+    def ordered_param_value_objects(filter)
+      filter.comparators.collect do |comp|
+        comp.objectified_param_value
+      end
+    end
+
+    def load_default_values_in_param(http_params)
+      params = http_params.clone
+      params = params.merge(q: {}) unless params[:q]
+      params = params.merge(custom_search: {}) unless params[:custom_search]
+      @filters.each do |filter|
+        filter.comparators.each do |comparator|
+          params[filter.params_key][comparator.search_key] ||= comparator.param_value
+        end
+      end
+      params
+    end
   end
 end

data/lib/query_report/helper.rb

@@ -11,12 +11,10 @@ module QueryReport
   module Helper
 
     # Generates the reports
-    # Params:
-    # query - The base query that the reporter with start with [filters will be applied on it]
-    # options - Options for the reports
-    #           :custom_view - by default false, if set to true then the reporter will look for the file to render
-    #           :skip_rendering - by default false, if set to true then the reporter will not render any thing, you will have to implement the rendering
-    #           :per_page - If given then overrides the default kaminari per page option
+    # @param query The base query that the reporter with start with [filters will be applied on it]
+    # @option options [Integer] :per_page If given then overrides the default kaminari per page option
+    # @option options [Boolean] :custom_view by default false, if set to true then the reporter will look for the file to render
+    # @option options [Boolean] :skip_rendering by default false, if set to true then the reporter will not render any thing, you will have to implement the rendering
     def reporter(query, options={}, &block)
       @report ||= QueryReport::Report.new(params, view_context, options)
       @report.query = query
@@ -78,7 +76,7 @@ module QueryReport
     end
 
     def send_pdf_email(email, subject, message, file_name, attachment)
-      @user = current_user
+      @user = current_user if defined? current_user
       to = email.split(',')
       ReportMailer.send_report(@user, to, subject, message, file_name, attachment).deliver
     end

data/lib/query_report/version.rb

@@ -1,3 +1,3 @@
 module QueryReport
-  VERSION = "1.0.23"
+  VERSION = "1.0.24"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_report
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.0.24
 platform: ruby
 authors:
 - A.K.M. Ashrafuzzaman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -252,3 +252,4 @@ signing_key:
 specification_version: 4
 summary: Structure you reports
 test_files: []
+has_rdoc: