query_report 0.0.2 → 0.0.3

data/lib/query_report/chart/custom_chart.rb

@@ -1,7 +1,10 @@
+require 'query_report/row'
+require 'query_report/chart/themes'
+
 module QueryReport
   module Chart
     class CustomChart
-      attr_reader :title, :type, :options, :data_table, :row
+      attr_reader :title, :type, :options, :data_table, :row, :rows
 
       def initialize(type, title, query, options={})
         @type = type
@@ -9,6 +12,7 @@ module QueryReport
         @query = query
         @options = options
         @row = []
+        @rows = []
         @data_table = GoogleVisualr::DataTable.new
       end
 
@@ -21,15 +25,31 @@ module QueryReport
         val = block.call(@query)
         @data_table.new_column(val.kind_of?(String) ? 'string' : 'number', column_title)
         @row << val
+        @rows << Row.new(column_title, val)
       end
 
       def prepare
-        data_table.add_row(@row)
+        @data_table.add_row(@row)
         opts = {:width => 500, :height => 240, :title => @title}.merge(options)
         chart_type = "#{type}_chart".classify
         chart_type = "GoogleVisualr::Interactive::#{chart_type}".constantize
-        chart_type.new(data_table, opts)
+        chart_type.new(@data_table, opts)
+      end
+
+      def prepare_gruff
+        @gruff = Gruff::Bar.new(options[:width] || 600)
+        @gruff.title = title
+        @gruff.theme = Gruff::Themes::GOOGLE_CHART
+        @rows.each do |row|
+          @gruff.data(row.name.humanize, row.value)
+        end
       end
+
+      def to_blob
+        prepare_gruff
+        @gruff.to_blob
+      end
+
     end
   end
 end

data/lib/query_report/chart/pie_chart.rb

@@ -1,3 +1,5 @@
+require 'query_report/chart/themes'
+
 module QueryReport
   module Chart
     class PieChart
@@ -8,9 +10,6 @@ module QueryReport
         @options = options
         @rows = []
         @query = query
-        @data_table = GoogleVisualr::DataTable.new
-        @data_table.new_column('string', 'Item')
-        @data_table.new_column('number', 'Value')
       end
 
       def add(column_title, &block)
@@ -19,10 +18,27 @@ module QueryReport
       end
 
       def prepare
+        @data_table = GoogleVisualr::DataTable.new
+        @data_table.new_column('string', 'Item')
+        @data_table.new_column('number', 'Value')
         @data_table.add_rows(@rows)
         opts = {:width => 500, :height => 240, :title => @title, :is3D => true}.merge(options)
         GoogleVisualr::Interactive::PieChart.new(@data_table, opts)
       end
+
+      def prepare_gruff
+        @gruff = Gruff::Pie.new(options[:width] || 600)
+        @gruff.title = title
+        @gruff.theme = Gruff::Themes::GOOGLE_CHART
+        @rows.each do |row|
+          @gruff.data(row[0], row[1])
+        end
+      end
+
+      def to_blob
+        prepare_gruff
+        @gruff.to_blob
+      end
     end
   end
 end

data/lib/query_report/chart/themes.rb

@@ -0,0 +1,116 @@
+module Gruff
+  module Themes
+    # A color scheme similar to the popular presentation software.
+    KEYNOTE = {
+        :colors => [
+            '#FDD84E', # yellow
+            '#6886B4', # blue
+            '#72AE6E', # green
+            '#D1695E', # red
+            '#8A6EAF', # purple
+            '#EFAA43', # orange
+            'white'
+        ],
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['black', '#4a465a']
+    }
+
+    # A color scheme plucked from the colors on the popular usability blog.
+    THIRTYSEVEN_SIGNALS = {
+        :colors => [
+            '#FFF804', # yellow
+            '#336699', # blue
+            '#339933', # green
+            '#ff0000', # red
+            '#cc99cc', # purple
+            '#cf5910', # orange
+            'black'
+        ],
+        :marker_color => 'black',
+        :font_color => 'black',
+        :background_colors => ['#d1edf5', 'white']
+    }
+
+    # A color scheme from the colors used on the 2005 Rails keynote
+    # presentation at RubyConf.
+    RAILS_KEYNOTE = {
+        :colors => [
+            '#00ff00', # green
+            '#333333', # grey
+            '#ff5d00', # orange
+            '#f61100', # red
+            'white',
+            '#999999', # light grey
+            'black'
+        ],
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['#0083a3', '#0083a3']
+    }
+
+    # A color scheme similar to that used on the popular podcast site.
+    ODEO = {
+        :colors => [
+            '#202020', # grey
+            'white',
+            '#3a5b87', # dark blue
+            '#a21764', # dark pink
+            '#8ab438', # green
+            '#999999', # light grey
+            'black'
+        ],
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['#ff47a4', '#ff1f81']
+    }
+
+    # A pastel theme
+    PASTEL = {
+        :colors => [
+            '#a9dada', # blue
+            '#aedaa9', # green
+            '#daaea9', # peach
+            '#dadaa9', # yellow
+            '#a9a9da', # dk purple
+            '#daaeda', # purple
+            '#dadada' # grey
+        ],
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+    }
+
+    # A greyscale theme
+    GREYSCALE = {
+        :colors => [
+            '#282828', #
+            '#383838', #
+            '#686868', #
+            '#989898', #
+            '#c8c8c8', #
+            '#e8e8e8', #
+        ],
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+    }
+
+    # A pastel theme
+    GOOGLE_CHART = {
+        :colors => [
+            '#3366CC', # blue
+            '#DC3912', # red
+            '#FF9900', # yellow
+            '#109618', # green
+            '#990099', # dk purple
+            '#0099C6', # sky
+            '#DD4477'  # grey
+        ],
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+    }
+
+  end
+end

data/lib/query_report/helper.rb

@@ -4,7 +4,7 @@ module QueryReport
   module Helper
     def reporter(query, &block)
       @report ||= QueryReport::Report.new(params)
-      @report.set_query(query)
+      @report.query = query
       @report.instance_eval &block
       render_report
     end
@@ -14,7 +14,7 @@ module QueryReport
         format.html { render 'query_report/list' }
         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)) }
+        format.pdf { render_pdf(ReportPdf.new(@report).standard) }
       end
     end
 

data/lib/query_report/report.rb

@@ -5,8 +5,7 @@ require 'query_report/chart/chart_with_total'
 
 module QueryReport
   class Report
-    attr_accessor :params, :query, :query_without_pagination, :chart, :charts,
-                  :filters, :search, :scopes, :current_scope
+    attr_accessor :params, :chart, :charts, :filters, :search, :scopes, :current_scope
 
     def initialize(params, options={}, &block)
       @params = params
@@ -24,13 +23,6 @@ module QueryReport
       @columns << Column.new(name, options, block)
     end
 
-    def set_query(query)
-      @query_cache = query
-      #apply ransack
-      @search = query.search(@params[:q])
-      @query_cache = @search.result
-    end
-
     def columns
       @columns
     end
@@ -39,6 +31,10 @@ module QueryReport
       @column_names ||= (@columns||[]).collect(&:humanize)
     end
 
+    def query=(query)
+      @query_cache = query
+    end
+
     def query
       apply_filters_and_pagination
       @query_cache
@@ -99,15 +95,19 @@ module QueryReport
     private
     def apply_filters_and_pagination
       return if @applied_filters_and_pagination
+      #apply ransack
+      @search = @query_cache.search(@params[:q])
+      @query_cache = @search.result
+
+      #apply scope
       if @current_scope and !['all', 'delete_all', 'destroy_all'].include?(@current_scope)
         @query_cache = @query_cache.send(@current_scope)
       end
 
+      #apply filters
       @filters.each do |filter|
         if filter.custom
           param = @params[:custom_search]
-          #Rails.logger.debug "@params[:custom_search] :: #{@params[:custom_search].inspect}"
-          #Rails.logger.debug "param :: #{param.inspect}"
           first_val = param[filter.keys.first] rescue nil
           last_val = param[filter.keys.last] rescue nil
           case filter.keys.size
@@ -120,6 +120,8 @@ module QueryReport
           end
         end
       end
+
+      #apply pagination
       @query_without_pagination_cache = @query_cache
       @query_cache = @query_without_pagination_cache.page(@params[:page])
       @applied_filters_and_pagination = true

data/lib/query_report/report_pdf.rb

@@ -0,0 +1,107 @@
+require "prawn"
+require "open-uri"
+
+class ReportPdf
+  attr_accessor :pdf, :default_options
+
+  def initialize(report)
+    @report = report
+    self.default_options = {alternate_row_bg_color: ["DDDDDD", "FFFFFF"],
+                            header_bg_color: 'AAAAAA',
+                            color: '000000',
+                            light_color: '555555'}
+    self.pdf = Prawn::Document.new
+  end
+
+  def render_header(options={})
+    #pdf.font("Times-Roman", size: 10) do
+    #  pdf.text_box current_institute.address.to_s,
+    #               :at => [400, pdf.cursor+20],
+    #               :inline_format => true,
+    #               :height => 100,
+    #               :width => 100
+    #end
+  end
+
+  def pdf_content(&code)
+    render_header
+    code.call(pdf)
+    pdf
+  end
+
+  def standard
+    pdf_content do
+      @report.charts.each do |chart|
+        if chart.respond_to?(:to_blob)
+          blob = chart.to_blob
+          data = StringIO.new(blob)
+          pdf.image(data)
+        end
+      end
+      
+      render_table_with(@report.all_records, {font_size: 8, header_font_size: 10})
+    end
+  end
+
+  private
+  def table_header_for(table_items, options={})
+    table_items.first.keys
+  end
+
+  def humanized_table_header_for(table_items, options={})
+    table_items.first.keys.collect(&:humanize) rescue table_header_for(table_items, options)
+  end
+
+  def table_content_for(table_items, options)
+    table_items.map do |item|
+      item_values = []
+
+      options[:table_header].each do |header|
+        item_values << cell_for(item, header)
+      end
+      item_values
+    end
+  end
+
+  def cell_for(item, prop)
+    val = item.respond_to?(prop) ? item.send(prop) : item[prop]
+    if val.kind_of? Array
+      val.collect { |v| [v] }
+      return pdf.make_table(val)
+    end
+    val
+  end
+
+  def render_table_with(table_items, options={})
+    if table_items.present?
+      options[:table_header] ||= table_header_for(table_items, options)
+      items = [humanized_table_header_for(table_items)]
+      items += table_content_for(table_items, options)
+      items += table_footer_for(table_items, options)
+      options[:bold_footer] = options[:titles_of_column_to_sum].present?
+      render_table(items, options)
+    end
+    pdf
+  end
+
+  def render_table(items, options={})
+    options = default_options.merge options
+    header_bg_color = options[:header_bg_color]
+    pdf.move_down 10
+    pdf.table(items, :row_colors => options[:alternate_row_bg_color], :header => true, :cell_style => {:inline_format => true, :size => options[:font_size] || 10}) do
+      row(0).style(:font_style => :bold, :background_color => header_bg_color, :size => options[:header_font_size] || 14)
+      row(items.size-1).style(:font_style => :bold) if options[:bold_footer]
+    end
+  end
+
+  def table_footer_for(table_items, options)
+    return [] if options[:titles_of_column_to_sum].blank?
+    total_hash = {} #for calculating total for a column
+    options[:titles_of_column_to_sum].each do |col|
+      total_hash[col] = table_items.sum { |i| (i.respond_to?(col) ? i.send(col) : i[col]) || 0 }
+    end
+
+    render_footer_with_col_span(total_hash, options)
+  end
+
+end

data/lib/query_report/row.rb

@@ -0,0 +1,11 @@
+module QueryReport
+  class Row
+    attr_reader :name, :value, :type
+
+    def initialize(name, value)
+      @name  = name
+      @value = value
+      @type  = value.kind_of?(String) ? 'string' : 'number'
+    end
+  end
+end

data/lib/query_report/version.rb

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

data/query_report.gemspec

@@ -19,4 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'ransack'
   gem.add_dependency 'google_visualr', '>= 2.1'
+  gem.add_dependency 'rmagick'
+  gem.add_dependency 'gruff'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_report
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This is a gem to help you to structure common reports of you application
   just by writing in the controller
 email:
@@ -64,10 +96,13 @@ files:
 - lib/query_report/chart/chart_with_total.rb
 - lib/query_report/chart/custom_chart.rb
 - lib/query_report/chart/pie_chart.rb
+- lib/query_report/chart/themes.rb
 - lib/query_report/column.rb
 - lib/query_report/filter.rb
 - lib/query_report/helper.rb
 - lib/query_report/report.rb
+- lib/query_report/report_pdf.rb
+- lib/query_report/row.rb
 - lib/query_report/version.rb
 - query_report.gemspec
 homepage: https://github.com/ashrafuzzaman/query_report