compendium 1.0.1 → 1.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2ExNjQ1Y2U2ZjhiZTQ4ZDg4NjI1MmU5NmYxODFmNDYzMDI2MzI0Yw==
+    Y2M5ZWFmZjNlN2Q0YWQ0MGQ4ZTQ0Njg3ZDIzN2VjMTI4NzZlOTJlYw==
   data.tar.gz: !binary |-
-    OTFhMGQ1Y2U0ZGE5YzM4YWQ0NDg3ODlmZDgwYjU3YmFiYjY0MmNjNA==
+    ZjFkNjcwNmU2YTRlOTNhZTdiZjYyYmU0MzA1MDEzZGJhMjdmOGQ3MQ==
 SHA512:
   metadata.gz: !binary |-
-    YzExMTE2ZjI3ZmZiZGM0OTgyMjQ5NWRmN2I4M2U3YTU1ZTI5OTlkZDhlZGJk
-    Y2Y5YTRmYWI2ZGRlM2JiYTY1MWIxNGNlZDMwZDNmMGRlNGZmZmU5MjNjNjU3
-    OGJkYTQ3MWRmMzQxZWEyNGY2NTcwMTZjNDhlYzgwNzJmN2UwMzc=
+    NjlmNzliZjA5MjU3N2E4Mzk2NzZkOWM0M2JmM2YzYzk1YWNjNDQ1MjgyZTc3
+    MGFkNzM5ODc4YzI1NGUyMzM1ZDliMWE1ZDY5NmQ2YTQzMjFkNjgzOGNiMzQy
+    ZGM3NWI5OTA5YjlhMGY0YzMwMjYwNzYzNjJiYjQ5ODE1MDY0NTM=
   data.tar.gz: !binary |-
-    NGNmMWQ3YzllM2E2MDBjZTY3MWI3YTEzZTY3NGRkNDA5MzdjNzk5Y2U5MjRm
-    MWM2OWZiZGJjZjljNjc1NWIzYTcxODBmMDk2NWRkNTc1NmM5NmJmZmVhMzEx
-    YzQyNDE0Nzk2MWNjM2U0MzY4NjdjZjdlOTgyYWE3NmU2Y2VmNDI=
+    ODAwYmEwOTJhMmViNTczMTQ4ZGNmYTY0ZGZmZjNjZTZkYjJjMTAwNzNiYjgx
+    ZmEyOTA0MDRjNmFkMWNiMWM5NzQ3ZTYyYzkzMDlmYzY4ZTk0YTczOTgyZTgy
+    MTc3ODZmYjU4NGY1MDA4NGJmMjVmNDgyNjIzOTE5YzcyY2Y4NzA=

data/app/assets/stylesheets/compendium/_metrics.css.scss

@@ -4,7 +4,7 @@ div.metrics
 {
   div.metric
   {
-    float: left;
+    display: inline-block;
     margin: 10px;
     padding: 5px;
     border: 2px solid #575757;

data/compendium.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rails', '>= 3.0.0'
   gem.add_dependency 'sass-rails', '>= 3.0.0'
   gem.add_dependency 'compass-rails', '>= 1.0.0'
-  gem.add_dependency 'collection_of', '>= 1.0.3'
+  gem.add_dependency 'collection_of', '1.0.4'
   gem.add_dependency 'inheritable_attr', '>= 1.0.0'
   gem.add_development_dependency 'rspec', '~> 2.0'
 end

data/config/initializers/ruby/hash.rb

@@ -0,0 +1,6 @@
+class Hash
+  # Remove nil values
+  def compact
+    delete_if{ |_, v| v.blank? }
+  end unless method_defined?(:compact)
+end

data/lib/compendium/dsl.rb

@@ -22,6 +22,7 @@ module Compendium
 
       if options[name]
         options[name].type = type if type
+        options[name].default = opts.delete(:default) if opts.key?(:default)
         options[name].merge!(opts)
       else
         options[name] = Compendium::Option.new(opts.merge(name: name, type: type))

data/lib/compendium/option.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/module/delegation'
 
 module Compendium
   class Option
-    attr_reader :name, :type, :default, :choices, :options
+    attr_accessor :name, :type, :default, :choices, :options
 
     delegate :boolean?, :date?, :dropdown?, :radio?, :text?, to: :type
     delegate :merge, :merge!, :[], to: :@options

data/lib/compendium/query.rb

@@ -1,16 +1,19 @@
 require 'compendium/result_set'
 require 'compendium/params'
 require 'collection_of'
+require_relative '../../config/initializers/ruby/hash'
 
 module Compendium
   class Query
     attr_reader :name, :results, :metrics
     attr_accessor :options, :proc, :through, :report
 
-    def initialize(name, options, proc)
-      @name = name
-      @options = options
-      @proc = proc
+    def initialize(*args)
+      @report = args.shift if arg_is_report?(args.first)
+
+      raise ArgumentError, "wrong number of arguments (#{args.size + (@report ? 1 : 0)} for 3..4)" unless args.size == 3
+
+      @name, @options, @proc = args
       @metrics = ::Collection[Metric]
     end
 
@@ -50,10 +53,14 @@ module Compendium
   private
 
     def collect_results(params, context)
-      args = if through.nil?
-        params
+      if through.nil?
+        args = params
       else
-        collect_through_query_results(through, params, context)
+        args = collect_through_query_results(through, params, context)
+
+        # If none of the through queries have any results, we shouldn't try to execute the query, because it
+        # depends on the results of its parents.
+        return @results = ResultSet.new([]) if args.compact.empty?
       end
 
       command = context.instance_exec(args, &proc) if proc
@@ -69,10 +76,20 @@ module Compendium
       if options.key?(:through) or options.fetch(:collect, nil) == :active_record
         command
       else
-        ::ActiveRecord::Base.connection.select_all(command.respond_to?(:to_sql) ? command.to_sql : command)
+        execute_command(command)
       end
     end
 
+    def execute_command(command)
+      return [] if command.nil?
+      command = command.to_sql if command.respond_to?(:to_sql)
+      execute_query(command)
+    end
+
+    def execute_query(command)
+      ::ActiveRecord::Base.connection.select_all(command)
+    end
+
     def collect_through_query_results(through, params, context)
       results = {}
 
@@ -90,5 +107,9 @@ module Compendium
     def get_through_query(name)
       report.queries[name]
     end
+
+    def arg_is_report?(arg)
+      arg.is_a?(Report) or (arg.is_a?(Class) and arg < Report)
+    end
   end
 end

data/lib/compendium/report.rb

@@ -19,11 +19,25 @@ module Compendium
       queries.each { |q| q.report = self }
     end
 
-    def run(context = nil)
+    def run(context = nil, options = {})
       self.context = context
       self.results = {}
 
-      queries.each{ |q| self.results[q.name] = q.run(params, ContextWrapper.wrap(context, self)) }
+      only = options.delete(:only)
+      except = options.delete(:except)
+
+      raise ArgumentError, 'cannot specify only and except options at the same time' if only && except
+      ([only] + [except]).flatten.compact.each { |q| raise ArgumentError, 'invalid query #{q}' unless queries.include?(q) }
+
+      queries_to_run = if only
+        queries.slice(only)
+      elsif except
+        queries.except(except)
+      else
+        queries
+      end
+
+      queries_to_run.each{ |q| self.results[q.name] = q.run(params, ContextWrapper.wrap(context, self)) }
 
       self
     end

data/lib/compendium/version.rb

@@ -1,3 +1,3 @@
 module Compendium
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/dsl_spec.rb

@@ -19,6 +19,12 @@ describe Compendium::DSL do
       subject.options[:starting_on].should be_boolean
       subject.options[:starting_on].should_not be_date
     end
+
+    it "should allow overriding default value" do
+      proc = -> { Date.new(2013, 6, 1) }
+      subject.option :starting_on, :date, default: proc
+      subject.options[:starting_on].default.should == proc
+    end
   end
 
   describe "#query" do

data/spec/query_spec.rb

@@ -1,6 +1,30 @@
 require 'compendium/query'
 
 describe Compendium::Query do
+  describe "#initialize" do
+    let(:options) { double("Options") }
+    let(:proc) { double("Proc") }
+
+    context "when supplying a report" do
+      let(:r) { Compendium::Report.new }
+      subject { described_class.new(r, :test, options, proc)}
+
+      its(:report) { should == r }
+      its(:name) { should == :test }
+      its(:options) { should == options }
+      its(:proc) { should == proc }
+    end
+
+    context "when not supplying a report" do
+      subject { described_class.new(:test, options, proc)}
+
+      its(:report) { should be_nil }
+      its(:name) { should == :test }
+      its(:options) { should == options }
+      its(:proc) { should == proc }
+    end
+  end
+
   describe "#run" do
     let(:query) { described_class.new(:test, {}, -> * { [1, 2, 3] }) }
     before { query.stub(:fetch_results) { |c| c } }
@@ -19,6 +43,46 @@ describe Compendium::Query do
       query.run(nil)
       q2.should_not have_run
     end
+
+    it "should return an empty result set if running an query with no proc" do
+      query = described_class.new(:blank, {}, nil)
+      query.run(nil).should be_empty
+    end
+
+    context 'through queries' do
+      let(:parent_query1) { described_class.new(:parent1, {}, -> * { }) }
+      let(:parent_query2) { described_class.new(:parent2, {}, -> * { }) }
+      let(:parent_query3) { described_class.new(:parent3, {}, -> * { [[1, 2, 3]] }) }
+
+      subject { described_class.new(:sub, {}, -> records { records.first }) }
+
+      before do
+        subject.stub(:get_through_query).with(:parent1).and_return(parent_query1)
+        subject.stub(:get_through_query).with(:parent2).and_return(parent_query2)
+        subject.stub(:get_through_query).with(:parent3).and_return(parent_query3)
+        described_class.any_instance.stub(:execute_query) { |cmd| cmd }
+      end
+
+      it "should not try to run a through query if the parent query has no results" do
+        subject.through = :parent1
+
+        expect { subject.run(nil) }.to_not raise_error
+        subject.results.should be_empty
+      end
+
+      it "should not try to run a through query with multiple parents all of which have no results" do
+        subject.through = [:parent1, :parent2]
+
+        expect { subject.run(nil) }.to_not raise_error
+        subject.results.should be_empty
+      end
+
+      it "should allow non blank queries" do
+        subject.through = :parent3
+        subject.run(nil)
+        subject.results.should == [1, 2, 3]
+      end
+    end
   end
 
   describe "#nil?" do

data/spec/report_spec.rb

@@ -29,64 +29,103 @@ describe Compendium::Report do
   end
 
   describe "#run" do
-    let(:report_class) do
-      Class.new(Compendium::Report) do
-        option :first, :date
-        option :second, :date
+    context do
+      let(:report_class) do
+        Class.new(Compendium::Report) do
+          option :first, :date
+          option :second, :date
 
-        query :test do |params|
-          [params[:first].__getobj__, params[:second].__getobj__]
+          query :test do |params|
+            [params[:first].__getobj__, params[:second].__getobj__]
+          end
+
+          metric :test_metric, -> results { results.to_a.max }, through: :test
         end
+      end
+
+      subject { report_class.new(first: '2010-10-10', second: '2011-11-11') }
+      let!(:report2) { report_class.new }
 
-        metric :test_metric, -> results { results.to_a.max }, through: :test
+      before do
+        Compendium::Query.any_instance.stub(:fetch_results) { |c| c }
+        subject.run
       end
-    end
 
-    subject { report_class.new(first: '2010-10-10', second: '2011-11-11') }
-    let!(:report2) { report_class.new }
+      its('test_results.records') { should == [Date.new(2010, 10, 10), Date.new(2011, 11, 11)] }
 
-    before do
-      Compendium::Query.any_instance.stub(:fetch_results) { |c| c }
-      subject.run
-    end
+      it "should run its metrics" do
+        subject.test.metrics[:test_metric].result.should == Date.new(2011, 11, 11)
+        subject.metrics[:test_metric].result.should == Date.new(2011, 11, 11)
+      end
 
-    its('test_results.records') { should == [Date.new(2010, 10, 10), Date.new(2011, 11, 11)] }
+      it "should not affect other instances of the report class" do
+        report2.test.results.should be_nil
+        report2.metrics[:test_metric].result.should be_nil
+      end
 
-    it "should run its metrics" do
-      subject.test.metrics[:test_metric].result.should == Date.new(2011, 11, 11)
-      subject.metrics[:test_metric].result.should == Date.new(2011, 11, 11)
-    end
+      it "should not affect the class collections" do
+        report_class.test.results.should be_nil
+      end
 
-    it "should not affect other instances of the report class" do
-      report2.test.results.should be_nil
-      report2.metrics[:test_metric].result.should be_nil
-    end
+      context "with through queries" do
+        let(:report_class) do
+          Class.new(Compendium::Report) do
+            option :first, :boolean, default: false
+            query(:test) { |params| !!params[:first] ? [100, 200, 400, 800] : [1600, 3200, 6400]}
+            query(:through, through: :test) { |results| [results.first] }
+          end
+        end
+
+        subject { report_class.new(first: true) }
+
+        its('through.results') { should == [100] }
 
-    it "should not affect the class collections" do
-      report_class.test.results.should be_nil
+        it "should not mark other instances' queries as ran" do
+          report2.test.should_not have_run
+        end
+
+        it "should not affect other instances" do
+          report2.queries.each { |q| q.stub(:fetch_results) { |c| c } }
+          report2.run
+          report2.through.results.should == [1600]
+        end
+      end
     end
 
-    context "with through queries" do
+    context "when specifying which queries to run" do
       let(:report_class) do
         Class.new(Compendium::Report) do
-          option :first, :boolean, default: false
-          query(:test) { |params| !!params[:first] ? [100, 200, 400, 800] : [1600, 3200, 6400]}
-          query(:through, through: :test) { |results| [results.first] }
+          query :first
+          query :second
         end
       end
 
-      subject { report_class.new(first: true) }
+      subject { report_class.new }
+
+      it "should raise an error if given :only and :except options" do
+        expect{ subject.run(nil, only: :first, except: :second) }.to raise_error(ArgumentError)
+      end
+
+      it "should raise an error if given an invalid query name" do
+        expect{ subject.run(nil, only: :foo) }.to raise_error(ArgumentError)
+      end
 
-      its('through.results') { should == [100] }
+      it "should run all queries if nothing is specified" do
+        subject.run(nil)
+        subject.first.should have_run
+        subject.second.should have_run
+      end
 
-      it "should not mark other instances' queries as ran" do
-        report2.test.should_not have_run
+      it "should only run queries specified by :only" do
+        subject.run(nil, only: :first)
+        subject.first.should have_run
+        subject.second.should_not have_run
       end
 
-      it "should not affect other instances" do
-        report2.queries.each { |q| q.stub(:fetch_results) { |c| c } }
-        report2.run
-        report2.through.results.should == [1600]
+      it "should not run queries specified by :except" do
+        subject.run(nil, except: :first)
+        subject.first.should_not have_run
+        subject.second.should have_run
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compendium
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -58,14 +58,14 @@ dependencies:
   name: collection_of
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.4
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   type: :runtime
   prerelease: false
@@ -123,6 +123,7 @@ files:
 - app/views/compendium/reports/setup.haml
 - compendium.gemspec
 - config/initializers/rails/active_record/connection_adapters/quoting.rb
+- config/initializers/ruby/hash.rb
 - config/initializers/ruby/numeric.rb
 - config/locales/en.yml
 - lib/compendium.rb