Merge pull request #2361 from mkllnk/2356-report-search-hint

2356 report search hint

.rubocop_todo.yml

@@ -271,7 +271,6 @@ Layout/EmptyLinesAroundArguments:
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'app/controllers/spree/admin/orders_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/controllers/spree/api/orders_controller_decorator.rb'
     - 'app/controllers/spree/api/products_controller_decorator.rb'
     - 'app/controllers/spree/checkout_controller_decorator.rb'
@@ -442,7 +441,6 @@ Layout/IndentHash:
 # SupportedStyles: normal, rails
 Layout/IndentationConsistency:
   Exclude:
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'lib/open_food_network/permissions.rb'
     - 'spec/controllers/admin/tag_rules_controller_spec.rb'
     - 'spec/features/consumer/shopping/checkout_spec.rb'
@@ -824,7 +822,6 @@ Layout/SpaceInsideHashLiteralBraces:
     - 'app/controllers/checkout_controller.rb'
     - 'app/controllers/spree/admin/line_items_controller_decorator.rb'
     - 'app/controllers/spree/admin/products_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/controllers/spree/admin/search_controller_decorator.rb'
     - 'app/controllers/spree/orders_controller_decorator.rb'
     - 'app/helpers/admin/business_model_configuration_helper.rb'
@@ -1274,7 +1271,6 @@ Naming/UncommunicativeMethodParamName:
 # SupportedStyles: snake_case, camelCase
 Naming/VariableName:
   Exclude:
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/helpers/admin/injection_helper.rb'
 
 # Offense count: 16
@@ -1554,7 +1550,6 @@ Rails/Presence:
 Rails/Present:
   Exclude:
     - 'app/controllers/spree/admin/orders_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/models/producer_property.rb'
     - 'lib/open_food_network/products_and_inventory_report.rb'
 
@@ -1856,7 +1851,6 @@ Style/ConditionalAssignment:
     - 'app/controllers/checkout_controller.rb'
     - 'app/controllers/spree/admin/base_controller_decorator.rb'
     - 'app/controllers/spree/admin/payment_methods_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/controllers/spree/admin/search_controller_decorator.rb'
     - 'app/helpers/spree/admin/orders_helper_decorator.rb'
     - 'app/models/spree/calculator/per_item_decorator.rb'
@@ -1992,7 +1986,6 @@ Style/HashSyntax:
     - 'app/controllers/spree/admin/line_items_controller_decorator.rb'
     - 'app/controllers/spree/admin/orders_controller_decorator.rb'
     - 'app/controllers/spree/admin/products_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/controllers/spree/admin/search_controller_decorator.rb'
     - 'app/controllers/spree/admin/shipping_methods_controller_decorator.rb'
     - 'app/controllers/spree/api/products_controller_decorator.rb'
@@ -2437,7 +2430,6 @@ Style/RescueModifier:
   Exclude:
     - 'app/controllers/application_controller.rb'
     - 'app/controllers/spree/admin/orders_controller_decorator.rb'
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'lib/tasks/data.rake'
 
 # Offense count: 5
@@ -2528,7 +2520,6 @@ Style/TrivialAccessors:
 # Cop supports --auto-correct.
 Style/UnlessElse:
   Exclude:
-    - 'app/controllers/spree/admin/reports_controller_decorator.rb'
     - 'app/models/enterprise.rb'
     - 'lib/open_food_network/order_grouper.rb'
 

app/assets/stylesheets/admin/reports.css.scss

@@ -0,0 +1,10 @@
+.report__table {
+  margin-top: 2em;
+}
+.report__message {
+  margin-top: 2em;
+  border: 1px solid #cee1f4;
+  border-radius: .5em;
+  padding: .5em;
+  text-align: center;
+}

app/controllers/spree/admin/reports_controller_decorator.rb

@@ -15,9 +15,10 @@ require 'open_food_network/payments_report'
 require 'open_food_network/orders_and_fulfillments_report'
 
 Spree::Admin::ReportsController.class_eval do
-
   include Spree::ReportsHelper
 
+  helper_method :render_content?
+
   before_filter :cache_search_state
   # Fetches user's distributors, suppliers and order_cycles
   before_filter :load_data, only: [:customers, :products_and_inventory, :order_cycle_management, :packing]
@@ -183,11 +184,11 @@ Spree::Admin::ReportsController.class_eval do
 
   def products_and_inventory
     @report_types = report_types[:products_and_inventory]
-    if params[:report_type] != 'lettuce_share'
-      @report = OpenFoodNetwork::ProductsAndInventoryReport.new spree_current_user, params, render_content?
-    else
-      @report = OpenFoodNetwork::LettuceShareReport.new spree_current_user, params, render_content?
-    end
+    @report = if params[:report_type] != 'lettuce_share'
+                OpenFoodNetwork::ProductsAndInventoryReport.new spree_current_user, params, render_content?
+              else
+                OpenFoodNetwork::LettuceShareReport.new spree_current_user, params, render_content?
+              end
     render_report(@report.header, @report.table, params[:csv], "products_and_inventory_#{timestamp}.csv")
   end
 
@@ -240,6 +241,8 @@ Spree::Admin::ReportsController.class_eval do
 
   def render_report(header, table, create_csv, csv_file_name)
     send_data csv_report(header, table), filename: csv_file_name if create_csv
+    @header = header
+    @table = table
     # Rendering HTML is the default.
   end
 

app/views/spree/admin/reports/_link_order.html.haml

@@ -0,0 +1 @@
+%a.edit-order{href: "/admin/orders/#{value}"}= value

app/views/spree/admin/reports/_table.html.haml

@@ -0,0 +1,23 @@
+- column_partials ||= {}
+- if render_content?
+  %table.report__table{id: id}
+    %thead
+      %tr
+        - @header.each do |heading|
+          %th= heading
+    %tbody
+      - @table.each do |row|
+        %tr
+          - row.each_with_index do |cell_value, column_index|
+            %td
+              - partial = column_partials[column_index]
+              - if partial
+                = render partial, value: cell_value
+              - else
+                = cell_value
+      - if @table.empty?
+        %tr
+          %td{colspan: @header.count}= t(:none)
+- else
+  %p.report__message
+    = t(".select_and_search")

app/views/spree/admin/reports/bulk_coop.html.haml

@@ -15,18 +15,5 @@
   %br
   %br
   = button t(:search)
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+
+= render "table", id: "listing_orders"

app/views/spree/admin/reports/customers.html.haml

@@ -29,18 +29,4 @@
   %br
   = button t(:search)
 
-%br
-%br
-%table#listing_customers.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_customers"

app/views/spree/admin/reports/order_cycle_management.html.haml

@@ -29,18 +29,4 @@
   .row
   = button t(:search)
 
-%br
-%br
-%table#listing_ocm_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_ocm_orders"

app/views/spree/admin/reports/orders_and_distributors.html.haml

@@ -6,18 +6,4 @@
   %br
   = button t(:search)
 
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => 'orders_header'}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_orders"

app/views/spree/admin/reports/orders_and_fulfillment.html.haml

@@ -25,18 +25,4 @@
   .row
   = button t(:search)
 
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_orders"

app/views/spree/admin/reports/packing.html.haml

@@ -25,18 +25,4 @@
   .row
   = button t(:search)
 
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_orders"

app/views/spree/admin/reports/payments.html.haml

@@ -15,18 +15,5 @@
   %br
   %br
   = button t(:search)
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+
+= render "table", id: "listing_orders"

app/views/spree/admin/reports/products_and_inventory.html.haml

@@ -31,18 +31,4 @@
   = label_tag :csv, t(:report_customers_csv)
   %br
   = button t(:search)
-%br
-%br
-%table#listing_products.index
-  %thead
-    %tr{'data-hook' => "products_header"}
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_products"

app/views/spree/admin/reports/sales_tax.html.haml

@@ -16,22 +16,4 @@
   %br
   = button t(:search)
 
-%br
-%br
-%table#listing_orders.index
-  %thead
-    %tr{'data-hook' => "orders_header"}
-      - @report.header.each do |heading|
-        %th= heading
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each_with_index do |column, i|
-          - if i == 0
-            %td
-              %a.edit-order{'href' => "/admin/orders/#{column}"}= column
-          - else
-            %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => @report.header.count}= t(:none)
+= render "table", id: "listing_orders", column_partials: {0 => "link_order"}

app/views/spree/admin/reports/users_and_enterprises.html.haml

@@ -17,18 +17,5 @@
     = label_tag :csv, t(:report_customers_csv)
   .row
     = button t(:search)
-%br
-%br
-%table#users_and_enterprises
-  %thead
-    %tr
-      - @report.header.each do |heading|
-        %th=heading
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+
+= render "table", id: "users_and_enterprises"

app/views/spree/admin/reports/xero_invoices.html.haml

@@ -32,16 +32,4 @@
     .four.columns.alpha= button t(:search)
 
 
-%table#listing_invoices.index
-  %thead
-    %tr
-      - @report.header.each do |header|
-        %th= header
-  %tbody
-    - @report.table.each do |row|
-      %tr
-        - row.each do |column|
-          %td= column
-    - if @report.table.empty?
-      %tr
-        %td{:colspan => "2"}= t(:none)
+= render "table", id: "listing_invoices"

config/locales/en.yml

@@ -2598,6 +2598,8 @@ See the %{link} to find out more about %{sitename}'s features and to start using
         display_as:
           display_as: Display As
       reports:
+        table:
+          select_and_search: "Select filters and click on SEARCH to access your data."
         bulk_coop:
           bulk_coop_supplier_report: 'Bulk Co-op - Totals by Supplier'
           bulk_coop_allocation: 'Bulk Co-op - Allocation'

spec/features/admin/reports_spec.rb

@@ -39,6 +39,8 @@ feature %q{
     scenario "customers report" do
       click_link "Mailing List"
       expect(page).to have_select('report_type', selected: 'Mailing List')
+      expect(page).to have_content "click on SEARCH"
+      click_button "Search"
 
       rows = find("table#listing_customers").all("thead tr")
       table = rows.map { |r| r.all("th").map { |c| c.text.strip } }
@@ -51,6 +53,7 @@ feature %q{
       click_link "Addresses"
       expect(page).to have_select('report_type', selected: 'Addresses')
 
+      click_button "Search"
       rows = find("table#listing_customers").all("thead tr")
       table = rows.map { |r| r.all("th").map { |c| c.text.strip } }
       expect(table.sort).to eq([
@@ -67,6 +70,7 @@ feature %q{
 
     scenario "payment method report" do
       click_link "Payment Methods Report"
+      click_button "Search"
       rows = find("table#listing_ocm_orders").all("thead tr")
       table = rows.map { |r| r.all("th").map { |c| c.text.strip } }
       expect(table.sort).to eq([
@@ -76,6 +80,7 @@ feature %q{
 
     scenario "delivery report" do
       click_link "Delivery Report"
+      click_button "Search"
       rows = find("table#listing_ocm_orders").all("thead tr")
       table = rows.map { |r| r.all("th").map { |c| c.text.strip } }
       expect(table.sort).to eq([
@@ -119,7 +124,7 @@ feature %q{
       #select 'Pack By Customer', from: 'report_type'
       click_button 'Search'
 
-      rows = find("table#listing_orders.index").all("thead tr")
+      rows = find("table#listing_orders").all("thead tr")
       table = rows.map { |r| r.all("th").map { |c| c.text.strip } }
       expect(table.sort).to eq([
         ["Hub", "Code", "First Name", "Last Name", "Supplier", "Product", "Variant", "Quantity", "TempControlled?"]
@@ -148,6 +153,7 @@ feature %q{
     login_to_admin_section
     click_link 'Reports'
     click_link 'Orders And Distributors'
+    click_button 'Search'
 
     expect(page).to have_content 'Order date'
   end
@@ -156,6 +162,7 @@ feature %q{
     login_to_admin_section
     click_link 'Reports'
     click_link 'Bulk Co-Op'
+    click_button 'Search'
 
     expect(page).to have_content 'Supplier'
   end
@@ -164,6 +171,7 @@ feature %q{
     login_to_admin_section
     click_link 'Reports'
     click_link 'Payment Reports'
+    click_button 'Search'
 
     expect(page).to have_content 'Payment State'
   end