query_report 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in query_report.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 A.K.M. Ashrafuzzaman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,29 @@
+# QueryReport
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'query_report'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_report
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/README.rdoc

@@ -0,0 +1,3 @@
+= QueryReport
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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

@@ -0,0 +1,7 @@
+<% if filter.type == :user %>
+    <% search_key = "#{filter.column.to_s}_id_eq"
+       user_id = @record.search.send(search_key)
+       user_name = User.find(user_id).name rescue '' %>
+    <%= user_search_field_tag "#{search_key}_search_field", user_name, :placeholder => filter.column.to_s.humanize, :'sync-id' => "q_#{search_key}" %>
+    <%= f.hidden_field search_key %>
+<% end %>

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

@@ -0,0 +1,62 @@
+<%= 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 %>
+
+<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 %>
+<% end %>
+<br/>
+<br/>
+
+<% if @record.column_names %>
+    <table class="table table-bordered table-striped">
+      <thead>
+      <% @record.column_names.each do |column| %>
+          <th><%= column.humanize %></th>
+      <% end %>
+      </thead>
+
+      <tbody>
+      <% @record.records.each do |record| %>
+          <tr>
+            <% @record.column_names.each do |column| %>
+                <td><%= record[column] %></td>
+            <% end %>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+<% else %>
+    <p>No record found</p>
+<% end %>
+
+<%= paginate @record.query %>

data/lib/query_report/chart/basic_chart.rb

@@ -0,0 +1,41 @@
+module QueryReport
+  module Chart
+    class BasicChart
+      attr_reader :title, :columns, :type, :data, :options
+
+      def initialize(type, name, columns, data, options={})
+        @type = type
+        @name = name
+        @columns = []
+        columns.each_with_index do |column, i|
+          @columns << QueryReport::Column.new(column, {type: (i == 0 ? 'string' : 'number')})
+        end
+        @data = data
+        @options = options
+      end
+
+      def prepare
+        data_table = GoogleVisualr::DataTable.new
+        columns.each do |column|
+          data_table.new_column(column.type, column.name)
+        end
+
+        rows = []
+        @data.each do |record|
+          row = []
+          columns.each do |column|
+            row << record[column.name]
+          end
+          rows << row
+        end
+        data_table.add_rows(rows)
+
+        opts = {:width => 400, :height => 240, :title => title, :hAxis => {:title => columns[0].name}}.merge(options)
+
+        chart_type = "#{type}_chart".classify
+        chart_type = "GoogleVisualr::Interactive::#{chart_type}".constantize
+        chart_type.new(data_table, opts)
+      end
+    end
+  end
+end

data/lib/query_report/chart/chart_with_total.rb

@@ -0,0 +1,82 @@
+module QueryReport
+  module Chart
+    class ChartWithTotal
+      attr_reader :title, :columns, :type, :data, :options
+
+      def initialize(type, name, columns, data, options={})
+        @type = type
+        @name = name
+        @columns = []
+        columns.each do |column|
+          @columns << QueryReport::Column.new(column, 'number')
+        end
+        @data = data
+        @options = options
+      end
+
+      def prepare
+        data_table = GoogleVisualr::DataTable.new
+        columns.each do |column|
+          data_table.new_column(column.type, column.name)
+        end
+
+        row = []
+        columns.each do |column|
+          total = 0
+          @data.each do |r|
+            total += r[column].to_f
+          end
+          row << total
+        end
+
+        data_table.add_row(row)
+
+        opts = {:width => 400, :height => 240, :title => title}.merge(options)
+
+        chart_type = "#{type}_chart".classify
+        chart_type = "GoogleVisualr::Interactive::#{chart_type}".constantize
+        chart_type.new(data_table, opts)
+      end
+    end
+  end
+
+  #class ColumnChartWithTotal
+  #  attr_reader :title, :columns, :type, :data, :options
+  #
+  #  def initialize(type, name, columns, data, options={})
+  #    @type = type
+  #    @name = name
+  #    @columns = []
+  #    columns.each do |column|
+  #      @columns << Report::Column.new(column, 'number')
+  #    end
+  #    @data = data
+  #    @options = options
+  #  end
+  #
+  #  def prepare
+  #    data_table = GoogleVisualr::DataTable.new
+  #    columns.each do |column|
+  #      data_table.new_column(column.type, column.name)
+  #    end
+  #
+  #    row = []
+  #    columns.each do |column|
+  #      total = 0
+  #      @data.each do |r|
+  #        total += r[column].to_f
+  #      end
+  #      row << total
+  #    end
+  #
+  #    data_table.add_row(row)
+  #
+  #    opts = {:width => 400, :height => 240, :title => title}.merge(options)
+  #
+  #    chart_type = "#{type}_chart".classify
+  #    chart_type = "GoogleVisualr::Interactive::#{chart_type}".constantize
+  #    chart_type.new(data_table, opts)
+  #  end
+  #end
+
+end

data/lib/query_report/chart/custom_chart.rb

@@ -0,0 +1,35 @@
+module QueryReport
+  module Chart
+    class CustomChart
+      attr_reader :title, :type, :options, :data_table, :row
+
+      def initialize(type, title, query, options={})
+        @type = type
+        @title = title
+        @query = query
+        @options = options
+        @row = []
+        @data_table = GoogleVisualr::DataTable.new
+      end
+
+      def add_column(title)
+        @data_table.new_column('string', title)
+        @row << title.humanize
+      end
+
+      def add(column_title, &block)
+        val = block.call(@query)
+        @data_table.new_column(val.kind_of?(String) ? 'string' : 'number', column_title)
+        @row << val
+      end
+
+      def prepare
+        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)
+      end
+    end
+  end
+end

data/lib/query_report/chart/pie_chart.rb

@@ -0,0 +1,28 @@
+module QueryReport
+  module Chart
+    class PieChart
+      attr_reader :title, :options, :data_table, :query, :rows
+
+      def initialize(title, query, options={})
+        @title = title
+        @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)
+        val = block.call(@query)
+        @rows << [column_title, val]
+      end
+
+      def prepare
+        @data_table.add_rows(@rows)
+        opts = {:width => 500, :height => 240, :title => @title, :is3D => true}.merge(options)
+        GoogleVisualr::Interactive::PieChart.new(@data_table, opts)
+      end
+    end
+  end
+end

data/lib/query_report/column.rb

@@ -0,0 +1,17 @@
+module QueryReport
+  class Column
+    attr_reader :name, :options, :type, :data
+
+    def initialize(name, options={}, block = nil)
+      @name = name
+      @options = options
+      @type = (options.kind_of?(Hash) ? options[:type] : options) || 'string'
+      @data = block || name.to_sym
+    end
+
+    def humanize
+      options[:as] || name.to_s.humanize
+    end
+  end
+
+end

data/lib/query_report/filter.rb

@@ -0,0 +1,41 @@
+module QueryReport
+  class Filter
+    attr_reader :column, :type, :comparators, :block, :custom
+
+    def initialize(column, options, &block)
+      @column = column
+      @type = options if options.kind_of? String
+      if options.kind_of? Hash
+        @type = options[:type]
+        @comparators = options[:comp] || detect_comparators(@type)
+      end
+      @block = block
+      @custom = @block ? true : false
+    end
+
+    def self.supported_types
+      [:date, :text]
+    end
+
+    def keys
+      @keys ||= (@comparators || {}).keys.map { |comp| "#{column.to_s}_#{comp}" }
+    end
+
+    supported_types.each do |supported_type|
+      define_method("#{supported_type.to_s}?") do
+        @type == supported_type
+      end
+    end
+
+    private
+    def detect_comparators(type)
+      case type
+        when :date
+          return {gteq: 'From', lteq: 'To'}
+        when :text
+          return {cont: @column.to_s.humanize}
+      end
+      {eq: 'Equal'}
+    end
+  end
+end

data/lib/query_report/helper.rb

@@ -0,0 +1,35 @@
+require 'query_report/record'
+
+module QueryReport
+  module Helper
+    def reporter(query, &block)
+      @record ||= QueryReport::Record.new(params)
+      @record.set_query(query)
+      @record.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)) }
+      end
+    end
+
+    def generate_csv_for_report(records)
+      if records.size > 0
+        columns = records.first.keys
+        CSV.generate do |csv|
+          csv << columns
+          records.each do |record|
+            csv << record.values
+          end
+        end
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/query_report/record.rb

@@ -0,0 +1,124 @@
+require 'query_report/filter'
+require 'query_report/column'
+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,
+                  :filters, :search, :scopes, :current_scope
+
+    def initialize(params, options={}, &block)
+      @params = params
+      @columns = []
+      @filters = []
+      @scopes = []
+      @column_separator = options.delete(:separator)
+      @current_scope = @params[:scope] || 'all'
+      @options = options.delete(:options)
+      instance_eval &block if block_given?
+    end
+
+    def column(name, options={}, &block)
+      @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
+
+    def column_names
+      @column_names ||= (@columns||[]).collect(&:humanize)
+    end
+
+    def query
+      apply_filters_and_pagination
+      @query_cache
+    end
+
+    def query_without_pagination
+      apply_filters_and_pagination
+      @query_without_pagination_cache
+    end
+
+    def records
+      @cached_records ||= map_record(query)
+    end
+
+    def all_records
+      @cached_all_records ||= map_record(query_without_pagination)
+    end
+
+    def map_record(query)
+      query.clone.map do |record|
+        array = @columns.collect { |column| [column.humanize,
+                                             (column.data.kind_of?(Symbol) ? record.send(column.name) : column.data.call(record))] }
+        Hash[*array.flatten]
+      end
+    end
+
+    def filter(column, options, &block)
+      @filters << Filter.new(column, options, &block)
+    end
+
+    def column_chart(title, columns)
+      @chart = QueryReport::Chart::BasicChart.new(:column, title, columns, all_records)
+    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?
+    end
+
+    def pie_chart(title, &block)
+      @chart = QueryReport::Chart::PieChart.new(title, query_without_pagination)
+      @chart.instance_eval &block if block_given?
+    end
+
+    def pie_chart_on_total(title, columns)
+      @chart = QueryReport::Chart::ChartWithTotal.new(:pie, title, columns, all_records, {:is3D => true})
+    end
+
+    def scope(scope)
+      @scopes << scope
+      @scopes = @scopes.uniq
+    end
+
+    private
+    def apply_filters_and_pagination
+      return if @applied_filters_and_pagination
+      if @current_scope and !['all', 'delete_all', 'destroy_all'].include?(@current_scope)
+        @query_cache = @query_cache.send(@current_scope)
+      end
+
+      @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
+            when 1
+              @query_cache = filter.block.call(@query_cache, first_val) if first_val.present?
+              break
+            when 2
+              @query_cache = filter.block.call(@query_cache, first_val, last_val) if first_val.present? and last_val.present?
+              break
+          end
+        end
+      end
+      @query_without_pagination_cache = @query_cache
+      @query_cache = @query_without_pagination_cache.page(@params[:page])
+      @applied_filters_and_pagination = true
+    end
+  end
+end

data/lib/query_report/version.rb

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

data/lib/query_report.rb

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

data/query_report.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_report/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "query_report"
+  gem.version       = QueryReport::VERSION
+  gem.authors       = ["A.K.M. Ashrafuzzaman"]
+  gem.email         = ["ashrafuzzaman.g2@gmail.com"]
+  gem.description   = %q{This is a gem to help you to structure common reports of you application just by writing in the controller}
+  gem.summary       = %q{Structure you reports}
+  gem.homepage      = "https://github.com/ashrafuzzaman/query_report"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib", "app"]
+
+  gem.add_dependency 'ransack'
+  gem.add_dependency 'google_visualr', '>= 2.1'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: query_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- A.K.M. Ashrafuzzaman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ransack
+  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: google_visualr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: This is a gem to help you to structure common reports of you application
+  just by writing in the controller
+email:
+- ashrafuzzaman.g2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- app/views/query_report/_custom_filters.html.erb
+- app/views/query_report/list.html.erb
+- lib/query_report.rb
+- lib/query_report/chart/basic_chart.rb
+- 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/column.rb
+- lib/query_report/filter.rb
+- lib/query_report/helper.rb
+- lib/query_report/record.rb
+- lib/query_report/version.rb
+- query_report.gemspec
+homepage: https://github.com/ashrafuzzaman/query_report
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- app
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Structure you reports
+test_files: []