Workarea 3.0.2

Suppresses Analytics Callbacks for Admins

Commit

Workarea 3.0.2 does not fire analytics callbacks when the current user is an administrator. This change reduces the amount of unwanted non-customer data being sent to 3rd party analytics services. The change affects workarea/storefront/modules/analytics.js in the Storefront, which now looks for an analytics=false cookie. This cookie is managed in controllers/workarea/authentication.rb in Workarea Core. If your application is overriding the Storefront analytics JS, you should update your copy to suppress callbacks when the cookie is set.

Adds Index to Payment Transaction Action

Commit

Workarea 3.0.2 declares an index on Workarea::Payment::Transaction#action.

# workarea/core/app/models/workarea/payment/transaction.rb

module Workarea
  class Payment
    class Transaction
      include ApplicationDocument

      # ...

      field :action, type: String

      # ...

      index({ action: 1 })

      # ...
    end
  end
end

To benefit from this index, you must create it within each environment. The following command will create the index. Applications using Workarea OMS must create this index.

bin/rails db:mongoid:create_indexes

Removes Grid Component from Taxonomy Content Blocks

Pull Request

Workarea 3.0.1 uses the grid component for the layout of taxonomy content blocks in the Storefront. However, these blocks typically require a custom layout, requiring the removal of the grid component. Workarea 3.0.2 removes the grid component from these blocks, replacing grid __cell elements with taxonomy-content-block__ container elements in the following Storefront partials.

Also affected are the workarea/storefront/components/_taxonomy_content_block.scss Storefront stylesheet and the Workarea::Storefront::ContentHelper#render_image_with_link Storefront helper method.

Run Workarea Upgrade or review the pull request to determine if your application is affected.

Reduces Focus Styles in Storefront

Pull Request

Workarea 3.0.1 highlights almost all focusable elements in the Storefront when those elements are focused (via the focus-ring Sass mixin). This is an oversight and causes unwanted focus rings. Workarea 3.0.2 reduces the affected elements to input, textarea, and select.

This change also removes the workarea/storefront/generic/_accessibility.scss stylesheet from the Storefront, and removes its inclusion within the Storefront's workarea/storefront/application.scss.erb manifest.

Fixes Styles for Secondary Nav Component

Commit

Workarea 3.0.2 updates selectors in the workarea/storefront/components/_secondary_nav.scss Storefront stylesheet to match the structure of the secondary-nav component, as it is used in the workarea/storefront/shared/_left_navigation.html.haml partial. The commit also makes minor changes to the default styles for this component.

Normalizes Padding in Storefront Page Aside

Commit

Workarea 3.0.2 removes padding from the following selectors to apply consistent default spacing within the Storefront page aside.

The following Storefront stylesheets are affected.

Aligns Test Class Names with File Names

Pull Request, Pull Request, Commit

Workarea 3.0.2 renames several test classes and test file names to bring them into alignment. If your application is decorating any of the affected classes, you will need to update your decorators. Run Workarea Upgrade or review the pull requests to see which classes and files are affected.

Changes Admin Append Points

Pull Request, Pull Request, Pull Request, Commit

Workarea 3.0.2 adds append points to the following Admin views and removes an append point from workarea/admin/payments/show.html.haml. If your application is overriding any of these views, you may wish to add these append points so that partials from plugins are rendered appropriately.

To see the changes, run Workarea Upgrade or review the pull requests/commits.

Allows Decoration of Generator Tests

Commit

Workarea 3.0.2 adds a new test class, Workarea::GeneratorTest. This class inherits from Rails::Generators::TestCase, but allows for test decoration by plugins and applications. The commit changes all generator tests to inherit from Workarea::GeneratorTest instead of Rails::Generators::TestCase.

Improves Note on Shipping Services Regions Field in Admin

Commit

Workarea 3.0.2 improves the note for the Regions field within the shipping services new and edit screens in the Admin. The change modifies workarea/admin/shipping_services/new.html.haml and workarea/admin/shipping_services/edit.html.haml to use a new translation key: workarea.admin.shipping_services.regions_note. If your application is overriding either of these views, you may want to update your copies.

Fixes Invalid HTML for the Social Networks Content Block Type

Commit

Workarea 3.0.2 fixes invalid HTML in the workarea/storefront/content_blocks/_social_networks.html.haml Storefront partial by wrapping the li elements in a ul. If your application is overriding this partial, you should make the same change in your copy.

Adds Test Case Methods to Determine Mount Point

Pull Request

Workarea 3.0.2 adds the Workarea::TestCase.running_in_gem? and Workarea::TestCase#running_in_gem? predicate methods to all test case classes. These methods return true when a test is run within the engine's embedded dummy app rather than a Workarea application. These methods allow for code branching, such as when configuring the location of vcr cassettes.

# workarea-testing/lib/workarea/test_case.rb

module Workarea
  class TestCase < ActiveSupport::TestCase
    # ...

    delegate :running_in_gem?, to: :class

    def self.running_in_gem?
      Rails.root.to_s.include?('test/dummy')
    end
  end
end

Enumerates Configured Card Types in Payment Icon Style Guide

Pull Request

The Storefront's payment icon component provides a modifier for each configured credit card type. The style guide for this component displays each modifier, an excerpt of which is shown below.

payment-icon storefront style guide

While Workarea 3.0.0 employs static code examples for these modifiers, Workarea 3.0.2 enumerates Workarea.config.credit_card_issuers, producing a code example for each member of that collection. This change ensures each accepted card type is represented on the style guide. It also allows plugins and applications to extend the style guide without overriding the partial.

If your application is overriding this view, you may want to update the copy in your application to ensure your style guide stays in sync with the configured card types.

Adds Admin Helper Method for Content Block Icons

Pull Request

Workarea 3.0.2 adds the Workarea::Admin::ContentBlockIconHelper#content_block_icon helper method to render content block icons in the Admin. The helper mimics the signature of InlineSvg::ActionView::Helpers#inline_svg, and uses that method in its implementation. The new helper method is needed to allow for a default icon for custom block types that do not provide their own icon. The default icon file is workarea/admin/content_block_types/custom_block.svg.

Within the following Admin views, content_block_icon replaces inline_svg.

The change also adds a type method to Workarea::Content::Preset. The method returns an instance of Workarea::Content::BlockType and is needed to provide access to Workarea::Content::BlockType#icon, which returns the path to the block type's icon file.

# workarea-core/app/models/workarea/content/preset.rb

module Workarea
  class Content
    class Preset
      include ApplicationDocument

      # ...

      # The {Workarea::Content::BlockType} that this block is. See documentation
      # for {Content.define_block_types} for info how to define block types.
      #
      # @return [Workarea::Content::BlockType]
      #
      def type
        Workarea.config.content_block_types.detect { |bt| bt.id == type_id }
      end
    end
  end
end

The pull request also updates Workarea's dependency on inline_svg to '~> 1.2.1'.

Adds Helper Method to Test for Partials to Append

Commit

Workarea 3.0.2 adds the Workarea::PluginsHelper#partials_to_append? helper method, which returns true if any partials are registered to append to a given append point. The example below tests if there are any partials to append to 'admin.fulfillment_show_workflow_bar' before appending the partials, allowing for conditional markup.

/ workarea-admin/app/views/workarea/admin/fulfillments/show.html.haml

/ ...

- if partials_to_append?('admin.fulfillment_show_workflow_bar')
  .workflow-bar
    .grid
      .grid __cell.grid__ cell--50
      .grid __cell.grid__ cell--50.align-right
        = append_partials('admin.fulfillment_show_workflow_bar', order: @order, fulfillment: @fulfillment)