spree_reports 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22cef88a7f4eca1368ead4f4841f43654b3daf72
-  data.tar.gz: 2a0568f18fcec38bea9bead64da6f7eef2802390
+  metadata.gz: 6500106e38d28eb5485eb9b6c178925ce9dc38ef
+  data.tar.gz: e67b9c9a9f0a956c69d282a214463a7d6abfb2c9
 SHA512:
-  metadata.gz: 0114714084f66f721354460546ff696c2d9bc2103aa6b0e83d5a16b928c2d54ce44cf310f02fbe7375bd54ae86a87e9e3942a91ed11a763355e651ecfa3e56bc
-  data.tar.gz: 4332bcdfc638a420e72954ba5ddd6c75d90931f5fde1658af0fbac9b7df1b8745df8d8cb19f8aa943c9332718f024b9b97599a722a9edee1171336f52cd77699
+  metadata.gz: 9db51ba8cf0813443f00119188dc75b3fc0f9aa7ccc7f9c4d9efa01ebba795f869c2acc0f8b55baadba496c2bd349fece14c1f134d6719b21deaca5e2f179763
+  data.tar.gz: cd4285331e0964650058ffbe8e92fba5156ff8bf55c7e0ff4bc7e1ac5196142b3e8e2769757e1cd586e3380af59927271f784368518b46938e698e3cb5ca946f

data/app/controllers/spree/admin/reports_controller_decorator.rb

@@ -11,6 +11,17 @@ Spree::Admin::ReportsController.class_eval do
       }
     end 
   end
+  
+  def sold_products
+    @report = SpreeReports::Reports::SoldProducts.new(params)
+    respond_to do |format|
+      format.html
+      format.csv {
+        return head :unauthorized unless SpreeReports.csv_export
+        send_data @report.to_csv, filename: @report.csv_filename, type: "text/csv"
+      }
+    end 
+  end
 
   protected
 

data/app/controllers/spree/api/spree_reports_controller.rb

@@ -8,6 +8,11 @@ module Spree
         render json: @report.data
       end
       
+      def sold_products
+        @report = SpreeReports::Reports::SoldProducts.new(params)
+        render json: @report.data
+      end
+      
       private
         def requires_admin
           return if @current_user_roles.include?(SpreeReports.api_user_role)

data/app/views/spree/admin/reports/sold_products.html.erb

@@ -0,0 +1,84 @@
+<%= stylesheet_link_tag 'spree_reports/spree_reports', media: 'all' %>
+<%= javascript_include_tag "//www.google.com/jsapi", "chartkick" %>
+<%=  %>
+
+<div class="spree_reports report">
+  
+  <h1>Sold Products</h1>
+  
+  <div class="options">
+    
+    <%= form_tag "", method: :get, class: "options" do %>
+
+      <span class="option">
+        <span title="<%= @report.date_start ? "date_start: #{l(@report.date_start.to_date)}" : "" %>">months:</span>
+        <%= select_tag "months", options_for_select(SpreeReports.report_months, selected: @report.months) %>
+      </span>
+        
+      <% if @report.currencies.size > 1 %>
+        <span class="option">
+          currency:
+          <%= select_tag "currency", options_for_select(@report.currencies, selected: @report.currency) %>
+        </span>
+      <% end %>
+  
+      <% if @report.stores.size > 2 %>
+        <span class="option">
+          store:
+          <%= select_tag "store", options_for_select(@report.stores, selected: @report.store) %>
+        </span>
+      <% end %>
+  
+      <%= submit_tag 'reload' %>
+  
+    <% end %>
+    
+  </div>
+  
+  <div class="table">
+    
+    <table class="data" border="1">
+      <tr>
+        <th>Variant ID</th>
+        <th>Product Variant Name</th>
+        <th>Quantity</th>
+      </tr>
+  
+      <% @report.data.each do |item| %>
+        <tr>
+          <td><%= item[:variant_id] %></td>
+          <td>
+            <%= link_to item[:variant_name], product_path(item[:variant_slug]) %>
+            <%= link_to "edit", admin_product_path(item[:variant_slug]) %>
+          </td>
+          <td><%= number_with_delimiter(item[:quantity]) %></td>
+        </tr>
+      <% end %>
+  
+    </table>
+  
+  </div>
+  
+  <div class="charts">
+     
+     <h2>Top 20 Products</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.first(20).collect { |i| [i[:variant_name], i[:quantity]] }] %>
+     </div>
+     
+     <h2>Flop 20 Products</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.reverse.first(20).collect { |i| [i[:variant_name], i[:quantity]] }] %>
+     </div>
+  
+  </div>
+  
+  <div class="permalink">
+    <h2>Permalink</h2>
+    <input id="spree_reports_permalink" type="text" value="<%= request.url.split('?').first + "?" + params.except(:utf8, :commit, :action, :controller).to_query %>" onclick="$(this).select();return;">
+    <% if SpreeReports.csv_export %>
+      <%= link_to 'Download as CSV', params.except(:utf8, :commit).merge(format: "csv") %>
+    <% end %>
+  </div>
+  
+</div>

data/config/locales/en.yml

@@ -2,6 +2,8 @@ en:
   spree:
     orders_by_period: "Orders per period"
     orders_by_period_description: "Orders for a specific time range per period"
+    sold_products: "Sold products"
+    sold_products_description: "Quantity of sold products for a specific time range"
     
     spree_reports:
       test: "TEST"

data/lib/spree_reports/reports/base.rb

@@ -16,6 +16,12 @@ module SpreeReports
         users.uniq
       end
       
+      def without_excluded_orders(orders)
+        return orders if excluded_user_ids.none?
+        excluded_order_ids = Spree::Order.where(user_id: excluded_user_ids).pluck(:id)
+        orders.where.not(id: excluded_order_ids) if excluded_order_ids.any?  
+      end
+        
     end
   end
 end

data/lib/spree_reports/reports/orders_by_period.rb

@@ -70,12 +70,8 @@ module SpreeReports
     
         @sales = @sales.where("#{date_column.to_s} >= ?", @date_start) if @date_start
         @sales = @sales.where(currency: @currency) if @currencies.size > 1
-        @sales = @sales.where(store_id: @store) if @stores.size > 2 && @store != "all"
-        
-        if excluded_user_ids.any?
-          excluded_sales = Spree::Order.where(user_id: excluded_user_ids).pluck(:id)
-          @sales = @sales.where.not(id: excluded_sales) if excluded_sales.any?  
-        end
+        @sales = @sales.where(store_id: @store) if @stores.size > 2 && @store != "all"        
+        @sales = without_excluded_orders(@sales)
         
         # group by
 
@@ -118,7 +114,6 @@ module SpreeReports
             items_per_order: SpreeReports::Helper.round(SpreeReports::Helper.divide(@sales_item_count_total[k].to_f, v.to_f))
           }
         end
-        
       end
       
       def to_csv

data/lib/spree_reports/reports/sold_products.rb

@@ -0,0 +1,86 @@
+module SpreeReports
+  module Reports
+    class SoldProducts < SpreeReports::Reports::Base
+      
+      attr_accessor :params, :data, :orders
+      attr_accessor :currencies, :currency, :stores, :store, :months, :date_start
+      
+      def initialize(params)
+        @params = params
+        setup_params
+        get_data
+        build_response
+      end
+      
+      def setup_params
+        @currencies = Spree::Order.select('currency').distinct.map { |c| c.currency }  
+        @currency = @currencies.include?(params[:currency]) ? params[:currency] : @currencies.first
+        
+        @stores = Spree::Store.all.map { |store| [store.name, store.id] }
+        @stores << ["all", "all"]
+        @store = @stores.map{ |s| s[1].to_s }.include?(params[:store]) ? params[:store] : @stores.first[1]
+    
+        @months = SpreeReports.report_months.include?(params[:months]) ? params[:months] : SpreeReports.default_months.to_s
+        @date_start = (@months != "all") ? (Time.now - (@months.to_i).months) : nil       
+      end
+      
+      def get_data
+        @orders = Spree::Order.complete.where(payment_state: 'paid')
+        @orders = @orders.where("completed_at >= ?", @date_start) if @date_start
+        @orders = @orders.where(currency: @currency) if @currencies.size > 1
+        @orders = @orders.where(store_id: @store) if @stores.size > 2 && @store != "all"
+        @orders = without_excluded_orders(@orders)
+        
+        order_ids = @orders.pluck(:id)
+        line_items = Spree::LineItem.where(order_id: order_ids)
+        variant_ids_and_quantity = line_items.group(:variant_id).sum(:quantity).sort_by { |k,v| v }.reverse
+        
+        variants = Spree::Variant.all
+        variant_names = variants.all.map { |v| [v.id, [variant_name_with_option_values(v), v.slug] ] }.to_h
+        
+        @data_tmp = variant_ids_and_quantity.map { |id, quantity| [id, quantity, variant_names[id][0], variant_names[id][1]] }     
+      end
+      
+      def build_response
+        @data = @data_tmp.map do |item|
+          {
+            variant_id: item[0],
+            variant_name: item[2],
+            variant_slug: item[3],
+            quantity: item[1]
+          }
+        end
+      end
+      
+      def variant_name_with_option_values(v)
+        s = v.name
+        option_values = v.option_values.map { |o| o.presentation }
+        s += " (#{option_values.join(", ")})" if option_values.any?
+        s
+      end
+        
+      def to_csv
+    
+        CSV.generate(headers: true, col_sep: ";") do |csv|
+          csv << %w{ variant_id variant_name variant_slug quantity }
+      
+          @data.each do |item|
+            csv << [
+              item[:variant_id],
+              item[:variant_name],
+              item[:variant_slug],
+              item[:quantity]
+            ]
+          end
+      
+        end
+    
+      end
+      
+      def csv_filename
+        "sold_products_#{@months}-months.csv"
+      end
+      
+    end
+  end
+end

data/lib/spree_reports/version.rb

@@ -1,3 +1,3 @@
 module SpreeReports
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/spree_reports.rb

@@ -40,12 +40,10 @@ end
 # default configuration, overrideable in config/initializer spree_reports.rb
 
 SpreeReports.reports = [
-  :orders_by_period
+  :orders_by_period,
+  :sold_products
 ]
 
-# :orders_by_payment_type
-# :orders_by_value_range
-
 SpreeReports.time_zone = "Pacific Time (US & Canada)"
 SpreeReports.week_start = :mon
 SpreeReports.csv_export = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_reports
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Lieser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -66,6 +66,7 @@ files:
 - app/controllers/spree/admin/reports_controller_decorator.rb
 - app/controllers/spree/api/spree_reports_controller.rb
 - app/views/spree/admin/reports/orders_by_period.html.erb
+- app/views/spree/admin/reports/sold_products.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - lib/spree_reports.rb
@@ -73,6 +74,7 @@ files:
 - lib/spree_reports/helper.rb
 - lib/spree_reports/reports/base.rb
 - lib/spree_reports/reports/orders_by_period.rb
+- lib/spree_reports/reports/sold_products.rb
 - lib/spree_reports/version.rb
 - lib/tasks/spree_reports_tasks.rake
 - test/dummy/README.rdoc