solidus_admin_insights 2.1.0

data/app/reports/spree/sales_performance_report/profit_loss_chart.rb

@@ -0,0 +1,37 @@
+class Spree::SalesPerformanceReport::ProfitLossChart
+  def initialize(result)
+    time_dim = result.time_dimension
+    @time_series = result.observations.collect(&time_dim)
+    @data = result.observations.collect(&:profit_loss)
+  end
+
+  def to_h
+    {
+      id: 'profit-loss',
+      json: {
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Profit/Loss</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Track the profit or loss value'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'Value($)' }
+        },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: [
+          {
+            name: 'Profit Loss',
+            tooltip: { valuePrefix: '$' },
+            data: @data
+          }
+        ]
+      }
+    }
+
+  end
+end

data/app/reports/spree/sales_performance_report/profit_loss_percent_chart.rb

@@ -0,0 +1,36 @@
+class Spree::SalesPerformanceReport::ProfitLossPercentChart
+  def initialize(result)
+    time_dim = result.time_dimension
+    @time_series = result.observations.collect(&time_dim)
+    @data = result.observations.collect(&:profit_loss_percent)
+  end
+
+  def to_h
+    {
+      id: 'profit-loss-percent',
+      json: {
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Profit/Loss %</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Track the profit or loss %age to create a projection'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'Percentage(%)' }
+        },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: [
+          {
+            name: 'Profit Loss Percent(%)',
+            tooltip: { valueSuffix: '%' },
+            data: @data
+          }
+        ]
+      }
+    }
+  end
+end

data/app/reports/spree/sales_performance_report/sale_cost_price_chart.rb

@@ -0,0 +1,48 @@
+class Spree::SalesPerformanceReport::SaleCostPriceChart
+  def initialize(result)
+    time_dim = result.time_dimension
+    @time_series = result.observations.collect(&time_dim)
+    @sale_price = result.observations.collect(&:sale_price)
+    @cost_price = result.observations.collect(&:cost_price)
+    @promotion_discount = result.observations.collect(&:promotion_discount)
+  end
+
+  def to_h
+    {
+      id: 'sale-price',
+      json: {
+        chart: { type: 'column' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Sales Performance %</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Compare the Selling price, cost price and promotional cost over a period of time'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'Value($)' }
+        },
+        tooltip: { valuePrefix: '$' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: [
+          {
+            name: 'Sale Price',
+            data: @sale_price
+          },
+          {
+            name: 'Cost Price',
+            data: @cost_price
+          },
+          {
+            name: 'Promotional Cost',
+            data: @promotion_discount
+          }
+        ]
+      }
+    }
+
+  end
+end

data/app/reports/spree/sales_tax_report.rb

@@ -0,0 +1,64 @@
+module Spree
+  class SalesTaxReport < Spree::Report
+    HEADERS             = { zone_name: :string, sales_tax: :integer }
+    SEARCH_ATTRIBUTES   = { start_date: :taxation_from, end_date: :taxation_till }
+    SORTABLE_ATTRIBUTES = []
+
+    class Result < Spree::Report::TimedResult
+      charts MonthlySalesTaxComparisonChart
+
+      def build_empty_observations
+        super
+        @_zones = @results.collect { |r| r['zone_name'] }.uniq
+        @observations = @_zones.collect do |zone|
+          @observations.collect do |observation|
+            _d_observation = observation.dup
+            _d_observation.zone_name = zone
+            _d_observation.sales_tax = 0
+            _d_observation
+          end
+        end.flatten
+      end
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields [:zone_name, :sales_tax]
+
+        def describes?(result, time_scale)
+          (zone_name == result['zone_name']) && super
+        end
+
+        def sales_tax
+          @sales_tax.to_f
+        end
+      end
+    end
+
+
+    def report_query
+      Spree::Report::QueryFragments
+        .from_subquery(tax_adjustments)
+        .group(*time_scale_columns_to_s, 'zone_name')
+        .order(*time_scale_columns)
+        .project(
+          'zone_name',
+          *time_scale_columns,
+          'SUM(sales_tax) as sales_tax'
+        )
+    end
+
+    private def tax_adjustments
+      Spree::TaxRate
+        .joins(:adjustments)
+        .joins(:zone)
+        .where(spree_adjustments: { adjustable_type: 'Spree::LineItem' } )
+        .where(spree_adjustments: { created_at: reporting_period })
+        .select(
+          'spree_adjustments.amount  as sales_tax',
+          'spree_zones.id            as zone_id',
+          'spree_zones.name          as zone_name',
+          *time_scale_selects('spree_adjustments')
+        )
+    end
+
+  end
+end

data/app/reports/spree/sales_tax_report/monthly_sales_tax_comparison_chart.rb

@@ -0,0 +1,39 @@
+class Spree::SalesTaxReport::MonthlySalesTaxComparisonChart
+  def initialize(result)
+    @time_dimension = result.time_dimension
+    @grouped_by_zone_name = result.observations.group_by(&:zone_name)
+    @time_series = []
+    if @grouped_by_zone_name.first.present?
+      @time_series = @grouped_by_zone_name.values.first.collect { |observation| observation.send(@time_dimension) }
+    end
+    @chart_series = @grouped_by_zone_name.map { |zone_name, observations| { type: 'column', name: zone_name, data: observations.collect(&:sales_tax) } }
+  end
+
+  def to_h
+    {
+      id: 'sale-tax',
+      json: {
+        chart: { type: 'column' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Monthly Sales Tax Comparison</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Compare the Sales tax collected from different Zones'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'Value($)' }
+        },
+        tooltip: { valuePrefix: '$' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: @chart_series
+      }
+    }
+
+  end
+
+
+end

data/app/reports/spree/shipping_cost_report.rb

@@ -0,0 +1,89 @@
+module Spree
+  class ShippingCostReport < Spree::Report
+    HEADERS             = { name: :string, shipping_charge: :integer, revenue: :integer, shipping_cost_percentage: :integer }
+    SEARCH_ATTRIBUTES   = { start_date: :start_date, end_date: :end_date }
+    SORTABLE_ATTRIBUTES = []
+
+    class Result < Spree::Report::TimedResult
+      charts ShippingCostDistributionChart
+
+      def build_empty_observations
+        super
+        @_shipping_methods = @results.collect { |r| r['name'] }.uniq
+        @observations = @_shipping_methods.collect do |shipping_method|
+          @observations.collect do |observation|
+            _d_observation                          = observation.dup
+            _d_observation.name                     = shipping_method
+            _d_observation.revenue                  = 0
+            _d_observation.shipping_charge          = 0
+            _d_observation.shipping_cost_percentage = 0
+            _d_observation
+          end
+        end.flatten
+      end
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields [:name, :shipping_charge, :revenue, :shipping_cost_percentage]
+
+        def describes?(result, time_scale)
+          (name = result['name']) && super
+        end
+
+        def shipping_cost_percentage
+          ((@shipping_charge.to_f * 100) / @revenue.to_f).round(2)
+        end
+      end
+    end
+
+    def report_query
+      ar_shipping_methods = Arel::Table.new(:spree_shipping_methods)
+      ar_subquery_with_rates = Arel::Table.new(:shipment_with_rates)
+
+      Spree::Report::QueryFragments
+        .from_subquery(shipment_with_rates, as: 'shipment_with_rates')
+        .join(ar_shipping_methods)
+        .on(ar_shipping_methods[:id].eq(ar_subquery_with_rates[:shipping_method_id]))
+        .project(
+          *time_scale_columns,
+          ar_shipping_methods[:id],
+          'revenue',
+          'shipping_charge',
+          'shipping_method_id',
+          'name'
+        )
+    end
+
+    private def order_with_shipments
+      Spree::Order
+        .where.not(completed_at: nil)
+        .where(completed_at: reporting_period)
+        .joins(:shipments)
+        .select(
+          'spree_shipments.id           as shipment_id',
+          'spree_orders.shipment_total  as shipping_charge',
+          'spree_orders.id              as order_id',
+          'spree_orders.total           as order_total',
+          *time_scale_selects('spree_orders')
+        )
+    end
+
+    private def shipment_with_rates
+      ar_shipping_rates = Arel::Table.new(:spree_shipping_rates)
+      ar_subquery       = Arel::Table.new(:results)
+
+      Spree::Report::QueryFragments.from_subquery(order_with_shipments)
+        .join(ar_shipping_rates)
+        .on(ar_shipping_rates[:shipment_id].eq(ar_subquery[:shipment_id]))
+        .where(ar_shipping_rates[:selected].eq(Arel::Nodes::Quoted.new(true)))
+        .group(*time_scale_columns, :shipping_method_id)
+        .order(*time_scale_columns)
+        .project(
+          *time_scale_columns,
+          'shipping_method_id',
+          'SUM(shipping_charge)  as shipping_charge',
+          'SUM(order_total)      as revenue'
+        )
+    end
+
+  end
+end

data/app/reports/spree/shipping_cost_report/shipping_cost_distribution_chart.rb

@@ -0,0 +1,38 @@
+class Spree::ShippingCostReport::ShippingCostDistributionChart
+
+
+  def initialize(result)
+    time_dimension = result.time_dimension
+    @grouped_by_shipping_method = result.observations.group_by(&:name)
+    @time_series = []
+    @time_series = @grouped_by_shipping_method.values.first.collect { |observation_value| observation_value.send(time_dimension) } if @grouped_by_shipping_method.first.present?
+    @result_series = @grouped_by_shipping_method.collect { |name, observations| { name: name, data: observations.collect(&:shipping_cost_percentage) } }
+  end
+
+  def to_h
+    {
+      id: 'shipping-cost-percentage-comparison',
+      json: {
+        chart: { type: 'spline' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Monthly Shipping Comparison</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Compare the Shipping percentage (calculated on Revenue) among various shipment methods such as UPS, FedEx etc.'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'Percentage(%)' }
+        },
+        tooltip: { valueSuffix: '%' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: @result_series
+      }
+    }
+
+  end
+
+end

data/app/reports/spree/trending_search_report.rb

@@ -0,0 +1,50 @@
+module Spree
+  class TrendingSearchReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :occurrences
+    HEADERS                    = { searched_term: :string, occurrences: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :start_date, end_date: :end_date, keywords_cont: :keyword }
+    SORTABLE_ATTRIBUTES        = [:occurrences]
+
+    def paginated?
+      true
+    end
+
+    class Result < Spree::Report::Result
+      charts FrequencyDistributionPieChart
+
+      class Observation < Spree::Report::Observation
+        observation_fields [:searched_term, :occurrences]
+      end
+    end
+
+    deeplink searched_term: { template: %Q{<a href='/products?utf8=%E2%9C%93&keywords={%# o['searched_term'] %}' target="_blank">{%# o['searched_term'] %}</a>} }
+
+    def paginated_report_query
+      report_query
+        .take(records_per_page)
+        .skip(current_page)
+    end
+
+    def record_count_query
+      Spree::Report::QueryFragments.from_subquery(report_query).project(Arel.star.count)
+    end
+
+    def report_query
+      Spree::Report::QueryFragments.from_subquery(searches)
+        .project("count(searched_term) as occurrences", "searched_term")
+        .group("searched_term")
+    end
+
+    private def searches
+      Spree::PageEvent
+        .where(activity: 'search')
+        .where(created_at: reporting_period)
+        .where(Spree::PageEvent.arel_table[:search_keywords].matches(keyword_search))
+        .select("search_keywords as searched_term")
+    end
+
+    private def keyword_search
+      search[:keywords_cont].present? ? "%#{ search[:keywords_cont] }%" : '%'
+    end
+  end
+end

data/app/reports/spree/trending_search_report/frequency_distribution_pie_chart.rb

@@ -0,0 +1,41 @@
+class Spree::TrendingSearchReport::FrequencyDistributionPieChart
+  attr_accessor :chart_data
+
+  def initialize(result)
+    total_occurrences = result.observations.sum(&:occurrences).to_f
+    self.chart_data = result.observations.collect { |x| { name: x.searched_term, y: x.occurrences/total_occurrences } }
+  end
+
+  def to_h
+    {
+
+      name: 'trending-search',
+      json: {
+        chart: { type: 'pie' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Trending Search Keywords(Top 20)</span><span class='fa fa-question-circle' data-toggle='tooltip' title='Track the most trending keywords searched by users'></span>"
+        },
+        tooltip: {
+          pointFormat: 'Search %: <b>{point.percentage:.1f}%</b>'
+        },
+        plotOptions: {
+          pie: {
+            allowPointSelect: true,
+            cursor: 'pointer',
+            dataLabels: {
+              enabled: false
+            },
+            showInLegend: true
+          }
+        },
+        series: [
+          {
+            name: 'Hits',
+            data: chart_data
+          }
+        ]
+      }
+    }
+  end
+end