solidus_admin_insights 2.1.0

data/app/reports/spree/product_views_to_cart_additions_report.rb

@@ -0,0 +1,53 @@
+module Spree
+  class ProductViewsToCartAdditionsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { product_name: :string, views: :integer, cart_additions: :integer, cart_to_view_ratio: :string }
+    SEARCH_ATTRIBUTES          = { start_date: :product_view_from, end_date: :product_view_till }
+    SORTABLE_ATTRIBUTES        = [:product_name, :views, :cart_additions]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :views, :cart_additions, :cart_to_view_ratio]
+
+        def cart_to_view_ratio
+          (cart_additions.to_f / views.to_f).round(2)
+        end
+      end
+    end
+
+    def report_query
+      cart_additions =
+        Spree::CartEvent
+          .added
+          .joins(:variant)
+          .joins(:product)
+          .where(created_at: reporting_period)
+          .group('spree_products.name', 'spree_products.slug')
+          .select(
+            'spree_products.name              as product_name',
+            'spree_products.slug              as product_slug',
+            'SUM(spree_cart_events.quantity)  as cart_additions'
+          )
+      total_views =
+        Spree::Product
+          .joins(:page_view_events)
+          .group(:name)
+          .select(
+            'spree_products.name  as product_name',
+            'COUNT(*)             as views'
+          )
+
+      Spree::Report::QueryFragments
+        .from_join(cart_additions, total_views, "q1.product_name = q2.product_name")
+        .project(
+          'q1.product_name',
+          'q1.product_slug',
+          'q2.views',
+          'q1.cart_additions'
+        )
+    end
+
+  end
+end

data/app/reports/spree/product_views_to_purchases_report.rb

@@ -0,0 +1,54 @@
+module Spree
+  class ProductViewsToPurchasesReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { product_name: :string, views: :integer, purchases: :integer, purchase_to_view_ratio: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :product_view_from, end_date: :product_view_till }
+    SORTABLE_ATTRIBUTES        = [:product_name, :views, :purchases]
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :views, :purchases, :purchase_to_view_ratio]
+
+        def purchase_to_view_ratio # This is inconsistent across postgres and mysql
+          (purchases.to_f / views.to_f).round(2)
+        end
+      end
+    end
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    def report_query
+      page_events_ar         = Arel::Table.new(:spree_page_events)
+      purchase_line_items_ar = Arel::Table.new(:purchase_line_items)
+
+      Spree::Report::QueryFragments.from_subquery(purchase_line_items, as: :purchase_line_items)
+        .join(page_events_ar)
+        .on(page_events_ar[:target_id].eq(purchase_line_items_ar[:product_id]))
+        .where(page_events_ar[:target_type].eq(Arel::Nodes::Quoted.new('Spree::Product')))
+        .where(page_events_ar[:activity].eq(Arel::Nodes::Quoted.new('view')))
+        .group(purchase_line_items_ar[:product_id], purchase_line_items_ar[:product_name],
+               purchase_line_items_ar[:product_slug], purchase_line_items_ar[:purchases])
+        .project(
+          'product_name',
+          'product_slug',
+          'COUNT(*) as views',
+          'purchases'
+        )
+    end
+
+    private def purchase_line_items
+      Spree::LineItem
+        .joins(:order)
+        .joins(:variant)
+        .joins(:product)
+        .where(spree_orders: { state: 'complete', created_at: reporting_period })
+        .group('spree_products.id', 'spree_products.name')
+        .select(
+          'SUM(quantity)        as purchases',
+          'spree_products.name  as product_name',
+          'spree_products.slug  as product_slug',
+          'spree_products.id    as product_id'
+        )
+    end
+  end
+end

data/app/reports/spree/promotional_cost_report.rb

@@ -0,0 +1,84 @@
+module Spree
+  class PromotionalCostReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :promotion_name
+    HEADERS                    = { promotion_name: :string, usage_count: :integer, promotion_discount: :integer, promotion_code: :string, promotion_start_date: :date, promotion_end_date: :date }
+    SEARCH_ATTRIBUTES          = { start_date: :promotion_created_from, end_date: :promotion_created_till }
+    SORTABLE_ATTRIBUTES        = [:promotion_name, :usage_count, :promotion_discount, :promotion_code, :promotion_start_date, :promotion_end_date]
+
+    class Result < Spree::Report::TimedResult
+      charts PromotionalCostChart, UsageCountChart
+
+      def build_empty_observations
+        super
+        @_promotions = @results.collect { |result| result['promotion_name'] }.uniq
+        @observations = @_promotions.collect do |promotion_name|
+          @observations.collect do |observation|
+            _d_observation = observation.dup
+            _d_observation.promotion_name = promotion_name
+            _d_observation.usage_count = 0
+            _d_observation
+          end
+        end.flatten
+      end
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields [
+          :promotion_name, :usage_count,
+          :promotion_discount, :promotion_code,
+          :promotion_start_date, :promotion_end_date
+        ]
+
+        def promotion_start_date
+          @promotion_start_date.present? ? @promotion_start_date.to_date.strftime("%B %d %Y") : "-"
+        end
+
+        def promotion_end_date
+          @promotion_end_date.present? ? @promotion_end_date.to_date.strftime("%B %d %Y") : "-"
+        end
+
+        def promotion_discount
+          @promotion_discount.to_f.abs
+        end
+
+        def describes?(result, time_scale)
+          result['promotion_name'] == promotion_name && super
+        end
+      end
+    end
+
+    def report_query
+      Spree::Report::QueryFragments
+        .from_subquery(eligible_promotions)
+        .group(*time_scale_columns, :promotion_id, :promotion_name,
+               :promotion_code, :promotion_start_date, :promotion_end_date)
+        .order(*time_scale_columns_to_s)
+        .project(
+          *time_scale_columns,
+          'promotion_name',
+          'promotion_code',
+          'promotion_start_date',
+          'promotion_end_date',
+          'SUM(promotion_discount)  as promotion_discount',
+          'COUNT(promotion_id)      as usage_count',
+          'promotion_id'
+        )
+    end
+
+    private def eligible_promotions
+      Spree::PromotionAction
+        .joins(:promotion)
+        .joins(:adjustment)
+        .where(spree_adjustments: { created_at: reporting_period })
+        .select(
+          'spree_promotions.starts_at   as promotion_start_date',
+          'spree_promotions.expires_at  as promotion_end_date',
+          'spree_adjustments.amount     as promotion_discount',
+          'spree_promotions.id          as promotion_id',
+          'spree_promotions.name        as promotion_name',
+          'spree_promotions.code        as promotion_code',
+          *time_scale_selects('spree_adjustments')
+        )
+    end
+
+  end
+end

data/app/reports/spree/promotional_cost_report/promotional_cost_chart.rb

@@ -0,0 +1,37 @@
+class Spree::PromotionalCostReport::PromotionalCostChart
+  attr_accessor :time, :series
+
+  def initialize(result)
+    @grouped_by_promotion = result.observations.group_by(&:promotion_name)
+    @time_dimension = result.time_dimension
+    self.time = []
+    self.time =   @grouped_by_promotion.values.first.collect { |observation_value| observation_value.send(@time_dimension) } if @grouped_by_promotion.first.present?
+    self.series = @grouped_by_promotion.collect { |promotion, values| { type: 'column', name: promotion, data: values.collect(&:promotion_discount) }  }
+  end
+
+  def to_h
+    {
+      id: 'promotional-cost',
+      json: {
+        chart: { type: 'column' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Promotional Cost</span><span class='fa fa-question-circle' data-toggle='tooltip' title=' Compare the costing for various promotions'></span>"
+        },
+        xAxis: { categories: time },
+        yAxis: {
+          title: { text: 'Value($)' }
+        },
+        tooltip: { valuePrefix: '$' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: series
+      }
+    }
+  end
+
+end

data/app/reports/spree/promotional_cost_report/usage_count_chart.rb

@@ -0,0 +1,41 @@
+class Spree::PromotionalCostReport::UsageCountChart
+
+  attr_accessor :time, :series
+
+  def initialize(result)
+    @grouped_by_promotion = result.observations.group_by(&:promotion_name)
+    @time_dimension = result.time_dimension
+    self.time = []
+    if @grouped_by_promotion.values.first.present?
+      self.time   = @grouped_by_promotion.values.first.collect { |observation_value| observation_value.send(@time_dimension) }
+    end
+    self.series = @grouped_by_promotion.collect { |promotion, values| { type: 'column', name: promotion, data: values.collect(&:usage_count) }  }
+  end
+
+
+  def to_h
+    {
+      id: 'promotion-usage-count',
+      json: {
+        chart: { type: 'spline' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Promotion Usage Count</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Compare the usage of individual promotions'></span>"
+        },
+        xAxis: { categories: time },
+        yAxis: {
+          title: { text: 'Count' }
+        },
+        tooltip: { valuePrefix: '#' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: series
+      }
+    }
+  end
+
+end

data/app/reports/spree/report.rb

@@ -0,0 +1,131 @@
+module Spree
+  class Report
+
+    attr_accessor :sortable_attribute, :sortable_type, :total_records,
+                  :records_per_page, :current_page, :paginate, :search, :reporting_period
+    alias_method  :sort_direction, :sortable_type
+    alias_method  :paginate?, :paginate
+
+
+    TIME_SCALES = [:hourly, :daily, :monthly, :yearly]
+
+    def paginated?
+      false
+    end
+
+    def pagination_required?
+      paginated? && paginate?
+    end
+
+    def deeplink_properties
+      {
+        deeplinked: false
+      }
+    end
+
+    def self.deeplink(template_for_headers = {})
+      define_method :deeplink_properties do
+        { deeplinked: true }.merge(template_for_headers)
+      end
+    end
+
+    def generate(options = {})
+      self.class::Result.new do |report|
+        report.start_date = @start_date
+        report.end_date   = @end_date
+        report.time_scale = @time_scale
+        report.report = self
+      end
+    end
+
+
+    def initialize(options)
+      self.search = options.fetch(:search, {})
+      self.records_per_page = options[:records_per_page]
+      self.current_page = options[:offset]
+      self.paginate = options[:paginate]
+      extract_reporting_period
+      determine_report_time_scale
+      if self.class::SORTABLE_ATTRIBUTES.present?
+        set_sortable_attributes(options, self.class::DEFAULT_SORTABLE_ATTRIBUTE)
+      end
+    end
+
+    def header_sorted?(header)
+      sortable_attribute.present? && sortable_attribute.eql?(header)
+    end
+
+    def get_results
+      query =
+        if pagination_required?
+          paginated_report_query
+        else
+          report_query
+        end
+
+      query = query.order(active_record_sort) if sortable_attribute.present?
+      query_sql = query.to_sql
+      r = ActiveRecord::Base.connection.exec_query(query_sql)
+    end
+
+    def set_sortable_attributes(options, default_sortable_attribute)
+      self.sortable_type ||= (options[:sort] && options[:sort][:type].eql?('desc')) ? :desc : :asc
+      self.sortable_attribute = options[:sort] ? options[:sort][:attribute].to_sym : default_sortable_attribute
+    end
+
+    def active_record_sort
+      "#{ sortable_attribute } #{ sortable_type }"
+    end
+
+    def total_records
+      ActiveRecord::Base.connection.select_value(record_count_query.to_sql)
+    end
+
+    def total_pages
+      if pagination_required?
+        total_pages = total_records / records_per_page
+        total_pages -= 1 if total_records % records_per_page == 0
+        total_pages
+      end
+    end
+
+    def time_scale_selects(time_scale_on = nil)
+      QueryTimeScale.select(@time_scale, time_scale_on)
+    end
+
+    def time_scale_columns
+      @_time_scale_columns ||= QueryTimeScale.time_scale_columns(@time_scale)
+    end
+
+    def time_scale_columns_to_s
+      @_time_scale_columns_to_s ||= time_scale_columns.collect(&:to_s)
+    end
+
+    def name
+      @_report_name ||= self.class.to_s.demodulize.underscore.gsub("_report", "")
+    end
+
+    private def extract_reporting_period
+      start_date = @search[:start_date]
+      @start_date = start_date.present? ? Date.parse(start_date) :  Date.current.beginning_of_year
+      end_date = @search[:end_date]
+      @end_date = (end_date.present? ? Date.parse(end_date).next_day : Date.current.end_of_year)
+      self.reporting_period = (@start_date.beginning_of_day)..(@end_date.end_of_day)
+    end
+
+    private def determine_report_time_scale
+      @time_scale =
+        case (@end_date - @start_date).to_i
+        when 0..1
+          :hourly
+        when 1..60
+          :daily
+        when 61..600
+          :monthly
+        else
+          :yearly
+        end
+    end
+
+  end
+end

data/app/reports/spree/report/chart.rb

@@ -0,0 +1,11 @@
+module Spree
+  class Report
+    module Chart
+      extend ActiveSupport::Concern
+
+      def chart_json
+        self.class::Chart.new(self, time_dimension).to_h
+      end
+    end
+  end
+end

data/app/reports/spree/report/configuration.rb

@@ -0,0 +1,40 @@
+class Spree::Report::Configuration
+  attr_accessor :default_report_category, :default_report
+  attr_reader :reports
+
+  def initialize
+    @reports = {}
+  end
+
+  def register_report_category(category)
+    @reports[category] = []
+  end
+
+  def register_report(category, report_name)
+    @reports[category] << report_name
+  end
+
+  def report_exists?(category, name)
+    @reports.key?(category) && @reports[category].include?(name)
+  end
+
+  def reports_for_category(category)
+    if category_exists? category
+      @reports[category]
+    else
+      []
+    end
+  end
+
+  def default_report_category
+    @default_report_category || @reports.keys.first
+  end
+
+  def default_report
+    @default_report || @reports[default_report_category].first
+  end
+
+  def category_exists?(category)
+    @reports.key? category
+  end
+end