kpi 0.5.0 → 0.5.1

data/app/models/kpi/entry.rb

@@ -1,4 +1,15 @@
 module KPI
-  class Entry < Struct.new(:name, :value, :description)
+  class Entry
+    attr_reader :name, :value, :description
+    def initialize(*args)
+      options = args.extract_options!
+      raise ArgumentError, "Wrong number of arguments (#{args.count} of 2)" unless args.count == 2
+      @name, @value = args
+      @description = options[:description]
+    end
+    
+    def to_a
+      [@title, @value, @description].compact
+    end
   end
 end

data/app/models/kpi/merged_report.rb

@@ -0,0 +1,36 @@
+module KPI
+  class MergedReport
+    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|
+        defined_kpis.each do |kpi_method|
+          yielder.yield(send(kpi_method))
+        end
+      end
+    end
+  
+    def title
+      self.class.name
+    end
+    
+    def defined_kpis
+      @reports.map(&:defined_kpis).inject(&:&)
+    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.gsub("$$", orginal.description) : nil)
+
+      KPI::Entry.new(result.name.gsub("$$", orginal.name), result.value, :description => description)
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module KPI
-  module Report
+  class Report
     module DynamicDefinitions
       module ClassMethods
         def method_added(name)

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

@@ -1,5 +1,5 @@
 module KPI
-  module Report
+  class Report
     module SuppressMemoization
       def suppress_memoization
         Thread.current[:'suppress memoization'] = true

data/app/models/kpi/report.rb

@@ -0,0 +1,41 @@
+module KPI
+  class Report
+    extend KPI::Report::SuppressMemoization
+    extend ActiveSupport::Memoizable
+ 
+    include KPI::Report::DynamicDefinitions
+    
+    blacklist :initialize, :collect!, :entries, :time, :title, :defined_kpis, :result
+ 
+    def initialize(*args)
+      options = args.extract_options!
+      @time = options[:time] || Time.now
+    end
+    attr_reader :time
+ 
+    def collect!
+      self.defined_kpis.each {|kpi_method| send(kpi_method) }
+      self
+    end
+ 
+    def entries
+      Enumerator.new do |yielder|
+        self.class.defined_kpis.each do |kpi_method|
+          yielder.yield(send(kpi_method))
+        end
+      end
+    end
+ 
+    def title
+      self.class.name
+    end
+ 
+    def defined_kpis
+      self.class.defined_kpis
+    end
+    
+    def result(*args)
+      KPI::Entry.new *args
+    end
+  end
+end

data/lib/array/extract_options.rb

@@ -0,0 +1,7 @@
+module ExtractOptions
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+Array.send(:include, ExtractOptions)

data/lib/kpi.rb

@@ -1,3 +1,5 @@
+require 'array/extract_options'
+
 module KPI
   require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
   require 'kpi/18compatibility' if RUBY_VERSION < '1.9'

data/test/test_helper.rb

@@ -14,6 +14,6 @@ require File.join(File.dirname(__FILE__), '..', 'lib/kpi/configuration')
 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')
+require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report')
+require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/merged_report')
 

data/test/unit/kpi/entry_tesr.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe "KPI::Entry" do
+  it "should require exactly 2 arguments" do
+    assert_raises(ArgumentError)) { KPI::Entry.new }
+    assert_raises(ArgumentError)) { KPI::Entry.new "test" }
+    assert_raises(ArgumentError)) { KPI::Entry.new "test", 1, "aaa" }
+  end
+
+  describe "when title and value given" do
+    before { @entry = KPI::Entry.new "name", "value" }
+    
+    it "returns name" do
+      assert_equal("name", @entry.name)
+    end
+    
+    it "returns value" do
+      assert_equal("value", @entry.value)
+    end
+    
+    it "returns nil as description" do
+      assert_nil(@entry.description)
+    end
+    describe "when description given" do
+      before { @entry = KPI::Entry.new "name", "value", :description => "desc" }
+    
+      it "returns description" do
+        assert_equal("desc", @entry.description)
+      end
+    end
+  end
+end

data/test/unit/kpi/{report/merged_test.rb → merged_report_test.rb}

@@ -1,23 +1,23 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
-describe "KPI::Report::Merged" do
+describe "KPI::MergedReport" do
   
   before do
-    class TestKpi < KPI::Report::Base
+    class TestKpi < KPI::Report
       def initialize return_value = 1
         super()
         @return = return_value
       end
 
       def test_kpi
-        return ["title", @return, "description"]
+        result "title", @return, :description => "description"
       end
 
       def test_kpi_2
-        return ["title 2 ", @return*2]
+        result "title 2 ", @return*2
       end
     end
-    class AnotherReport < KPI::Report::Base
+    class AnotherReport < KPI::Report
     end
   end
 
@@ -28,26 +28,26 @@ describe "KPI::Report::Merged" do
 
   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) {}
+      KPI::MergedReport.new(TestKpi.new) {}
+      KPI::MergedReport.new(TestKpi.new, TestKpi.new) {}
+      KPI::MergedReport.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() {}
+        KPI::MergedReport.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) {}
+        KPI::MergedReport.new(TestKpi.new, AnotherReport.new) {}
       end
     end
 
     it "should require block when initializing" do
       assert_raises(Exception) do
-        KPI::Report::Merged.new(TestKpi.new)
+        KPI::MergedReport.new(TestKpi.new)
       end
     end
   end
@@ -57,26 +57,26 @@ describe "KPI::Report::Merged" 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)"]
+      @average = KPI::MergedReport.new(report1, report2) do |*entries|
+        average = entries.map(&:value).sum / entries.size
+        KPI::Entry.new "Average $$", average, :description => "$$ (average)"
       end
     end
 
     it "should calculate value using block given in initializer when asking for KPI" do
-      assert_equal 5, @average.test_kpi[1]
+      assert_equal 5, @average.test_kpi.value
     end
 
     it "should change $$ in title to indicator title" do
-      assert_equal "Average title", @average.test_kpi[0]
+      assert_equal "Average title", @average.test_kpi.name
     end
 
     it "should change $$ in description to indicator descripiton" do
-      assert_equal "description (average)", @average.test_kpi[2]
+      assert_equal "description (average)", @average.test_kpi.description
     end
 
     it "should return nil description when no description" do
-      assert_nil @average.test_kpi_2[2]
+      assert_nil @average.test_kpi_2.description
     end
 
     describe "entries" do
@@ -96,5 +96,11 @@ describe "KPI::Report::Merged" do
         assert_equal [5,10], @average.entries.map(&:value)
       end
     end
+    
+    describe :defined_kpis do
+      it "should return KPIs defined by all compounds" do
+        assert_equal TestKpi.defined_kpis, @average.defined_kpis
+      end
+    end
   end
 end

data/test/unit/kpi/{report/base_test.rb → report_test.rb}

@@ -1,16 +1,17 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
-describe "KPI::Report::Base" do
+describe "KPI::Report" do
   before do
-    class TestKpi < KPI::Report::Base
+    class TestKpi < KPI::Report
       def test_kpi
-        return ["title", 1, "description"]
+        return KPI::Entry.new "title", 1, :description => "description"
       end
 
       def another_kpi
-        return ["another title", 0]
+        return KPI::Entry.new "another title", 0
       end
     end
+    @kpi = TestKpi.new
   end
 
   after { Object.send(:remove_const, :TestKpi) }
@@ -29,15 +30,18 @@ describe "KPI::Report::Base" do
   end
 
   describe :collect! do
-    before { @kpi = TestKpi.new }
     it "should collect all KPIs" do
       assert_equal 2, @kpi.collect!.entries.count
     end
   end
+  
+  describe :defined_kpis do
+    it "should return KPIs defined by class" do
+      assert_equal TestKpi.defined_kpis, @kpi.defined_kpis
+    end
+  end
 
   describe :entries do
-    before { @kpi = TestKpi.new }
-
     it "should return enumerator" do
       assert @kpi.entries.kind_of?(Enumerable)
     end
@@ -61,7 +65,28 @@ describe "KPI::Report::Base" do
 
   describe :title do
     it "should return class name by default" do
-      assert_equal "TestKpi", TestKpi.new.title
+      assert_equal "TestKpi", @kpi.title
+    end
+  end
+  
+  describe :time do
+    it "should return overriden time" do
+      assert_equal(:time, TestKpi.new(:time => :time).time)
+    end
+  end
+  
+  describe :result do
+    it "creates KPI::Entry" do
+      class TestKpi
+        def super_kpi
+          result "test", 2, :description => "desc"
+        end
+      end
+      
+      @entry = TestKpi.new.super_kpi
+      assert_equal("test", @entry.name)
+      assert_equal(2, @entry.value)
+      assert_equal("desc", @entry.description)
     end
   end
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kpi
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: 
-  version: 0.5.0
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -14,71 +19,94 @@ date: 2011-05-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: actionmailer
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
         version: "2.3"
-  type: :runtime
-  prerelease: false
+  name: actionmailer
   version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
         version: "2.3"
-  type: :runtime
-  prerelease: false
+  name: activesupport
   version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: minitest
   version_requirements: *id003
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-  type: :development
-  prerelease: false
+  name: bundler
   version_requirements: *id004
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
         version: 1.5.2
-  type: :development
-  prerelease: false
+  name: jeweler
   version_requirements: *id005
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :development
-  prerelease: false
+  name: rcov
   version_requirements: *id006
+  prerelease: false
 description: This gem helps you to track key indicators in your Rails app.
 email: artur.roszczyk@gmail.com
 executables: []
@@ -90,10 +118,11 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - app/models/kpi/entry.rb
-- app/models/kpi/report/base.rb
+- app/models/kpi/merged_report.rb
+- app/models/kpi/report.rb
 - app/models/kpi/report/dynamic_definitions.rb
-- app/models/kpi/report/merged.rb
 - app/models/kpi/report/suppress_memoization.rb
+- lib/array/extract_options.rb
 - lib/engine.rb
 - lib/generators/kpi/USAGE
 - lib/generators/kpi/kpi_generator.rb
@@ -103,8 +132,9 @@ files:
 - LICENSE.txt
 - README.rdoc
 - test/test_helper.rb
-- test/unit/kpi/report/base_test.rb
-- test/unit/kpi/report/merged_test.rb
+- test/unit/kpi/entry_tesr.rb
+- test/unit/kpi/merged_report_test.rb
+- test/unit/kpi/report_test.rb
 has_rdoc: true
 homepage: http://github.com/sevos/kpi
 licenses: 
@@ -119,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2742020933560976689
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -128,15 +158,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 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
+- test/unit/kpi/entry_tesr.rb
+- test/unit/kpi/merged_report_test.rb
+- test/unit/kpi/report_test.rb

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

@@ -1,35 +0,0 @@
-module KPI
-  module Report
-    class Base
-      extend KPI::Report::SuppressMemoization
-      extend ActiveSupport::Memoizable
-
-      include KPI::Report::DynamicDefinitions
-      
-      blacklist :initialize, :collect!, :entries, :time, :title
-
-      def initialize(time=Time.now)
-        @time = time
-      end
-      attr_reader :time
-
-      def collect!
-        self.class.defined_kpis.each {|kpi_method| send(kpi_method) }
-        self
-      end
-
-      def entries
-        Enumerator.new do |yielder|
-          self.class.defined_kpis.each do |kpi_method|
-            result = send(kpi_method)
-            yielder.yield(Entry.new(*result))
-          end
-        end
-      end
-
-      def title
-        self.class.name
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-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