analytics_plane 1.0.2

data/lib/analytics_plane/adapters/active_record/report_query.rb

@@ -0,0 +1,88 @@
+module AnalyticsPlane
+  module Adapters
+    module ActiveRecord
+      class ReportQuery
+        def self.add_select_clause(query, data_source, report_config)
+          fields = []
+          report_config['columns'].each do |column|
+            next unless column['selected']
+
+            if report_config['aggregated']
+              fields << column['name'] if column['group_by']
+              fields << "COUNT(#{column['name']}) AS 'num_#{column['name']}'" if column['count']
+              if column['count_distinct']
+                fields << "COUNT(DISTINCT #{column['name']}) AS 'num_uniq_#{column['name']}'"
+              end
+              if column['average']
+                if column['type'].in?(%w[date datetime])
+                  fields << "FROM_UNIXTIME(AVG(UNIX_TIMESTAMP(#{column['name']}))) AS 'avg_#{column['name']}'"
+                else
+                  fields << "AVG(#{column['name']}) AS 'avg_#{column['name']}'"
+                end
+              end
+              fields << "MIN(#{column['name']}) AS 'min_#{column['name']}'" if column['min']
+              fields << "MAX(#{column['name']}) AS 'max_#{column['name']}'" if column['max']
+              fields << "SUM(#{column['name']}) AS 'sum_#{column['name']}'" if column['sum']
+            else
+              fields << column['name']
+            end
+          end
+
+          fields = data_source.column_names if fields.empty?
+
+          query.select(fields)
+        end
+
+        def self.add_where_clause(query, report_config)
+          return query if report_config['filters'].blank?
+
+          report_config['filters'].each do |filter|
+            field = filter['name']
+            operator = filter['operator']
+            value = filter['value']
+
+            case operator
+            when '='
+              query = query.where(field => value)
+            when '!='
+              query = query.where.not(field => value)
+            when '>'
+              query = query.where("#{field} > ?", value)
+            when '>='
+              query = query.where("#{field} >= ?", value)
+            when '<'
+              query = query.where("#{field} < ?", value)
+            when '<='
+              query = query.where("#{field} <= ?", value)
+            when 'contains'
+              query = query.where("#{field} LIKE ?", "%#{value}%")
+            when 'starts_with'
+              query = query.where("#{field} LIKE ?", "#{value}%")
+            when 'ends_with'
+              query = query.where("#{field} LIKE ?", "%#{value}")
+            when 'one_of'
+              query = query.where("#{field} IN (?)", value)
+            when 'not_one_of'
+              query = query.where.not("#{field} IN (?)", value)
+            end
+          end
+
+          query
+        end
+
+        def self.add_group_clause(query, report_config)
+          return query unless report_config['aggregated']
+
+          group_fields = []
+          report_config['columns'].each do |column|
+            next unless column['selected'] && column['group_by']
+
+            group_fields << column['name']
+          end
+
+          query.group(group_fields)
+        end
+      end
+    end
+  end
+end

data/lib/analytics_plane/adapters/active_record_adapter.rb

@@ -0,0 +1,39 @@
+module AnalyticsPlane
+  module Adapters
+    class ActiveRecordAdapter
+      include AnalyticsPlane::Adapters::Base
+
+      def self.adapter_key
+        :active_record
+      end
+
+      def self.fetch_chart_data(data_source, chart)
+        chart_config = chart.configuration
+
+        query = data_source.all
+        query = AnalyticsPlane::Adapters::ActiveRecord::ChartQuery.add_select_clause(query, chart_config)
+        query = AnalyticsPlane::Adapters::ActiveRecord::ChartQuery.add_where_clause(query, chart_config)
+        query = AnalyticsPlane::Adapters::ActiveRecord::ChartQuery.add_group_clause(query, chart_config)
+        data = query.to_a
+
+        {
+          series: AnalyticsPlane::Adapters::ActiveRecord::ChartQuery.parse_series_data(data, chart_config),
+          categories: AnalyticsPlane::Adapters::ActiveRecord::ChartQuery.parse_category_data(data, chart_config, data_source),
+          meta: {
+            title: chart.name,
+            chart_type: chart_config['chart_type']
+          }
+        }
+      end
+
+      def self.fetch_report_data(data_source, report)
+        report_config = report.configuration
+
+        query = data_source.all
+        query = AnalyticsPlane::Adapters::ActiveRecord::ReportQuery.add_select_clause(query, data_source, report_config)
+        query = AnalyticsPlane::Adapters::ActiveRecord::ReportQuery.add_where_clause(query, report_config)
+        AnalyticsPlane::Adapters::ActiveRecord::ReportQuery.add_group_clause(query, report_config)
+      end
+    end
+  end
+end

data/lib/analytics_plane/adapters/base.rb

@@ -0,0 +1,21 @@
+module AnalyticsPlane
+  module Adapters
+    module Base
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def adapter_key
+          raise NotImplementedError
+        end
+
+        def fetch_chart_data(data_source, chart)
+          raise NotImplementedError
+        end
+
+        def fetch_report_data(data_source, report)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/analytics_plane/adapters/registry.rb

@@ -0,0 +1,23 @@
+module AnalyticsPlane
+  module Adapters
+    class Registry
+      mattr_accessor :adapters, default: {}
+
+      def self.register(klass)
+        key = klass.adapter_key.to_sym
+        raise "Duplicate dataset adapter key: #{key}" if @adapters.key?(key)
+        @adapters[key] = klass
+      end
+
+      def self.fetch(key)
+        @adapters.fetch(key.to_sym) do
+          raise KeyError, "Unknown dataset adapter: #{key}"
+        end
+      end
+
+      def self.clear!
+        @adapters = {}
+      end
+    end
+  end
+end

data/lib/analytics_plane/builders/chart_builder.rb

@@ -0,0 +1,65 @@
+module AnalyticsPlane
+  module Builders
+    class ChartBuilder
+      def self.build(chart)
+        data = fetch_data(chart)
+        parse_query_results(data)
+      end
+
+      def self.fetch_data(chart)
+        chart_config = chart.configuration || {}
+        dataset = Dataset.find(chart_config['dataset_id'])
+        AnalyticsPlane::Services::DatasetFetcher.fetch_chart_data(dataset, chart)
+      end
+
+      def self.parse_query_results(data)
+        {
+          'chart': {
+            'type': data[:meta][:chart_type]
+          },
+
+          'title': {
+            'text': data[:meta][:title]
+          },
+
+          'xAxis': {
+            'categories': data[:categories]
+          },
+
+          'yAxis': {
+            'title': {
+              'text': nil
+            }
+          },
+
+          'series': data[:series]
+        }
+      end
+
+      def self.build_csv(chart)
+        {
+          headers: csv_headers(chart),
+          rows: fetch_data(chart)
+        }
+      end
+
+      def self.csv_headers(chart)
+        chart_config = chart.configuration || {}
+
+        fields = []
+        fields << chart_config['x_axis']['attr']
+
+        chart_config['y_axes'].each do |column|
+          fields << "num_#{column['attr']}" if column['count']
+          fields << "num_uniq_#{column['attr']}" if column['count_distinct']
+          fields << "avg_#{column['attr']}" if column['average']
+          fields << "min_#{column['attr']}" if column['min']
+          fields << "max_#{column['attr']}" if column['max']
+          fields << "sum_#{column['attr']}" if column['sum']
+        end
+
+        fields
+      end
+    end
+  end
+end

data/lib/analytics_plane/builders/report_builder.rb

@@ -0,0 +1,50 @@
+module AnalyticsPlane
+  module Builders
+    class ReportBuilder
+      def self.build(report)
+        fetch_data(report)
+      end
+
+      def self.fetch_data(report)
+        report_config = report.configuration || {}
+        dataset = Dataset.find(report_config['dataset_id'])
+        AnalyticsPlane::Services::DatasetFetcher.fetch_report_data(dataset, report)
+      end
+
+      def self.build_csv(report)
+        {
+          headers: csv_headers(report),
+          rows: fetch_data(report)
+        }
+      end
+
+      def self.csv_headers(report)
+        report_config = report.configuration || {}
+
+        dataset = Dataset.find(report_config['dataset_id'])
+        dataset_class = AnalyticsPlane::Services::DatasetFetcher.fetch_report_data(dataset, report)
+
+        return dataset_class.column_names if report_config['columns'].blank?
+
+        fields = []
+        report_config['columns'].each do |column|
+          next unless column['selected']
+
+          if report_config['aggregated']
+            fields << column['name'] if column['group_by']
+            fields << "num_#{column['name']}" if column['count']
+            fields << "num_uniq_#{column['name']}" if column['count_distinct']
+            fields << "avg_#{column['name']}" if column['average']
+            fields << "min_#{column['name']}" if column['min']
+            fields << "max_#{column['name']}" if column['max']
+            fields << "sum_#{column['name']}" if column['sum']
+          else
+            fields << column['name']
+          end
+        end
+
+        fields
+      end
+    end
+  end
+end

data/lib/analytics_plane/data_sources/base.rb

@@ -0,0 +1,13 @@
+module AnalyticsPlane
+  module DataSources
+    module Base
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def dataset_key
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/analytics_plane/data_sources/registry.rb

@@ -0,0 +1,24 @@
+module AnalyticsPlane
+  module DataSources
+    class Registry
+      mattr_accessor :data_sources, default: {}
+
+      def self.register(klass)
+        key = klass.dataset_key.to_sym
+        raise "Duplicate dataset key: #{key}" if data_sources.key?(key)
+
+        @data_sources[key] = klass
+      end
+
+      def self.fetch(key)
+        @data_sources.fetch(key.to_sym) do
+          raise KeyError, "Unknown dataset: #{key}"
+        end
+      end
+
+      def self.clear!
+        @data_sources = {}
+      end
+    end
+  end
+end

data/lib/analytics_plane/railtie.rb

@@ -0,0 +1,10 @@
+module AnalyticsPlane
+  class Railtie < Rails::Railtie
+    initializer "analytics_plane.prepare" do
+      Rails.application.config.to_prepare do
+        AnalyticsPlane::DataSources::Registry.clear!
+        AnalyticsPlane::Adapters::Registry.clear!
+      end
+    end
+  end
+end

data/lib/analytics_plane/registrar.rb

@@ -0,0 +1,15 @@
+module AnalyticsPlane
+  module Registrar
+    def self.register(&block)
+      instance_eval(&block)
+    end
+
+    def self.data_source(klass)
+      AnalyticsPlane::DataSources::Registry.register(klass)
+    end
+
+    def self.adapter(klass)
+      AnalyticsPlane::Adapters::Registry.register(klass)
+    end
+  end
+end

data/lib/analytics_plane/services/dataset_fetcher.rb

@@ -0,0 +1,17 @@
+module AnalyticsPlane
+  module Services
+    class DatasetFetcher
+      def self.fetch_chart_data(dataset, chart)
+        adapter = AnalyticsPlane::Adapters::Registry.fetch(dataset.adapter)
+        data_source = AnalyticsPlane::DataSources::Registry.fetch(dataset.slug)
+        data = adapter.fetch_chart_data(data_source, chart)
+      end
+
+      def self.fetch_report_data(dataset, report)
+        adapter = AnalyticsPlane::Adapters::Registry.fetch(dataset.adapter)
+        data_source = AnalyticsPlane::DataSources::Registry.fetch(dataset.slug)
+        data = adapter.fetch_report_data(data_source, report)
+      end
+    end
+  end
+end

data/lib/analytics_plane/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AnalyticsPlane
+  VERSION = "1.0.2"
+end

data/lib/analytics_plane.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+require "rails"
+
+require_relative "analytics_plane/adapters/base"
+require_relative "analytics_plane/adapters/active_record/chart_query"
+require_relative "analytics_plane/adapters/active_record/report_query"
+require_relative "analytics_plane/adapters/active_record_adapter"
+require_relative "analytics_plane/adapters/registry"
+require_relative "analytics_plane/builders/chart_builder"
+require_relative "analytics_plane/builders/report_builder"
+require_relative "analytics_plane/data_sources/base"
+require_relative "analytics_plane/data_sources/registry"
+require_relative "analytics_plane/services/dataset_fetcher"
+require_relative "analytics_plane/registrar"
+require_relative "analytics_plane/version"
+require_relative "analytics_plane/railtie"
+
+module AnalyticsPlane
+  class Error < StandardError; end
+end

data/lib/generators/fios/chart/chart_generator.rb

@@ -0,0 +1,34 @@
+require "rails/generators"
+require "rails/generators/named_base"
+require "rails/generators/migration"
+
+module AnalyticsPlane
+  module Generators
+    class ChartGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a Chart model and migration for AnalyticsPlane"
+
+      def create_model
+        template "chart_model.rb", "app/models/#{file_name}.rb"
+      end
+
+      def create_chart_migration
+        migration_template(
+          "create_charts.rb",
+          "db/migrate/create_#{file_name.pluralize}.rb"
+        )
+      end
+
+      def self.next_migration_number(dirname)
+        if @next_migration_number
+          @next_migration_number += 1
+        else
+          @next_migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+      end
+    end
+  end
+end

data/lib/generators/fios/dashboard/dashboard_generator.rb

@@ -0,0 +1,41 @@
+require "rails/generators"
+require "rails/generators/named_base"
+require "rails/generators/migration"
+
+module AnalyticsPlane
+  module Generators
+    class DashboardGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a Dashboard model, Dashboard Widget model, and migrations for AnalyticsPlane"
+
+      def create_dashboard_model
+        template "dashboard_model.rb", "app/models/#{file_name}.rb"
+      end
+
+      def create_widget_model
+        template "dashboard_widget_model.rb", "app/models/#{file_name}_widget.rb"
+      end
+
+      def create_dashboard_migration
+        migration_template(
+          "create_dashboards.rb",
+          "db/migrate/create_#{file_name.pluralize}.rb"
+        )
+      end
+
+      def create_widget_migration
+        migration_template(
+          "create_dashboard_widgets.rb",
+          "db/migrate/create_#{file_name.pluralize}_widget.rb"
+        )
+      end
+
+      def self.next_migration_number(dirname)
+        @next_migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

data/lib/generators/fios/data_source/data_source_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+require "rails/generators/named_base"
+
+module AnalyticsPlane
+  module Generators
+    class DataSourceGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a AnalyticsPlane data source"
+
+      def create_data_source
+        template "data_source.rb", "app/datasets/#{file_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/fios/dataset/dataset_generator.rb

@@ -0,0 +1,34 @@
+require "rails/generators"
+require "rails/generators/named_base"
+require "rails/generators/migration"
+
+module AnalyticsPlane
+  module Generators
+    class DatasetGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a Dataset model and migration for AnalyticsPlane"
+
+      def create_dataset
+        template "dataset_model.rb", "app/models/#{file_name}.rb"
+      end
+
+      def create_dataset_migration
+        migration_template(
+          "create_datasets.rb",
+          "db/migrate/create_#{file_name.pluralize}.rb"
+        )
+      end
+
+      def self.next_migration_number(dirname)
+        if @next_migration_number
+          @next_migration_number += 1
+        else
+          @next_migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+      end
+    end
+  end
+end

data/lib/generators/fios/install/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module AnalyticsPlane
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Installs AnalyticsPlane and creates the initializer"
+
+      def create_initializer
+        template "analytics_plane_initializer.rb", "config/initializers/analytics_plane.rb"
+      end
+    end
+  end
+end

data/lib/generators/fios/report/report_generator.rb

@@ -0,0 +1,34 @@
+require "rails/generators"
+require "rails/generators/named_base"
+require "rails/generators/migration"
+
+module AnalyticsPlane
+  module Generators
+    class ReportGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a Report model and migration for AnalyticsPlane"
+
+      def create_model
+        template "report_model.rb", "app/models/#{file_name}.rb"
+      end
+
+      def create_report_migration
+        migration_template(
+          "create_reports.rb",
+          "db/migrate/create_#{file_name.pluralize}.rb"
+        )
+      end
+
+      def self.next_migration_number(dirname)
+        if @next_migration_number
+          @next_migration_number += 1
+        else
+          @next_migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+      end
+    end
+  end
+end

data/lib/generators/fios/templates/analytics_plane_initializer.rb

@@ -0,0 +1,6 @@
+Rails.application.config.to_prepare do
+  AnalyticsPlane::Registrar.register do
+    # adapter AnalyticsPlane::Adapters::ActiveRecordAdapter
+    # data_source EmployeesDataSource
+  end
+end

data/lib/generators/fios/templates/chart_model.rb

@@ -0,0 +1,5 @@
+class <%= class_name %> < ApplicationRecord
+  store_accessor :configuration, :chart_type, :dataset_id, :x_axis, :y_axes, :filters
+
+  validates :name, presence: true, uniqueness: true
+end

data/lib/generators/fios/templates/create_charts.rb

@@ -0,0 +1,9 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :name, null: false
+      t.json :configuration, null: false, default: {}
+      t.timestamps
+    end
+  end
+end

data/lib/generators/fios/templates/create_dashboard_widgets.rb

@@ -0,0 +1,9 @@
+class Create<%= class_name %>Widgets < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= file_name %>_widgets do |t|
+      t.references :dashboard, foreign_key: true
+      t.json :layout, null: false, default: {}
+      t.timestamps
+    end
+  end
+end

data/lib/generators/fios/templates/create_dashboards.rb

@@ -0,0 +1,8 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/lib/generators/fios/templates/create_datasets.rb

@@ -0,0 +1,11 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :slug, null: false
+      t.string :name, null: false
+      t.text :description
+      t.string :adapter, null: false
+      t.timestamps
+    end
+  end
+end

data/lib/generators/fios/templates/create_reports.rb

@@ -0,0 +1,9 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :name, null: false
+      t.json :configuration, null: false, default: {}
+      t.timestamps
+    end
+  end
+end

data/lib/generators/fios/templates/dashboard_model.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < ApplicationRecord
+  has_many :dashboard_widgets, dependent: :destroy
+
+  accepts_nested_attributes_for :dashboard_widgets, allow_destroy: true
+
+  validates :name, presence: true, uniqueness: true
+end

data/lib/generators/fios/templates/dashboard_widget_model.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Widget < ApplicationRecord
+  store_accessor :layout, :pos_x, :pos_y, :width, :height
+
+  belongs_to :dashboard
+end