workarea-sitemaps 2.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a849e41bff94936faa32f32f815fcfc1f2538320a80428c338c798aad7fa72fd
+  data.tar.gz: 105d71537ba4ef0cfc373d1808897d861b5df24a950046e320401db9a5d03043
+SHA512:
+  metadata.gz: 4049a90e3f0c579dd91fbe7d226ef3fb07034f87e15cd09d911423b2e5c17faceda0a4612c79711eab3306b5d48a6aeec26ca0c0aa22f1844a90cd2efa30ae70
+  data.tar.gz: fdc7d1f30ed4e57bed5c91cc0e4ec0530e431baf7bfae02509073842315936a16a072fd7f26bd5543ed205c9c8a1a1523a33d3d3b03013f270296c64d5f33433

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}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+Gemfile.lock
+.sass-cache/
+log/*.log
+pkg/
+test/dummy/public/system/dragonfly
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.DS_Store
+node_modules
+test/reports
+package.json
+yarn.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--failure-exit-code 0

data/.yardopts

@@ -0,0 +1 @@
+--files CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,228 @@
+Workarea Sitemaps 2.1.6 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Sitemaps 2.1.5 (2019-07-23)
+--------------------------------------------------------------------------------
+
+*   Parse Path URLs in Sitemap
+
+    When a URL for a `Navigation::Taxon` is not fully-qualified, the
+    generator builds these links as `://page-name` in the sitemap. To
+    resolve this, `Sitemap::Link` now checks for whether the URL is fully
+    qualified before attempting to use its parsed `#host` and `#scheme` in
+    the generation for the sitemap.
+
+    SITEMAPS-22
+    Tom Scott
+
+
+
+Workarea Sitemaps 2.1.4 (2019-04-02)
+--------------------------------------------------------------------------------
+
+*   Only Track HTTP Links in Sitemap
+
+    Non-HTTP links, like `tel:` and `mailto:`, are invalid within a
+    Google-compatible XML sitemap. Omit any taxonomy that points to these
+    URLs in the sitemap by checking for the presence of "http" or "/" at the
+    beginning of the URL, or whether the Taxon is linked to a Navigable item.
+    Introduce a new predicate method, `Navigation::Taxon#show_in_sitemap?`,
+    to wrap up all the logic for whether a taxon should be included in the
+    generated Google Sitemap XML.
+
+    SITEMAPS-20
+    Tom Scott
+
+
+
+Workarea Sitemaps 2.1.3 (2019-03-19)
+--------------------------------------------------------------------------------
+
+*   Remove Inactive Products From Generated Sitemap
+
+    Add the `Catalog::Product.active_with_variants` scope and use it in
+    `GenerateSitemaps` to prevent products that have no variants appearing
+    in the sitemap just because they have `active: true` set on them.
+
+    SITEMAPS-21
+    Tom Scott
+
+*   Update for workarea v3.4 compatibility
+
+    SITEMAPS-19
+    Matt Duffy
+
+
+
+Workarea Sitemaps 2.1.2 (2019-01-08)
+--------------------------------------------------------------------------------
+
+*   Update README
+
+    SITEMAPS-18
+    Curt Howard
+
+
+
+Workarea Sitemaps 2.1.1 (2018-10-30)
+--------------------------------------------------------------------------------
+
+*   Fix External Links in Sitemap
+
+    When taxonomy contains a link that is external (e.g., to an alternative
+    site or subdomain, like `https://blog.yourclient.com`), the
+    `Workarea::GenerateSitemaps` worker was mistakenly applying the default
+    configured host for the application to each entry. Create a new
+    `Sitemap::Link` class that parses the URL into a URI, if given, or
+    reverts back to the original code of finding the route path and using
+    that as the entry. Workarea also configures a `:host` for every URL in
+    the sitemap, rather than relying on `SitemapGenerator`'s OOB behavior
+    of setting the `default_host` for all entries.
+
+    SITEMAPS-16
+    Tom Scott
+
+
+
+Workarea Sitemaps 2.1.0 (2018-05-24)
+--------------------------------------------------------------------------------
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+*   Fix for headless Chrome
+
+    We strip HTTP cache headers in tests now. To test HTTP caching headers, you
+    must enable them.
+    Ben Crouse
+
+
+
+Workarea Sitemaps 2.0.1 (2017-10-31)
+--------------------------------------------------------------------------------
+
+*   Move configuration into initializers
+
+    SITEMAPS-15
+    Matt Duffy
+
+
+Workarea Sitemaps 2.0.0 (2017-05-01)
+--------------------------------------------------------------------------------
+
+*   Remove lastmod and priority from sitemap entries
+
+    These aren't being accurately kept up to date and search engines ignore
+    them anyways.
+
+    SITEMAPS-10
+    Ben Crouse
+
+*   Allow homepage in sitemap
+
+    According to googling around, this can't hurt and may help.
+
+    SITEMAPS-9
+    Ben Crouse
+
+*   Bump sitemap_generator dependency
+
+    SITEMAPS-8
+    Ben Crouse
+
+*   Cleanup namespace (minor)
+
+    SITEMAPS-8
+    Ben Crouse
+
+*   Convert specs to minitest and get them passing
+
+    SITEMAPS-8
+    Ben Crouse
+
+
+WebLinc Sitemaps 1.0.3 (2016-10-25)
+--------------------------------------------------------------------------------
+
+*   Use https in the default host
+
+    SITEMAPS-5
+    Ben Crouse
+
+*   Fix Cache-Control header set too long
+
+    This causes bots to hang on to the cache for too long and therefore not index changes to the sitemap content.
+
+    The default value from Dragonfly is good for most use cases, but sitemaps are updated daily.
+
+    SITEMAPS-4
+    Ben Crouse
+
+*   Fix Cache-Control header set too long
+
+    This causes bots to hang on to the cache for too long and therefore not index changes to the sitemap content.
+
+    The default value from Dragonfly is good for most use cases, but sitemaps are updated daily.
+
+    SITEMAPS-4
+    Ben Crouse
+
+
+WebLinc Sitemaps 1.0.2 (2016-06-13)
+--------------------------------------------------------------------------------
+
+*   Fix Cache-Control header set too long
+
+    This causes bots to hang on to the cache for too long and therefore not index changes to the sitemap content.
+
+    The default value from Dragonfly is good for most use cases, but sitemaps are updated daily.
+
+    SITEMAPS-4
+    Ben Crouse
+
+
+WebLinc Sitemaps 1.0.1 (2016-04-05)
+--------------------------------------------------------------------------------
+
+
+WebLinc Sitemaps 1.0.0 (January 13, 2016)
+--------------------------------------------------------------------------------
+
+*   Update for compatibility with WebLinc 2.0
+
+*   Add default_url_option to fix errors when running the worker
+
+    SITEMAPS-3
+
+
+WebLinc Sitemaps 0.5.0 (July 12, 2015)
+--------------------------------------------------------------------------------
+
+*   Update for compatibility with weblinc 0.10 and constrain to weblinc >= 0.10
+
+    99e26beca229a9c7e483a92cbdf7963e06eb7d0a
+    2b83f6641e5e3ebee981aa9175199df45d5e173e
+
+
+WebLinc Sitemaps 0.4.0 (June 1, 2015)
+--------------------------------------------------------------------------------
+
+*   Update for compatibility and consistency with weblinc 0.9.0.
+
+
+WebLinc Sitemaps 0.3.0 (April 10, 2015)
+--------------------------------------------------------------------------------
+
+*   Update testing environment for compatibility with WebLinc 0.8.0.
+
+*   Use new decorator style for consistency with WebLinc 0.8.0.
+
+*   Remove gems server secrets for consistency with WebLinc 0.8.0.
+
+*   Add sitemap link to robots.txt.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,40 @@
+Workarea Sitemaps
+================================================================================
+
+A Workarea Commerce plugin that automatically adds search-engine friendly sitemaps to your site via `sitemap.xml.gz` and `sitemap:index.xml.gz` files.
+
+Overview
+--------------------------------------------------------------------------------
+
+* Provides `sitemap.xml.gz`, `sitemap:index.xml.gz`, and `robots.txt` files
+* Automatically generated each morning at 5AM, by default
+* Provide configurable file caching via Dragonfly
+* Indexes all active products and navigation taxons
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-sitemaps'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Sitemaps is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/sitemaps/version'
+
+desc "Release version #{Workarea::Sitemaps::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::Sitemaps::VERSION} -m 'Tagging #{Workarea::Sitemaps::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-sitemaps.gemspec'
+  system "gem push workarea-sitemaps-#{Workarea::Sitemaps::VERSION}.gem"
+  system "gem push workarea-sitemaps-#{Workarea::Sitemaps::VERSION}.gem --host #{host}"
+  system "rm workarea-sitemaps-#{Workarea::Sitemaps::VERSION}.gem"
+end

data/app/models/workarea/navigation/taxon.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Navigation::Taxon, with: :sitemaps do
+    def show_in_sitemap?
+      !placeholder? && active? && (navigable.present? || url.to_s.start_with?('http', '/'))
+    end
+  end
+end

data/app/models/workarea/sitemap/link.rb

@@ -0,0 +1,53 @@
+module Workarea
+  class Sitemap
+    # Model object for representing a single link in the sitemap. A
+    # sitemap XML file is composed of +<url />+ elements, and this class
+    # helps to define the data that ends up in there.
+    class Link
+      delegate_missing_to :@taxon
+
+      # @param [Workarea::Navigation::Taxon] taxon - Model this link is based on
+      # @param [Workarea::GenerateSitemaps] generator - Worker class this link was instantiated from.
+      def initialize(taxon:, generator:)
+        @taxon = taxon
+        @generator = generator
+      end
+
+      # Return the parsed +host+ from the given URL, or the default host
+      # (+Workarea.config.host+) if a +Navigable+ model is being linked
+      # to.
+      def host
+        return default_host unless fully_qualified_url?
+        "#{uri.scheme}://#{uri.host}"
+      end
+
+      # Return the route path for the +Navigable+ model that is linked
+      # to in this taxon, or the +url+ that was hard-coded into the
+      # taxon at creation.
+      def path
+        return uri.path if url?
+
+        @generator.send(route, navigable_slug)
+      end
+
+      private
+
+      def route
+        @route ||= "#{resource_name}_path"
+      end
+
+      def uri
+        @uri ||= URI.parse(url)
+      end
+
+      def default_host
+        scheme = Rails.configuration.force_ssl ? 'https' : 'http'
+        "#{scheme}://#{Workarea.config.host}"
+      end
+
+      def fully_qualified_url?
+        url? && uri.host.present? && uri.scheme.present?
+      end
+    end
+  end
+end

data/app/models/workarea/sitemap.rb

@@ -0,0 +1,20 @@
+module Workarea
+  class Sitemap
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    extend Dragonfly::Model
+
+    field :file_uid, type: String
+    field :index, type: String
+
+    dragonfly_accessor :file, app: :workarea
+
+    def self.find_or_initialize_by_index(index)
+      find_by_index(index) || new(index: index)
+    end
+
+    def self.find_by_index(index)
+      where(index: index).first
+    end
+  end
+end

data/app/views/workarea/storefront/pages/_robots_sitemaps.text.erb

@@ -0,0 +1 @@
+Sitemap: https://<%= Workarea.config.host %>/sitemap.xml.gz

data/app/workers/workarea/generate_sitemaps.rb

@@ -0,0 +1,71 @@
+module Workarea
+  class GenerateSitemaps
+    include Sidekiq::Worker
+    include Storefront::Engine.routes.url_helpers
+
+    TMP_DIR = Rails.root.join('tmp', 'sitemaps')
+
+    def perform(*)
+      begin
+        create_sitemap
+        store_sitemap
+
+        SitemapGenerator::Sitemap.ping_search_engines if Rails.env.production?
+      ensure
+        FileUtils.rm_rf(TMP_DIR)
+      end
+    end
+
+    private
+
+    def create_sitemap
+      per_batch = 100
+      generator = self
+
+      SitemapGenerator::Sitemap.default_host = "https://#{Workarea.config.host}"
+      SitemapGenerator::Sitemap.public_path = TMP_DIR
+      SitemapGenerator::Sitemap.create do
+        #
+        # Products
+        #
+        #
+        Catalog::Product.active.each_by(per_batch) do |product|
+          next unless product.active?
+          add generator.product_path(product), changefreq: 'daily'
+        end
+
+        #
+        # Navigation Links
+        #
+        #
+        Navigation::Taxon.all.each_by(per_batch) do |taxon|
+          next unless taxon.show_in_sitemap?
+
+          entry = Sitemap::Link.new(taxon: taxon, generator: generator)
+
+          add entry.path, changefreq: 'weekly', host: entry.host
+        end
+      end
+    end
+
+    def store_sitemap
+      Dir[File.join(TMP_DIR, '*.xml.gz')].each do |path|
+        file_name = path.split('/').last
+        matches = /\d/.match(file_name) || []
+        index = matches[0]
+
+        sitemap = Workarea::Sitemap.find_or_initialize_by_index(index)
+        sitemap.file = File.new(path)
+        sitemap.save!
+      end
+    end
+
+    def default_url_options
+      { locale: locale }
+    end
+
+    def locale
+      @locale ||= ::I18n.locale != ::I18n.default_locale ? ::I18n.locale : nil
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/farts/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'