workarea-core 3.4.12

data/lib/generators/workarea/style_guide/templates/style_guide_partial.html.haml.erb

@@ -0,0 +1,51 @@
+#<%= @name %>.style-guide__subsection
+
+  %h3= link_to_style_guide('<%= @section %>', '<%= @slug %>')
+
+  %p <%= @name %> Description
+
+<% if @section == 'tools' %>
+  %table.table
+    %thead
+      %tr
+        %th Parameter
+        %th Description
+        %th Required?
+        %th Default Value
+    %tbody
+      %tr
+        %td <code>$example-param</code>
+        %td It's just an example
+        %td Yes
+        %td None
+
+  %p Useage:
+  %pre.style-guide__code-block
+    %code
+      :preserve
+        .example {
+            @include example($param)
+        }
+<% end; if @section == 'components' %>
+  .style-guide__example-block
+    %span.example
+<% end; if ['objects','components'].include?(@section) %>
+  .style-guide__unit-test
+    %h4 Unit Test
+
+    %p should work with <code>example</code> elements
+    .style-guide__example-block
+      %span.example-class
+
+    %p should work with <code>example</code> elements
+    .style-guide__example-block
+      %span.example-class
+<% end; if @section == 'trumps' %>
+  %p without <code>example-class</code>:
+  .style-guide__example-block
+    %span Example
+
+  %p without <code>example-class</code>:
+  .style-guide__example-block
+    %span.example-class Example
+<% end %>

data/lib/minitest/workarea_plugin.rb

@@ -0,0 +1,11 @@
+module Minitest
+  def self.plugin_workarea_init(options)
+    if ENV['CI'].to_s =~ /true/
+      path = ENV['JUNIT_PATH'] || 'test/reports'
+      FileUtils.mkdir_p(path)
+
+      options[:junit] = true
+      options[:junit_filename] = "#{path}/report.xml"
+    end
+  end
+end

data/lib/tasks/assets.rake

@@ -0,0 +1,3 @@
+Rake::Task['assets:environment'].enhance do
+  require 'workarea/ext/sprockets/task'
+end

data/lib/tasks/cache.rake

@@ -0,0 +1,40 @@
+namespace :workarea do
+  namespace :cache do
+    desc 'Prime images cache'
+    task prime_images: :environment do
+      include Rails.application.routes.url_helpers
+      include Workarea::Storefront::ProductsHelper
+      include Workarea::Core::Engine.routes.url_helpers
+
+      built_in_jobs = [:thumb, :gif, :jpg, :png, :strip, :convert, :optimized]
+
+      jobs = Dragonfly.app(:workarea).processor_methods.reject do |job|
+        built_in_jobs.include?(job)
+      end
+
+      Workarea::Catalog::Product.all.each_by(50) do |product|
+        product.images.each do |image|
+          jobs.each do |job|
+            url = URI.join(
+              "https://#{Workarea.config.host}",
+              dynamic_product_image_url(
+                image.product.slug,
+                image.option,
+                image.id,
+                job,
+                only_path: true
+              )
+            ).to_s
+
+            begin
+              `curl #{url}`
+              puts "Downloaded image #{url}"
+            rescue StandardError => e
+              puts e.inspect
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/cleanup.rake

@@ -0,0 +1,13 @@
+namespace :workarea do
+  desc 'clear out host assets, logs, caches, and tmp files'
+  task cleanup: :environment do
+    puts 'Cleaning up assets...'
+    Rake::Task['assets:clean'].invoke
+
+    puts 'Cleaning up logs...'
+    Rake::Task['log:clear'].invoke
+
+    puts 'Cleaning up temp files...'
+    Rake::Task['tmp:clear'].invoke
+  end
+end

data/lib/tasks/help.rake

@@ -0,0 +1,59 @@
+namespace :workarea do
+  desc 'Drop and recreate help articles (Warning: all current help will be deleted!)'
+  task reload_help: :environment do
+    puts 'Deleting help articles...'
+    Workarea::Help::Article.delete_all
+    Workarea::Help::Asset.delete_all
+
+    Workarea::HelpSeeds.new.perform
+    Rake::Task['workarea:search_index:help'].invoke
+  end
+
+  desc 'Upgrade help (creates only new articles that do not exist in the database)'
+  task upgrade_help: :environment do
+    Workarea::HelpSeeds.new.perform
+    Rake::Task['workarea:search_index:help'].invoke
+  end
+
+  task dump_help: :environment do
+    Workarea::Help::Article.all.each_by(50) do |article|
+      article_root = Rails.root.join(
+        'data',
+        'help',
+        article.category.systemize,
+        article.name.systemize
+      )
+
+      asset_path = article_root.join('assets')
+
+      FileUtils.mkdir_p(article_root)
+
+      if article.thumbnail.present?
+        article.thumbnail.to_file(article_root.join(article.thumbnail.name))
+      end
+
+      Workarea::Help::Asset.all.each_by(50) do |asset|
+        if article.summary.include?(asset.url) || article.body.include?(asset.url)
+          FileUtils.mkdir_p(asset_path)
+          asset.to_file(asset_path.join(asset.name))
+          reference = "<%= #{asset.name.split('.').first} %>"
+
+          article.summary.gsub!(asset.url, reference)
+          article.body.gsub!(asset.url, reference)
+        end
+      end
+
+      if article.summary.present?
+        File.open(article_root.join('summary.md'), 'w') do |file|
+          file.write(article.summary)
+        end
+      end
+
+      if article.body.present?
+        File.open(article_root.join('body.md'), 'w') do |file|
+          file.write(article.body)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/insights.rake

@@ -0,0 +1,49 @@
+require 'active_support/testing/time_helpers'
+
+namespace :workarea do
+  namespace :insights do
+    desc 'Creates metrics and insights based on orders'
+    task generate: :environment do
+      include ActiveSupport::Testing::TimeHelpers
+      batch_size = ENV['WORKAREA_INSIGHTS_BATCH_SIZE'].presence || 1000
+
+      Workarea::Order
+        .placed
+        .each_by(batch_size.to_i) { |o| Workarea::SaveOrderMetrics.perform(o) }
+
+      8.times do |i|
+        travel_to (i.weeks.ago.beginning_of_week + 1.hour)
+        Workarea::GenerateInsights.generate_all!
+      end
+
+      puts "Success! Generated #{Workarea::Insights::Base.count} insights."
+    end
+
+    # Clear the metrics/insights environment - deletes lots of data, this task
+    # is very dangerous! Useful for testing/debugging.
+    task reset: :environment do
+      Workarea::Order
+        .where(:metrics_saved_at.gt => 0)
+        .update_all(metrics_saved_at: nil)
+
+
+      Workarea::Metrics::CategoryByDay.delete_all
+      Workarea::Metrics::CountryByDay.delete_all
+      Workarea::Metrics::DiscountByDay.delete_all
+      Workarea::Metrics::MenuByDay.delete_all
+      Workarea::Metrics::ProductByDay.delete_all
+      Workarea::Metrics::ProductByWeek.delete_all
+      Workarea::Metrics::ProductForLastWeek.delete_all
+      Workarea::Metrics::SalesByDay.delete_all
+      Workarea::Metrics::SearchByDay.delete_all
+      Workarea::Metrics::SearchByWeek.delete_all
+      Workarea::Metrics::SearchForLastWeek.delete_all
+      Workarea::Metrics::SkuByDay.delete_all
+      Workarea::Metrics::TrafficReferrerByDay.delete_all
+      Workarea::Metrics::User.delete_all
+      Workarea::Insights::Base.delete_all
+
+      puts "Success! Insights and metrics have been cleared."
+    end
+  end
+end

data/lib/tasks/lint.rake

@@ -0,0 +1,7 @@
+namespace :workarea do
+  desc 'Check the application for suspicious data'
+  task lint: :environment do
+    require 'workarea/lint'
+    Workarea::Lint.run
+  end
+end

data/lib/tasks/search.rake

@@ -0,0 +1,89 @@
+namespace :workarea do
+  namespace :search_index do
+    desc 'Reindex all data'
+    task all: :environment do
+      Rake::Task['workarea:search_index:storefront'].invoke
+      Rake::Task['workarea:search_index:admin'].invoke
+      Rake::Task['workarea:search_index:help'].invoke
+    end
+
+    desc 'Reindex admin'
+    task admin: :environment do
+      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      puts 'Indexing admin...'
+
+      Workarea::Search::Admin.reset_indexes!
+
+      Mongoid.models.each do |klass|
+        next unless Workarea::Search::Admin.for(klass.first).present?
+
+        klass.all.each_slice_of(100) do |models|
+          Workarea::BulkIndexAdmin.perform_by_models(models)
+        end
+      end
+
+      Workarea.config.jump_to_navigation.to_a.each do |tuple|
+        Workarea::Search::Admin::Navigation.new(tuple).save
+      end
+    end
+
+    desc 'Reindex storefront'
+    task storefront: :environment do
+      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      puts 'Indexing storefront...'
+
+      Workarea::Search::Storefront.reset_indexes!
+      Workarea::Search::Storefront.ensure_dynamic_mappings
+
+      # This code finds all unique filters for products so we can index a sample
+      # product for each to ensure the dynamic mappings get created.
+      #
+      # This is necessary to fix mapping errors from Elasticsearch when trying
+      # to index category percolations against fields which have no mapping.
+      #
+      map = %{
+        function() {
+          for (var key in this.filters.#{I18n.locale}) {
+            emit(key, null);
+          }
+        }
+      }
+      reduce = 'function(key) { return null; }'
+      results = Workarea::Catalog::Product.map_reduce(map, reduce).out(inline: 1)
+      unique_filters = results.map { |r| r['_id'] }
+
+      sample_products = unique_filters.reduce([]) do |memo, filter|
+        filter = "filters.#{I18n.locale}.#{filter}"
+        memo << Workarea::Catalog::Product.exists(filter => true).sample
+      end
+
+      sample_products.each do |product|
+        Workarea::Search::Storefront::Product.new(product).save
+      end
+
+      Workarea::Catalog::Category.all.each_by(100) do |category|
+        Workarea::Search::Storefront::Product.add_category(category)
+        Workarea::Search::Storefront::Category.new(category).save
+      end
+
+      Workarea::Content::Page.all.each_by(100) do |page|
+        Workarea::Search::Storefront::Page.new(page).save
+      end
+
+      Workarea::BulkIndexProducts.perform
+      Workarea::BulkIndexSearches.perform
+    end
+
+    desc 'Reindex help'
+    task help: :environment do
+      require 'sidekiq/testing/inline' unless ENV['INLINE'] == 'false'
+      puts 'Indexing help...'
+
+      Workarea::Search::Help.reset_indexes!
+
+      Workarea::Help::Article.all.each_by(100) do |help_article|
+        Workarea::Search::Help.new(help_article).save
+      end
+    end
+  end
+end

data/lib/tasks/services.rake

@@ -0,0 +1,73 @@
+require 'workarea/version'
+
+namespace :workarea do
+  namespace :services do
+    def assert_docker_compose_installed!
+      unless system('docker-compose -v > /dev/null 2>&1')
+        STDERR.puts <<~eos
+**************************************************
+⛔️ ERROR: workarea:services tasks depend on Docker Compose being installed. \
+See https://docs.docker.com/compose/install/ for how to install.
+**************************************************
+          eos
+        exit
+      end
+    end
+
+    def compose_file_path
+      File.join(`bundle show workarea`, 'docker-compose.yml').gsub("\n", '')
+    end
+
+    def compose_env
+      {
+        'COMPOSE_FILE' => compose_file_path,
+        'COMPOSE_PROJECT_NAME' => File.basename(Dir.pwd),
+
+        'MONGODB_VERSION' => Workarea::VERSION::MONGODB::STRING,
+        'MONGODB_PORT' => ENV['WORKAREA_MONGODB_PORT'] || '27017',
+
+        'REDIS_VERSION' => Workarea::VERSION::REDIS::STRING,
+        'REDIS_PORT' => ENV['WORKAREA_REDIS_PORT'] || '6379',
+
+        'ELASTICSEARCH_VERSION' => Workarea::VERSION::ELASTICSEARCH::STRING,
+        'ELASTICSEARCH_PORT' => ENV['WORKAREA_ELASTICSEARCH_PORT'] || '9200'
+      }
+    end
+
+    desc 'Start Workarea background services for this app'
+    task :up do
+      puts 'Starting Workarea services...'
+      assert_docker_compose_installed!
+
+      if system(compose_env, "docker-compose up -d #{ENV['COMPOSE_ARGUMENTS']} #{ENV['WORKAREA_SERVICES']}")
+        puts '✅ Success! Workarea services are running in the background. Run workarea:services:down to stop them.'
+      else
+        STDERR.puts '⛔️ Error! There was an error starting Workarea services.'
+      end
+    end
+
+    desc 'Stop Workarea external services for this app'
+    task :down do
+      puts 'Stopping Workarea services...'
+      assert_docker_compose_installed!
+
+      if system(compose_env, "docker-compose down #{ENV['COMPOSE_ARGUMENTS']}")
+        puts '✅ Success! Workarea services are stopped. Run workarea:services:up to start them.'
+      else
+        STDERR.puts '⛔️ Error! There was an error stopping Workarea services.'
+      end
+    end
+
+    desc 'Remove data volumes associated with Workarea external services. Stops containers.'
+    task :clean do
+      puts 'Removing Workarea service data...'
+      assert_docker_compose_installed!
+
+      if system(compose_env, "docker-compose down -v #{ENV['COMPOSE_ARGUMENTS']}")
+        puts '✅ Success! Workarea service volumes have been removed. Run workarea:services:up to start services and recreate volumes.'
+      else
+        STDERR.puts '⛔️ Error! There was an error removing Workarea service volumes.'
+      end
+    end
+  end
+end

data/lib/tasks/tests.rake

@@ -0,0 +1,96 @@
+load 'rails/test_unit/testing.rake'
+
+namespace :workarea do
+  task :prepare do
+    $: << 'test'
+  end
+
+  desc 'Run workarea tests (with decorators)'
+  task test: :prepare do
+    roots = [Workarea::Core::Engine.root] +
+              Workarea::Plugin.installed.map(&:root) +
+              [Rails.root]
+
+    Rails::TestUnit::Runner.rake_run(
+      roots
+        .map { |r| FileList["#{r}/test/**/*_test.rb"] }
+        .reduce(&:+)
+    )
+  end
+
+  desc 'Run workarea/core tests (with decorators)'
+  task 'test:core' => :prepare do
+    Rails::TestUnit::Runner.rake_run(["#{Workarea::Core::Engine.root}/test"])
+  end
+
+  desc 'Run decorated tests'
+  task 'test:decorated' => :prepare do
+    decorators = Dir.glob("test/**/*.#{Rails::Decorators.extension}")
+    decorated = decorators.map do |file|
+      file.gsub(".#{Rails::Decorators.extension}", '.rb')
+    end
+
+    roots = [Workarea::Core::Engine.root] +
+              Workarea::Plugin.installed.map(&:root)
+
+    Rails::TestUnit::Runner.rake_run(
+      decorated.reduce([]) do |memo, relative_original|
+        original = roots
+          .map { |root| "#{root}/#{relative_original}" }
+          .detect { |original_path| File.exist?(original_path) }
+        if original.blank?
+          raise <<~HEREDOC
+          Problem:
+            Can't find original test #{relative_original} for #{relative_original.gsub(/rb$/, Rails::Decorators.extension.to_s)}
+          Summary:
+            Test decorators need to have the same path as the orignal test.
+          Resolution:
+            Check that your test decoration has the right path and file name.
+          HEREDOC
+        end
+        memo << original
+      end
+    )
+  end
+
+  desc 'Run all installed workarea plugin tests (with decorators)'
+  task 'test:plugins' => :prepare do
+    engines = Workarea::Plugin.installed.reject do |engine|
+      %w(admin storefront).include?(engine.slug)
+    end.map(&:root)
+
+    Rails::TestUnit::Runner.rake_run(
+      engines.map { |r| FileList["#{r}/test/**/*_test.rb"] }.reduce(&:+) || []
+    )
+  end
+
+  desc 'Run all app specific tests'
+  task 'test:app' => :prepare do
+    Rails::TestUnit::Runner.rake_run(FileList["#{Rails.root}/test/**/*_test.rb"])
+  end
+
+  Workarea::Plugin.installed.each do |engine|
+    display_name = engine.name.split('::')[1..-1].join('_').downcase
+
+    desc "Run workarea #{display_name} tests (with decorators)"
+    task "test:#{display_name}" => :prepare do
+      Rails::TestUnit::Runner.rake_run(
+        FileList[engine.root.join('test', '**', '*', '*_test.rb')]
+      )
+    end
+  end
+
+  desc 'Run workarea performance tests (with decorators)'
+  task 'test:performance' => :prepare do
+    roots = [Workarea::Core::Engine.root] +
+              Workarea::Plugin.installed.map(&:root) +
+              [Rails.root]
+
+    ENV['PERF_TEST'] = true
+    Rails::TestUnit::Runner.rake_run(
+      roots
+        .map { |r| FileList["#{r}/test/performance/**/*_test.rb"] }
+        .reduce(&:+)
+    )
+  end
+end