compendium 1.0.5 → 1.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWQyNzhiZThjMTNmZGNiNTg1NzY1YzlhMGUwOGM1ZDllOGU1YzhkYQ==
+    YWEzYjAwNDlhYjlhZGQ1ODY0NTBmNThhY2ZjOTU4ZTMzMWMzM2Y0OA==
   data.tar.gz: !binary |-
-    NWIyNjQ5YzBjMWI4YTZjMWNjOTEzMmExM2U3OTE5NTI5NTUyYzI0ZQ==
+    YWZlOGE4NmE3NjQ5ZDM1ODZmMzlhOTJiZjhmYWZjYTU0NTNiN2FiMw==
 SHA512:
   metadata.gz: !binary |-
-    OWMxY2NjZDlhYmNjMzliNTJjMjE3N2Y3N2EyMmNmNjQ5Nzc3ZWYwZWIwYjli
-    NjBlYTNlMTRlNzRmZDg3NjdjNTUxNmM5NTZhODhhNGFmZjk0ZTg4MTkwMzBi
-    NjMyZDgyZWM5NjUxOWRmYTg4N2UzMjFlNWM0ZGExOTRiZTRiZjE=
+    NjQyMDM2NTE0OGYxMzZhZGUxNzQ5MDkzNGJlMDJmMzcxZjgyNTFjNzAzNDkw
+    ZmVkNWVlNTcxYzkwZTFhOGE1ODdjYmE2NzdlMjNmOGM2Y2I3MjAwZTNlYWI1
+    NzAwNmVlZTY2OTYwMzI5MDcwMTcxYzg3MmY5Y2Q3ZjI2NTRhNzM=
   data.tar.gz: !binary |-
-    ZWI0OGNlYTkzNmQ2MDQ5ZGE4ZmM0NWY5NmRlZDU0NjNhNzgwNzFkMDI3MjA4
-    OTFkOGZhYzY0ZWZiYWNkMjY0ZDVjMjlmMzJkM2EwYTEzN2NkYTAxNzM5NzA0
-    MDA1Njk3ZDQ5NjAxNWRmNTdkZWE2NWM4NDVhMGE2YzE3ZmNhZDc=
+    YmYzYmRjZDkyN2Q5ZWU2ZDlhODBiMmJkMjgxNzY3NWE0ZmM4YTFjZDE4NGNj
+    MDY2NTk2YzkwYjIyMmZiMTA1MGYxOWRmOTI2N2NmZjE0MDVlNmYyYTdiNzZh
+    NTIyMjQ3NzNmZDRiYTE3YjI4NTg2NmM5NzJiNWFkODkxM2I1MWI=

data/README.md

@@ -8,42 +8,46 @@ Compendium is a reporting framework for Rails which makes it easy to create and
 
 A Compendium report is a subclass of `Compendium::Report`. Reports can be defined using the simple DSL:
 
-    class MyReport < Compendium::Report
-      # Options define which parameters your report will accept when being set up.
-      # An option is defined with a name, a type, and some settings (ie. default value, choices for radio buttons and
-      # dropdowns, etc.)
-      option :starting_on, :date, default: -> { Date.today - 1.month }
-      option :ending_on, :date, default: -> { Date.today }
-      option :currency, :radio, choices: [:USD, :CAD, :GBP]
-
-      # By default, queries are converted to SQL and executed instead of returning AR models
-      # The query definition block gets the report's current parameters
-      # totals: true means that the last row returned should be interpretted as a row of totals
-      query :deliveries, totals: true do |params|
-        Items.where(delivered: true, purchased_at: (params[:starting_on]..params[:ending_on]))
-      end
-
-      # Define a query which collects data by using AR directly
-      query :on_hand_inventory, collect: :active_record do |params|
-        Items.where(in_stock: true)
-      end
-
-      # Define a query that works on another query's result set
-      # Note: chart and data are aliases for query
-      chart :deliveries_over_time, through: :deliveries do |results|
-        results.group_by(&:purchased_at)
-      end
-
-      # Queries can also be used to drive metrics
-      metric :shipping_time, -> results { results.last['shipping_time'] }, through: :deliveries
-    end
+```ruby
+class MyReport < Compendium::Report
+  # Options define which parameters your report will accept when being set up.
+  # An option is defined with a name, a type, and some settings (ie. default value, choices for radio buttons and
+  # dropdowns, etc.)
+  option :starting_on, :date, default: -> { Date.today - 1.month }
+  option :ending_on, :date, default: -> { Date.today }
+  option :currency, :radio, choices: [:USD, :CAD, :GBP]
+
+  # By default, queries are converted to SQL and executed instead of returning AR models
+  # The query definition block gets the report's current parameters
+  # totals: true means that the last row returned should be interpretted as a row of totals
+  query :deliveries, totals: true do |params|
+    Items.where(delivered: true, purchased_at: (params[:starting_on]..params[:ending_on]))
+  end
+
+  # Define a query which collects data by using AR directly
+  query :on_hand_inventory, collect: :active_record do |params|
+    Items.where(in_stock: true)
+  end
+
+  # Define a query that works on another query's result set
+  # Note: chart and data are aliases for query
+  chart :deliveries_over_time, through: :deliveries do |results|
+    results.group_by(&:purchased_at)
+  end
+
+  # Queries can also be used to drive metrics
+  metric :shipping_time, -> results { results.last['shipping_time'] }, through: :deliveries
+end
+```
 
 Reports can then also be simply instantiated (which is done automatically if using the supplied
 `Compendium::ReportsController`):
 
-    report = MyReport.new(starting_on: '2013-06-01')
-    report.run(self) # The parameter is the context to run the report in; usually this should be
-                     # a controller context so that methods like current_user can be used
+```ruby
+report = MyReport.new(starting_on: '2013-06-01')
+report.run(self) # The parameter is the context to run the report in; usually this should be
+                 # a controller context so that methods like current_user can be used
+```
 
 Compendium also comes with a variety of different presenters, for rendering the setup page, and displaying charts
 (`report.render_chart`), tables (`report.render_table`) and metrics for your report. Charting is delegated through a
@@ -60,7 +64,9 @@ method (*NOTE:* you have to pass `local_assigns` into it if you want locals to b
 Routes are not automatically added to your application. In order to do so, you can use the `mount_compendium` helper
 within your `config/routes.rb` file
 
-    mount_compendium at: '/report', controller: 'reports' # controller defaults to compendium/reports
+```ruby
+mount_compendium at: '/report', controller: 'reports' # controller defaults to compendium/reports
+```
 
 ### Interaction with other gems
 * If [accessible_tooltip](https://github.com/dvandersluis/accessible_tooltip) is present, option notes will be rendered

data/app/classes/compendium/presenters/metric.rb

@@ -2,10 +2,19 @@ module Compendium::Presenters
   class Metric < Base
     presents :metric
 
-    delegate :name, :query, :ran?, to: :metric
+    delegate :name, :query, :description, :ran?, to: :metric
+
+    def initialize(template, object, options = {})
+      super(template, object)
+      @options = options
+    end
 
     def label
-      t("#{query}.#{name}")
+      @options[:label] || t("#{query}.#{name}")
+    end
+
+    def description
+      @options[:description]
     end
 
     def result(number_format = '%0.1f', display_nil_as = :na)
@@ -15,5 +24,9 @@ module Compendium::Presenters
         t(display_nil_as)
       end
     end
+
+    def render
+      @template.render 'compendium/reports/metric', metric: self
+    end
   end
 end

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

@@ -0,0 +1,5 @@
+.metric{ id: metric.label.parameterize }
+  .metric-label
+    = metric.label
+  .metric-data= metric.result
+  .metric-label-small= metric.description

data/lib/compendium/metric.rb

@@ -20,6 +20,10 @@ module Compendium
     end
     alias_method :has_ran?, :ran?
 
+    def render(template, *options, &block)
+      Compendium::Presenters::Metric.new(template, self, *options, &block).render
+    end
+
   private
 
     def condition_failed?(ctx)

data/lib/compendium/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compendium
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -119,6 +119,7 @@ files:
 - app/classes/compendium/presenters/table.rb
 - app/controllers/compendium/reports_controller.rb
 - app/helpers/compendium/reports_helper.rb
+- app/views/compendium/reports/_metric.haml
 - app/views/compendium/reports/run.haml
 - app/views/compendium/reports/setup.haml
 - compendium.gemspec