kpi 0.3.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Artur Roszczyk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= kpi
+
+Description goes here.
+
+== Contributing to kpi
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Artur Roszczyk. See LICENSE.txt for
+further details.
+

data/app/mailers/kpi/mailer.rb

@@ -0,0 +1,12 @@
+class KPI::Mailer < ActionMailer::Base
+  default :from => KPI.mail_from
+  default :to => KPI.mail_to
+
+  def report(kpi_report)
+    @entries = kpi_report.entries
+    @time = kpi_report.time
+    @title = kpi_report.title
+
+    mail :subject => "[#{KPI.app_name} KPI][#{@time.to_date.to_s(:db)}] #{@title}"
+  end
+end

data/app/models/kpi/entry.rb

@@ -0,0 +1,4 @@
+module KPI
+  class Entry < Struct.new(:name, :value, :description)
+  end
+end

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

@@ -0,0 +1,51 @@
+module KPI
+  module Report
+    class Base
+      @@do_not_memoize = [:initialize, :collect!, :entries, :time, :title]
+      extend KPI::Report::SuppressMemoization
+      extend ActiveSupport::Memoizable
+      
+      def self.method_added(name)
+        unless self.method_blacklisted?(name) || suppressed_memoization?
+          self.defined_kpis << name
+          suppress_memoization { memoize name }
+        end
+      end
+
+      def self.method_blacklisted?(name)
+        @@do_not_memoize.include?(name) || name =~ /_unmemoized_/
+      end
+
+      def self.defined_kpis
+        @kpi_methods ||= []
+      end
+
+      def self.collect_and_send!
+        KPI::Mailer.report(self.new.tap(&:collect!)).deliver
+      end
+
+      def initialize(time=Time.now)
+        @time = time
+      end
+      attr_reader :time
+
+      def collect!
+        self.class.defined_kpis.each {|kpi_method| send(kpi_method) }
+        self.class.defined_kpis.count
+      end
+
+      def entries
+        Enumerator.new do |yielder|
+          self.class.defined_kpis.each do |kpi_method|
+            result = send(kpi_method)
+            yielder.yield(Entry.new(result.shift, result.shift, result.shift))
+          end
+        end
+      end
+
+      def title
+        self.class.name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module KPI
+  module Report
+    module SuppressMemoization
+      def suppress_memoization
+        Thread.current[:'suppress memoization'] = true
+        yield
+      ensure
+        Thread.current[:'suppress memoization'] = false
+      end
+      
+      def suppressed_memoization?
+        Thread.current[:'suppress memoization']
+      end
+    end
+  end
+end

data/app/views/kpi/mailer/report.html.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  </head>
+
+  <body>
+    <h1><%= KPI.app_name %> KPI Report</h1>
+    <h2><%= @title %></h2>
+    <p>Created at: <%= @time.to_s(:db) %></p>
+    <table style="border-collapse: collapse;width: 100%;" width="100%">
+      <tr style="border-bottom: 1px solid black;">
+        <td>KPI</td>
+        <td>Value</td>
+      </tr>
+      <% for entry in @entries %>
+        <tr style="border-bottom: 1px solid black;">
+          <td>
+            <strong><%= entry.name %></strong>
+            <% unless entry.description.blank? %>
+              <br />
+              <span style="color: grey; font-size: smaller;">
+                <%= entry.description %>
+              </span>
+            <% end %>
+          </td>
+          <td style="text-align: center;"><%= entry.value %></td>
+        </tr>
+      <% end %>
+    </table>
+  </body>    
+</html>

data/lib/engine.rb

@@ -0,0 +1,17 @@
+require 'kpi'
+require 'rails'
+
+module KPI
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+    
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+  end
+end

data/lib/kpi.rb

@@ -0,0 +1,16 @@
+module KPI
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
+  mattr_accessor :app_name
+  @@app_name = "Your app"
+
+  mattr_accessor :mail_from
+  @@mail_from = "example@example.com"
+
+  mattr_accessor :mail_to
+  @@mail_to = "example@example.com"
+
+  def self.configure
+    yield self
+  end
+end

data/spec/models/kpi/report/base_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe "KPI::Report::Base" do
+  before(:all) do
+    class TestKpi < KPI::Report::Base
+      def test_kpi
+        return ["title", 1, "description"]
+      end
+
+      def another_kpi
+        return ["another title", 0]
+      end
+    end
+  end
+
+  it "should define indicators" do
+    TestKpi.defined_kpis.should == [:test_kpi, :another_kpi]
+  end
+
+  describe :collect! do
+    before { @kpi = TestKpi.new }
+    it "should call all KPIs" do
+      TestKpi.defined_kpis.each do |kpi_method|
+        @kpi.should_receive(kpi_method)
+      end
+      @kpi.collect!
+    end
+  end
+
+  describe :entries do
+    before { @kpi = TestKpi.new }
+
+    it "should return enumerator" do
+      @kpi.entries.should be_kind_of(Enumerable)
+    end
+
+    it "should return enumerator with entries" do
+      @kpi.entries.first.should be_kind_of(KPI::Entry)
+    end
+
+    it "should fill entries with names" do
+      @kpi.entries.map(&:name).should == ["title", "another title"]
+    end
+
+    it "should fill entries with values" do
+      @kpi.entries.map(&:value).should == [1, 0]
+    end
+
+    it "should fill entries with descriptions" do
+      @kpi.entries.map(&:description).should == ["description", nil]
+    end
+  end
+
+  describe :title do
+    it "should return class name by default" do
+      TestKpi.new.title.should == "TestKpi"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'active_support'
+require 'action_mailer'
+require 'rspec'
+require 'kpi'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/entry')
+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/mailers/kpi/mailer')
+
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: kpi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Artur Roszczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: This gem helps you to track key indicators in your Rails app.
+email: artur.roszczyk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- app/mailers/kpi/mailer.rb
+- app/models/kpi/entry.rb
+- app/models/kpi/report/base.rb
+- app/models/kpi/report/suppress_memoization.rb
+- app/views/kpi/mailer/report.html.erb
+- lib/engine.rb
+- lib/kpi.rb
+- LICENSE.txt
+- README.rdoc
+- spec/models/kpi/report/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sevos/kpi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1994630966239560221
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Key Performance Indicators for Rails 3.x
+test_files: 
+- spec/models/kpi/report/base_spec.rb
+- spec/spec_helper.rb