solidus_product_feed 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c3bec9a0329340d4408fe6ba7e3e9817394ab86
-  data.tar.gz: 99c1d07475c2d437db367c2ac5bf52035c40a143
+  metadata.gz: be2f9f7cc2d18d5a7378987fc39bf1cd8c1d6aeb
+  data.tar.gz: bedae2c876c2da7cc7a7c0fcabcb571d731d196d
 SHA512:
-  metadata.gz: 96f166ddd4787da1441c2c47d335fd529e8232176ddf9c4ae9c20a3724c651d096393c00ec419874f47c3473e1153d61085ed313792ef9c2296d2634ccd59e24
-  data.tar.gz: 544fb19985b15ec8bb26c7bb79eeb4b35d6e8a6dfa710a79f61db0453e3d4cda65cbdc9301b903738fdfaa3c20a57e0ad2af1e57a710d18ff18ba49d8f315c76
+  metadata.gz: 44f3c3e13bd3e8edc0bee99561ffa9949fa0c71975b1dd4b4b98d4987b16b3f01d02eeff2d3bdccc3d48eb885e1bea5dd0927696957a2209c1f13b2462a2f1bf
+  data.tar.gz: 0ca8f25a3f15966b8df37d5c697d35f686d7143a06cb9e1331f6777d625a330d7e600189e6c3498270e73d0eb171f54e9a1440f33388f1b401ab9140d8b9d545

data/.rubocop.yml

@@ -0,0 +1,150 @@
+AllCops:
+   Exclude:
+     - spec/dummy/**/*
+     - script/*
+     - Guardfile
+     - vendor/**/*
+
+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

data/.travis.yml

@@ -1,11 +1,21 @@
 sudo: false
+cache: bundler
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.1
 env:
   matrix:
-    - SOLIDUS_BRANCH=v1.0
-    - SOLIDUS_BRANCH=v1.1
-    - SOLIDUS_BRANCH=v1.2
-    - SOLIDUS_BRANCH=v1.3
-    - SOLIDUS_BRANCH=master
+    - SOLIDUS_BRANCH=v1.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=master DB=postgres
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql
+    - SOLIDUS_BRANCH=master DB=mysql

data/Gemfile

@@ -1,11 +1,18 @@
-source 'http://rubygems.org'
+source "https://rubygems.org"
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-gem 'solidus', github: 'solidusio/solidus', branch: branch
+gem "solidus", github: "solidusio/solidus", branch: branch
+gem 'solidus_auth_devise'
+
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+end
+
+gem 'pg'
+gem 'mysql2'
 
-# Provides basic authentication functionality for testing parts of your engine
 group :development, :test do
-  gem 'solidus_auth_devise'
+  gem "pry-rails"
 end
 
 gemspec

data/README.md

@@ -6,6 +6,14 @@ 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.
 
+Note on Versions
+================
+
+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.
+
+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.
+
 
 Installation
 ===============

data/app/controllers/spree/products_controller_decorator.rb

@@ -1,15 +1,18 @@
-Spree::ProductsController.class_eval do
-  respond_to :rss, :only => [:index]
-  before_filter :check_rss, only: :index
-
-  def check_rss
-    if request.format.rss?
-      @products = Spree::Product.all
-      respond_to do |format|
-        format.rss { render 'spree/products/index.rss', :layout => false }
-      end
+Spree::ProductsController.prepend(Module.new do
+  class << self
+    def prepended(klass)
+      klass.respond_to :rss, only: :index
     end
   end
 
-  # caches_page :index, :if => Proc.new {|c| c.request.format.rss? }, :expires_in => 1.days
-end
+  def index
+    load_feed_products if request.format.rss?
+    super
+  end
+
+  private
+
+  def load_feed_products
+    @feed_products = Spree::Product.all.map(&Spree::FeedProduct.method(:new))
+  end
+end)

data/app/models/spree/feed_product.rb

@@ -0,0 +1,39 @@
+module Spree
+  class FeedProduct
+    attr_reader :product
+
+    def initialize(product)
+      @product = product
+    end
+
+    def id
+      product.id
+    end
+
+    def title
+      product.name
+    end
+
+    def description
+      product.description
+    end
+
+    # Must be selected from https://support.google.com/merchants/answer/1705911
+    def category
+    end
+
+    # Must be "new", "refurbished", or "used".
+    def condition
+      "new"
+    end
+
+    def price
+      Spree::Money.new(product.price)
+    end
+
+    def image_link
+      return unless product.images.any?
+      product.images.first.attachment.url(:large)
+    end
+  end
+end

data/app/overrides/rss_link.rb

@@ -1,5 +1,5 @@
-Deface::Override.new(:virtual_path => 'layouts/spree_application',
-                     :name => 'product_rss_link',
-                     :original => '86987c7feaaea3181df195ca520571d801bbbaf3',
-                     :insert_bottom => "[data-hook='inside_head']",
-                     :text => '<%= auto_discovery_link_tag(:rss, products_path(:format => :rss), {:title => "#{Spree::Config[:site_title]} Products"}) %>')
+Deface::Override.new(virtual_path: 'layouts/spree_application',
+                     name: 'product_rss_link',
+                     original: '86987c7feaaea3181df195ca520571d801bbbaf3',
+                     insert_bottom: "[data-hook='inside_head']",
+                     text: '<%= auto_discovery_link_tag(:rss, products_path(:format => :rss), {:title => "#{Spree::Config[:site_title]} Products"}) %>')

data/app/views/spree/products/index.rss.builder

@@ -1,27 +1,23 @@
-xml.instruct! :xml, :version=>"1.0"
-xml.rss(:version=>"2.0", "xmlns:g" => "http://base.google.com/ns/1.0"){
-  xml.channel{
-    xml.title(current_store.name)
-    xml.link("http://#{current_store.url}")
-    xml.description("Find out about new products on http://#{current_store.url} first!")
-    xml.language('en-us')
-    @products.each do |product|
-      xml.item do
-        xml.title(product.name)
-        xml.description((product.images.count > 0 ? link_to(image_tag(product.images.first.attachment.url(:product)), product_url(product)) : '') + simple_format(product.description))
-        xml.author(current_store.url)
-        xml.pubDate((product.available_on || product.created_at).strftime("%a, %d %b %Y %H:%M:%S %z"))
-        xml.link(product_url(product))
-        xml.guid(product.id)
+xml.instruct! :xml, version: "1.0"
 
-        if product.images.count > 0
-          xml.tag!('g:image_link', product.images.first.attachment.url(:large))
-        end
+xml.rss version: "2.0", "xmlns:g" => "http://base.google.com/ns/1.0" do
+  xml.channel do
+    xml.title current_store.name
+    xml.link "http://#{current_store.url}"
+    xml.description "Find out about new products on http://#{current_store.url} first!"
+    xml.language 'en-us'
 
-        xml.tag!('g:price', product.price)
-        xml.tag!('g:condition', 'retail')
-        xml.tag!('g:id', product.id)
+    @feed_products.each do |feed_product|
+      xml.item do
+        xml.tag! 'g:id', feed_product.id
+        xml.title feed_product.title
+        xml.description feed_product.description
+        xml.category feed_product.category if feed_product.category
+        xml.link product_url(feed_product.product)
+        xml.tag! 'g:image_link', feed_product.image_link
+        xml.tag! 'g:condition', feed_product.condition
+        xml.tag! 'g:price', feed_product.price.money.format(symbol: false, with_currency: true)
       end
     end
-  }
-}
+  end
+end

data/lib/generators/solidus_product_feed/install/install_generator.rb

@@ -1,7 +1,7 @@
 module SolidusProductFeed
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      class_option :auto_run_migrations, :type => :boolean, :default => false
+      class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_migrations
         run 'rake railties:install:migrations FROM=spree_product_feed'
@@ -12,12 +12,12 @@ module SolidusProductFeed
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
         if run_migrations
-           run 'rake db:migrate'
-         else
-           puts "Skiping rake db:migrate, don't forget to run it!"
-         end
+          run 'rake db:migrate'
+        else
+          puts "Skipping rake db:migrate, don't forget to run it!"
+        end
       end
     end
   end

data/lib/solidus_product_feed/engine.rb

@@ -15,6 +15,6 @@ module SolidusProductFeed
       end
     end
 
-    config.to_prepare &method(:activate).to_proc
+    config.to_prepare(&method(:activate).to_proc)
   end
 end

data/lib/solidus_product_feed/version.rb

@@ -1,3 +1,3 @@
 module SolidusProductFeed
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/solidus_product_feed.gemspec

@@ -20,9 +20,12 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_runtime_dependency 'solidus_core', ["~> 1.0"]
-  s.add_runtime_dependency 'solidus_backend', ["~> 1.0"]
+  s.add_runtime_dependency 'solidus_backend', [">= 1.0", "< 3"]
 
-  s.add_development_dependency 'rspec-rails',  '~> 3.4'
+  s.add_development_dependency 'rspec-rails', '~> 3.4'
+  s.add_development_dependency 'rubocop', '~> 0.39.0'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'faker'
   s.add_development_dependency 'sqlite3'
 end

data/spec/controllers/products_controller_spec.rb

@@ -1,15 +1,20 @@
 require 'spec_helper'
 
 describe Spree::ProductsController, type: :controller do
-  context "GET /index.rss" do
-    before { get :index, format: 'rss', use_route: :spree}
+  render_views
 
-    it 'succeeds' do
-      expect(response).to be_success
-    end
+  context "GET #index" do
+    subject { spree_get :index, format: 'rss' }
+
+    let!(:product) { create :product, name: "2 Hams", price: 20.00 }
+
+    it { is_expected.to have_http_status :ok }
+
+    it { is_expected.to render_template 'spree/products/index' }
 
     it 'returns the correct content type' do
-      expect(response.content_type).to eql('application/rss+xml')
+      subject
+      expect(response.content_type).to eq 'application/rss+xml'
     end
   end
 end

data/spec/models/spree/feed_product_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+RSpec.describe Spree::FeedProduct do
+  let(:feed_product) { described_class.new(product) }
+  let(:product) do
+    create :product,
+      name: "2 Hams 20 Dollars",
+      description: "As seen on TV!"
+  end
+
+  describe "#id" do
+    subject { feed_product.id }
+
+    it "delegates to the product's SKU" do
+      expect(subject).to eq product.id
+    end
+  end
+
+  describe "#category" do
+    subject { feed_product.category }
+    it { is_expected.to be_nil }
+  end
+
+  describe "#condition" do
+    subject { feed_product.condition }
+    it { is_expected.to eq "new" }
+  end
+
+  describe "#price" do
+    subject { feed_product.price }
+    it { is_expected.to eq Spree::Money.new(19.99, currency: 'USD') }
+  end
+
+  describe "#image_link" do
+    subject { feed_product.image_link }
+    context "when the product has images" do
+      before { Spree::Image.create! viewable: product.master, attachment_file_name: 'hams.png' }
+      it { is_expected.to eq '/spree/products/1/large/hams.png' }
+    end
+
+    context "when the product doesn't have images" do
+      it { is_expected.to be_nil }
+    end
+  end
+
+  describe "#description" do
+    subject { feed_product.description }
+    it { is_expected.to eq "As seen on TV!" }
+  end
+
+  describe "#title" do
+    subject { feed_product.title }
+    it { is_expected.to eq "2 Hams 20 Dollars" }
+  end
+end

data/spec/spec_helper.rb

@@ -1,29 +1,17 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require 'rspec/rails'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |file| require file }
+require 'factory_girl_rails'
+require 'pry'
+require 'faker' # Required for factories.
+require 'spree/testing_support/factories'
+require 'spree/testing_support/controller_requests'
 
 RSpec.configure do |config|
-  # == Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
   config.mock_with :rspec
-
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
   config.use_transactional_fixtures = true
-
   config.include Devise::TestHelpers, type: :controller
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.include FactoryGirl::Syntax::Methods
 end

metadata

@@ -1,57 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: solidus_product_feed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Joshua Nussbaum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: solidus_core
+  name: solidus_backend
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: solidus_backend
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '3.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +123,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -94,6 +143,7 @@ files:
 - app/assets/stylesheets/spree/frontend/spree_product_feed.css
 - app/assets/stylesheets/store/solidus_product_feed.css
 - app/controllers/spree/products_controller_decorator.rb
+- app/models/spree/feed_product.rb
 - app/overrides/rss_link.rb
 - app/views/spree/products/index.rss.builder
 - config/routes.rb
@@ -105,6 +155,7 @@ files:
 - script/rails
 - solidus_product_feed.gemspec
 - spec/controllers/products_controller_spec.rb
+- spec/models/spree/feed_product_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses: []
@@ -132,4 +183,5 @@ specification_version: 4
 summary: Spree extension that provides an RSS feed for products
 test_files:
 - spec/controllers/products_controller_spec.rb
+- spec/models/spree/feed_product_spec.rb
 - spec/spec_helper.rb