query_report 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,11 @@
 # 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
 
-TODO: Write a gem description
+The gem is still in infant stage. So I would just ask you to keep an eye on this for now.
 
 ## Installation
 
@@ -18,7 +23,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your controller add,
+```ruby
+require 'query_report/helper'
+```
+
+And include,
+```ruby
+include QueryReport::Helper
+```
+
+Then add
+
+```ruby
+def invoice
+  query = Invoice.includes(:invoiced_to => {:user => :profile})
+  reporter(query) do
+    scope :unpaid
+
+    filter :invoiced_on, type: :date
+    filter :title, type: :text
+    filter :invoiced_to, type: :user
+
+    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'
+
+    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)
+      end
+    end
+  end
+end
+```
 
 ## Contributing
 

data/lib/query_report.rb

@@ -1,5 +1,5 @@
 require "query_report/version"
-require "query_report/record"
+require "query_report/report"
 require 'query_report/chart/pie_chart'
 require 'query_report/chart/custom_chart'
 
@@ -7,7 +7,7 @@ module QueryReport
   autoload :VERSION,                  'query_report/version'
   autoload :Helper,                   'query_report/helper'
   autoload :Views,                    'query_report/views'
-  autoload :Record,                   'query_report/record'
+  autoload :Report, 'query_report/report'
   autoload :Filter,                   'query_report/filter'
   autoload :Column,                   'query_report/column'
 end

data/lib/query_report/helper.rb

@@ -1,20 +1,20 @@
-require 'query_report/record'
+require 'query_report/report'
 
 module QueryReport
   module Helper
     def reporter(query, &block)
-      @record ||= QueryReport::Record.new(params)
-      @record.set_query(query)
-      @record.instance_eval &block
+      @report ||= QueryReport::Report.new(params)
+      @report.set_query(query)
+      @report.instance_eval &block
       render_report
     end
 
     def render_report
       respond_to do |format|
         format.html { render 'query_report/list' }
-        format.json { render json: @record.records }
-        format.csv { send_data generate_csv_for_report(@record.all_records), :disposition => "attachment;" }
-        format.pdf { render_pdf(ReportPdf.new.list(@record.all_records)) }
+        format.json { render json: @report.records }
+        format.csv { send_data generate_csv_for_report(@report.all_records), :disposition => "attachment;" }
+        format.pdf { render_pdf(ReportPdf.new.list(@report.all_records)) }
       end
     end
 

data/lib/query_report/{record.rb → report.rb}

@@ -4,8 +4,8 @@ require 'query_report/chart/basic_chart'
 require 'query_report/chart/chart_with_total'
 
 module QueryReport
-  class Record
-    attr_accessor :params, :query, :query_without_pagination, :chart,
+  class Report
+    attr_accessor :params, :query, :query_without_pagination, :chart, :charts,
                   :filters, :search, :scopes, :current_scope
 
     def initialize(params, options={}, &block)
@@ -13,6 +13,7 @@ module QueryReport
       @columns = []
       @filters = []
       @scopes = []
+      @charts = []
       @column_separator = options.delete(:separator)
       @current_scope = @params[:scope] || 'all'
       @options = options.delete(:options)
@@ -70,17 +71,20 @@ module QueryReport
 
     def column_chart(title, columns)
       @chart = QueryReport::Chart::BasicChart.new(:column, title, columns, all_records)
+      @charts << @chart
     end
 
     def compare_with_column_chart(title, x_axis, &block)
       @chart = QueryReport::Chart::CustomChart.new(:column, title, query_without_pagination)
       @chart.add_column x_axis
       @chart.instance_eval &block if block_given?
+      @charts << @chart
     end
 
     def pie_chart(title, &block)
       @chart = QueryReport::Chart::PieChart.new(title, query_without_pagination)
       @chart.instance_eval &block if block_given?
+      @charts << @chart
     end
 
     def pie_chart_on_total(title, columns)

data/lib/query_report/version.rb

@@ -1,3 +1,3 @@
 module QueryReport
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_report
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -67,7 +67,7 @@ files:
 - lib/query_report/column.rb
 - lib/query_report/filter.rb
 - lib/query_report/helper.rb
-- lib/query_report/record.rb
+- lib/query_report/report.rb
 - lib/query_report/version.rb
 - query_report.gemspec
 homepage: https://github.com/ashrafuzzaman/query_report