workarea-registries 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5ab7f95e20ba90a464ec73c765ab167e8e72b6
-  data.tar.gz: d4593a5909ddfa50c3b6b0b5ce28d8f484a2feb2
+  metadata.gz: 8f6da4e142c2c5b40a90b36ec6ac4d3697413c0c
+  data.tar.gz: 0f9cecbaca22c4b850e237780098078f85770253
 SHA512:
-  metadata.gz: 867dfe500ce0ab7417b7630017dec70fbe3ed9af04f01634df609b344b3534da5223af412dce8d493e74f2b3004acf4062ff1286b81b801e9139ce53dddbb7b8
-  data.tar.gz: f97bbd88043e4a6b913d323057b6037559da645815cf0d5eb9d5df93b944ab6003a997902a7fd2b250aaa7731514dc80024cca2108567dcd33fc05f23a45bb26
+  metadata.gz: 9d21cfd7a35ec95c5020094191d6d1793245ed75a683a05e6b6e01e7e0e2cec7589b4217287b58da7ffb2118307b7a570b8cbff8659563a1d30ee8f91fd7ad73
+  data.tar.gz: 42fe304c3e83d60b2e57ba696c88b5a78120faf934edf2cc7f3739ab2f86b966f7802e2a2b31a19ad89d4bb23079eeedfa772f41815f0e71d69fb8ed92133b27

data/app/controllers/workarea/admin/reports_controller.decorator

@@ -0,0 +1,33 @@
+module Workarea
+  decorate Admin::ReportsController, with: :registries do
+    def active_registries
+      page_number = params[:page] || 1
+
+      active_registries = Registry
+        .with_items
+        .page(page_number)
+        .per(Workarea.config.per_page)
+        .order_by(created_at: :desc)
+
+      @active_registries = PagedArray.from(
+        Admin::ActiveRegistryViewModel.wrap(active_registries),
+        page_number,
+        Workarea.config.per_page,
+        active_registries.total_count
+      )
+    end
+
+    def export_active_registries
+      emails = params[:emails].to_s.split(',').map(&:strip)
+
+      if emails.any?
+        Admin::ActiveRegistriesMailer.report(emails).deliver_later
+        flash[:success] = t('workarea.admin.reports.flash_messages.success')
+      else
+        flash[:error] = t('workarea.admin.report.flash_messages.email_is_required')
+      end
+
+      redirect_to active_registries_report_path
+    end
+  end
+end

data/app/mailers/workarea/admin/active_registries_mailer.rb

@@ -0,0 +1,16 @@
+module Workarea
+  module Admin
+    class ActiveRegistriesMailer < Admin::ApplicationMailer
+      def report(emails)
+        report = ActiveRegistriesReport.new
+        report.generate
+        attachments['report.csv'] = File.read(report.file_path)
+        mail(
+            to: emails,
+            from: Workarea.config.email_from,
+            subject: t('workarea.admin.active_registries_mailer.report.subject'),
+        )
+      end
+    end
+  end
+end

data/app/models/workarea/registry.rb

@@ -24,6 +24,7 @@ module Workarea
     validates :privacy, presence: true,
       inclusion: { in: %w(public shared private) }
 
+    scope :with_items, -> { where('items.0' => { '$exists' => true }) }
     scope :for_user, ->(user_id) { where(user_id: user_id.to_s) }
     scope :by_activity, -> { order(updated_at: :desc) }
 
@@ -53,6 +54,14 @@ module Workarea
       items.select(&:purchased_by?)
     end
 
+    def total_purchased_items
+      purchased_items.pluck('quantity').sum
+    end
+
+    def total_price
+      purchased_items.map{ |item| item.total_price }.sum
+    end
+
     def unpurchased_items
       items.reject(&:purchased_by?)
     end
@@ -61,6 +70,18 @@ module Workarea
       items.reject(&:purchased_by?).select(&:available?)
     end
 
+    def total_items
+      unpurchased_items.pluck('quantity').sum
+    end
+
+    def total_items_received
+      unpurchased_items.pluck('received').sum
+    end
+
+    def total_products
+      unpurchased_items.size
+    end
+
     def add_item(params)
       quantity = params.fetch(:quantity, 1).to_i
       existing_item = find_existing_item(sku: params[:sku])
@@ -82,7 +103,8 @@ module Workarea
 
       if existing_purchased_item
         quantity = existing_purchased_item.quantity + params[:quantity]
-        existing_purchased_item.update(quantity: quantity)
+        total_price = existing_purchased_item.total_price + params[:total_price]
+        existing_purchased_item.update(quantity: quantity, total_price: total_price)
       else
         items.build(params)
       end

data/app/models/workarea/registry/item.rb

@@ -8,6 +8,7 @@ module Workarea
       field :quantity, type: Integer, default: 1
       field :received, type: Integer, default: 0
       field :purchased_by, type: String
+      field :total_price, type: Money, default: 0.to_m
 
       embedded_in :registry,
         class_name: 'Workarea::Registry',
@@ -23,6 +24,10 @@ module Workarea
         quantity > received
       end
 
+      def unavailable?
+        !available?
+      end
+
       def received?
         received.positive?
       end

data/app/services/workarea/registries/active_registries_report.rb

@@ -0,0 +1,43 @@
+module Workarea
+  class ActiveRegistriesReport
+    include ActionView::Helpers::NumberHelper
+    attr_reader :file_path
+
+    def initialize
+      @file_path = "#{Rails.root}/tmp/active_registries/report.csv"
+    end
+
+    def generate
+      dir_path = File.dirname(file_path)
+      FileUtils.mkdir_p dir_path unless File.directory?(dir_path)
+      CSV.open(file_path, 'w') do |csv|
+        csv << [
+          'Name',
+          'Email',
+          'Products',
+          'Items',
+          'Purchased Items',
+          'Total Price',
+        ]
+        populate_csv(csv)
+      end
+    end
+
+    private
+
+    def populate_csv(csv)
+      Registry.with_items.order_by(created_at: :desc).each_by(100) do |registry|
+        registry = Admin::ActiveRegistryViewModel.new(registry)
+
+        csv << [
+          registry.name,
+          registry.email,
+          registry.total_products,
+          registry.total_items,
+          registry.total_purchased_items,
+          number_to_currency(registry.total_price)
+        ]
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/active_registry_view_model.rb

@@ -0,0 +1,19 @@
+module Workarea
+  module Admin
+    class ActiveRegistryViewModel < ApplicationViewModel
+      def total_price
+        @total_price ||= begin
+          purchased_items.map{ |item| item.total_price }.sum
+        end
+      end
+
+      def unpurchased_items
+        @unpurchased_items ||= items.reject(&:purchased_by?)
+      end
+
+      def purchased_items
+        @purchased_items ||= items.select(&:purchased_by?)
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/dashboards/reports_view_model.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Admin::Dashboards::ReportsViewModel, with: :registries do
+    def active_registries
+      @active_registries ||= Registry.order_by(created_at: :desc)
+    end
+  end
+end

data/app/views/workarea/admin/active_registries_mailer/report.html.haml

@@ -0,0 +1 @@
+%p="Please download the CSV attachment"

data/app/views/workarea/admin/dashboards/_active_registries_report_card.html.haml

@@ -0,0 +1,16 @@
+.grid__cell
+  .card{ class: card_classes(:active_wish_lists_report, local_assigns[:active]) }
+    = link_to active_wish_lists_report_path, class: 'card__header' do
+      %span.card__header-text= t('workarea.admin.report.active_registries.title')
+      = inline_svg 'workarea/admin/icons/insights.svg', class: 'card__icon'
+
+    .card__body
+      .card__centered-content
+        %table
+          %tbody
+            - @dashboard.active_registries.limit(4).each do |registry|
+              %tr
+                %td= local_time_ago(registry.created_at)
+
+      = link_to active_registries_report_path, class: 'card__button' do
+        %span.button.button--small= t('workarea.admin.dashboards.reports.view_full_report')

data/app/views/workarea/admin/registries/index.html.haml

@@ -46,6 +46,8 @@
             %th= t('workarea.admin.fields.name')
             %th= t('workarea.admin.fields.user_id')
             %th= t('workarea.admin.fields.items')
+            %th= t('workarea.admin.fields.purchased_items')
+            %th= t('workarea.admin.fields.total_price')
         %tbody
           - @search.results.each do |result|
             %tr.index-table__row
@@ -59,7 +61,9 @@
                   = result.user_id
                 - else
                   = link_to result.user.name, user_path(result.user)
-              %td= result.items.size
+              %td= result.total_items
+              %td= result.total_purchased_items
+              %td= number_to_currency(result.total_price)
 
       - if @search.results.total_pages > 1
         = render 'workarea/admin/shared/pagination', collection: @search.results
@@ -67,4 +71,4 @@
   .workflow-bar
     .grid
       .grid__cell.grid__cell--50
-        = render 'workarea/admin/shared/bulk_actions', klass: Workarea::Registry, search: @search, bulk_delete: false
+        = render 'workarea/admin/shared/bulk_actions', klass: Workarea::Registry, search: @search, bulk_delete: false

data/app/views/workarea/admin/reports/active_registries.html.haml

@@ -0,0 +1,46 @@
+- @page_title = t('workarea.admin.report.active_registries.title')
+
+.view
+  .view__header
+    .grid
+      .grid__cell.grid__cell--25
+      .grid__cell.grid__cell--50
+        .view__heading
+          = link_to "↑ #{t('workarea.admin.reports.all_reports')}", reports_dashboards_path
+          %h1.heading.heading--no-margin= t('workarea.admin.report.active_registries.title')
+      .grid__cell.grid__cell--25.grid--right
+        = link_to(t('workarea.admin.report.export'), '#export', data: { tooltip: { interactive: true, side: 'bottom' } })
+        = form_tag export_active_registries_report_path, method: 'post', id: 'export', class: 'tooltip-content align-center' do
+          %h2= t('workarea.admin.reports.export.where_will_the_file_go')
+          .property
+            = email_field_tag 'emails', params[:emails] || current_user.email, class: 'text-box text-box--wide', required: true, placeholder: t('workarea.admin.reports.export.enter_email'), multiple: true
+            %span.property__note
+              = t('workarea.admin.reports.export.emails_note')
+          = button_tag t('workarea.admin.reports.export.start_export'), value: 'create_export', class: 'button button--inline'
+
+  .view__container
+    %table
+      %thead
+        %tr
+          %th= t('workarea.admin.fields.name')
+          %th= t('workarea.admin.fields.user')
+          %th= t('workarea.admin.fields.products')
+          %th= t('workarea.admin.fields.items')
+          %th= t('workarea.admin.fields.purchased_items')
+          %th= t('workarea.admin.fields.total_price')
+          %th= t('workarea.admin.fields.updated_at')
+          %th= t('workarea.admin.fields.created_at')
+      %tbody
+        - @active_registries.each do |registry|
+          %tr
+            %td= registry.name
+            %td= registry.email
+            %td= registry.total_products
+            %td= registry.total_items
+            %td= registry.total_purchased_items
+            %td= number_to_currency(registry.total_price)
+            %td= local_time_ago(registry.updated_at)
+            %td= local_time_ago(registry.created_at)
+
+    - if @active_registries.total_pages > 1
+      = render 'workarea/admin/shared/pagination', collection: @active_registries

data/app/views/workarea/admin/shared/primary_nav/_active_registries_report_link.html.haml

@@ -0,0 +1 @@
+%li{ class: "primary-nav__item" }= link_to t('workarea.admin.shared.primary_nav.active_registries'), active_registries_report_path, class: navigation_link_classes(active_registries_report_path)

data/app/views/workarea/storefront/registries_mailer/thank.html.haml

@@ -6,14 +6,11 @@
 %tr
   %td
     %h1= @content
-    %p
-      %strong= @thank.from
-    %p= t('workarea.storefront.email.thank.thank_you')
+    %p= t('workarea.storefront.email.registries.thank.thank_you', registry_owner: @thank.friendly_from )
 
     - if @thank.message.present?
-      %p 
-        %strong #{@thank.from} #{t('workarea.storefront.email.thank.from_message_html')}
-      %p= @thank.message
+      %p
+        %i= @thank.message
 
 
 = append_partials('storefront.registry_thank_mailer.bottom')

data/app/views/workarea/storefront/users/registries/show.html.haml

@@ -56,13 +56,21 @@
 
   %h2= t('workarea.storefront.registries.items')
 
-  .browsing-controls
-    = form_tag users_registry_path, method: 'get', class: 'browsing-controls__form' do
-      %p.browsing-controls__form-item.property
-        = label_tag :state, nil, class: 'property__name' do
-          %span.property__text= t('workarea.storefront.registries.filter')
-        %span.value= select_tag :state, options_for_select(@registry.state_options, params[:state]), data: { form_submitting_control: '' }
-      %p.browsing-controls__form-item.hidden-if-js-enabled= button_tag t('workarea.storefront.forms.go'), class: 'button'
+  .grid.grid--auto.grid--middle
+    - if @registry.purchased_items.any?
+      .grid__cell
+        .browsing-controls
+          = form_tag users_registry_path, method: 'get', class: 'browsing-controls__form' do
+            %p.browsing-controls__form-item.property
+              = label_tag :state, nil, class: 'property__name' do
+                %span.property__text= t('workarea.storefront.registries.filter')
+              %span.value= select_tag :state, options_for_select(@registry.state_options, params[:state]), data: { form_submitting_control: '' }
+            %p.browsing-controls__form-item.hidden-if-js-enabled= button_tag t('workarea.storefront.forms.go'), class: 'button'
+    - if @registry.unpurchased_items.any?
+      .grid__cell
+        = t('workarea.storefront.registries.total_products', count: @registry.total_products)
+        |
+        = t('workarea.storefront.registries.total_items_received', count: @registry.total_items_received)
 
   .grid
     .grid__cell

data/app/workers/workarea/update_registry_items.rb

@@ -9,15 +9,18 @@ module Workarea
       order = Order.find(order_id)
 
       order.items.each do |item|
-        next unless item.registry_id.present?
+        next unless item.registry_item?
         registry = Workarea::Registry.find(item.registry_id)
         registry.mark_item_received(item)
-        registry.add_purchased_item({
-          sku: item.sku,
-          product_id: item.product_id,
-          quantity: item.quantity,
-          purchased_by: order.email
-        })
+        registry.add_purchased_item(
+          {
+            sku: item.sku,
+            product_id: item.product_id,
+            quantity: item.quantity,
+            purchased_by: order.email,
+            total_price: item.total_price
+          }
+        )
       end
     end
   end

data/config/initializers/appends.rb

@@ -1,3 +1,13 @@
+Workarea.append_partials(
+  'admin.reports_menu',
+  'workarea/admin/shared/primary_nav/active_registries_report_link',
+)
+
+Workarea.append_partials(
+  'admin.reports_dashboard',
+  'workarea/admin/dashboards/active_registries_report_card',
+)
+
 Workarea.append_partials(
   'admin.orders_menu',
   'workarea/admin/registries/menu'

data/config/locales/en.yml

@@ -1,6 +1,14 @@
 en:
   workarea:
     admin:
+      registries:
+        fields:
+          email: email
+          items: Items
+          name: Name
+          products: Products
+          purchased_items: Items Sold
+          total_price: Total Price
       registries:
         index:
           dashboard_link: Orders dashboard
@@ -9,6 +17,15 @@ en:
         pluralize:
           one: '%{count} Registry'
           other: '%{count} Registries'
+      report:
+        active_registries:
+          title: Active Registries
+        flash_messages:
+          email_is_required: Email is required
+      shared:
+        primary_nav:
+          active_registries: Active Registries
+          registries: Registries
     errors:
       messages:
         registry_sku_unavailable: "Sorry, %{registry} is not asking for %{sku} anymore. It has been removed"
@@ -33,7 +50,7 @@ en:
           thank:
             from_info: 'has included a personal note:'
             subject: Thank you from %{from}
-            thank_you: wants to thank you for your gift!
+            thank_you: '%{registry_owner} wants to thank you for your gift!'
       flash_messages:
         private_registry: This registry is private.
         registry_created: Your registry has been created.
@@ -94,6 +111,15 @@ en:
           heading: Search Registries
         search_title: Registry Search
         title: Registries
+        total_items:
+          one: '%{count} Item'
+          other: '%{count} Items'
+        total_items_received:
+          one: '%{count} Item Purchased'
+          other: '%{count} Items Purchased'
+        total_products:
+          one: '%{count} Product'
+          other: '%{count} Products'
         quantity_purchased: '%{quantity} purchased'
         unpurchased_items: Unpurchased Items
         view: View

data/config/routes.rb

@@ -22,5 +22,10 @@ end
 Workarea::Admin::Engine.routes.draw do
   scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
     resources :registries, only: [:index, :show]
+
+    resource :report do
+      get :active_registries
+      post :export_active_registries
+    end
   end
 end

data/lib/workarea/registries/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Registries
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/test/workers/update_registry_items_test.rb

@@ -29,7 +29,14 @@ module Workarea
     def test_perform
       user = create_user
       order = create_order(email: user.email, user_id: user.id)
-      order.items.build(product_id: product.id, sku: product.variants.first.sku, quantity: 1, registry_id: registry.id)
+      item_price = Workarea::Pricing::Sku.find('SKU1').regular_price
+      order.items.build(
+        product_id: product.id,
+        sku: product.variants.first.sku,
+        quantity: 1,
+        registry_id: registry.id,
+        total_price: item_price
+      )
       order.save!
 
       UpdateRegistryItems.new.perform(order.id)
@@ -40,6 +47,7 @@ module Workarea
       assert_equal(1, registry.items.first.received)
       assert(registry.items.first.received?)
       assert(registry.items.last.purchased?)
+      assert_equal(500, registry.items.last.total_price.cents)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-registries
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jurgen Hahn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -43,6 +43,7 @@ files:
 - app/assets/javascripts/workarea/storefront/registries/modules/toggle_registry_address.js
 - app/assets/javascripts/workarea/storefront/registries/templates/add_to_registry_button.jst.ejs
 - app/controllers/workarea/admin/registries_controller.rb
+- app/controllers/workarea/admin/reports_controller.decorator
 - app/controllers/workarea/storefront/cart_items_controller.decorator
 - app/controllers/workarea/storefront/registries_controller.rb
 - app/controllers/workarea/storefront/users/registries_controller.rb
@@ -50,6 +51,7 @@ files:
 - app/controllers/workarea/storefront/users/registry_shares_controller.rb
 - app/controllers/workarea/storefront/users/registry_thanks_controller.rb
 - app/helpers/workarea/registries_helper.rb
+- app/mailers/workarea/admin/active_registries_mailer.rb
 - app/mailers/workarea/storefront/registries_mailer.rb
 - app/models/workarea/checkout/steps/addresses.decorator
 - app/models/workarea/order.decorator
@@ -64,6 +66,9 @@ files:
 - app/queries/workarea/search/admin_registries.rb
 - app/seeds/workarea/registry_content_seeds.rb
 - app/services/workarea/inventory_adjustment.decorator
+- app/services/workarea/registries/active_registries_report.rb
+- app/view_models/workarea/admin/active_registry_view_model.rb
+- app/view_models/workarea/admin/dashboards/reports_view_model.decorator
 - app/view_models/workarea/admin/registry_view_model.rb
 - app/view_models/workarea/storefront/checkout/addresses_view_model.decorator
 - app/view_models/workarea/storefront/order_item_view_model.decorator
@@ -74,8 +79,12 @@ files:
 - app/view_models/workarea/storefront/registry_thank_view_model.rb
 - app/view_models/workarea/storefront/registry_view_model.rb
 - app/view_models/workarea/storefront/user_view_model.decorator
+- app/views/workarea/admin/active_registries_mailer/report.html.haml
+- app/views/workarea/admin/dashboards/_active_registries_report_card.html.haml
 - app/views/workarea/admin/registries/_menu.html.haml
 - app/views/workarea/admin/registries/index.html.haml
+- app/views/workarea/admin/reports/active_registries.html.haml
+- app/views/workarea/admin/shared/primary_nav/_active_registries_report_link.html.haml
 - app/views/workarea/storefront/carts/_registry_details.html.haml
 - app/views/workarea/storefront/checkouts/_registry_address.html.haml
 - app/views/workarea/storefront/checkouts/_registry_address_fields.html.haml