kpi 0.4.1 → 0.5.0

data/app/models/kpi/report/base.rb

@@ -22,7 +22,7 @@ module KPI
         Enumerator.new do |yielder|
           self.class.defined_kpis.each do |kpi_method|
             result = send(kpi_method)
-            yielder.yield(Entry.new(result[0], result[1], result[2]))
+            yielder.yield(Entry.new(*result))
           end
         end
       end

data/app/models/kpi/report/dynamic_definitions.rb

@@ -10,7 +10,7 @@ module KPI
         end
 
         def method_blacklisted?(name)
-          not_kpi_methods.include?(name) || name =~ /_unmemoized_/
+          not_kpi_methods.include?(name) || name =~ /_unmemoized_/ || !self.instance_methods(true).map(&:to_sym).include?(name)
         end
 
         def blacklist(*methods)

data/app/models/kpi/report/merged.rb

@@ -0,0 +1,38 @@
+module KPI
+  module Report
+    class Merged
+      def initialize(*args, &block)
+        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
+      end
+      
+      def entries
+        Enumerator.new do |yielder|
+          @reports.first.class.defined_kpis.each do |kpi_method|
+            result = self.send(kpi_method.to_sym)
+            yielder.yield(KPI::Entry.new(*result))
+          end
+        end
+      end
+
+      def title
+        self.class.name
+      end
+
+      def method_missing(name, *args)
+        result = @compare.call(*@reports.map(&name.to_sym))
+        [0,2].each do |i|
+          text = @reports.first.send(name.to_sym)[i]
+          result[i] = text ? result[i].gsub!("$$", text) : nil
+        end
+        result
+      end
+      
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -15,4 +15,5 @@ require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/entry')
 require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report/dynamic_definitions')
 require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report/suppress_memoization')
 require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report/base')
+require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report/merged')
 

data/test/unit/kpi/report/base_test.rb

@@ -1,19 +1,32 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
-class TestKpi < KPI::Report::Base
-  def test_kpi
-    return ["title", 1, "description"]
-  end
+describe "KPI::Report::Base" do
+  before do
+    class TestKpi < KPI::Report::Base
+      def test_kpi
+        return ["title", 1, "description"]
+      end
 
-  def another_kpi
-    return ["another title", 0]
+      def another_kpi
+        return ["another title", 0]
+      end
+    end
   end
-end
 
-describe "KPI::Report::Base" do
+  after { Object.send(:remove_const, :TestKpi) }
+
   it "should define indicators" do
     assert_equal [:test_kpi, :another_kpi], TestKpi.defined_kpis
   end
+  
+  it "should not define indicator from private method" do
+    class TestKpi
+      private
+      def not_kpi
+      end
+    end
+    assert !TestKpi.defined_kpis.include?(:not_kpi)
+  end
 
   describe :collect! do
     before { @kpi = TestKpi.new }
@@ -51,4 +64,4 @@ describe "KPI::Report::Base" do
       assert_equal "TestKpi", TestKpi.new.title
     end
   end
-end
+end

data/test/unit/kpi/report/merged_test.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe "KPI::Report::Merged" do
+  
+  before do
+    class TestKpi < KPI::Report::Base
+      def initialize return_value = 1
+        super()
+        @return = return_value
+      end
+
+      def test_kpi
+        return ["title", @return, "description"]
+      end
+
+      def test_kpi_2
+        return ["title 2 ", @return*2]
+      end
+    end
+    class AnotherReport < KPI::Report::Base
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :TestKpi)
+    Object.send(:remove_const, :AnotherReport)
+  end
+
+  describe "when initializing" do
+    it "should initialize with list of KPI::Report::Base objects and block" do
+      KPI::Report::Merged.new(TestKpi.new) {}
+      KPI::Report::Merged.new(TestKpi.new,TestKpi.new) {}
+      KPI::Report::Merged.new(TestKpi.new,TestKpi.new,TestKpi.new) {}
+    end
+
+    it "should require at least one element when initializing" do
+      assert_raises(ArgumentError) do
+        KPI::Report::Merged.new() {}
+      end
+    end
+
+    it "should require objects of the same type when initializing" do
+      assert_raises(ArgumentError) do
+        KPI::Report::Merged.new(TestKpi.new,AnotherReport.new) {}
+      end
+    end
+
+    it "should require block when initializing" do
+      assert_raises(Exception) do
+        KPI::Report::Merged.new(TestKpi.new)
+      end
+    end
+  end
+
+  describe "when two reports given for average" do
+    before do
+      report1 = TestKpi.new(2)
+      report2 = TestKpi.new(8)
+
+      @average = KPI::Report::Merged.new(report1, report2) do |*entries|
+        average = entries.map{|e| KPI::Entry.new(*e).value }.sum / entries.size
+        ["Average $$", average, "$$ (average)"]
+      end
+    end
+
+    it "should calculate value using block given in initializer when asking for KPI" do
+      assert_equal 5, @average.test_kpi[1]
+    end
+
+    it "should change $$ in title to indicator title" do
+      assert_equal "Average title", @average.test_kpi[0]
+    end
+
+    it "should change $$ in description to indicator descripiton" do
+      assert_equal "description (average)", @average.test_kpi[2]
+    end
+
+    it "should return nil description when no description" do
+      assert_nil @average.test_kpi_2[2]
+    end
+
+    describe "entries" do
+      it "should return enumerator with entries" do
+        assert_kind_of Enumerable, @average.entries
+      end
+
+      it "should pack average entries to enumerator" do
+        assert @average.entries.all? { |e| e.instance_of?(KPI::Entry) }
+      end
+
+      it "should have each average entry for each indicator" do
+        assert_equal TestKpi.defined_kpis.size, @average.entries.to_a.size
+      end
+
+      it "should calculate averages for each indicator" do
+        assert_equal [5,10], @average.entries.map(&:value)
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: kpi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -92,6 +92,7 @@ files:
 - app/models/kpi/entry.rb
 - app/models/kpi/report/base.rb
 - app/models/kpi/report/dynamic_definitions.rb
+- app/models/kpi/report/merged.rb
 - app/models/kpi/report/suppress_memoization.rb
 - lib/engine.rb
 - lib/generators/kpi/USAGE
@@ -103,6 +104,7 @@ files:
 - README.rdoc
 - test/test_helper.rb
 - test/unit/kpi/report/base_test.rb
+- test/unit/kpi/report/merged_test.rb
 has_rdoc: true
 homepage: http://github.com/sevos/kpi
 licenses: 
@@ -117,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3262081361924611010
+      hash: -2742020933560976689
       segments: 
       - 0
       version: "0"
@@ -137,3 +139,4 @@ summary: Key Performance Indicators for Rails 3.x
 test_files: 
 - test/test_helper.rb
 - test/unit/kpi/report/base_test.rb
+- test/unit/kpi/report/merged_test.rb