compendium 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzRhZmU5NjE5ZTIzMGZmM2JmMzhlNDRhNjY3NTQ2ZjRjYzI0ZDkxNg==
+    ZGJkNWVkYjI2YzZhZDYxOWVlODRkYTRhZWEyMGZjZWE5M2JkNTQwMA==
   data.tar.gz: !binary |-
-    ODk2NGYxNjU1YzgzZTlkZmM5MmU1ZjljZjNlNjdkZGE1YTY0ZmY1Ng==
+    ODlmZmY3MWJmYzFkNzJkNWIzYWZkYWNhN2M5NGNkOWFmZGZlYjhkMQ==
 SHA512:
   metadata.gz: !binary |-
-    OThmYTFhNmQ2MWY0NTdmYmQxYzg2OTkzYzViNThmMTNjNzhhNDgzMjU4NmQ2
-    NjYyMThlMzQyMDY4NzU1YWY0MTdiNGIyYWFjNzdlMzgzMGMyZjY0MTk0MjU2
-    MzEyYTVjMGE1ZTQ2NTczN2YyOWM5ZTg1YTk1Mzg3ZjYxOTNjOGI=
+    NDE4YmNmMzkwZWY4ZTI4ZTliYjdjYTI5NWI1MmE4ZGM0NTBkYWQ3YzQxZWJi
+    ZjU2NmJhZWQzNmRlNDZjZjM5MWQ4ZjdiODdmMmY4YWEyYTc4ZmU1NmZhOTNh
+    YTkyMDA2OWZkODRjZDExYjhhN2FkOGE1Y2Y5MDM2MmFkODlmN2U=
   data.tar.gz: !binary |-
-    Y2M1NzdhOGQzMWVhZjNmNGVlZTVlY2JiOWQzZTFlZTkzZGY4ZjE5YjdiMWVi
-    ZGU2MzY3ZTU4ZTFiNzU4MDQxNTA5ZjBlZTlmY2YyNGIyM2ZlZWQ3MzNhYzMz
-    ZjExMWFhOWZhZTIwOGQwZjJlOGQ2ZGE1OTFhYjAxOTA2MzEwMGE=
+    YzYwMWVkNzIzNzdhZDA0NDUyMTYyMTZiMjA2YWJmYTU2NzY0OTNjNGUzYWM5
+    ZDU0YTUwNDgxNDgyNTVkMzI2ODFhMzdmMDM5MGQzNDcwNzBmMDgwYzM4OTc0
+    NWVlNzY2N2I3ZGQ1NWViMGEwMzZkNjhlNTFmZTIwOWFhMjViMzM=

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Change Log
 
-## 1.1.0 (unreleased)
+## 1.1.1
+* Fix crash regressions in Rails 3
+* Added `CountQuery` query type which calls count on the result of the given block (for instance a query which is
+  grouped by day and then counted).
+* Added `ScalarParam` param type for collecting arbitrary data
+
+## 1.1.0
 * Added query filters (allow a result set to be filtered to remove/translate/etc. data)
 * Extract chart providers into their own gems
-* Allow queries to be rendered as charts without having been run yet (to set up for a future AJAX load)
+* Queries can now be rendered with a remote data source
 * Added `Report#url` and `Query#url` methods to get the JSON URL
 
 ## 1.0.7
@@ -15,4 +21,4 @@
 ## 1.0.5
 * Fixed the `:only` and `:except` options to `Report#run`
 * Give `ThroughQuery` access to params if the definition block has an arity of 2
-* Fixed mutating results in a `ThroughQuery` block affecting the parent query
+* Fixed mutating results in a `ThroughQuery` block affecting the parent query

data/README.md

@@ -86,11 +86,24 @@ as JSON. If using the default routes provided by `mount_compendium` (assuming co
 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>.
 
+### Chart Providers
+
+As of 1.1.0, chart providers have been extracted out of the main repository and are available as their own gems. If you want to render queries as a chart, a chart provider gem is needed.
+
+If multiple chart providers are installed, you can select the one you wish you use with the following initializer:
+
+```ruby
+Compendium.configure do |config|
+  config.chart_provider = :AmCharts # or any other provider name
+end
+```
+
+The following providers are available (If you would like to contribute a chart provider, please let me know and I'll add it to the list):
+* [compendium-amcharts](https://github.com/dvandersluis/compendium-amcharts) - makes use of [AmCharts.rb](https://github.com/dvandersluis/amcharts.rb)
+
 ### 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.
-* [AmCharts.rb](https://github.com/dvandersluis/amcharts.rb) is currently the only chart provider (please create a pull
-request if you'd like to create another one...)
 
 ## Installation
 

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

@@ -62,7 +62,7 @@ module Compendium::Presenters
     end
 
     def protected_against_csrf?
-      !@template.controller.forgery_protection_strategy.nil?
+      @template.controller.send(:protect_against_forgery?)
     end
 
     def form_authenticity_param

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

@@ -46,6 +46,9 @@ module Compendium::Presenters
       out = ActiveSupport::SafeBuffer.new
 
       case option.type.to_sym
+        when :scalar
+          out << scalar_field(form)
+
         when :date
           out << date_field(form)
 
@@ -82,6 +85,12 @@ module Compendium::Presenters
       end
     end
 
+    def scalar_field(form)
+      content_tag('div', class: 'option-scalar') do
+        form.text_field option.name
+      end
+    end
+
     def dropdown(form, choices = {}, options = {})
       content_tag('div', class: 'option-dropdown') do
         form.select option.name, choices, options.symbolize_keys

data/lib/compendium.rb

@@ -7,6 +7,7 @@ module Compendium
   autoload :ChartProvider,          'compendium/abstract_chart_provider'
   autoload :CollectionQuery,        'compendium/collection_query'
   autoload :ContextWrapper,         'compendium/context_wrapper'
+  autoload :CountQuery,             'compendium/count_query'
   autoload :DSL,                    'compendium/dsl'
   autoload :Metric,                 'compendium/metric'
   autoload :Option,                 'compendium/option'
@@ -22,6 +23,7 @@ module Compendium
   autoload :DropdownParam,          'compendium/param_types'
   autoload :ParamWithChoices,       'compendium/param_types'
   autoload :RadioParam,             'compendium/param_types'
+  autoload :ScalarParam,            'compendium/param_types'
 
   def self.reports
     @reports ||= []

data/lib/compendium/count_query.rb

@@ -0,0 +1,17 @@
+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)
+
+  private
+
+    def execute_command(command)
+      return [] if command.nil?
+      raise InvalidCommand unless command.respond_to?(:count)
+      command.count
+    end
+  end
+end

data/lib/compendium/dsl.rb

@@ -99,6 +99,8 @@ module Compendium
 
         query_type = ThroughQuery
         params.insert(1, through)
+      elsif opts.fetch(:count, false)
+        query_type = CountQuery
       end
 
       query = query_type.new(*params)

data/lib/compendium/option.rb

@@ -7,7 +7,7 @@ module Compendium
   class Option
     attr_accessor :name, :type, :default, :choices, :options
 
-    delegate :boolean?, :date?, :dropdown?, :radio?, :text?, to: :type
+    delegate :boolean?, :date?, :dropdown?, :radio?, :scalar?, to: :type
     delegate :merge, :merge!, :[], to: :@options
 
     def initialize(hash = {})

data/lib/compendium/param_types.rb

@@ -3,6 +3,7 @@ require 'delegate'
 
 module Compendium
   class Param < ::SimpleDelegator
+    def scalar?; false; end
     def boolean?; false; end
     def date?; false; end
     def dropdown?; false; end
@@ -40,6 +41,17 @@ module Compendium
     end
   end
 
+  class ScalarParam < Param
+    def initialize(obj, *)
+      super obj
+    end
+
+    # A scalar param just keeps track of a value with no modifications
+    def scalar?
+      true
+    end
+  end
+
   class BooleanParam < Param
     def initialize(obj, *)
       # If given 0, 1, or a version thereof (ie. "0"), pass it along

data/lib/compendium/report.rb

@@ -11,7 +11,7 @@ module Compendium
     extend Compendium::DSL
 
     delegate :valid?, :errors, to: :params
-    delegate :name, :url, to: :class
+    delegate :report_name, :url, to: 'self.class'
 
     class << self
       def inherited(report)
@@ -28,8 +28,8 @@ module Compendium
         }
       end
 
-      def name
-        super.underscore.gsub(/_report$/,'').to_sym
+      def report_name
+        name.underscore.gsub(/_report$/,'').to_sym
       end
 
       # Get a URL for this report (format: :json set by default)
@@ -59,11 +59,13 @@ module Compendium
     private
 
       def path_helper(params)
-        unless Rails.application.routes.url_helpers.method_defined? :compendium_reports_run_path
-          raise ActionController::RoutingError, "compendium_reports_run_path must be defined"
-        end
+        raise ActionController::RoutingError, "compendium_reports_run_path must be defined" unless route_helper_defined?
+        Rails.application.routes.url_helpers.compendium_reports_run_path(self.report_name, params.reverse_merge(format: :json))
+      end
 
-        Rails.application.routes.url_helpers.compendium_reports_run_path(self.name, params.reverse_merge(format: :json))
+      def route_helper_defined?
+        @route_helpers ||= Module.new { include Rails.application.routes.url_helpers }
+        @route_helpers.method_defined?(:compendium_reports_run_path)
       end
     end
 

data/lib/compendium/version.rb

@@ -1,3 +1,3 @@
 module Compendium
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/count_query_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'compendium/count_query'
+
+class SingleCounter
+  def count
+    1792
+  end
+end
+
+class MultipleCounter
+  def count
+    { 1 => 123, 2 => 456, 3 => 789 }
+  end
+end
+
+describe Compendium::CountQuery do
+  subject { described_class.new(:counted_query, { count: true }, -> * { @counter }) }
+
+  describe "#run" do
+    it "should call count on the proc result" do
+      @counter = SingleCounter.new
+      @counter.should_receive(:count).and_return(1234)
+      subject.run(nil, self)
+    end
+
+    it "should return the count" do
+      @counter = SingleCounter.new
+      subject.run(nil, self).should == [1792]
+    end
+
+    it "should return a hash if given" do
+      @counter = MultipleCounter.new
+      subject.run(nil, self).should == { 1 => 123, 2 => 456, 3 => 789 }
+    end
+
+    it "should raise an error if the proc does not respond to count" do
+      @counter = Class.new
+      expect { subject.run(nil, self) }.to raise_error Compendium::CountQuery::InvalidCommand
+    end
+  end
+end

data/spec/dsl_spec.rb

@@ -99,6 +99,21 @@ describe Compendium::DSL do
         its(:collection) { should == query }
       end
     end
+
+    context "when given a count option" do
+      subject{ report_class.queries[:counted] }
+
+      context "set to true" do
+        before { report_class.query :counted, count: true }
+        it { should be_a Compendium::CountQuery }
+      end
+
+      context "set to false" do
+        before { report_class.query :counted, count: false }
+        it { should be_a Compendium::Query }
+        it { should_not be_a Compendium::CountQuery }
+      end
+    end
   end
 
   describe "#chart" do

data/spec/param_types_spec.rb

@@ -3,6 +3,7 @@ require 'compendium/param_types'
 describe Compendium::Param do
   subject{ described_class.new(:test) }
 
+  it { should_not be_scalar }
   it { should_not be_boolean }
   it { should_not be_date }
   it { should_not be_dropdown }
@@ -16,6 +17,20 @@ describe Compendium::Param do
   end
 end
 
+describe Compendium::ScalarParam do
+  subject{ described_class.new(123) }
+
+  it { should be_scalar }
+  it { should_not be_boolean }
+  it { should_not be_date }
+  it { should_not be_dropdown }
+  it { should_not be_radio }
+
+  it "should not change values" do
+    subject.should == 123
+  end
+end
+
 describe Compendium::ParamWithChoices do
   subject{ described_class.new(0, %w(a b c)) }
 
@@ -58,6 +73,7 @@ end
 describe Compendium::BooleanParam do
   subject{ described_class.new(true) }
 
+  it { should_not be_scalar }
   it { should be_boolean }
   it { should_not be_date }
   it { should_not be_dropdown }
@@ -111,6 +127,7 @@ end
 describe Compendium::DateParam do
   subject{ described_class.new(Date.today) }
 
+  it { should_not be_scalar }
   it { should_not be_boolean }
   it { should be_date }
   it { should_not be_dropdown }
@@ -131,6 +148,7 @@ end
 describe Compendium::DropdownParam do
   subject{ described_class.new(0, %w(a b c)) }
 
+  it { should_not be_scalar }
   it { should_not be_boolean }
   it { should_not be_date }
   it { should be_dropdown }
@@ -140,6 +158,7 @@ end
 describe Compendium::RadioParam do
   subject{ described_class.new(0, %w(a b c)) }
 
+  it { should_not be_scalar }
   it { should_not be_boolean }
   it { should_not be_date }
   it { should_not be_dropdown }

data/spec/presenters/chart_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'compendium/presenters/chart'
 
 describe Compendium::Presenters::Chart do
-  let(:template) { double('Template', forgery_protection_strategy: nil, request_forgery_protection_token: :authenticity_token, form_authenticity_token: "ABCDEFGHIJ").as_null_object }
+  let(:template) { double('Template', protect_against_forgery?: false, request_forgery_protection_token: :authenticity_token, form_authenticity_token: "ABCDEFGHIJ").as_null_object }
   let(:query) { double('Query', name: 'test_query', results: results, ran?: true, options: {}).as_null_object }
   let(:results) { Compendium::ResultSet.new([]) }
 
@@ -43,7 +43,7 @@ describe Compendium::Presenters::Chart do
       its(:params) { should == { report: { foo: 'bar' } } }
 
       context "when CSRF protection is enabled" do
-        before { template.stub(forgery_protection_strategy: double('CSRF')) }
+        before { template.stub(protect_against_forgery?: true) }
 
         its(:params) { should include authenticity_token: "ABCDEFGHIJ" }
       end

data/spec/report_spec.rb

@@ -28,9 +28,9 @@ describe Compendium::Report do
     its(:metrics) { should_not equal report2.metrics }
   end
 
-  describe ".name" do
+  describe ".report_name" do
     subject { TestReport = Class.new(described_class) }
-    its(:name) { should == :test }
+    its(:report_name) { should == :test }
   end
 
   describe "#run" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compendium
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -132,6 +132,7 @@ files:
 - lib/compendium/abstract_chart_provider.rb
 - lib/compendium/collection_query.rb
 - lib/compendium/context_wrapper.rb
+- lib/compendium/count_query.rb
 - lib/compendium/dsl.rb
 - lib/compendium/engine.rb
 - lib/compendium/engine/mount.rb
@@ -147,6 +148,7 @@ files:
 - lib/compendium/version.rb
 - spec/collection_query_spec.rb
 - spec/context_wrapper_spec.rb
+- spec/count_query_spec.rb
 - spec/dsl_spec.rb
 - spec/metric_spec.rb
 - spec/option_spec.rb
@@ -187,6 +189,7 @@ summary: Ruby on Rails reporting framework
 test_files:
 - spec/collection_query_spec.rb
 - spec/context_wrapper_spec.rb
+- spec/count_query_spec.rb
 - spec/dsl_spec.rb
 - spec/metric_spec.rb
 - spec/option_spec.rb