workarea-shipping_message 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5e1225408130adc4eb18bf709026998b277db84b1a745e18e2429257bab1938
+  data.tar.gz: 82b4faf8d0ec2c646a9abfc8a3019bb37b71f1a251c22db8588ffc664c3996ba
+SHA512:
+  metadata.gz: ed38dadb210e1bbd5ce3599cc1c67eff9eceef12098f642399a684dfc4ec1d62436845661c470f9b24d4a1f6fcca0d07d2eb3716138a4c6b81d215e43c2ca072
+  data.tar.gz: 3d07b7a90cf5d48abf186f987bc0fce5590ecf4c7a61dec0da66bc7fc8bbf3d9ca5f0506af788dacb75cc76d7c30a9dc1d5bc7bd599809d8fd26627ab2d1c8dd

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+Gemfile.lock
+.sass-cache/
+log/*.log
+pkg/
+coverage/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+test/dummy/public/system
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+Workarea Shipping Message 1.2.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+*   Upgrade for v3.5 compatibility
+
+    Ben Crouse
+
+
+
+Workarea Shipping Message 1.1.0 (2019-04-16)
+--------------------------------------------------------------------------------
+
+*   Update for v3.4 compatibility
+
+    * Update admin pricing_discounts/cards to include metrics card
+    * Add minimum version requirement
+
+    SHIPPNGMSG-6
+    Jake Beresford
+
+
+
+Workarea Shipping Message 1.0.0 (2018-03-21)
+--------------------------------------------------------------------------------
+
+*   Upgrade for v3 compatibility
+
+    In addition to standard upgrade tasks this plugin was significantly refactored to be more conventional. The implementation was updated with a Discount::Message concern which is extended in Pricing::Discount::Shipping removing the need for a custom settings object and unconventional configuration on the host app. This change should also make it more intuitive to add discount messages to other discount types if necessary. Additional logic would need to be defined to achieve this.
+
+    * Discount::Message uses {amount} keyword that is gsubbed for the amount delta in the view_model
+    * Rename everything, update decorators, change before_filter to before_action
+    * Add dotfiles and bamboo dependencies
+    * Update cart view model decorator so it works
+    * Add translations
+    * Move admin UI into discounts UI
+    * Convert tests to minitest
+
+    SHIPPNGMSG-5
+    Jake Beresford
+
+
+

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,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'workarea', git: 'https://github.com/workarea-commerce/workarea.git'
+
+group :test do
+  gem "simplecov", require: false
+end

data/LICENSE.md

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

data/README.md

@@ -0,0 +1,40 @@
+Workarea Shipping Message
+================================================================================
+
+Discount messaging plugin for the Workarea platform.
+
+Out of the box this plugin adds messaging to the cart to let a customer know how
+close they are to receiving a free shipping discount.
+
+The plugin includes seed data that sets up a free shipping discount with message.
+
+Configuration
+--------------------------------------------------------------------------------
+
+No additional configuration is necessary to use this plugin with free shipping messaging.
+
+Other discount types can be configured to allow messaging.
+To configure another discount type for messaging you will need to
+
+1. Decorate the discount type and include Pricing::Discount::Message
+2. Add a method called discount_message_valid? to the decorated discount type.
+    See workarea-shipping-message/app/models/workarea/pricing/discount/shipping.decorator
+    for an example.
+3. Create a new discount that meets the criteria of your discount_message_valid?
+    method
+4. Add a method to render your discount message along with any necessary logic to
+    the relevant view_model for where your message will be displayed.
+5. Call the discount render method in the view where your message will be displayed
+
+If you think your new discount message might be a useful addition to this plugin
+please include a member of the plugin team on your pull request or open a PR against
+this plugin.
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,42 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+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/shipping_message/version"
+
+desc "Release version #{Workarea::ShippingMessage::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::ShippingMessage::VERSION} -m 'Tagging #{Workarea::ShippingMessage::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-shipping_message.gemspec"
+  system "gem push workarea-shipping_message-#{Workarea::ShippingMessage::VERSION}.gem --host #{host}"
+  system "rm workarea-shipping_message-#{Workarea::ShippingMessage::VERSION}.gem"
+end

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

@@ -0,0 +1,8 @@
+module Workarea
+  decorate Admin::PricingDiscountsController, with: :shipping_message do
+    def message
+      discount = Pricing::Discount.find(params[:id])
+      @discount = Admin::DiscountViewModel.wrap(discount, view_model_options)
+    end
+  end
+end

data/app/models/workarea/pricing/discount/message.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module Pricing
+    class Discount
+      module Message
+        extend ActiveSupport::Concern
+
+        included do
+          field :message, type: String, localize: true
+          field :message_active, type: Boolean, default: false
+          field :message_applied, type: String, localize: true
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/pricing/discount/shipping.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Pricing::Discount::Shipping, with: :discount_message do
+    decorated do
+      include Pricing::Discount::Message
+    end
+
+    def discount_message_valid?
+      order_total? && order_total_operator == :greater_than
+    end
+  end
+end

data/app/seeds/workarea/free_shipping_promo_seeds.rb

@@ -0,0 +1,24 @@
+module Workarea
+  class FreeShippingPromoSeeds
+    def perform
+      puts "Adding free shipping discount with message..."
+
+      create_shipping_message_discount
+    end
+
+    def create_shipping_message_discount
+      shipping_service = Shipping::Service.where(name: "Ground").first || Shipping::Service.all.first
+
+      discount = Pricing::Discount::Shipping.create!(
+        name: "Free Shipping Over $50",
+        shipping_service: shipping_service,
+        amount: 0.to_m,
+        order_total_operator: :greater_than,
+        order_total: 50.to_m,
+        message_active: true,
+        message_applied: "You got FREE SHIPPING!",
+        message: "You're only {amount} away from FREE SHIPPING!"
+      )
+    end
+  end
+end

data/app/view_models/workarea/storefront/cart_view_model.decorator

@@ -0,0 +1,49 @@
+module Workarea
+  decorate Storefront::CartViewModel, with: 'ShippingMessage' do
+    decorated do
+      include ActionView::Helpers::NumberHelper
+    end
+
+    def free_shipping_discount
+      discount ||= Workarea::Pricing::Discount.where(
+        order_total_operator: :greater_than,
+        amount: 0.to_m,
+        message_active: true
+      ).first
+
+      return nil unless discount.present? && discount.active? && discount.discount_message_valid?
+
+      discount ||= if shipping.present? && shipping.shipping_service.present?
+                  shipping.price_adjustments.detect do |discount|
+                    discount.shipping_service.id == shipping_service.id
+                  end
+                else
+                  discount
+                end
+    end
+
+    def amount_away_from_free_shipping
+      discount ||= free_shipping_discount
+
+      return nil unless discount.present?
+
+      discount.order_total - subtotal_price
+    end
+
+    def free_shipping_message
+      amount_delta ||= amount_away_from_free_shipping
+      return nil unless amount_delta.present?
+
+      if amount_delta > 0
+        free_shipping_discount.message.gsub(/{amount}/, number_to_currency(amount_delta))
+      else
+        free_shipping_discount.message_applied
+      end
+    end
+
+    private
+      def shipping
+        Workarea::Shipping.find_by_order(model.id)
+      end
+  end
+end