kpi_manager 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 985c3aca449032e19dd3a05f7e2d487294c5672d
+  data.tar.gz: 6bf47a080c73fcace81ae070bbb45c418e48d5b2
+SHA512:
+  metadata.gz: 88c32c4ebc9a5879f4f3c2760b750aa2575a3c4ca27699234ac3ae37b9f33351596996549ce10bc938880abb93f031d0e619b6cf4b3463d2b12e5c132ceb7d48
+  data.tar.gz: e506c3ae26086b59c5a14a95e7b5f1efcb650ad04c124990812d8940c257070f63ae97f747375be92e963d6de224384dde6a7ad3ba638853f012627be8fa8506

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Hugo Chevalier
+
+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,12 @@
+= KpiManager
+
+As a developer:
+Define KPIs in an initializer
+
+As a back-office administrator:
+- Create a report from back-office
+- Attach any KPI that has been created by your developers
+- KPIs removed by developers will be ignored without crashing the whole report
+- Select your start and end dates to generate the report
+
+rails g kpi_manager:migrations

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KpiManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/test_app/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('../spec/**/*_spec.rb')
+end
+task default: :spec

data/app/assets/javascripts/kpi_manager/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/kpi_manager/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/kpi_manager/application_controller.rb

@@ -0,0 +1,5 @@
+module KpiManager
+  class ApplicationController < ActionController::Base # :nodoc:
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/kpi_manager/application_helper.rb

@@ -0,0 +1,4 @@
+module KpiManager
+  module ApplicationHelper # :nodoc:
+  end
+end

data/app/views/layouts/kpi_manager/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>KpiManager</title>
+  <%= stylesheet_link_tag    "kpi_manager/application", media: "all" %>
+  <%= javascript_include_tag "kpi_manager/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+KpiManager::Engine.routes.draw do
+end

data/lib/kpi_manager/dashboard.rb

@@ -0,0 +1,4 @@
+module KpiManager
+  class Dashboard < ActiveRecord::Base
+  end
+end

data/lib/kpi_manager/dataset.rb

@@ -0,0 +1,13 @@
+module KpiManager
+  # Allow scope-like behavior, KPIs use datasets to compute data from
+  class Dataset
+    def self.add(name, &block)
+      b = block
+      KpiManager::Report.class_eval do
+        define_method(name) do |from, to|
+          b.call(from, to)
+        end
+      end
+    end
+  end
+end

data/lib/kpi_manager/engine.rb

@@ -0,0 +1,5 @@
+module KpiManager
+  class Engine < ::Rails::Engine # :nodoc:
+    isolate_namespace KpiManager
+  end
+end

data/lib/kpi_manager/generators/kpi_manager_generator.rb

@@ -0,0 +1,15 @@
+module KpiManager
+  class MigrationsGenerator < Rails::Generators::Base # :nodoc:
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      time = Time.zone.now.strftime('%Y%m%d%H%M')
+      dashboard_mig = "db/migrate/#{time}00_create_kpi_manager_dashboard.rb"
+      template 'dashboard_migration.rb', dashboard_mig
+      report_mig = "db/migrate/#{time}01_create_kpi_manager_report.rb"
+      template 'report_migration.rb', report_mig
+      kpi_mig = "db/migrate/#{time}02_create_kpi_manager_kpi.rb"
+      template 'kpi_migration.rb', kpi_mig
+    end
+  end
+end

data/lib/kpi_manager/generators/templates/dashboard_migration.rb

@@ -0,0 +1,10 @@
+class CreateKpiManagerDashboard < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_dashboards do |t|
+      t.string :name
+      t.string :slug
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/kpi_manager/generators/templates/kpi_migration.rb

@@ -0,0 +1,8 @@
+class CreateKpiManagerKpi < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_kpis do |t|
+      t.string :slug
+      t.references :report
+    end
+  end
+end

data/lib/kpi_manager/generators/templates/report_migration.rb

@@ -0,0 +1,11 @@
+class CreateKpiManagerReport < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_reports do |t|
+      t.string :name
+      # TODO: handle recurrency
+      # TODO: handle multiple recipients
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/kpi_manager/kpi.rb

@@ -0,0 +1,21 @@
+module KpiManager
+  # Represent a KPI bound to a specific report
+  class Kpi < ActiveRecord::Base
+    belongs_to :report, class_name: 'KpiManager::Report'
+
+    @@kpis = {}
+
+    def self.add(name, label, options = nil, &block)
+      options ||= {}
+      dataset = options[:dataset]
+      b = block
+      raise 'No dataset to work against' unless dataset
+      KpiManager::Report.class_eval do
+        define_method(name) do |dataset_p, **refs|
+          b.call(dataset_p, refs)
+        end
+      end
+      @@kpis[name] = { dataset: dataset, label: label, options: options }
+    end
+  end
+end

data/lib/kpi_manager/report.rb

@@ -0,0 +1,58 @@
+module KpiManager
+  # Allow to manipulate recurrent reports
+  class Report < ActiveRecord::Base
+    has_many :kpis, class_name: 'KpiManager::Kpi'
+
+    after_initialize :initialize_instance_vars
+
+    def generate(from, to = nil)
+      @from = from
+      @to = to || Time.zone.now
+      @report = []
+
+      registered_kpis.each do |kpi_name, kpi_data|
+        @report << [
+          kpi_data[:label],
+          send(
+            kpi_name,
+            get_dataset(kpi_data[:dataset]),
+            references(kpi_data[:options])
+          )
+        ]
+      end
+
+      @report
+    end
+
+    private
+
+    def initialize_instance_vars(_attributes = {}, options = {})
+      @options = options
+      @datacache = {}
+    end
+
+    def references(kpi_options)
+      refs = {}
+      kpi_options[:references] ||= []
+      kpi_options[:references].each do |kpi_name|
+        kpi = registered_kpis[kpi_name]
+        refs[kpi_name] = send(
+          kpi_name,
+          get_dataset(kpi[:dataset]),
+          references(kpi[:options])
+        )
+      end
+      refs
+    end
+
+    def get_dataset(name)
+      @datacache[name] ||= send(name, @from, @to)
+    end
+
+    def registered_kpis
+      all_kpis = KpiManager::Kpi.class_variable_get(:@@kpis)
+      authorized = kpis.pluck(:slug).map(&:to_sym)
+      all_kpis.select { |kpi_name, _kpi_data| authorized.include?(kpi_name) }
+    end
+  end
+end

data/lib/kpi_manager/version.rb

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

data/lib/kpi_manager.rb

@@ -0,0 +1,11 @@
+require 'kpi_manager/engine'
+
+module KpiManager # :nodoc:
+end
+
+require 'kpi_manager/dataset'
+require 'kpi_manager/kpi'
+require 'kpi_manager/report'
+
+require 'rails/generators'
+require 'kpi_manager/generators/kpi_manager_generator'

data/lib/tasks/kpi_manager_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :kpi_manager do
+#   # Task goes here
+# end

data/spec/rails_helper.rb

@@ -0,0 +1,15 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../test_app/config/environment', __FILE__)
+
+abort('Running in production mode!') if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+RSpec.configure do |config|
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+end

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/models/car.rb

@@ -0,0 +1,4 @@
+class Car < ActiveRecord::Base
+  has_many :orders
+  has_many :users, through: :orders
+end

data/spec/test_app/app/models/order.rb

@@ -0,0 +1,5 @@
+class Order < ActiveRecord::Base
+  belongs_to :car
+  belongs_to :user
+  belongs_to :promotion
+end

data/spec/test_app/app/models/promotion.rb

@@ -0,0 +1,5 @@
+class Promotion < ActiveRecord::Base
+  def calculate_from(base_price)
+    base_price - (base_price / 100 * percentage)
+  end
+end

data/spec/test_app/app/models/user.rb

@@ -0,0 +1,15 @@
+class User < ActiveRecord::Base
+  has_many :orders
+  has_many :cars, through: :orders
+
+  scope :active, -> { where(enabled: true) }
+
+  def buy_car(car, promotion = nil)
+    order = orders.new(
+      car: car,
+      promotion: promotion
+    )
+    order.paid_price = promotion ? promotion.calculate_from(car.price) : car.price
+    order.save
+  end
+end

data/spec/test_app/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require 'kpi_manager'
+
+module TestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/test_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/test_app/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/test_app/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/test_app/config/environments/test.rb

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

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

@@ -0,0 +1,11 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

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

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

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

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

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

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

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

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

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

@@ -0,0 +1,21 @@
+# Datasets
+KpiManager::Dataset.add(:subscribers) do |from, to|
+  User.where(created_at: (from..to))
+end
+
+KpiManager::Dataset.add(:bills) do |from, to|
+  Order.where(created_at: (from..to))
+end
+
+# KPIs
+KpiManager::Kpi.add(:users_count, 'Subscribed users', dataset: :subscribers) do |dataset|
+  dataset.count
+end
+
+KpiManager::Kpi.add(:total_earned, 'Total earned', dataset: :bills) do |dataset|
+  dataset.to_a.inject(0) { |acc, elem| acc + elem.paid_price }
+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

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

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

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

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_test_app_session'

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

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/spec/test_app/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount KpiManager::Engine => '/kpi_manager'
+end

data/spec/test_app/db/migrate/20170116133339_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :firstname
+      t.string :lastname
+      t.string :email
+      t.date :birthdate
+      t.boolean :enabled, default: :true
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116133440_create_cars.rb

@@ -0,0 +1,11 @@
+class CreateCars < ActiveRecord::Migration
+  def change
+    create_table :cars do |t|
+      t.string :brand
+      t.string :model
+      t.float :price
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116133459_create_promotion.rb

@@ -0,0 +1,7 @@
+class CreatePromotion < ActiveRecord::Migration
+  def change
+    create_table :promotions do |t|
+      t.integer :percentage
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116133513_create_orders.rb

@@ -0,0 +1,12 @@
+class CreateOrders < ActiveRecord::Migration
+  def change
+    create_table :orders do |t|
+      t.references :car
+      t.references :user
+      t.references :promotion
+      t.float :paid_price
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116205700_create_kpi_manager_dashboard.rb

@@ -0,0 +1,10 @@
+class CreateKpiManagerDashboard < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_dashboards do |t|
+      t.string :name
+      t.string :slug
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116205701_create_kpi_manager_report.rb

@@ -0,0 +1,11 @@
+class CreateKpiManagerReport < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_reports do |t|
+      t.string :name
+      # TODO: handle recurrency
+      # TODO: handle multiple recipients
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170116205702_create_kpi_manager_kpi.rb

@@ -0,0 +1,8 @@
+class CreateKpiManagerKpi < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :kpi_manager_kpis do |t|
+      t.string :slug
+      t.references :report
+    end
+  end
+end

data/spec/test_app/db/schema.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20_170_116_205_702) do
+  create_table 'cars', force: :cascade do |t|
+    t.string   'brand'
+    t.string   'model'
+    t.float    'price'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+  end
+
+  create_table 'kpi_manager_dashboards', force: :cascade do |t|
+    t.string   'name'
+    t.string   'slug'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+  end
+
+  create_table 'kpi_manager_kpis', force: :cascade do |t|
+    t.string  'slug'
+    t.integer 'report_id'
+  end
+
+  create_table 'kpi_manager_reports', force: :cascade do |t|
+    t.string   'name'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+  end
+
+  create_table 'orders', force: :cascade do |t|
+    t.integer  'car_id'
+    t.integer  'user_id'
+    t.integer  'promotion_id'
+    t.float    'paid_price'
+    t.datetime 'created_at',   null: false
+    t.datetime 'updated_at',   null: false
+  end
+
+  create_table 'promotions', force: :cascade do |t|
+    t.integer 'percentage'
+  end
+
+  create_table 'users', force: :cascade do |t|
+    t.string   'firstname'
+    t.string   'lastname'
+    t.string   'email'
+    t.date     'birthdate'
+    t.boolean  'enabled', default: true
+    t.datetime 'created_at',                null: false
+    t.datetime 'updated_at',                null: false
+  end
+end

data/spec/test_app/spec/kpi_manager_spec.rb

@@ -0,0 +1,37 @@
+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')
+    expectancy = [
+      ["Subscribed users", 2],
+      ["Total earned", 21140.9],
+      ["Average order", 10570.45]
+    ]
+    expect(report.generate(Date.yesterday)).to eql(expectancy)
+  end
+end

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: kpi_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Hugo Chevalier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+description: Description of KpiManager.
+email:
+- drakhaine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/kpi_manager/application.js
+- app/assets/stylesheets/kpi_manager/application.css
+- app/controllers/kpi_manager/application_controller.rb
+- app/helpers/kpi_manager/application_helper.rb
+- 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/version.rb
+- lib/tasks/kpi_manager_tasks.rake
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/test_app/app/controllers/application_controller.rb
+- spec/test_app/app/helpers/application_helper.rb
+- spec/test_app/app/models/car.rb
+- spec/test_app/app/models/order.rb
+- spec/test_app/app/models/promotion.rb
+- spec/test_app/app/models/user.rb
+- spec/test_app/config/application.rb
+- spec/test_app/config/boot.rb
+- spec/test_app/config/environment.rb
+- spec/test_app/config/environments/development.rb
+- spec/test_app/config/environments/production.rb
+- spec/test_app/config/environments/test.rb
+- spec/test_app/config/initializers/assets.rb
+- spec/test_app/config/initializers/backtrace_silencers.rb
+- spec/test_app/config/initializers/cookies_serializer.rb
+- spec/test_app/config/initializers/filter_parameter_logging.rb
+- spec/test_app/config/initializers/inflections.rb
+- spec/test_app/config/initializers/kpi_manager.rb
+- spec/test_app/config/initializers/mime_types.rb
+- spec/test_app/config/initializers/session_store.rb
+- spec/test_app/config/initializers/wrap_parameters.rb
+- spec/test_app/config/routes.rb
+- spec/test_app/db/migrate/20170116133339_create_users.rb
+- spec/test_app/db/migrate/20170116133440_create_cars.rb
+- spec/test_app/db/migrate/20170116133459_create_promotion.rb
+- spec/test_app/db/migrate/20170116133513_create_orders.rb
+- spec/test_app/db/migrate/20170116205700_create_kpi_manager_dashboard.rb
+- 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/kpi_manager_spec.rb
+homepage: https://rubygems.org/kpi_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Summary of KpiManager.
+test_files:
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/test_app/app/controllers/application_controller.rb
+- spec/test_app/app/helpers/application_helper.rb
+- spec/test_app/app/models/car.rb
+- spec/test_app/app/models/order.rb
+- spec/test_app/app/models/promotion.rb
+- spec/test_app/app/models/user.rb
+- spec/test_app/config/application.rb
+- spec/test_app/config/boot.rb
+- spec/test_app/config/environment.rb
+- spec/test_app/config/environments/development.rb
+- spec/test_app/config/environments/production.rb
+- spec/test_app/config/environments/test.rb
+- spec/test_app/config/initializers/assets.rb
+- spec/test_app/config/initializers/backtrace_silencers.rb
+- spec/test_app/config/initializers/cookies_serializer.rb
+- spec/test_app/config/initializers/filter_parameter_logging.rb
+- spec/test_app/config/initializers/inflections.rb
+- spec/test_app/config/initializers/kpi_manager.rb
+- spec/test_app/config/initializers/mime_types.rb
+- spec/test_app/config/initializers/session_store.rb
+- spec/test_app/config/initializers/wrap_parameters.rb
+- spec/test_app/config/routes.rb
+- spec/test_app/db/migrate/20170116133339_create_users.rb
+- spec/test_app/db/migrate/20170116133440_create_cars.rb
+- spec/test_app/db/migrate/20170116133459_create_promotion.rb
+- spec/test_app/db/migrate/20170116133513_create_orders.rb
+- spec/test_app/db/migrate/20170116205700_create_kpi_manager_dashboard.rb
+- 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/kpi_manager_spec.rb