Merge pull request #10789 from spree/feature/early-spring-2021-housec…

…leaning

Update Documentation for Spree 4.2

.circleci/config.yml

@@ -23,11 +23,11 @@ run_tests: &run_tests
     - checkout
     - restore_cache:
         keys:
-          - spree-bundle-v7-{{ checksum ".ruby-version" }}-{{ .Branch }}
-          - spree-bundle-v7-{{ checksum ".ruby-version" }}
+          - spree-bundle-v7-ruby-2-7-{{ .Branch }}
+          - spree-bundle-v7-ruby-2-7
     - run:
         name: Run rspec in parallel
-        command: BUNDLE_GEMFILE=../Gemfile ./build-ci.rb test
+        command: BUNDLE_GEMFILE=../Gemfile ./bin/build-ci.rb test
     - store_artifacts:
         path: /tmp/test-artifacts
         destination: test-artifacts
@@ -48,7 +48,7 @@ run_tests_3_0: &run_tests_3_0
           - spree-bundle-v7-ruby-3-0
     - run:
         name: Run rspec in parallel
-        command: BUNDLE_GEMFILE=../Gemfile ./build-ci.rb test
+        command: BUNDLE_GEMFILE=../Gemfile ./bin/build-ci.rb test
     - store_artifacts:
         path: /tmp/test-artifacts
         destination: test-artifacts
@@ -65,15 +65,15 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - spree-bundle-v7-{{ checksum ".ruby-version" }}-{{ .Branch }}
-            - spree-bundle-v7-{{ checksum ".ruby-version" }}
+            - spree-bundle-v7-ruby-2-7-{{ .Branch }}
+            - spree-bundle-v7-ruby-2-7
       - run:
           name: Bundle Install
           command: |
             bundle check || bundle install
-            ./build-ci.rb install
+            ./bin/build-ci.rb install
       - save_cache:
-          key: spree-bundle-v7-{{ checksum ".ruby-version" }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+          key: spree-bundle-v7-ruby-2-7-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/spree/vendor/bundle
 
@@ -89,7 +89,7 @@ jobs:
           name: Bundle Install
           command: |
             bundle check || bundle install
-            ./build-ci.rb install
+            ./bin/build-ci.rb install
       - save_cache:
           key: spree-bundle-v7-ruby-3-0-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
           paths:
@@ -125,16 +125,16 @@ jobs:
     - checkout
     - restore_cache:
         keys:
-          - spree-bundle-v7-{{ checksum ".ruby-version" }}-{{ .Branch }}
-          - spree-bundle-v7-{{ checksum ".ruby-version" }}
+          - spree-bundle-v7-ruby-2-7-{{ .Branch }}
+          - spree-bundle-v7-ruby-2-7
     - run:
         name: Ensure Bundle Install
         command: |
           bundle install
-          ./build-ci.rb install
+          ./bin/build-ci.rb install
     - run:
         name: Run rspec in parallel
-        command: BUNDLE_GEMFILE=../Gemfile ./build-ci.rb test
+        command: BUNDLE_GEMFILE=../Gemfile ./bin/build-ci.rb test
     - store_artifacts:
         path: /tmp/test-artifacts
         destination: test-artifacts
@@ -173,7 +173,7 @@ jobs:
             - spree-bundle-v7-ruby-3-0
       - run:
           name: Run rspec in parallel
-          command: BUNDLE_GEMFILE=../Gemfile ./build-ci.rb test
+          command: BUNDLE_GEMFILE=../Gemfile ./bin/build-ci.rb test
       - store_artifacts:
           path: /tmp/test-artifacts
           destination: test-artifacts

.gitignore

@@ -11,7 +11,6 @@
 .loadpath
 .project
 .vscode
-bin/*
 public/dispatch.cgi
 public/dispatch.fcgi
 public/dispatch.rb

.rubocop.yml

@@ -1,7 +1,5 @@
 require: rubocop-rspec
 
-inherit_from: '.rubocop-disabled.yml'
-
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
@@ -145,3 +143,51 @@ Lint/AmbiguousBlockAssociation:
 
 Style/NumericLiterals:
   Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VoidExpect:
+  Enabled: false
+
+RSpec/BeforeAfterAll:
+  Enabled: false

CHANGELOG.md

@@ -1,47 +1 @@
-## 4.2.0 (unreleased)
-
-https://guides.spreecommerce.org/release_notes/4_2_0.html
-
-## 4.1.0 (2020-02-28)
-
-https://guides.spreecommerce.org/release_notes/4_1_0.html
-
-## 4.0.0 (2019-10-09)
-
-https://guides.spreecommerce.org/release_notes/4_0_0.html
-
-## 3.7.0 (2019-02-04)
-
-https://guides.spreecommerce.org/release_notes/3_7_0.html
-
-## 3.6.0 (2018-06-12)
-
-https://guides.spreecommerce.org/release_notes/3_6_0.html
-
-## 3.5.0 (2018-06-12)
-
-https://guides.spreecommerce.org/release_notes/3_5_0.html
-
-## 3.4.0 (2017-10-12)
-
-https://guides.spreecommerce.org/release_notes/3_4_0.html
-
-## 3.3.0 (2017-08-22)
-
-https://guides.spreecommerce.org/release_notes/3_3_0.html
-
-## 3.2.0 (2017-03-17)
-
-https://guides.spreecommerce.org/release_notes/3_2_0.html
-
-## 3.1.0 (2016-06-15)
-
-https://guides.spreecommerce.org/release_notes/3_1_0.html
-
-## 3.0.0 (2015-03-10)
-
-https://guides.spreecommerce.org/release_notes/3_0_0.html
-
-## 2.4.0 (2014-11-07)
-
-https://guides.spreecommerce.org/release_notes/2_4_0.html
+Please see [Release Notes](https://guides.spreecommerce.org/release_notes/)

Rakefile

@@ -93,6 +93,6 @@ end
 desc "Creates a sandbox application for simulating the Spree code in a deployed Rails app"
 task :sandbox do
   Bundler.with_clean_env do
-    exec("lib/sandbox.sh")
+    exec("bin/sandbox.sh")
   end
 end

SECURITY.md

@@ -1,17 +1 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 4.2.x   | :white_check_mark: |
-| 4.1.x   | :white_check_mark: |
-| 4.0.x   | :white_check_mark:                |
-| 3.7.x   | :white_check_mark: |
-| 3.6.x   | :white_check_mark: |
-| < 3.6   | :x:                |
-
-## Reporting a Vulnerability
-
-**Do not open up a GitHub issue if the bug is a security vulnerability**.
-Instead please report any vulnerabilities at security@spreecommerce.org
+Please see [Spree Guides Security section](https://guides.spreecommerce.org/developer/security/security.html).

build.sh → bin/build.sh

@@ -14,7 +14,7 @@ prepare_app(){
   echo "Preparing test app..."
   BUNDLE_GEMFILE=../Gemfile bundle exec rake test_app
 }
-# Target postgres. Override with: `DB=sqlite bash build.sh`
+# Target postgres. Override with: `DB=sqlite bash bin/build.sh`
 export DB=${DB:-postgres}
 
 # Spree defaults

cmd/lib/spree_cmd/templates/extension/Appraisals

@@ -1,10 +1,5 @@
-appraise 'spree-4-1' do
-  gem 'spree', '~> 4.1.0'
-  gem 'rails-controller-testing'
-end
-
 appraise 'spree-4-2' do
-  gem 'spree', '~> 4.2.0.rc4'
+  gem 'spree', '~> 4.2.0'
   gem 'rails-controller-testing'
 end
 

cmd/lib/spree_cmd/templates/extension/README.md

@@ -7,7 +7,7 @@ Introduction goes here.
 1. Add this extension to your Gemfile with this line:
 
     ```ruby
-    gem '<%= file_name %>', github: '[your-github-handle]/<%= file_name %>'
+    gem '<%= file_name %>'
     ```
 
 2. Install the gem using Bundler
@@ -42,6 +42,15 @@ Simply add this require statement to your spec_helper:
 require '<%= file_name %>/factories'
 ```
 
+## Releasing
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release REAMDE](https://github.com/svenfuchs/gem-release)
+
 ## Contributing
 
 If you'd like to contribute, please take a look at the

cmd/lib/spree_cmd/templates/extension/extension.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.version     = <%= class_name %>.version
   s.summary     = 'Add extension summary here'
   s.description = 'Add (optional) extension description here'
-  s.required_ruby_version = '>= 2.2.7'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.author    = 'You'
   s.email     = 'you@example.com'
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  spree_version = '>= 3.2.0', '< 5.0'
+  spree_version = '>= 4.2.0', '< 6.0'
   s.add_dependency 'spree_core', spree_version
   s.add_dependency 'spree_api', spree_version
   s.add_dependency 'spree_backend', spree_version

cmd/lib/spree_cmd/templates/extension/gemfiles/spree_4_2.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails-controller-testing"
-gem "spree", "~> 4.2.0.rc4"
+gem "spree", "~> 4.2.0"
 
 gemspec path: "../"

cmd/lib/spree_cmd/templates/extension/gitignore

@@ -20,3 +20,4 @@ public/spree
 .ruby-version
 .ruby-gemset
 gemfiles/*.gemfile.lock
+*.gem