(feature): TPI (sectors, companies) controllers, chart API & views

Gemfile

@@ -30,6 +30,9 @@ gem 'language_list'
 gem 'simplecov', require: false, group: :test
 gem 'dotenv-rails'
 
+# TPI
+gem 'chartkick'
+
 group :development, :test do
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
   gem 'capybara'

Gemfile.lock

@@ -145,6 +145,7 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (~> 1.5)
       xpath (~> 3.2)
+    chartkick (3.2.1)
     concurrent-ruby (1.1.5)
     crass (1.0.4)
     declarative (0.0.10)
@@ -468,6 +469,7 @@ DEPENDENCIES
   capistrano-rvm
   capistrano-yarn
   capybara
+  chartkick
   climate_watch_engine (~> 1.4.3)!
   devise (>= 4.7.1)
   discard

app/admin/cp_assessments.rb

@@ -34,6 +34,7 @@
 
   index do
     column :title, &:title_link
+    column :company
     column :assessment_date
     column :publication_date
     actions

app/assets/javascripts/application.js

@@ -13,4 +13,6 @@
 //= require rails-ujs
 //= require activestorage
 //= require turbolinks
+//= require chartkick
+//= require highcharts
 //= require_tree .

app/assets/stylesheets/tpi.scss

@@ -0,0 +1,19 @@
+.container {
+  display: flex;
+  flex-direction: row;
+  justify-content: center;
+  gap: 5px;
+}
+
+container-columns {
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  gap: 5px;
+}
+
+.chart {
+  display: flex;
+  flex-flow: row wrap;
+  justify-content: center;
+}

app/controllers/tpi/companies_controller.rb

@@ -0,0 +1,21 @@
+module Tpi
+  class CompaniesController < ApplicationController
+    def show
+      @company = Company.find(params[:id])
+
+      @company_details = ::Api::Presenters::Company.new(@company).company_details
+    end
+
+    # Data:     Company emissions
+    # Section:  CP
+    # Type:     line chart
+    # On pages: :show
+    def emissions_chart_data
+      @company = Company.find(params[:id])
+
+      data = ::Api::Charts::Company.new(@company).emissions_data
+
+      render json: data.chart_json
+    end
+  end
+end

app/controllers/tpi/sectors_controller.rb

@@ -0,0 +1,56 @@
+module Tpi
+  class SectorsController < ApplicationController
+    def index
+      @sectors_names = Sector.order(:name).pluck(:id, :name)
+      @companies_names = Company.limit(50).pluck(:id, :name)
+    end
+
+    def show
+      @sector = Sector.find(params[:id])
+
+      @companies_by_levels = ::Api::Charts::Sector.new(companies_scope(params)).companies_summaries_by_level
+    end
+
+    # Chart data endpoints
+
+    # Data:     Sectors Companies number, grouped by Levels
+    # Section:  MQ
+    # Type:     pie chart
+    # On pages: :index, :show
+    def levels_chart_data
+      data = ::Api::Charts::Sector.new(companies_scope(params)).companies_count_by_level
+
+      render json: data.chart_json
+    end
+
+    # Data:     Companies emissions
+    # Section:  CP
+    # Type:     line chart
+    # On pages: :show
+    def emissions_chart_data
+      data = ::Api::Charts::Sector.new(companies_scope(params)).companies_emissions_data
+
+      render json: data.chart_json
+    end
+
+    # Data:     Sector Companies numbers, grouped by CP Benchmarks from given Sector
+    # Section:  CP
+    # Type:     column chart
+    # On pages: :index
+    def benchmarks_chart_data
+      data = ::Api::Charts::CPBenchmark.new.cp_performance_data
+
+      render json: data.chart_json
+    end
+
+    private
+
+    def companies_scope(params)
+      if params[:id]
+        Sector.find(params[:id]).companies
+      else
+        Company
+      end
+    end
+  end
+end

app/helpers/chart_helper.rb

@@ -0,0 +1,34 @@
+module ChartHelper
+  # defaults chart options (Highcharts)
+  def default_chart_options
+    {
+      legend: {
+        verticalAlign: 'top'
+      },
+      plotOptions: {
+        area: {
+          fillOpacity: 0.3,
+          marker: {
+            enabled: false
+          }
+        },
+        column: {
+          stacking: 'percent'
+        }
+      }
+    }
+  end
+
+  def mq_sector_pie_chart_options
+    {
+      tooltip: {enabled: false},
+      plotOptions: {
+        pie: {
+          dataLabels: {
+            format: 'Level {point.name} <br> {point.y} companies <br> {point.percentage:.1f}%'
+          }
+        }
+      }
+    }
+  end
+end

app/models/company.rb

@@ -43,11 +43,48 @@ class Company < ApplicationRecord
   validates_presence_of :name, :slug, :isin, :size
   validates_uniqueness_of :slug, :isin, :name
 
+  def to_s
+    name
+  end
+
   def latest_mq_assessment
     mq_assessments.order(:assessment_date).last
   end
 
-  def to_s
-    name
+  def latest_cp_assessment
+    cp_assessments.order(:assessment_date).last
+  end
+
+  def latest_sector_benchmarks
+    sector.latest_released_benchmarks
+  end
+
+  # Returns sector CP benchmarks:
+  # - from the last date before latest CP::Assessment date
+  #   (if company latest CP::Assessment was after at least one benchmark)
+  # - from latest benchmarks otherwise
+  #
+  # @return [AssociationRelation [#<CP::Benchmark]
+  #
+  # @example Company has assessment:
+  # - benchmarks available for 04.2017 and 05.2018
+  # - if assessment date is 06.2018 - we take benchmarks from 05.2018
+  # - if assessment date is 06.2017 - we take benchmarks from 04.2017
+  def latest_sector_benchmarks_before_last_assessment
+    last_assessment_date = latest_cp_assessment&.assessment_date
+
+    return sector.latest_released_benchmarks unless last_assessment_date
+
+    sector_benchmarks_dates = sector.cp_benchmarks.pluck(:release_date).uniq.sort
+
+    last_release_date_before_assessment =
+      sector_benchmarks_dates
+        .select { |d| d < last_assessment_date }
+        .last
+
+    release_date =
+      last_release_date_before_assessment || sector_benchmarks_dates.last
+
+    sector.cp_benchmarks.where(release_date: release_date)
   end
 end

app/models/mq/assessment.rb

@@ -61,5 +61,9 @@ def questions=(value)
     def find_answer_by_key(key)
       questions.find { |q| q.key == key }.answer
     end
+
+    def questions_by_level
+      questions.group_by(&:level)
+    end
   end
 end

app/models/sector.rb

@@ -19,4 +19,8 @@ class Sector < ApplicationRecord
 
   validates_presence_of :name, :slug
   validates_uniqueness_of :name, :slug
+
+  def latest_released_benchmarks
+    cp_benchmarks.group_by(&:release_date).max&.last || []
+  end
 end

app/services/api/charts/company.rb

@@ -0,0 +1,104 @@
+module Api
+  module Charts
+    class Company
+      def initialize(company)
+        @company = company
+      end
+
+      # Returns array of following series:
+      # - company emissions
+      # - company's sector average emissions
+      # - company's sector CP benchmarks (scenarios)
+      #
+      # @return [Array]
+      # @example
+      #   [
+      #     { name: 'Air China',                   data: { '2014' => 111.0, '2015' => 112.0 } },
+      #
+      #     { name: 'Airlines sector mean',        data: { ... } },
+      #
+      #     { name: '2 Degrees (Shift-Improve)',   data: { ... } },
+      #     { name: '2 Degrees (High Efficiency)', data: { ... } },
+      #   ]
+      #
+      def emissions_data
+        [
+          emissions_data_from_company,
+          emissions_data_from_sector,
+          emissions_data_from_sector_benchmarks
+        ].flatten
+      end
+
+      private
+
+      def emissions_data_from_company
+        {
+          name: @company.name,
+          data: @company.latest_cp_assessment&.emissions
+        }
+      end
+
+      def emissions_data_from_sector
+        {
+          name: "#{@company.sector.name} sector mean",
+          data: sector_average_emissions
+        }
+      end
+
+      def emissions_data_from_sector_benchmarks
+        @company.latest_sector_benchmarks_before_last_assessment.map do |benchmark|
+          {
+            type: 'area',
+            fillOpacity: 0.1,
+            name: benchmark.scenario,
+            data: benchmark.emissions
+          }
+        end
+      end
+
+      # Returns average emissions history for given Sector.
+      # For each year, average value is calculated from all available
+      # companies emissions, up to last reported year.
+      #
+      # @example {'2014' => 111.0, '2015' => 112.0 }
+      #
+      def sector_average_emissions
+        years_with_reported_emissions
+          .map { |year| [year.to_s, sector_average_emission_for_year(year)] }
+          .to_h
+      end
+
+      # @return [Float] average emission from all Companies from single year
+      def sector_average_emission_for_year(year)
+        company_emissions = sector_all_emissions
+          .map { |emissions| emissions[year.to_s] }
+          .compact
+
+        (company_emissions.sum / company_emissions.count).round(2)
+      end
+
+      # @return [Array] of years for which emissions was reported
+      def years_with_reported_emissions
+        last_reported_year = Time.new.year
+
+        (sector_all_emission_years.min..last_reported_year).map.to_a
+      end
+
+      # @return [Array] unique array of years as numbers
+      def sector_all_emission_years
+        sector_all_emissions
+          .flat_map(&:keys)
+          .map(&:to_i)
+          .uniq
+      end
+
+      # @return [Array<Hash>] list of { year => value } pairs from all Companies from current Sector
+      def sector_all_emissions
+        @sector_all_emissions ||= @company.sector
+          .companies
+          .includes(:cp_assessments)
+          .flat_map { |c| c.latest_cp_assessment.emissions }
+      end
+    end
+  end
+end