kpi 0.5.4 → 0.5.5

data/app/models/kpi/merged_report.rb

@@ -1,12 +1,13 @@
 module KPI
   class MergedReport
+    
     def initialize(*args, &block)
+      options = args.extract_options!
       raise ArgumentError, "Should have any argument" if args.length == 0
       raise Exception unless block_given?
-      raise ArgumentError, "Argument must be the same type" unless args.map(&:class).uniq.size == 1
-
-      @reports ||= args
-      @compare = block
+      @_mode = options[:mode] || :&
+      @_reports = args
+      @_merge = block
     end
     
     def entries
@@ -22,18 +23,40 @@ module KPI
     end
     
     def defined_kpis
-      @reports.map(&:defined_kpis).inject(&:&)
+      # takes all reports and uses & (default) or | operator for inject function
+      # to build list of defined KPIs
+      @_reports.map(&:defined_kpis).inject(&@_mode).map(&:to_sym)
     end
 
     def method_missing(name, *args)
-      result = @compare.call(*@reports.map(&name.to_sym))
-      orginal = @reports.first.send(name.to_sym)
-      description = (orginal.description && result.description ? result.description.gsub("$$", orginal.description) : nil)
+      return kpi_exists?($1) if (/(.*)\?/ =~ name.to_s)                  # check if KPI exists in report if name of missing method has trailing '?'
+      result = merge_proc_call(name)                                     
+      orginal = @_reports.find(&:"#{name}?").send(name)                  # find first report having requested KPI
+      description = if orginal.description && result.description         # if description exists in orginal and result Entries
+                      result.description.gsub("$$", orginal.description)
+                    else nil
+                    end
 
       KPI::Entry.new(result.name.gsub("$$", orginal.name),
                      result.value,
                      :description => description,
                      :unit => (result.unit || orginal.unit))
     end
+    
+    private
+
+    def kpi_exists?(name)    
+      self.defined_kpis.include?(name.to_sym)
+    end
+
+    def merge_proc_call(name)
+      sym_name = name.to_sym
+      args = @_mode == :& ? @_reports.map(&sym_name) : begin # if report is in intersection mode, query for an KPI, otherwise
+        @_reports.map do |report|                            #   for each report
+          report.send("#{name}?") ? report.send(name) : nil  #     if it has requested kpi return it's result, otherwise: nil
+        end
+      end
+      @_merge.call(*args)                                    # call merge proc with according KPIs
+    end
   end
 end

data/app/models/kpi/report.rb

@@ -5,7 +5,7 @@ module KPI
  
     include KPI::Report::DynamicDefinitions
     
-    blacklist :initialize, :collect!, :entries, :time, :title, :defined_kpis, :result
+    blacklist :initialize, :collect!, :entries, :time, :title, :defined_kpis, :result, :method_missing
  
     def initialize(*args)
       @options = args.extract_options!
@@ -31,11 +31,23 @@ module KPI
     end
  
     def defined_kpis
-      self.class.defined_kpis
+      self.class.defined_kpis.map(&:to_sym)
     end
-    
+
     def result(*args)
       KPI::Entry.new *args
     end
+    
+    def method_missing(name, *args)
+      # check if KPI exists in report if name of missing method has trailing '?'
+      return kpi_exists?($1.to_sym) if (/(.*)\?/ =~ name.to_s)
+      super
+    end
+    
+    private
+    
+    def kpi_exists?(name)    
+      self.defined_kpis.include?(name.to_sym)
+    end
   end
-end
+end

data/test/unit/kpi/merged_report_test.rb

@@ -18,6 +18,13 @@ describe "KPI::MergedReport" do
       end
     end
     class AnotherReport < KPI::Report
+      def test_kpi
+        result "title", 3, :description => "description"
+      end
+
+      def another_kpi
+        result "another", 5
+      end
     end
   end
 
@@ -39,10 +46,8 @@ describe "KPI::MergedReport" do
       end
     end
 
-    it "should require objects of the same type when initializing" do
-      assert_raises(ArgumentError) do
-        KPI::MergedReport.new(TestKpi.new, AnotherReport.new) {}
-      end
+    it "should allow objects of the same type when initializing" do
+      KPI::MergedReport.new(TestKpi.new, AnotherReport.new) {}
     end
 
     it "should require block when initializing" do
@@ -52,7 +57,7 @@ describe "KPI::MergedReport" do
     end
   end
 
-  describe "when two reports given for average" do
+  describe "when two identical reports given for average" do
     before do
       @report1 = TestKpi.new(2)
       @report2 = TestKpi.new(8)
@@ -113,6 +118,62 @@ describe "KPI::MergedReport" do
       it "should return KPIs defined by all compounds" do
         assert_equal TestKpi.defined_kpis, @average.defined_kpis
       end
+
+      it "should check if defined_kpis return array of symbol" do
+        assert_same true, @average.defined_kpis.map(&:class).uniq === [Symbol]
+      end
+
+      it "should return true when calling test_kpi?" do
+        assert @average.test_kpi?
+      end
+      
+      it "should return false when calling non existing method with '?'" do
+        assert !@average.test_kpi_23?
+      end
+    end
+  end
+
+  describe "when different reports given for merge" do
+    before do
+      @report1 = TestKpi.new(2)
+      @report2 = AnotherReport.new
+    end
+
+    describe "when intersection" do
+      before do
+        @merge = KPI::MergedReport.new(@report1, @report2) do |test, another|
+          KPI::Entry.new "$$", {:test => test, :another => another}, :description => '$$'
+        end
+      end
+
+      it "should have only common KPI defined" do
+        assert_equal [:test_kpi], @merge.defined_kpis
+      end
+
+      it "should not repospond for not common KPI" do
+        assert_raises(NoMethodError) { @merge.another_kpi }
+      end
+
+      it "should return values for common KPI" do
+        assert_instance_of Hash, @merge.test_kpi.value
+      end
+    end
+    
+    describe "when conjunction" do
+      before do
+        @merge = KPI::MergedReport.new(@report1, @report2, :mode => :|) do |test, another|
+          merge = {:test => test.try(:value), :another => another.try(:value)}
+          KPI::Entry.new "$$", merge, :description => '$$'
+        end
+      end
+    
+      it "should have all KPI of both reports" do
+        assert_equal [:test_kpi, :test_kpi_2, :another_kpi], @merge.defined_kpis
+      end
+    
+      it "should return KPI" do
+        assert_equal({:test => nil, :another => 5}, @merge.another_kpi.value)
+      end
     end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: kpi
 version: !ruby/object:Gem::Version 
-  hash: 3
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 4
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -15,98 +10,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 +02:00
+date: 2011-05-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
         version: "2.3"
-  prerelease: false
   type: :runtime
-  requirement: *id001
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
         version: "2.3"
-  prerelease: false
   type: :runtime
-  requirement: *id002
+  prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: minitest
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  prerelease: false
   type: :development
-  requirement: *id003
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
         version: "1.0"
-  prerelease: false
   type: :development
-  requirement: *id004
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
         version: 1.5.2
-  prerelease: false
   type: :development
-  requirement: *id005
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  prerelease: false
   type: :development
-  requirement: *id006
+  prerelease: false
+  version_requirements: *id006
 description: This gem helps you to track key indicators in your Rails app.
 email: artur.roszczyk@gmail.com
 executables: []
@@ -148,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -4102410912308546025
       segments: 
       - 0
       version: "0"
@@ -157,9 +129,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []