kpi_manager 0.1.0.pre → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 985c3aca449032e19dd3a05f7e2d487294c5672d
-  data.tar.gz: 6bf47a080c73fcace81ae070bbb45c418e48d5b2
+  metadata.gz: 3c8f55cc566b14da16121391756278ad78e4e884
+  data.tar.gz: caed2e8541f8f30178830b7c9303fcf76228b5b3
 SHA512:
-  metadata.gz: 88c32c4ebc9a5879f4f3c2760b750aa2575a3c4ca27699234ac3ae37b9f33351596996549ce10bc938880abb93f031d0e619b6cf4b3463d2b12e5c132ceb7d48
-  data.tar.gz: e506c3ae26086b59c5a14a95e7b5f1efcb650ad04c124990812d8940c257070f63ae97f747375be92e963d6de224384dde6a7ad3ba638853f012627be8fa8506
+  metadata.gz: 3dfc53eaa8809ebc952bb8981a8af9a84ee36b1d834610768d332c80ac9e04e4edd293aa9671e6abc9eecdeefdb0ebcbc74dea8ef7c090e65afe31f7c77e8629
+  data.tar.gz: c05ad8ad69f2c24ce65cfc6fd5a94552566ae27d28a40d12daf222bf66948a8e8340afbc9a686ea8ac88c89d0d311a9eb37cd3e2daf8d2e5ee7c6e9d15467993

data/lib/kpi_manager/{report.rb → models/report.rb}

@@ -10,6 +10,8 @@ module KpiManager
       @to = to || Time.zone.now
       @report = []
 
+      @datacache.clear
+
       registered_kpis.each do |kpi_name, kpi_data|
         @report << [
           kpi_data[:label],
@@ -21,7 +23,35 @@ module KpiManager
         ]
       end
 
-      @report
+      rr = KpiManager::ReportingResult.new(@report)
+      rr.from = @from
+      rr.to = @to
+      rr
+    end
+
+    def compare(from, to)
+      @from = from
+      @to = to
+      self
+    end
+
+    def with(oth_from, oth_to)
+      raise RuntimeError, 'No date range set' unless @from && @to
+
+      left = self.generate(@from, @to).results
+      right = self.generate(oth_from, oth_to).results
+
+      res = left.zip(right).map do |left, right|
+        [
+          left[0],
+          (right[1].to_f - left[1].to_f) / left[1].to_f * 100
+        ]
+      end
+
+      rr = KpiManager::ReportingResult.new(res)
+      rr.from = oth_from - @from
+      rr.to = oth_to - @to
+      rr
     end
 
     private

data/lib/kpi_manager/models/reporting_result.rb

@@ -0,0 +1,24 @@
+module KpiManager
+  class ReportingResult
+    attr_accessor :results, :from, :to
+
+    def initialize(table)
+      @results = table
+    end
+
+    def -(other)
+      left = self.results
+      right = other.results
+      res = left.zip(right).map do |left, right|
+        [
+          left[0],
+          (right[1].to_f - left[1].to_f) / left[1].to_f * 100
+        ]
+      end
+      rr = KpiManager::ReportingResult.new(res)
+      rr.from = other.from - self.from
+      rr.to = other.to - self.to
+      rr
+    end
+  end
+end

data/lib/kpi_manager/version.rb

@@ -1,3 +1,3 @@
 module KpiManager
-  VERSION = '0.1.0.pre'.freeze
+  VERSION = '0.2.0.pre'.freeze
 end

data/lib/kpi_manager.rb

@@ -3,9 +3,10 @@ require 'kpi_manager/engine'
 module KpiManager # :nodoc:
 end
 
-require 'kpi_manager/dataset'
-require 'kpi_manager/kpi'
-require 'kpi_manager/report'
+require 'kpi_manager/models/dataset'
+require 'kpi_manager/models/kpi'
+require 'kpi_manager/models/reporting_result'
+require 'kpi_manager/models/report'
 
 require 'rails/generators'
 require 'kpi_manager/generators/kpi_manager_generator'

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ RSpec.configure do |config|
   require 'simplecov'
   SimpleCov.start do
     add_filter '/spec/'
+    add_filter '/lib/kpi_manager/generators/'
   end
 
   config.expect_with :rspec do |expectations|
@@ -12,6 +13,10 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  require 'factory_girl_rails'
+  require 'faker'
+  config.include FactoryGirl::Syntax::Methods
+
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
   config.filter_run_when_matching :focus

data/spec/test_app/config/initializers/kpi_manager.rb

@@ -19,3 +19,12 @@ end
 KpiManager::Kpi.add(:average_order, 'Average order', dataset: :bills, references: [:total_earned]) do |dataset, **refs|
   dataset.count.zero? ? 0 : refs[:total_earned] / dataset.count
 end
+
+KpiManager::Kpi.add(:promotion_used, 'Promotion used', dataset: :bills) do |dataset, **refs|
+  dataset.where.not(promotion: nil).count
+end
+
+KpiManager::Kpi.add(:average_promotion, 'Average promotion', dataset: :bills) do |dataset, **refs|
+  sum = dataset.where.not(promotion: nil).inject(0) { |acc, elem| acc + elem.promotion.percentage }
+  dataset.count.zero? ? 0 : sum / dataset.count
+end

data/spec/test_app/spec/factories/car.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :car do
+    brand Faker::Vehicle.manufacture
+    model Faker::Commerce.product_name
+    price Faker::Commerce.price
+  end
+end

data/spec/test_app/spec/factories/user.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :user do
+    firstname Faker::Name.first_name
+    lastname Faker::Name.last_name
+    email Faker::Internet.email
+    birthdate Faker::Date.between(20.years.ago, 10.years.ago)
+    created_at Faker::Date.between(2.hours.ago, 10.minutes.ago)
+  end
+end

data/spec/test_app/spec/kpi_manager_spec.rb

@@ -2,36 +2,80 @@ require 'spec_helper'
 require 'rails_helper'
 
 RSpec.describe KpiManager::Report, :type => :model do
-  it 'generates a report' do
-    p206 = Car.create(brand: 'Peugot', model: '206', price: 9890.90)
-    zoe = Car.create(brand: 'Renault', model: 'Zoé', price: 12500)
-
-    hugo = User.create(
-      firstname: 'Hugo',
-      lastname: 'Chevalier',
-      email: 'email@gmail.com',
-      birthdate: Date.parse('1989-05-01')
-    )
-
-    drakhaine = User.create(
-      firstname: 'Drakhaine',
-      lastname: 'Arakhnide',
-      email: 'email@gmail.com',
-      birthdate: Date.parse('1989-04-24')
-    )
-
-    hugo.buy_car(p206)
-    drakhaine.buy_car(zoe, Promotion.create(percentage: 10))
-
-    report = KpiManager::Report.create(name: 'My first report')
-    report.kpis.create(slug: 'users_count')
-    report.kpis.create(slug: 'total_earned')
-    report.kpis.create(slug: 'average_order')
+  before(:all) do
+    car1 = create(:car, price: 1000.00)
+    car2 = create(:car, price: 2000.00)
+
+    user1 = create(:user, created_at: 10.minutes.ago)
+    user2 = create(:user, created_at: 3.minutes.ago)
+    old_user = create(:user, created_at: 35.days.ago)
+
+    old_user.buy_car(car1, Promotion.create(percentage: 30))
+    old_user.orders.last.update(created_at: 33.days.ago)
+
+    user1.buy_car(car1)
+    user2.buy_car(car2, Promotion.create(percentage: 10))
+
+    @report = KpiManager::Report.create(name: 'My first report')
+    @report.kpis.create(slug: 'users_count')
+    @report.kpis.create(slug: 'total_earned')
+    @report.kpis.create(slug: 'average_order')
+    @report.kpis.create(slug: 'promotion_used')
+    @report.kpis.create(slug: 'average_promotion')
+  end
+
+  it 'generates a report for previous month' do
+    # Last month
+    expectancy = [
+      ["Subscribed users", 1],
+      ["Total earned", 700.00],
+      ["Average order", 700.00],
+      ["Promotion used", 1],
+      ["Average promotion", 30]
+    ]
+    report = @report.generate(60.days.ago, 31.days.ago)
+    expect(report.results).to eql(expectancy)
+  end
+
+  it 'generates a report for current month' do
+    # Current month
     expectancy = [
       ["Subscribed users", 2],
-      ["Total earned", 21140.9],
-      ["Average order", 10570.45]
+      ["Total earned", 2800.00],
+      ["Average order", 1400.00],
+      ["Promotion used", 1],
+      ["Average promotion", 5]
     ]
-    expect(report.generate(Date.yesterday)).to eql(expectancy)
+    report = @report.generate(30.days.ago)
+    expect(report.results).to eql(expectancy)
+  end
+
+  context 'generating a diff' do
+    it 'works with compare().with()' do
+      # Diff
+      expectancy = [
+        ["Subscribed users", 100.0],
+        ["Total earned", 300.00],
+        ["Average order", 100.00],
+        ["Promotion used", 0.0],
+        ["Average promotion", -83.33333333333334]
+      ]
+      report = @report.compare(60.days.ago, 31.days.ago).with(30.days.ago, Time.zone.now)
+      expect(report.results).to eql(expectancy)
+    end
+
+    it 'works when subtracting two report results' do
+      # Diff
+      expectancy = [
+        ["Subscribed users", 100.0],
+        ["Total earned", 300.00],
+        ["Average order", 100.00],
+        ["Promotion used", 0.0],
+        ["Average promotion", -83.33333333333334]
+      ]
+      report1 = @report.generate(60.days.ago, 31.days.ago)
+      report2 = @report.generate(30.days.ago, Time.zone.now)
+      expect((report1 - report2).results).to eql(expectancy)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kpi_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.2.0.pre
 platform: ruby
 authors:
 - Hugo Chevalier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-16 00:00:00.000000000 Z
+date: 2016-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +164,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.46.0
-description: Description of KpiManager.
+description: |2
+      KpiManager allows to create reports from a back-office.
+      KPIs must be defined in the code before they're available in reports editor.
+      On v1.0.0, it will be possible to schedule recurrent reporting by email
+      and to create report-tied dashboards displaying widgets for each of your KPIs.
 email:
 - drakhaine@gmail.com
 executables: []
@@ -153,15 +185,16 @@ files:
 - app/views/layouts/kpi_manager/application.html.erb
 - config/routes.rb
 - lib/kpi_manager.rb
-- lib/kpi_manager/dashboard.rb
-- lib/kpi_manager/dataset.rb
 - lib/kpi_manager/engine.rb
 - lib/kpi_manager/generators/kpi_manager_generator.rb
 - lib/kpi_manager/generators/templates/dashboard_migration.rb
 - lib/kpi_manager/generators/templates/kpi_migration.rb
 - lib/kpi_manager/generators/templates/report_migration.rb
-- lib/kpi_manager/kpi.rb
-- lib/kpi_manager/report.rb
+- lib/kpi_manager/models/dashboard.rb
+- lib/kpi_manager/models/dataset.rb
+- lib/kpi_manager/models/kpi.rb
+- lib/kpi_manager/models/report.rb
+- lib/kpi_manager/models/reporting_result.rb
 - lib/kpi_manager/version.rb
 - lib/tasks/kpi_manager_tasks.rake
 - spec/rails_helper.rb
@@ -196,8 +229,10 @@ files:
 - spec/test_app/db/migrate/20170116205701_create_kpi_manager_report.rb
 - spec/test_app/db/migrate/20170116205702_create_kpi_manager_kpi.rb
 - spec/test_app/db/schema.rb
+- spec/test_app/spec/factories/car.rb
+- spec/test_app/spec/factories/user.rb
 - spec/test_app/spec/kpi_manager_spec.rb
-homepage: https://rubygems.org/kpi_manager
+homepage: https://github.com/hchevalier/kpi_manager
 licenses:
 - MIT
 metadata: {}
@@ -220,7 +255,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Summary of KpiManager.
+summary: Create recurrent reports from KPIs.
 test_files:
 - spec/rails_helper.rb
 - spec/spec_helper.rb
@@ -254,4 +289,6 @@ test_files:
 - spec/test_app/db/migrate/20170116205701_create_kpi_manager_report.rb
 - spec/test_app/db/migrate/20170116205702_create_kpi_manager_kpi.rb
 - spec/test_app/db/schema.rb
+- spec/test_app/spec/factories/car.rb
+- spec/test_app/spec/factories/user.rb
 - spec/test_app/spec/kpi_manager_spec.rb