workarea-gift_wrapping 1.2.1

data/test/integration/workarea/storefront/gift_wrapping_integration_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class GiftWrappingIntegrationTest < Workarea::IntegrationTest
+      def test_items_that_cannot_be_gift_wrapped
+        product = create_product(allow_gift_wrapping: false)
+        shipping_service = create_shipping_service
+        gift_wrap = create_gift_wrap
+
+        post storefront.cart_items_path,
+          params: {
+            product_id: product.id,
+            sku: product.skus.first,
+            quantity: 1
+          }
+
+        patch storefront.checkout_addresses_path,
+          params: {
+            email: 'bcrouse@weblinc.com',
+            billing_address: {
+              first_name: 'Ben',
+              last_name: 'Crouse',
+              street: '12 N. 3rd St.',
+              city: 'Philadelphia',
+              region: 'PA',
+              postal_code: '19106',
+              country: 'US',
+              phone_number: '2159251800'
+            },
+            shipping_address: {
+              first_name: 'Ben',
+              last_name: 'Crouse',
+              street: '22 S. 3rd St.',
+              city: 'Philadelphia',
+              region: 'PA',
+              postal_code: '19106',
+              country: 'US',
+              phone_number: '2159251800'
+            }
+          }
+
+        get storefront.checkout_shipping_path
+        assert_includes(
+          response.body,
+          t('workarea.storefront.checkouts.gift_wrapping_unavailable')
+        )
+
+        order = Order.first
+        patch storefront.checkout_shipping_path,
+          params: {
+            shipping_service: shipping_service.name,
+            gift_wrapping: { order.items.first.id => { gift_wrap: gift_wrap.id } }
+          }
+
+        get storefront.checkout_payment_path
+        patch storefront.checkout_place_order_path,
+          params: {
+            payment: 'new_card',
+            credit_card: {
+              number: 1,
+              month: 1,
+              year: Time.current.year + 1,
+              cvv: '999'
+            }
+          }
+
+        assert_equal(1, Order.placed.count)
+
+        refute(order.reload.items.first.allow_gift_wrapping?)
+        assert(order.items.first.gift_wrap_quantities.blank?)
+        assert(order.items.first.gift_wraps_attributes.blank?)
+      end
+    end
+  end
+end

data/test/models/workarea/checkout/steps/gift_wrapping_shipping_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Workarea
+  class Checkout
+    module Steps
+      class GiftWrappingShippingTest < TestCase
+        def test_update
+          order = create_order(items: [])
+          order.add_item(
+            product_id: '1234',
+            sku: 'SKU',
+            quantity: 2,
+            product_attributes: { allow_gift_wrapping: true }
+          )
+
+          checkout = Checkout.new(order)
+          step = Steps::Shipping.new(checkout)
+
+          gift_wrap = create_gift_wrap(name: 'Simple', sku: 'GW01')
+
+          step.update(
+            gift_message: 'Foo bar',
+            gift_wrapping: {
+              order.items.first.id.to_s => { gift_wrap: gift_wrap.id.to_s }
+            }
+          )
+
+          assert_equal('Foo bar', checkout.shipping.reload.gift_message)
+
+          item = order.reload.items.first
+          assert_equal({ 'GW01' => 2 }, item.gift_wrap_quantities)
+          assert_equal(gift_wrap.id, item.gift_wraps_attributes.first['_id'])
+        end
+      end
+    end
+  end
+end

data/test/models/workarea/order/gift_wrapping_item_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module Workarea
+  class Order
+    class GiftWrappingItemTest < TestCase
+      def test_quantity
+        item = Order::Item.new(
+          quantity: 1,
+          gift_wrap_quantities: { 'GW01' => 1 }
+        )
+
+        item.quantity = 3
+        assert_equal(3, item.quantity)
+        assert_equal({ 'GW01' => 3 }, item.gift_wrap_quantities)
+      end
+
+      def test_reset_gift_wrapping
+        wrap = create_gift_wrap(name: 'Test', sku: 'GW01')
+
+        item = Order::Item.new(
+          quantity: 2,
+          gift_wrap_quantities: { 'GW01' => 2 },
+          gift_wraps_attributes: [wrap.as_document]
+        )
+
+        item.reset_gift_wrapping
+        assert_empty(item.gift_wrap_quantities)
+        assert_empty(item.gift_wraps_attributes)
+      end
+
+      def test_add_gift_wrap
+        wrap = create_gift_wrap(name: 'Test', sku: 'GW01')
+        item = Order::Item.new(quantity: 3)
+
+        item.add_gift_wrap(wrap.as_document, 1)
+
+        assert_equal({ 'GW01' => 1 }, item.gift_wrap_quantities)
+        assert_equal(1, item.gift_wraps_attributes.count)
+
+        item.add_gift_wrap(wrap.as_document)
+
+        assert_equal({ 'GW01' => 3 }, item.gift_wrap_quantities)
+        assert_equal(1, item.gift_wraps_attributes.count)
+
+        item.add_gift_wrap(wrap.as_document, 10)
+
+        assert_equal({ 'GW01' => 3 }, item.gift_wrap_quantities)
+        assert_equal(1, item.gift_wraps_attributes.count)
+      end
+    end
+  end
+end

data/test/models/workarea/pricing/calculators/gift_wrapping_calculator_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+module Workarea
+  module Pricing
+    module Calculators
+      class GiftWrappingCalculatorTest < TestCase
+        setup :setup_gift_wraps
+
+        def setup_gift_wraps
+          create_gift_wrap(name: 'Standard', sku: 'GW1', pricing: { tax_code: '001', prices: [{ regular: 2.to_m }] })
+          create_gift_wrap(name: 'Special', sku: 'GW2', pricing: { tax_code: '002', prices: [{ regular: 1.to_m }] })
+        end
+
+        def test_adjust
+          order = Order.new
+          order.add_item(product_id: 'PRODUCT', sku: 'SKU1', quantity: 2, gift_wrap_quantities: { 'GW1' => 2 })
+          order.add_item(product_id: 'PRODUCT', sku: 'SKU2', quantity: 1, gift_wrap_quantities: { 'GW2' => 1 })
+
+          GiftWrappingCalculator.test_adjust(order)
+
+          assert_equal(1, order.items.first.price_adjustments.length)
+          assert_equal('item', order.items.first.price_adjustments.first.price)
+          assert_equal(4.to_m, order.items.first.price_adjustments.first.amount)
+          assert_equal('001', order.items.first.price_adjustments.first.data['tax_code'])
+          assert_equal(
+            I18n.t('workarea.gift_wrap.price_adjustment'),
+            order.items.first.price_adjustments.first.description
+          )
+
+          assert_equal(1, order.items.second.price_adjustments.length)
+          assert_equal('item', order.items.second.price_adjustments.first.price)
+          assert_equal(1.to_m, order.items.second.price_adjustments.first.amount)
+          assert_equal('002', order.items.second.price_adjustments.first.data['tax_code'])
+          assert_equal(
+            I18n.t('workarea.gift_wrap.price_adjustment'),
+            order.items.second.price_adjustments.first.description
+          )
+        end
+
+        # Note: Orders like this are not possible in the UI, but gift wrapping
+        # is modeled in such a way that it can be done if the interface to build
+        # it was added as a customization.
+        def test_adjust_with_partial_and_mixed_wrappings
+          order = Order.new
+          order.add_item(product_id: 'PRODUCT', sku: 'SKU1', quantity: 3, gift_wrap_quantities: { 'GW1' => 1, 'GW2' => 2 })
+          order.add_item(product_id: 'PRODUCT', sku: 'SKU2', quantity: 2, gift_wrap_quantities: { 'GW2' => 1 })
+
+          GiftWrappingCalculator.test_adjust(order)
+
+          assert_equal(2, order.items.first.price_adjustments.length)
+
+          assert_equal('item', order.items.first.price_adjustments.first.price)
+          assert_equal(1, order.items.first.price_adjustments.first.quantity)
+          assert_equal(2.to_m, order.items.first.price_adjustments.first.amount)
+          assert_equal('001', order.items.first.price_adjustments.first.data['tax_code'])
+          assert_equal(
+            I18n.t('workarea.gift_wrap.price_adjustment'),
+            order.items.first.price_adjustments.first.description
+          )
+
+          assert_equal('item', order.items.first.price_adjustments.second.price)
+          assert_equal(2.to_m, order.items.first.price_adjustments.second.amount)
+          assert_equal(2, order.items.first.price_adjustments.second.quantity)
+          assert_equal('002', order.items.first.price_adjustments.second.data['tax_code'])
+          assert_equal(
+            I18n.t('workarea.gift_wrap.price_adjustment'),
+            order.items.first.price_adjustments.first.description
+          )
+
+          assert_equal(1, order.items.second.price_adjustments.length)
+
+          assert_equal('item', order.items.second.price_adjustments.first.price)
+          assert_equal(1.to_m, order.items.second.price_adjustments.first.amount)
+          assert_equal(1, order.items.second.price_adjustments.first.quantity)
+          assert_equal('002', order.items.second.price_adjustments.first.data['tax_code'])
+          assert_equal(
+            I18n.t('workarea.gift_wrap.price_adjustment'),
+            order.items.second.price_adjustments.first.description
+          )
+        end
+      end
+    end
+  end
+end

data/test/system/workarea/admin/gift_wrap_system_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+module Workarea
+  module Admin
+    class GiftWrapSystemTest < Workarea::SystemTest
+      include Admin::IntegrationTest
+
+      def test_managing_gift_wraps
+        visit admin.catalog_gift_wraps_path
+
+        click_link t('workarea.admin.catalog_gift_wraps.index.button')
+
+        fill_in 'gift_wrap[name]', with: 'Test'
+        fill_in 'gift_wrap[sku]', with: 'GIFT_WRAP'
+        fill_in 'pricing_sku[regular]', with: '2.50'
+        click_button t('workarea.admin.catalog_gift_wraps.new.button')
+
+        assert(page.has_content?('Success'))
+        assert(page.has_content?('Test'))
+        assert(page.has_content?('GIFT_WRAP'))
+
+        click_link 'Test'
+
+        click_link t('workarea.admin.catalog_gift_wraps.edit.view_pricing')
+        assert_current_path(admin.pricing_sku_path('GIFT_WRAP'))
+        assert(page.has_content?('2.50'))
+
+        visit admin.catalog_gift_wraps_path
+        click_link 'Test'
+
+        fill_in 'gift_wrap[name]', with: 'Fancy'
+        click_button t('workarea.admin.catalog_gift_wraps.edit.button')
+
+        assert(page.has_content?('Success'))
+        assert(page.has_no_content?('Test'))
+        assert(page.has_content?('Fancy'))
+        assert(page.has_content?('GIFT_WRAP'))
+
+        click_link 'Fancy'
+        click_link t('workarea.admin.actions.delete')
+
+        assert(page.has_content?('Success'))
+        assert(page.has_no_content?('Fancy'))
+        assert(page.has_no_content?('GIFT_WRAP'))
+      end
+    end
+  end
+end

data/test/system/workarea/storefront/gift_wrap_system_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class GiftWrapSystemTest < Workarea::SystemTest
+      include Storefront::SystemTest
+
+      setup :setup_checkout_specs, :setup_gift_wrap, :start_guest_checkout
+
+      def setup_gift_wrap
+        create_gift_wrap(name: 'Standard', sku: 'GW1', pricing: { tax_code: '001', prices: [{ regular: 1.to_m }] })
+        create_gift_wrap(name: 'Special', sku: 'GW2', pricing: { tax_code: '001', prices: [{ regular: 1.5.to_m }] })
+      end
+
+      def test_successfully_checking_out
+        assert_current_path(storefront.checkout_addresses_path)
+        fill_in_email
+        fill_in_shipping_address
+        uncheck 'same_as_shipping'
+        fill_in_billing_address
+        click_button t('workarea.storefront.checkouts.continue_to_shipping')
+
+        assert_current_path(storefront.checkout_shipping_path)
+        assert(page.has_content?('Success'))
+
+        fill_in 'gift_message', with: 'test gift message is here'
+
+        item = Order.last.items.first
+        select 'Special', from: "gift_wrapping[#{item.id}][gift_wrap]"
+
+        click_button t('workarea.storefront.checkouts.continue_to_payment')
+
+        assert_current_path(storefront.checkout_payment_path)
+        assert(page.has_content?('Success'))
+
+        assert(page.has_content?(t('workarea.storefront.checkouts.gift_message')))
+        assert(page.has_content?('test gift message is here'))
+        assert(page.has_content?('Special'))
+        assert(page.has_content?(t('workarea.gift_wrap.price_adjustment')))
+        assert(page.has_content?('$1.50')) # gift wrapping
+
+        assert(page.has_content?('22 S. 3rd St.'))
+        assert(page.has_content?('Philadelphia'))
+        assert(page.has_content?('PA'))
+        assert(page.has_content?('19106'))
+        assert(page.has_content?('Ground'))
+
+        assert(page.has_content?('Integration Product'))
+        assert(page.has_content?('SKU'))
+
+        assert(page.has_content?('$6.50')) # Subtotal
+        assert(page.has_content?('$7.00')) # Shipping
+        assert(page.has_content?('$0.94')) # Tax
+        assert(page.has_content?('$14.44')) # Total
+
+        fill_in_credit_card
+        click_button t('workarea.storefront.checkouts.place_order')
+
+        assert_current_path(storefront.checkout_confirmation_path)
+
+        assert(page.has_content?('Success'))
+        assert(page.has_content?(t('workarea.storefront.flash_messages.order_placed')))
+        assert(page.has_content?(Order.first.id))
+
+        assert(page.has_content?('22 S. 3rd St.'))
+        assert(page.has_content?('Philadelphia'))
+        assert(page.has_content?('PA'))
+        assert(page.has_content?('19106'))
+        assert(page.has_content?('Ground'))
+
+        assert(page.has_content?('1019 S. 47th St.'))
+        assert(page.has_content?('Philadelphia'))
+        assert(page.has_content?('PA'))
+        assert(page.has_content?('19143'))
+
+        assert(page.has_content?('Test Card'))
+        assert(page.has_content?('XX-1'))
+
+        assert(page.has_content?('Integration Product'))
+        assert(page.has_content?('SKU'))
+
+        assert(page.has_content?(t('workarea.storefront.checkouts.gift_message')))
+        assert(page.has_content?('test gift message is here'))
+        assert(page.has_content?('Special'))
+
+        assert(page.has_content?('$6.50')) # Subtotal
+        assert(page.has_content?('$7.00')) # Shipping
+        assert(page.has_content?('$0.94')) # Tax
+        assert(page.has_content?('$14.44')) # Total
+      end
+    end
+  end
+end

data/test/teaspoon_env.rb

@@ -0,0 +1,6 @@
+require 'workarea/testing/teaspoon'
+
+Teaspoon.configure do |config|
+  config.root = Workarea::GiftWrapping::Engine.root
+  Workarea::Teaspoon.apply(config)
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
+require 'rails/test_help'
+require 'workarea/test_help'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new

data/workarea-gift_wrapping.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'workarea/gift_wrapping/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'workarea-gift_wrapping'
+  s.version     = Workarea::GiftWrapping::VERSION
+  s.authors     = ['Matt Duffy']
+  s.email       = ['mduffy@workarea.com']
+  s.homepage    = 'https://github.com/workarea-commerce/workarea-gift-wrapping'
+  s.summary     = 'Gift wrapping plugin for the Workarea Commerce Platform'
+  s.description = 'Workarea Commerce Platform plugin that provides Gift message and wrapping options during checkout.'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.license = 'Business Software License'
+
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.2.x'
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: workarea-gift_wrapping
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Matt Duffy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workarea
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.x
+description: Workarea Commerce Platform plugin that provides Gift message and wrapping
+  options during checkout.
+email:
+- mduffy@workarea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/documentation-request.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/workarea/admin/catalog_gift_wraps_controller.rb
+- app/models/workarea/catalog/gift_wrap.rb
+- app/models/workarea/catalog/product.decorator
+- app/models/workarea/checkout/steps/shipping.decorator
+- app/models/workarea/order/item.decorator
+- app/models/workarea/pricing/calculators/gift_wrapping_calculator.rb
+- app/models/workarea/pricing/request.decorator
+- app/models/workarea/shipping.decorator
+- app/seeds/workarea/gift_wrapping_seeds.rb
+- app/view_models/workarea/order_item_view_model.decorator
+- app/view_models/workarea/storefront/checkout/gift_options_view_model.rb
+- app/view_models/workarea/storefront/checkout/summary_view_model.decorator
+- app/views/workarea/admin/catalog_gift_wraps/_aux_navigation.html.haml
+- app/views/workarea/admin/catalog_gift_wraps/_navigation.html.haml
+- app/views/workarea/admin/catalog_gift_wraps/edit.html.haml
+- app/views/workarea/admin/catalog_gift_wraps/index.html.haml
+- app/views/workarea/admin/catalog_gift_wraps/new.html.haml
+- app/views/workarea/admin/catalog_products/_gift_wrapping_fields.html.haml
+- app/views/workarea/admin/orders/_gift_wrapping.html.haml
+- app/views/workarea/admin/shippings/_gift_message.html.haml
+- app/views/workarea/storefront/checkouts/_gift_message.html.haml
+- app/views/workarea/storefront/checkouts/_gift_message_summary.html.haml
+- app/views/workarea/storefront/checkouts/_gift_wrapping.html.haml
+- app/views/workarea/storefront/checkouts/_gift_wrapping_summary.html.haml
+- app/views/workarea/storefront/order_mailer/_gift_message.html.haml
+- app/views/workarea/storefront/order_mailer/_gift_message.text.erb
+- app/views/workarea/storefront/order_mailer/_gift_wrapping.html.haml
+- app/views/workarea/storefront/order_mailer/_gift_wrapping.text.erb
+- app/views/workarea/storefront/orders/_gift_message.html.haml
+- app/views/workarea/storefront/orders/_gift_wrapping.html.haml
+- bin/rails
+- config/initializers/appends.rb
+- config/initializers/configuration.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/workarea/gift_wrapping.rb
+- lib/workarea/gift_wrapping/engine.rb
+- lib/workarea/gift_wrapping/version.rb
+- test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/mailer.html.erb
+- test/dummy/app/views/layouts/mailer.text.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/bin/update
+- test/dummy/bin/yarn
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/cable.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/workarea.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/puma.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/config/spring.rb
+- test/dummy/db/seeds.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/factories/workarea/gift_wrapping.rb
+- test/integration/workarea/admin/catalog_gift_wrap_integration_test.rb
+- test/integration/workarea/storefront/gift_wrapping_integration_test.rb
+- test/models/workarea/checkout/steps/gift_wrapping_shipping_test.rb
+- test/models/workarea/order/gift_wrapping_item_test.rb
+- test/models/workarea/pricing/calculators/gift_wrapping_calculator_test.rb
+- test/system/workarea/admin/gift_wrap_system_test.rb
+- test/system/workarea/storefront/gift_wrap_system_test.rb
+- test/teaspoon_env.rb
+- test/test_helper.rb
+- workarea-gift_wrapping.gemspec
+homepage: https://github.com/workarea-commerce/workarea-gift-wrapping
+licenses:
+- Business Software License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Gift wrapping plugin for the Workarea Commerce Platform
+test_files: []