kpi 0.3.1 → 0.3.3

data/README.rdoc

@@ -70,9 +70,11 @@ To collect all statistics and send an email to you just call:
       def title; "Your daily report"; end
       # ...
     end
+* You can use Whenever gem to generate periodic reports
 
 == Todo
 
+* Generators for configuration and reports
 * Database persistence - storing reports in different databases: PostgreSQL & Mongo prioritized
 * Controllers & views allowing to review stored reports
 * More tests ;)

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

@@ -1,28 +1,13 @@
 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
+      include KPI::Report::DynamicDefinitions
+      include KPI::Report::MailDelivery
+      
+      blacklist :initialize, :collect!, :entries, :time, :title
 
       def initialize(time=Time.now)
         @time = time
@@ -31,7 +16,7 @@ module KPI
 
       def collect!
         self.class.defined_kpis.each {|kpi_method| send(kpi_method) }
-        self.class.defined_kpis.count
+        self
       end
 
       def entries

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

@@ -0,0 +1,34 @@
+module KPI
+  module Report
+    module DynamicDefinitions
+      module ClassMethods
+        def method_added(name)
+          unless self.method_blacklisted?(name) || suppressed_memoization?
+            self.defined_kpis << name
+            suppress_memoization { memoize name }
+          end
+        end
+
+        def method_blacklisted?(name)
+          not_kpi_methods.include?(name) || name =~ /_unmemoized_/
+        end
+
+        def blacklist(*methods)
+          not_kpi_methods.push *methods
+        end
+
+        def defined_kpis
+          @kpi_methods ||= []
+        end
+
+        def not_kpi_methods
+          @not_kpi_methods ||= []
+        end
+      end
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module KPI
+  module Report
+    module MailDelivery
+      def self.included(base)
+        base.class_eval do
+          blacklist :send!
+        end
+      end
+
+      def send!
+        KPI::Mailer.report(self.collect!).deliver
+      end
+    end
+  end
+end

data/lib/generators/kpi/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate kpi Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/kpi/install_generator.rb

@@ -0,0 +1,14 @@
+module KPI
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      namespace "kpi:install"
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Creates a KPI initializer."
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/kpi.rb"
+      end
+    end
+  end
+end
+    

data/lib/generators/kpi/kpi_generator.rb

@@ -0,0 +1,8 @@
+module KPI
+  module Generators
+    class KPIGenerator < Rails::Generators::NamedBase
+      namespace "kpi"
+      source_root File.expand_path("../templates", __FILE__)
+    end
+  end
+end

data/lib/generators/kpi/templates/initializer.rb

@@ -0,0 +1,11 @@
+KPI.configure do |c|
+  # Your application name
+  # It appears in email subjects and inside email body
+  c.app_name = "Your app name"
+
+  # "from" field of KPI emails
+  c.mail_from = "kpi@yourapp.com"
+  
+  # "to" field of KPI emails
+  c.mail_to = "example@example.com"
+end

data/lib/kpi/configuration.rb

@@ -0,0 +1,22 @@
+module KPI
+  module Configuration
+    def self.included(base)
+      base.class_eval do
+        
+        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
+    end
+  end
+end

data/lib/kpi.rb

@@ -1,16 +1,6 @@
 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
+  require 'kpi/configuration'
+  include KPI::Configuration
 end

data/spec/spec_helper.rb

@@ -9,8 +9,11 @@ require 'kpi'
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+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/mail_delivery')
 require File.join(File.dirname(__FILE__), '..', 'app/models/kpi/report/base')
 require File.join(File.dirname(__FILE__), '..', 'app/mailers/kpi/mailer')
 

metadata

@@ -2,7 +2,7 @@
 name: kpi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-21 00:00:00 +01:00
+date: 2011-04-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   prerelease: false
   version_requirements: *id002
@@ -53,7 +53,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: "1.0"
   type: :development
   prerelease: false
   version_requirements: *id004
@@ -92,10 +92,17 @@ files:
 - app/mailers/kpi/mailer.rb
 - app/models/kpi/entry.rb
 - app/models/kpi/report/base.rb
+- app/models/kpi/report/dynamic_definitions.rb
+- app/models/kpi/report/mail_delivery.rb
 - app/models/kpi/report/suppress_memoization.rb
 - app/views/kpi/mailer/report.html.erb
 - lib/engine.rb
+- lib/generators/kpi/USAGE
+- lib/generators/kpi/install_generator.rb
+- lib/generators/kpi/kpi_generator.rb
+- lib/generators/kpi/templates/initializer.rb
 - lib/kpi.rb
+- lib/kpi/configuration.rb
 - LICENSE.txt
 - README.rdoc
 - spec/models/kpi/report/base_spec.rb
@@ -114,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -914412323094170311
+      hash: -1444204594839301290
       segments: 
       - 0
       version: "0"