compendium 1.1.3.4 → 1.2.0

data/app/controllers/compendium/reports_controller.rb

@@ -5,8 +5,8 @@ module Compendium
 
     before_filter :find_report
     before_filter :find_query
-    before_filter :validate_options, only: :run
-    before_filter :run_report, only: :run
+    before_filter :validate_options, only: [:run, :export]
+    before_filter :run_report, only: [:run, :export]
 
     def setup
       render_setup
@@ -25,6 +25,27 @@ module Compendium
       end
     end
 
+    def export
+      unless @report.exports?(request.format)
+        redirect_to action: :setup, format: nil
+        return
+      end
+
+      respond_to do |format|
+        format.csv do
+          filename = @report.report_name.to_s.parameterize + '-' + Time.current.strftime('%Y%m%d%H%I%S')
+          response.headers['Content-Disposition'] = 'attachment; filename="' + filename + '.csv"'
+
+          query = @report.queries[@report.exporters[:csv]]
+          render text: query.render_csv
+        end
+
+        format.any do
+          redirect_to action: :setup, format: nil
+        end
+      end
+    end
+
   private
 
     def find_report
@@ -32,11 +53,11 @@ module Compendium
       @report_name = "#{@prefix}_report"
 
       begin
-        require(@report_name) unless Rails.env.development? or Module.const_defined?(@report_name.classify)
+        require(@report_name) unless Rails.env.development? || Module.const_defined?(@report_name.classify)
         @report_class = @report_name.camelize.constantize
         @report = setup_report
       rescue LoadError
-        flash[:error] = t(:invalid_report)
+        flash[:error] = t(:invalid_report, scope: 'compendium.reports')
         redirect_to action: :index
       end
     end
@@ -46,7 +67,7 @@ module Compendium
       @query = @report.queries[params[:query]]
 
       unless @query
-        flash[:error] = t(:invalid_report_query)
+        flash[:error] = t(:invalid_report_query, scope: 'compendium.reports')
         redirect_to action: :setup, report_name: params[:report_name]
       end
     end
@@ -61,7 +82,7 @@ module Compendium
     end
 
     def validate_options
-      render_setup and return unless @report.valid?
+      render_setup && return unless @report.valid?
     end
 
     def run_report
@@ -80,4 +101,4 @@ module Compendium
       paths
     end
   end
-end
+end

data/app/views/compendium/reports/setup.haml

@@ -4,11 +4,25 @@
 = render_if_exists partial: 'report_header', path: 'compendium/reports'
 
 .options
-  = form_for report, as: :report, url: compendium_reports_run_path do |f|
+  = form_for report, as: :report, url: compendium_reports_run_path, html: { id: 'setup_report_form' } do |f|
+    = hidden_field_tag :format, :html
+
     - report.options.each do |option|
       - expose option, Compendium::Presenters::Option do |opt|
         .option
           = opt.label(f)
           .option-element-group= opt.input(self, f)
 
-    = f.submit t(:generate_report, scope: 'compendium.reports')
+    .option
+      = f.submit t(:generate_report, scope: 'compendium.reports'), onclick: "set_format('html')"
+      - if report.exports?(:csv)
+        = f.submit t(:export_csv, scope: 'compendium.reports'), name: :export, onclick: "set_format('csv')"
+
+:javascript
+  function set_format(format)
+  {
+    var form = document.getElementById('setup_report_form'),
+        input = form.querySelector('input#format[type=hidden]');
+
+    input.value = format;
+  }

data/compendium.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'rails', '>= 3.0.0'
+  gem.add_dependency 'rails', '>= 3.0.0', '< 4'
   gem.add_dependency 'sass-rails', '>= 3.0.0'
   gem.add_dependency 'compass-rails', '>= 1.0.0'
-  gem.add_dependency 'collection_of', '1.0.5'
+  gem.add_dependency 'collection_of', '1.0.6'
   gem.add_dependency 'inheritable_attr', '>= 1.0.0'
-  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'rake', '> 11.0.1', '< 12'
+  gem.add_development_dependency 'rspec', '~> 2.0', '< 2.99'
 end

data/config/locales/en.yml

@@ -1,6 +1,11 @@
 en:
   compendium:
+    total: "Total"
+
     reports:
+      generate_report: "Generate Report"
+      export_csv: "Export CSV"
+
       invalid_report: "Invalid report!"
       invalid_report_query: "Invalid query!"
-      generate_report: "Generate Report"
+      query_required_for_csv: "A query must be specified to export a CSV file!"

data/config/locales/es.yml

@@ -0,0 +1,11 @@
+es:
+  compendium:
+    total: "Total"
+
+    reports:
+      generate_report: "Generar informe"
+      export_csv: "Exportar CSV"
+
+      invalid_report: "¡Informe no válido!"
+      invalid_report_query: "¡Consulta no válida!"
+      query_required_for_csv: "¡Se debe especificar una consulta para exportar un archivo CSV!"

data/config/locales/fr.yml

@@ -0,0 +1,11 @@
+fr:
+  compendium:
+    total: "Total"
+
+    reports:
+      generate_report: "Générer Rapport"
+      export_csv: "Exporter CSV"
+
+      invalid_report: "Rapport invalide!"
+      invalid_report_query: "Requête invalide!"
+      query_required_for_csv: "Une requête doit être spécifiée afin d'exporter un fichier CSV!"

data/lib/compendium.rb

@@ -1,4 +1,5 @@
 require 'compendium/engine'
+require 'compendium/errors'
 require 'compendium/version'
 require 'active_support/configurable'
 

data/lib/compendium/collection_query.rb

@@ -37,7 +37,7 @@ module Compendium
     end
 
     def prepare_collection(collection)
-      return collection if collection.is_a?(Query) or collection.is_a?(Symbol)
+      return collection if collection.is_a?(Query) || collection.is_a?(Symbol)
       collection.is_a?(Hash) ? collection : Hash[collection.zip(collection)]
     end
   end

data/lib/compendium/count_query.rb

@@ -1,10 +1,16 @@
+require 'compendium/errors'
 require 'compendium/query'
 
 module Compendium
   # A CountQuery is a Query which runs an SQL count statement
   # Often useful in conjunction with a grouped query
   class CountQuery < Query
-    InvalidCommand = Class.new(StandardError)
+
+    def initialize(*args)
+      super
+
+      @options.reverse_merge!(order: 'COUNT(*)', reverse: true)
+    end
 
   private
 

data/lib/compendium/dsl.rb

@@ -8,14 +8,17 @@ module Compendium
     def self.extended(klass)
       klass.inheritable_attr :queries, default: ::Collection[Query]
       klass.inheritable_attr :options, default: ::Collection[Option]
+      klass.inheritable_attr :exporters, default: {}
     end
 
+    # Define a query
     def query(name, opts = {}, &block)
       define_query(name, opts, &block)
     end
     alias_method :chart, :query
     alias_method :data, :query
 
+    # Define a parameter for the report
     def option(name, *args)
       opts = args.extract_options!
       type = args.shift
@@ -31,6 +34,8 @@ module Compendium
       end
     end
 
+    # Define a metric from a query or implicitly
+    # A metric is a derived statistic from a report, for instance a count of rows
     def metric(name, *args, &block)
       proc = args.first.is_a?(Proc) ? args.first : block
       opts = args.extract_options!
@@ -49,10 +54,32 @@ module Compendium
       end
     end
 
+    # Define a filter to modify the results from specified query (in this case :deliveries)
+    # For example, this can be useful to translate columns prior to rendering, as it will apply
+    # for all render types (table, chart, JSON)
+    # Multiple queries can be set up with the same filter
     def filter(*query_names, &block)
-      query_names.each do |query_name|
-        raise ArgumentError, "query #{query_name} is not defined" unless queries.key?(query_name)
-        queries[query_name].add_filter(block)
+      each_query(query_names) do |query|
+        query.add_filter(block)
+      end
+    end
+
+    # Allow default table settings to be defined for a query.
+    # These settings are used when rendering a query to an HTML table or to CSV
+    def table(*query_names, &block)
+      each_query(query_names) do |query|
+        query.table_settings = block
+      end
+    end
+
+    # Define any exports the report has
+    def exports(type, *opts)
+      exporters[type] = if opts.empty?
+        true
+      elsif opts.length == 1
+        opts.first
+      else
+        opts
       end
     end
 
@@ -86,6 +113,13 @@ module Compendium
 
   private
 
+    def each_query(query_names, &block)
+      query_names.each do |query_name|
+        raise ArgumentError, "query #{query_name} is not defined" unless queries.key?(query_name)
+        yield queries[query_name]
+      end
+    end
+
     def define_query(name, opts, &block)
       params = [name.to_sym, opts, block]
       query_type = Query
@@ -110,7 +144,14 @@ module Compendium
       query.report = self
 
       metrics[name] = opts[:metric] if opts.key?(:metric)
+
+      if queries[name]
+        raise CannotRedefineQueryType unless queries[name].instance_of?(query_type)
+        queries.delete(name)
+      end
+
       queries << query
+
       query
     end
 
@@ -119,4 +160,4 @@ module Compendium
       self.params_class.validates name, validations
     end
   end
-end
+end

data/lib/compendium/engine/mount.rb

@@ -1,13 +1,21 @@
 module ActionDispatch
   module Routing
     class Mapper
+      class ExportRouter
+        def matches?(request)
+          request.params[:export].present?
+        end
+      end
+
       def mount_compendium(options = {})
-        scope options[:at], controller: options.fetch(:controller, 'compendium/reports') do
-          get ':report_name', action: :setup, as: 'compendium_reports_setup'
-          post ':report_name(/:query)', action: :run, as: 'compendium_reports_run'
-          root action: :index, as: 'compendium_reports_root'
+        scope options[:at], controller: options.fetch(:controller, 'compendium/reports'), as: 'compendium_reports' do
+          get ':report_name', action: :setup, constraints: { format: :html }, as: 'setup'
+          match ':report_name/export', action: :export, as: 'export', via: [:get, :post]
+          post ':report_name(/:query)', constraints: ExportRouter.new, action: :export, as: 'export_post'
+          match ':report_name(/:query)', action: :run, as: 'run', via: [:get, :post]
+          root action: :index, as: 'root'
         end
       end
     end
   end
-end
+end

data/lib/compendium/errors.rb

@@ -0,0 +1,6 @@
+module Compendium
+  CompendiumError = Class.new(StandardError)
+
+  InvalidCommand = Class.new(CompendiumError)
+  CannotRedefineQueryType = Class.new(CompendiumError)
+end

data/lib/compendium/metric.rb

@@ -27,7 +27,7 @@ module Compendium
   private
 
     def condition_failed?(ctx)
-      (options.key?(:if) and !ctx.instance_exec(&options[:if])) or (options.key?(:unless) and ctx.instance_exec(&options[:unless]))
+      (options.key?(:if) && !ctx.instance_exec(&options[:if])) || (options.key?(:unless) && ctx.instance_exec(&options[:unless]))
     end
   end
 end

data/lib/compendium/open_hash.rb

@@ -45,7 +45,7 @@ module Compendium
           return self[method[1..-1]] if self.key?(method[1..-1].to_sym)
 
         else
-          return self[method] if key?(method) or !respond_to?(method)
+          return self[method] if key?(method) || !respond_to?(method)
       end
 
       super

data/lib/compendium/param_types.rb

@@ -38,7 +38,7 @@ module Compendium
         index = obj
       else
         index = obj.numeric? ? obj.to_i : @choices.index(obj)
-        raise IndexError if (!obj.nil? and index.nil?) or index.to_i.abs > @choices.length - 1
+        raise IndexError if (!obj.nil? && index.nil?) || index.to_i.abs > @choices.length - 1
       end
 
       super(index)
@@ -63,7 +63,7 @@ module Compendium
   class BooleanParam < Param
     def initialize(obj, *)
       # If given 0, 1, or a version thereof (ie. "0"), pass it along
-      return super obj.to_i if obj.numeric? and (0..1).cover?(obj.to_i)
+      return super obj.to_i if obj.numeric? && (0..1).cover?(obj.to_i)
       super !!obj ? 0 : 1
     end
 

data/lib/compendium/params.rb

@@ -37,7 +37,7 @@ module Compendium
     end
 
     def get_default_value(current, default)
-      if current.blank? and !default.blank?
+      if current.blank? && !default.blank?
         default.respond_to?(:call) ? default.call : default
       else
         current

data/lib/compendium/query.rb

@@ -4,12 +4,11 @@ require 'compendium/metric'
 require 'compendium/presenters/chart'
 require 'compendium/presenters/table'
 require 'collection_of'
-require_relative '../../config/initializers/ruby/hash'
 
 module Compendium
   class Query
     attr_reader :name, :results, :metrics, :filters
-    attr_accessor :options, :proc, :report
+    attr_accessor :options, :proc, :report, :table_settings
 
     def initialize(*args)
       @report = args.shift if arg_is_report?(args.first)
@@ -58,6 +57,10 @@ module Compendium
       Compendium::Presenters::Table.new(template, self, *options, &block).render unless empty?
     end
 
+    def render_csv(&block)
+      Compendium::Presenters::CSV.new(self, &block).render unless empty?
+    end
+
     # Allow access to the chart object without having to explicitly render it
     def chart(template, *options, &block)
       # Access the actual chart object
@@ -89,6 +92,8 @@ module Compendium
 
     def collect_results(context, *params)
       command = context.instance_exec(*params, &proc) if proc
+      command = order_command(command) if options[:order]
+
       results = fetch_results(command)
       results = filter_results(results, *params) if filters.any?
       @results = ResultSet.new(results) if results
@@ -105,6 +110,12 @@ module Compendium
     def filter_results(results, params)
       return unless results
 
+      if results.respond_to? :with_indifferent_access
+        results = results.with_indifferent_access
+      else
+        results.map! &:with_indifferent_access
+      end
+
       filters.each do |f|
         if f.arity == 2
           results = f.call(results, params)
@@ -116,6 +127,14 @@ module Compendium
       results
     end
 
+    def order_command(command)
+      return command unless command.respond_to?(:order)
+
+      command = command.order(options[:order])
+      command = command.reverse_order if options.fetch(:reverse, false)
+      command
+    end
+
     def execute_command(command)
       return [] if command.nil?
       command = command.to_sql if command.respond_to?(:to_sql)
@@ -127,11 +146,11 @@ module Compendium
     end
 
     def arg_is_report?(arg)
-      arg.is_a?(Report) or (arg.is_a?(Class) and arg < Report)
+      arg.is_a?(Report) || (arg.is_a?(Class) && arg < Report)
     end
 
     def get_associated_query(query)
       query.is_a?(Query) ? query : report.queries[query]
     end
   end
-end
+end