compendium 1.1.2 → 1.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjZkMmY3MmZhNjk4YzdjMmRkZTBiZDcyZjMwYjUyNjU2MDFmMjM1YQ==
+    OGFjMjNjNDU4NzgwOWE0MGQzNmVhNjMyMDRmMzJjZDQwNjNiMzY3Mw==
   data.tar.gz: !binary |-
-    N2IxZDJkYzJkNjJkMzYxMGU2OWYwOTQ0NjA2NzdlYmI4ODJjYjQwNw==
+    OTNhNjQ5NzIwYjc4NWFmYWJhNmMwN2M3ZjE3Y2M3NTRkMjExNDg0OA==
 SHA512:
   metadata.gz: !binary |-
-    MGVhNDY5ZTViNWJiYzJlMmM4NjY1MGNiNzcxYjNhMzdlODE2ZGYxN2U1ZjI5
-    YzkwMzg1OTkzMzUyYTc5MjdkYmUyNDFjNmVmNGZjOGFiOWZiZDY1YzNmNGIz
-    YzQ0MGM1NjA2YTcxMmVlMDUzOWI2ZmU2NGVlNTk1ZTYzOTZiZWU=
+    MjZiZDVkYmRiOTRkMjdmMGMxMGY0YTdkZjIzYWM4ZGNlMDYyOTAyMTBmODFj
+    ZGY1Y2UwZGM4YmNlNmNiYzk5NWYwMWJkOTNlMTNhYzhjMjFmYWE3MTZhM2E0
+    NWQ0ZWY3MDIzMzM4ZTkyMWY5NzQwMzJhZDNhMjUzZjMzNWNjNTM=
   data.tar.gz: !binary |-
-    YjQ2MjJmMTViNGU4NDZhYjU2ZDA4OTAwOGMzOGM1MjEyMzQ4NDBlZmJiMTcx
-    YzU4N2U2NzhmOTMzNDJiODgxYzQxYWQ2NzI0NjA0ZmIzM2U4ODEyMTZlOWZh
-    NDBkMzRiMGU2YTczNWE2YmQyNDIzMjExZDZlNDdjYzlkYmFjZjQ=
+    OTYxODI5ODBiNDIyNDBmZjg4MTAxYWI5YzNmNjJlNjk2ODEwMmY4ZDY0Njdj
+    NjIzNWVjMDhhM2EwMTA1ZTdmYzY4YTllZmYxMDgwNjM4NzcyZDZkYTA4NTAw
+    N2IxMmMwYmQwNTk1NzIzNGE2ZTM0Y2M0ZjU3NWQzMjUxN2E1NGI=

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Change Log
 
+## 1.1.2
+* Allow direct access to a chart object without having to render it (useful if the provider allows chart settings to be updated after initialization)
+* Delegate missing methods from ChartProvider classes to the chart
+
 ## 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).
+  grouped by day and then counted)
 * Added `ScalarParam` param type for collecting arbitrary data
 
 ## 1.1.0

data/lib/compendium.rb

@@ -15,6 +15,7 @@ module Compendium
   autoload :Query,                  'compendium/query'
   autoload :ResultSet,              'compendium/result_set'
   autoload :Report,                 'compendium/report'
+  autoload :SumQuery,               'compendium/sum_query'
   autoload :ThroughQuery,           'compendium/through_query'
 
   autoload :Param,                  'compendium/param_types'

data/lib/compendium/dsl.rb

@@ -101,6 +101,9 @@ module Compendium
         params.insert(1, through)
       elsif opts.fetch(:count, false)
         query_type = CountQuery
+      elsif opts.fetch(:sum, false)
+        query_type = SumQuery
+        params.insert(1, opts[:sum])
       end
 
       query = query_type.new(*params)

data/lib/compendium/query.rb

@@ -1,5 +1,6 @@
 require 'compendium/result_set'
 require 'compendium/params'
+require 'compendium/metric'
 require 'compendium/presenters/chart'
 require 'compendium/presenters/table'
 require 'collection_of'

data/lib/compendium/sum_query.rb

@@ -0,0 +1,26 @@
+require 'compendium/query'
+
+module Compendium
+  # A SumQuery is a Query which runs an SQL sum statement (with a given column)
+  # Often useful in conjunction with a grouped query and counter cache
+  # (alternately, see CountQuery)
+  class SumQuery < Query
+    InvalidCommand = Class.new(StandardError)
+
+    attr_accessor :column
+
+    def initialize(*args)
+      @report = args.shift if arg_is_report?(args.first)
+      @column = args.slice!(1)
+      super(*args)
+    end
+
+  private
+
+    def execute_command(command)
+      return [] if command.nil?
+      raise InvalidCommand unless command.respond_to?(:sum)
+      command.sum(column)
+    end
+  end
+end

data/lib/compendium/version.rb

@@ -1,3 +1,3 @@
 module Compendium
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/dsl_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'compendium'
 require 'compendium/dsl'
 
@@ -114,6 +115,23 @@ describe Compendium::DSL do
         it { should_not be_a Compendium::CountQuery }
       end
     end
+
+    context 'when given a sum option' do
+      subject{ report_class.queries[:summed] }
+
+      context 'set to a truthy value' do
+        before { report_class.query :summed, sum: :assoc_count }
+
+        it { should be_a Compendium::SumQuery }
+        its(:column) { should == :assoc_count }
+      end
+
+      context 'set to false' do
+        before { report_class.query :summed, sum: false }
+        it { should be_a Compendium::Query }
+        it { should_not be_a Compendium::SumQuery }
+      end
+    end
   end
 
   describe "#chart" do

data/spec/sum_query_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'compendium/sum_query'
+require 'compendium/report'
+
+class SingleSummer
+  def sum(col)
+    1792
+  end
+end
+
+class MultipleSummer
+  def sum(col)
+    { 1 => 123, 2 => 456, 3 => 789 }
+  end
+end
+
+describe Compendium::SumQuery do
+  subject { described_class.new(:counted_query, :col, { sum: :col }, -> * { @counter }) }
+
+  describe "#run" do
+    it "should call sum on the proc result" do
+      @counter = SingleSummer.new
+      @counter.should_receive(:sum).with(:col).and_return(1234)
+      subject.run(nil, self)
+    end
+
+    it "should return the sum" do
+      @counter = SingleSummer.new
+      subject.run(nil, self).should == [1792]
+    end
+
+    it "should return a hash if given" do
+      @counter = MultipleSummer.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 sum" do
+      @counter = Class.new
+      expect { subject.run(nil, self) }.to raise_error Compendium::SumQuery::InvalidCommand
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compendium
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -144,6 +144,7 @@ files:
 - lib/compendium/query.rb
 - lib/compendium/report.rb
 - lib/compendium/result_set.rb
+- lib/compendium/sum_query.rb
 - lib/compendium/through_query.rb
 - lib/compendium/version.rb
 - spec/collection_query_spec.rb
@@ -161,6 +162,7 @@ files:
 - spec/report_spec.rb
 - spec/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/sum_query_spec.rb
 - spec/through_query_spec.rb
 homepage: https://github.com/dvandersluis/compendium
 licenses:
@@ -202,5 +204,6 @@ test_files:
 - spec/report_spec.rb
 - spec/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/sum_query_spec.rb
 - spec/through_query_spec.rb
 has_rdoc: