Merge pull request #3019 from tvdeyen/add-docs-site

Setup Netlify site for yard docs

Gemfile

@@ -2,31 +2,37 @@
 
 source 'https://rubygems.org'
 
-gemspec require: false
+group :backend, :frontend, :core, :api do
+ gemspec require: false
 
-rails_version = ENV['RAILS_VERSION'] || '~> 5.2.0'
-gem 'rails', rails_version, require: false
+ rails_version = ENV['RAILS_VERSION'] || '~> 5.2.0'
+ gem 'rails', rails_version, require: false
 
-platforms :ruby do
- gem 'mysql2', '~> 0.5.0', require: false
- gem 'pg', '~> 1.0', require: false
- gem 'sqlite3', require: false
- gem 'fast_sqlite', require: false
-end
+ platforms :ruby do
+ case ENV['DB']
+ when /mysql/
+ gem 'mysql2', '~> 0.5.0', require: false
+ when /postgres/
+ gem 'pg', '~> 1.0', require: false
+ else
+ gem 'sqlite3', require: false
+ gem 'fast_sqlite', require: false
+ end
+ end
 
-platforms :jruby do
- gem 'jruby-openssl', require: false
- gem 'activerecord-jdbcsqlite3-adapter', require: false
-end
+ platforms :jruby do
+  gem 'jruby-openssl', require: false
+  gem 'activerecord-jdbcsqlite3-adapter', require: false
+ end
 
-gem 'database_cleaner', '~> 1.3', require: false
-gem 'factory_bot_rails', '~> 4.8', require: false
-gem 'i18n-tasks', '~> 0.9', require: false
-gem 'rspec-activemodel-mocks', '~>1.1', require: false
-gem 'rspec-rails', '~> 3.7', require: false
-gem 'simplecov', require: false
-gem 'with_model', require: false
-gem 'rails-controller-testing', require: false
+ gem 'database_cleaner', '~> 1.3', require: false
+ gem 'factory_bot_rails', '~> 4.8', require: false
+ gem 'rspec-activemodel-mocks', '~>1.1', require: false
+ gem 'rspec-rails', '~> 3.7', require: false
+ gem 'simplecov', require: false
+ gem 'with_model', require: false
+ gem 'rails-controller-testing', require: false
+end
 
 group :backend, :frontend do
  gem 'capybara', '~> 2.15', require: false
@@ -44,17 +50,17 @@ group :backend do
  gem 'teaspoon-mocha', require: false
 end
 
-gem 'rubocop', '~> 0.53.0', require: false
-
 group :utils do
  gem 'pry'
  gem 'launchy', require: false
+ gem 'i18n-tasks', '~> 0.9', require: false
+ gem 'rubocop', '~> 0.53.0', require: false
 end
 
 gem 'rspec_junit_formatter', require: false, group: :ci
 
 # Documentation
-gem 'yard'
+gem 'yard', require: false, group: :docs
 
 custom_gemfile = File.expand_path('Gemfile-custom', __dir__)
 eval File.read(custom_gemfile) if File.exist?(custom_gemfile)

core/app/mailers/spree/carton_mailer.rb

@@ -6,10 +6,10 @@ class CartonMailer < BaseMailer
  # shipped. If a carton contains items from multiple orders then this will be
  # called with that carton one time for each order.
  #
- # @param carton [Spree::Carton] the shipped carton
- # @param order [Spree::Order] one of the orders with items in the carton
- # @param resend [Boolean] indicates whether the email is a 'resend' (e.g.
- #  triggered by the admin "resend" button)
+ # @option options carton [Spree::Carton] the shipped carton
+ # @option options order [Spree::Order] one of the orders with items in the carton
+ # @option options resend [Boolean] indicates whether the email is a 'resend' (e.g.
+ # triggered by the admin "resend" button)
  # @return [Mail::Message]
  #
  # Note: The signature of this method has changed. The new (non-deprecated)

core/app/models/spree/order_cancellations.rb

@@ -23,8 +23,8 @@ def initialize(order)
  # @api public
  #
  # @param [Array<InventoryUnit>] inventory_units the inventory units to be short shipped
- # @param (deprecated) [String] whodunnit the system or person that is short shipping the inventory unit
- # @param [String] created_by the system or person that is short shipping the inventory unit
+ # @param [Spree.user_class] whodunnit (deprecated) the system or person that is short shipping the inventory unit
+ # @param [Spree.user_class] created_by the system or person that is short shipping the inventory unit
  #
  # @return [Array<UnitCancel>] the units that have been canceled due to short shipping
  def short_ship(inventory_units, whodunnit: nil, created_by: nil)
@@ -65,8 +65,8 @@ def short_ship(inventory_units, whodunnit: nil, created_by: nil)
  #
  # @param [InventoryUnit] inventory_unit the inventory unit to be canceled
  # @param [String] reason the reason that you are canceling the inventory unit
- # @param (deprecated) [String] whodunnit the system or person that is canceling the inventory unit
- # @param [String] created_by the system or person that is canceling the inventory unit
+ # @param [Spree.user_class] whodunnit (deprecated) the system or person that is canceling the inventory unit
+ # @param [Spree.user_class] created_by the system or person that is canceling the inventory unit
  #
  # @return [UnitCancel] the unit that has been canceled
  def cancel_unit(inventory_unit, reason: Spree::UnitCancel::DEFAULT_REASON, whodunnit: nil, created_by: nil)