workarea-wish_lists 3.0.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea', '>= 3.3.0'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,58 @@
+Workarea Wish Lists
+================================================================================
+
+A Workarea Commerce plugin to allow customers to create, manage, share, and search wish lists.
+
+Overview
+--------------------------------------------------------------------------------
+
+* Add products to a wish list from the product details page or cart
+* Manage list privacy - public, shared, or private
+* Manage wish list items
+* View products purchased from the wish lists
+* Search public wish lists by customer's name or email address
+* Add products to cart from wish lists
+* Admin view of a customer's wish list items and purchase state
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-wish_lists'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Features
+--------------------------------------------------------------------------------
+
+### Creating and managing wish lists
+
+A customer can manage a list of products associated to their account. These products can be added from the product detail page directly, or from the cart. Wish list items maintain quantity, option, and customization selections for easy addition to orders at a later time. Quantity can be changed from the wish list page.
+
+### Privacy Control
+
+A customer has control over the privacy level of their wish list. Setting a wish list to `public` allows other visitors of the site to search by a user's full name or email address and view a wish list, as well as purchase items off the wish list. Lists set to `shared` are not searchable but can be viewed by other visitors of the site if given a direct link to the wish list by the customer. A `private` wish list can be viewed only by the customer that owns the list.
+
+### Add to cart from wish list
+
+An item can be added to a customer's cart from their own wish list or a wish list they have searched for / been given a link to view. Items purchased from the list will be marked as purchased.
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Wish Lists is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/wish_lists/version'
+
+desc "Release version #{Workarea::WishLists::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::WishLists::VERSION} -m 'Tagging #{Workarea::WishLists::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-wish_lists.gemspec'
+  system "gem push workarea-wish_lists-#{Workarea::WishLists::VERSION}.gem"
+  system "gem push workarea-wish_lists-#{Workarea::WishLists::VERSION}.gem --host #{host}"
+  system "rm workarea-wish_lists-#{Workarea::WishLists::VERSION}.gem"
+end

data/app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_button.js

@@ -0,0 +1,35 @@
+/**
+ * @namespace WORKAREA.wishListButton
+ */
+WORKAREA.registerModule('wishListButton', (function () {
+    'use strict';
+
+    var redirectToWishList = function() {
+            window.location = WORKAREA.routes.storefront.usersWishListPath();
+        },
+        addItemToWishList = function(event) {
+            var $button = $(event.currentTarget),
+                action = WORKAREA.routes.storefront.addToUsersWishListPath(),
+                $form = $button.closest('.product-details')
+                               .find('.product-details__add-to-cart-form'),
+                payload = $form.serialize();
+
+            event.preventDefault();
+
+            if ($form.valid()) {
+                $.post(action, payload, redirectToWishList);
+            }
+        },
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.wishListButton
+         */
+        init = function($scope) {
+            $('[data-wish-list-button]', $scope).on('click', addItemToWishList);
+        };
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_public_quantity_fields.js

@@ -0,0 +1,42 @@
+/**
+ * @namespace WORKAREA.wishListPublicQuantityFields
+ */
+WORKAREA.registerModule('wishListPublicQuantityFields', (function () {
+    'use strict';
+
+    var convertPriceToCents = function (textPrice) {
+            return parseInt(textPrice) * 100;
+        },
+
+        calculateTotalPrice = function (priceAsText, quantity) {
+            var total = convertPriceToCents(priceAsText) * quantity;
+            return total/100;
+        },
+
+        totalPrice = function (price, quantity) {
+            return '$' + calculateTotalPrice(price, quantity).toFixed(2);
+        },
+
+        updateItemTotalPrice = function (event) {
+            var $item = $(event.currentTarget).closest('tr'),
+                $itemPrice = $item.find('.wish-lists__public-item-price'),
+                $itemTotal = $item.find('.wish-lists__public-total-price'),
+                quantity = $item.find('.wish-lists__public-quantity-field').val(),
+                price = $itemPrice.text().replace('$', '');
+
+            $itemTotal.text(totalPrice(price, quantity));
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.wishListPublicQuantityFields
+         */
+        init = function ($scope) {
+            $('.wish-lists__public-quantity-field', $scope).on('change', updateItemTotalPrice);
+        };
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/wish_lists/templates/hidden_input.jst.ejs

@@ -0,0 +1 @@
+<input type="hidden" name="<%= name %>" value="<%= value %>">

data/app/assets/stylesheets/workarea/storefront/wish_lists/components/_wish_list_button.scss

@@ -0,0 +1,6 @@
+/*------------------------------------*\
+    #WISH-LIST-BUTTON
+\*------------------------------------*/
+
+.wish-list-button {}
+    .wish-list-button__link {}

data/app/assets/stylesheets/workarea/storefront/wish_lists/components/_wish_lists.scss

@@ -0,0 +1,24 @@
+/*------------------------------------*\
+    #WISH-LISTS
+\*------------------------------------*/
+
+/**
+ * 1. Form submit action
+ */
+
+.wish-lists {}
+
+    .wish-lists__link {}
+
+    .wish-lists__section {}
+
+        .wish-lists__public-url {}
+
+            .wish-lists__public-url-name,
+            .wish-lists__public-url-link {
+                margin: 0 0 halve($spacing-unit);
+            }
+
+    .wish-lists__section--settings {}
+    .wish-lists__section--share {}
+    .wish-lists__section--items {}

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

@@ -0,0 +1,20 @@
+module Workarea
+  decorate Admin::UsersController, with: :wish_lists do
+    def wish_list
+    end
+
+    private
+
+    def find_user
+      if params[:user_id].present?
+        @user =
+          Admin::UserViewModel.new(
+            User.find(params[:user_id]),
+            view_model_options
+          )
+      else
+        super
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/users/wish_lists_controller.rb

@@ -0,0 +1,128 @@
+module Workarea
+  module Storefront
+    class Users::WishListsController < Storefront::ApplicationController
+      skip_before_action :verify_authenticity_token, only: [:add_item]
+      before_action :store_item_in_session, only: :add_item, unless: :logged_in?
+      before_action :store_item_in_session_when_moving_to_cart, only: :create_from_cart_item, unless: :logged_in?
+      before_action :require_login_and_redirect
+      before_action :add_item_from_session, only: :show, if: :item_stored_in_session?
+      before_action :validate_customizations, only: :add_item
+
+      def show
+        WishList::Pricing.perform(current_wish_list)
+        @wish_list = WishListViewModel.new(
+          current_wish_list,
+          view_model_options
+        )
+      end
+
+      def update
+        current_wish_list.update_attributes(params.permit(:privacy))
+        flash[:success] =
+          t('workarea.storefront.flash_messages.wish_list_updated')
+        redirect_to users_wish_list_path
+      end
+
+      def update_item_quantity
+        if current_wish_list.update_item_quantity(params[:item_id], params[:quantity].to_i)
+          flash[:success] =
+            t('workarea.storefront.flash_messages.wish_list_item_updated')
+        end
+        redirect_to users_wish_list_path
+      end
+
+      def create_from_cart_item
+        item = current_order.items.find(params[:item_id])
+        current_wish_list.add_item(
+          item.product_id,
+          item.sku,
+          item.quantity,
+          OrderItemDetails.find!(item.sku).to_h,
+          item.customizations
+        )
+        current_order.remove_item(params[:item_id])
+
+        flash[:success] =
+          t('workarea.storefront.flash_messages.item_moved_to_wish_list')
+        redirect_to users_wish_list_path
+      end
+
+      def add_item
+        current_wish_list.add_item(
+          product_id,
+          sku,
+          params[:quantity].to_i,
+          OrderItemDetails.find!(sku).to_h,
+          customizations.try(:to_h) || {}
+        )
+        flash[:success] =
+          t('workarea.storefront.flash_messages.wish_list_item_added')
+        redirect_to users_wish_list_path
+      end
+
+      def remove_item
+        current_wish_list.remove_item(params[:sku])
+        flash[:success] =
+          t('workarea.storefront.flash_messages.wish_list_item_removed')
+        redirect_to users_wish_list_path
+      end
+
+      private
+
+      def require_login_and_redirect
+        remember_location(users_wish_list_path) unless logged_in?
+        require_login
+      end
+
+      def current_wish_list
+        @wish_list ||= WishList.for_user(current_user.id)
+      end
+
+      def store_item_in_session
+        wish_list_session.store_item(params.merge(customizations: customizations.try(:to_h) || {}))
+      end
+
+      def store_item_in_session_when_moving_to_cart
+        item = current_order.items.where(id: params[:item_id]).first
+        wish_list_session.store_item(item.attributes.merge(item_id: params[:item_id]))
+      end
+
+      def add_item_from_session
+        item_id = session[:wish_list_item_id]
+
+        wish_list_session.add_item(current_wish_list)
+        current_order.remove_item(item_id) if item_id.present?
+      end
+
+      def wish_list_session
+        WishListSession.new(session)
+      end
+
+      def item_stored_in_session?
+        session.key?(:wish_list_product_id)
+      end
+
+      def customizations
+        @customizations ||= Catalog::Customizations.find(product_id, params.to_unsafe_h)
+      end
+
+      def validate_customizations
+        if customizations.present? && !customizations.valid?
+          flash[:error] = customizations.errors.full_messages.join(', ')
+          product = Catalog::Product.find(product_id)
+
+          redirect_back(fallback_location: product_path(product))
+          return false
+        end
+      end
+
+      def product_id
+        params[:product_id]
+      end
+
+      def sku
+        params[:sku]
+      end
+    end
+  end
+end