workarea-product_badges 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3632e4f228e57a2fc9484b0c8cdc4e65f9b42c562768e987481e1a93ae5c7c8
+  data.tar.gz: 70dacdddb4287037759a4a90263cc2ef602b47ac542f3110497bc8aec8cd9e35
+SHA512:
+  metadata.gz: 28fe68b38b069e53fc71a386e0408763e23b94e37803855ce23a933cb1ac938c1ec2870a8be1036b2b03738b882f15c165ef92e6aff900f9dc07f0dbcce18d9b
+  data.tar.gz: fd4b8439d1f4a8e89221df01fe6da7bf9167cbc650b06949df7291b179f48fdfb9da42e31d7f541706a191fbc2e2ff5f194f5f4724f9565e30f48992624a5fba

data/.editorconfig

@@ -0,0 +1,16 @@
+# 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}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4

data/.eslintrc

@@ -0,0 +1,25 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": ["error", "always"],
+      "eqeqeq": ["error", "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true
+    }
+}

data/.gitignore

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

data/.markdownlint.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD003": {
+    "style": "setext_with_atx"
+  },
+  "MD007": {
+    "indent": 4
+  },
+  "no-hard-tabs": false
+}

data/.rails-rubocop.yml

@@ -0,0 +1,119 @@
+AllCops:
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rails-rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'test/dummy/**/*'
+    - 'lib/badges.rb'
+    - 'lib/badges/**/*'

data/.scss-lint.yml

@@ -0,0 +1,192 @@
+# Extension of the default configuration:
+# https://github.com/causes/scss-lint/blob/master/config/default.yml
+
+exclude: 'docs/**'
+
+linters:
+  Comment:
+    enabled: false
+
+  DeclarationOrder:
+    enabled: true
+
+  ElsePlacement:
+    enabled: true
+
+  EmptyRule:
+    enabled: false
+
+  HexLength:
+    enabled: true
+    style: long
+
+  Indentation:
+    enabled: true
+    allow_non_nested_indentation: true
+    character: space
+    width: 4
+
+  LeadingZero:
+    enabled: true
+    style: include_zero
+
+  MergeableSelector:
+    enabled: true
+    force_nesting: false
+
+  PropertySortOrder:
+    enabled: true
+    ignore_unspecified: false
+    separate_groups: false
+    order:
+      - display
+      -
+      - position
+      - top
+      - right
+      - bottom
+      - left
+      - z-index
+      -
+      - margin
+      - margin-top
+      - margin-right
+      - margin-bottom
+      - margin-left
+      -
+      - margin-collapse
+      - margin-top-collapse
+      - margin-right-collapse
+      - margin-bottom-collapse
+      - margin-left-collapse
+      -
+      - padding
+      - padding-top
+      - padding-right
+      - padding-bottom
+      - padding-left
+      -
+      - width
+      - height
+      - max-width
+      - max-height
+      - min-width
+      - min-height
+      -
+      - float
+      - clear
+      -
+      - color
+      -
+      - font
+      - font-size
+      - font-style
+      - font-family
+      - font-weight
+      - font-variant
+      - font-smoothing
+      -
+      - line-height
+      - letter-spacing
+      - word-spacing
+      -
+      - text-align
+      - text-indent
+      - text-shadow
+      - text-overflow
+      - text-rendering
+      - text-transform
+      - text-decoration
+      - text-size-adjust
+      -
+      - word-break
+      - word-wrap
+      -
+      - white-space
+      -
+      - background
+      - background-size
+      - background-color
+      - background-image
+      - background-repeat
+      - background-position
+      - background-attachment
+      -
+      - border
+      - border-top
+      - border-right
+      - border-bottom
+      - border-left
+      -
+      - border-image
+      - border-spacing
+      - border-collapse
+      -
+      - border-color
+      - border-top-color
+      - border-right-color
+      - border-bottom-color
+      - border-left-color
+      -
+      - border-style
+      - border-top-style
+      - border-right-style
+      - border-bottom-style
+      - border-left-style
+      -
+      - border-width
+      - border-top-width
+      - border-right-width
+      - border-bottom-width
+      - border-left-width
+      -
+      - border-radius
+      - border-top-right-radius
+      - border-bottom-right-radius
+      - border-bottom-left-radius
+      - border-top-left-radius
+      - border-radius-topright
+      - border-radius-bottomright
+      - border-radius-bottomleft
+      - border-radius-topleft
+      -
+      - box-shadow
+
+  SelectorFormat:
+    enabled: true
+    convention: hyphenated_BEM
+
+  SingleLinePerSelector:
+    enabled: false
+
+  SpaceAfterPropertyColon:
+    enabled: true
+    style: at_least_one_space
+
+  SpaceBeforeBrace:
+    enabled: true
+    style: space
+    allow_single_line_padding: true
+
+  VariableForProperty:
+    enabled: true
+    properties:
+      - color
+      - font-family
+      - background-color
+
+  PseudoElement:
+    enabled: false
+
+  # These default settings may be problematic to implementors. They are not
+  # ommitted so that they may be adjusted as needed during an implementation.
+  #
+  # For documentation:
+  # https://github.com/causes/scss-lint/blob/master/lib/scss_lint/linter/README.md
+
+  DuplicateProperty:
+    enabled: true
+
+  PropertySpelling:
+    enabled: true
+    extra_properties: [] # Add experimental CSS to this array, if needed

data/CHANGELOG.md

@@ -0,0 +1,101 @@
+Workarea Product Badges 1.3.2 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Product Badges 1.3.1 (2019-06-11)
+--------------------------------------------------------------------------------
+
+*   Add minimum version requirement for Workarea v3.4
+
+    * As of v1.3.0 product badges requries workarea v3.4.0 or higher
+
+    PRODBADGE-10
+    Jake Beresford
+
+
+
+Workarea Product Badges 1.3.0 (2019-03-19)
+--------------------------------------------------------------------------------
+
+*   Update for v3.4 compatibility
+
+    * Update implementation of top_sellers badge to use new Insights properly
+    * Update gemfile format
+    * Use integration tests instead of system tests for speed and to prevent weirdness.
+    * Set test/dummy to use 5.2
+    * Fix engine_path in bin/rails
+    * Remove require workarea from bin/rails
+    * rubocop fixes
+
+    PRODBADGE-8
+    Jake Beresford
+
+*   Update for v3.4 compatibility
+
+    * Use Insights instead of deprecated Analytics when determining best sellers
+    * Update CI scripts
+
+    PRODBADGE-8
+    Matt Dunphy
+
+
+
+Workarea Product Badges 1.2.0 (2018-10-30)
+--------------------------------------------------------------------------------
+
+*   Allow field used for new badge to be configured
+
+    PRODBADGE-4
+    Jake Beresford
+
+
+
+Workarea Product Badges 1.1.0 (2018-09-19)
+--------------------------------------------------------------------------------
+
+*   Add badges to product detail page
+
+    * Append badges partial to storefront.product_description
+    * Add scoped styles for badges on PDP
+
+    PRODBADGE-7
+    Jake Beresford
+
+*   Prevent pointer events on badges
+
+    * Allow user to click link behind a badge component, like a linked product_summary image
+
+    PRODBADGE-6
+    Jake Beresford
+
+
+
+Workarea Product Badges 1.0.0 (2018-04-11 10:58:26 -0400)
+--------------------------------------------------------------------------------
+
+*   Workarea Product Badges Plugin
+
+    Allows products to be 'badged' either manually via the admin/product import or
+    via logic-based automatic badges.  Admins can add badges via a CSV of
+    values or toggle rule-based badges like 'sale' or 'new'.  Badges are
+    displayed on product summary.
+
+    PRODBADGE-1
+    Jake Beresford
+
+
+Workarea Product Badges 1.0.0 (2018-04-10 15:14:42 -0400)
+--------------------------------------------------------------------------------
+
+*   Workarea Product Badges Plugin
+
+    Allows products to be 'badged' either manually via the admin/product import or
+    via logic-based automatic badges.  Admins can add badges via a CSV of
+    values or toggle rule-based badges like 'sale' or 'new'.  Badges are
+    displayed on product summary.
+
+    PRODBADGE-1
+    Jake Beresford

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Declare your gem"s dependencies in accordions.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem "byebug", group: [:development, :test]
+
+gem "workarea", source: "https://gems.weblinc.com"

data/README.md

@@ -0,0 +1,167 @@
+Workarea Badges
+================================================================================
+
+Badges plugin for the Workarea platform.
+Adds badges to product summary and product detail views.
+
+Badges can be added to products manually, or via a product import by specifying
+a comma-separated list in the product[:badges] field.
+
+In addition to custom badges via the product[:badges] field this plugin provides
+automatic badging for products. Out of the box automatic badges are:
+
+* New
+* Sale
+* Best Seller
+
+Configuration
+--------------------------------------------------------------------------------
+
+The following configuration can be added to your host app and adjusted as necessary:
+
+```ruby
+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
+```
+
+### new_threshold
+
+* type: integer
+* default: 30
+* products created in this time will receive a 'New' badge
+
+### new_date_field
+
+* type: symbol
+* default: :created_at
+* Specify which field will be used to calculate whether a product should display
+  the 'new' badge.
+
+### number_of_top_sellers
+
+* type: integer
+* default: 10
+* Description: Number of products from top sellers to apply a badge to
+
+### max_badges
+
+* type: integer
+* default: nil
+* Description: limits the number of badges that can be applied to any product
+
+### sort
+
+* type: Lambda
+* default: ->(badges) { badges.sort_by{ |b| ["New", "Sale", "Best Seller"].find_index(b) || 999 } }
+* Description: Specify the order in which badges should appear, this lambda can
+  be updated to sort badges according to any business logic without decoration.
+  By default the plugin will sort automatic badges first followed by custom badges.
+  Custom badges will display in the order they appear in the admin.
+
+#### Implementing a custom sort class
+
+For more complicated sorting logic, a sorting class can be implemented as long as
+it responds to .call example
+
+```ruby
+class MyBadgeSort
+  def self.call(badges)
+    new(badges).results
+  end
+
+  def initialize(badges)
+    @badges = badges
+  end
+
+  def results
+    # do all sorts of crazy complex stuff
+  end
+end
+```
+
+Then update your configuration to:
+
+```ruby
+  Workarea.config.product_badges[:sort] = MyBadgeSort
+```
+
+Adding new automatic badges
+--------------------------------------------------------------------------------
+
+To add a new automatic badge in your host application you should decorate the
+product_view_model automatic_badges method, calling super and injecting your badge
+to the array.
+
+Example:
+
+```ruby
+module Workarea
+  decorate Storefront::ProductViewModel, with: :your_app_name do
+    def automatic_badges
+      super << custom_badge_method
+    end
+
+    private
+
+    def custom_badge_method
+      if logic_for_automatic_badge
+        t('workarea.storefront.products.badges.[custom_badge_key]')
+      end
+    end
+  end
+end
+```
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+To access Workarea gems and source code, you must be an employee of WebLinc or a licensed retailer or partner.
+
+Workarea gems are hosted privately at https://gems.weblinc.com/.
+You must have individual or team credentials to install gems from this server. Add your gems server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-badges', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-badges'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright WebLinc 2018. All rights reserved.
+
+For licensing, contact sales@workarea.com.