workarea-product_badges 1.3.2

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.seconds.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,91 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Attempt to read encrypted secrets from `config/secrets.yml.enc`.
+  # Requires an encryption key in `ENV["RAILS_MASTER_KEY"]` or
+  # `config/secrets.yml.key`.
+  config.read_encrypted_secrets = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  # config.active_record.dump_schema_after_migration = false
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,44 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.seconds.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  config.action_view.raise_on_missing_translations = true
+
+  config.cache_store = :null_store
+end

data/test/dummy/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/test/dummy/config/initializers/assets.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+# Add Yarn node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join('node_modules')
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/test/dummy/config/initializers/workarea.rb

@@ -0,0 +1,5 @@
+Workarea.configure do |config|
+  # Basic site info
+  config.site_name = 'Workarea Badges'
+  config.host = 'www.example.com'
+end

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/puma.rb

@@ -0,0 +1,56 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# If you are preloading your application and using Active Record, it's
+# recommended that you close any connections to the database before workers
+# are forked to prevent connection leakage.
+#
+# before_fork do
+#   ActiveRecord::Base.connection_pool.disconnect! if defined?(ActiveRecord)
+# end
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted, this block will be run. If you are using the `preload_app!`
+# option, you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, as Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+#
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,32 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+# Shared secrets are available across all environments.
+
+# shared:
+#   api_key: a1B2c3D4e5F6
+
+# Environmental secrets are only available for that specific environment.
+
+development:
+  secret_key_base: 75b70e890639a171b634affb1d3f58a93142c0dd9e9e4e2631b008435ed593d1d8dc689288ca3d7b1b5e58ea091b8f992fddbeb8238da7fe03db0f02e39c242f
+
+test:
+  secret_key_base: 29fd6d44ee68c2b8b190449faf9ba6e9b045445d0cebf32abb28936bd4af877f1ffa0cda57c4741bc498a8b0c86bd7b46803b43b5d96a076f32d6d99f54e34f0
+
+# Do not keep production secrets in the unencrypted secrets file.
+# Instead, either read values from the environment.
+# Or, use `bin/rails secrets:setup` to configure encrypted secrets
+# and move the `production:` environment over there.
+
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/test/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/test/dummy/db/seeds.rb

@@ -0,0 +1,2 @@
+require 'workarea/seeds'
+Workarea::Seeds.run

data/test/dummy/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "dummy",
+  "private": true,
+  "dependencies": {}
+}

data/test/integration/workarea/admin/products_badging_integration_test.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module Admin
+    class ProductsBadgingIntegrationTest
+      def test_updates_a_product_with_custom_badges
+        product = create_product(variants: [])
+
+        patch admin.catalog_product_path(product),
+          params: { product: { badges: ["Test", "Custom", "Badges"] } }
+
+        product.reload
+        assert_equal(["Test", "Custom", "Badges"], product.badges)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require "test_helper"
+
+module Workarea
+  module Admin
+    class ProductBadgesSystemTest < Workarea::SystemTest
+      include Admin::IntegrationTest
+
+      setup :product
+
+      def product
+        @product ||= create_product(
+          badges: ["Custom Badge"]
+        )
+      end
+
+      def test_adding_a_custom_badge
+        visit admin.catalog_product_path(@product)
+
+        click_link "Attributes"
+
+        fill_in "product[badges_list]", with: "Custom Badge, New Badge"
+
+        click_button "save_product"
+        assert(page.has_content?("Success"))
+        assert_current_path(admin.catalog_product_path(@product))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require "test_helper"
+
+module Workarea
+  module Storefront
+    class ProductBadgesSystemTest < Workarea::SystemTest
+      include Storefront::SystemTest
+
+      setup :set_products
+
+      def set_products
+        @products =
+          [
+            create_product(id:          "PROD1",
+                           name:        "New Badge Product",
+                           created_at:  Time.current - 1.hour,
+                           variants:    [{ sku: "SKU1", regular: 10.to_m }]),
+            create_product(id:          "PROD2",
+                           name:        "Sale Badge Product",
+                           created_at:  Time.current - 60.days,
+                           variants:    [{
+                             sku: "SKU2",
+                             regular: 10.to_m,
+                             on_sale: true,
+                             sale: 5.to_m
+                           }]),
+            create_product(id:          "PROD3",
+                           name:        "Custom Badge Product",
+                           created_at:  Time.current - 60.days,
+                           badges:      ["Custom Badge"],
+                           variants:    [{ sku: "SKU3", regular: 10.to_m }]),
+            create_product(id:          "PROD4",
+                           name:        "Multiple Badges Product",
+                           created_at:  Time.current - 1.days,
+                           badges: ["Custom Badge", "Another Badge"],
+                           variants:    [{
+                             sku: "SKU4",
+                             regular: 10.to_m,
+                             on_sale: true,
+                             sale: 5.to_m
+                           }]),
+          ]
+      end
+
+      def categorize_products(category)
+        category.update_attributes!(
+          product_ids: [@products.first.id, @products.second.id, @products.third.id]
+        )
+      end
+
+      def test_badges_are_displayed
+        category = create_category
+        categorize_products(category)
+
+        visit storefront.category_path(category)
+
+        assert(page.has_content?("New"))
+        assert(page.has_content?("Sale"))
+        assert(page.has_content?("Custom Badge"))
+      end
+    end
+  end
+end

data/test/teaspoon_env.rb

@@ -0,0 +1,6 @@
+require "workarea/testing/teaspoon"
+
+Teaspoon.configure do |config|
+  config.root = Workarea::ProductBadges::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/test/view_models/workarea/storefront/product_view_model_badging_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+
+module Workarea
+  module Storefront
+    class ProductViewModelBadgingTest < TestCase
+      def test_badges_returns_array_of_badges
+        product = create_product(name: "test", badges: ["Test"])
+
+        badges = ProductViewModel.new(product).badges
+        assert_equal(["New", "Test"], badges)
+      end
+
+      def test_automatic_badges_returns_new_badge
+        product = create_product(name: "test")
+        automatic_badges = ProductViewModel.new(product).automatic_badges
+        assert_equal(["New"], automatic_badges)
+      end
+
+      def test_automatic_badges_returns_sale_badge
+        product = create_product(
+          variants: [{
+            sku: "SKU4",
+            regular: 10.to_m,
+            on_sale: true,
+            sale: 5.to_m
+          }]
+        )
+        automatic_badges = ProductViewModel.new(product).automatic_badges
+
+        assert_equal(["New", "Sale"], automatic_badges)
+      end
+
+      def test_automatic_badges_returns_best_seller_badge
+        product = create_product(id: "foo")
+        product_two = create_product(id: "bar")
+        create_top_products(results: [{ product_id: product.id }, { product_id: product_two.id }])
+
+        automatic_badges = ProductViewModel.new(product).automatic_badges
+        assert_equal(["New", "Best Seller"], automatic_badges)
+      end
+
+      def test_badges_are_sorted_according_to_configuration
+        Workarea.with_config do |config|
+          config.product_badges[:sort] = ->(badges) { badges.sort_by { |b| ["New", "Custom Badge", "Another Badge"].find_index(b) || 999 } }
+
+          product = create_product(
+            id: "PROD4",
+            name: "Multiple Badges Product",
+            created_at:  Time.current - 1.days,
+            badges: ["Custom Badge", "Another Badge"],
+            variants: [{
+              sku: "SKU4",
+              regular: 10.to_m,
+              on_sale: true,
+              sale: 5.to_m
+            }]
+          )
+
+          badges = ProductViewModel.new(product).badges
+
+          assert_equal(["New", "Custom Badge", "Another Badge", "Sale"], badges)
+        end
+      end
+
+      def test_badges_limited_by_max_badges_config
+        Workarea.with_config do |config|
+          config.product_badges[:max_badges] = 1
+
+          product = create_product(
+            name: "Two Badges Product",
+            badges: ["One", "Two"]
+          )
+
+          badges = ProductViewModel.new(product).badges
+
+          assert_equal(1, badges.count)
+        end
+      end
+    end
+  end
+end