compendium 1.0.6 → 1.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWEzYjAwNDlhYjlhZGQ1ODY0NTBmNThhY2ZjOTU4ZTMzMWMzM2Y0OA==
+    Y2ZlZDg2ZDkxZjRlNjc5Yzk0OTZlYWUyYTJkNDZmMTBkNTlmNDczMA==
   data.tar.gz: !binary |-
-    YWZlOGE4NmE3NjQ5ZDM1ODZmMzlhOTJiZjhmYWZjYTU0NTNiN2FiMw==
+    OWE2NmE5MGZlZjhmNzdlOTljZWQyYmQ4NDU2NzhlZmM5MzZhMjgxNg==
 SHA512:
   metadata.gz: !binary |-
-    NjQyMDM2NTE0OGYxMzZhZGUxNzQ5MDkzNGJlMDJmMzcxZjgyNTFjNzAzNDkw
-    ZmVkNWVlNTcxYzkwZTFhOGE1ODdjYmE2NzdlMjNmOGM2Y2I3MjAwZTNlYWI1
-    NzAwNmVlZTY2OTYwMzI5MDcwMTcxYzg3MmY5Y2Q3ZjI2NTRhNzM=
+    ZjNkMDgzYWI0OGNkZTY4NGJmMDQxMzRjMzcyODEyOWE2MGFhZDlmOWIzMzZl
+    ZTQ3OGViNWQ3MGY3ZTlkOGFkMzZhNmVjNmM3NmFiMjYwMzc2MmE0YTQ2ZjBm
+    YzY0ODFkNzlhMzBhZTEzNDkzNTQ3OTVlZmMwZDJiOWE3NWFiYWU=
   data.tar.gz: !binary |-
-    YmYzYmRjZDkyN2Q5ZWU2ZDlhODBiMmJkMjgxNzY3NWE0ZmM4YTFjZDE4NGNj
-    MDY2NTk2YzkwYjIyMmZiMTA1MGYxOWRmOTI2N2NmZjE0MDVlNmYyYTdiNzZh
-    NTIyMjQ3NzNmZDRiYTE3YjI4NTg2NmM5NzJiNWFkODkxM2I1MWI=
+    ZDk4ODU0OTJmMTU4ODA2ODViZjhlNDVjZTI2YTdlMjA4ZDY2ZGFhZWI1OWQy
+    ZjM4MjAxNTI2NzRkYTYxNTlhNDAxNzkxYzMwNjdhNDA4MGI3N2NhZWRlOTFm
+    Yjc1OWQzMzVjNWZhN2QwNGQ3YTZkMTgyZTI0NjRkMmMzNjcyNjI=

data/README.md

@@ -1,4 +1,4 @@
-# Compendium
+# Compendium [![Gem Version](https://badge.fury.io/rb/compendium.svg)](http://badge.fury.io/rb/compendium)
 
 Ruby on Rails framework for making reporting easy.
 
@@ -68,6 +68,14 @@ within your `config/routes.rb` file
 mount_compendium at: '/report', controller: 'reports' # controller defaults to compendium/reports
 ```
 
+### Rendering report results as JSON
+
+While the default action when running a report is to render a view with the results, Compendium reports can be rendered
+as JSON. If using the default routes provided by `mount_compendium` (assuming compendium was mounted at `/report`),
+`POST`ing to <code>report/<i>report_name</i>.json</code> will return the report results as JSON. You can also collect
+the results of a single query (instead of the entire report) by `POST`ing to
+<code>report/<i>report_name</i>/<i>query_name</i>.json</code>.
+
 ### Interaction with other gems
 * If [accessible_tooltip](https://github.com/dvandersluis/accessible_tooltip) is present, option notes will be rendered
 in a tooltip rather than as straight text.

data/app/controllers/compendium/reports_controller.rb

@@ -4,6 +4,7 @@ module Compendium
     include Compendium::ReportsHelper
 
     before_filter :find_report
+    before_filter :find_query
     before_filter :validate_options, only: :run
     before_filter :run_report, only: :run
 
@@ -12,8 +13,16 @@ module Compendium
     end
 
     def run
-      template = template_exists?(@prefix, get_template_prefixes) ? @prefix : 'run'
-      render action: template, locals: { report: @report }
+      respond_to do |format|
+        format.json do
+          render json: @query ? @query.results : @report.results
+        end
+
+        format.any do
+          template = template_exists?(@prefix, get_template_prefixes) ? @prefix : 'run'
+          render action: template, locals: { report: @report }
+        end
+      end
     end
 
   private
@@ -32,6 +41,16 @@ module Compendium
       end
     end
 
+    def find_query
+      return unless params[:query]
+      @query = @report.queries[params[:query]]
+
+      unless @query
+        flash[:error] = t(:invalid_report_query)
+        redirect_to action: :setup, report_name: params[:report_name]
+      end
+    end
+
     def render_setup(opts = {})
       locals = { report: @report, prefix: @prefix }
       opts.empty? ? render(action: :setup, locals: locals) : render_if_exists(opts.merge(locals: locals)) || render(action: :setup, locals: locals)
@@ -46,7 +65,7 @@ module Compendium
     end
 
     def run_report
-      @report.run(self)
+      @report.run(self, @query ? { only: @query.name } : {})
     end
 
     def get_template_prefixes

data/config/locales/en.yml

@@ -2,4 +2,5 @@ en:
   compendium:
     reports:
       invalid_report: "Invalid report!"
+      invalid_report_query: "Invalid query!"
       generate_report: "Generate Report"

data/lib/compendium/engine/mount.rb

@@ -4,7 +4,7 @@ module ActionDispatch
       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', action: :run, as: 'compendium_reports_run'
+          post ':report_name(/:query)', action: :run, as: 'compendium_reports_run'
           root action: :index, as: 'compendium_reports_root'
         end
       end

data/lib/compendium/version.rb

@@ -1,3 +1,3 @@
 module Compendium
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compendium
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime