workarea-product_badges 1.3.2

data/Rakefile

@@ -0,0 +1,63 @@
+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    = "Product Badges"
+  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/product_badges/version"
+
+desc "Release version #{Workarea::ProductBadges::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::ProductBadges::VERSION} -m 'Tagging #{Workarea::ProductBadges::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-product_badges.gemspec"
+  system "gem push workarea-product_badges-#{Workarea::ProductBadges::VERSION}.gem"
+  system "gem push workarea-product_badges-#{Workarea::ProductBadges::VERSION}.gem --host #{host}"
+  system "rm workarea-product_badges-#{Workarea::ProductBadges::VERSION}.gem"
+end
+
+desc "Run the JavaScript tests"
+ENV["TEASPOON_RAILS_ENV"] = File.expand_path("../test/dummy/config/environment", __FILE__)
+task teaspoon: "app:teaspoon"
+
+desc "Start a server at http://localhost:3000/teaspoon for JavaScript tests"
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path("../test/teaspoon_env.rb", __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/stylesheets/workarea/product_badges/components/_badges.scss

@@ -0,0 +1,47 @@
+/*------------------------------------*\
+    #BADGES
+\*------------------------------------*/
+
+$badges-top-offset: 0 !default;
+$badges-left-offset: 0 !default;
+$badges-product-detail-max-width: 150px !default;
+
+$badge-color: $black !default;
+$badge-background-color: $blue !default;
+$badge-new-background-color: $green !default;
+$badge-sale-background-color: $red !default;
+$badge-best-seller-background-color: $red !default;
+
+
+.badges {
+    position: absolute;
+    top: $badges-top-offset;
+    left: $badges-left-offset;
+    pointer-events: none;
+
+    .product-detail-container & {
+        position: static;
+        max-width: $badges-product-detail-max-width;
+    }
+}
+
+    .badges__badge {
+        margin-top: $spacing-unit;
+        padding: ($spacing-unit / 2) ($spacing-unit * 2);
+        color: $badge-color;
+        background-color: $badge-background-color;
+    }
+
+    .badges__badge--new {
+        background-color: $badge-new-background-color;
+    }
+
+    .badges__badge--sale {
+        background-color: $badge-sale-background-color;
+    }
+
+    .badges__badge--best-seller {
+        background-color: $badge-best-seller-background-color;
+    }
+
+        .badges__badge-text {}

data/app/models/workarea/catalog/product.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Catalog::Product, with: :product_badges do
+    decorated do
+      field :new_badge, type: Boolean, default: true
+      field :sale_badge, type: Boolean, default: true
+      field :best_seller_badge, type: Boolean, default: true
+      field :badges, type: Array, default: []
+      list_field :badges
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Workarea
+  decorate Storefront::ProductViewModel, with: :product_badges do
+    def badges
+      @badges ||= begin
+        badges = Badges.sort.call(model.badges + automatic_badges)
+
+        if Badges.max_badges.present?
+          badges.first(Badges.max_badges)
+        else
+          badges
+        end
+      end
+    end
+
+    def automatic_badges
+      [new_product_badge, sale_badge, best_seller_badge].compact
+    end
+
+    private
+      def new_product_badge
+        if new? && model.new_badge?
+          t("workarea.storefront.products.badges.new")
+        end
+      end
+
+      def sale_badge
+        if on_sale? && model.sale_badge?
+          t("workarea.storefront.products.badges.sale")
+        end
+      end
+
+      def best_seller_badge
+        if best_seller? && model.best_seller_badge?
+          t("workarea.storefront.products.badges.best_seller")
+        end
+      end
+
+      def best_sellers
+        top_seller_limit = Badges.number_of_top_sellers
+        @best_sellers ||= Workarea::Insights::TopProducts.current.results.first(top_seller_limit).map { |p| p["product_id"] }
+      end
+
+      def best_seller?
+        return false unless best_sellers.present?
+        model.id.in?(best_sellers)
+      end
+
+      def new?
+        model.public_send(Workarea.config.product_badges[:new_date_field]) > Badges.new_threshold.days.ago
+      end
+  end
+end

data/app/views/workarea/admin/catalog_products/_badge_fields.html.haml

@@ -0,0 +1,40 @@
+.property
+  = label_tag 'product_badges_list', t('workarea.admin.catalog_products.edit.custom_badges_label'), class: 'property__name'
+  = text_field_tag 'product[badges_list]', @product.badges_list, class: 'text-box'
+  %span.property__note
+    = t('workarea.admin.catalog_products.edit.tags_note')
+    = link_to '#csv-help', data: { tooltip: '' } do
+      = inline_svg('workarea/admin/icons/help.svg', class: 'svg-icon svg-icon--small svg-icon--blue', title: t('workarea.admin.catalog_products.edit.learn_more'))
+
+%h2= t('workarea.admin.catalog_products.edit.auto_badging_enabled')
+
+.grid
+  .grid__cell.grid__cell--25
+    .property
+      %span.property__name
+        = t('workarea.admin.catalog_products.edit.new_product_badge')
+        = link_to '#new-badge-info', data: { tooltip: '' } do
+          = inline_svg('workarea/admin/icons/help.svg', class: 'svg-icon svg-icon--small svg-icon--blue', title: t('workarea.admin.catalog_products.edit.new_product_badge'))
+        #new-badge-info.tooltip-content
+          %p= t('workarea.admin.catalog_products.edit.new_badge_tool_tip', new_threshold: Workarea::Badges.new_threshold)
+      =  toggle_button_for 'product[new_badge]', @product.new_badge
+
+  .grid__cell.grid__cell--25
+    .property
+      %span.property__name
+        = t('workarea.admin.catalog_products.edit.sale_badge')
+        = link_to '#sale-badge-info', data: { tooltip: '' } do
+          = inline_svg('workarea/admin/icons/help.svg', class: 'svg-icon svg-icon--small svg-icon--blue', title: t('workarea.admin.catalog_products.edit.sale_badge'))
+        #sale-badge-info.tooltip-content
+          %p= t('workarea.admin.catalog_products.edit.sale_badge_tool_tip')
+      =  toggle_button_for 'product[sale_badge]', @product.sale_badge
+
+  .grid__cell.grid__cell--25
+    .property
+      %span.property__name
+        = t('workarea.admin.catalog_products.edit.best_seller_badge')
+        = link_to '#best-seller-badge-info', data: { tooltip: '' } do
+          = inline_svg('workarea/admin/icons/help.svg', class: 'svg-icon svg-icon--small svg-icon--blue', title: t('workarea.admin.catalog_products.edit.best_seller_badge'))
+        #best-seller-badge-info.tooltip-content
+          %p= t('workarea.admin.catalog_products.edit.best_seller_badge_tool_tip', top_sellers: Workarea::Badges.number_of_top_sellers)
+      =  toggle_button_for 'product[best_seller_badge]', @product.best_seller_badge

data/app/views/workarea/storefront/products/_badges.haml

@@ -0,0 +1,5 @@
+- if product.badges.present?
+  .badges
+    - product.badges.each do |badge|
+      .badges__badge{ class: "badges__badge--#{badge.parameterize}" }
+        .badges__badge-text= badge

data/bin/rails

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/workarea/product_badges/engine", __FILE__)
+APP_PATH = File.expand_path("../../test/dummy/config/application", __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+require "teaspoon-mocha"
+
+require "rails/engine/commands"

data/config/initializers/appends.rb

@@ -0,0 +1,21 @@
+module Workarea
+  Plugin.append_partials(
+    "admin.product_fields",
+    "workarea/admin/catalog_products/badge_fields"
+  )
+
+  Plugin.append_partials(
+    "storefront.product_summary",
+    "workarea/storefront/products/badges"
+  )
+
+  Plugin.append_partials(
+    "storefront.product_description",
+    "workarea/storefront/products/badges"
+  )
+
+  Plugin.append_stylesheets(
+    "storefront.components",
+    "workarea/product_badges/components/badges"
+  )
+end

data/config/initializers/workarea.rb

@@ -0,0 +1,9 @@
+Workarea.configure do |config|
+  config.product_badges = {
+    new_threshold: 30,
+    new_date_field: :created_at,
+    number_of_top_sellers: 10,
+    max_badges: nil,
+    sort: ->(badges) { badges.sort_by { |b| ["New", "Sale", "Best Seller"].find_index(b) || 999 } }
+  }
+end

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  workarea:
+    admin:
+      catalog_products:
+        edit:
+          auto_badging_enabled: Auto badging enabled for...
+          best_seller_badge: Best Seller badge
+          best_seller_badge_tool_tip: This badge will show if it is in the top %{top_sellers} best selling products.
+          custom_badges_label: Custom badges
+          new_product_badge: New product badge
+          new_badge_tool_tip: This badge will show if the product was created within the last %{new_threshold} days.
+          sale_badge: Sale badge
+          sale_badge_tool_tip: This badge will show if any of the pricing records are set to on sale.
+    storefront:
+      products:
+        badges:
+          best_seller: Best Seller
+          new: New
+          sale: Sale

data/lib/workarea/product_badges/engine.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module ProductBadges
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::ProductBadges
+    end
+  end
+end

data/lib/workarea/product_badges/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module ProductBadges
+    VERSION = "1.3.2"
+  end
+end

data/lib/workarea/product_badges.rb

@@ -0,0 +1,30 @@
+require "workarea"
+require "workarea/storefront"
+require "workarea/admin"
+
+require "workarea/product_badges/engine"
+require "workarea/product_badges/version"
+
+module Workarea
+  module Badges
+    def self.new_threshold
+      config[:new_threshold].try(&:to_i) || 30
+    end
+
+    def self.number_of_top_sellers
+      config[:number_of_top_sellers].try(:to_i) || 10
+    end
+
+    def self.max_badges
+      config[:max_badges].try(:to_i)
+    end
+
+    def self.sort
+      config[:sort]
+    end
+
+    def self.config
+      Workarea.config.product_badges
+    end
+  end
+end

data/script/admin_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:admin

data/script/ci

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bundle exec workarea-lint
+bundle exec workarea-audit
+bin/rails test test/**/*_test.rb

data/script/core_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:core

data/script/plugins_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:plugins

data/script/storefront_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:storefront

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(" ")}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require_relative "boot"
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+require "teaspoon-mocha"
+
+# Workarea must be required before other gems to ensure control over Rails.env
+# for running tests
+require "workarea/core"
+require "workarea/admin"
+require "workarea/storefront"
+Bundler.require(*Rails.groups)
+require "workarea/product_badges"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1
+  channel_prefix: dummy_production

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!