solidus_product_feed 1.0.0 → 1.1.0

data/Rakefile

@@ -1,21 +1,6 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
-require 'rspec/core/rake_task'
-require 'spree/testing_support/common_rake'
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-RSpec::Core::RakeTask.new
-
-task :default do
-  if Dir["spec/dummy"].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir("../../")
-  end
-  Rake::Task[:spec].invoke
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'spree_product_feed'
-  Rake::Task['common:test_app'].invoke("Spree::User")
-end
+task default: 'extension:specs'

data/app/decorators/controllers/solidus_product_feed/spree/products_controller_decorator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolidusProductFeed
+  module Spree
+    module ProductsControllerDecorator
+      def self.prepended(klass)
+        klass.respond_to :rss, only: :index
+        klass.before_action :verify_requested_format!, only: :index
+      end
+
+      def index
+        load_feed_products if request.format.rss?
+        super
+      end
+
+      private
+
+      def load_feed_products
+        @feed_products = ::Spree::Product.all.map(&SolidusProductFeed.feed_product_class.method(:new))
+      end
+
+      ::Spree::ProductsController.prepend self
+    end
+  end
+end

data/app/models/spree/feed_product.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class FeedProduct
     attr_reader :product
@@ -6,20 +8,38 @@ module Spree
       @product = product
     end
 
-    def id
-      product.id
+    def schema
+      {
+        'g:id' => id,
+        'title' => title,
+        'description' => description,
+        'link' => link,
+        'g:image_link' => image_link,
+        'g:condition' => condition,
+        'g:price' => price,
+        'g:availability' => availability,
+        'g:brand' => brand,
+        'g:mpn' => mpn,
+        'category' => category,
+      }
     end
 
+    delegate :id, to: :product
+
     def title
       product.name
     end
 
-    def description
-      product.description
+    delegate :description, to: :product
+
+    def link
+      ->(view) { view.product_url(product) }
     end
 
-    # Must be selected from https://support.google.com/merchants/answer/1705911
-    def category
+    def image_link
+      return unless product.images.any?
+
+      product.images.first.attachment.url(:large)
     end
 
     # Must be "new", "refurbished", or "used".
@@ -28,12 +48,21 @@ module Spree
     end
 
     def price
-      Spree::Money.new(product.price)
+      Spree::Money.new(product.price).money.format(symbol: false, with_currency: true)
     end
 
-    def image_link
-      return unless product.images.any?
-      product.images.first.attachment.url(:large)
+    def availability
+      product.master.in_stock? ? 'in stock' : 'out of stock'
+    end
+
+    def brand; end
+
+    def mpn
+      product.master.sku
+    end
+
+    def category
+      # Must be selected from https://support.google.com/merchants/answer/1705911
     end
   end
 end

data/app/overrides/rss_link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(virtual_path: 'layouts/spree_application',
                      name: 'product_rss_link',
                      original: '86987c7feaaea3181df195ca520571d801bbbaf3',

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

@@ -1,22 +1,20 @@
+# frozen_string_literal: true
+
 xml.instruct! :xml, version: "1.0"
 
 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.title SolidusProductFeed.evaluate(SolidusProductFeed.title, self)
+    xml.link SolidusProductFeed.evaluate(SolidusProductFeed.link, self)
+    xml.description SolidusProductFeed.evaluate(SolidusProductFeed.description, self)
+    xml.language SolidusProductFeed.evaluate(SolidusProductFeed.language, self)
 
     @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)
+        feed_product.schema.each_pair do |tag, value|
+          value = value.call(self) if value.respond_to?(:call)
+          xml.tag! tag, value
+        end
       end
     end
   end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_product_feed"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/r

@@ -0,0 +1,13 @@
+#!/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('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_product_feed/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'spec/dummy'
+
+unless File.exist? "#{app_root}/bin/rails"
+  system "bin/rake", app_root or begin # rubocop:disable Style/AndOr
+    warn "Automatic creation of the dummy app failed"
+    exit 1
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_product_feed"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/sandbox_rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -1,3 +1,5 @@
-Rails.application.routes.draw do
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
   # Add your extension routes here
 end

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

@@ -1,22 +1,20 @@
+# frozen_string_literal: true
+
 module SolidusProductFeed
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_migrations
-        run 'rake railties:install:migrations FROM=spree_product_feed'
-      end
-
-      def add_javascripts
-        append_file "vendor/assets/javascripts/spree/backend/all.js", "//= require spree/backend/spree_product_feed\n"
+        run 'bin/rails railties:install:migrations FROM=solidus_product_feed'
       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]')) # rubocop:disable Metrics/LineLength
         if run_migrations
-          run 'rake db:migrate'
+          run 'bin/rails db:migrate'
         else
-          puts "Skipping rake db:migrate, don't forget to run it!"
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
         end
       end
     end

data/lib/solidus_product_feed.rb

@@ -1,2 +1,43 @@
-require 'spree_core'
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'solidus_product_feed/version'
 require 'solidus_product_feed/engine'
+
+require 'deface'
+
+module SolidusProductFeed
+  class << self
+    attr_writer :title, :link, :description, :language, :feed_product_class
+
+    def configure
+      yield self
+    end
+
+    def evaluate(value, view_context)
+      value.respond_to?(:call) ? value.call(view_context) : value
+    end
+
+    def title
+      @title ||= ->(view) { view.current_store.name }
+    end
+
+    def link
+      @link ||= ->(view) { "http://#{view.current_store.url}" }
+    end
+
+    def description
+      @description ||= ->(view) { "Find out about new products on http://#{view.current_store.url} first!" }
+    end
+
+    def language
+      @language ||= 'en-us'
+    end
+
+    def feed_product_class
+      (@feed_product_class ||= 'Spree::FeedProduct').constantize
+    end
+  end
+end

data/lib/solidus_product_feed/engine.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_product_feed'
+
 module SolidusProductFeed
   class Engine < Rails::Engine
-    engine_name 'solidus_product_feed'
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
 
-    config.autoload_paths += %W(#{config.root}/lib)
+    engine_name 'solidus_product_feed'
 
     # use rspec for tests
     config.generators do |g|
       g.test_framework :rspec
     end
-
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator.rb')) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
-    end
-
-    config.to_prepare(&method(:activate).to_proc)
   end
 end