workarea-search_autocomplete 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cab34311e40d6ee51590272548d7851d97c0d3f460f13874f517f1e93df0b6b
+  data.tar.gz: e300b27a52950b6cecfa00685c20a6a67b8886fcf025ac2c636f61398a61599e
+SHA512:
+  metadata.gz: a7868dcbf6741b677bec1fb7b00b5fe459f531a9912bccfa3a2a88e5b4bab570be7d71f6831e93f7e726d5bd55cc8c7b0e7839d5821c9e99624f4c623b6c348e
+  data.tar.gz: 396b33e63da8fba698fb99948a4ccddb134209f8cbf203a348cb0a4bbfe511674e4b6478df2c0f65bf64c0e5cd05a4783a618046fb4768ad44ea24734423fc55

data/.editorconfig

@@ -0,0 +1,20 @@
+# 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,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss,*.js.erb}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.eslintrc.json

@@ -0,0 +1,35 @@
+{
+    "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,
+      "describe": true,
+      "after": true,
+      "afterEach": true,
+      "before": true,
+      "beforeEach": true,
+      "it": true,
+      "expect": true,
+      "sinon": true,
+      "fixture": true,
+      "chai": true
+    }
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+    - uses: workarea-commerce/ci/eslint@v1
+      with:
+        args: '**/*.js'
+    - uses: workarea-commerce/ci/stylelint@v1
+      with:
+        args: '**/*.scss'
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -0,0 +1,20 @@
+.bundle/
+log/*.log
+pkg/
+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
+node_modules
+yarn.lock
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+

data/.stylelintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "stylelint-config-recommended-scss",
+  "rules": {
+    "block-no-empty": null,
+    "no-descending-specificity": null,
+    "property-no-unknown": [true, { "ignoreProperties": ["mso-hide"] }]
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+Workarea Search Autocomplete 1.0.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+*   Fix Name of Append Point
+
+    This append point should be prefixed with `storefront.` in order to
+    notate where it is output on the site.
+
+    SEARCHAUTO-1
+    Tom Scott
+
+*   Improve Search Autocomplete UI
+
+    * Hide UI when input is empty
+    * Add contentable area to UI
+    * Display Trending Products/Searches when no results are available
+    * Add append point for content search
+
+    SEARCHAUTO-1
+    Curt Howard
+
+*   Fix case sensitivity
+
+    Fix #3
+    Ben Crouse
+
+*   Update config fields to be administrable fields
+
+    Matt Duffy
+
+*   Add backend implementation
+
+    Ben Crouse
+
+
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in workarea-search_autocomplete.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', github: 'workarea-commerce/workarea'

data/README.md

@@ -0,0 +1,17 @@
+Workarea Search Autocomplete
+================================================================================
+
+Search Autocomplete plugin for the Workarea platform.
+
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.workarea.com](http://developer.workarea.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright Workarea 2019. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,60 @@
+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    = 'Workarea Search Autocomplete'
+  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/search_autocomplete/version'
+
+desc "Release version #{Workarea::SearchAutocomplete::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::SearchAutocomplete::VERSION} -m 'Tagging #{Workarea::SearchAutocomplete::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-search_autocomplete.gemspec"
+  system "gem push workarea-search_autocomplete-#{Workarea::SearchAutocomplete::VERSION}.gem"
+  system "gem push workarea-search_autocomplete-#{Workarea::SearchAutocomplete::VERSION}.gem --host #{host}"
+  system "rm workarea-search_autocomplete-#{Workarea::SearchAutocomplete::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/javascripts/workarea/storefront/search_autocomplete/config.js

@@ -0,0 +1,12 @@
+(function () {
+    'use strict';
+
+    WORKAREA.config.searchAutocomplete = {
+        selector: '#storefront_search',
+        delays: {
+            input: 500,
+            change: 250,
+            focus: 0
+        }
+    };
+})();

data/app/assets/javascripts/workarea/storefront/search_autocomplete/modules/search_autocomplete.js

@@ -0,0 +1,76 @@
+/**
+ * @namespace WORKAREA.searchAutocomplete
+ */
+
+WORKAREA.registerModule('searchAutocomplete', (function () {
+    'use strict';
+
+    var cache = {},
+        hide = function () {
+            $('#search_autocomplete')
+            .addClass('visually-hidden')
+            .removeClass('search-autocomplete--visible')
+                .closest('.page-header__search-value')
+                .removeClass('page-header__search-value--autocomplete');
+        },
+
+        render = function (response) {
+            $('#search_autocomplete')
+            .removeClass('visually-hidden')
+            .addClass('search-autocomplete--visible')
+            .empty()
+            .append(response)
+                .closest('.page-header__search-value')
+                .addClass('page-header__search-value--autocomplete');
+        },
+
+        handleUserClick = function (event) {
+            if (_.isEmpty($(event.target).closest($('#search_autocomplete')))) {
+                hide();
+            }
+        },
+
+        handleUserInput = function (event) {
+            var endpoint = WORKAREA.routes.storefront.autocompleteSearchPath({
+                q: event.target.value
+            });
+
+            if (cache[endpoint]) {
+                render(cache[endpoint]);
+            } else {
+                $.get(endpoint)
+                .fail(function () { hide(); })
+                .done(function (response) {
+                    cache[endpoint] = response;
+                    render(response);
+                });
+            }
+
+        },
+
+        getDelay = function (type) {
+            if (WORKAREA.environment.isTest) {
+                return 0;
+            } else {
+                return WORKAREA.config.searchAutocomplete.delays[type];
+            }
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.searchAutocomplete
+         */
+        init = function ($scope) {
+            $(WORKAREA.config.searchAutocomplete.selector, $scope)
+            .on('focus', _.debounce(handleUserInput, getDelay('focus')))
+            .on('input', _.debounce(handleUserInput, getDelay('input')))
+            .on('change', _.debounce(handleUserInput, getDelay('change')));
+        };
+
+    $(window).on('click', handleUserClick);
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/stylesheets/workarea/storefront/search_autocomplete/components/_page_header.scss

@@ -0,0 +1,9 @@
+/*------------------------------------*\
+    #PAGE-HEADER
+\*------------------------------------*/
+
+/**
+ * Provide a positioning context for the Search Autocomplete UI
+ */
+
+.page-header__search-value--autocomplete { position: relative; }

data/app/assets/stylesheets/workarea/storefront/search_autocomplete/components/_search_autocomplete.scss

@@ -0,0 +1,53 @@
+/*------------------------------------*\
+    #SEARCH-AUTOCOMPLETE
+\*------------------------------------*/
+
+$search-autocomplete-bg-color: $background-color !default;
+$search-autocomplete-border: 1px solid $black !default;
+
+$search-autocomplete-z-indexes: ();
+@each $name in $page-container {
+    $search-autocomplete-z-indexes: append($search-autocomplete-z-indexes, $name);
+
+    @if $name == page-header {
+        $search-autocomplete-z-indexes: append($search-autocomplete-z-indexes, search-autocomplete);
+    }
+}
+
+.search-autocomplete {
+    display: none;
+    background: $search-autocomplete-bg-color;
+    border: $search-autocomplete-border;
+    padding: $spacing-unit;
+
+    @include respond-to($medium-breakpoint) {
+        display: block;
+        width: 90vw;
+    }
+
+    @include respond-to($x-wide-breakpoint) {
+        width: 1050px;
+    }
+}
+
+.search-autocomplete--visible {
+    position: absolute;
+    top: 100%;
+    right: 0;
+    z-index: index($search-autocomplete-z-indexes, search-autocomplete);
+}
+
+
+    .search-autocomplete__products {
+        text-align: left;
+    }
+
+
+    .search-autocomplete__searches {
+        @extend %list-reset;
+        text-align: right;
+    }
+
+        .search-autocomplete__searches-item {}
+
+            .search-autocomplete__searches-link {}