workarea 3.4.12

data/README.md

@@ -0,0 +1,163 @@
+Workarea Commerce Platform
+================================================================================
+[![Build Status](https://travis-ci.com/workarea-commerce/workarea.svg?token=YjqtGLgnbrDJ77Kqw1nV&branch=master)](https://travis-ci.com/workarea-commerce/workarea)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+[Workarea](https://www.workarea.com) is an enterprise-grade commerce platform written in [Ruby on Rails](https://rubyonrails.org). It uses [MongoDB](https://www.mongodb.com), [Elasticsearch](https://www.elastic.co/products/elasticsearch), and [Redis](https://redis.io). Workarea also uses a whole lot of gems you can see in [our gemspec](https://github.com/weblinc/workarea/blob/master/core/workarea-core.gemspec).
+
+[Workarea Commerce Cloud](https://www.workarea.com/pages/commerce-cloud)
+[Documentation](https://developer.workarea.com)
+[Demo](https://github.com/workarea-commerce/workarea#demo)
+[Getting Started](https://github.com/workarea-commerce/workarea#getting-started)
+[Plugins](https://github.com/workarea-commerce/workarea#plugins)
+[Deploying](https://github.com/workarea-commerce/workarea#deploying)
+[Contributing](https://github.com/workarea-commerce/workarea#contributing)
+[Slack](https://www.workarea.com/slack)
+
+![Workarea Screenshot](https://raw.githubusercontent.com/workarea-commerce/workarea/master/docs/source/images/readme-hero.png)
+
+Features
+--------------------------------------------------------------------------------
+Workarea combines commerce, content, search, and insights into a unified platform to enable merchants to move faster and work smarter. Out-of-the-box features include:
+
+**Storefront**
+* Mobile-first frontend
+* Localization support
+* First-class SEO
+* Built-in analytics
+* Cart and checkout
+* Customer accounts
+* Discounts
+* Basic taxes
+* Shipping services
+
+**Content**
+* Responsive CMS
+* Asset management
+* Localized content
+* Intelligent merchandising
+* Content-based navigation
+
+**Search**
+* Product search
+* Search-driven categories
+* Filtering and sorting
+* Search merchandising
+* Results tuning
+* Advanced reporting
+
+**Insights**
+* Robust dashboards
+* Sales reports
+* Trending reports
+* Search reports
+* Advanced insights
+
+**Admin**
+* Site planning and automation
+* Workflows for common tasks
+* Inline insights
+* Search-first administration
+* Commenting
+* Audit logs for changes
+
+
+Demo
+--------------------------------------------------------------------------------
+
+You can run a demo version of workarea by running the following command in your terminal:
+
+```bash
+curl -s https://raw.githubusercontent.com/workarea-commerce/workarea-demo/master/bin/install | bash
+```
+
+This will run a script that does the following:
+
+* clone the [workarea-demo](https://github.com/workarea-commerce/workarea-demo) repository.
+* build a Docker image for the application
+* start containers for the application and required services
+* seed the database
+* start the application server
+
+It requires you have Docker installed and running. Once complete, you can visit `http://localhost:3000` to view your app. The seed data provides an admin user with an email/password of `user@workarea.com/w0rkArea!`.
+
+Getting Started
+--------------------------------------------------------------------------------
+We'll assume you have [Docker desktop](https://www.docker.com/products/docker-desktop) and [Ruby >= 2.4.0, < 2.7.0](https://github.com/rbenv/rbenv#installation) installed.
+
+1. Add the `workarea` gem to the `Gemfile` in your Rails 5.2 app:
+
+        gem 'workarea', '~> 3.4.6'
+
+2. Install the gems:
+
+        $ bundle install
+
+3. Start the workarea services (uses Docker):
+
+        $ bin/rails workarea:services:up
+
+4. Run the Workarea Rails generator:
+
+        $ bin/rails generate workarea:install
+
+   This generator will mount the Workarea engines in `config/routes.rb`, and add Workarea seeds to `db/seeds.rb`.
+
+5. Run the database seeds:
+
+        $ bin/rails db:seed
+
+5. Run the Rails server:
+
+        $ bin/rails server
+
+6. Visit `http://localhost:3000` in a browser and you'll see your Workarea storefront.
+
+For more information on getting started, see the [quick start](https://developer.workarea.com/articles/create-a-new-app.html) guide.
+
+
+Plugins
+--------------------------------------------------------------------------------
+Workarea extends functionality with a library of plugins. These plugins add everything from additional content blocks, to wish lists, to payment gateway integrations and more. Here are some of the most popular plugins:
+
+| Plugin | Description |
+| --- | --- |
+| [API](https://github.com/workarea-commerce/workarea-api) | Provides APIs for storefront and admin |
+| [Blog](https://github.com/workarea-commerce/workarea-blog) | Integrated blogging |
+| [Reviews](https://github.com/workarea-commerce/workarea-reviews) | Adds product reviews |
+| [Google Analytics](https://github.com/workarea-commerce/workarea-google-analytics) | Integrates GA with Workarea's analytics |
+| [Paypal](https://github.com/workarea-commerce/workarea-paypal) | Adds Paypal checkout |
+| [Wish Lists](https://github.com/workarea-commerce/workarea-wish-lists) | Adds customer wish lists |
+| [Sitemaps](https://github.com/workarea-commerce/workarea-sitemaps) | Autogenerating sitemaps |
+| [Share](https://github.com/workarea-commerce/workarea-share) | Adds page sharing via social media or email |
+| [Google Tag Manager](https://github.com/workarea-commerce/workarea-tag-manager) | Adds [Google Tag Manager](https://marketingplatform.google.com/about/tag-manager/) |
+| [Package Products](https://github.com/workarea-commerce/workarea-package-products) | Allows displaying products as a group in browse and details pages |
+| [Gift Cards](https://github.com/workarea-commerce/workarea-gift-cards) | Adds Workarea-native digital gift cards |
+
+Deploying
+--------------------------------------------------------------------------------
+Workarea is fairly complex application to host, we recommend our [Commerce Cloud](https://www.workarea.com/pages/commerce-cloud) hosting.
+
+If you'd like to host on your own, we have some documentation to help:
+
+* [Required infrastructure](https://developer.workarea.com/articles/infrastructure.html)
+* [Configuring Workarea for hosting](https://developer.workarea.com/articles/configuration-for-hosting.html)
+
+
+Contributing
+--------------------------------------------------------------------------------
+All contributors in any way are expected to follow the [code of conduct](https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md).
+
+### Looking for how to contribute code?
+We encourage you to contribute to Workarea! Check out our [articles on contribution](https://developer.workarea.com/articles/contribute-code.html) on [https://developer.workarea.com](https://developer.workarea.com).
+
+### Looking for how to submit a bug?
+Please check out our [article on how to submit a bug](https://developer.workarea.com/articles/report-a-bug.html) for how to proceed
+
+### Looking for how to report a security vulnerability?
+Please check out our [security policy](https://developer.workarea.com/articles/security-policy.html) for how to proceed.
+
+
+License
+--------------------------------------------------------------------------------
+Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)

data/docker-compose.yml

@@ -0,0 +1,27 @@
+version: '3'
+services:
+  mongo:
+    image: "mongo:${MONGODB_VERSION}"
+    volumes:
+      - mongo:/data/db
+    ports:
+      - '127.0.0.1:${MONGODB_PORT}:27017'
+
+  redis:
+    image: "redis:${REDIS_VERSION}"
+    volumes:
+      - redis:/data
+    ports:
+      - '127.0.0.1:${REDIS_PORT}:6379'
+
+  elasticsearch:
+    image: "elasticsearch:${ELASTICSEARCH_VERSION}"
+    ports:
+      - '127.0.0.1:${ELASTICSEARCH_PORT}:9200'
+    volumes:
+      - elasticsearch:/usr/share/elasticsearch/data
+
+volumes:
+  mongo:
+  redis:
+  elasticsearch:

data/docs/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'redcarpet'
+gem 'middleman', '~> 4.2'
+gem 'middleman-autoprefixer', '~> 2.9'
+gem 'middleman-search', '~> 0.10.0'
+gem 'middleman-navtree', '~> 0.1.10'
+gem 'puma'

data/docs/bin/middleman

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'middleman' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("middleman-cli", "middleman")

data/docs/config.rb

@@ -0,0 +1,87 @@
+require_relative './workarea_renderer'
+
+# Activate and configure extensions
+# https://middlemanapp.com/advanced/configuration/#configuring-extensions
+
+set :markdown_engine, :redcarpet
+set :markdown, fenced_code_blocks: true, tables: true, no_intra_emphasis: true, renderer: WorkareaRenderer
+
+set :relative_links, true
+
+set :feedback_url, 'https://docs.google.com/forms/d/e/1FAIpQLSdwBiHq_F8TVPAcBQFGf9e--yCE6rbGvGuiAF-W2lB2zrRbtg/viewform?usp=pp_url&entry.1298659050='
+
+activate :search do |search|
+  search.resources = Dir['source/**/*.html*'].map do |path|
+    path.split('/').drop(1).join('/').gsub(/\.erb|\.md/, '')
+  end
+
+  search.fields = {
+    title: { boost: 100, store: true, required: true },
+    content: { boost: 50 },
+    excerpt: { index: false, store: true },
+    url:     { index: false, store: true }
+  }
+end
+
+activate :navtree do |options|
+  options.automatic_tree_updates = false
+end
+
+# Layouts
+# https://middlemanapp.com/basics/layouts/
+
+# Per-page layout changes
+page '/*.xml', layout: false
+page '/*.json', layout: false
+page '/*.txt', layout: false
+
+# With alternative layout
+page '/articles/*', layout: 'article'
+page '/release-notes/*', layout: 'bare'
+page '/upgrade-guides/*', layout: 'bare'
+
+# Proxy pages
+# https://middlemanapp.com/advanced/dynamic-pages/
+
+# proxy(
+#   '/this-page-has-no-template.html',
+#   '/template-file.html',
+#   locals: {
+#     which_fake_page: 'Rendering a fake page with a local variable'
+#   },
+# )
+
+# Helpers
+# Methods defined in the helpers block are available in templates
+# https://middlemanapp.com/basics/helper-methods/
+
+helpers do
+  def body_classes(classes = '')
+    ['body', current_page.data.body_class, classes].join(' ')
+  end
+
+  def recent_articles(size = 5)
+    files = Dir['source/{articles,hosting}/**/*.md']
+              .map { |p| File.new(p) }
+              .sort { |y, x| x.ctime <=> y.ctime }
+
+    files.take(size).map do |file|
+      sitemap.resources.find { |r| file.path.include?(r.path) }
+    end
+  end
+end
+
+# Build-specific configuration
+# https://middlemanapp.com/advanced/configuration/#environment-specific-settings
+
+configure :build do
+  activate :minify_css
+  activate :minify_javascript
+  activate :relative_assets
+
+  # Keep this here, as per:
+  # https://github.com/middleman/middleman-autoprefixer/issues/33
+  activate :autoprefixer do |prefix|
+    prefix.browsers = "last 2 versions"
+  end
+end

data/docs/config.ru

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.require(:default)
+
+middleman = Middleman::Application.new
+app = Middleman::Rack.new(middleman).to_app
+
+run app

data/docs/data/articles.yml

@@ -0,0 +1,157 @@
+introduction:
+  overview.html.md: /articles/overview.html.md
+  api-overview.html.md: /articles/api-overview.html.md
+  b2b-overview.html.md: /articles/b2b-overview.html.md
+developing-on-workarea:
+  quick-start:
+    create-a-new-app.html.md: /articles/create-a-new-app.html.md
+    use-an-existing-workarea-app.html.md: /articles/use-an-existing-workarea-app.html.md
+  installing.html.md: /articles/installing.html.md
+  navigating-the-code.html.md: /articles/navigating-the-code.html.md
+  seeds.html.md: /articles/seeds.html.md
+  integrating-with-other-software: /articles/integrating-with-other-software.html.md
+  common-tasks:
+    run-sidekiq-in-a-local-environment: /articles/run-sidekiq-in-a-local-environment.html.md
+    add-remove-or-change-a-mongoid-validation.html.md: /articles/add-remove-or-change-a-mongoid-validation.html.md
+    add-metrics.html.md: /articles/add-metrics.html.md
+    add-a-report.html.md: /articles/add-a-report.html.md
+hosting-workarea:
+  infrastructure.html.md: /articles/infrastructure.html.md
+  configuration-for-hosting.html.md: /articles/configuration-for-hosting.html.md
+application-architecture:
+  prerequisites-and-dependencies.html.md: /articles/prerequisites-and-dependencies.html.md
+  domain-modeling.html.md: /articles/domain-modeling.html.md
+  testing.html.md: /articles/testing.html.md
+  view-models.html.md: /articles/view-models.html.md
+  workers.html.md: /articles/workers.html.md
+  caching:
+    http-caching.html.md: /articles/http-caching.html.md
+    html-fragment-caching.html.md: /articles/html-fragment-caching.html.md
+    low-level-caching.html.md: /articles/low-level-caching.html.md
+  diagrams:
+    commerce-model.html.md: /articles/commerce-model.html.md
+    writing-data.html.md: /articles/writing-data.html.md
+    reading-data.html.md: /articles/reading-data.html.md
+    images-flow.html.md: /articles/images-flow.html.md
+  extension:
+    extension-overview.html.md: /articles/extension-overview.html.md
+    appending.html.md: /articles/appending.html.md
+    decoration.html.md: /articles/decoration.html.md
+    overriding.html.md: /articles/overriding.html.md
+    configuration.html.md: /articles/configuration.html.md
+  misc:
+    application-document.html.md: /articles/application-document.html.md
+    releasable.html.md: /articles/releasable.html.md
+    swappable-list-data-structure.html.md: /articles/swappable-list-data-structure.html.md
+plugins:
+  plugins-overview.html.md: /articles/plugins-overview.html.md
+  create-a-plugin.html.md: /articles/create-a-plugin.html.md
+  maintain-a-plugin.html.md: /articles/maintain-a-plugin.html.md
+  test-if-a-plugin-is-installed.html.md: /articles/test-if-a-plugin-is-installed.html.md
+products:
+  products.html.md: /articles/products.html.md
+  sort-and-exclude-product-options.html.md: /articles/sort-and-exclude-product-options.html.md
+  change-the-storefront-product-pricing-ui.html.md: /articles/change-the-storefront-product-pricing-ui.html.md
+  configure-low-inventory-threshold.html.md: /articles/configure-low-inventory-threshold.html.md
+search:
+  searching.html.md: /articles/searching.html.md
+  storefront-search-features.html.md: /articles/storefront-search-features.html.md
+  storefront-searches.html.md: /articles/storefront-searches.html.md
+  analyze-storefront-search-results.html.md: /articles/analyze-storefront-search-results.html.md
+  change-storefront-search-results.html.md: /articles/change-storefront-search-results.html.md
+  index-storefront-search-documents.html.md: /articles/index-storefront-search-documents.html.md
+  add-remove-sort-and-group-storefront-search-filters.html.md: /articles/add-remove-sort-and-group-storefront-search-filters.html.md
+  change-the-storefront-search-filters-ui.html.md: /articles/change-the-storefront-search-filters-ui.html.md
+cart-and-checkout:
+  checkout.html.md: /articles/checkout.html.md
+  configure-a-payment-gateway.html.md: /articles/configure-a-payment-gateway.html.md
+  integrate-a-payment-gateway.html.md: /articles/integrate-a-payment-gateway.html.md
+  test-a-credit-card-transaction.html.md: /articles/test-a-credit-card-transaction.html.md
+orders:
+  orders.html.md: /articles/orders.html.md
+  orders-and-items.html.md: /articles/orders-and-items.html.md
+  order-life-cycle.html.md: /articles/order-life-cycle.html.md
+  shipping.html.md: /articles/shipping.html.md
+users:
+  configure-logins-and-authentication.html.md: /articles/configure-logins-and-authentication.html.md
+navigation:
+  navigation.html.md: /articles/navigation.html.md
+  navigable.html.md: /articles/navigable.html.md
+content:
+  content.html.md: /articles/content.html.md
+  contentable.html.md: /articles/contentable.html.md
+  add-a-content-area.html.md: /articles/add-a-content-area.html.md
+  add-a-content-block-type.html.md: /articles/add-a-content-block-type.html.md
+  add-system-content.html.md: /articles/add-system-content.html.md
+themes:
+  themes-overview.html.md: /articles/themes-overview.html.md
+  create-a-theme.html.md: /articles/create-a-theme.html.md
+pricing:
+  order-pricing.html.md: /articles/order-pricing.html.md
+  add-or-replace-a-pricing-calculator.html.md: /articles/add-or-replace-a-pricing-calculator.html.md
+  change-the-storefront-product-pricing-ui.html.md: /articles/change-the-storefront-product-pricing-ui.html.md
+  create-a-custom-discount.html.md: /articles/create-a-custom-discount.html.md
+inventory:
+  inventory.html.md: /articles/inventory.html.md
+  integrate-an-inventory-management-system.html.md: /articles/integrate-an-inventory-management-system.html.md
+  define-and-configure-inventory-policies.html.md: /articles/define-and-configure-inventory-policies.html.md
+storefronts:
+  views:
+    views.html.md: /articles/views.html.md
+    style-guides.html.md: /articles/style-guides.html.md
+    create-a-style-guide.html.md: /articles/create-a-style-guide.html.md
+    add-remove-or-change-a-product-template.html.md: /articles/add-remove-or-change-a-product-template.html.md
+    error-pages.html.md: /articles/error-pages.html.md
+    customize-a-helper.html.md: /articles/customize-a-helper.html.md
+    rails-asset-view-helpers.html.md: /articles/rails-asset-view-helpers.html.md
+    system-emails.html.md: /articles/system-emails.html.md
+    configure-contact-form-subjects-list.html.md: /articles/configure-contact-form-subjects-list.html.md
+  stylesheets:
+    css-architectural-overview.html.md: /articles/css-architectural-overview.html.md
+    stylesheets-overview.html.md: /articles/stylesheets-overview.html.md
+    add-stylesheets-through-a-manifest.html.md: /articles/add-stylesheets-through-a-manifest.html.md
+    add-css-through-the-admin-ui.html.md: /articles/add-css-through-the-admin-ui.html.md
+    feature-spec-helper-stylesheet.html.md: /articles/feature-spec-helper-stylesheet.html.md
+  javascripts:
+    javascript-overview.html.md: /articles/javascript-overview.html.md
+    javascript-reference-documentation.html.md: /articles/javascript-reference-documentation.html.md
+    javascript-modules.html.md: /articles/javascript-modules.html.md
+    javascript-templates.html.md: /articles/javascript-templates.html.md
+    access-routes-in-javascript.html.md: /articles/access-routes-in-javascript.html.md
+    analytics-overview.html.md: /articles/analytics-overview.html.md
+    integrate-a-web-analytics-provider.html.md: /articles/integrate-a-web-analytics-provider.html.md
+    add-javascript-through-a-manifest.html.md: /articles/add-javascript-through-a-manifest.html.md
+    add-javascript-through-a-view.html.md: /articles/add-javascript-through-a-view.html.md
+    add-javascript-through-the-admin-ui.html.md: /articles/add-javascript-through-the-admin-ui.html.md
+    featurejs-and-feature-spec-helper.html.md: /articles/featurejs-and-feature-spec-helper.html.md
+    automated-javascript-testing.html.md: /articles/automated-javascript-testing.html.md
+    browser-and-device-support.html.md: /articles/browser-and-device-support.html.md
+    progressive-web-application-support.html.md: /articles/progressive-web-application-support.html.md
+  assets:
+    rails-asset-manifests.html.md: /articles/rails-asset-manifests.html.md
+    configure-asset-types.html.md: /articles/configure-asset-types.html.md
+    configure-product-image-sizes-and-processing.html.md: /articles/configure-product-image-sizes-and-processing.html.md
+    configure-imageoptim.html.md: /articles/configure-imageoptim.html.md
+    favicon-support.html.md: /articles/favicon-support.html.md
+    change-product-placeholder-image.html.md: /articles/change-product-placeholder-image.html.md
+    configure-asset-storage.html.md: /articles/configure-asset-storage.html.md
+internationalization:
+  i18n.html.md: /articles/i18n.html.md
+  configure-locales.html.md: /articles/configure-locales.html.md
+  translate-or-customize-static-content.html.md: /articles/translate-or-customize-static-content.html.md
+  translate-or-customize-message-content.html.md: /articles/translate-or-customize-message-content.html.md
+  translate-administrable-content.html.md: /articles/translate-administrable-content.html.md
+  translate-javascript-content.html.md: /articles/translate-javascript-content.html.md
+contribute:
+  contribute-code.html.md: /articles/contribute-code.html.md
+  contribute-documentation.html.md: /articles/contribute-documentation.html.md
+  documentation.html.md: /articles/documentation.html.md
+  documentation-style-guide.html.md: /articles/documentation-style-guide.html.md
+  report-a-bug.html.md: /articles/report-a-bug.html.md
+  coding-standards:
+    ruby-coding-standards.html.md: /articles/ruby-coding-standards.html.md
+    javascript-coding-standards.html.md: /articles/javascript-coding-standards.html.md
+    stylesheet-coding-standards.html.md: /articles/stylesheet-coding-standards.html.md
+policies:
+  maintenance-policy.html.md: /articles/maintenance-policy.html.md
+  security-policy.html.md: /articles/security-policy.html.md