solidus_product_feed 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be2f9f7cc2d18d5a7378987fc39bf1cd8c1d6aeb
-  data.tar.gz: bedae2c876c2da7cc7a7c0fcabcb571d731d196d
+SHA256:
+  metadata.gz: ce324fceb2c25c2e9099d69ba76e0b03ea5dd00ff02447a87b12d662dc694aa6
+  data.tar.gz: 2bf5fd20d9dcdf286391e33fe4376118e49e86341ad5a6cdf871a4f1f6d76da6
 SHA512:
-  metadata.gz: 44f3c3e13bd3e8edc0bee99561ffa9949fa0c71975b1dd4b4b98d4987b16b3f01d02eeff2d3bdccc3d48eb885e1bea5dd0927696957a2209c1f13b2462a2f1bf
-  data.tar.gz: 0ca8f25a3f15966b8df37d5c697d35f686d7143a06cb9e1331f6777d625a330d7e600189e6c3498270e73d0eb171f54e9a1440f33388f1b401ab9140d8b9d545
+  metadata.gz: 2bd0231bb2fa56111602ee89dc001ad6303868812626700edf908ab52793b40d74249098a436c8174a26a5a3349473817c406fb9579d6602dce3ad64129913b5
+  data.tar.gz: db7f8948fd6bf0952cce55e5356ccd0cd857a6c2d25f1f445889535a69dcc4910590d1b418af57e09044f3b1a676d556b605e9f451264977c2364739d6d20141

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_product_feed/version.rb'
+  message: Bump SolidusProductFeed to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -1,12 +1,20 @@
+*.gem
 \#*
 *~
 .#*
 .DS_Store
 .idea
 .project
+.sass-cache
+coverage
+Gemfile.lock
 tmp
 nbproject
+pkg
 *.swp
 spec/dummy
-pkg
-Gemfile.lock
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -1 +1,2 @@
---colour
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,150 +1,4 @@
-AllCops:
-   Exclude:
-     - spec/dummy/**/*
-     - script/*
-     - Guardfile
-     - vendor/**/*
+require:
+  - solidus_dev_support/rubocop
 
-Style/MutableConstant:
-  Enabled: false
-
-# Relaxed.Ruby.Style
-
-Style/Alias:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylealias
-
-Style/BeginBlock:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
-
-Style/BlockDelimiters:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
-
-Style/Documentation:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styledocumentation
-
-Style/DotPosition:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styledotposition
-
-Style/DoubleNegation:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
-
-Style/EndBlock:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleendblock
-
-Style/FormatString:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleformatstring
-
-Style/IfUnlessModifier:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
-
-Style/Lambda:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylelambda
-
-Style/ModuleFunction:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
-
-Style/MultilineBlockChain:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
-
-Style/NegatedIf:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
-
-Style/NegatedWhile:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
-
-Style/ParallelAssignment:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
-
-Style/PerlBackrefs:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
-
-Style/Semicolon:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
-
-Style/SignalException:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
-
-Style/SingleLineBlockParams:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
-
-Style/SingleLineMethods:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
-
-Style/SpaceBeforeBlockBraces:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
-
-Style/SpaceInsideParens:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
-
-Style/SpecialGlobalVars:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
-
-Style/StringLiterals:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
-
-Style/WhileUntilModifier:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
-
-Lint/AssignmentInCondition:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-01-23 16:16:15 +0100 using RuboCop version 0.76.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/InterpolationCheck:
+  Exclude:
+    - 'app/overrides/rss_link.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'solidus_product_feed.gemspec'
+
+# Offense count: 2
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/controllers/products_controller_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/controllers/products_controller_spec.rb'
+
+# Offense count: 2
+RSpec/LetSetup:
+  Exclude:
+    - 'spec/controllers/products_controller_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/controllers/products_controller_spec.rb'
+    - 'spec/models/spree/feed_product_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 152

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+## [Unreleased](https://github.com/solidusio-contrib/solidus_product_feed/tree/HEAD)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_product_feed/compare/v1.0.0...HEAD)
+
+**Closed issues:**
+
+- Dependabot couldn't find a Gemfile-local for this project [\#49](https://github.com/solidusio-contrib/solidus_product_feed/issues/49)
+- Dependabot can't resolve your Ruby dependency files [\#47](https://github.com/solidusio-contrib/solidus_product_feed/issues/47)
+- Dependabot can't resolve your Ruby dependency files [\#46](https://github.com/solidusio-contrib/solidus_product_feed/issues/46)
+- Dependabot can't resolve your Ruby dependency files [\#45](https://github.com/solidusio-contrib/solidus_product_feed/issues/45)
+- Dependabot can't resolve your Ruby dependency files [\#44](https://github.com/solidusio-contrib/solidus_product_feed/issues/44)
+- Dependabot can't resolve your Ruby dependency files [\#43](https://github.com/solidusio-contrib/solidus_product_feed/issues/43)
+- Dependabot can't resolve your Ruby dependency files [\#42](https://github.com/solidusio-contrib/solidus_product_feed/issues/42)
+- Dependabot can't resolve your Ruby dependency files [\#41](https://github.com/solidusio-contrib/solidus_product_feed/issues/41)
+- Dependabot can't resolve your Ruby dependency files [\#40](https://github.com/solidusio-contrib/solidus_product_feed/issues/40)
+
+**Merged pull requests:**
+
+- Update gem to the latest version of solidus\_dev\_support [\#55](https://github.com/solidusio-contrib/solidus_product_feed/pull/55) ([aldesantis](https://github.com/aldesantis))
+- Relax solidus\_support dependency [\#53](https://github.com/solidusio-contrib/solidus_product_feed/pull/53) ([kennyadsl](https://github.com/kennyadsl))
+- Fix Dependabot looking for Gemfile-local [\#51](https://github.com/solidusio-contrib/solidus_product_feed/pull/51) ([aldesantis](https://github.com/aldesantis))
+- Upgrade the extension using solidus\_dev\_support [\#48](https://github.com/solidusio-contrib/solidus_product_feed/pull/48) ([blocknotes](https://github.com/blocknotes))
+- Verify Request Format [\#39](https://github.com/solidusio-contrib/solidus_product_feed/pull/39) ([mamhoff](https://github.com/mamhoff))
+- Adopt solidus\_extension\_dev\_tools [\#38](https://github.com/solidusio-contrib/solidus_product_feed/pull/38) ([aldesantis](https://github.com/aldesantis))
+- Adopt CircleCI instead of Travis [\#31](https://github.com/solidusio-contrib/solidus_product_feed/pull/31) ([aldesantis](https://github.com/aldesantis))
+- Update Ruby and Solidus versions [\#30](https://github.com/solidusio-contrib/solidus_product_feed/pull/30) ([aldesantis](https://github.com/aldesantis))
+- Update travis and rakefile [\#29](https://github.com/solidusio-contrib/solidus_product_feed/pull/29) ([jtapia](https://github.com/jtapia))
+- Add support for latest Solidus versions [\#27](https://github.com/solidusio-contrib/solidus_product_feed/pull/27) ([jtapia](https://github.com/jtapia))
+- Dynamic schema [\#26](https://github.com/solidusio-contrib/solidus_product_feed/pull/26) ([aldesantis](https://github.com/aldesantis))
+- Make feed headers configurable [\#25](https://github.com/solidusio-contrib/solidus_product_feed/pull/25) ([aldesantis](https://github.com/aldesantis))
+- Add brand and MPN tags for Google Merchant feed [\#24](https://github.com/solidusio-contrib/solidus_product_feed/pull/24) ([aldesantis](https://github.com/aldesantis))
+- Remove Solidus v2.3 from Travis config \(EOL\) [\#23](https://github.com/solidusio-contrib/solidus_product_feed/pull/23) ([aitbw](https://github.com/aitbw))
+- Extension maintenance [\#22](https://github.com/solidusio-contrib/solidus_product_feed/pull/22) ([aitbw](https://github.com/aitbw))
+- Fix specs [\#20](https://github.com/solidusio-contrib/solidus_product_feed/pull/20) ([kennyadsl](https://github.com/kennyadsl))
+- Remove versions past EOL from .travis.yml [\#19](https://github.com/solidusio-contrib/solidus_product_feed/pull/19) ([jacobherrington](https://github.com/jacobherrington))
+- Add Solidus 2.7 to .travis.yml [\#18](https://github.com/solidusio-contrib/solidus_product_feed/pull/18) ([jacobherrington](https://github.com/jacobherrington))
+- Use ffaker instead of faker [\#17](https://github.com/solidusio-contrib/solidus_product_feed/pull/17) ([jhawthorn](https://github.com/jhawthorn))
+
+## [v1.0.0](https://github.com/solidusio-contrib/solidus_product_feed/tree/v1.0.0) (2016-08-24)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_product_feed/compare/v0.1.0...v1.0.0)
+
+**Merged pull requests:**
+
+- Add support for Solidus 2.0 and Rails 5 [\#12](https://github.com/solidusio-contrib/solidus_product_feed/pull/12) ([jhawthorn](https://github.com/jhawthorn))
+- Bring the feed more in line with the spec [\#10](https://github.com/solidusio-contrib/solidus_product_feed/pull/10) ([jarednorman](https://github.com/jarednorman))
+- Add a note on versions [\#9](https://github.com/solidusio-contrib/solidus_product_feed/pull/9) ([jhawthorn](https://github.com/jhawthorn))
+- Extract feed logic to class [\#7](https://github.com/solidusio-contrib/solidus_product_feed/pull/7) ([jarednorman](https://github.com/jarednorman))
+
+## [v0.1.0](https://github.com/solidusio-contrib/solidus_product_feed/tree/v0.1.0) (2016-05-10)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_product_feed/compare/ab9d93c2af70a24bfb2a7ab75f3fdf33ddaef3aa...v0.1.0)
+
+**Merged pull requests:**
+
+- Rename to solidus\_product\_feed [\#4](https://github.com/solidusio-contrib/solidus_product_feed/pull/4) ([Sinetheta](https://github.com/Sinetheta))
+- Upgrade 2-4-stable to Solidus [\#3](https://github.com/solidusio-contrib/solidus_product_feed/pull/3) ([Sinetheta](https://github.com/Sinetheta))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,18 +1,37 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-gem "solidus", github: "solidusio/solidus", branch: branch
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
 gem 'solidus_auth_devise'
 
-if branch == 'master' || branch >= "v2.0"
-  gem "rails-controller-testing", group: :test
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
 end
 
-gem 'pg'
-gem 'mysql2'
-
-group :development, :test do
-  gem "pry-rails"
+group :test do
+  gem 'rails-controller-testing'
 end
 
 gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 [name of plugin creator]
+Copyright (c) 2011 Joshua Nussbaum and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -9,7 +9,7 @@ are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name Spree nor the names of its contributors may be used to
+    * Neither the name Solidus nor the names of its contributors may be used to
       endorse or promote products derived from this software without specific
       prior written permission.
 

data/README.md

@@ -1,44 +1,89 @@
-Solidus Product Feed
-================
+# Solidus Product Feed
 
-[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_product_feed.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_product_feed)
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_product_feed.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_product_feed)
 
-An extension that provides an RSS feed for products. Google Shopper attributes are also implemented.
-An RSS link is automatically appended to the `<head>` tag in the `layouts/spree_application` file.
+An extension that provides an RSS feed for products. Google Merchant Feed attributes are also
+implemented. An RSS link is automatically appended to the `<head>` tag in the
+`layouts/spree_application` file.
 
-Note on Versions
-================
+## Installation
 
-The master branch tracks the 1.0 version of this gem, which has some major changes from it's predecessor `spree_product_feed`.
-The 1.0 version is cleaner, more extensible, and more correct at the expense of compatibility.
+Add the gem to your `Gemfile`:
 
-We also have a [`~> 0.1.0` version](https://github.com/solidusio-contrib/solidus_product_feed/tree/v0.1) which is a direct port of `spree_product_feed` with minimal changes.
+```ruby
+gem 'solidus_product_feed'
+````
 
+Install the gem:
 
-Installation
-===============
+```console
+$ bundle install
+```
 
-1) add the gem to your `Gemfile`:
+You're done! You can now see your RSS feed at `/products.rss`.
 
-`gem 'solidus_product_feed'`
+## Usage
 
-2) run bundler:
+The feed ships with sensible defaults for your products, but customization is very easy.
 
-`bundle install`
+### Headers
 
-3) BOOOM, you're done
+You can easily change the feed's headers by putting the following in your Rails initializer:
 
-Viewing Product RSS
-============
+```ruby
+SolidusProductFeed.configure do |config|
+  config.title = 'My Awesome Store'
+  config.link = 'https://www.awesomestore.com'
+  config.description = 'Find out about new products on https://www.awesomestore.com first!'
+  config.language = 'en-us'
+end
+```
 
-`http://yourdomain.tld/products.rss`
+Note that you can also pass a Proc for each of these options. The Proc will be passed the view
+context as its only argument, so that you can use all your helpers:
 
-Testing
-=======
+```ruby
+SolidusProductFeed.configure do |config|
+  config.title = -> (view) { view.current_store.name }
+  config.link = -> (view) { "http://#{view.current_store.url}" }
+  config.description = -> (view) { "Find out about new products on http://#{view.current_store.url} first!" }
+  config.language = -> (view) { view.lang_from_store(current_store.language) }
+end
+```
 
-Be sure to add the rspec-rails gem to your Gemfile and then create a dummy test app for the specs to run against.
+### Item schema
 
-    $ bundle exec rake test app
-    $ bundle exec rspec spec
+If you need to alter the XML schema of a product (e.g. to add/remove a tag), you can do it by
+subclassing `Spree::FeedProduct` in your app and overriding the `schema` method:
 
-Copyright (c) 2011 Joshua Nussbaum, released under the New BSD License
+```ruby
+module AwesomeStore
+  class FeedProduct < Spree::FeedProduct
+    def schema
+      super.merge('g:brand' => 'Awesome Store Inc.')
+    end
+  end
+end
+```
+
+Then set your custom class in an initializer:
+
+```ruby
+SolidusProductFeed.configure do |config|
+  config.feed_product_class = 'AwesomeStore::FeedProduct'
+end
+```
+
+If you want to change the value of an existing tag, you can also simply override the corresponding
+tag method (`link`, `price` etc.). Check the [source code](https://github.com/solidusio-contrib/solidus_product_feed/blob/master/app/models/spree/feed_product.rb)
+for more details. 
+
+## Testing
+
+Be sure to add the `rspec-rails` gem to your Gemfile and then create a dummy test app for the specs 
+to run against.
+
+```console
+$ bundle exec rake test app
+$ bundle exec rspec spec
+```